From 7f76bea9d3e884b7e2b3e55597b23410fc86a608 Mon Sep 17 00:00:00 2001 From: Al Bailey Date: Tue, 14 Mar 2023 19:50:11 +0000 Subject: [PATCH] Upload skeleton for unified software management Current Status: - minimal debian packaging - python skeleton - tox - zuul integration - pecan API skeleton - unit tests Next Steps: - CLI commands - API endpoints - controller - agent - expanded packaging Test Plan: PASS: Build and Install ISO PASS: tox PASS: 'software' is in the PATH and can be invoked. PASS: wget http://127.0.0.1:5490 returns 204 when software-api is running Story: 2010676 Task: 47754 Signed-off-by: Al Bailey Change-Id: I8e2d993ac85dcff7bb970ddf05fd63db9f2abe11 --- .zuul.yaml | 27 + debian_iso_image.inc | 3 + debian_pkg_dirs | 1 + debian_stable_wheels.inc | 1 + software/.coveragerc | 7 + software/Hacking.rst | 4 + software/LICENSE | 202 ++++++ software/README.rst | 5 + software/debian/deb_folder/changelog | 5 + software/debian/deb_folder/control | 20 + software/debian/deb_folder/copyright | 23 + software/debian/deb_folder/rules | 16 + software/debian/deb_folder/software.install | 2 + software/debian/deb_folder/source/format | 1 + software/debian/deb_folder/source/options | 1 + software/debian/meta_data.yaml | 9 + software/pylint.rc | 623 ++++++++++++++++++ software/requirements.txt | 3 + software/setup.cfg | 31 + software/setup.py | 11 + software/software/__init__.py | 0 software/software/api/__init__.py | 0 software/software/api/app.py | 54 ++ software/software/api/controllers/__init__.py | 0 software/software/api/controllers/root.py | 17 + software/software/cmd/__init__.py | 0 software/software/cmd/api.py | 78 +++ software/software/cmd/shell.py | 40 ++ software/software/config.py | 43 ++ software/software/tests/__init__.py | 0 software/software/tests/cmd/__init__.py | 0 software/software/tests/cmd/test_api.py | 33 + software/software/tests/cmd/test_shell.py | 24 + software/test-requirements.txt | 7 + software/tox.ini | 83 +++ 35 files changed, 1374 insertions(+) create mode 100644 software/.coveragerc create mode 100644 software/Hacking.rst create mode 100644 software/LICENSE create mode 100644 software/README.rst create mode 100644 software/debian/deb_folder/changelog create mode 100644 software/debian/deb_folder/control create mode 100644 software/debian/deb_folder/copyright create mode 100755 software/debian/deb_folder/rules create mode 100644 software/debian/deb_folder/software.install create mode 100644 software/debian/deb_folder/source/format create mode 100644 software/debian/deb_folder/source/options create mode 100644 software/debian/meta_data.yaml create mode 100644 software/pylint.rc create mode 100644 software/requirements.txt create mode 100644 software/setup.cfg create mode 100644 software/setup.py create mode 100644 software/software/__init__.py create mode 100644 software/software/api/__init__.py create mode 100644 software/software/api/app.py create mode 100644 software/software/api/controllers/__init__.py create mode 100644 software/software/api/controllers/root.py create mode 100644 software/software/cmd/__init__.py create mode 100644 software/software/cmd/api.py create mode 100644 software/software/cmd/shell.py create mode 100644 software/software/config.py create mode 100644 software/software/tests/__init__.py create mode 100644 software/software/tests/cmd/__init__.py create mode 100644 software/software/tests/cmd/test_api.py create mode 100644 software/software/tests/cmd/test_shell.py create mode 100644 software/test-requirements.txt create mode 100644 software/tox.ini diff --git a/.zuul.yaml b/.zuul.yaml index a888c819..98ea95d9 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -11,6 +11,8 @@ - py3-flake8 - patch-alarm-tox-pylint - patch-alarm-tox-py39 + - stx-software-tox-pylint + - stx-software-tox-py39 - sw-patch-tox-pylint - sw-patch-tox-py39 gate: @@ -20,6 +22,8 @@ - py3-flake8 - patch-alarm-tox-pylint - patch-alarm-tox-py39 + - stx-software-tox-pylint + - stx-software-tox-py39 - sw-patch-tox-pylint - sw-patch-tox-py39 post: @@ -43,6 +47,29 @@ vars: tox_envlist: flake8 +- job: + name: stx-software-tox-py39 + parent: tox-py39 + nodeset: debian-bullseye + files: + - software/* + vars: + tox_envlist: py39 + python_version: 3.9 + tox_extra_args: -c software/tox.ini + +- job: + name: stx-software-tox-pylint + parent: tox + nodeset: debian-bullseye + files: + - software/* + vars: + tox_envlist: pylint + python_version: 3.9 + tox_extra_args: -c software/tox.ini + + - job: name: sw-patch-tox-py39 parent: tox-py39 diff --git a/debian_iso_image.inc b/debian_iso_image.inc index 74fa7730..f202fab4 100644 --- a/debian_iso_image.inc +++ b/debian_iso_image.inc @@ -11,3 +11,6 @@ enable-dev-patch #patch-alarm python3-patch-alarm + +#software +software diff --git a/debian_pkg_dirs b/debian_pkg_dirs index dfe1b139..27986947 100644 --- a/debian_pkg_dirs +++ b/debian_pkg_dirs @@ -1,3 +1,4 @@ enable-dev-patch patch-alarm +software sw-patch diff --git a/debian_stable_wheels.inc b/debian_stable_wheels.inc index 36e6f927..964bcdac 100644 --- a/debian_stable_wheels.inc +++ b/debian_stable_wheels.inc @@ -1 +1,2 @@ cgcs-patch-wheel +software-wheel diff --git a/software/.coveragerc b/software/.coveragerc new file mode 100644 index 00000000..96ff290d --- /dev/null +++ b/software/.coveragerc @@ -0,0 +1,7 @@ +[run] +branch = True +source = software +omit = software/tests/* + +[report] +ignore_errors = True diff --git a/software/Hacking.rst b/software/Hacking.rst new file mode 100644 index 00000000..fd41ba8d --- /dev/null +++ b/software/Hacking.rst @@ -0,0 +1,4 @@ +Debian Changes: + +Updating the debian changelog: + dch -c deb_folder/changelog -i diff --git a/software/LICENSE b/software/LICENSE new file mode 100644 index 00000000..d6456956 --- /dev/null +++ b/software/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/software/README.rst b/software/README.rst new file mode 100644 index 00000000..da1b95ae --- /dev/null +++ b/software/README.rst @@ -0,0 +1,5 @@ +========== +software +========== + +StarlingX Unified Software Delivery and Management diff --git a/software/debian/deb_folder/changelog b/software/debian/deb_folder/changelog new file mode 100644 index 00000000..3a4456cb --- /dev/null +++ b/software/debian/deb_folder/changelog @@ -0,0 +1,5 @@ +software (1.0.1) unstable; urgency=medium + + * Initial release. + + -- Al Bailey Tue, 14 Mar 2023 18:49:14 +0000 diff --git a/software/debian/deb_folder/control b/software/debian/deb_folder/control new file mode 100644 index 00000000..579a0c16 --- /dev/null +++ b/software/debian/deb_folder/control @@ -0,0 +1,20 @@ +Source: software +Section: admin +Priority: optional +Maintainer: StarlingX Developers +Build-Depends: debhelper-compat (= 13), + dh-python, + python3-all, + python3-setuptools, + python3-wheel +Build-Depends-Indep: + python3-keystonemiddleware, + python3-oslo.config +Standards-Version: 4.5.1 +Homepage: https://www.starlingx.io +Rules-Requires-Root: no + +Package: software +Architecture: all +Description: StarlingX unified software deployment and management + StarlingX unified software deployment and management. diff --git a/software/debian/deb_folder/copyright b/software/debian/deb_folder/copyright new file mode 100644 index 00000000..cb2c2ad7 --- /dev/null +++ b/software/debian/deb_folder/copyright @@ -0,0 +1,23 @@ +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: software +Source: http://opendev.org/starlingx/update + +Files: * +Copyright: (c) 2013-2023 Wind River Systems, Inc + (c) Others (See individual files for more details) +License: Apache-2 + 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. + . + On Debian-based systems the full text of the Apache version 2.0 license + can be found in `/usr/share/common-licenses/Apache-2.0'. + diff --git a/software/debian/deb_folder/rules b/software/debian/deb_folder/rules new file mode 100755 index 00000000..21ea9eed --- /dev/null +++ b/software/debian/deb_folder/rules @@ -0,0 +1,16 @@ +#!/usr/bin/make -f +export DH_VERBOSE = 1 +export PYBUILD_NAME = software +export PBR_VERSION=1.0.0 + +ROOT := $(CURDIR)/debian/tmp + +%: + dh $@ --with python3 --buildsystem=pybuild + +override_dh_install: + python3 setup.py install -f --install-layout=deb --root=$(ROOT) + python3 setup.py bdist_wheel --universal -d $(CURDIR)/debian/$(PYBUILD_NAME)-wheels/usr/share/python-wheels + install -d -m 755 $(ROOT)/usr/bin + dh_install + diff --git a/software/debian/deb_folder/software.install b/software/debian/deb_folder/software.install new file mode 100644 index 00000000..78e37455 --- /dev/null +++ b/software/debian/deb_folder/software.install @@ -0,0 +1,2 @@ +/usr/bin +/usr/lib/python*/dist-packages/* diff --git a/software/debian/deb_folder/source/format b/software/debian/deb_folder/source/format new file mode 100644 index 00000000..d3827e75 --- /dev/null +++ b/software/debian/deb_folder/source/format @@ -0,0 +1 @@ +1.0 diff --git a/software/debian/deb_folder/source/options b/software/debian/deb_folder/source/options new file mode 100644 index 00000000..cb61fa52 --- /dev/null +++ b/software/debian/deb_folder/source/options @@ -0,0 +1 @@ +extend-diff-ignore = "^[^/]*[.]egg-info/" diff --git a/software/debian/meta_data.yaml b/software/debian/meta_data.yaml new file mode 100644 index 00000000..9ecbcd35 --- /dev/null +++ b/software/debian/meta_data.yaml @@ -0,0 +1,9 @@ +--- +debname: software +debver: 1.0.1 +src_path: . +revision: + dist: $STX_DIST + PKG_GITREVCOUNT: true + GITREVCOUNT: + BASE_SRCREV: d923bfaa381e2143bc5b961fe2a50a8deb6ee393 diff --git a/software/pylint.rc b/software/pylint.rc new file mode 100644 index 00000000..4211134e --- /dev/null +++ b/software/pylint.rc @@ -0,0 +1,623 @@ +[MAIN] + +# 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 + +# Clear in-memory caches upon conclusion of linting. Useful if running pylint +# in a server-like mode. +clear-cache-post-run=no + +# Load and enable all available extensions. Use --list-extensions to see a list +# all available extensions. +#enable-all-extensions= + +# In error mode, messages with a category besides ERROR or FATAL are +# suppressed, and no reports are done by default. Error mode is compatible with +# disabling specific errors. +#errors-only= + +# Always return a 0 (non-error) status code, even if lint errors are found. +# This is primarily useful in continuous integration scripts. +#exit-zero= + +# 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-allow-list= + +# 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. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold under which the program will exit with error. +fail-under=10 + +# Interpret the stdin as a python script, whose filename needs to be passed as +# the module_or_package argument. +#from-stdin= + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Add files or directories matching the regular expressions patterns to the +# ignore-list. The regex matches against paths and can be in Posix or Windows +# format. Because '\\' represents the directory delimiter on Windows systems, +# it can't be used as an escape character. +ignore-paths= + +# Files or directories matching the regular expression patterns are skipped. +# The regex matches against base names, not paths. The default value ignores +# Emacs file locks +ignore-patterns=^\.# + +# 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= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use, and will cap the count on Windows to +# avoid hangs. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.9 + +# Discover python modules and packages in the file system subtree. +recursive=no + +# Add paths to the list of the source roots. Supports globbing patterns. The +# source root is an absolute path or a path relative to the current working +# directory used to determine a package namespace for modules located under the +# source root. +source-roots= + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + +# In verbose mode, extra non-checker-related info will be displayed. +#verbose= + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. If left empty, argument names will be checked with the set +# naming style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. If left empty, attribute names will be checked with the set naming +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. If left empty, class attribute names will be checked +# with the set naming style. +#class-attribute-rgx= + +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE + +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. If left empty, class constant names will be checked with +# the set naming style. +#class-const-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. If left empty, class names will be checked with the set naming style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. If left empty, constant names will be checked with the set naming +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. If left empty, function names will be checked with the set +# naming style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. If left empty, inline iteration names will be checked +# with the set naming style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. If left empty, method names will be checked with the set naming style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. If left empty, module names will be checked with the set naming style. +#module-rgx= + +# 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. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Regular expression matching correct type alias names. If left empty, type +# alias names will be checked with the set naming style. +#typealias-rgx= + +# Regular expression matching correct type variable names. If left empty, type +# variable names will be checked with the set naming style. +#typevar-rgx= + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. If left empty, variable names will be checked with the set +# naming style. +#variable-rgx= + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit + +# 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] + +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= + +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= + +# 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 an if statement (see R0916). +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=1 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when caught. +overgeneral-exceptions=builtins.BaseException,builtins.Exception + + +[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=100 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# 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 + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow explicit reexports by alias from a package __init__. +allow-reexport-from-package=no + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to 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 + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, +# UNDEFINED. +confidence=HIGH, + CONTROL_FLOW, + INFERENCE, + INFERENCE_FAILURE, + UNDEFINED + +# 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 re-enable 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= + +# 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=c-extension-no-member + + +[METHOD_ARGS] + +# List of qualified names (i.e., library.method) which require a timeout +# parameter e.g. 'requests.api.get,requests.api.post' +timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +notes-rgx= + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'fatal', 'error', 'warning', 'refactor', +# 'convention', and 'info' which contain the number of messages in each +# category, as well as 'statement' which is the total number of statements +# analyzed. This score is used by the global evaluation report (RP0004). +evaluation=max(0, 0 if fatal else 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, e.g. +# mypackage.mymodule.MyReporterClass. +#output-format= + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[SIMILARITIES] + +# Comments are removed from the similarity computation +ignore-comments=yes + +# Docstrings are removed from the similarity computation +ignore-docstrings=yes + +# Imports are removed from the similarity computation +ignore-imports=yes + +# Signatures are removed from the similarity computation +ignore-signatures=yes + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. No available dictionaries : You need to install +# both the python package and the system dependency for enchant to work.. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear at the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[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 to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=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 symbolic message names to ignore for Mixin members. +ignored-checks-for-mixins=no-member, + not-async-context-manager, + not-context-manager, + attribute-defined-outside-init + +# 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,argparse.Namespace + +# 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 + +# Regex pattern to define which classes are considered mixins. +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-builtins= + +# 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. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io diff --git a/software/requirements.txt b/software/requirements.txt new file mode 100644 index 00000000..de94602e --- /dev/null +++ b/software/requirements.txt @@ -0,0 +1,3 @@ +oslo.config +oslo.log +pecan diff --git a/software/setup.cfg b/software/setup.cfg new file mode 100644 index 00000000..02a8fdfd --- /dev/null +++ b/software/setup.cfg @@ -0,0 +1,31 @@ +[metadata] +name = software +summary = A Project Gating System +description_file = + README.rst +author = StarlingX Team +author_email = starlingx-discuss@lists.starlingx.io +home_page = https://www.starlingx.io/ +python_requires = >=3.9 +license_files = LICENSE +classifier = + Environment :: OpenStack + Intended Audience :: Information Technology + Intended Audience :: System Administrators + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux + Programming Language :: Python + Programming Language :: Python :: 3 + Programming Language :: Python :: 3.9 + +[files] +packages = + software + +[entry_points] +console_scripts = + software = software.cmd.shell:main + software-api = software.cmd.api:main + +[wheel] +universal = 1 diff --git a/software/setup.py b/software/setup.py new file mode 100644 index 00000000..4729f4d8 --- /dev/null +++ b/software/setup.py @@ -0,0 +1,11 @@ +# +# Copyright (c) 2023 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# +import setuptools + +setuptools.setup( + setup_requires=['pbr'], + pbr=True +) diff --git a/software/software/__init__.py b/software/software/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/software/software/api/__init__.py b/software/software/api/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/software/software/api/app.py b/software/software/api/app.py new file mode 100644 index 00000000..2ea68485 --- /dev/null +++ b/software/software/api/app.py @@ -0,0 +1,54 @@ +""" +Copyright (c) 2023 Wind River Systems, Inc. + +SPDX-License-Identifier: Apache-2.0 + +""" + +import pecan + +from software.config import CONF + + +def get_pecan_config(): + """Load the pecan configuration.""" + pecan_opts = CONF.pecan + + cfg_dict = { + # todo(abailey): add server defaults to config + "server": { + "port": "5490", + "host": "127.0.0.1" + }, + "app": { + "root": pecan_opts.root, + "modules": pecan_opts.modules, + "debug": pecan_opts.debug, + "auth_enable": pecan_opts.auth_enable, + "force_canonical": pecan_opts.force_canonical, + "guess_content_type_from_ext": + pecan_opts.guess_content_type_from_ext, + } + } + return pecan.configuration.conf_from_dict(cfg_dict) + + +def setup_app(pecan_config=None): + """Setup the pecan REST API.""" + if not pecan_config: + pecan_config = get_pecan_config() + pecan.configuration.set_config(dict(pecan_config), overwrite=True) + + # todo(abailey): Add in the hooks + hooks = [] + + # todo(abailey): It seems like the call to pecan.configuration above + # mean that the following lines are redundnant? + app = pecan.make_app( + pecan_config.app.root, + debug=pecan_config.app.debug, + hooks=hooks, + force_canonical=pecan_config.app.force_canonical, + guess_content_type_from_ext=pecan_config.app.guess_content_type_from_ext + ) + return app diff --git a/software/software/api/controllers/__init__.py b/software/software/api/controllers/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/software/software/api/controllers/root.py b/software/software/api/controllers/root.py new file mode 100644 index 00000000..b999f0e2 --- /dev/null +++ b/software/software/api/controllers/root.py @@ -0,0 +1,17 @@ +""" +Copyright (c) 2023 Wind River Systems, Inc. + +SPDX-License-Identifier: Apache-2.0 + +""" +from pecan import expose + + +class RootController: + """pecan REST API root""" + + @expose() + @expose('json') + def index(self): + """index for the root""" + return {} diff --git a/software/software/cmd/__init__.py b/software/software/cmd/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/software/software/cmd/api.py b/software/software/cmd/api.py new file mode 100644 index 00000000..20e2e40c --- /dev/null +++ b/software/software/cmd/api.py @@ -0,0 +1,78 @@ +# +# Copyright (c) 2023 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# + +""" +API console script for Unified Software Management +""" +import gc +import socket +from wsgiref import simple_server + +from oslo_log import log as logging +from software.api.app import setup_app + + +LOG = logging.getLogger(__name__) + +# todo(abailey): these need to be part of config +API_PORT = 5490 +# Limit socket blocking to 5 seconds to allow for thread to shutdown +API_SOCKET_TIMEOUT = 5.0 + + +class RestAPI(): + """The base WSGI application""" + def __init__(self): + self.app = setup_app() + self.running = False + + def __call__(self, environ, start_response): + return self.app(environ, start_response) + + +class MyHandler(simple_server.WSGIRequestHandler): + """Overridden WSGIReqestHandler""" + def address_string(self): + # In the future, we could provide a config option to allow + # reverse DNS lookups. + return self.client_address[0] + + +def main(): + """Main entry point for API""" + # todo(abailey): process configuration + host = "127.0.0.1" + port = API_PORT + + # todo(abailey): configure logging + LOG.info(" + Starting Unified Software Management API") + + try: + simple_server.WSGIServer.address_family = socket.AF_INET + wsgi = simple_server.make_server( + host, port, + RestAPI(), + handler_class=MyHandler + ) + wsgi.socket.settimeout(API_SOCKET_TIMEOUT) + + running = True + while running: # run until an exception is raised + wsgi.handle_request() + + # Call garbage collect after wsgi request is handled, + # to ensure any open file handles are closed in the case + # of an upload. + gc.collect() + except KeyboardInterrupt: + LOG.warning(" - Received Control C. Shutting down.") + except BaseException: # pylint: disable=broad-exception-caught + LOG.exception(" - Unhandled API exception") + LOG.info(" - Stopping Unified Software Management API") + + +if __name__ == "__main__": + main() diff --git a/software/software/cmd/shell.py b/software/software/cmd/shell.py new file mode 100644 index 00000000..66179ef2 --- /dev/null +++ b/software/software/cmd/shell.py @@ -0,0 +1,40 @@ +# +# Copyright (c) 2023 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# + +""" +Command Line Interface for Unified Software Management +""" + +import logging +import sys + +BASENAME = 'software' +commands = ('capabilities', 'info', 'bash_completion') +logger = logging.getLogger(__name__) + + +class SoftwareShell: + """CLI Shell""" + def main(self, argv): + """Parse and run the commands for this CLI""" + print(f"Under construction {argv}") + + +def main(): + """Main entry point for CLI""" + try: + SoftwareShell().main(sys.argv[1:]) + except KeyboardInterrupt: + print(f"... terminating {BASENAME} client", file=sys.stderr) + sys.exit(130) + except Exception as ex: # pylint: disable=broad-exception-caught + logger.debug(ex, exc_info=1) + print(f"ERROR: {ex}", file=sys.stderr) + sys.exit(1) + + +if __name__ == "__main__": + main() diff --git a/software/software/config.py b/software/software/config.py new file mode 100644 index 00000000..8c0dc047 --- /dev/null +++ b/software/software/config.py @@ -0,0 +1,43 @@ +""" +Copyright (c) 2023 Wind River Systems, Inc. + +SPDX-License-Identifier: Apache-2.0 + +""" +from oslo_config import cfg + +# setup a shareable config +CONF = cfg.CONF + +# define the pecan configuration options +PECAN_CONFIG_GROUP = 'pecan' +# todo(abailey): Add help text for these options +pecan_opts = [ + cfg.StrOpt( + 'root', + default='software.api.controllers.root.RootController' + ), + cfg.ListOpt( + 'modules', + default=["software.api"] + ), + cfg.BoolOpt( + 'debug', + default=False + ), + cfg.BoolOpt( + 'auth_enable', + default=True + ), + cfg.BoolOpt( + 'force_canonical', + default=True + ), + cfg.BoolOpt( + 'guess_content_type_from_ext', + default=False + ), +] + +# register the configuration for this component +CONF.register_opts(pecan_opts, group=PECAN_CONFIG_GROUP) diff --git a/software/software/tests/__init__.py b/software/software/tests/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/software/software/tests/cmd/__init__.py b/software/software/tests/cmd/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/software/software/tests/cmd/test_api.py b/software/software/tests/cmd/test_api.py new file mode 100644 index 00000000..1009872e --- /dev/null +++ b/software/software/tests/cmd/test_api.py @@ -0,0 +1,33 @@ +# +# Copyright (c) 2023 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# +"""Unit tests for software.cmd.api""" + +# standard imports +import logging +from unittest import mock +from wsgiref.simple_server import WSGIServer + +# third-party libraries +from oslo_log import fixture as log_fixture +import testtools + +# local imports +from software.cmd import api + + +class SoftwareCmdAPITestCase(testtools.TestCase): + """Unit tests for software.cmd.api""" + + @mock.patch.object(WSGIServer, 'handle_request') + def test_main(self, mock_handle_request): + """Test main method""" + # Info and Warning logs are expected for this unit test. + # 'ERROR' logs are not expected. + self.useFixture( + log_fixture.SetLogLevel(['software'], logging.ERROR) + ) + mock_handle_request.side_effect = KeyboardInterrupt + api.main() diff --git a/software/software/tests/cmd/test_shell.py b/software/software/tests/cmd/test_shell.py new file mode 100644 index 00000000..24f36ef2 --- /dev/null +++ b/software/software/tests/cmd/test_shell.py @@ -0,0 +1,24 @@ +# +# Copyright (c) 2023 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# +"""Unit tests for shell.py""" + +# standard imports +from unittest import mock + +# third party imports +import testtools + +# local imports +from software.cmd import shell + + +class SoftwareShellTestCase(testtools.TestCase): + """Unit tests for shell""" + + @mock.patch('sys.argv', ['']) + def test_no_args(self): + """Test main method with no args""" + shell.main() diff --git a/software/test-requirements.txt b/software/test-requirements.txt new file mode 100644 index 00000000..43806539 --- /dev/null +++ b/software/test-requirements.txt @@ -0,0 +1,7 @@ +# The order of packages is significant, because pip processes them in this order +hacking + +bandit +coverage +pylint +stestr diff --git a/software/tox.ini b/software/tox.ini new file mode 100644 index 00000000..b28871c6 --- /dev/null +++ b/software/tox.ini @@ -0,0 +1,83 @@ +# +# Copyright (c) 2023 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# + +[tox] +envlist = pep8,py39,pylint,bandit,cover +minversion = 2.3.2 +skipsdist = True + +[testenv] +allowlist_externals = find + sh +basepython = python3 +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt +install_command = pip install \ + -c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/starlingx/root/raw/branch/master/build-tools/requirements/debian/upper-constraints.txt} \ + {opts} {packages} +passenv = + XDG_CACHE_HOME +setenv = VIRTUAL_ENV={envdir} + LANG=en_US.UTF-8 + LANGUAGE=en_US:en + LC_ALL=C + OS_STDERR_CAPTURE=1 + OS_STDOUT_CAPTURE=1 + OS_TEST_TIMEOUT=60 + PYTHONDONTWRITEBYTECODE=True + PYTHONHASHSEED=0 +sitepackages = False +usedevelop = true + +[bandit] +exclude = tests +skips = + +[testenv:bandit] +commands = bandit --ini tox.ini -n 5 -r software + +[testenv:cover] +setenv = + {[testenv]setenv} + PYTHON=coverage run --parallel-mode + +commands = + coverage erase + stestr run {posargs} + coverage combine + coverage html -d cover + coverage xml -o cover/coverage.xml + coverage report + +[flake8] +# H106: Don't put vim configuration in source files (off by default). +# H203: Use assertIs(Not)None to check for None (off by default). +# H904 Delay string interpolations at logging calls (off by default) +enable-extensions = H106 H203,H904 +exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,release-tag-* +ignore = +max-line-length = 80 +show-source = True + +[testenv:flake8] +commands = flake8 {posargs} + +[testenv:pep8] +commands = flake8 {posargs} + +[testenv:py39] +basepython = python3.9 +commands = + stestr run {posargs} + stestr slowest + +[testenv:pylint] +commands = pylint software --rcfile=./pylint.rc + +[stestr] +test_path=./software/tests +top_dir=./ +group_regex=([^\.]*\.)*