Cache charmcraft pack container, skip unstable tests except on schedule

Ported from canonical/mysql-k8s-operator#146

.github/workflows/ci.yaml

@@ -1,26 +1,82 @@
-name: Spark History Server Testing
+# Copyright 2022 Canonical Ltd.
+# See LICENSE file for licensing details.
+name: Tests
+
 on:
+  push:
+    branches:
+      - main
   pull_request:
+  schedule:
+    - cron: '53 0 * * *' # Daily at 00:53 UTC
 
 jobs:
   lint:
     name: Lint
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
-      - name: Install dependencies
+        uses: actions/checkout@v3
+      - name: Install tox
+        # TODO: Consider replacing with custom image on self-hosted runner OR pinning version
         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-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
-      - name: Install dependencies
-        run: python -m pip install tox
+        uses: actions/checkout@v3
+      - name: Install tox
+        # TODO: Consider replacing with custom image on self-hosted runner OR pinning version
+        run: python3 -m pip install tox
       - name: Run tests
-        run: tox -e unit
+        run: tox run -e unit
+
+  build:
+    name: Build charms
+    uses: canonical/data-platform-workflows/.github/workflows/build_charms_with_cache.yaml@v1
+
+  integration-test:
+    strategy:
+      fail-fast: false
+      matrix:
+        tox-environments:
+          - integration
+    name: ${{ matrix.tox-environments }}
+    needs:
+      - lint
+      - unit-test
+      - build
+    runs-on: ubuntu-latest
+    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
+          # This is needed until https://bugs.launchpad.net/juju/+bug/1977582 is fixed
+          bootstrap-options: "--agent-version 2.9.38"
+      - 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 run -e ${{ matrix.tox-environments }} -- -m '${{ steps.select-tests.outputs.mark_expression }}'
+        env:
+          CI_PACKED_CHARMS: ${{ needs.build.outputs.charms }}

CONTRIBUTING.md

@@ -2,24 +2,21 @@
 
 To make contributions to this charm, you'll need a working [development setup](https://juju.is/docs/sdk/dev-setup).
 
-You can use the environments created by `tox` for development:
+You can create an environment for development with `tox`:
 
 ```shell
-tox --notest -e unit
-source .tox/unit/bin/activate
+tox devenv -e integration
+source venv/bin/activate
 ```
 
-## Testing
-
-This project uses `tox` for managing test environments. There are some pre-configured environments
-that can be used for linting and formatting code when you're preparing contributions to the charm:
+### Testing
 
 ```shell
-tox -e fmt           # update your code according to linting rules
-tox -e lint          # code style
-tox -e unit          # unit tests
-tox -e integration   # integration tests
-tox                  # runs 'lint' and 'unit' environments
+tox run -e format        # update your code according to linting rules
+tox run -e lint          # code style
+tox run -e unit          # unit tests
+tox run -e integration   # integration tests
+tox                      # runs 'lint' and 'unit' environments
 ```
 
 ## Build the charm

pyproject.toml

@@ -12,6 +12,7 @@ show_missing = true
 minversion = "6.0"
 log_cli_level = "INFO"
 asyncio_mode = "auto"
+markers = ["unstable"]
 
 # Formatting tools configuration
 [tool.black]

tests/integration/__init__.py

@@ -0,0 +1,2 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.

tests/integration/conftest.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python3
+# Copyright 2022 Canonical Ltd.
+# See LICENSE file for licensing details.
+
+import json
+import os
+from pathlib import Path
+
+import pytest
+from pytest_operator.plugin import OpsTest
+
+
+@pytest.fixture
+def ops_test(ops_test: OpsTest) -> OpsTest:
+    if os.environ.get("CI") == "true":
+        # Running in GitHub Actions; skip build step
+        # (GitHub Actions uses a separate, cached build step. See .github/workflows/ci.yaml)
+        packed_charms = json.loads(os.environ["CI_PACKED_CHARMS"])
+
+        async def build_charm(charm_path, bases_index: int = None) -> Path:
+            for charm in packed_charms:
+                if Path(charm_path) == Path(charm["directory_path"]):
+                    if bases_index is None or bases_index == charm["bases_index"]:
+                        return charm["file_path"]
+            raise ValueError(f"Unable to find .charm file for {bases_index=} at {charm_path=}")
+
+        ops_test.build_charm = build_charm
+    return ops_test

tests/unit/__init__.py

@@ -0,0 +1,2 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.

tests/unit/test_charm.py

@@ -8,7 +8,7 @@
 import ops.testing
 from ops.model import ActiveStatus, BlockedStatus, WaitingStatus
 from ops.testing import Harness
-from src.constants import (
+from constants import (
     CONFIG_KEY_S3_ACCESS_KEY,
     CONFIG_KEY_S3_BUCKET,
     CONFIG_KEY_S3_ENDPOINT,

tox.ini

@@ -2,30 +2,29 @@
 # See LICENSE file for licensing details.
 
 [tox]
-skipsdist = True
-isolated_build = True
+no_package = True
 skip_missing_interpreters = True
-envlist = lint, unit
+env_list = lint, unit
 
 [vars]
 application = spark-history-server
-src_path = {toxinidir}/src/
-tst_path = {toxinidir}/tests/
-all_path = {[vars]src_path} {[vars]tst_path}
+src_path = {tox_root}/src
+tests_path = {tox_root}/tests
+all_path = {[vars]src_path} {[vars]tests_path}
 
 [testenv]
-allowlist_externals = /bin/bash
-                      poetry
-whitelist_externals = poetry
+allowlist_externals =
+    /bin/bash
+    poetry
 
-setenv =
-  PYTHONPATH = {toxinidir}:{toxinidir}/lib:{[vars]src_path}
-  PYTHONBREAKPOINT=ipdb.set_trace
-  PY_COLORS=1
-passenv =
-  PYTHONPATH
-  CHARM_BUILD_DIR
-  MODEL_SETTINGS
+set_env =
+    PYTHONPATH = {tox_root}/lib:{[vars]src_path}
+    PYTHONBREAKPOINT=ipdb.set_trace
+    PY_COLORS=1
+pass_env =
+    PYTHONPATH
+    CHARM_BUILD_DIR
+    MODEL_SETTINGS
 deps =
     poetry
 
@@ -37,7 +36,7 @@ commands =
     /bin/bash -ec "charmcraft pack"
     /bin/bash -ec "juju deploy ./*.charm --resource spark-history-server-image=dataplatformoci/spark:3.3.1"
 
-[testenv:fmt]
+[testenv:format]
 description = Apply coding style standards to code
 commands =
     poetry install
@@ -51,14 +50,14 @@ commands =
 description = Check code against coding style standards
 commands =
     poetry install --only lint
-    poetry run codespell {toxinidir} \
-        --skip {toxinidir}/.git \
-        --skip {toxinidir}/.tox \
-        --skip {toxinidir}/build \
-        --skip {toxinidir}/lib \
-        --skip {toxinidir}/venv \
-        --skip {toxinidir}/.mypy_cache \
-        --skip {toxinidir}/icon.svg
+    poetry run codespell {tox_root} \
+        --skip {tox_root}/.git \
+        --skip {tox_root}/.tox \
+        --skip {tox_root}/build \
+        --skip {tox_root}/lib \
+        --skip {tox_root}/venv \
+        --skip {tox_root}/.mypy_cache \
+        --skip {tox_root}/icon.svg
 
     poetry run ruff {[vars]all_path}
     poetry run black --check --diff {[vars]all_path}
@@ -68,11 +67,15 @@ description = Run unit tests
 commands =
     poetry install --with unit
     poetry run coverage run --source={[vars]src_path} \
-        -m pytest --ignore={[vars]tst_path}integration -v --tb native -s {posargs}
+        -m pytest -vv --tb native -s {posargs} {[vars]tests_path}/unit
     poetry run coverage report
 
 [testenv:integration]
 description = Run integration tests
+pass_env =
+    {[testenv]pass_env}
+    CI
+    CI_PACKED_CHARMS
 commands =
     poetry install --with integration
-    poetry run pytest -vv --tb native --ignore={[vars]tst_path}unit --log-cli-level=INFO -s {posargs}
+    poetry run pytest -vv --tb native --log-cli-level=INFO -s {posargs} {[vars]tests_path}/integration/test_charm.py