From 09f63f7cc951a0a3b000cd2f3b49746d4354f817 Mon Sep 17 00:00:00 2001 From: Al Bailey Date: Mon, 16 Sep 2019 17:01:32 -0500 Subject: [PATCH] Adding pylint target to utilities for zuul validation. This target cannot be included as part of openstack-tox-linters because the required-projects for pylint are config and fault. No code changes are submitted as part of this review. The suppressed errors can be un-suppressed as the code gets cleaned up in later reviews. Change-Id: Ica70f77e6cab8cea8647950428701146faf38c2d Story: 2004515 Task: 36667 Signed-off-by: Al Bailey --- .zuul.yaml | 13 +++ pylint.rc | 261 ++++++++++++++++++++++++++++++++++++++++++ test-requirements.txt | 1 + tox.ini | 29 +++++ 4 files changed, 304 insertions(+) create mode 100755 pylint.rc diff --git a/.zuul.yaml b/.zuul.yaml index 7ccbd0a6..62452c45 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -3,6 +3,19 @@ check: jobs: - openstack-tox-linters + - stx-tox-pylint gate: jobs: - openstack-tox-linters + - stx-tox-pylint + +- job: + name: stx-tox-pylint + parent: tox + description: | + Run pylint tests + required-projects: + - starlingx/fault + - starlingx/config + vars: + tox_envlist: pylint diff --git a/pylint.rc b/pylint.rc new file mode 100755 index 00000000..08558a84 --- /dev/null +++ b/pylint.rc @@ -0,0 +1,261 @@ +[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. 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= + +# Use multiple processes to speed up Pylint. +jobs=4 + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + +# 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=lxml.etree,greenlet + + +[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). +# See "Messages Control" section of +# https://pylint.readthedocs.io/en/latest/user_guide +# We are disabling todo/fixme +# We are disabling (C)onvention +# We are disabling (R)efactor +# These error checks should be enabled whenever the code is cleaned up: +# E0203: access-member-before-definition +# E0401: import-error +# E0611: no-name-in-module +# E1101: no-member +# E1135: unsupported-membership-test +# E1205: logging-too-many-args +# W0107: unnecessary-pass +# W0150: lost-exception +# W0201: attribute-defined-outside-init +# W0221: arguments-differ +# W0231: super-init-not-called +# W0235: useless-super-delegation +# W0603: global-statement +# W0611: unused-import +# W0612: unused-variable +# W0613: unused-argument +# W0621: redefined-outer-name +# W0622: redefined-builtin +# W0702: bare-except +# W0703: broad-except +# W1201: logging-not-lazy +# W1202: logging-format-interpolation +# W1401: anomalous-backslash-in-string +disable=C,R,fixme, + E0203,E0401,E0611,E1101,E1135,E1205, + W0107,W0150,W0201,W0221,W0231,W0235,W0603,W0611,W0612,W0613,W0621,W0622, + W0702,W0703,W1201,W1202,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 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 +ignored-modules=distutils,eventlet.green.subprocess,six,six.moves + +# List of classes names for which member attributes should not be checked +# (useful for classes with attributes dynamically set). +ignored-classes=SQLObject, optparse.Values, thread._local, _thread._local + +# 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/test-requirements.txt b/test-requirements.txt index 8ae3e22f..6c74ddf3 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,3 +1,4 @@ # hacking pulls in flake8 hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 bashate >= 0.2 +pylint diff --git a/tox.ini b/tox.ini index 164fe1ed..5e22eec4 100644 --- a/tox.ini +++ b/tox.ini @@ -4,6 +4,8 @@ minversion = 2.3 skipsdist = True sitepackages=False +stxdir = {toxinidir}/.. + [testenv] install_command = pip install -U {opts} {packages} setenv = @@ -70,6 +72,33 @@ max-line-length=80 commands = flake8 +[testenv:pylint] +basepython = python3 +sitepackages = False +deps = + {[testenv]deps} + -e{[tox]stxdir}/config/tsconfig/tsconfig + -e{[tox]stxdir}/config/sysinv/sysinv/sysinv + -e{[tox]stxdir}/fault/fm-api + keyring + keystoneauth1 + libvirt-python + oslo.messaging + oslo.service + pyinotify + python-daemon + python-novaclient + +commands = pylint {posargs} \ + ceph/ceph-manager/ceph-manager/ceph_manager \ + ceph/python-cephclient/python-cephclient/cephclient \ + utilities/logmgmt/logmgmt/logmgmt/ \ + utilities/pci-irq-affinity-agent/pci_irq_affinity/pci_irq_affinity \ + utilities/platform-util/platform-util/platform_util \ + utilities/pm-qos-mgr/src/pm_qos_mgr \ + --rcfile=./pylint.rc + + [testenv:linters] commands = {[testenv:bashate]commands}