Use reusable integration test workflow (#161)

- Use
https://github.com/canonical/data-platform-workflows/blob/main/.github/workflows/integration_test_charm.md
- Parameterize `ops.JujuVersion.has_secrets` as pytest fixture & test
combinations of relations with & without secrets at the same time
instead of splitting the unit test CI into two workflows and passing
"libjuju agent version" env var (when libjuju is not being used in unit
tests)

Note that this PR increases the number of combination options by about a
factor of 2, which increases the number of combinations exponentially
(~300 tests to ~3400 tests [plus an exponential increase of tests within
each test with a for loop, that aren't tracked by pytest individually]).
In the future we may want to add a "quick" version/subset of the unit
tests for local runs & for PRs or to gate the integration CI (which
currently waits for unit tests to pass before starting)

Author: carlcsaposs-canonical

.github/workflows/ci.yaml

@@ -31,7 +31,7 @@ jobs:
   unit-test:
     name: Unit test charm
     runs-on: ubuntu-latest
-    timeout-minutes: 8
+    timeout-minutes: 15
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -44,101 +44,27 @@ jobs:
 
   build:
     name: Build charm
-    uses: canonical/data-platform-workflows/.github/workflows/build_charms_with_cache.yaml@v4.2.3
+    uses: canonical/data-platform-workflows/.github/workflows/build_charms_with_cache.yaml@v6.2.0
     permissions:
       actions: write  # Needed to manage GitHub Actions cache
 
-  gh-hosted-collect-integration-tests:
-    name: (GH hosted) Collect integration test groups
-    needs:
-      - lint
-      - unit-test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Install tox & poetry
-        run: |
-          pipx install tox
-          pipx install poetry
-      - name: Select test stability level
-        id: select-test-stability
-        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: Collect test groups
-        id: collect-groups
-        run: tox run -e integration -- tests/integration -m '${{ steps.select-test-stability.outputs.mark_expression }}' --collect-groups
-    outputs:
-      groups: ${{ steps.collect-groups.outputs.groups }}
-
-  gh-hosted-integration-test:
+  integration-test:
     strategy:
       fail-fast: false
       matrix:
-        groups: ${{ fromJSON(needs.gh-hosted-collect-integration-tests.outputs.groups) }}
-        juju-snap-channel:  ["2.9/stable", "3.1/stable"]
-        include:
-          - juju-snap-channel: "3.1/stable"
-            agent-version: "3.1.6"
-            libjuju-version:  "3.2.2"
-          - juju-snap-channel: "2.9/stable"
-            agent-version: "2.9.45"
-            libjuju-version:  "2.9.44.1"
-    name: ${{ matrix.juju-snap-channel }} - (GH hosted) ${{ matrix.groups.job_name }} | ${{ matrix.ubuntu-versions.series }}
+        juju:
+          - agent: 2.9.45
+            libjuju: ^2
+          - agent: 3.1.6
+    name: Integration test charm | ${{ matrix.juju.agent }}
     needs:
       - lint
       - unit-test
       - build
-      - gh-hosted-collect-integration-tests
-    runs-on: ubuntu-latest
-    timeout-minutes: 120
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Install tox & poetry
-        run: |
-          pipx install tox
-          pipx install poetry
-      - name: Free up disk space
-        run: |
-          # From https://github.com/actions/runner-images/issues/2840#issuecomment-790492173
-          sudo rm -rf /usr/share/dotnet
-          sudo rm -rf /opt/ghc
-          sudo rm -rf /usr/local/share/boost
-          sudo rm -rf "$AGENT_TOOLSDIRECTORY"
-      - name: Setup operator environment
-        uses: charmed-kubernetes/actions-operator@main
-        with:
-          provider: microk8s
-          channel: "1.28-strict/stable"
-          bootstrap-options: "--agent-version ${{ matrix.agent-version }}"
-          juju-channel: ${{ matrix.juju-snap-channel }}
-      - name: Update python-libjuju version
-        if: ${{ matrix.libjuju-version == '2.9.44.1' }}
-        run: poetry add --lock --group integration juju@'${{ matrix.libjuju-version }}'            
-      - name: Download packed charm(s)
-        uses: actions/download-artifact@v3
-        with:
-          name: ${{ needs.build.outputs.artifact-name }}
-      - name: Select test stability level
-        id: select-test-stability
-        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 run -e integration -- "${{ matrix.groups.path_to_test_file }}" --group="${{ matrix.groups.group_number }}" -m '${{ steps.select-test-stability.outputs.mark_expression }}'
-        env:
-          LIBJUJU_VERSION_SPECIFIER: ${{ matrix.libjuju-version }}
+    uses: canonical/data-platform-workflows/.github/workflows/[email protected]
+    with:
+      artifact-name: ${{ needs.build.outputs.artifact-name }}
+      cloud: microk8s
+      microk8s-snap-channel: 1.28-strict/stable
+      juju-agent-version: ${{ matrix.juju.agent }}
+      libjuju-version-constraint: ${{ matrix.juju.libjuju }}

.github/workflows/release.yaml

@@ -32,15 +32,15 @@ jobs:
 
   build:
     name: Build charm
-    uses: canonical/data-platform-workflows/.github/workflows/build_charm_without_cache.yaml@v4.2.3
+    uses: canonical/data-platform-workflows/.github/workflows/build_charm_without_cache.yaml@v6.2.0
 
   release:
     name: Release charm
     needs:
       - lib-check
       - ci-tests
       - build
-    uses: canonical/data-platform-workflows/.github/workflows/release_charm.yaml@v4.2.3
+    uses: canonical/data-platform-workflows/.github/workflows/release_charm.yaml@v6.2.0
     with:
       channel: 8.0/edge
       artifact-name: ${{ needs.build.outputs.artifact-name }}

.github/workflows/sync_issue_to_jira.yaml

@@ -9,7 +9,7 @@ on:
 jobs:
   sync:
     name: Sync GitHub issue to Jira
-    uses: canonical/data-platform-workflows/.github/workflows/sync_issue_to_jira.yaml@v4.2.3
+    uses: canonical/data-platform-workflows/.github/workflows/sync_issue_to_jira.yaml@v6.2.0
     with:
       jira-base-url: https://warthogs.atlassian.net
       jira-project-key: DPE

poetry.lock

@@ -48,21 +48,20 @@ codespell = "^2.2.5"
 pytest = "^7.4.0"
 pytest-xdist = "^3.3.1"
 pytest-cov = "^4.1.0"
-ops-scenario = "^5.4.1"
+ops-scenario = "^5.6.2"
 ops = ">=2.0.0"
 pytest-mock = "^3.11.1"
 
 [tool.poetry.group.integration.dependencies]
 pytest = "^7.4.0"
 pytest-operator = "^0.28.0"
-pytest-operator-cache = {git = "https://github.com/canonical/data-platform-workflows", tag = "v4.2.3", subdirectory = "python/pytest_plugins/pytest_operator_cache"}
-pytest-operator-groups = {git = "https://github.com/canonical/data-platform-workflows", tag = "v4.2.3", subdirectory = "python/pytest_plugins/pytest_operator_groups"}
-juju = "3.2.2"
+pytest-operator-cache = {git = "https://github.com/canonical/data-platform-workflows", tag = "v6.2.0", subdirectory = "python/pytest_plugins/pytest_operator_cache"}
+pytest-operator-groups = {git = "https://github.com/canonical/data-platform-workflows", tag = "v6.2.0", subdirectory = "python/pytest_plugins/pytest_operator_groups"}
+juju = "^3.2.2"
 mysql-connector-python = "~8.0.33"
 pyyaml = "^6.0.1"
 tenacity = "^8.2.2"
-ops = ">=2.0.0"
-pytest-mock = "^3.11.1"
+ops = "^2.6.0"
 
 
 [tool.coverage.run]

pyproject.toml

@@ -1,11 +1,7 @@
 # Copyright 2023 Canonical Ltd.
 # See LICENSE file for licensing details.
 
-from unittest.mock import PropertyMock
-
 import pytest
-from ops import JujuVersion
-from pytest_mock import MockerFixture
 
 
 @pytest.fixture(autouse=True)
@@ -57,20 +53,7 @@ def kubernetes_patch(monkeypatch):
     monkeypatch.setattr("kubernetes_upgrade._Partition.set", lambda *args, **kwargs: None)
 
 
-@pytest.fixture(autouse=True, params=["juju2", "juju3"])
-def juju_has_secrets(mocker: MockerFixture, request):
-    """This fixture will force the usage of secrets whenever run on Juju 3.x.
-
-    NOTE: This is needed, as normally JujuVersion is set to 0.0.0 in tests
-    (i.e. not the real juju version)
-    """
-    if request.param == "juju3":
-        mocker.patch.object(
-            JujuVersion, "has_secrets", new_callable=PropertyMock
-        ).return_value = False
-        return False
-    else:
-        mocker.patch.object(
-            JujuVersion, "has_secrets", new_callable=PropertyMock
-        ).return_value = True
-        return True
+@pytest.fixture(params=[True, False])
+def juju_has_secrets(request, monkeypatch):
+    monkeypatch.setattr("ops.JujuVersion.has_secrets", request.param)
+    return request.param