fix: license headers & lint & test

canonical · Jan 9, 2025 · 5c7ff6c · 5c7ff6c
1 parent 455f58a
commit 5c7ff6c
Show file tree

Hide file tree

Showing 55 changed files with 103 additions and 102 deletions.
diff --git a/.trivyignore b/.trivyignore
@@ -1,2 +1,4 @@
 # Jenkins executable
 CVE-2024-47072
+# Pebble vulnerabilities
+CVE-2024-45338
diff --git a/actions.yaml b/actions.yaml
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 get-admin-password:

diff --git a/charmcraft.yaml b/charmcraft.yaml
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 type: charm

diff --git a/config.yaml b/config.yaml
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 options:

diff --git a/generate-src-docs.sh b/generate-src-docs.sh
@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 lazydocs --no-watermark --output-path src-docs src/*
diff --git a/jenkins_rock/rockcraft.yaml b/jenkins_rock/rockcraft.yaml
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 name: jenkins

diff --git a/lib/charms/traefik_k8s/v2/ingress.py b/lib/charms/traefik_k8s/v2/ingress.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 r"""# Interface Library for ingress.

diff --git a/metadata.yaml b/metadata.yaml
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 name: jenkins-k8s

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 [tool.bandit]

diff --git a/src/actions.py b/src/actions.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Jenkins charm actions."""

diff --git a/src/agent.py b/src/agent.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """The Jenkins agent relation observer."""

diff --git a/src/auth_proxy.py b/src/auth_proxy.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Observer module for Jenkins to auth_proxy integration."""

diff --git a/src/charm.py b/src/charm.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Charm Jenkins."""

diff --git a/src/cos.py b/src/cos.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Observer module for Jenkins to COS integration."""

diff --git a/src/ingress.py b/src/ingress.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Observer module for Jenkins to ingress integration."""

diff --git a/src/jenkins.py b/src/jenkins.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Functions to operate Jenkins."""

diff --git a/src/pebble.py b/src/pebble.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Pebble functionality."""

diff --git a/src/state.py b/src/state.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Jenkins States."""

diff --git a/src/timerange.py b/src/timerange.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """The module for checking time ranges."""

diff --git a/templates/logging.properties b/templates/logging.properties
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 # Use with java logging property

diff --git a/tests/__init__.py b/tests/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Tests module."""
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Fixtures for jenkins-k8s charm tests."""

diff --git a/tests/integration/__init__.py b/tests/integration/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Integration tests module."""
diff --git a/tests/integration/conftest.py b/tests/integration/conftest.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Fixtures for Jenkins-k8s-operator charm integration tests."""
@@ -19,7 +19,6 @@
 import requests
 from juju.action import Action
 from juju.application import Application
-from juju.client._definitions import FullStatus, UnitStatus
 from juju.model import Controller, Model
 from juju.unit import Unit
 from keycloak import KeycloakAdmin, KeycloakOpenIDConnection
@@ -38,7 +37,7 @@
     get_dex_service_url,
     update_redirect_uri,
 )
-from .helpers import generate_jenkins_client_from_application, get_pod_ip
+from .helpers import generate_jenkins_client_from_application, get_model_unit_addresses, get_pod_ip
 from .types_ import KeycloakOIDCMetadata, LDAPSettings, ModelAppUnit, UnitWebClient
 
 KUBECONFIG = os.environ.get("TESTING_KUBECONFIG", "./kube-config")
@@ -129,13 +128,9 @@ def model_app_unit_fixture(model: Model, application: Application, unit: Unit):
 @pytest_asyncio.fixture(scope="module", name="unit_ip")
 async def unit_ip_fixture(model: Model, application: Application):
     """Get Jenkins charm unit IP."""
-    status: FullStatus = await model.get_status([application.name])
-    try:
-        unit_status: UnitStatus = next(iter(status.applications[application.name].units.values()))
-        assert unit_status.address, "Invalid unit address"
-        return unit_status.address
-    except StopIteration as exc:
-        raise StopIteration("Invalid unit status") from exc
+    unit_ips = await get_model_unit_addresses(model=model, app_name=application.name)
+    assert unit_ips, f"Unit IP address not found for {application.name}"
+    return unit_ips[0]
 
 
 @pytest.fixture(scope="module", name="web_address")
@@ -480,15 +475,9 @@ async def jenkins_with_proxy_fixture(
 @pytest_asyncio.fixture(scope="module", name="proxy_jenkins_unit_ip")
 async def proxy_jenkins_unit_ip_fixture(model: Model, jenkins_with_proxy: Application):
     """Get Jenkins charm w/ proxy enabled unit IP."""
-    status: FullStatus = await model.get_status([jenkins_with_proxy.name])
-    try:
-        unit_status: UnitStatus = next(
-            iter(status.applications[jenkins_with_proxy.name].units.values())
-        )
-        assert unit_status.address, "Invalid unit address"
-        return unit_status.address
-    except StopIteration as exc:
-        raise StopIteration("Invalid unit status") from exc
+    unit_ips = await get_model_unit_addresses(model=model, app_name=jenkins_with_proxy.name)
+    assert unit_ips, f"Unit IP address not found for {jenkins_with_proxy.name}"
+    return unit_ips[0]
 
 
 @pytest_asyncio.fixture(scope="module", name="proxy_jenkins_web_address")
@@ -781,10 +770,9 @@ async def traefik_application_fixture(model: Model):
     await model.wait_for_idle(
         status="active", apps=[traefik.name], timeout=20 * 60, idle_period=30, raise_on_error=False
     )
-    status = await model.get_status(filters=[traefik.name])
-    unit = next(iter(status.applications[traefik.name].units))
-    traefik_address = status["applications"][traefik.name]["units"][unit]["address"]
-    return (traefik, traefik_address)
+    unit_ips = await get_model_unit_addresses(model=model, app_name=traefik.name)
+    assert unit_ips, f"Unit IP address not found for {traefik.name}"
+    return (traefik, unit_ips[0])
 
 
 @pytest_asyncio.fixture(scope="module", name="oathkeeper_related")

diff --git a/tests/integration/constants.py b/tests/integration/constants.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Constants for Jenkins-k8s-operator charm integration tests."""

diff --git a/tests/integration/dex.py b/tests/integration/dex.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """DEX deployment and utilities for testing."""

diff --git a/tests/integration/helpers.py b/tests/integration/helpers.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Helpers for Jenkins-k8s-operator charm integration tests."""
@@ -14,6 +14,7 @@
 import requests
 import tenacity
 from juju.application import Application
+from juju.client._definitions import ApplicationStatus, FullStatus, UnitStatus
 from juju.model import Model
 from juju.unit import Unit
 from pytest_operator.plugin import OpsTest
@@ -70,7 +71,7 @@ async def install_plugins(
     )
 
 
-async def get_model_jenkins_unit_address(model: Model, app_name: str):
+async def get_model_unit_addresses(model: Model, app_name: str) -> list[str]:
     """Extract the address of a given unit.
 
     Args:
@@ -80,10 +81,18 @@ async def get_model_jenkins_unit_address(model: Model, app_name: str):
     Returns:
         the IP address of the Jenkins unit.
     """
-    status = await model.get_status()
-    unit = list(status.applications[app_name].units)[0]
-    address = status["applications"][app_name]["units"][unit]["address"]
-    return address
+    status: FullStatus = await model.get_status()
+    # mypy cannot infer the type ApplicationStatus but thinks its the base class type "Type".
+    application_status: ApplicationStatus | None = status.applications[app_name]  # type: ignore
+    assert application_status, f"Application status {app_name} not found in {status}"
+    # mypy cannot infer the type UnitStatus but thinks its the base class type "Type".
+    unit_status_map: dict[typing.Any, UnitStatus | None] = application_status.units  # type: ignore
+    units_statuses: list[UnitStatus | None] = list(unit_status_map.values())
+    return [
+        str(unit_status.address)
+        for unit_status in units_statuses
+        if unit_status and unit_status.address
+    ]
 
 
 def gen_test_job_xml(node_label: str):
@@ -314,8 +323,9 @@ async def generate_unit_web_client_from_application(
         A Jenkins web client.
     """
     assert model
-    unit_ip = await get_model_jenkins_unit_address(model, jenkins_app.name)
-    address = f"http://{unit_ip}:8080"
+    unit_ips = await get_model_unit_addresses(model, jenkins_app.name)
+    assert unit_ips, f"Unit IP address not found for {jenkins_app.name}"
+    address = f"http://{unit_ips[0]}:8080"
     jenkins_unit = jenkins_app.units[0]
     jenkins_client = await generate_jenkins_client_from_application(ops_test, jenkins_app, address)
     unit_web_client = UnitWebClient(unit=jenkins_unit, web=address, client=jenkins_client)

diff --git a/tests/integration/pre_run_script.sh b/tests/integration/pre_run_script.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 # Pre-run script for integration test operator-workflows action.

diff --git a/tests/integration/substrings.py b/tests/integration/substrings.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Helper functions for tests."""

diff --git a/tests/integration/test_auth_proxy.py b/tests/integration/test_auth_proxy.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Integration tests for jenkins-k8s-operator with auth_proxy."""

diff --git a/tests/integration/test_cos.py b/tests/integration/test_cos.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Integration tests for jenkins-k8s-operator with COS."""
@@ -11,11 +11,10 @@
 import requests
 from juju.action import Action
 from juju.application import Application
-from juju.client._definitions import FullStatus
 from juju.model import Model
 from kubernetes.client import CoreV1Api
 
-from .helpers import wait_for
+from .helpers import get_model_unit_addresses, wait_for
 from .types_ import UnitWebClient
 
 logger = logging.getLogger(__name__)
@@ -36,11 +35,10 @@ async def test_prometheus_integration(
     assert res.status_code == 200
 
     model: Model = unit_web_client.unit.model
-    status: FullStatus = await model.get_status(filters=[prometheus_related.name])
-    for unit in status.applications[prometheus_related.name].units.values():
-        query_targets = requests.get(
-            f"http://{unit.address}:9090/api/v1/targets", timeout=10
-        ).json()
+    unit_ips = await get_model_unit_addresses(model=model, app_name=prometheus_related.name)
+    assert unit_ips, f"Unit IP address not found for {prometheus_related.name}"
+    for ip in unit_ips:
+        query_targets = requests.get(f"http://{ip}:9090/api/v1/targets", timeout=10).json()
         assert len(query_targets["data"]["activeTargets"])
 
 
@@ -85,12 +83,13 @@ async def test_loki_integration(
         loki to scrape.
     """
     model: Model = unit_web_client.unit.model
-    status: FullStatus = await model.get_status(filters=[loki_related.name])
-    for unit in status.applications[loki_related.name].units.values():
+    unit_ips = await get_model_unit_addresses(model=model, app_name=loki_related.name)
+    assert unit_ips, f"Unit IP address not found for {loki_related.name}"
+    for ip in unit_ips:
         await wait_for(
             functools.partial(
                 log_files_exist,
-                unit.address,
+                ip,
                 application.name,
                 ("/var/lib/jenkins/logs/jenkins.log",),
             ),
@@ -151,20 +150,20 @@ async def test_grafana_integration(
     assert: grafana Jenkins dashboard can be found
     """
     model: Model = application.model
-    status: FullStatus = await model.get_status(filters=[grafana_related.name])
     action: Action = await grafana_related.units[0].run_action("get-admin-password")
     await action.wait()
     password = action.results["admin-password"]
-    for unit in status.applications[grafana_related.name].units.values():
+    unit_ips = await get_model_unit_addresses(model=model, app_name=grafana_related.name)
+    for ip in unit_ips:
         sess = requests.session()
         sess.post(
-            f"http://{unit.address}:3000/login",
+            f"http://{ip}:3000/login",
             json={
                 "user": "admin",
                 "password": password,
             },
         ).raise_for_status()
         await wait_for(
-            functools.partial(dashboard_exist, loggedin_session=sess, unit_address=unit.address),
+            functools.partial(dashboard_exist, loggedin_session=sess, unit_address=ip),
             timeout=60 * 20,
         )
diff --git a/tests/integration/test_external_agent.py b/tests/integration/test_external_agent.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Integration tests for jenkins-k8s-operator with ingress."""

diff --git a/tests/integration/test_ingress.py b/tests/integration/test_ingress.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Integration tests for jenkins-k8s-operator with ingress."""

diff --git a/tests/integration/test_jenkins.py b/tests/integration/test_jenkins.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Canonical Ltd.
+# Copyright 2025 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Integration tests for jenkins-k8s-operator charm."""