From af133fec2f1c3d11694420686e906c8d188ae32f Mon Sep 17 00:00:00 2001 From: Jessica Castelino Date: Thu, 28 Sep 2023 16:17:19 +0000 Subject: [PATCH] Build Software Client python wheels package MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit USM needs to build a python wheels package containing ONLY the ‘software’ cli client for inclusion in the Remote CLI Container. Test Plan: PASS Build software-client package PASS Build ISO PASS Install ISO PASS Run "software list" and "software upload" Story: 2010676 Task: 48851 Change-Id: Idb6d69a66d625291094501cacdb0bb84f511f81d Signed-off-by: Jessica Castelino --- debian_iso_image.inc | 1 + debian_pkg_dirs | 1 + software-client/debian/deb_folder/changelog | 5 + software-client/debian/deb_folder/control | 33 + software-client/debian/deb_folder/copyright | 23 + software-client/debian/deb_folder/rules | 18 + .../debian/deb_folder/software-client.install | 4 + .../debian/deb_folder/source/format | 1 + .../debian/deb_folder/source/options | 1 + software-client/debian/meta_data.yaml | 9 + software-client/pylint.rc | 658 ++++++++++++++++++ software-client/requirements.txt | 10 + .../service-files/software_client.completion | 0 software-client/setup.cfg | 28 + software-client/setup.py | 11 + software-client/software_client/__init__.py | 2 + software-client/software_client/constants.py | 63 ++ .../software_client}/software_client.py | 2 +- .../software_client/tests/__init__.py | 0 .../tests/test_software_client.py | 8 +- software-client/test-requirements.txt | 7 + software-client/tox.ini | 86 +++ software/debian/deb_folder/rules | 3 - software/debian/deb_folder/software.install | 2 - software/setup.cfg | 1 - 25 files changed, 966 insertions(+), 11 deletions(-) create mode 100644 software-client/debian/deb_folder/changelog create mode 100644 software-client/debian/deb_folder/control create mode 100644 software-client/debian/deb_folder/copyright create mode 100755 software-client/debian/deb_folder/rules create mode 100644 software-client/debian/deb_folder/software-client.install create mode 100644 software-client/debian/deb_folder/source/format create mode 100644 software-client/debian/deb_folder/source/options create mode 100644 software-client/debian/meta_data.yaml create mode 100644 software-client/pylint.rc create mode 100644 software-client/requirements.txt rename software/service-files/software.completion => software-client/service-files/software_client.completion (100%) create mode 100644 software-client/setup.cfg create mode 100644 software-client/setup.py create mode 100644 software-client/software_client/__init__.py create mode 100644 software-client/software_client/constants.py rename {software/software => software-client/software_client}/software_client.py (99%) create mode 100644 software-client/software_client/tests/__init__.py rename {software/software => software-client/software_client}/tests/test_software_client.py (94%) create mode 100644 software-client/test-requirements.txt create mode 100644 software-client/tox.ini diff --git a/debian_iso_image.inc b/debian_iso_image.inc index f202fab4..512e721b 100644 --- a/debian_iso_image.inc +++ b/debian_iso_image.inc @@ -14,3 +14,4 @@ python3-patch-alarm #software software +software-client diff --git a/debian_pkg_dirs b/debian_pkg_dirs index 27986947..71ab89f6 100644 --- a/debian_pkg_dirs +++ b/debian_pkg_dirs @@ -1,4 +1,5 @@ enable-dev-patch patch-alarm software +software-client sw-patch diff --git a/software-client/debian/deb_folder/changelog b/software-client/debian/deb_folder/changelog new file mode 100644 index 00000000..56ed9636 --- /dev/null +++ b/software-client/debian/deb_folder/changelog @@ -0,0 +1,5 @@ +software-client (1.0-1) UNRELEASED; urgency=medium + + * Initial release. + + -- Jessica Castelino Tue, 26 Sep 2023 20:05:44 +0000 diff --git a/software-client/debian/deb_folder/control b/software-client/debian/deb_folder/control new file mode 100644 index 00000000..018da48c --- /dev/null +++ b/software-client/debian/deb_folder/control @@ -0,0 +1,33 @@ +Source: software-client +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-client +Architecture: all +Depends: ${python3:Depends}, + ${misc:Depends}, + python3-argcomplete +Description: StarlingX unified software deployment and management client + StarlingX unified software deployment and management client. + + +Package: software-client-wheel +Architecture: all +Depends: ${python3:Depends}, ${misc:Depends}, python3-wheel +Description: StarlingX unified software deployment and management client + StarlingX unified software deployment and management client. + . + This is the support package for the PEP 427 wheel version of the package, + required for using pip inside a virtual environment. diff --git a/software-client/debian/deb_folder/copyright b/software-client/debian/deb_folder/copyright new file mode 100644 index 00000000..a94a1246 --- /dev/null +++ b/software-client/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) 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-client/debian/deb_folder/rules b/software-client/debian/deb_folder/rules new file mode 100755 index 00000000..4763c5f3 --- /dev/null +++ b/software-client/debian/deb_folder/rules @@ -0,0 +1,18 @@ +#!/usr/bin/make -f +export DH_VERBOSE = 1 +export PYBUILD_NAME = software-client +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/share/bash-completion/completions + install -m 755 -d ${ROOT}/etc/software-client + install -m 444 service-files/software_client.completion \ + ${ROOT}/usr/share/bash-completion/completions/software + dh_install diff --git a/software-client/debian/deb_folder/software-client.install b/software-client/debian/deb_folder/software-client.install new file mode 100644 index 00000000..96e9ca28 --- /dev/null +++ b/software-client/debian/deb_folder/software-client.install @@ -0,0 +1,4 @@ +usr/bin +usr/lib/python*/dist-packages/* +usr/share/ + diff --git a/software-client/debian/deb_folder/source/format b/software-client/debian/deb_folder/source/format new file mode 100644 index 00000000..d3827e75 --- /dev/null +++ b/software-client/debian/deb_folder/source/format @@ -0,0 +1 @@ +1.0 diff --git a/software-client/debian/deb_folder/source/options b/software-client/debian/deb_folder/source/options new file mode 100644 index 00000000..cb61fa52 --- /dev/null +++ b/software-client/debian/deb_folder/source/options @@ -0,0 +1 @@ +extend-diff-ignore = "^[^/]*[.]egg-info/" diff --git a/software-client/debian/meta_data.yaml b/software-client/debian/meta_data.yaml new file mode 100644 index 00000000..21cdbea9 --- /dev/null +++ b/software-client/debian/meta_data.yaml @@ -0,0 +1,9 @@ +--- +debname: software-client +debver: 1.0-1 +src_path: . +revision: + dist: $STX_DIST + PKG_GITREVCOUNT: true + GITREVCOUNT: + BASE_SRCREV: d923bfaa381e2143bc5b961fe2a50a8deb6ee393 diff --git a/software-client/pylint.rc b/software-client/pylint.rc new file mode 100644 index 00000000..089f84b2 --- /dev/null +++ b/software-client/pylint.rc @@ -0,0 +1,658 @@ +[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=lxml + +# 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". +# -Conventions- +# C0103 invalid-name +# C0114 missing-module-docstring +# C0115 missing-class-docstring +# C0116 missing-function-docstring +# C0209 consider-using-f-string +# C0301 line-too-long +# C0302 too-many-lines +# C0411 wrong-import-order +# C0415 import-outside-toplevel +# -Refactoring- +# R0205 useless-object-inheritance +# R0402 consider-using-from-import +# R0903 too-few-public-methods +# R0911 too-many-return-statements +# R0912 too-many-branches +# R0914 too-many-locals +# R0915 too-many-statements +# R1702 too-many-nested-blocks +# R1705 no-else-return +# R1714 consider-using-in +# R1722 consider-using-sys-exit +# R1724 no-else-continue +# R1725 super-with-arguments +# R1732 consider-using-with +# R1735 use-dict-literal +# -Warnings- +# W0602 global-variable-not-assigned +# W0603 global-statement +# W0718 broad-exception-raised +# W1514 unspecified-encoding +# W3101 missing-timeout +disable= C0103,C0114,C0115,C0116,C0209,C0301,C0302,C0411, + C0415,R0205,R0402,R0903,R0911,R0912,R0914,R0915, + R1702,R1705,R1714,R1722,R1724,R1725,R1732,R1735, + W0602,W0603,W0718,W1514,W3101, + +# 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=sh + +# 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-client/requirements.txt b/software-client/requirements.txt new file mode 100644 index 00000000..4ba0a8f3 --- /dev/null +++ b/software-client/requirements.txt @@ -0,0 +1,10 @@ +argcomplete +keystoneauth1 +keystonemiddleware +oslo.config +oslo.policy +oslo.serialization +netaddr +pecan +requests_toolbelt +WebOb diff --git a/software/service-files/software.completion b/software-client/service-files/software_client.completion similarity index 100% rename from software/service-files/software.completion rename to software-client/service-files/software_client.completion diff --git a/software-client/setup.cfg b/software-client/setup.cfg new file mode 100644 index 00000000..df92534f --- /dev/null +++ b/software-client/setup.cfg @@ -0,0 +1,28 @@ +[metadata] +name = software_client +summary = Unified Software Management Client +description = file: README.rst +author = StarlingX Team +author_email = starlingx-discuss@lists.starlingx.io +home_page = https://www.starlingx.io/ +license_files = LICENSE +classifiers = + 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 + +[options] +packages = find: +python_requires = >=3.9 + +[options.entry_points] +console_scripts = + software=software_client.software_client:main + +[wheel] +universal = 1 diff --git a/software-client/setup.py b/software-client/setup.py new file mode 100644 index 00000000..4729f4d8 --- /dev/null +++ b/software-client/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-client/software_client/__init__.py b/software-client/software_client/__init__.py new file mode 100644 index 00000000..3bf7dae5 --- /dev/null +++ b/software-client/software_client/__init__.py @@ -0,0 +1,2 @@ +# The version of this component +VERSION = 1.0 diff --git a/software-client/software_client/constants.py b/software-client/software_client/constants.py new file mode 100644 index 00000000..0ec789b1 --- /dev/null +++ b/software-client/software_client/constants.py @@ -0,0 +1,63 @@ +""" +Copyright (c) 2023 Wind River Systems, Inc. + +SPDX-License-Identifier: Apache-2.0 + +""" + +ADDRESS_VERSION_IPV4 = 4 +ADDRESS_VERSION_IPV6 = 6 +CONTROLLER_FLOATING_HOSTNAME = "controller" + +SOFTWARE_STORAGE_DIR = "/opt/software" + +AVAILABLE_DIR = "%s/metadata/available" % SOFTWARE_STORAGE_DIR +UNAVAILABLE_DIR = "%s/metadata/unavailable" % SOFTWARE_STORAGE_DIR +DEPLOYING_START_DIR = "%s/metadata/deploying_start" % SOFTWARE_STORAGE_DIR +DEPLOYING_HOST_DIR = "%s/metadata/deploying_host" % SOFTWARE_STORAGE_DIR +DEPLOYING_ACTIVATE_DIR = "%s/metadata/deploying_activate" % SOFTWARE_STORAGE_DIR +DEPLOYING_COMPLETE_DIR = "%s/metadata/deploying_complete" % SOFTWARE_STORAGE_DIR +DEPLOYED_DIR = "%s/metadata/deployed" % SOFTWARE_STORAGE_DIR +REMOVING_DIR = "%s/metadata/removing" % SOFTWARE_STORAGE_DIR +ABORTING_DIR = "%s/metadata/aborting" % SOFTWARE_STORAGE_DIR +COMMITTED_DIR = "%s/metadata/committed" % SOFTWARE_STORAGE_DIR +SEMANTICS_DIR = "%s/semantics" % SOFTWARE_STORAGE_DIR + +PATCH_AGENT_STATE_IDLE = "idle" +PATCH_AGENT_STATE_INSTALLING = "installing" +PATCH_AGENT_STATE_INSTALL_FAILED = "install-failed" +PATCH_AGENT_STATE_INSTALL_REJECTED = "install-rejected" + +ABORTING = 'aborting' +AVAILABLE = 'available' +COMMITTED = 'committed' +DEPLOYED = 'deployed' +DEPLOYING_ACTIVATE = 'deploying-activate' +DEPLOYING_COMPLETE = 'deploying-complete' +DEPLOYING_HOST = 'deploying-host' +DEPLOYING_START = 'deploying-start' +REMOVING = 'removing' +UNAVAILABLE = 'unavailable' +UNKNOWN = 'n/a' + + +STATUS_DEVELOPEMENT = 'DEV' +STATUS_OBSOLETE = 'OBS' +STATUS_RELEASED = 'REL' + +LOOPBACK_INTERFACE_NAME = "lo" + +SEMANTIC_PREAPPLY = 'pre-apply' +SEMANTIC_PREREMOVE = 'pre-remove' +SEMANTIC_ACTIONS = [SEMANTIC_PREAPPLY, SEMANTIC_PREREMOVE] + +DEPLOYMENT_STATE_ACTIVE = "Active" +DEPLOYMENT_STATE_INACTIVE = "Inactive" +DEPLOYMENT_STATE_PRESTAGING = "Prestaging" +DEPLOYMENT_STATE_PRESTAGED = "Prestaged" + +ISO_EXTENSION = ".iso" +SIG_EXTENSION = ".sig" +PATCH_EXTENSION = ".patch" +SUPPORTED_UPLOAD_FILE_EXT = [ISO_EXTENSION, SIG_EXTENSION, PATCH_EXTENSION] +SCRATCH_DIR = "/scratch" diff --git a/software/software/software_client.py b/software-client/software_client/software_client.py similarity index 99% rename from software/software/software_client.py rename to software-client/software_client/software_client.py index 4645e1f3..79afd220 100644 --- a/software/software/software_client.py +++ b/software-client/software_client/software_client.py @@ -12,7 +12,7 @@ import os import re import requests import signal -import software.constants as constants +import software_client.constants as constants import subprocess import sys import textwrap diff --git a/software-client/software_client/tests/__init__.py b/software-client/software_client/tests/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/software/software/tests/test_software_client.py b/software-client/software_client/tests/test_software_client.py similarity index 94% rename from software/software/tests/test_software_client.py rename to software-client/software_client/tests/test_software_client.py index 83b13cb7..cb3b1049 100644 --- a/software/software/tests/test_software_client.py +++ b/software-client/software_client/tests/test_software_client.py @@ -10,7 +10,7 @@ import sys import testtools from unittest import mock -from software import software_client +from software_client import software_client API_PORT = "5493" @@ -131,7 +131,7 @@ class SoftwareClientHelpTestCase(SoftwareClientTestCase, SoftwareClientNonRootMi print_help is invoked when there is a failure. """ - @mock.patch('software.software_client.check_for_os_region_name') + @mock.patch('software_client.software_client.check_for_os_region_name') @mock.patch('argparse.ArgumentParser.print_help') @mock.patch('argparse.ArgumentParser.print_usage') def test_main_no_args(self, mock_usage, mock_help, mock_check): @@ -142,7 +142,7 @@ class SoftwareClientHelpTestCase(SoftwareClientTestCase, SoftwareClientNonRootMi mock_help.assert_not_called() mock_check.assert_not_called() - @mock.patch('software.software_client.check_for_os_region_name') + @mock.patch('software_client.software_client.check_for_os_region_name') @mock.patch('argparse.ArgumentParser.print_help') @mock.patch('argparse.ArgumentParser.print_usage') def test_main_help(self, mock_usage, mock_help, mock_check): @@ -153,7 +153,7 @@ class SoftwareClientHelpTestCase(SoftwareClientTestCase, SoftwareClientNonRootMi mock_help.assert_called() mock_check.assert_not_called() - @mock.patch('software.software_client.check_for_os_region_name') + @mock.patch('software_client.software_client.check_for_os_region_name') @mock.patch('argparse.ArgumentParser.print_help') @mock.patch('argparse.ArgumentParser.print_usage') def test_main_invalid_action_calls_help(self, mock_usage, mock_help, mock_check): diff --git a/software-client/test-requirements.txt b/software-client/test-requirements.txt new file mode 100644 index 00000000..43806539 --- /dev/null +++ b/software-client/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-client/tox.ini b/software-client/tox.ini new file mode 100644 index 00000000..7dd12acb --- /dev/null +++ b/software-client/tox.ini @@ -0,0 +1,86 @@ +# +# Copyright (c) 2023 Wind River Systems, Inc. +# +# SPDX-License-Identifier: Apache-2.0 +# + +[tox] +envlist = pep8,py39,pylint +minversion = 2.3.2 +skipsdist = True +stxdir = {toxinidir}/../.. + +[testenv] +allowlist_externals = find + sh +basepython = python3 +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + -e{[tox]stxdir}/config/tsconfig/tsconfig + +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_client + +[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-* +max-line-length = 80 +show-source = True +ignore = E402,H306,H404,H405,W504,E501 + +[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_client --rcfile=./pylint.rc + +[stestr] +test_path=./software_client/tests +top_dir=./ +group_regex=([^\.]*\.)* diff --git a/software/debian/deb_folder/rules b/software/debian/deb_folder/rules index 28242507..6cdbd0bf 100755 --- a/software/debian/deb_folder/rules +++ b/software/debian/deb_folder/rules @@ -21,7 +21,6 @@ override_dh_install: install -d -m 755 $(ROOT)/usr/bin install -d -m 755 $(ROOT)/usr/sbin install -d -m 755 $(ROOT)/run - install -d -m 755 $(ROOT)/usr/share/bash-completion/completions install -m 755 -d ${ROOT}/etc/goenabled.d install -m 755 -d ${ROOT}/etc/init.d install -m 755 -d ${ROOT}/etc/logrotate.d @@ -47,8 +46,6 @@ override_dh_install: ${PMONDIR}/software-agent.conf install -m 444 service-files/*.service \ ${ROOT}/lib/systemd/system - install -m 444 service-files/software.completion \ - ${ROOT}/usr/share/bash-completion/completions/software install -m 400 service-files/software-functions \ ${ROOT}/etc/software/software-functions install -m 444 service-files/software-tmpdirs.conf \ diff --git a/software/debian/deb_folder/software.install b/software/debian/deb_folder/software.install index 18506da5..02b86a21 100644 --- a/software/debian/deb_folder/software.install +++ b/software/debian/deb_folder/software.install @@ -7,5 +7,3 @@ run/software-tmpdirs.conf usr/bin usr/lib/python*/dist-packages/* usr/sbin -usr/share/ - diff --git a/software/setup.cfg b/software/setup.cfg index ab153c8b..593c2903 100644 --- a/software/setup.cfg +++ b/software/setup.cfg @@ -33,7 +33,6 @@ exclude = [options.entry_points] console_scripts = - software = software.software_client:main software-controller-daemon = software.software_controller:main software-agent = software.software_agent:main