add revewdog

Signed-off-by: Bernhard Kaindl <[email protected]>

Author: bernhardkaindl

.coveragerc

@@ -28,3 +28,5 @@ exclude_lines =
 precision = 1
 include =
         xcp/*
+omit =
+        xcp/dmv.py

.github/workflows/main.yml

@@ -36,6 +36,7 @@ jobs:
     - uses: pre-commit-ci/[email protected]
       if: always()
 
+
   test:
     needs: pre-commit
     strategy:

.github/workflows/reviewdog-review.yml

@@ -0,0 +1,55 @@
+name: Reviewdog PR Review comments
+
+#
+# The reviewdog steps use reporter: github-pr-review, which submits the results
+# as a review comment on the pull request. It needs a GitHub token with
+# public_repo scope to post the comments and can only be used in the context
+# of a pull request.
+#
+on: pull_request
+
+#
+# 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
+#
+
+concurrency:  # On new workflow, cancel old workflows from the same PR, branch or tag:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  reviewdog:
+    runs-on: ubuntu-24.04
+    env:
+      REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.REVIEWDOG_GITHUB_API_TOKEN }}
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: 3.13
+
+    - name: Install uv and activate the environment
+      uses: astral-sh/setup-uv@v6
+      with:
+        activate-environment: true
+
+    - run: uv pip install pylint types-setuptools -r pyproject.toml --extra mypy
+
+    - uses: tsuyoshicho/action-mypy@v4
+      name: Run mypy with reviewdog to submit GitHub checks for warnings
+      if: ${{ github.actor != 'nektos/act' }}
+      with:
+        install_types: false
+        mypy_flags: --exclude python-libs-*/stubs/
+        reporter: github-pr-review
+        level: warning
+        github_token: ${{ secrets.REVIEWDOG_GITHUB_API_TOKEN }}
+
+    - uses: dciborow/[email protected]
+      name: Run pylint with reviewdog to submit GitHub checks for warnings
+      if: ${{ github.actor != 'nektos/act' }}
+      with:
+        reporter: github-pr-review
+        glob_pattern: "xcp tests"
+        github_token: ${{ secrets.REVIEWDOG_GITHUB_API_TOKEN }}

.pre-commit-config.yaml

@@ -101,7 +101,7 @@ repos:
         name: pytest unit tests and static analysis using tox
         types: [python]
         # entry: sh -c "pytest -x -rf --new-first --show-capture=all >/dev/tty"
-        entry: sh -c "tox >/dev/tty"
+        entry: sh -c "tox -e py311-cov-check-pytype-pyright-lint-mdreport >/dev/tty"
         verbose: true
         language: python
         require_serial: true

stubs/parameterized/__init__.pyi

@@ -21,13 +21,14 @@
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-import os
-import subprocess
+import errno
+import glob
 import json
+import os
 import re
 import struct
-import glob
-import errno
+import subprocess
+from typing import Any, Dict
 
 from .compat import open_with_codec_handling
 
@@ -91,37 +92,36 @@ def id_matches(id1, id2):
         return True
     return id1 == id2
 
-'''
-driver_pci_ids example:
-{
-        "abc.ko": [
-            {
-                "vendor_id": "14e4",
-                "device_id": "163c",
-                "subvendor_id": "*",
-                "subdevice_id": "*"
-            },
-            {
-                "vendor_id": "14e4",
-                "device_id": "163b",
-                "subvendor_id": "*",
-                "subdevice_id": "*"
-            }],
-        "de.ko": [
-            {
-                "vendor_id": "eees",
-                "device_id": "163c",
-                "subvendor_id": "*",
-                "subdevice_id": "*"
-            },
-            {
-                "vendor_id": "14f4",
-                "device_id": "16db",
-                "subvendor_id": "2123",
-                "subdevice_id": "1123"
-            }]
-}
-'''
+
+# driver_pci_ids example:
+# {
+#     "abc.ko": [
+#         {
+#             "vendor_id": "14e4",
+#             "device_id": "163c",
+#             "subvendor_id": "*",
+#             "subdevice_id": "*"
+#         },
+#         {
+#             "vendor_id": "14e4",
+#             "device_id": "163b",
+#             "subvendor_id": "*",
+#             "subdevice_id": "*"
+#         }],
+#     "de.ko": [
+#         {
+#             "vendor_id": "eees",
+#             "device_id": "163c",
+#             "subvendor_id": "*",
+#             "subdevice_id": "*"
+#         },
+#         {
+#             "vendor_id": "14f4",
+#             "device_id": "16db",
+#             "subvendor_id": "2123",
+#             "subdevice_id": "1123"
+#         }]
+# }
 def pci_matches(present_pci_id, driver_pci_ids):
     """Check if present PCI ID matches any of the driver PCI IDs."""
     merged_driver_pci_id_list = []
@@ -236,6 +236,8 @@ def parse_dmv_info(self, fpath):
         return json_data, json_formatted
 
 class DriverMultiVersionManager(object):
+    dmv_list = {}  # type: Dict[str, Any]
+
     def __init__(self, runtime=False):
         self.runtime = runtime
         self.dmv_list = {
@@ -296,7 +298,7 @@ def parse_dmv_list(self):
         for _, updates_dir, dmv_dir in get_all_kabi_dirs():
             if not os.path.isdir(dmv_dir):
                 continue
-    
+
             for path, _, files in os.walk(dmv_dir):
                 if "info.json" not in files:
                     continue