Refactor paths to use os.path methods.

Instead of using string manipulation and hardcoded
path separators, use the os.path.join method for better
consistency.

Add some initial pytest unit tests. Tests include one
to verify the generator can create a fluxcd application.

Apply flake8 corrections to entire codebase.
Apply pylint corrections to entire codebase.
Diabled bandit.

Update tox.ini file and test-requirements.txt

Make updates to .zuul.yaml to enable coverage tests
with helm. Coverage check will fail if coverage
falls below 55% for now. Zuul is using the same
version of helm as is current in STX; v3.12.2.

TODO - Make sure flake8, pylint, etc.. are good.

Test Plan:
PASS - Verify the generator can still build an example
       fluxcd app
TODO - Verify the generator can still buld an example
       armada app

Story: 2010937
Task: 48918
Task: 48917

Change-Id: I18a52cd98b730cc96b2b51cd4c1ab16785ad9857
Signed-off-by: Reed, Joshua <Joshua.Reed@windriver.com>

.coveragerc

@@ -0,0 +1,11 @@
+[run]
+omit =
+        *__init__*
+        *test_*
+        *conftest.py*
+
+[report]
+omit =
+        *__init__*
+        *test_*
+        *conftest.py*

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 100
+ignore = H101,H102

.gitignore

@@ -9,3 +9,4 @@ example/adminer
 .idea
 __pycache__
 *.egg-info/
+*.coverage

.pylintrc

@@ -0,0 +1,652 @@
+[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,
+                      asyncSetUp,
+                      __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=2
+
+
+[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*(# )?<?https?://\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=raw-checker-failed,
+        bad-inline-option,
+        locally-disabled,
+        file-ignored,
+        suppressed-message,
+        useless-suppression,
+        deprecated-pragma,
+        use-symbolic-message-instead,
+        use-implicit-booleaness-not-comparison-to-string,
+        use-implicit-booleaness-not-comparison-to-zero,
+        wrong-import-order,
+        too-many-branches,
+        too-many-statements,
+        fixme,
+        consider-using-enumerate,
+        broad-exception-caught,
+        subprocess-run-check,
+        no-else-return,
+        no-else-raise,
+        too-many-locals,
+        consider-using-dict-items,
+        anomalous-backslash-in-string,
+        too-many-lines,
+        invalid-name,
+        inconsistent-return-statements,
+        too-many-instance-attributes,
+        useless-object-inheritance,
+        consider-using-with
+
+# 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=
+
+
+[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,
+# json2 (improved json format), json (old json format) 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

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "editor.rulers": [
+        100
+    ],
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

.zuul.yaml

@@ -7,13 +7,13 @@
         - app-gen-tool-tox-py39
         - app-gen-tool-tox-flake8
         - app-gen-tool-tox-pylint
-        - app-gen-tool-tox-bandit
+        - app-gen-tool-tox-coverage
     gate:
       jobs:
         - app-gen-tool-tox-py39
         - app-gen-tool-tox-flake8
         - app-gen-tool-tox-pylint
-        - app-gen-tool-tox-bandit
+        - app-gen-tool-tox-coverage
 
 - job:
     name: app-gen-tool-tox-py39
@@ -28,6 +28,20 @@
       python_version: 3.9
       tox_extra_args: -c tox.ini
 
+- job:
+    name: app-gen-tool-tox-coverage
+    parent: tox-py39
+    description: |
+      Run coverage test for app-gen-tool
+    nodeset: debian-bullseye
+    pre-run: playbooks/app-gen-tool-tox-coverage/pre.yaml
+    files:
+      - ./*
+    vars:
+      tox_envlist: coverage
+      python_version: 3.9
+      tox_extra_args: -c tox.ini
+
 - job:
     name: app-gen-tool-tox-flake8
     parent: tox

README.md

@@ -14,7 +14,7 @@ Below you will find the steps to deploy an application as a **StarlingX App**.
     - [Metadata File Configuration](#metadata-file-configuration)
     - [App Setup configuration](#app-setup-configuration)
   - [Run the StarlingX App Generator](#run-the-starlingx-app-generator)
-    - [Flux Packaging](#flux-packaging)
+    - [FluxCD Packaging](#fluxcd-packaging)
       - [FluxCD Manifest](#fluxcd-manifest)
       - [Plugins](#plugins)
       - [Metadata](#metadata)
@@ -24,7 +24,7 @@ Below you will find the steps to deploy an application as a **StarlingX App**.
       - [Metadata](#metadata-1)
       - [Tarballs](#tarballs-1)
   - [Customizing the application](#customizing-the-application)
-    - [Flux Manifest](#flux-manifest)
+    - [FluxCD Manifest](#fluxcd-manifest)
       - [FluxCD](#fluxcd)
       - [Plugins](#plugins-1)
       - [Other files](#other-files)
@@ -357,13 +357,13 @@ In order to allow such customization, the generator provides additional
 functions to modify specific files in the package.
 
 ```shell
-starlingx-app-generator -i app_manifest.yaml -t <armada/flux/both> [-o ./output] [--overwrite] [--no-package]|[--package-only]
+starlingx-app-generator -i app_manifest.yaml -t <armada/fluxcd/both> [-o ./output] [--overwrite] [--no-package]|[--package-only]
 ```
 
 Where:
 
 - `-i/--input`: path to the `app_manifest.yaml` configuration file.
-- `-t/--type`: type of packaging, needs to choose between armada, flux or both.
+- `-t/--type`: type of packaging, needs to choose between armada, fluxcd or both.
 - `-o/--output`: output folder. Defaults to a new folder with the app name in
   the current directory.
 - `--overwrite`: deletes existing output folder before starting.

app_gen_tool/cmd/generator.py

@@ -1,11 +1,14 @@
-#!/usr/bin/env python
+"""Entry point for app generator CLI."""
 import sys
 
 from app_gen_tool.generator import main as gen_main
 
+
 def main():
+    """Main Method for CLI App Generator Tool."""
     gen_main(sys.argv[1:])
 
+
 # Entry point here kept to allow for debug/testing.
 if __name__ == "__main__":
     main()

app_gen_tool/common.py

@@ -1,2 +1,6 @@
-def to_camel_case(s):
+"""Module for common methods accross entire codebase."""
+
+
+def to_camel_case(s: str) -> str:
+    """Convert String to camel case."""
     return s[0].lower() + s.title().replace('_', '')[1:] if s else s

app_gen_tool/constants.py

@@ -1,21 +1,23 @@
-## Variables for armada packaging
+"""Declare Constants for Repository Here."""
+# Variables for armada packaging
 import getpass
 import os
 
-ARMADA_CHART_TEMPLATE = 'template_armada/armada-chart.template'
-ARMADA_CHARTGROUP_TEMPLATE = 'template_armada/armada-chartgroup.template'
-ARMADA_MANIFEST_TEMPLATE = 'template_armada/armada-manifest.template'
-BIN_FETCH_CHART_INFO = 'scripts/fetch_chart_info.sh'
+# Variables for Aramada packaging
+ARMADA_CHART_TEMPLATE = os.path.join('templates_armada', 'armada-chart.template')
+ARMADA_CHARTGROUP_TEMPLATE = os.path.join('templates_armada', 'armada-chartgroup.template')
+ARMADA_MANIFEST_TEMPLATE = os.path.join('templates_armada', 'armada-manifest.template')
 
-## Variables for FluxCD packaging
-FLUX_KUSTOMIZATION_TEMPLATE = 'templates_flux/kustomization.template'
-FLUX_BASE_TEMPLATES = 'templates_flux/base/'
-FLUX_MANIFEST_TEMPLATE = 'templates_flux/fluxcd-manifest'
-FLUX_COMMON_TEMPLATE = 'templates_plugins/common.template'
-FLUX_HELM_TEMPLATE = 'templates_plugins/helm.template'
-FLUX_KUSTOMIZE_TEMPLATE = 'templates_plugins/kustomize.template'
-FLUX_LIFECYCLE_TEMPLATE = 'templates_plugins/lifecycle.template'
+# Variables for FluxCD packaging
+FLUXCD_KUSTOMIZATION_TEMPLATE = os.path.join('templates_flux', 'kustomization.template')
+FLUXCD_BASE_TEMPLATES = os.path.join('templates_flux', 'base')
+FLUXCD_MANIFEST_TEMPLATE = os.path.join('templates_flux', 'fluxcd-manifest')
+FLUXCD_COMMON_TEMPLATE = os.path.join('templates_plugins', 'common.template')
+FLUXCD_HELM_TEMPLATE = os.path.join('templates_plugins', 'helm.template')
+FLUXCD_KUSTOMIZE_TEMPLATE = os.path.join('templates_plugins', 'kustomize.template')
+FLUXCD_LIFECYCLE_TEMPLATE = os.path.join('templates_plugins', 'lifecycle.template')
 
-
-TEMP_USER_DIR = '/tmp/' + getpass.getuser() + '/'
+# Other variables
+BIN_FETCH_CHART_INFO = os.path.join('scripts', 'fetch_chart_info.sh')
+TEMP_USER_DIR = os.path.join('tmp', getpass.getuser())
 APP_GEN_PY_PATH = os.path.split(os.path.realpath(__file__))[0]

app_gen_tool/generator.py

@@ -1,25 +1,29 @@
+"""Generator Main Module."""
 import getopt
 import os
-import sys
 import re
 import shutil
+import sys
 import yaml
 
 from app_gen_tool.application import Application
 
+
 def parse_yaml(yaml_in):
+    """Pare generator input yaml file."""
     yaml_data = ''
     try:
-        with open(yaml_in) as f:
+        with open(yaml_in, 'r', encoding='utf-8') as f:
             yaml_data = yaml.safe_load(f)
     except FileNotFoundError:
-        print('Error: %s no found' % yaml_in )
-    except Exception as e:
+        print('Error: {yaml_in} not found')
+    except Exception:
         print('Error: Invalid yaml file')
     return yaml_data
 
 
-def check_manifest(manifest_data):
+def check_manifest(manifest_data):  # pylint: disable=too-many-return-statements
+    """Check generator input yaml file for correct inputs."""
     # TODO: check more mandatory key/values in manifest yaml
 
     # check app values
@@ -35,15 +39,6 @@ def check_manifest(manifest_data):
         print('Error: \'appVersion\' is missing.')
         return False
 
-    # # check manifest values
-    # if 'manifest' not in manifest_data['appManifestFile-config']:
-    #     print('Error: \'manifest\'is missing.')
-    #     return False
-
-    # if 'releasePrefix' not in manifest_data['manifest']:
-    #     print('Error: Manifest attribute \'releasePrefix\' is missing.')
-    #     return False
-
     # check chartGroup values
     if 'chartGroup' not in manifest_data['appManifestFile-config']:
         print('Error: \'chartGroup\' is missing.')
@@ -67,45 +62,63 @@ def check_manifest(manifest_data):
 
         # check chart path, supporting: dir, git, tarball
         if 'path' not in chart:
-            print('Error: Chart attribute \'path\' is missing in chart %s.' % chart['name'])
+            print(f'Error: Chart attribute \'path\' is missing in chart {chart["name"]}.')
             return False
         else:
             # TODO: To support branches/tags in git repo
             if chart['path'].endswith('.git'):
                 if 'subpath' not in chart:
-                    print('Error: Chart attribute \'subpath\' is missing in chart %s.' % chart['name'])
+                    print(
+                        'Error: Chart attribute \'subpath\' is missing in '
+                        f'chart {chart["name"]}.'
+                    )
                     return False
                 chart['_pathType'] = 'git'
-                gitname = re.search('[^/]+(?=\.git$)',chart['path']).group()
+                gitname = re.search(r'[^/]+(?=\.git$)', chart['path']).group()
                 if gitname:
                     chart['_gitname'] = gitname
                 else:
-                    print('Error: Invalid \'path\' in chart %s.' % chart['name'])
-                    print('       only \'local dir\', \'.git\', \'.tar.gz\', \'.tgz\' are supported')
+                    print(f'Error: Invalid \'path\' in chart {chart["name"]}.')
+                    print(
+                        '       only \'local dir\', \'.git\', \'.tar.gz\', \'.tgz\' are supported'
+                    )
                     return False
             elif chart['path'].endswith('.tar.gz') or chart['path'].endswith('.tgz'):
                 if 'subpath' not in chart:
-                    print('Error: Chart attribute \'subpath\' is missing in chart %s.' % chart['name'])
+                    print(
+                        'Error: Chart attribute \'subpath\' is missing in '
+                        f'chart {chart["name"]}.'
+                    )
                     return False
                 chart['_pathType'] = 'tarball'
-                tarname = re.search('[^/]+(?=\.tgz)|[^/]+(?=\.tar\.gz)',chart['path']).group()
+                tarname = \
+                    re.search(
+                        r'[^/]+(?=\.tgz)|[^/]+(?=\.tar\.gz)',
+                        chart['path']
+                    ).group()
                 if tarname:
                     chart['_tarname'] = tarname
                 else:
-                    print('Error: Invalid \'path\' in chart %s.' % chart['name'])
-                    print('       only \'local dir\', \'.git\', \'.tar.gz\', \'.tgz\' are supported')
+                    print(f'Error: Invalid \'path\' in chart {chart["name"]}.')
+                    print(
+                        '       only \'local dir\', \'.git\', \'.tar.gz\', \'.tgz\' are supported'
+                    )
                     return False
             else:
 
                 if not os.path.isdir(chart['path']):
-                    print('Error: Invalid \'path\' in chart %s.' % chart['name'])
-                    print('       only \'local dir\', \'.git\', \'.tar.gz\', \'.tgz\' are supported')
+                    print(f'Error: Invalid \'path\' in chart {chart["name"]}.')
+                    print(
+                        '       only \'local dir\', \'.git\', \'.tar.gz\', \'.tgz\' are supported'
+                    )
                     return False
                 chart['_pathType'] = 'dir'
 
     return True
 
+
 def print_help():
+    """Print CLI Helm Menu."""
     print('StarlingX User Application Generator')
     print('')
     print('Usage:')
@@ -124,7 +137,7 @@ def print_help():
 
 
 def check_input_file(app_data) -> bool:
-    """ Checks if input file passed by user is valid"""
+    """Check if input file passed by user is valid."""
     if not app_data:
         print('Parse yaml error')
         return False
@@ -135,8 +148,7 @@ def check_input_file(app_data) -> bool:
 
 
 def check_app_directory(app_out, overwrite, package_only) -> bool:
-    """ Checks if the user gave enough information to modify or create
-    app folder directory."""
+    """Checks if the user gave enough information to modify or create app folder directory."""
 
     if os.path.exists(app_out) and not overwrite and not package_only:
         print(f'Output folder {app_out} exists, please remove it, use '
@@ -157,13 +169,15 @@ def create_app_directories(app_out, overwrite):
 
 
 def generate_app(app, package_type, no_package, package_only):
-    if package_type == 'armada' or package_type == 'both':
+    """Generate app based on application packaging type."""
+    if package_type == 'armada' or package_type == 'both':  # pylint: disable=consider-using-in
         app.gen_armada_app(app.output_folder, no_package, package_only)
-    if package_type == 'fluxcd' or package_type == 'both':
-        app.gen_flux_app(app.output_folder, no_package, package_only)
+    if package_type == 'fluxcd' or package_type == 'both':  # pylint: disable=consider-using-in
+        app.gen_fluxcd_app(app.output_folder, no_package, package_only)
 
 
 def main(argv):
+    """Main Method with argument parsing."""
     input_file = ''
     output_folder = '.'
     package_type = ''
@@ -171,8 +185,20 @@ def main(argv):
     package_only = False
     no_package = False
     try:
-        options, args = getopt.getopt(argv, 'hi:o:t:', \
-                ['help', 'input=', 'output=', 'type=', 'overwrite', 'no-package', 'package-only'])
+        options, _ = \
+            getopt.getopt(
+                argv,
+                'hi:o:t:',
+                [
+                    'help',
+                    'input=',
+                    'output=',
+                    'type=',
+                    'overwrite',
+                    'no-package',
+                    'package-only'
+                ]
+            )
     except getopt.GetoptError:
         print('Error: Invalid argument')
         sys.exit(1)
@@ -207,11 +233,13 @@ def main(argv):
         if not check_input_file(app_data):
             sys.exit(1)
 
-        app = Application(app_data, package_type)
-        app.output_folder = os.path.abspath(output_folder) + '/' + \
-                            app.get_app_name()
+        output_folder = os.path.abspath(output_folder)
+
+        app = Application(app_data, package_type, output_folder)
 
         if not check_app_directory(app.output_folder, overwrite, package_only):
             sys.exit(1)
+
         create_app_directories(app.output_folder, overwrite)
+
         generate_app(app, package_type, no_package, package_only)

bandit.yaml

@@ -0,0 +1 @@
+skips: [B603]

playbooks/app-gen-tool-tox-coverage/pre.yaml

@@ -0,0 +1,4 @@
+- hosts: all
+  roles:
+    - role: ensure-helm
+      helm_version: "3.12.2"

test-requirements.txt

@@ -3,3 +3,7 @@ bashate >= 0.2
 PyYAML >= 3.1.0
 shellcheck-py;python_version>="3.0" # MIT
 yamllint<1.26.1;python_version>="3.0" # GPLv2
+pylint
+bandit
+pytest
+coverage

tests/unit/resources/app-test.yaml

@@ -0,0 +1,46 @@
+---
+## App Manifest Configuration
+appManifestFile-config:
+  appName: app-adminer
+  appVersion: 1.0-1
+  namespace: default
+  chart:
+    - name: adminer
+      version: 0.2.1
+      path: ./tests/unit/resources/adminer/adminer
+  chartGroup:
+    - name:  adminer
+      chart_names:
+        -  adminer
+#################################################
+## App Metadata Configuration
+# for further details about possible configurations on this file, please
+# visit the link: https://wiki.openstack.org/wiki/StarlingX/Containers/StarlingXAppsInternals#metadata.yaml
+metadataFile-config:
+  # the following configurations are optional
+  # uncomment and configure properly the ones you need for your application metadata
+  upgrades:
+    auto_update: true
+
+  supported_k8s_version:
+    minimum: 1.21.8
+    maximum: 1.26.1
+
+  k8s_upgrades:
+    auto_update: true
+    timing: pre
+
+  maintain_user_overrides: true
+
+
+#################################################
+## App Setup Configuration
+# if you wish to see a setup.cfg example, please see the link
+# https://opendev.org/starlingx/app-dell-storage/src/branch/master/python3-k8sapp-dell-storage/k8sapp_dell_storage/setup.cfg
+setupFile-config:
+  metadata:
+    author: StarlingX
+    author_email: starlingx-discuss@lists.starlingx.io
+    url: https://www.starlingx.io/
+    classifier:
+      - "Environment :: OpenStack"

tests/unit/test_application_class.py

@@ -0,0 +1,64 @@
+import os
+import shutil
+import tarfile
+
+from app_gen_tool.application import Application
+from app_gen_tool.generator import parse_yaml, create_app_directories, generate_app, check_input_file
+
+def _extract(tar_url, extract_path='.'):
+    tar = tarfile.open(tar_url, 'r')
+    for item in tar:
+        tar.extract(item, extract_path)
+        if item.name.find(".tgz") != -1 or item.name.find(".tar") != -1:
+            _extract(item.name, "./" + item.name[:item.name.rfind('/')])
+
+class TestCameCase:
+
+    def setup_class(cls):
+
+        current_file = os.path.abspath(__file__)
+        current_folder = os.path.dirname(current_file)
+        resource_folder = os.path.join(current_folder, 'resources')
+        input_file = os.path.join(resource_folder, 'app-test.yaml')
+        test_helm_chart = os.path.join(resource_folder, 'adminer-0.2.1.tgz')
+
+        cls.OUTPUT_FOLDER = os.path.join(current_folder, "TEST_OUTPUT")
+        cls.helm_chart_folder = os.path.join(resource_folder, 'adminer')
+        cls.app_data = parse_yaml(input_file)
+
+        if not os.path.exists(cls.OUTPUT_FOLDER):
+            os.makedirs(cls.OUTPUT_FOLDER, exist_ok=True)
+
+        if not os.path.exists(cls.helm_chart_folder):
+            _extract(test_helm_chart, cls.helm_chart_folder)
+
+    def teardown_class(cls):
+
+        if os.path.exists(cls.OUTPUT_FOLDER):
+            shutil.rmtree(cls.OUTPUT_FOLDER)
+
+        if os.path.exists(cls.helm_chart_folder):
+            shutil.rmtree(cls.helm_chart_folder)
+
+    def test_generate_fluxcd_app(self):
+
+        package_type = "fluxcd"
+        overwrite = True
+        package_only = False
+        no_package = False
+
+        if not check_input_file(self.app_data):
+            assert False
+
+        app = Application(self.app_data, package_type, self.OUTPUT_FOLDER)
+
+        create_app_directories(app.output_folder, overwrite)
+
+        generate_app(app, package_type, no_package, package_only)
+
+        output_file = \
+            os.path.join(self.OUTPUT_FOLDER, 'app-adminer', "FluxCD", 'app-adminer-1.0-1.tgz')
+
+        file_exists = os.path.exists(output_file)
+
+        assert file_exists == True

tests/unit/test_camel_case.py

@@ -0,0 +1,18 @@
+from app_gen_tool.common import to_camel_case
+
+
+class TestCameCase:
+
+    def setup_class(cls):
+        pass
+
+    def teardown_class(cls):
+        pass
+
+    def test_camel_case(self):
+
+        input_string = "ThisIsAString"
+        output_string = to_camel_case(input_string)
+
+        assert output_string == input_string.lower()
+

tox.ini

@@ -151,7 +151,7 @@ usedevelop = False
 skip_install = True
 deps = -r{toxinidir}/test-requirements.txt
 commands =
-    flake8
+    flake8 ./app_gen_tool
 
 [testenv:venv]
 basepython = python3
@@ -159,12 +159,44 @@ commands = {posargs}
 
 [testenv:flake8]
 basepython = python3
-description = Dummy environment to allow flake8 to be run in subdir tox
+description = Run Flake8 Linter
+commands =
+    flake8 ./app_gen_tool
 
 [testenv:pylint]
 basepython = python3
-description = Dummy environment to allow pylint to be run in subdir tox
+description = Run pylint linter
+commands =
+    pylint ./app_gen_tool
 
 [testenv:bandit]
 basepython = python3
-description = Dummy environment to allow bandit to be run in subdir tox
+description = Run bandit check
+commands =
+    bandit -c ./bandit.yaml -r ./app_gen_tool
+
+[testenv:pytest]
+basepython = python3
+description = Run bandit check
+commands =
+    pytest tests/
+
+
+[testenv:coverage-run]
+basepython = python3
+description = Run pytest with code coverage check
+commands =
+    coverage run -m pytest -s tests/
+
+[testenv:coverage-report]
+basepython = python3
+description = Run pytest with code coverage report
+commands =
+    coverage report --fail-under=55
+
+[testenv:coverage]
+basepython = python3
+description = Run coverage report
+commands =
+    {[testenv:coverage-run]commands}
+    {[testenv:coverage-report]commands}