diff --git a/.zuul.yaml b/.zuul.yaml index f7a6012782..2d02a9db55 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -15,6 +15,7 @@ - controllerconfig-tox-py27 - controllerconfig-tox-pylint - configutilities-tox-flake8 + - configutilities-tox-pylint - stx-devstack-config: voting: false - cgtsclient-tox-py27 @@ -35,6 +36,7 @@ - controllerconfig-tox-py27 - controllerconfig-tox-pylint - configutilities-tox-flake8 + - configutilities-tox-pylint - cgtsclient-tox-py27 - cgtsclient-tox-pep8 - cgtsclient-tox-pylint @@ -148,6 +150,18 @@ tox_envlist: flake8 tox_extra_args: -c configutilities/configutilities/tox.ini +- job: + name: configutilities-tox-pylint + parent: tox + description: Run pylint tests for configutilities + required-projects: + - openstack/stx-update + files: + - configutilities/* + vars: + tox_envlist: pylint + tox_extra_args: -c configutilities/configutilities/tox.ini + - job: name: stx-devstack-config parent: stx-devstack-base diff --git a/configutilities/configutilities/configutilities/common/utils.py b/configutilities/configutilities/configutilities/common/utils.py index 77d1c38314..e178c533da 100644 --- a/configutilities/configutilities/configutilities/common/utils.py +++ b/configutilities/configutilities/configutilities/common/utils.py @@ -331,7 +331,7 @@ def extract_openstack_password_rules_from_file( config = configparser.RawConfigParser() parsed_config = config.read(rules_file) if not parsed_config: - msg = ("Cannot parse rules file: %" % rules_file) + msg = ("Cannot parse rules file: %s" % rules_file) raise Exception(msg) if not config.has_section(section): msg = ("Required section '%s' not found in rules file" % section) diff --git a/configutilities/configutilities/pylint.rc b/configutilities/configutilities/pylint.rc new file mode 100755 index 0000000000..5c51c4c3ba --- /dev/null +++ b/configutilities/configutilities/pylint.rc @@ -0,0 +1,233 @@ +[MASTER] +# Specify a configuration file. +rcfile=pylint.rc + +# Python code to execute, usually for sys.path manipulation such as pygtk.require(). +#init-hook= + +# Add files or directories to the blacklist. They should be base names, not paths. +ignore=tests + +# Pickle collected data for later comparisons. +persistent=yes + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + + +[MESSAGES CONTROL] +# 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. +#enable= + +# Disable 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). +# https://pylint.readthedocs.io/en/latest/user_guide/output.html#source-code-analysis-section +# We are disabling (C)onvention +# We are disabling (R)efactor +# The following warnings should be fixed: +# fixme (todo, xxx, fixme) +# W0102: dangerous-default-value +# W0106: expression-not-assigned +# W0107: unnecessary-pass +# W0201: attribute-defined-outside-init +# W0231: super-init-not-called +# W0235: useless-super-delegation +# W0311: bad-indentation +# W0603: global-statement +# W0611: unused-import +# W0612: unused-variable +# W0613: unused-argument +# W0622: redefined-builtin +# W0703: broad-except +# W1401: anomalous-backslash-in-string +# E0401: import-error +# E1101: no-member +disable=C, R, fixme, W0102, W0106, W0107, W0201, W0231, W0235, W0311, + W0603, W0611, W0612, W0613, W0622, W0703, W1401, E0401, E1101 + +[REPORTS] +# Set the output format. Available formats are text, parseable, colorized, msvs +# (visual studio) and html +output-format=text + +# Put messages in a separate file for each module / package specified on the +# command line instead of printing them on stdout. Reports (if any) will be +# written in a file name "pylint_global.[txt|html]". +files-output=no + +# Tells whether to display a full report or only the messages +reports=no + +# 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) + + +[SIMILARITIES] +# Minimum lines number of a similarity. +min-similarity-lines=4 + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + + +[FORMAT] +# Maximum number of characters on a single line. +max-line-length=85 + +# Maximum number of lines in a module +max-module-lines=1000 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 tab). +indent-string=' ' + + +[TYPECHECK] +# 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 + +# List of classes names for which member attributes should not be checked +# (useful for classes with attributes dynamically set). +ignored-classes=SQLObject + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E0201 when accessed. Python regular +# expressions are accepted. +generated-members=REQUEST,acl_users,aq_parent + + +[BASIC] +# List of builtins function names that should not be used, separated by a comma +bad-functions=map,filter,apply,input + +# Regular expression which should only match correct module names +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Regular expression which should only match correct module level names +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Regular expression which should only match correct class names +class-rgx=[A-Z_][a-zA-Z0-9]+$ + +# Regular expression which should only match correct function names +function-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression which should only match correct method names +method-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression which should only match correct instance attribute names +attr-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression which should only match correct argument names +argument-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression which should only match correct variable names +variable-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression which should only match correct list comprehension / +# generator expression variable names +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ + +# Good variable names which should always be accepted, separated by a comma +good-names=i,j,k,ex,Run,_ + +# Bad variable names which should always be refused, separated by a comma +bad-names=foo,bar,baz,toto,tutu,tata + +# Regular expression which should only match functions or classes name which do +# not require a docstring +no-docstring-rgx=__.*__ + + +[MISCELLANEOUS] +# List of note tags to take in consideration, separated by a comma. +notes=FIXME,XXX,TODO + + +[VARIABLES] +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# A regular expression matching the beginning of the name of dummy variables +# (i.e. not used). +dummy-variables-rgx=_|dummy + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + + +[IMPORTS] +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=regsub,string,TERMIOS,Bastion,rexec + +# 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 external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + + +[DESIGN] +# Maximum number of arguments for function / method +max-args=5 + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore +ignored-argument-names=_.* + +# Maximum number of locals for function / method body +max-locals=15 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of branch for function / method body +max-branchs=12 + +# Maximum number of statements in function / method body +max-statements=50 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + + +[CLASSES] +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__,__new__,setUp + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + + +[EXCEPTIONS] +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception diff --git a/configutilities/configutilities/tox.ini b/configutilities/configutilities/tox.ini index b32f381429..f9ac97717c 100644 --- a/configutilities/configutilities/tox.ini +++ b/configutilities/configutilities/tox.ini @@ -4,9 +4,11 @@ # and then run "tox" from this directory. [tox] -envlist = flake8 +envlist = flake8,pylint # Tox does not work if the path to the workdir is too long, so move it to /tmp toxworkdir = /tmp/{env:USER}_ccutiltox +stxdir = {toxinidir}/../../.. + [testenv] whitelist_externals = find @@ -32,3 +34,13 @@ commands = flake8 {posargs} [flake8] ignore = H102,H104,H306,H401,H403,H404,H405 exclude = dist,build + +[testenv:pylint] +basepython = python3 +sitepackages = False + +deps = -r{toxinidir}/test-requirements.txt + -e{[tox]stxdir}/stx-update/tsconfig/tsconfig + pylint +commands = + pylint {posargs} configutilities --rcfile=./pylint.rc