From 345232a3e4725f4087c2aee5647199fa2c5c8d33 Mon Sep 17 00:00:00 2001 From: Isu Kim <49092508+isu-kim@users.noreply.github.com> Date: Fri, 10 May 2024 21:30:13 +0900 Subject: [PATCH 01/12] Work on Pylint - chore: separate ruff and pylint - chore: add pylint CI - chore: add .pylintrc for ignoring modules - rename: ai-engine was renamed to ai_engine for pylint - chore: now includes protobuf as well for Python - chore: remove protobuf generation from Dockerfile --- .github/workflows/ci-test-py.yml | 23 +- ai-engine/.pylintrc | 639 +++++++++++++++++++++++ ai-engine/Dockerfile | 2 - ai-engine/{ai-engine.py => ai_engine.py} | 24 +- protobuf/sentryflow_metrics_pb2.py | 35 ++ protobuf/sentryflow_metrics_pb2.pyi | 25 + protobuf/sentryflow_metrics_pb2_grpc.py | 101 ++++ 7 files changed, 839 insertions(+), 10 deletions(-) create mode 100644 ai-engine/.pylintrc rename ai-engine/{ai-engine.py => ai_engine.py} (85%) create mode 100644 protobuf/sentryflow_metrics_pb2.py create mode 100644 protobuf/sentryflow_metrics_pb2.pyi create mode 100644 protobuf/sentryflow_metrics_pb2_grpc.py diff --git a/.github/workflows/ci-test-py.yml b/.github/workflows/ci-test-py.yml index b129a06..7ff259c 100644 --- a/.github/workflows/ci-test-py.yml +++ b/.github/workflows/ci-test-py.yml @@ -20,7 +20,7 @@ jobs: pip install -r requirements.txt working-directory: ai-engine - py-lint-ai-sentryflow: + py-ruff-ai-sentryflow: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 @@ -47,6 +47,27 @@ jobs: ruff --output-format=github . working-directory: ai-engine + py-lint-ai-sentryflow: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: '3.11' + cache: 'pip' + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + pip install pylint + working-directory: ai-engine + + - name: Lint with Pylint + run: | + pylint ai_engine.py + working-directory: ai-engine + py-pep8-ai-sentryflow: runs-on: ubuntu-latest steps: diff --git a/ai-engine/.pylintrc b/ai-engine/.pylintrc new file mode 100644 index 0000000..1ffed1a --- /dev/null +++ b/ai-engine/.pylintrc @@ -0,0 +1,639 @@ +[MAIN] + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Clear in-memory caches upon conclusion of linting. Useful if running pylint +# in a server-like mode. +clear-cache-post-run=no + +# Load and enable all available extensions. Use --list-extensions to see a list +# all available extensions. +#enable-all-extensions= + +# In error mode, messages with a category besides ERROR or FATAL are +# suppressed, and no reports are done by default. Error mode is compatible with +# disabling specific errors. +#errors-only= + +# Always return a 0 (non-error) status code, even if lint errors are found. +# This is primarily useful in continuous integration scripts. +#exit-zero= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-allow-list= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold under which the program will exit with error. +fail-under=10 + +# Interpret the stdin as a python script, whose filename needs to be passed as +# the module_or_package argument. +#from-stdin= + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Add files or directories matching the regular expressions patterns to the +# ignore-list. The regex matches against paths and can be in Posix or Windows +# format. Because '\\' represents the directory delimiter on Windows systems, +# it can't be used as an escape character. +ignore-paths= + +# Files or directories matching the regular expression patterns are skipped. +# The regex matches against base names, not paths. The default value ignores +# Emacs file locks +ignore-patterns=^\.# + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules=protobuf,stringlifier + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use, and will cap the count on Windows to +# avoid hangs. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.10 + +# Discover python modules and packages in the file system subtree. +recursive=no + +# Add paths to the list of the source roots. Supports globbing patterns. The +# source root is an absolute path or a path relative to the current working +# directory used to determine a package namespace for modules located under the +# source root. +source-roots= + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + +# In verbose mode, extra non-checker-related info will be displayed. +#verbose= + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. If left empty, argument names will be checked with the set +# naming style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. If left empty, attribute names will be checked with the set naming +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. If left empty, class attribute names will be checked +# with the set naming style. +#class-attribute-rgx= + +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE + +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. If left empty, class constant names will be checked with +# the set naming style. +#class-const-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. If left empty, class names will be checked with the set naming style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. If left empty, constant names will be checked with the set naming +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. If left empty, function names will be checked with the set +# naming style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. If left empty, inline iteration names will be checked +# with the set naming style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. If left empty, method names will be checked with the set naming style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. If left empty, module names will be checked with the set naming style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Regular expression matching correct type alias names. If left empty, type +# alias names will be checked with the set naming style. +#typealias-rgx= + +# Regular expression matching correct type variable names. If left empty, type +# variable names will be checked with the set naming style. +#typevar-rgx= + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. If left empty, variable names will be checked with the set +# naming style. +#variable-rgx= + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + asyncSetUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= + +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when caught. +overgeneral-exceptions=builtins.BaseException,builtins.Exception + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow explicit reexports by alias from a package __init__. +allow-reexport-from-package=no + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, +# UNDEFINED. +confidence=HIGH, + CONTROL_FLOW, + INFERENCE, + INFERENCE_FAILURE, + UNDEFINED + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then re-enable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + use-implicit-booleaness-not-comparison-to-string, + use-implicit-booleaness-not-comparison-to-zero + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable= + + +[METHOD_ARGS] + +# List of qualified names (i.e., library.method) which require a timeout +# parameter e.g. 'requests.api.get,requests.api.post' +timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +notes-rgx= + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + +# Let 'consider-using-join' be raised when the separator to join on would be +# non-empty (resulting in expected fixes of the type: ``"- " + " - +# ".join(items)``) +suggest-join-with-non-empty-separator=yes + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'fatal', 'error', 'warning', 'refactor', +# 'convention', and 'info' which contain the number of messages in each +# category, as well as 'statement' which is the total number of statements +# analyzed. This score is used by the global evaluation report (RP0004). +evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +msg-template= + +# Set the output format. Available formats are: text, parseable, colorized, +# json2 (improved json format), json (old json format) and msvs (visual +# studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +#output-format= + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[SIMILARITIES] + +# Comments are removed from the similarity computation +ignore-comments=yes + +# Docstrings are removed from the similarity computation +ignore-docstrings=yes + +# Imports are removed from the similarity computation +ignore-imports=yes + +# Signatures are removed from the similarity computation +ignore-signatures=yes + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. No available dictionaries : You need to install +# both the python package and the system dependency for enchant to work. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear at the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of symbolic message names to ignore for Mixin members. +ignored-checks-for-mixins=no-member, + not-async-context-manager, + not-context-manager, + attribute-defined-outside-init + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# Regex pattern to define which classes are considered mixins. +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io diff --git a/ai-engine/Dockerfile b/ai-engine/Dockerfile index 3929e1a..3761f18 100644 --- a/ai-engine/Dockerfile +++ b/ai-engine/Dockerfile @@ -17,8 +17,6 @@ WORKDIR /ai-engine/stringlifier RUN pip3 install . WORKDIR /ai-engine -RUN python3 -m grpc_tools.protoc --python_out=. --pyi_out=. --grpc_python_out=. -I=. protobuf/sentryflow_metrics.proto - RUN pip install -r requirements.txt CMD ["python3", "ai-engine.py"] diff --git a/ai-engine/ai-engine.py b/ai-engine/ai_engine.py similarity index 85% rename from ai-engine/ai-engine.py rename to ai-engine/ai_engine.py index 43f5786..fbaff75 100644 --- a/ai-engine/ai-engine.py +++ b/ai-engine/ai_engine.py @@ -1,10 +1,14 @@ -import os -import grpc +# SPDX-License-Identifier: Apache-2.0 + +"""SentryFlow AI API Classification Engine""" -from stringlifier.api import Stringlifier from concurrent import futures from collections import Counter +import os +import grpc + +from stringlifier.api import Stringlifier from protobuf import sentryflow_metrics_pb2_grpc from protobuf import sentryflow_metrics_pb2 @@ -20,7 +24,7 @@ def __init__(self): self.listen_addr = "0.0.0.0:5000" self.server = None - self.grpc_servers = list() + self.grpc_servers = [] def init_grpc_servers(self): """ @@ -41,7 +45,7 @@ def serve(self): """ self.server.add_insecure_port(self.listen_addr) - print("[INFO] Starting to serve on {}".format(self.listen_addr)) + print(f"[INFO] Starting to serve on {self.listen_addr}") self.server.start() self.server.wait_for_termination() @@ -56,7 +60,13 @@ def register(self, server): :param server: The server :return: None """ - pass + + def unregister(self, server): + """ + unregister method that unregisters gRPC service from target server + :param server: The server + :return: None + """ class APIClassificationServer(sentryflow_metrics_pb2_grpc.APIClassificationServicer, GRPCServer): @@ -85,7 +95,7 @@ def ClassifyAPIs(self, request_iterator, context): ml_results = self.stringlifier(all_paths) ml_counts = Counter(ml_results) - print("{} -> {}".format(all_paths, ml_counts)) + print(f"{all_paths} -> {ml_counts}") yield sentryflow_metrics_pb2.APIClassificationResponse(APIs=ml_counts) diff --git a/protobuf/sentryflow_metrics_pb2.py b/protobuf/sentryflow_metrics_pb2.py new file mode 100644 index 0000000..3ed6fd4 --- /dev/null +++ b/protobuf/sentryflow_metrics_pb2.py @@ -0,0 +1,35 @@ +# -*- coding: utf-8 -*- +# Generated by the protocol buffer compiler. DO NOT EDIT! +# source: sentryflow_metrics.proto +# Protobuf Python Version: 5.26.1 +"""Generated protocol buffer code.""" +from google.protobuf import descriptor as _descriptor +from google.protobuf import descriptor_pool as _descriptor_pool +from google.protobuf import symbol_database as _symbol_database +from google.protobuf.internal import builder as _builder +# @@protoc_insertion_point(imports) + +_sym_db = _symbol_database.Default() + + + + +DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x18sentryflow_metrics.proto\x12\x08protobuf\"\'\n\x18\x41PIClassificationRequest\x12\x0b\n\x03\x41PI\x18\x01 \x03(\t\"\x85\x01\n\x19\x41PIClassificationResponse\x12;\n\x04\x41PIs\x18\x01 \x03(\x0b\x32-.protobuf.APIClassificationResponse.APIsEntry\x1a+\n\tAPIsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\x04:\x02\x38\x01\x32p\n\x11\x41PIClassification\x12[\n\x0c\x43lassifyAPIs\x12\".protobuf.APIClassificationRequest\x1a#.protobuf.APIClassificationResponse(\x01\x30\x01\x42\x15Z\x13SentryFlow/protobufb\x06proto3') + +_globals = globals() +_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals) +_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'sentryflow_metrics_pb2', _globals) +if not _descriptor._USE_C_DESCRIPTORS: + _globals['DESCRIPTOR']._loaded_options = None + _globals['DESCRIPTOR']._serialized_options = b'Z\023SentryFlow/protobuf' + _globals['_APICLASSIFICATIONRESPONSE_APISENTRY']._loaded_options = None + _globals['_APICLASSIFICATIONRESPONSE_APISENTRY']._serialized_options = b'8\001' + _globals['_APICLASSIFICATIONREQUEST']._serialized_start=38 + _globals['_APICLASSIFICATIONREQUEST']._serialized_end=77 + _globals['_APICLASSIFICATIONRESPONSE']._serialized_start=80 + _globals['_APICLASSIFICATIONRESPONSE']._serialized_end=213 + _globals['_APICLASSIFICATIONRESPONSE_APISENTRY']._serialized_start=170 + _globals['_APICLASSIFICATIONRESPONSE_APISENTRY']._serialized_end=213 + _globals['_APICLASSIFICATION']._serialized_start=215 + _globals['_APICLASSIFICATION']._serialized_end=327 +# @@protoc_insertion_point(module_scope) diff --git a/protobuf/sentryflow_metrics_pb2.pyi b/protobuf/sentryflow_metrics_pb2.pyi new file mode 100644 index 0000000..4aa0d80 --- /dev/null +++ b/protobuf/sentryflow_metrics_pb2.pyi @@ -0,0 +1,25 @@ +from google.protobuf.internal import containers as _containers +from google.protobuf import descriptor as _descriptor +from google.protobuf import message as _message +from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional + +DESCRIPTOR: _descriptor.FileDescriptor + +class APIClassificationRequest(_message.Message): + __slots__ = ("API",) + API_FIELD_NUMBER: _ClassVar[int] + API: _containers.RepeatedScalarFieldContainer[str] + def __init__(self, API: _Optional[_Iterable[str]] = ...) -> None: ... + +class APIClassificationResponse(_message.Message): + __slots__ = ("APIs",) + class APIsEntry(_message.Message): + __slots__ = ("key", "value") + KEY_FIELD_NUMBER: _ClassVar[int] + VALUE_FIELD_NUMBER: _ClassVar[int] + key: str + value: int + def __init__(self, key: _Optional[str] = ..., value: _Optional[int] = ...) -> None: ... + APIS_FIELD_NUMBER: _ClassVar[int] + APIs: _containers.ScalarMap[str, int] + def __init__(self, APIs: _Optional[_Mapping[str, int]] = ...) -> None: ... diff --git a/protobuf/sentryflow_metrics_pb2_grpc.py b/protobuf/sentryflow_metrics_pb2_grpc.py new file mode 100644 index 0000000..209c5ca --- /dev/null +++ b/protobuf/sentryflow_metrics_pb2_grpc.py @@ -0,0 +1,101 @@ +# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT! +"""Client and server classes corresponding to protobuf-defined services.""" +import grpc +import warnings + +import sentryflow_metrics_pb2 as sentryflow__metrics__pb2 + +GRPC_GENERATED_VERSION = '1.63.0' +GRPC_VERSION = grpc.__version__ +EXPECTED_ERROR_RELEASE = '1.65.0' +SCHEDULED_RELEASE_DATE = 'June 25, 2024' +_version_not_supported = False + +try: + from grpc._utilities import first_version_is_lower + _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION) +except ImportError: + _version_not_supported = True + +if _version_not_supported: + warnings.warn( + f'The grpc package installed is at version {GRPC_VERSION},' + + f' but the generated code in sentryflow_metrics_pb2_grpc.py depends on' + + f' grpcio>={GRPC_GENERATED_VERSION}.' + + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}' + + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.' + + f' This warning will become an error in {EXPECTED_ERROR_RELEASE},' + + f' scheduled for release on {SCHEDULED_RELEASE_DATE}.', + RuntimeWarning + ) + + +class APIClassificationStub(object): + """Missing associated documentation comment in .proto file.""" + + def __init__(self, channel): + """Constructor. + + Args: + channel: A grpc.Channel. + """ + self.ClassifyAPIs = channel.stream_stream( + '/protobuf.APIClassification/ClassifyAPIs', + request_serializer=sentryflow__metrics__pb2.APIClassificationRequest.SerializeToString, + response_deserializer=sentryflow__metrics__pb2.APIClassificationResponse.FromString, + _registered_method=True) + + +class APIClassificationServicer(object): + """Missing associated documentation comment in .proto file.""" + + def ClassifyAPIs(self, request_iterator, context): + """Missing associated documentation comment in .proto file.""" + context.set_code(grpc.StatusCode.UNIMPLEMENTED) + context.set_details('Method not implemented!') + raise NotImplementedError('Method not implemented!') + + +def add_APIClassificationServicer_to_server(servicer, server): + rpc_method_handlers = { + 'ClassifyAPIs': grpc.stream_stream_rpc_method_handler( + servicer.ClassifyAPIs, + request_deserializer=sentryflow__metrics__pb2.APIClassificationRequest.FromString, + response_serializer=sentryflow__metrics__pb2.APIClassificationResponse.SerializeToString, + ), + } + generic_handler = grpc.method_handlers_generic_handler( + 'protobuf.APIClassification', rpc_method_handlers) + server.add_generic_rpc_handlers((generic_handler,)) + + + # This class is part of an EXPERIMENTAL API. +class APIClassification(object): + """Missing associated documentation comment in .proto file.""" + + @staticmethod + def ClassifyAPIs(request_iterator, + target, + options=(), + channel_credentials=None, + call_credentials=None, + insecure=False, + compression=None, + wait_for_ready=None, + timeout=None, + metadata=None): + return grpc.experimental.stream_stream( + request_iterator, + target, + '/protobuf.APIClassification/ClassifyAPIs', + sentryflow__metrics__pb2.APIClassificationRequest.SerializeToString, + sentryflow__metrics__pb2.APIClassificationResponse.FromString, + options, + channel_credentials, + insecure, + call_credentials, + compression, + wait_for_ready, + timeout, + metadata, + _registered_method=True) From c62480962ffa9f7522dbc8d5daeaed498819aba5 Mon Sep 17 00:00:00 2001 From: Isu Kim <49092508+isu-kim@users.noreply.github.com> Date: Fri, 10 May 2024 21:35:28 +0900 Subject: [PATCH 02/12] Fix pylint --- ai-engine/ai_engine.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ai-engine/ai_engine.py b/ai-engine/ai_engine.py index fbaff75..694a6aa 100644 --- a/ai-engine/ai_engine.py +++ b/ai-engine/ai_engine.py @@ -81,7 +81,7 @@ def __init__(self): def register(self, server): sentryflow_metrics_pb2_grpc.add_APIClassificationServicer_to_server(self, server) - def ClassifyAPIs(self, request_iterator, context): + def ClassifyAPIs(self, request_iterator, context): # pylint: disable=C0103 """ GetAPIClassification method that runs multiple API ML Classification at once :param request_iterator: The requests From b3591abe0e3d6ff0c11f6a75230b586ac1b68b05 Mon Sep 17 00:00:00 2001 From: Isu Kim <49092508+isu-kim@users.noreply.github.com> Date: Fri, 10 May 2024 21:37:45 +0900 Subject: [PATCH 03/12] Update ai_engine.py --- ai-engine/ai_engine.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ai-engine/ai_engine.py b/ai-engine/ai_engine.py index 694a6aa..55f3536 100644 --- a/ai-engine/ai_engine.py +++ b/ai-engine/ai_engine.py @@ -8,9 +8,9 @@ import os import grpc -from stringlifier.api import Stringlifier from protobuf import sentryflow_metrics_pb2_grpc from protobuf import sentryflow_metrics_pb2 +from stringlifier.api import Stringlifier class HandlerServer: @@ -81,7 +81,7 @@ def __init__(self): def register(self, server): sentryflow_metrics_pb2_grpc.add_APIClassificationServicer_to_server(self, server) - def ClassifyAPIs(self, request_iterator, context): # pylint: disable=C0103 + def ClassifyAPIs(self, request_iterator, _): # pylint: disable=C0103 """ GetAPIClassification method that runs multiple API ML Classification at once :param request_iterator: The requests From 6cfd5ff0ed93e9defe08f9ea2aeb2668212702dc Mon Sep 17 00:00:00 2001 From: Isu Kim <49092508+isu-kim@users.noreply.github.com> Date: Fri, 10 May 2024 21:39:41 +0900 Subject: [PATCH 04/12] Update ci-test-py.yml --- .github/workflows/ci-test-py.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci-test-py.yml b/.github/workflows/ci-test-py.yml index 7ff259c..23747fc 100644 --- a/.github/workflows/ci-test-py.yml +++ b/.github/workflows/ci-test-py.yml @@ -75,4 +75,4 @@ jobs: - name: 'Run PEP8' uses: quentinguidee/pep8-action@v1 with: - arguments: '--max-line-length=120 --exclude=./ai-engine/stringlifier/*' + arguments: '--max-line-length=120 --exclude=./ai-engine/stringlifier/*' --exclude=./ai-engine/protobuf/*' From 71536b6d065328a67f7c90626ff92219ee167ddd Mon Sep 17 00:00:00 2001 From: Isu Kim <49092508+isu-kim@users.noreply.github.com> Date: Fri, 10 May 2024 21:40:41 +0900 Subject: [PATCH 05/12] Update ci-test-py.yml --- .github/workflows/ci-test-py.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci-test-py.yml b/.github/workflows/ci-test-py.yml index 23747fc..12c4aa7 100644 --- a/.github/workflows/ci-test-py.yml +++ b/.github/workflows/ci-test-py.yml @@ -75,4 +75,4 @@ jobs: - name: 'Run PEP8' uses: quentinguidee/pep8-action@v1 with: - arguments: '--max-line-length=120 --exclude=./ai-engine/stringlifier/*' --exclude=./ai-engine/protobuf/*' + arguments: '--max-line-length=120 --exclude=./ai-engine/stringlifier/* --exclude=./ai-engine/protobuf/*' From 468824d0caea33d1ecb51ee9cbaad446a0486e70 Mon Sep 17 00:00:00 2001 From: Isu Kim <49092508+isu-kim@users.noreply.github.com> Date: Fri, 10 May 2024 21:55:41 +0900 Subject: [PATCH 06/12] Update ci-test-py.yml --- .github/workflows/ci-test-py.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci-test-py.yml b/.github/workflows/ci-test-py.yml index 7ff259c..5b2685d 100644 --- a/.github/workflows/ci-test-py.yml +++ b/.github/workflows/ci-test-py.yml @@ -75,4 +75,4 @@ jobs: - name: 'Run PEP8' uses: quentinguidee/pep8-action@v1 with: - arguments: '--max-line-length=120 --exclude=./ai-engine/stringlifier/*' + arguments: '--max-line-length=120 --exclude="./stringlifier/*,./protobuf/*"' From d4263cc746de5315dbee1d913f7885b62ad278e1 Mon Sep 17 00:00:00 2001 From: Isu Kim <49092508+isu-kim@users.noreply.github.com> Date: Fri, 10 May 2024 21:56:29 +0900 Subject: [PATCH 07/12] Revert "Update ci-test-py.yml" This reverts commit 468824d0caea33d1ecb51ee9cbaad446a0486e70. --- .github/workflows/ci-test-py.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci-test-py.yml b/.github/workflows/ci-test-py.yml index 5b2685d..7ff259c 100644 --- a/.github/workflows/ci-test-py.yml +++ b/.github/workflows/ci-test-py.yml @@ -75,4 +75,4 @@ jobs: - name: 'Run PEP8' uses: quentinguidee/pep8-action@v1 with: - arguments: '--max-line-length=120 --exclude="./stringlifier/*,./protobuf/*"' + arguments: '--max-line-length=120 --exclude=./ai-engine/stringlifier/*' From 1a41c38c4fd84b814188cf482cbc21dee21723d9 Mon Sep 17 00:00:00 2001 From: Isu Kim <49092508+isu-kim@users.noreply.github.com> Date: Fri, 10 May 2024 21:56:49 +0900 Subject: [PATCH 08/12] Update ci-test-py.yml --- .github/workflows/ci-test-py.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci-test-py.yml b/.github/workflows/ci-test-py.yml index 12c4aa7..5b2685d 100644 --- a/.github/workflows/ci-test-py.yml +++ b/.github/workflows/ci-test-py.yml @@ -75,4 +75,4 @@ jobs: - name: 'Run PEP8' uses: quentinguidee/pep8-action@v1 with: - arguments: '--max-line-length=120 --exclude=./ai-engine/stringlifier/* --exclude=./ai-engine/protobuf/*' + arguments: '--max-line-length=120 --exclude="./stringlifier/*,./protobuf/*"' From 24ca6781daaaf8c063634191128bd092b8564238 Mon Sep 17 00:00:00 2001 From: Isu Kim <49092508+isu-kim@users.noreply.github.com> Date: Fri, 10 May 2024 21:58:35 +0900 Subject: [PATCH 09/12] Update ci-test-py.yml --- .github/workflows/ci-test-py.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci-test-py.yml b/.github/workflows/ci-test-py.yml index 5b2685d..9cc117e 100644 --- a/.github/workflows/ci-test-py.yml +++ b/.github/workflows/ci-test-py.yml @@ -75,4 +75,4 @@ jobs: - name: 'Run PEP8' uses: quentinguidee/pep8-action@v1 with: - arguments: '--max-line-length=120 --exclude="./stringlifier/*,./protobuf/*"' + arguments: '--max-line-length=120 --exclude=./stringlifier/*,./protobuf/*' From 5737016f53f9db407c09d5f78bf62e45ca8c64f7 Mon Sep 17 00:00:00 2001 From: Isu Kim <49092508+isu-kim@users.noreply.github.com> Date: Fri, 10 May 2024 21:59:49 +0900 Subject: [PATCH 10/12] Update ci-test-py.yml --- .github/workflows/ci-test-py.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci-test-py.yml b/.github/workflows/ci-test-py.yml index 9cc117e..4a86277 100644 --- a/.github/workflows/ci-test-py.yml +++ b/.github/workflows/ci-test-py.yml @@ -75,4 +75,4 @@ jobs: - name: 'Run PEP8' uses: quentinguidee/pep8-action@v1 with: - arguments: '--max-line-length=120 --exclude=./stringlifier/*,./protobuf/*' + arguments: '--max-line-length=120 --exclude=./ai-engine/stringlifier/*,./ai-engine/protobuf/*' From 999a09b5a6a84e1d1ec761752c9080938a850bb3 Mon Sep 17 00:00:00 2001 From: Isu Kim <49092508+isu-kim@users.noreply.github.com> Date: Fri, 10 May 2024 22:01:13 +0900 Subject: [PATCH 11/12] Update ci-test-py.yml --- .github/workflows/ci-test-py.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci-test-py.yml b/.github/workflows/ci-test-py.yml index 4a86277..e108336 100644 --- a/.github/workflows/ci-test-py.yml +++ b/.github/workflows/ci-test-py.yml @@ -75,4 +75,4 @@ jobs: - name: 'Run PEP8' uses: quentinguidee/pep8-action@v1 with: - arguments: '--max-line-length=120 --exclude=./ai-engine/stringlifier/*,./ai-engine/protobuf/*' + arguments: '--max-line-length=120 --exclude=*/stringlifier/*,*/protobuf/*' From d6663bd4be507a161957cc9501060fafe84b06c1 Mon Sep 17 00:00:00 2001 From: Isu Kim <49092508+isu-kim@users.noreply.github.com> Date: Fri, 10 May 2024 22:03:45 +0900 Subject: [PATCH 12/12] Update ci-test-py.yml --- .github/workflows/ci-test-py.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci-test-py.yml b/.github/workflows/ci-test-py.yml index e108336..9b3cc2c 100644 --- a/.github/workflows/ci-test-py.yml +++ b/.github/workflows/ci-test-py.yml @@ -75,4 +75,4 @@ jobs: - name: 'Run PEP8' uses: quentinguidee/pep8-action@v1 with: - arguments: '--max-line-length=120 --exclude=*/stringlifier/*,*/protobuf/*' + arguments: '--max-line-length=120 --exclude=*stringlifier/*,*protobuf/*'