misc(ci): Adding a basic pipeline to run linters and test

Author: rboni-dk

.github/workflows/pull_request.yml

@@ -0,0 +1,49 @@
+name: Pull Request Checks
+
+on:
+  pull_request:
+    branches: [ main ]
+
+  workflow_dispatch:
+
+jobs:
+  ruff:
+    name: Lint with ruff
+    uses: ./.github/workflows/python-job.yml
+    with:
+      run: |
+        ruff check --show-fixes
+        ruff format --check --diff
+
+    secrets: inherit
+
+  test:
+    name: Run tests
+    uses: ./.github/workflows/python-job.yml
+    with:
+      run: |
+        set -o pipefail
+        mkdir reports
+        pytest --junit-xml=reports/pytest.xml --cov --cov-report=term-missing:skip-covered | tee reports/coverage.txt
+      artifact: pytest-results
+      artifact_path: reports/
+    secrets: inherit
+
+  report-coverage:
+    name: Report tests coverage
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'pull_request' }}
+    needs: [test]
+    steps:
+      - name: Download Pytest results
+        uses: actions/download-artifact@v4
+        with:
+          name: pytest-results
+          path: reports
+
+      - name: Add PR comment
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          junitxml-path: reports/pytest.xml
+          pytest-coverage-path: reports/coverage.txt
+          report-only-changed-files: true

.github/workflows/python-job.yml

@@ -0,0 +1,52 @@
+name: Python Job
+
+on:
+  workflow_call:
+    inputs:
+      python-version:
+        type: string
+        default: "3.9"
+      run:
+        required: true
+        type: string
+      artifact:
+        type: string
+        default: ''
+        required: false
+      artifact_path:
+        type: string
+        default: ''
+        required: false
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+        with:
+          ref: "${{ github.head_ref || github.ref }}"
+
+      - name: Set up Python ${{ inputs.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          cache: 'pip'
+          python-version: ${{ inputs.python-version }}
+
+      - name: Install project dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev,test]
+
+      - name: Run Command
+        run: |
+          ${{ inputs.run }}
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        if: ${{ github.event.inputs.artifact == '' || github.event.inputs.artifact_path == '' }}
+        with:
+          name: ${{ inputs.artifact }}
+          path: ${{ inputs.artifact_path }}
+          if-no-files-found: ignore
+

dk-installer.py

@@ -27,8 +27,7 @@
 import urllib.request
 import urllib.parse
 import zipfile
-
-
+import typing
 #
 # Initial setup
 #
@@ -288,7 +287,7 @@ def console_tee(text, skip_logging=False):
 @dataclasses.dataclass
 class Requirement:
     key: str
-    cmd: tuple[str, ...]
+    cmd: tuple[typing.Union[str, pathlib.Path], ...]
     fail_msg: tuple[str, ...]
 
     def check_availability(self, action, args):
@@ -316,9 +315,9 @@ class CommandFailed(Exception):
 
     def __init__(
         self,
-        idx: int | None = None,
-        cmd: str | None = None,
-        ret_code: int | None = None,
+        idx: typing.Union[int, None] = None,
+        cmd: typing.Union[str, None] = None,
+        ret_code: typing.Union[int, None] = None,
     ):
         if any((idx, cmd, ret_code)) and not all((idx, cmd)):
             raise ValueError(f"{self.__class__.__name__} requires 'idx' and 'cmd' to be set unless all args are None.")
@@ -344,7 +343,7 @@ def __init__(self, action, args):
         self.action = action
         self.args = args
 
-    def _hash_value(self, value: bytes | str, digest_size: int = 8) -> str:
+    def _hash_value(self, value: typing.Union[bytes, str], digest_size: int = 8) -> str:
         if isinstance(value, str):
             value = value.encode()
         return hashlib.blake2b(value, salt=self.get_instance_id().encode(), digest_size=digest_size).hexdigest()
@@ -527,7 +526,7 @@ def configure_logging(self, debug=False):
 
     def _get_failed_cmd_log_file_path(
         self, exception: Exception
-    ) -> tuple[CommandFailed, pathlib.Path] | tuple[None, None]:
+    ) -> typing.Union[tuple[CommandFailed, pathlib.Path], tuple[None, None]]:
         while exception:
             if isinstance(exception, CommandFailed):
                 break
@@ -2439,7 +2438,7 @@ def run_installer(args):
         "Disable sending analytics data",
         key="send_analytics_data",
         value="--no-analytics",
-        msg="Sending analytcs data has been disabled for this session.",
+        msg="Sending analytics data has been disabled for this session.",
     )
     cfg_menu.add_option(
         "Enable sending analytics data",