Merge branch 'main' into fix-missing-interface

Author: Alex-Welsh

.github/workflows/helm-lint.yaml

@@ -0,0 +1,44 @@
+# NOTE: This workflow can be run locally using https://github.com/nektos/act with:
+# act -W .github/workflows/helm-lint.yaml workflow_call -s GITHUB_TOKEN=$(gh auth token)
+name: Helm Lint
+on:
+  workflow_call:
+    inputs:
+      ref:
+        type: string
+        description: The Git ref under test.
+        required: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+          fetch-depth: 0
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v4
+        with:
+          version: v3.15.3
+
+      - name: Set up chart-testing
+        uses: helm/chart-testing-action@v2
+
+      - name: Run chart-testing (lint)
+        run: |-
+          ct lint \
+            --target-branch ${{ github.event.repository.default_branch }} \
+            --charts chart/ \
+            --validate-maintainers=false
+
+      - name: Run template validation
+        run: |-
+          helm template foo chart \
+            | docker run -i --rm ghcr.io/yannh/kubeconform:latest \
+            --strict --summary
+
+      - name: Run manifest snapshot test
+        run: docker run -i --rm -v $(pwd):/apps helmunittest/helm-unittest chart

.github/workflows/test-pr.yaml

@@ -31,6 +31,12 @@ jobs:
     with:
       ref: ${{ github.event.pull_request.head.sha }}
 
+  # Run the chart linting on every PR, even from external repos
+  lint:
+    uses: ./.github/workflows/helm-lint.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

.github/workflows/tox.yaml

@@ -11,10 +11,10 @@ on:
 jobs:
   build:
     name: Tox unit tests and linting
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     strategy:
       matrix:
-        python-version: ['3.10']
+        python-version: ['3.12','3.13']
 
     steps:
     - name: Check out the repository
@@ -41,5 +41,5 @@ jobs:
     - name: Archive code coverage results
       uses: actions/upload-artifact@v4
       with:
-        name: code-coverage-report
+        name: "code-coverage-report-${{ matrix.python-version }}"
         path: cover/

Dockerfile

@@ -1,8 +1,7 @@
-FROM ubuntu:jammy AS python-builder
+FROM ubuntu:24.04 AS python-builder
 
 RUN apt-get update && \
-    apt-get install -y python3 python3-venv && \
-    rm -rf /var/lib/apt/lists/*
+    apt-get install -y python3 python3-venv
 
 RUN python3 -m venv /venv && \
     /venv/bin/pip install -U pip setuptools
@@ -14,16 +13,16 @@ COPY . /app
 RUN /venv/bin/pip install /app
 
 
-FROM ubuntu:jammy
+FROM ubuntu:24.04
 
 # Don't buffer stdout and stderr as it breaks realtime logging
-ENV PYTHONUNBUFFERED 1
+ENV PYTHONUNBUFFERED=1
 
 # Create the user that will be used to run the app
-ENV APP_UID 1001
-ENV APP_GID 1001
-ENV APP_USER app
-ENV APP_GROUP app
+ENV APP_UID=1001
+ENV APP_GID=1001
+ENV APP_USER=app
+ENV APP_GROUP=app
 RUN groupadd --gid $APP_GID $APP_GROUP && \
     useradd \
       --no-create-home \
@@ -40,5 +39,4 @@ RUN apt-get update && \
 COPY --from=python-builder /venv /venv
 
 USER $APP_UID
-ENTRYPOINT ["tini", "-g", "--"]
-CMD ["/venv/bin/kopf", "run", "--module", "capi_janitor.openstack.operator", "--all-namespaces"]
+CMD ["/venv/bin/kopf", "run", "--module", "capi_janitor.openstack.operator", "--all-namespaces", "--verbose"]

README.md

@@ -24,6 +24,26 @@ helm upgrade \
   --install
 ```
 
+## Tox for unittests and linting
+
+We use tox to run unit tests and linters across the code.
+To run all the checks, including efforts to automatically
+fix linting issues, please run:
+
+```sh
+tox
+```
+
+You can run individual unit tests by running:
+
+```sh
+tox -e py3 -- <name-of-unit-test>
+```
+
+Note, failures on your initial tox run may be automatically
+fixed, where possible. So your second tox run may pass.
+This way we can run the default tox target in CI.
+
 ## Configuration
 
 `cluster-api-janitor-openstack` will always clean up

capi_janitor/openstack/openstack.py

@@ -4,7 +4,6 @@
 import urllib.parse
 
 import httpx
-
 from easykube import rest
 
 

capi_janitor/openstack/operator.py

@@ -5,11 +5,10 @@
 import random
 import string
 
-import kopf
-import yaml
-
 import easykube
 import httpx
+import kopf
+import yaml
 
 from . import openstack
 
@@ -47,9 +46,7 @@ async def on_startup(**kwargs):
 
 @kopf.on.cleanup()
 async def on_cleanup(**kwargs):
-    """
-    Runs on operator shutdown.
-    """
+    """Runs on operator shutdown."""
     # Make sure that the easykube client is shut down properly
     await ekclient.aclose()
 
@@ -105,7 +102,6 @@ async def secgroups_for_cluster(resource, cluster):
 
 async def filtered_volumes_for_cluster(resource, cluster):
     """Async iterator for volumes belonging to the specified cluster."""
-
     async for vol in resource.list():
         # CSI Cinder sets metadata on the volumes that we can look for
         owner = vol.metadata.get("cinder.csi.openstack.org/cluster")
@@ -162,7 +158,6 @@ async def purge_openstack_resources(
     logger, clouds, cloud_name, cacert, name, include_volumes, include_appcred
 ):
     """Cleans up the OpenStack resources created by the OCCM and CSI for a cluster."""
-
     # Use the credential to delete external resources as required
     async with openstack.Cloud.from_clouds(clouds, cloud_name, cacert) as cloud:
         if not cloud.is_authenticated:
@@ -360,7 +355,6 @@ async def _on_openstackcluster_event_impl(
     name, namespace, meta, labels, spec, logger, **kwargs
 ):
     """Executes whenever an event occurs for an OpenStack cluster."""
-
     # Get the resource for manipulating OpenStackClusters at the preferred version
     openstackclusters = await _get_os_cluster_client()
 
@@ -375,7 +369,10 @@ async def _on_openstackcluster_event_impl(
     if not meta.get("deletionTimestamp"):
         if FINALIZER not in finalizers:
             await patch_finalizers(
-                openstackclusters, name, namespace, finalizers + [FINALIZER]
+                openstackclusters,
+                name,
+                namespace,
+                [*finalizers, FINALIZER],
             )
             logger.info("added janitor finalizer to cluster")
         return