Merge pull request #27 from xenserver-next/py3-move-to-tox

Initial Python3 support with Test-Driven-Development enforced by CI
(git diff coverage and diff lint checking) with mypy, pyre and pytype

Author: bernhardkaindl

.coveragerc

@@ -12,6 +12,7 @@ exclude_lines =
     # Don't complain if tests don't hit defensive assertion code:
     raise AssertionError
     raise NotImplementedError
+    raise ValueError
     \<assert\>.*
 
     # Don't complain if non-runnable code isn't run:

.env

@@ -0,0 +1,11 @@
+#
+# Environment file picked up by act-cli.rpm, it can be run on Fedora 37 with podman:
+# act --bind --container-daemon-socket $XDG_RUNTIME_DIR/podman/podman.sock -W .github/workflows/main.yml
+# This offers lower minimum scores for tox.ini because the ACT containers don't
+# provides the cpio tool which is required for tests of xcp/cpiofile.py:
+#
+XCP_COV_MIN=53
+TESTS_COV_MIN=90
+DIFF_COV_MIN=75
+DIFF_COVCOMBINE_MIN=81
+GITHUB_STEP_SUMMARY=.github/workflows/.tox/GITHUB_STEP_SUMMARY.md

.github/workflows/main.yml

@@ -1,50 +1,82 @@
+# actions can be run locally using act and docker, on Fedora 37 also with podman, using:
+# https://github.com/nektos/act
+# sudo dnf install -y act-cli podman-docker
+# act --bind --container-daemon-socket $XDG_RUNTIME_DIR/podman/podman.sock -W .github/workflows/main.yml
+
 name: Unit tests
 
+# Checks can be skipped by adding "skip-checks: true" to a commit message,
+# or requested by adding "request-checks: true" if disabled by default for pushes:
+# https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks#skipping-and-requesting-checks-for-individual-commits
 on: [push, pull_request]
+env:
+  PYTHONWARNINGS: "ignore:DEPRECATION"
+  PIP_ROOT_USER_ACTION: "ignore"     # For local testing using act-cli
+  PIP_NO_WARN_SCRIPT_LOCATION: "0"   # For local testing using act-cli
+  PIP_DISABLE_PIP_VERSION_CHECK: "1" # Reduce noise in logs
 
 jobs:
-  test_py2:
-    runs-on: ubuntu-20.04
-
+  test:
+    strategy:
+      # See: https://github.com/xenserver/python-libs/pull/26#discussion_r1179482169
+      # max-parallel: 1
+      # Want to get the results of all the tests, don't terminate all on a fail:
+      fail-fast: false
+      matrix:
+        include:
+        - python-version: '3.11'
+          os: ubuntu-latest
+        # This tests with Python 2.7 and with Ubuntu-20.04's Python 3.8 for combined py2+3 coverage:
+        - python-version: '2.7'
+          os: ubuntu-20.04
+        - python-version: '3.10'
+          os: ubuntu-latest
+        - python-version: '3.9'
+          os: ubuntu-latest
+        - python-version: '3.7'
+          os: ubuntu-latest
+        - python-version: '3.6'
+          os: ubuntu-20.04
+    runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
-          fetch-depth: 0
-      - name: Set up Python 2.7
-        uses: actions/setup-python@v2
+          fetch-depth: 0  # Needed by diff-cover to get the changed lines: origin/master..HEAD
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
         with:
-          python-version: '2.7'
+          python-version: ${{ matrix.python-version }}
 
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements-dev.txt
-          # FIXME: branding.py still has no permanent home
-          curl https://gist.github.com/ydirson/3c36a7e19d762cc529a6c82340894ccc/raw/5ca39f621b1feab813e171f535c1aad1bd483f1d/branding.py -O -L
-          pip install pyliblzma
-          pip install -e .
-          command -v xz
-
-      - name: Test
+      - name: Run of tox on ubuntu-latest
+        if: ${{ startsWith(matrix.python-version, '3.') && matrix.python-version != 3.6 }}
         run: |
-          pytest --cov -rP
-          coverage xml
-          coverage html
-          coverage html -d htmlcov-tests --include="tests/*"
-          diff-cover --html-report coverage-diff.html coverage.xml
+          pip install 'virtualenv<20.22' 'tox>=4.5.1' tox-gh-actions
+          tox --workdir .github/workflows/.tox --recreate
 
-      - name: Pylint
+      # tox >= 4.0.0 is needed for using optional-dependencies from pyproject.toml, which is
+      # is not available for python <= 3.6, so use the python3.8 of Ubuntu-20.04 to install it:
+      - name: Install of tox on ubuntu-20.04 (to support optional-dependencies from pyproject.toml)
+        if: ${{ matrix.python-version == 2.7 || matrix.python-version == 3.6 }}
         run: |
-          pylint --version
-          pylint --exit-zero xcp/ tests/ setup.py
-          pylint --exit-zero --msg-template="{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}" xcp/ tests/ setup.py > pylint.txt
-          diff-quality --violations=pylint --html-report pylint-diff.html pylint.txt
+          set -xv;curl -sSL https://bootstrap.pypa.io/get-pip.py -o get-pip.py
+          python3.8 get-pip.py
+          python3.8 -m pip install 'virtualenv<20.22' 'tox>=4.5.1' tox-gh-actions
+
+      - name: Run tox4 with Python 3.8(to support optional-dependencies from pyproject.toml) for Python3.6
+        if: ${{ matrix.python-version == 3.6 }}
+        run: tox --workdir .github/workflows/.tox --recreate -e py36-lint
+
+      - name: Generate combined test-coverage with Python 2.7 and 3.8 for Upload
+        if: ${{ matrix.python-version == 2.7 }}
+        run: tox --workdir .github/workflows/.tox --recreate -e py38-covcombine
 
-      - uses: actions/upload-artifact@v3
+      - name: Upload coverage reports to Codecov
+        if: ${{ matrix.python-version == 2.7 }}
+        uses: codecov/codecov-action@v3
         with:
-          name: Coverage and pylint reports
-          path: |
-            coverage-diff.html
-            pylint-diff.html
-            htmlcov
-            htmlcov-tests
+          directory: .github/workflows/.tox/py38-covcombine/log
+          env_vars: OS,PYTHON
+          fail_ci_if_error: true
+          flags: unittest
+          name: py27-py38-combined
+          verbose: true

.github/workflows/pytype.cfg

@@ -0,0 +1,65 @@
+# NOTE: All relative paths are relative to the location of this file.
+
+[pytype]
+
+# Space-separated list of files or directories to exclude.
+exclude =
+
+# Space-separated list of files or directories to process.
+inputs = ../../xcp ../../tests
+
+# Keep going past errors to analyze as many files as possible.
+keep_going = True
+
+# Run N jobs in parallel. When 'auto' is used, this will be equivalent to the
+# number of CPUs on the host system.
+jobs = 4
+
+# All pytype output goes here.
+output = .pytype
+
+# Platform (e.g., "linux", "win32") that the target code runs on.
+platform = linux
+
+# Paths to source code directories, separated by ':'.
+# pythonpath = stubs
+
+# Python version (major.minor) of the target code.
+python_version = 3.10
+
+# Enable parameter count checks for overriding methods. This flag is temporary
+# and will be removed once this behavior is enabled by default.
+overriding_parameter_count_checks = True
+
+# Use the enum overlay for more precise enum checking. This flag is temporary
+# and will be removed once this behavior is enabled by default.
+# use_enum_overlay = True
+
+# Variables initialized as None retain their None binding. This flag is
+# temporary and will be removed once this behavior is enabled by default.
+# strict_none_binding = True
+
+# Opt-in: Do not allow Any as a return type.
+# no_return_any = True
+
+# Experimental: Infer precise return types even for invalid function calls.
+#precise_return = True
+
+# Experimental: Solve unknown types to label with structural types.
+# protocols = True
+
+# Experimental: Only load submodules that are explicitly imported.
+# strict_import = False
+
+# Experimental: Enable exhaustive checking of function parameter types.
+#strict_parameter_checks = True
+
+# Experimental: Emit errors for comparisons between incompatible primitive
+# types.
+#strict_primitive_comparisons = True
+
+# Space-separated list of error names to ignore.
+# disable = pyi-error
+
+# Don't report errors.
+#report_errors = True