Feat/operator workflow integration test

.github/workflows/integration_tests.yaml

@@ -1,144 +1,26 @@
-name: integration-tests
+name: Integration tests
 
 on:
   pull_request:
 
 jobs:
-  integration-test-charm-no-runner:
-    name: Integration test charm with no runner
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        juju: [3.1, 2.9]
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup operator environment
-        uses: charmed-kubernetes/actions-operator@main
-        with:
-          juju-channel: ${{ matrix.juju }}/stable
-          provider: lxd
-      - name: Enable br_netfilter
-        run: sudo modprobe br_netfilter
-      - name: Run Integration tests
-        run: |
-          tox -e integration-juju${{ matrix.juju }} -- \
-            --keep-models \
-            --path ${{secrets.E2E_TESTING_REPO}} \
-            --token ${{secrets.E2E_TESTING_TOKEN}} \
-            --token-alt ${{secrets.E2E_TESTING_TOKEN_ALT}} \
-            tests/integration/test_charm_no_runner.py
-  integration-test-charm:
-    name: Integration test charm
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        juju: [3.1, 2.9]
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup operator environment
-        uses: charmed-kubernetes/actions-operator@main
-        with:
-          juju-channel: ${{ matrix.juju }}/stable
-          provider: lxd
-      - name: Enable br_netfilter
-        run: sudo modprobe br_netfilter
-      - name: Run Integration tests
-        run: |
-          tox -e integration-juju${{ matrix.juju }} -- \
-            --keep-models \
-            --path ${{secrets.E2E_TESTING_REPO}} \
-            --token ${{secrets.E2E_TESTING_TOKEN}} \
-            --token-alt ${{secrets.E2E_TESTING_TOKEN_ALT}} \
-            tests/integration/test_charm.py
-  integration-test-charm-fork-repo:
-    name: Integration test charm with fork repo
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        juju: [3.1, 2.9]
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup operator environment
-        uses: charmed-kubernetes/actions-operator@main
-        with:
-          juju-channel: ${{ matrix.juju }}/stable
-          provider: lxd
-      - name: Enable br_netfilter
-        run: sudo modprobe br_netfilter
-      - name: Run Integration tests
-        run: |
-          tox -e integration-juju${{ matrix.juju }} -- \
-            --keep-models \
-            --path ${{secrets.E2E_TESTING_REPO}} \
-            --token ${{secrets.E2E_TESTING_TOKEN}} \
-            --token-alt ${{secrets.E2E_TESTING_TOKEN_ALT}} \
-            tests/integration/test_charm_fork_repo.py
-  integration-test-charm-scheduled-events:
-    name: Integration test charm scheduled events
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        juju: [3.1, 2.9]
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup operator environment
-        uses: charmed-kubernetes/actions-operator@main
-        with:
-          juju-channel: ${{ matrix.juju }}/stable
-          provider: lxd
-      - name: Enable br_netfilter
-        run: sudo modprobe br_netfilter
-      - name: Run Integration tests
-        run: |
-          tox -e integration-juju${{ matrix.juju }} -- \
-            --keep-models \
-            --path ${{secrets.E2E_TESTING_REPO}} \
-            --token ${{secrets.E2E_TESTING_TOKEN}} \
-            --token-alt ${{secrets.E2E_TESTING_TOKEN_ALT}} \
-            tests/integration/test_charm_scheduled_events.py
-  integration-test-charm-metrics:
-    name: Integration test charm metrics
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        juju: [ 3.1, 2.9 ]
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup operator environment
-        uses: charmed-kubernetes/actions-operator@main
-        with:
-          juju-channel: ${{ matrix.juju }}/stable
-          provider: lxd
-      - name: Enable br_netfilter
-        run: sudo modprobe br_netfilter
-      - name: Run Integration tests
-        run: |
-          tox -e integration-juju${{ matrix.juju }} -- \
-            --keep-models \
-            --path ${{secrets.E2E_TESTING_REPO}} \
-            --token ${{secrets.E2E_TESTING_TOKEN}} \
-            --token-alt ${{secrets.E2E_TESTING_TOKEN_ALT}} \
-            tests/integration/test_charm_metrics.py
-  required_status_checks:
-    name: Required Integration Test Status Checks
-    runs-on: ubuntu-latest
-    needs:
-      - integration-test-charm-no-runner
-      - integration-test-charm
-      - integration-test-charm-fork-repo
-      - integration-test-charm-scheduled-events
-      - integration-test-charm-metrics
-    if: always() && !cancelled()
-    timeout-minutes: 30
-    steps:
-      - run: |
-          [ '${{ needs.integration-test-charm-no-runner.result }}' = 'success' ] || (echo integration-test-charm-no-runner failed && false)
-          [ '${{ needs.integration-test-charm.result }}' = 'success' ] || (echo integration-test-charm failed && false)
-          [ '${{ needs.integration-test-charm-fork-repo.result }}' = 'success' ] || (echo integration-test-charm-fork-repo failed && false)
-          [ '${{ needs.integration-test-charm-scheduled-events.result }}' = 'success' ] || (echo integration-test-charm-schedule-events failed && false)
-          [ '${{ needs.integration-test-charm-metrics.result }}' = 'success' ] || (echo integration-test-charm-metrics failed && false)
+  integration-tests-juju2:
+    name: Integration test with juju 2.9
+    uses: canonical/operator-workflows/.github/workflows/integration_test.yaml@main
+    secrets: inherit
+    with:
+      juju-channel: 2.9/stable
+      pre-run-script: scripts/pre-integration-test.sh
+      provider: lxd
+      test-tox-env: integration-juju2.9
+      modules: '["test_charm_fork_repo", "test_charm_no_runner", "test_charm_scheduled_events", "test_charm_one_runner", "test_charm_metrics"]'
+  integration-tests-juju3:
+    name: Integration test with juju 3.1
+    uses: canonical/operator-workflows/.github/workflows/integration_test.yaml@main
+    secrets: inherit
+    with:
+      juju-channel: 3.1/stable
+      pre-run-script: scripts/pre-integration-test.sh
+      provider: lxd
+      test-tox-env: integration-juju3.1
+      modules: '["test_charm_fork_repo", "test_charm_no_runner", "test_charm_scheduled_events", "test_charm_one_runner", "test_charm_metrics"]'

scripts/pre-integration-test.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
+# Enable kernel module br_netfilter
+sudo modprobe br_netfilter

tests/conftest.py

@@ -11,6 +11,7 @@ def pytest_addoption(parser: Parser):
     """Add options to pytest parser."""
     parser.addoption("--path", action="store")
     parser.addoption("--token", action="store")
+    parser.addoption("--charm-file", action="store")
     parser.addoption("--token-alt", action="store")
     parser.addoption("--http-proxy", action="store")
     parser.addoption("--https-proxy", action="store")

tests/integration/conftest.py

@@ -5,6 +5,7 @@
 
 import secrets
 import subprocess
+import zipfile
 from pathlib import Path
 from typing import Any, AsyncIterator
 
@@ -34,14 +35,31 @@ def app_name() -> str:
     return f"integration-id{secrets.token_hex(2)}"
 
 
-@pytest_asyncio.fixture(scope="module")
-async def charm_path(ops_test: OpsTest, lxd_profile: Path) -> AsyncIterator[Path]:
-    """Path to the built charm.
-
-    Including lxd_profile fixture as an argument, will make lxd_profile.yaml
-    file present under the charm directory during the building of the charm.
-    """
-    yield await ops_test.build_charm(".")
+@pytest.fixture(scope="module")
+def charm_file(pytestconfig: pytest.Config) -> str:
+    """Path to the built charm."""
+    charm = pytestconfig.getoption("--charm-file")
+    assert charm, "Please specify the --charm-file command line option"
+
+    with zipfile.ZipFile(charm, mode="a") as charm_file:
+        charm_file.writestr(
+            "lxd-profile.yaml",
+            """config:
+    security.nesting: true
+    security.privileged: true
+    raw.lxc: |
+        lxc.apparmor.profile=unconfined
+        lxc.mount.auto=proc:rw sys:rw cgroup:rw
+        lxc.cgroup.devices.allow=a
+        lxc.cap.drop=
+devices:
+    kmsg:
+        path: /dev/kmsg
+        source: /dev/kmsg
+        type: unix-char
+""",
+        )
+    return f"./{charm}"
 
 
 @pytest.fixture(scope="module")
@@ -97,41 +115,10 @@ def model(ops_test: OpsTest) -> Model:
     return ops_test.model
 
 
-@pytest_asyncio.fixture(scope="module")
-async def lxd_profile() -> AsyncIterator[Path]:
-    """File containing LXD profile for test mode.
-
-    The file needs to be in the charm directory while building a test version
-    of the charm.
-    """
-    lxd_profile_path = Path("lxd-profile.yaml")
-
-    lxd_profile_path.write_text(
-        """config:
-    security.nesting: true
-    security.privileged: true
-    raw.lxc: |
-        lxc.apparmor.profile=unconfined
-        lxc.mount.auto=proc:rw sys:rw cgroup:rw
-        lxc.cgroup.devices.allow=a
-        lxc.cap.drop=
-devices:
-    kmsg:
-        path: /dev/kmsg
-        source: /dev/kmsg
-        type: unix-char
-"""
-    )
-
-    yield lxd_profile_path
-
-    lxd_profile_path.unlink(missing_ok=True)
-
-
 @pytest_asyncio.fixture(scope="module")
 async def app_no_runner(
     model: Model,
-    charm_path: Path,
+    charm_file: str,
     app_name: str,
     path: str,
     token: str,
@@ -152,7 +139,7 @@ async def app_no_runner(
     )
 
     application = await model.deploy(
-        charm_path,
+        charm_file,
         application_name=app_name,
         series="jammy",
         config={
@@ -185,7 +172,7 @@ async def app(model: Model, app_no_runner: Application) -> AsyncIterator[Applica
 @pytest_asyncio.fixture(scope="module")
 async def app_scheduled_events(
     model: Model,
-    charm_path: Path,
+    charm_file: str,
     app_name: str,
     path: str,
     token: str,
@@ -215,7 +202,7 @@ async def app_scheduled_events(
     )
 
     application = await model.deploy(
-        charm_path,
+        charm_file,
         application_name=app_name,
         series="jammy",
         config={