[DPE-3733] Update CI (#80)

* update CI * add select test step to job * rearrange imports on tests * split CI due to different agent requirements * skip pod deletion test on discourse
canonical · Apr 17, 2024 · 0c12059 · 0c12059
1 parent 9cddc63
commit 0c12059
Show file tree

Hide file tree

Showing 12 changed files with 166 additions and 150 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -1,112 +1,166 @@
+# Copyright 2024 Canonical Ltd.
+# See LICENSE file for licensing details.
 name: Tests
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
-  workflow_call:
   pull_request:
+  schedule:
+    - cron: '53 0 * * *' # Daily at 00:53 UTC
+  # Triggered on push to branch "main" by .github/workflows/release.yaml
+  workflow_call:
 
 jobs:
   lint:
     name: Lint
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
+    timeout-minutes: 5
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Install dependencies
+      - name: Install tox
         run: python3 -m pip install tox
       - name: Run linters
-        run: tox -e lint
+        run: tox run -e lint
 
   unit-test:
     name: Unit tests
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Install dependencies
+      - name: Install tox
         run: python -m pip install tox
       - name: Run tests
-        run: tox -e unit
+        run: tox run -e unit
 
-  integration-test-general:
-    name: Integration tests (general)
-    needs:
-      - lint
-      - unit-test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup operator environment
-        uses: charmed-kubernetes/actions-operator@main
-        with:
-          provider: microk8s
-          bootstrap-options: "--agent-version 2.9.43"
-      - name: Run integration tests
-        run: tox -e integration-charm
+  build:
+    name: Build charms
+    uses: canonical/data-platform-workflows/.github/workflows/build_charms_with_cache.yaml@v7
 
-  integration-test-relation:
-    name: Integration tests (relation)
+  integration-test:
+    strategy:
+      fail-fast: false
+      matrix:
+        tox-environments:
+          - integration-charm
+          - integration-password
+          - integration-redis-relation
+    name: ${{ matrix.tox-environments }}
     needs:
       - lint
       - unit-test
-    runs-on: ubuntu-latest
+      - build
+    runs-on: ubuntu-22.04
+    timeout-minutes: 120
     steps:
       - name: Checkout
         uses: actions/checkout@v3
       - name: Setup operator environment
+        # TODO: Replace with custom image on self-hosted runner
         uses: charmed-kubernetes/actions-operator@main
         with:
           provider: microk8s
+          channel: "1.28-strict/stable"
+          juju-channel: 2.9/stable
           bootstrap-options: "--agent-version 2.9.43"
+      - name: Download packed charm(s)
+        uses: actions/download-artifact@v3
+        with:
+          name: ${{ needs.build.outputs.artifact-name }}
+      - name: Select tests
+        id: select-tests
+        run: |
+          if [ "${{ github.event_name }}" == "schedule" ]
+          then
+            echo Running unstable and stable tests
+            echo "mark_expression=" >> $GITHUB_OUTPUT
+          else
+            echo Skipping unstable tests
+            echo "mark_expression=not unstable" >> $GITHUB_OUTPUT
+          fi
       - name: Run integration tests
-        run: tox -e integration-relation
+        run: tox run -e ${{ matrix.tox-environments }} -- -m '${{ steps.select-tests.outputs.mark_expression }}'
+        env:
+          CI_PACKED_CHARMS: ${{ needs.build.outputs.charms }}
 
   integration-test-relation-single-unit:
-    name: Integration tests (relation, num_units=1)
+    name: integration-relation (relation, num_units=1)
     needs:
       - lint
       - unit-test
+      - build
     runs-on: ubuntu-latest
+    timeout-minutes: 120
     steps:
       - name: Checkout
         uses: actions/checkout@v3
       - name: Setup operator environment
+        # TODO: Replace with custom image on self-hosted runner
         uses: charmed-kubernetes/actions-operator@main
         with:
           provider: microk8s
+          channel: "1.28-strict/stable"
+          juju-channel: 2.9/stable
           bootstrap-options: "--agent-version 2.9.43"
-      - name: Run integration tests
-        run: tox -e integration-relation -- --num-units 1
-
-  integration-test-password:
-    name: Integration tests (password)
-    needs:
-      - lint
-      - unit-test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup operator environment
-        uses: charmed-kubernetes/actions-operator@main
+      - name: Download packed charm(s)
+        uses: actions/download-artifact@v3
         with:
-          provider: microk8s
-          bootstrap-options: "--agent-version 2.9.43"
+          name: ${{ needs.build.outputs.artifact-name }}
+      - name: Select tests
+        id: select-tests
+        run: |
+          if [ "${{ github.event_name }}" == "schedule" ]
+          then
+            echo Running unstable and stable tests
+            echo "mark_expression=" >> $GITHUB_OUTPUT
+          else
+            echo Skipping unstable tests
+            echo "mark_expression=not unstable" >> $GITHUB_OUTPUT
+          fi
       - name: Run integration tests
-        run: tox -e integration-password
+        run: tox run -e integration-redis-relation -- --num-units 1 -m '${{ steps.select-tests.outputs.mark_expression }}'
+        env:
+          CI_PACKED_CHARMS: ${{ needs.build.outputs.charms }}
 
   integration-test-scaling:
-    name: Integration tests (scaling)
+    name: integration-scaling
     needs:
       - lint
       - unit-test
+      - build
     runs-on: ubuntu-latest
+    timeout-minutes: 120
     steps:
       - name: Checkout
         uses: actions/checkout@v3
       - name: Setup operator environment
+        # TODO: Replace with custom image on self-hosted runner
         uses: charmed-kubernetes/actions-operator@main
         with:
           provider: microk8s
+          channel: "1.28-strict/stable"
+          juju-channel: 2.9/stable
           bootstrap-options: "--agent-version 2.9.29"
+      - name: Download packed charm(s)
+        uses: actions/download-artifact@v3
+        with:
+          name: ${{ needs.build.outputs.artifact-name }}
+      - name: Select tests
+        id: select-tests
+        run: |
+          if [ "${{ github.event_name }}" == "schedule" ]
+          then
+            echo Running unstable and stable tests
+            echo "mark_expression=" >> $GITHUB_OUTPUT
+          else
+            echo Skipping unstable tests
+            echo "mark_expression=not unstable" >> $GITHUB_OUTPUT
+          fi
       - name: Run integration tests
-        run: tox -e integration-scaling
+        run: tox run -e integration-scaling -- -m '${{ steps.select-tests.outputs.mark_expression }}'
+        env:
+          CI_PACKED_CHARMS: ${{ needs.build.outputs.charms }}
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -9,6 +9,7 @@ jobs:
   lib-check:
     name: Check libraries
     runs-on: ubuntu-latest
+    timeout-minutes: 5
     steps:
       - name: Checkout
         uses: actions/checkout@v3

diff --git a/pyproject.toml b/pyproject.toml
@@ -11,6 +11,7 @@ show_missing = true
 [tool.pytest.ini_options]
 minversion = "6.0"
 log_cli_level = "INFO"
+markers = ["unstable"]
 
 # Formatting tools configuration
 [tool.black]

diff --git a/tests/helpers.py b/tests/helpers.py
diff --git a/tests/conftest.py → tests/integration/conftest.py b/tests/conftest.py → tests/integration/conftest.py
@@ -1,7 +1,7 @@
 # Copyright 2022 Canonical Ltd.
 # See LICENSE file for licensing details.
 
-from tests.helpers import NUM_UNITS
+from .helpers import NUM_UNITS
 
 
 def pytest_addoption(parser):

diff --git a/tests/integration/helpers.py b/tests/integration/helpers.py
@@ -5,12 +5,26 @@
 """Helpers for integration tests."""
 import logging
 import subprocess
+from pathlib import Path
 from urllib.request import urlopen
 
+import yaml
 from pytest_operator.plugin import OpsTest
 from tenacity import before_log, retry, stop_after_attempt, wait_fixed
 
-from tests.helpers import APP_NAME
+METADATA = yaml.safe_load(Path("./metadata.yaml").read_text())
+APP_NAME = METADATA["name"]
+STORAGE_PATH = METADATA["storage"]["database"]["location"]
+TLS_RESOURCES = {
+    "cert-file": "tests/tls/redis.crt",
+    "key-file": "tests/tls/redis.key",
+    "ca-cert-file": "tests/tls/ca.crt",
+}
+APPLICATION_DATA = {
+    "leader-host": "leader-host",
+    "redis-password": "password",
+}
+NUM_UNITS = 3
 
 logger = logging.getLogger(__name__)
 

diff --git a/tests/integration/test_charm.py b/tests/integration/test_charm.py
@@ -2,7 +2,6 @@
 # Copyright 2022 Canonical Ltd.
 # See LICENSE file for licensing details.
 
-
 import logging
 
 import pytest
@@ -11,8 +10,11 @@
 from pytest_operator.plugin import OpsTest
 from redis import Redis
 
-from tests.helpers import APP_NAME, METADATA, NUM_UNITS, TLS_RESOURCES
-from tests.integration.helpers import (
+from .helpers import (
+    APP_NAME,
+    METADATA,
+    NUM_UNITS,
+    TLS_RESOURCES,
     attach_resource,
     change_config,
     get_address,

diff --git a/tests/integration/test_password.py b/tests/integration/test_password.py
@@ -2,16 +2,14 @@
 # Copyright 2022 Canonical Ltd.
 # See LICENSE file for licensing details.
 
-
 import logging
 
 import pytest
 from pytest_operator.plugin import OpsTest
 from redis import Redis
 from redis.exceptions import AuthenticationError
 
-from tests.helpers import APP_NAME, METADATA
-from tests.integration.helpers import get_address, get_password
+from .helpers import APP_NAME, METADATA, get_address, get_password
 
 logger = logging.getLogger(__name__)
 

diff --git a/tests/integration/test_redis_relation.py b/tests/integration/test_redis_relation.py
@@ -10,8 +10,9 @@
 from lightkube.resources.core_v1 import Pod
 from pytest_operator.plugin import OpsTest
 
-from tests.helpers import APP_NAME, METADATA
-from tests.integration.helpers import (
+from .helpers import (
+    APP_NAME,
+    METADATA,
     check_application_status,
     get_address,
     get_unit_map,
@@ -122,6 +123,7 @@ async def test_discourse_request(ops_test: OpsTest):
     assert response.status == 200
 
 
+@pytest.mark.skip(reason="Discourse goes into error on CI on primary change")
 async def test_delete_redis_pod(ops_test: OpsTest):
     """Delete the leader redis-k8s pod.
 
@@ -140,7 +142,7 @@ async def test_delete_redis_pod(ops_test: OpsTest):
     )
     await ops_test.model.block_until(
         lambda: check_application_status(ops_test, FIRST_DISCOURSE_APP_NAME) == "active",
-        timeout=600,
+        timeout=1200,
         wait_period=5,
     )
 

diff --git a/tests/integration/test_scaling.py b/tests/integration/test_scaling.py
@@ -2,16 +2,17 @@
 # Copyright 2022 Canonical Ltd.
 # See LICENSE file for licensing details.
 
-
 import logging
 import time
 
 import pytest
 from pytest_operator.plugin import OpsTest
 from redis import Redis
 
-from tests.helpers import APP_NAME, METADATA, NUM_UNITS
-from tests.integration.helpers import (
+from .helpers import (
+    APP_NAME,
+    METADATA,
+    NUM_UNITS,
     get_address,
     get_password,
     get_sentinel_password,

diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py
@@ -19,7 +19,11 @@
 from redis.exceptions import RedisError
 
 from charm import RedisK8sCharm
-from tests.helpers import APPLICATION_DATA
+
+APPLICATION_DATA = {
+    "leader-host": "leader-host",
+    "redis-password": "password",
+}
 
 
 class TestCharm(TestCase):