Update tests

We're updating the tests, following the same pattern used by the
other rocks.

The integration tests ensure that every supported version can be
deployed using helm charts, while the sanity tests verify the
image filesystem and executables.

.github/workflows/pull_request.yaml

@@ -18,6 +18,12 @@ jobs:
       rockcraft-revisions: '{"amd64": "1783", "arm64": "1784"}'
       arch-skipping-maximize-build-space: '["arm64"]'
       platform-labels: '{"arm64": ["self-hosted", "Linux", "ARM64", "jammy", "large"]}'
+  run-tests:
+    uses: canonical/k8s-workflows/.github/workflows/run_tests.yaml@main
+    needs: [build-and-push-arch-specifics]
+    secrets: inherit
+    with:
+      rock-metas: ${{ needs.build-and-push-arch-specifics.outputs.rock-metas }}
   scan-images:
     uses: canonical/k8s-workflows/.github/workflows/scan_images.yaml@main
     needs: [build-and-push-arch-specifics]

tests/integration/conftest.py

@@ -0,0 +1,136 @@
+#
+# Copyright 2024 Canonical, Ltd.
+#
+import logging
+from pathlib import Path
+from typing import Generator, List
+
+import pytest
+from test_util import config, harness, util
+
+LOG = logging.getLogger(__name__)
+
+
+def _harness_clean(h: harness.Harness):
+    "Clean up created instances within the test harness."
+
+    if config.SKIP_CLEANUP:
+        LOG.warning(
+            "Skipping harness cleanup. "
+            "It is your job now to clean up cloud resources"
+        )
+    else:
+        LOG.debug("Cleanup")
+        h.cleanup()
+
+
+@pytest.fixture(scope="module")
+def h() -> harness.Harness:
+    LOG.debug("Create harness for %s", config.SUBSTRATE)
+    if config.SUBSTRATE == "local":
+        h = harness.LocalHarness()
+    elif config.SUBSTRATE == "lxd":
+        h = harness.LXDHarness()
+    elif config.SUBSTRATE == "multipass":
+        h = harness.MultipassHarness()
+    elif config.SUBSTRATE == "juju":
+        h = harness.JujuHarness()
+    else:
+        raise harness.HarnessError(
+            "TEST_SUBSTRATE must be one of: local, lxd, multipass, juju"
+        )
+
+    yield h
+
+    _harness_clean(h)
+
+
+def pytest_configure(config):
+    config.addinivalue_line(
+        "markers",
+        "node_count: Mark a test to specify how many instance nodes need to be created\n"
+        "disable_k8s_bootstrapping: By default, the first k8s node is bootstrapped. This marker disables that.",
+    )
+
+
+@pytest.fixture(scope="function")
+def node_count(request) -> int:
+    node_count_marker = request.node.get_closest_marker("node_count")
+    if not node_count_marker:
+        return 1
+    node_count_arg, *_ = node_count_marker.args
+    return int(node_count_arg)
+
+
+@pytest.fixture(scope="function")
+def disable_k8s_bootstrapping(request) -> int:
+    return bool(request.node.get_closest_marker("disable_k8s_bootstrapping"))
+
+
+@pytest.fixture(scope="function")
+def instances(
+    h: harness.Harness, node_count: int, tmp_path: Path, disable_k8s_bootstrapping: bool
+) -> Generator[List[harness.Instance], None, None]:
+    """Construct instances for a cluster.
+
+    Bootstrap and setup networking on the first instance, if `disable_k8s_bootstrapping` marker is not set.
+    """
+    if not config.SNAP_CHANNEL:
+        pytest.fail("Set TEST_SNAP_CHANNEL to the channel of the k8s snap to install.")
+
+    if node_count <= 0:
+        pytest.xfail("Test requested 0 or fewer instances, skip this test.")
+
+    LOG.info(f"Creating {node_count} instances")
+    instances: List[harness.Instance] = []
+
+    for _ in range(node_count):
+        # Create <node_count> instances and setup the k8s snap in each.
+        instance = h.new_instance()
+        instances.append(instance)
+        util.setup_k8s_snap(instance)
+
+    if not disable_k8s_bootstrapping:
+        first_node, *_ = instances
+        first_node.exec(["k8s", "bootstrap"])
+
+    yield instances
+
+    if config.SKIP_CLEANUP:
+        LOG.warning("Skipping clean-up of instances, delete them on your own")
+        return
+
+    # Cleanup after each test.
+    # We cannot execute _harness_clean() here as this would also
+    # remove the module_instance.
+    for instance in instances:
+        h.delete_instance(instance.id)
+
+
+@pytest.fixture(scope="module")
+def module_instance(
+    h: harness.Harness, tmp_path_factory: pytest.TempPathFactory,
+    request
+) -> Generator[harness.Instance, None, None]:
+    """Constructs and bootstraps an instance that persists over a test session.
+
+    Bootstraps the instance with all k8sd features enabled to reduce testing time.
+    """
+    LOG.info("Setup node and enable all features")
+
+    instance = h.new_instance()
+    util.setup_k8s_snap(instance)
+    request.addfinalizer(lambda: util.purge_k8s_snap(instance))
+
+    bootstrap_config_path = "/home/ubuntu/bootstrap-session.yaml"
+    instance.send_file(
+        (config.MANIFESTS_DIR / "bootstrap-session.yaml").as_posix(),
+        bootstrap_config_path,
+    )
+
+    instance.exec(["k8s", "bootstrap", "--file", bootstrap_config_path])
+    util.wait_until_k8s_ready(instance, [instance])
+    util.wait_for_network(instance)
+    util.wait_for_dns(instance)
+
+    yield instance

tests/integration/test_multus_v3_8.py

@@ -0,0 +1,55 @@
+#
+# Copyright 2024 Canonical, Ltd.
+#
+import os
+import pathlib
+
+from test_util import harness, util
+
+
+def test_multus_deployment(
+        tmp_path: pathlib.Path,
+        module_instance: harness.Instance):
+    clone_path = tmp_path / "multus"
+    clone_path.mkdir()
+
+    clone_command = [
+        "git", "clone", "https://github.com/k8snetworkplumbingwg/helm-charts",
+        "--depth", "1",
+        str(clone_path.absolute())
+    ]
+    module_instance.exec(clone_command)
+
+    chart_path = clone_path / 'multus'
+
+    helm_command = [
+        "sudo", "k8s",
+        "helm", "install", "multus-cni",
+        str(chart_path.absolute()),
+        "--namespace", "kube-system",
+    ]
+
+    image_uri = os.getenv("ROCK_MULTUS_V3_8")
+    assert image_uri is not None, "ROCK_MULTUS_V3_8 is not set"
+    image_split = image_uri.split(":")
+
+    helm_command += [
+        "--set",
+        f"image.repository={image_split[0]}",
+        "--set",
+        f"image.tag={image_split[1]}",
+        "--set",
+        "securityContext.runAsUser=584792",
+    ]
+
+    module_instance.exec(helm_command)
+
+    util.stubbornly(retries=3, delay_s=1).on(module_instance).exec(
+        [
+            "sudo", "k8s",
+            "kubectl", "rollout", "status",
+            "daemonset", "multus-cni-multus-ds",
+            "--namespace", "kube-system",
+            "--timeout", "60s",
+        ]
+    )

tests/integration/test_multus_v4_0_2.py

@@ -0,0 +1,41 @@
+#
+# Copyright 2024 Canonical, Ltd.
+#
+import os
+
+from test_util import harness, util
+
+
+def test_multus_deployment(module_instance: harness.Instance):
+    helm_command = [
+        "sudo", "k8s",
+        "helm", "install", "multus-cni",
+        "oci://registry-1.docker.io/bitnamicharts/multus-cni",
+        "--version", "2.1.7",
+        "--namespace", "kube-system",
+    ]
+
+    image_uri = os.getenv("ROCK_MULTUS_V4_0_2")
+    assert image_uri is not None, "ROCK_MULTUS_V4_0_2 is not set"
+    image_split = image_uri.split(":")
+
+    helm_command += [
+        "--set",
+        f"image.repository={image_split[0]}",
+        "--set",
+        f"image.tag={image_split[1]}",
+        "--set",
+        "securityContext.runAsUser=584792",
+    ]
+
+    module_instance.exec(helm_command)
+
+    util.stubbornly(retries=3, delay_s=1).on(module_instance).exec(
+        [
+            "sudo", "k8s",
+            "kubectl", "rollout", "status",
+            "daemonset", "multus-cni",
+            "--namespace", "kube-system",
+            "--timeout", "180s",
+        ]
+    )

tests/integration/test_util/config.py

@@ -0,0 +1,63 @@
+#
+# Copyright 2024 Canonical, Ltd.
+#
+import os
+from pathlib import Path
+
+DIR = Path(__file__).absolute().parent
+
+MANIFESTS_DIR = DIR / ".." / ".." / "templates"
+
+# SNAP is the absolute path to the snap against which we run the integration tests.
+SNAP_CHANNEL = os.getenv("TEST_SNAP_CHANNEL")
+
+# SUBSTRATE is the substrate to use for running the integration tests.
+# One of 'local' (default), 'lxd', 'juju', or 'multipass'.
+SUBSTRATE = os.getenv("TEST_SUBSTRATE") or "local"
+
+# SKIP_CLEANUP can be used to prevent machines to be automatically destroyed
+# after the tests complete.
+SKIP_CLEANUP = (os.getenv("TEST_SKIP_CLEANUP") or "") == "1"
+
+# LXD_PROFILE_NAME is the profile name to use for LXD containers.
+LXD_PROFILE_NAME = os.getenv("TEST_LXD_PROFILE_NAME") or "k8s-integration"
+
+# LXD_PROFILE is the profile to use for LXD containers.
+LXD_PROFILE = (
+    os.getenv("TEST_LXD_PROFILE")
+    or (DIR / ".." / ".." / "lxd-profile.yaml").read_text()
+)
+
+# LXD_IMAGE is the image to use for LXD containers.
+LXD_IMAGE = os.getenv("TEST_LXD_IMAGE") or "ubuntu:22.04"
+
+# LXD_SIDELOAD_IMAGES_DIR is an optional directory with OCI images from the host
+# that will be mounted at /var/snap/k8s/common/images on the LXD containers.
+LXD_SIDELOAD_IMAGES_DIR = os.getenv("TEST_LXD_SIDELOAD_IMAGES_DIR") or ""
+
+# MULTIPASS_IMAGE is the image to use for Multipass VMs.
+MULTIPASS_IMAGE = os.getenv("TEST_MULTIPASS_IMAGE") or "22.04"
+
+# MULTIPASS_CPUS is the number of cpus for Multipass VMs.
+MULTIPASS_CPUS = os.getenv("TEST_MULTIPASS_CPUS") or "2"
+
+# MULTIPASS_MEMORY is the memory for Multipass VMs.
+MULTIPASS_MEMORY = os.getenv("TEST_MULTIPASS_MEMORY") or "2G"
+
+# MULTIPASS_DISK is the disk size for Multipass VMs.
+MULTIPASS_DISK = os.getenv("TEST_MULTIPASS_DISK") or "10G"
+
+# JUJU_MODEL is the Juju model to use.
+JUJU_MODEL = os.getenv("TEST_JUJU_MODEL")
+
+# JUJU_CONTROLLER is the Juju controller to use.
+JUJU_CONTROLLER = os.getenv("TEST_JUJU_CONTROLLER")
+
+# JUJU_CONSTRAINTS is the constraints to use when creating Juju machines.
+JUJU_CONSTRAINTS = os.getenv("TEST_JUJU_CONSTRAINTS", "mem=4G cores=2 root-disk=20G")
+
+# JUJU_BASE is the base OS to use when creating Juju machines.
+JUJU_BASE = os.getenv("TEST_JUJU_BASE") or "ubuntu@22.04"
+
+# JUJU_MACHINES is a list of existing Juju machines to use.
+JUJU_MACHINES = os.getenv("TEST_JUJU_MACHINES") or ""

tests/integration/test_util/harness/__init__.py

@@ -0,0 +1,18 @@
+#
+# Copyright 2024 Canonical, Ltd.
+#
+from test_util.harness.base import Harness, HarnessError, Instance
+from test_util.harness.juju import JujuHarness
+from test_util.harness.local import LocalHarness
+from test_util.harness.lxd import LXDHarness
+from test_util.harness.multipass import MultipassHarness
+
+__all__ = [
+    HarnessError,
+    Harness,
+    Instance,
+    JujuHarness,
+    LocalHarness,
+    LXDHarness,
+    MultipassHarness,
+]