From cbd8a609c76b7701d15baabdf2400ae60ade0fcd Mon Sep 17 00:00:00 2001 From: Alan Rominger Date: Wed, 29 Mar 2023 16:23:24 -0400 Subject: [PATCH] Add 3 github actions checks which were lost This adds 3 already existing tox targets to github checks include code quality, dist verification, and qunit tests Because these do not fit in the django-python matrix these are added as separate jobs Getting them passing requires several requirements changes correct tox requirements.txt location update lib versions in that requirements file add deps to quality target, since pylint resolves imports Update tox whitelist to allowlist and include timeout for qunit Fix code quality failures a few whitespace points a warning about invalid related_name remove imports of classes that do not exist in tests DRY edits to Makefile remove pylint rcfile and use CLI options instead substantially changes code quality selections enabled --- .github/workflows/test.yml | 46 +++- Makefile | 8 +- pylintrc | 420 ----------------------------- requirements.txt | 8 +- sortedm2m_tests/models.py | 2 +- sortedm2m_tests/test_base.py | 19 +- sortedm2m_tests/test_migrations.py | 38 --- test_project/settings.py | 1 - tox.ini | 10 +- 9 files changed, 59 insertions(+), 493 deletions(-) delete mode 100644 pylintrc diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index d0de5d79..6c8b71a7 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -70,11 +70,6 @@ jobs: restore-keys: | ${{ matrix.python-version }}-v1- - - name: Install Selenium dependencies - run: | - sudo apt-get -qq update - sudo apt-get -y install firefox xvfb - - name: Install dependencies run: | python -m pip install --upgrade pip @@ -90,3 +85,44 @@ jobs: uses: codecov/codecov-action@v2 with: name: Python ${{ matrix.python-version }} + + tox_checks: + name: Run tox environment ${{ matrix.tox-env }} + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + tox-env: ['quality', 'dist-validation'] + + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v3 + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + python -m pip install --upgrade tox tox-gh-actions + + - name: Tox tests + run: tox -e ${{ matrix.tox-env }} -v + + qunit: + name: Visual tests + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v3 + + - name: Install Selenium dependencies + run: | + sudo apt-get -qq update + sudo apt-get -y install firefox xvfb + + - name: Install python dependencies + run: | + python -m pip install --upgrade pip + python -m pip install --upgrade tox tox-gh-actions + + - name: Tox tests + run: tox -e qunit -v diff --git a/Makefile b/Makefile index 7b9b13f5..1d49cd99 100644 --- a/Makefile +++ b/Makefile @@ -1,9 +1,11 @@ .PHONY: quality requirements +CHECK_DIRS?=example sortedm2m sortedm2m_tests test_project *.py + quality: ## Run isort, pycodestyle, and Pylint - isort --check-only --recursive . - pycodestyle example sortedm2m sortedm2m_tests test_project *.py - pylint --rcfile=pylintrc example sortedm2m sortedm2m_tests test_project *.py + isort --check-only $(CHECK_DIRS) + pycodestyle $(CHECK_DIRS) + DJANGO_SETTINGS_MODULE=test_project.settings pylint --errors-only --load-plugins pylint_django $(CHECK_DIRS) requirements: ## Install requirements for development pip install -r requirements.txt diff --git a/pylintrc b/pylintrc deleted file mode 100644 index 0fbe6bbf..00000000 --- a/pylintrc +++ /dev/null @@ -1,420 +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,migrations - -# 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_django - -# 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,too-few-public-methods,missing-docstring,too-many-locals,duplicate-code,invalid-name,fixme,too-many-ancestors,too-many-arguments - -# 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 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[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 - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -notes=FIXME,XXX,TODO - - -[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-zA-Z0-9_]*[a-zA-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 - -[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=120 - -# Maximum number of lines in a module -max-module-lines=1000 - -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma,dict-separator - -# 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 - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=no - -# Minimum lines number of a similarity. -min-similarity-lines=4 - - -[BASIC] - -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Naming hint for attribute names -attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Naming hint for class names -class-name-hint=[A-Z_][a-zA-Z0-9]+$ - -# Regular expression matching correct class names -class-rgx=[A-Z_][a-zA-Z0-9]+$ - -# Naming hint for constant names -const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Naming hint for function names -function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[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 - -# Naming hint for inline iteration names -inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Naming hint for method names -method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Naming hint for module names -module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# 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 - -# Naming hint for variable names -variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[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 - - -[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=7 - -# 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=2 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=Exception diff --git a/requirements.txt b/requirements.txt index 88ada90b..e5947042 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -coverage==4.5.4 -isort==4.3.21 -pycodestyle==2.5.0 -pylint-django==2.0.11 +coverage==7.2.2 +isort==5.12.0 +pycodestyle==2.10.0 +pylint-django==2.5.3 diff --git a/sortedm2m_tests/models.py b/sortedm2m_tests/models.py index 8fdae960..4d028031 100644 --- a/sortedm2m_tests/models.py +++ b/sortedm2m_tests/models.py @@ -64,7 +64,7 @@ class MessyStore(models.Model): class SelfReference(models.Model): - me = SortedManyToManyField('self', related_name='hide+') + me = SortedManyToManyField('self') def __str__(self): return str(self.pk) diff --git a/sortedm2m_tests/test_base.py b/sortedm2m_tests/test_base.py index a4fdebe4..3d11ee77 100644 --- a/sortedm2m_tests/test_base.py +++ b/sortedm2m_tests/test_base.py @@ -239,7 +239,6 @@ def set_up_test_model( related_model=False, mti_model=False, proxy_model=False, - manager_model=False, unique_together=False, options=False, db_table=None, @@ -352,20 +351,4 @@ def set_up_test_model( bases=["%s.Pony" % app_label], ) ) - if manager_model: - from .models import FoodManager, FoodQuerySet - - operations.append( - migrations.CreateModel( - "Food", - fields=[ - ("id", models.AutoField(primary_key=True)), - ], - managers=[ - ("food_qs", FoodQuerySet.as_manager()), - ("food_mgr", FoodManager("a", "b")), - ("food_mgr_kwargs", FoodManager("x", "y", 3, 4)), - ], - ) - ) - return self.apply_operations(app_label, ProjectState(), operations) \ No newline at end of file + return self.apply_operations(app_label, ProjectState(), operations) diff --git a/sortedm2m_tests/test_migrations.py b/sortedm2m_tests/test_migrations.py index c074ef21..82de930c 100644 --- a/sortedm2m_tests/test_migrations.py +++ b/sortedm2m_tests/test_migrations.py @@ -6,44 +6,6 @@ from .test_base import OperationTestBase -class OperationTests(OperationTestBase): - - available_apps = ["example.testapp"] - databases = {'default'} - - def test_alter_field_sortedm2m(self): - project_state = self.set_up_test_model("test_alflmm", second_model=True) - - project_state = self.apply_operations( - "test_alflmm", - project_state, - operations=[ - migrations.AddField( - "Pony", - "stables", - SortedManyToManyField("Stable", related_name="ponies"), - ) - ], - ) - Pony = project_state.apps.get_model("test_alflmm", "Pony") - self.assertFalse(Pony._meta.get_field("stables").blank) - - project_state = self.apply_operations( - "test_alflmm", - project_state, - operations=[ - AlterSortedManyToManyField( - "Pony", - "stables", - SortedManyToManyField( - to="Stable", related_name="ponies", blank=True - ), - ) - ], - ) - Pony = project_state.apps.get_model("test_alflmm", "Pony") - self.assertTrue(Pony._meta.get_field("stables").blank) - class OperationTests(OperationTestBase): available_apps = ["example.testapp"] diff --git a/test_project/settings.py b/test_project/settings.py index a0e44015..2b6fcec9 100644 --- a/test_project/settings.py +++ b/test_project/settings.py @@ -102,4 +102,3 @@ # Default primary key field type # https://docs.djangoproject.com/en/dev/ref/settings/#default-auto-field DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' - diff --git a/tox.ini b/tox.ini index 5198840f..dbd9e203 100644 --- a/tox.ini +++ b/tox.ini @@ -50,8 +50,10 @@ commands = [testenv:quality] deps = Django>=2.2,<3.0 - -rrequirements/test.txt -whitelist_externals = + selenium<4.0 + psycopg2-binary + -rrequirements.txt +allowlist_externals = make commands = make quality @@ -64,5 +66,7 @@ commands = twine check dist/* [testenv:qunit] -deps = selenium +deps = selenium<4.0 +allowlist_externals = + timeout commands = timeout 20 xvfb-run python test_project/qunit-runner.py