Add tox tests (#270)

Co-authored-by: bertiethorpe <[email protected]>
Co-authored-by: bertiethorpe <[email protected]>

Author: JohnGarbutt

.github/workflows/test-pr.yaml

@@ -25,6 +25,12 @@ concurrency:
 # TODO(mkjpryor): Change this in the future to use the CAPI management only variation
 #####
 jobs:
+  # Run the unit tests on every PR, even from external repos
+  unit_tests:
+    uses: ./.github/workflows/tox.yaml
+    with:
+      ref: ${{ github.event.pull_request.head.sha }}
+
   # This job exists so that PRs from outside the main repo are rejected
   fail_on_remote:
     runs-on: ubuntu-latest
@@ -33,7 +39,7 @@ jobs:
         run: exit ${{ github.event.pull_request.head.repo.full_name == 'azimuth-cloud/cluster-api-addon-provider' && '0' || '1' }}
 
   publish_artifacts:
-    needs: [fail_on_remote]
+    needs: [unit_tests,fail_on_remote]
     uses: ./.github/workflows/build-push-artifacts.yaml
     with:
       ref: ${{ github.event.pull_request.head.sha }}

.github/workflows/tox.yaml

@@ -0,0 +1,45 @@
+name: Tox unit tests
+
+on:
+  workflow_call:
+    inputs:
+      ref:
+        type: string
+        description: The ref to build.
+        required: true
+
+jobs:
+  build:
+    name: Tox unit tests and linting
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        python-version: ['3.10','3.12']
+
+    steps:
+    - name: Check out the repository
+      uses: actions/checkout@v4
+      with:
+        ref: ${{ inputs.ref || github.ref }}
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install tox
+
+    - name: Test with tox
+      run: tox
+
+    - name: Generate coverage reports
+      run: tox -e cover
+
+    - name: Archive code coverage results
+      uses: actions/upload-artifact@v4
+      with:
+        name: "code-coverage-report-${{ matrix.python-version }}"
+        path: cover/

.gitignore

@@ -1,3 +1,9 @@
 __pycache__
 *.egg-info
-.python-version
+.python-version
+chart/charts/*
+chart/Chart.lock
+# ignore unit test stuff
+.stestr/*
+.tox/*
+.coverage*

.stestr.conf

@@ -0,0 +1,3 @@
+[DEFAULT]
+test_path=./capi_addons/tests
+top_dir=./

capi_addons/config.py

@@ -1,113 +1,124 @@
-import typing as t
-
-from pydantic import Field, conint, constr, field_validator, ValidationInfo
-
-from configomatic import Configuration as BaseConfiguration, Section, LoggingConfiguration
+from configomatic import (
+    Configuration as BaseConfiguration,
+)
+from configomatic import (
+    LoggingConfiguration,
+    Section,
+)
+from pydantic import Field, ValidationInfo, conint, constr, field_validator
 
 
 class HelmClientConfiguration(Section):
     """
     Configuration for the Helm client.
     """
+
     #: The default timeout to use with Helm releases
     #: Can be an integer number of seconds or a duration string like 5m, 5h
-    default_timeout: t.Union[int, constr(min_length = 1)] = "1h"
+    default_timeout: int | constr(min_length=1) = "1h"
     #: The executable to use
     #: By default, we assume Helm is on the PATH
-    executable: constr(min_length = 1) = "helm"
+    executable: constr(min_length=1) = "helm"
     #: The maximum number of revisions to retain in the history of releases
     history_max_revisions: int = 10
     #: Indicates whether to verify TLS when pulling charts
     insecure_skip_tls_verify: bool = False
     #: The directory to use for unpacking charts
     #: By default, the system temporary directory is used
-    unpack_directory: t.Optional[str] = None
+    unpack_directory: str | None = None
 
 
 class Configuration(
     BaseConfiguration,
-    default_path = "/etc/capi-addon-provider/config.yaml",
-    path_env_var = "CAPI_ADDON_PROVIDER_CONFIG",
-    env_prefix = "CAPI_ADDON_PROVIDER"
+    default_path="/etc/capi-addon-provider/config.yaml",
+    path_env_var="CAPI_ADDON_PROVIDER_CONFIG",
+    env_prefix="CAPI_ADDON_PROVIDER",
 ):
     """
     Top-level configuration model.
     """
+
     #: The logging configuration
-    logging: LoggingConfiguration = Field(default_factory = LoggingConfiguration)
+    logging: LoggingConfiguration = Field(default_factory=LoggingConfiguration)
 
     #: The API group of the cluster CRDs
-    api_group: constr(min_length = 1) = "addons.stackhpc.com"
+    api_group: constr(min_length=1) = "addons.stackhpc.com"
     #: The prefix to use for operator annotations
-    annotation_prefix: constr(min_length = 1) = Field(None, validate_default = True)
+    annotation_prefix: constr(min_length=1) = Field(None, validate_default=True)
     #: A list of categories to place CRDs into
-    crd_categories: t.List[constr(min_length = 1)] = Field(
-        default_factory = lambda: ["cluster-api", "capi-addons"]
+    crd_categories: list[constr(min_length=1)] = Field(
+        default_factory=lambda: ["cluster-api", "capi-addons"]
     )
 
     #: The field manager name to use for server-side apply
-    easykube_field_manager: constr(min_length = 1) = "cluster-api-addon-provider"
+    easykube_field_manager: constr(min_length=1) = "cluster-api-addon-provider"
 
     #: The amount of time (seconds) before a watch is forcefully restarted
-    watch_timeout: conint(gt = 0) = 600
+    watch_timeout: conint(gt=0) = 600
 
     #: The delay to use for temporary errors by default
-    temporary_error_delay: conint(gt = 0) = 15
+    temporary_error_delay: conint(gt=0) = 15
 
     #: The Helm client configuration
-    helm_client: HelmClientConfiguration = Field(default_factory = HelmClientConfiguration)
+    helm_client: HelmClientConfiguration = Field(
+        default_factory=HelmClientConfiguration
+    )
 
     #: Label indicating that an addon belongs to a cluster
-    cluster_label: constr(min_length = 1) = Field(None, validate_default = True)
+    cluster_label: constr(min_length=1) = Field(None, validate_default=True)
     #: Label indicating the target namespace for the addon
-    release_namespace_label: constr(min_length = 1) = Field(None, validate_default = True)
+    release_namespace_label: constr(min_length=1) = Field(None, validate_default=True)
     #: Label indicating the name of the release for the addon
-    release_name_label: constr(min_length = 1) = Field(None, validate_default = True)
+    release_name_label: constr(min_length=1) = Field(None, validate_default=True)
     #: Label indicating that a configmap or secret should be watched for changes
-    watch_label: constr(min_length = 1) = Field(None, validate_default = True)
+    watch_label: constr(min_length=1) = Field(None, validate_default=True)
     #: Prefix to use for annotations containing a configmap checksum
-    configmap_annotation_prefix: constr(min_length = 1) = Field(None, validate_default = True)
+    configmap_annotation_prefix: constr(min_length=1) = Field(
+        None, validate_default=True
+    )
     #: Prefix to use for annotations containing a secret checksum
-    secret_annotation_prefix: constr(min_length = 1) = Field(None, validate_default = True)
+    secret_annotation_prefix: constr(min_length=1) = Field(None, validate_default=True)
     #: Annotation to use to trigger restarts of workloads in lifecycle hooks
-    lifecycle_hook_restart_annotation: constr(min_length = 1) = Field(None, validate_default = True)
+    lifecycle_hook_restart_annotation: constr(min_length=1) = Field(
+        None, validate_default=True
+    )
 
-    @field_validator("annotation_prefix", mode = "before")
+    @field_validator("annotation_prefix", mode="before")
     @classmethod
     def default_annotation_prefix(cls, v, info: ValidationInfo):
-        return v or info.data['api_group']
+        return v or info.data["api_group"]
 
-    @field_validator("cluster_label", mode = "before")
+    @field_validator("cluster_label", mode="before")
     @classmethod
     def default_cluster_label(cls, v, info: ValidationInfo):
         return v or f"{info.data['api_group']}/cluster"
 
-    @field_validator("release_namespace_label", mode = "before")
+    @field_validator("release_namespace_label", mode="before")
     @classmethod
     def default_release_namespace_label(cls, v, info: ValidationInfo):
         return v or f"{info.data['api_group']}/release-namespace"
 
-    @field_validator("release_name_label", mode = "before")
+    @field_validator("release_name_label", mode="before")
     @classmethod
     def default_release_name_label(cls, v, info: ValidationInfo):
         return v or f"{info.data['api_group']}/release-name"
 
-    @field_validator("watch_label", mode = "before")
+    @field_validator("watch_label", mode="before")
     @classmethod
     def default_watch_label(cls, v, info: ValidationInfo):
         return v or f"{info.data['api_group']}/watch"
 
-    @field_validator("configmap_annotation_prefix", mode = "before")
+    @field_validator("configmap_annotation_prefix", mode="before")
     @classmethod
     def default_configmap_annotation_prefix(cls, v, info: ValidationInfo):
         return v or f"configmap.{info.data['annotation_prefix']}"
 
-    @field_validator("secret_annotation_prefix", mode = "before")
+    @field_validator("secret_annotation_prefix", mode="before")
     @classmethod
     def default_secret_annotation_prefix(cls, v, info: ValidationInfo):
         return v or f"secret.{info.data['annotation_prefix']}"
 
-    @field_validator("lifecycle_hook_restart_annotation", mode = "before")
+    @field_validator("lifecycle_hook_restart_annotation", mode="before")
     @classmethod
     def default_lifecycle_hook_restart_annotation(cls, v, info: ValidationInfo):
         return v or f"{info.data['annotation_prefix']}/restarted-at"

capi_addons/models/v1alpha1/__init__.py

@@ -1,3 +1,3 @@
-from .base import *
-from .helm_release import *
-from .manifests import *
+from capi_addons.models.v1alpha1.base import *  # noqa: F403
+from capi_addons.models.v1alpha1.helm_release import *  # noqa: F403
+from capi_addons.models.v1alpha1.manifests import *  # noqa: F403