From a69e6653579416f1b4c1546d2998fb8870cfffc7 Mon Sep 17 00:00:00 2001 From: Zhixiong Chi Date: Thu, 27 May 2021 23:09:25 -0400 Subject: [PATCH] stx tool: Initial the stx tool for starlingx debian building Create the 'stx' tool to implement the build system to support the starlingx debian. Now it's just a top command skeleton, later we will add the functional module to support more, like control|config. Meanwhile update the tox to include pep8 and pylint test for stx. Story: 2008862 Task: 42391 Change-Id: Ic5ec479ad3e311ecab28e4d5bc53c9debda7cba3 Signed-off-by: Zhixiong Chi --- .zuul.yaml | 4 + pylint.rc | 237 ++++++++++++++++++++++++++++++++++++++++ stx/bin/stx | 39 +++++++ stx/lib/stx/__init__.py | 26 +++++ stx/lib/stx/stx_main.py | 23 ++++ test-requirements.txt | 1 + tox.ini | 33 +++++- 7 files changed, 362 insertions(+), 1 deletion(-) create mode 100755 pylint.rc create mode 100755 stx/bin/stx create mode 100644 stx/lib/stx/__init__.py create mode 100644 stx/lib/stx/stx_main.py diff --git a/.zuul.yaml b/.zuul.yaml index 68c68134..8327a81a 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -6,9 +6,13 @@ check: jobs: - openstack-tox-linters + - openstack-tox-pep8 + - openstack-tox-pylint gate: jobs: - openstack-tox-linters + - openstack-tox-pep8 + - openstack-tox-pylint post: jobs: - stx-tools-upload-git-mirror diff --git a/pylint.rc b/pylint.rc new file mode 100755 index 00000000..34a963a7 --- /dev/null +++ b/pylint.rc @@ -0,0 +1,237 @@ +[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= + +# 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 (C)onvention +disable=C, + +[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=yes + +# 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). +# pylint is confused by sqlalchemy Table, as well as sqlalchemy Enum types +# ie: (unprovisioned, identity) +# LookupDict in requests library confuses pylint +ignored-classes=SQLObject, optparse.Values, thread._local, _thread._local, + Table, unprovisioned, identity, LookupDict + +# 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/stx/bin/stx b/stx/bin/stx new file mode 100755 index 00000000..3f595173 --- /dev/null +++ b/stx/bin/stx @@ -0,0 +1,39 @@ +#!/usr/bin/env python3 +# +# Copyright (c) 2021 Wind River Systems, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import os +import sys + +sys.path.insert(0, os.path.join(os.path.dirname(os.path.dirname(__file__)),'lib')) + +try: + import stx +except RuntimeError as exc: + sys.exit(str(exc)) + +from stx import stx_main + +if __name__ == "__main__": + try: + sys.exit(stx_main.stx_main()) + except stx_main.STXMainException as err: + sys.exit(err) + except stx.STXHandledException: + sys.exit(1) + except Exception: + import traceback + traceback.print_exc() + sys.exit(1) diff --git a/stx/lib/stx/__init__.py b/stx/lib/stx/__init__.py new file mode 100644 index 00000000..875c7242 --- /dev/null +++ b/stx/lib/stx/__init__.py @@ -0,0 +1,26 @@ +# +# STX Build System Python Library +# +# Copyright (c) 2021 Wind River Systems, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +__version__ = "1.0.0" + + +class STXHandledException(Exception): + """ + The big dilemma for generic stx code is what information to give the user + when an exception occurs. Any exception inheriting this base exception class + will provide information to the user。 + """ diff --git a/stx/lib/stx/stx_main.py b/stx/lib/stx/stx_main.py new file mode 100644 index 00000000..15a04f19 --- /dev/null +++ b/stx/lib/stx/stx_main.py @@ -0,0 +1,23 @@ +# +# Copyright (c) 2021 Wind River Systems, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +class STXMainException(Exception): + pass + + +def stx_main(): + + return 0 diff --git a/test-requirements.txt b/test-requirements.txt index 4dfcd348..66632c0a 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,3 +1,4 @@ bashate >= 0.2 PyYAML>=3.1.0 yamllint>=0.5.2 +hacking>=2.0<2.1 diff --git a/tox.ini b/tox.ini index 1ef026fd..50ca22ec 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = linters +envlist = linters,pep8,pylint minversion = 2.3 skipsdist = True @@ -32,6 +32,37 @@ commands = -name \*.sh \ -print0 | xargs -0 bashate -v -iE006,E040" +[testenv:pep8] +basepython = python3 +usedevelop = False +description = + Run style checks. + +commands = + flake8 stx + +[testenv:pylint] +basepython = python3 +sitepackages = False + +deps = {[testenv]deps} + ruamel.yaml + pylint<2.5.0 +commands = + pylint {posargs} --rcfile=./pylint.rc stx + +[flake8] +# E123, E125 skipped as they are invalid PEP-8. +# E501 skipped because some of the code files include templates +# that end up quite wide +# H404 multi line docstring should start without a leading new line +# H405 multi line docstring summary not separated with an empty line +# W504 line break after binary operator +# F401 'XXXXX' imported but unused +show-source = True +ignore = E123,E125,E501,H404,H405,W504,F401 +exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,release-tag-* + [testenv:venv] basepython = python3 commands = {posargs}