From 7fbddc4096b80907a14c8520c26a8025964d638d Mon Sep 17 00:00:00 2001 From: Al Bailey Date: Tue, 8 Jan 2019 11:12:42 -0600 Subject: [PATCH] Adding a pylint tox and zuul job for stx-integ The failing pylint warnings and errors are currently suppressed. They will be fixed by subsequent commits. Story: 2004515 Task: 28791 Change-Id: I93a89554bf2dfbd9d1cbd96728a7663c408a79b1 Signed-off-by: Al Bailey --- .zuul.yaml | 10 +++ pylint.rc | 236 +++++++++++++++++++++++++++++++++++++++++++++++++++++ tox.ini | 33 ++++++++ 3 files changed, 279 insertions(+) create mode 100755 pylint.rc diff --git a/.zuul.yaml b/.zuul.yaml index 1ff057e58..937b1619f 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -7,6 +7,7 @@ - build-openstack-releasenotes - openstack-tox-pep8 - openstack-tox-linters + - stx-integ-pylint - stx-devstack-integ: voting: false gate: @@ -14,6 +15,7 @@ - build-openstack-releasenotes - openstack-tox-pep8 - openstack-tox-linters + - stx-integ-pylint post: jobs: - publish-stx-tox @@ -64,3 +66,11 @@ LIBS_FROM_GIT: keystone files: - ^devstack/.* + +- job: + name: stx-integ-pylint + parent: openstack-tox-pylint + required-projects: + - openstack/stx-config + - openstack/stx-fault + - openstack/stx-update diff --git a/pylint.rc b/pylint.rc new file mode 100755 index 000000000..d20b7606a --- /dev/null +++ b/pylint.rc @@ -0,0 +1,236 @@ +[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=unit_test.py + +# 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). +# E0203 access-member-before-definition +# E0602 undefined-variable +# E1101 no-member +# E1205 logging-too-many-args +# fixme +# W0102 dangerous-default-value +# W0105 pointless-string-statement +# W0106 expression-not-assigned +# W0201 attribute-defined-outside-init +# W0212 protected-access +# W0221 arguments-differ +# W0231 super-init-not-called +# W0235 useless-super-delegation +# W0611 unused-import +# W0612 Unused variable warning +# W0613 Unused argument warning +# W0621 redefined-outer-name +# W0622 redefined-builtin +# W0702 bare-except +# W0703 broad except warning +# W1201 logging-not-lazy +# W1401 anomalous-backslash-in-string +disable=C, R, E0203, E0602, E1101, E1205, fixme, + W0102, W0105, W0106, W0201, W0212, W0221, W0231, W0235, + W0611, W0612, W0613, W0621, W0622, W0702, W0703, W1201, W1401 + + +[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,sqlalchemy,scoped_session,_socketobject + +# 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/tox.ini b/tox.ini index 9c5db307d..7458a5d33 100644 --- a/tox.ini +++ b/tox.ini @@ -2,6 +2,7 @@ envlist = linters minversion = 2.3 skipsdist = True +stxdir = {toxinidir}/.. [testenv] install_command = pip install -U {opts} {packages} @@ -109,6 +110,38 @@ deps = commands = flake8 +[testenv:pylint] +basepython = python2.7 +deps = -r{toxinidir}/test-requirements.txt + -e{[tox]stxdir}/stx-update/tsconfig/tsconfig + -e{[tox]stxdir}/stx-fault/fm-api + -e{[tox]stxdir}/stx-config/sysinv/sysinv/sysinv + -e{[tox]stxdir}/stx-config/sysinv/cgts-client/cgts-client + docutils + keyring + libvirt-python + oslo_i18n + oslo_log + oslo_messaging + oslo_service + python-cephclient + python-cinderclient + python-glanceclient + python-keystoneclient + python-novaclient + SQLAlchemy + retrying + python-daemon==2.1.2 + pylint + +# There are currenrly 5 python modules with a setup.py file +commands = pylint --rcfile=./pylint.rc \ + ceph/ceph-manager/ceph-manager/ceph_manager \ + logging/logmgmt/logmgmt/logmgmt \ + tools/storage-topology/storage-topology/storage_topology \ + tools/vm-topology/vm-topology/vm_topology \ + utilities/platform-util/platform-util/platform_util + [testenv:venv] basepython = python3 commands = {posargs}