test(RHTAPWATCH-643): Adding python tests to CI

Signed-off-by: Yftach Herzog <[email protected]>

.github/workflows/test.yaml

@@ -0,0 +1,23 @@
+name: tests
+
+on:
+  pull_request:
+    branches: [ main ]
+jobs:
+  test:
+    permissions:
+      checks: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.11
+      - name: Install pipenv
+        run: pip install pipenv==2023.7.23
+      - name: Create virtualenv
+        run: pipenv sync
+      - name: Run tests
+        run: |
+          pipenv run pytest tests

Pipfile

@@ -0,0 +1,18 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+pytest = "*"
+black = "*"
+mypy = "*"
+pylint = "*"
+isort = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.11"
+
+[scripts]

compose_generator/compose_generator.py

@@ -1,3 +1,4 @@
+"""Top level generic entity for creating a compose"""
 from dataclasses import dataclass
 
 from .protocols import (
@@ -20,6 +21,7 @@ class ComposeGenerator:
     :param requestor: an object to request a new composed
     :param fetcher: an object to fetch a compose once it's ready
     """
+
     configurations_generator: ComposeConfigurationsGenerator
     requestor: ComposeRequester
     fetcher: ComposeFetcher

compose_generator/odcs_compose_generator.py

@@ -1,9 +1,11 @@
 #!/usr/bin/env python3
 
+"""Initialize and us a compose generator using ODCS"""
+
+from .compose_generator import ComposeGenerator
+from .odcs_configurations_generator import ODCSConfigurationsGenerator
 from .odcs_fetcher import ODCSFetcher
 from .odcs_requester import ODCSRequester
-from .odcs_configurations_generator import ODCSConfigurationsGenerator
-from .compose_generator import ComposeGenerator
 
 
 def main():

compose_generator/odcs_configurations_generator.py

@@ -1,3 +1,4 @@
+"""Configurations generator for ODCS compose"""
 from dataclasses import dataclass
 
 from .protocols import ComposeConfigurations, ComposeConfigurationsGenerator
@@ -18,6 +19,7 @@ class ODCSConfigurationsGenerator(ComposeConfigurationsGenerator):
     :param container_data: data loaded from container.yaml
     :param content_sets_data: data loaded from content_sets.yaml
     """
+
     container_data: dict
     content_sets_data: dict
 

compose_generator/odcs_fetcher.py

@@ -1,3 +1,4 @@
+"""Fetch ready ODCS compose"""
 from dataclasses import dataclass
 from pathlib import Path
 
@@ -9,6 +10,7 @@ class ODCSResultReference(ComposeReference):
     """
     Reference to a locally-stored compose result
     """
+
     compose_path: Path
 
 
@@ -17,5 +19,6 @@ class ODCSFetcher(ComposeFetcher):
     """
     Fetch ODCS compose based on a remote compose-reference and store it locally
     """
+
     def __call__(self, request_reference: ComposeReference) -> ODCSResultReference:
         raise NotImplementedError()

compose_generator/odcs_requester.py

@@ -1,3 +1,4 @@
+"""Request a new ODCS compose"""
 from dataclasses import dataclass
 
 from .protocols import ComposeConfigurations, ComposeReference, ComposeRequester
@@ -8,6 +9,7 @@ class ODCSRequestReference(ComposeReference):
     """
     Reference to a remotely-stored compose data
     """
+
     compose_url: str
 
 
@@ -17,5 +19,6 @@ class ODCSRequester(ComposeRequester):
     Request a new ODCS compose based on compose configurations and return a reference
     to the remote compose location.
     """
+
     def __call__(self, configs: ComposeConfigurations) -> ODCSRequestReference:
         raise NotImplementedError()

compose_generator/protocols.py

@@ -1,5 +1,8 @@
+"""compose generator protocols"""
 from typing import Protocol
 
+# pylint: disable=too-few-public-methods
+
 
 class ComposeConfigurations(Protocol):
     """
@@ -11,6 +14,7 @@ class ComposeConfigurationsGenerator(Protocol):
     """
     Generate compose configurations
     """
+
     def __call__(self) -> ComposeConfigurations:
         pass
 
@@ -25,6 +29,7 @@ class ComposeRequester(Protocol):
     """
     Given compose configurations, return a remote compose reference
     """
+
     def __call__(self, configs: ComposeConfigurations) -> ComposeReference:
         pass
 

format.sh

@@ -0,0 +1,11 @@
+#!/bin/bash -ex
+
+main() {
+    local pkgs=("tests" "compose_generator")
+    pipenv run isort --profile black "${pkgs[@]}"
+    pipenv run black "${pkgs[@]}"
+}
+
+if [[ "${BASH_SOURCE[0]}" == "$0" ]]; then
+    main "$@"
+fi

tests/test_static_check.py

@@ -0,0 +1,25 @@
+"""Static checks"""
+from subprocess import run
+from typing import Final
+
+PKGS: Final[list[str]] = ["tests", "compose_generator"]
+
+
+def test_mypy() -> None:
+    """Static Type check"""
+    run(["mypy"] + PKGS, check=True)
+
+
+def test_isort() -> None:
+    """Imports formatting check"""
+    run(["isort", "--check", "--profile", "black"] + PKGS, check=True)
+
+
+def test_black() -> None:
+    """Formatting check"""
+    run(["black", "--check"] + PKGS, check=True)
+
+
+def test_pylint() -> None:
+    """Lint check"""
+    run(["pylint"] + PKGS, check=True)