Add workflow to run tox jobs

Author: kajinamit

.coveragerc

@@ -0,0 +1,7 @@
+[run]
+branch = True
+source = tcib
+omit = tcib/tests/*
+
+[report]
+ignore_errors = True

.github/workflows/toxjobs.yml

@@ -0,0 +1,25 @@
+name: Run tox jobs
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  tox:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9']
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install tox
+    - name: Run lint jobs
+      run: tox -e linters
+    - name: Run unit tests
+      run: tox -e py3

.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+      - id: check-byte-order-marker
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: debug-statements
+      - id: check-yaml
+        files: .*\.(yaml|yml)$
+  - repo: https://github.com/pycqa/flake8.git
+    rev: 3.9.0
+    hooks:
+      - id: flake8
+  - repo: https://github.com/openstack-dev/bashate.git
+    rev: 2.0.0
+    hooks:
+      - id: bashate
+        entry: bashate --error . --ignore=E006,E040,E042
+        # Run bashate check for all bash scripts
+        # Ignores the following rules:
+        # E006: Line longer than 79 columns (as many scripts use jinja
+        #       templating, this is very difficult)
+        # E040: Syntax error determined using `bash -n` (as many scripts
+        #       use jinja templating, this will often fail and the syntax
+        #       error will be discovered in execution anyway)
+  - repo: https://github.com/PyCQA/pylint
+    rev: pylint-2.7.2
+    hooks:
+      - id: pylint

.pylintrc

@@ -0,0 +1,56 @@
+[MESSAGES CONTROL]
+
+disable =
+    # TODO(ssbarnea): remove temporary skips adding during initial adoption:
+    arguments-differ,
+    attribute-defined-outside-init,
+    broad-except,
+    consider-iterating-dictionary,
+    consider-merging-isinstance,
+    consider-using-dict-comprehension,
+    consider-using-in,
+    consider-using-set-comprehension,
+    dangerous-default-value,
+    duplicate-code,
+    fixme,
+    global-statement,
+    import-error,
+    inconsistent-return-statements,
+    invalid-name,
+    missing-class-docstring,
+    missing-function-docstring,
+    missing-module-docstring,
+    no-self-use,
+    no-value-for-parameter,
+    protected-access,
+    raise-missing-from,
+    redefined-argument-from-local,
+    redefined-builtin,
+    redefined-outer-name,
+    super-init-not-called,
+    super-with-arguments,
+    superfluous-parens,
+    too-few-public-methods,
+    too-many-ancestors,
+    too-many-arguments,
+    too-many-branches,
+    too-many-instance-attributes,
+    too-many-lines,
+    too-many-locals,
+    too-many-nested-blocks,
+    too-many-public-methods,
+    too-many-statements,
+    unidiomatic-typecheck,
+    unnecessary-comprehension,
+    unnecessary-pass,
+    unsubscriptable-object,
+    unused-argument,
+    unused-variable,
+    useless-else-on-loop,
+    useless-object-inheritance,
+    useless-super-delegation,
+    wrong-import-order,
+    wrong-import-position
+
+[REPORTS]
+output-format = colorized

tcib/client/container_image.py

@@ -47,7 +47,8 @@
 if sys.prefix != "/usr" and not os.path.isdir(CONTAINER_IMAGES_BASE_PATH):
     CONTAINER_IMAGES_BASE_PATH = os.path.join(
         "/usr", "share", "tcib", "container-images")
-CONTAINER_IMAGES_BASE_PATH = os.environ.get("TCIB_CONFIG_PATH", CONTAINER_IMAGES_BASE_PATH)
+CONTAINER_IMAGES_BASE_PATH = os.environ.get(
+    "TCIB_CONFIG_PATH", CONTAINER_IMAGES_BASE_PATH)
 
 
 class Build(command.Command):
@@ -688,9 +689,8 @@ def take_action(self, parsed_args):
                         "The file provided by <options-apply> does not "
                         "exist, check you settings and try again."
                     )
-                else:
-                    with open(parsed_args.extra_config) as f:
-                        generation_playbook["vars"] = yaml.safe_load(f)
+                with open(parsed_args.extra_config) as f:
+                    generation_playbook["vars"] = yaml.safe_load(f)
 
             playdata.append(generation_playbook)
 

tcib/client/utils.py

@@ -110,11 +110,11 @@ def __exit__(self, *args):
         if self.cleanup:
             self.clean()
         else:
-            LOG.warning("Not cleaning temporary directory [ %s ]" % self.dir)
+            LOG.warning("Not cleaning temporary directory [ %s ]", self.dir)
 
     def clean(self):
         shutil.rmtree(self.dir, ignore_errors=True)
-        LOG.info("Temporary directory [ %s ] cleaned up" % self.dir)
+        LOG.info("Temporary directory [ %s ] cleaned up", self.dir)
 
 
 def _encode_envvars(env):
@@ -124,8 +124,7 @@ def _encode_envvars(env):
     """
     for key, value in env.items():
         env[key] = str(value)
-    else:
-        return env
+    return env
 
 
 def makedirs(dir_path):
@@ -139,15 +138,13 @@ def makedirs(dir_path):
         os.makedirs(dir_path)
     except FileExistsError:
         LOG.debug(
-            'Directory "{}" was not created because it'
-            ' already exists.'.format(
-                dir_path
-            )
+            'Directory "%s" was not created because it already exists.',
+            dir_path
         )
         return False
-    else:
-        LOG.debug('Directory "{}" was created.'.format(dir_path))
-        return True
+
+    LOG.debug('Directory "%s" was created.', dir_path)
+    return True
 
 
 def playbook_verbosity(self):
@@ -244,7 +241,7 @@ def _playbook_check(play):
             play = os.path.join(playbook_dir, play)
             if not os.path.exists(play):
                 raise RuntimeError('No such playbook: {}'.format(play))
-        LOG.debug('Ansible playbook {} found'.format(play))
+        LOG.debug('Ansible playbook %s found', play)
         return play
 
     def _inventory(inventory):
@@ -267,9 +264,9 @@ def _inventory(inventory):
 
     def _running_ansible_msg(playbook, timeout=None):
         if timeout and timeout > 0:
-            return ('Running Ansible playbook with timeout %sm: %s,' %
+            return ('Running Ansible playbook with timeout %sm: %s' %
                     (timeout, playbook))
-        return ('Running Ansible playbook: %s,' % playbook)
+        return ('Running Ansible playbook: %s' % playbook)
 
     if not playbook_dir:
         playbook_dir = workdir
@@ -308,31 +305,27 @@ def _running_ansible_msg(playbook, timeout=None):
             )
 
         LOG.info(
-            _running_ansible_msg(playbook, timeout) +
-            ' multi-playbook execution: {}'
-            ' Working directory: {},'
-            ' Playbook directory: {}'.format(
-                verified_playbooks,
-                workdir,
-                playbook_dir
-            )
+            '%s,'
+            '  multi-playbook execution: %s,'
+            ' Working directory: %s,'
+            ' Playbook directory: %s',
+            _running_ansible_msg(playbook, timeout),
+            verified_playbooks,
+            workdir,
+            playbook_dir
         )
     else:
         playbook = _playbook_check(play=playbook)
         LOG.info(
-            _running_ansible_msg(playbook, timeout) +
-            ' Working directory: {},'
-            ' Playbook directory: {}'.format(
-                workdir,
-                playbook_dir
-            )
+            '%s, Working directory: %s, Playbook directory: %s',
+            _running_ansible_msg(playbook, timeout),
+            workdir,
+            playbook_dir
         )
 
     if limit_hosts:
         LOG.info(
-            'Running ansible with the following limit: {}'.format(
-                limit_hosts
-            )
+            'Running ansible with the following limit: %s', limit_hosts
         )
     ansible_fact_path = os.path.join(
         os.path.expanduser('~'),
@@ -441,8 +434,7 @@ def _running_ansible_msg(playbook, timeout=None):
             msg = "extra_env_variables must be a dict"
             LOG.error(msg)
             raise SystemError(msg)
-        else:
-            env.update(extra_env_variables)
+        env.update(extra_env_variables)
 
     if 'ANSIBLE_CONFIG' not in env and not ansible_cfg:
         ansible_cfg = os.path.join(workdir, 'ansible.cfg')
@@ -554,6 +546,4 @@ def _running_ansible_msg(playbook, timeout=None):
 
             raise RuntimeError(err_msg)
 
-    LOG.info(
-        'Ansible execution success. playbook: {}'.format(
-            playbook))
+    LOG.info('Ansible execution success. playbook: %s', playbook)

tox.ini

@@ -37,7 +37,6 @@ allowlist_externals =
 commands = {posargs}
 
 [testenv:linters]
-basepython=python39
 deps =
     virtualenv>=20.0.20
     pre-commit>=2.4.0