diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml new file mode 100644 index 0000000..f86ac28 --- /dev/null +++ b/.github/dependabot.yaml @@ -0,0 +1,13 @@ +version: 2 +updates: + + - package-ecosystem: pip + directory: / + schedule: + interval: weekly + day: sunday + target-branch: dev + labels: [dependencies] + versioning-strategy: increase-if-necessary + commit-message: + prefix: '[dependency]' diff --git a/.github/workflows/codeql-analysis.yaml b/.github/workflows/codeql-analysis.yaml new file mode 100644 index 0000000..d04bda1 --- /dev/null +++ b/.github/workflows/codeql-analysis.yaml @@ -0,0 +1,48 @@ +name: Code Scanning - Action + +'on': + push: + branches: [dev, main] + pull_request: + branches: [dev] + schedule: + # yamllint disable-line rule:quoted-strings + - cron: '44 11 * * 3' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + timeout-minutes: 360 + permissions: + # required for all workflows + security-events: write + + # only required for workflows in private repositories + actions: read + contents: read + + strategy: + fail-fast: false + matrix: + language: [python] + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v3 + with: + languages: ${{ matrix.language }} + + # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v3 + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v3 + with: + category: /language:${{matrix.language}} diff --git a/.github/workflows/combine-dependabot-pr.yaml b/.github/workflows/combine-dependabot-pr.yaml new file mode 100644 index 0000000..eb8c106 --- /dev/null +++ b/.github/workflows/combine-dependabot-pr.yaml @@ -0,0 +1,47 @@ +name: Combine PRs + +'on': + schedule: + # yamllint disable-line rule:quoted-strings + - cron: '0 2 * * 1' # Monday at 02:00 AM + workflow_dispatch: # allows you to manually trigger the workflow + inputs: + logLevel: + description: Log level + required: true + default: warning + type: choice + options: + - info + - warning + - debug + +# The minimum permissions required to run this Action +permissions: + contents: write + pull-requests: write + repository-projects: write + checks: read + +jobs: + combine-prs: + runs-on: ubuntu-latest + + steps: + - name: combine dependabot prs + id: combine-prs + uses: github/combine-prs@v5.0.0 + with: + pr_title: '[dependency]: Combine dependabot PRs' + ci_required: true + branch_prefix: dependabot + labels: dependencies + pr_body_header: '# Combined Dependabot PRs ➡️📦⬅️' + + - name: Enable auto-merge for Dependabot PRs + if: ${{ steps.combine-prs.outputs.pr_url }} + run: gh pr merge --auto --squash --subject "$PR_TITLE" "$PR_URL" + env: + PR_URL: ${{ steps.combine-prs.outputs.pr_url }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + PR_TITLE: '[dependency]: Combine dependabot PRs' diff --git a/.gitlintmodules b/.gitlintmodules new file mode 100644 index 0000000..8d44e73 --- /dev/null +++ b/.gitlintmodules @@ -0,0 +1 @@ +miscellaneous diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..699d5c1 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,4 @@ +[submodule "_symbol"] + path = _symbol + url = https://github.com/symbol/symbol.git + branch = dev diff --git a/Jenkinsfile b/Jenkinsfile new file mode 100644 index 0000000..7511647 --- /dev/null +++ b/Jenkinsfile @@ -0,0 +1,9 @@ +defaultCiPipeline { + // First OS is the default for CI + operatingSystem = ['ubuntu'] + instanceSize = 'medium' + + environment = 'python' + + packageId = 'miscellaneous-scripts' +} diff --git a/_symbol b/_symbol new file mode 160000 index 0000000..1703326 --- /dev/null +++ b/_symbol @@ -0,0 +1 @@ +Subproject commit 1703326d272868ddd2aa785b755c891be3a11806 diff --git a/init.sh b/init.sh new file mode 100755 index 0000000..dccfa9c --- /dev/null +++ b/init.sh @@ -0,0 +1,9 @@ +#!/bin/bash + +set -ex + +git submodule update --init +git -C _symbol config core.sparseCheckout true +echo 'jenkins/*' >>.git/modules/_symbol/info/sparse-checkout +echo 'linters/*' >>.git/modules/_symbol/info/sparse-checkout +git submodule update --force --checkout _symbol diff --git a/jenkins b/jenkins new file mode 120000 index 0000000..1811596 --- /dev/null +++ b/jenkins @@ -0,0 +1 @@ +_symbol/jenkins \ No newline at end of file diff --git a/linters b/linters new file mode 120000 index 0000000..1f66959 --- /dev/null +++ b/linters @@ -0,0 +1 @@ +_symbol/linters \ No newline at end of file diff --git a/linters/python/.pycodestyle b/linters/python/.pycodestyle deleted file mode 100644 index 4ef1389..0000000 --- a/linters/python/.pycodestyle +++ /dev/null @@ -1,3 +0,0 @@ -[pycodestyle] -max-line-length = 140 -ignore = W191 diff --git a/linters/python/.pylintrc b/linters/python/.pylintrc deleted file mode 100644 index 4dbcf84..0000000 --- a/linters/python/.pylintrc +++ /dev/null @@ -1,401 +0,0 @@ -[MASTER] - -# 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-whitelist= - -# Add files or directories to the blacklist. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the blacklist. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins=pylint.extensions.no_self_use - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# 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 reenable 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=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=missing-docstring - -# 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= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=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, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[BASIC] - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,35})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,35})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Z][a-zA-Z0-9_]{2,35}|(__.*__))$ - -# Regular expression matching correct class names -class-rgx=[A-Z_][a-zA-Z0-9]+$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(t_[A-Z0-9_]+)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=100 - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,35})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -good-names=i,j,k,ex,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][a-z0-9_]*$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,35})|(test_[a-z0-9_]+)|(_[a-z0-9_]*))$ - -# Regular expression matching correct module names -module-rgx=((test_)?([A-Za-z][a-zA-Z0-9_]+)|(__main__))$ - -# 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. -property-classes=abc.abstractproperty - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,35})|(_[a-z0-9_]*))$ - - -[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='\t' - -# Maximum number of characters on a single line. -max-line-length=140 - -# 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 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -notes=FIXME,XXX,TODO - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -min-similarity-lines=4 - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=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 missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=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 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 - -# 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= - -# 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 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins=_ - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# 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. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-z0-9_]*[a-z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -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,future.builtins - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# 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] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -max-attributes=8 - -# Maximum number of boolean expressions in a if statement -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=0 - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# 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 - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in 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 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=builtins.Exception - -[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=yes - -[MAIN] - -# Minimum supported python version -py-version = 3.8 diff --git a/scripts/ci/lint.sh b/scripts/ci/lint.sh index 573f4b7..405db10 100755 --- a/scripts/ci/lint.sh +++ b/scripts/ci/lint.sh @@ -6,14 +6,14 @@ if [ $# -gt 0 ]; then PYLINT_DISABLE_COMMANDS="$1" fi -find . -type f -name "*.sh" -print0 | xargs -0 shellcheck -find . -type f -name "*.py" -print0 | PYTHONPATH=. xargs -0 python3 -m isort \ +find . -name _symbol -prune -o -type f -name "*.sh" -print0 | xargs -0 shellcheck +find . -name _symbol -prune -o -type f -name "*.py" -print0 | PYTHONPATH=. xargs -0 python3 -m isort \ --line-length 140 \ --indent " " \ --multi-line 3 \ --check-only -find . -type f -name "*.py" -print0 | PYTHONPATH=. xargs -0 python3 -m pycodestyle \ +find . -name _symbol -prune -o -type f -name "*.py" -print0 | PYTHONPATH=. xargs -0 python3 -m pycodestyle \ --config="$(git rev-parse --show-toplevel)/linters/python/.pycodestyle" -find . -type f -name "*.py" -print0 | PYTHONPATH=. xargs -0 python3 -m pylint \ +find . -name _symbol -prune -o -type f -name "*.py" -print0 | PYTHONPATH=. xargs -0 python3 -m pylint \ --rcfile "$(git rev-parse --show-toplevel)/linters/python/.pylintrc" \ --disable "${PYLINT_DISABLE_COMMANDS}" diff --git a/scripts/ci/test.sh b/scripts/ci/test.sh new file mode 100755 index 0000000..2c424d8 --- /dev/null +++ b/scripts/ci/test.sh @@ -0,0 +1,5 @@ +#!/bin/bash + +set -ex + +echo "no tests to run"