test: use jubilant for integration (#719)

Author: florentianayuwono

tests/integration/test_charm_fork_path_change.py

@@ -8,11 +8,10 @@
 
 import logging
 
+import jubilant
 import pytest
 from github.Repository import Repository
 from juju.application import Application
-from juju.model import Model
-from ops.model import ActiveStatus
 
 from charm_state import PATH_CONFIG_NAME
 from tests.integration.conftest import GitHubConfig
@@ -26,7 +25,7 @@
 @pytest.mark.asyncio
 @pytest.mark.abort_on_fail
 async def test_path_config_change(
-    model: Model,
+    juju: jubilant.Juju,
     app_with_forked_repo: Application,
     github_repository: Repository,
     github_config: GitHubConfig,
@@ -38,16 +37,18 @@ async def test_path_config_change(
     assert: No runners connected to the forked repository and one runner in the main repository.
     """
     logger.info("test_path_config_change")
-    await model.wait_for_idle(
-        apps=[app_with_forked_repo.name], status=ActiveStatus.name, idle_period=30, timeout=10 * 60
+    juju.wait(
+        lambda status: jubilant.all_active(status, app_with_forked_repo.name),
+        delay=10,
+        timeout=10 * 60,
     )
 
     unit = app_with_forked_repo.units[0]
 
     logger.info("Ensure there is a runner (this calls reconcile)")
     await instance_helper.ensure_charm_has_runner(app_with_forked_repo)
 
-    await app_with_forked_repo.set_config({PATH_CONFIG_NAME: github_config.path})
+    juju.config(app_with_forked_repo.name, values={PATH_CONFIG_NAME: github_config.path})
 
     logger.info("Reconciling (again)")
     await wait_for_runner_ready(app=app_with_forked_repo)

tests/integration/test_charm_metrics_failure.py

@@ -7,6 +7,7 @@
 from asyncio import sleep
 from typing import AsyncIterator
 
+import jubilant
 import pytest
 import pytest_asyncio
 from github.Branch import Branch
@@ -30,18 +31,16 @@
 
 
 @pytest_asyncio.fixture(scope="function", name="app")
-async def app_fixture(app_for_metric: Application) -> AsyncIterator[Application]:
+async def app_fixture(
+    juju: jubilant.Juju, app_for_metric: Application
+) -> AsyncIterator[Application]:
     """Setup and teardown the charm after each test.
 
     Clear the metrics log before each test.
     """
     unit = app_for_metric.units[0]
     await clear_metrics_log(unit)
-    await app_for_metric.set_config(
-        {
-            BASE_VIRTUAL_MACHINES_CONFIG_NAME: "0",
-        }
-    )
+    juju.config(app_for_metric.name, values={BASE_VIRTUAL_MACHINES_CONFIG_NAME: "0"})
     await wait_for_reconcile(app=app_for_metric)
 
     yield app_for_metric
@@ -51,6 +50,7 @@ async def app_fixture(app_for_metric: Application) -> AsyncIterator[Application]
 @pytest.mark.asyncio
 @pytest.mark.abort_on_fail
 async def test_charm_issues_metrics_for_abnormal_termination(
+    juju: jubilant.Juju,
     app: Application,
     github_repository: Repository,
     test_github_branch: Branch,
@@ -62,8 +62,8 @@ async def test_charm_issues_metrics_for_abnormal_termination(
     assert: The RunnerStart, RunnerStop and Reconciliation metric is logged.
         The Reconciliation metric has the post job status set to Abnormal.
     """
-    await app.set_config({PATH_CONFIG_NAME: github_repository.full_name})
-    await app.set_config({BASE_VIRTUAL_MACHINES_CONFIG_NAME: "1"})
+    juju.config(app.name, values={PATH_CONFIG_NAME: github_repository.full_name})
+    juju.config(app.name, values={BASE_VIRTUAL_MACHINES_CONFIG_NAME: "1"})
     await instance_helper.ensure_charm_has_runner(app)
 
     unit = app.units[0]

tests/integration/test_charm_metrics_success.py

@@ -6,13 +6,13 @@
 import json
 from typing import AsyncIterator
 
+import jubilant
 import pytest
 import pytest_asyncio
 from github.Branch import Branch
 from github.Repository import Repository
 from github_runner_manager.manager.vm_manager import PostJobStatus
 from juju.application import Application
-from juju.model import Model
 
 from charm_state import BASE_VIRTUAL_MACHINES_CONFIG_NAME
 from tests.integration.helpers.charm_metrics import (
@@ -29,7 +29,7 @@
 
 
 @pytest_asyncio.fixture(scope="function", name="app")
-async def app_fixture(model: Model, app_for_metric: Application) -> AsyncIterator[Application]:
+async def app_fixture(app_for_metric: Application) -> AsyncIterator[Application]:
     """Setup and teardown the charm after each test.
 
     Clear the metrics log before each test.
@@ -44,7 +44,7 @@ async def app_fixture(model: Model, app_for_metric: Application) -> AsyncIterato
 @pytest.mark.asyncio
 @pytest.mark.abort_on_fail
 async def test_charm_issues_runner_installed_metric(
-    app: Application, instance_helper: OpenStackInstanceHelper
+    juju: jubilant.Juju, app: Application, instance_helper: OpenStackInstanceHelper
 ):
     """
     arrange: A working charm deployment.
@@ -54,7 +54,7 @@ async def test_charm_issues_runner_installed_metric(
     await instance_helper.ensure_charm_has_runner(app)
 
     # Set the number of virtual machines to 0 to speedup reconciliation
-    await app.set_config({BASE_VIRTUAL_MACHINES_CONFIG_NAME: "0"})
+    juju.config(app.name, values={BASE_VIRTUAL_MACHINES_CONFIG_NAME: "0"})
     await wait_for_reconcile(app=app)
 
     metrics_log = await get_metrics_log(app.units[0])
@@ -73,6 +73,7 @@ async def test_charm_issues_runner_installed_metric(
 @pytest.mark.asyncio
 @pytest.mark.abort_on_fail
 async def test_charm_issues_metrics_after_reconciliation(
+    juju: jubilant.Juju,
     app: Application,
     github_repository: Repository,
     test_github_branch: Branch,
@@ -98,7 +99,7 @@ async def test_charm_issues_metrics_after_reconciliation(
     )
 
     # Set the number of virtual machines to 0 to speedup reconciliation
-    await app.set_config({BASE_VIRTUAL_MACHINES_CONFIG_NAME: "0"})
+    juju.config(app.name, values={BASE_VIRTUAL_MACHINES_CONFIG_NAME: "0"})
     await wait_for_reconcile(app=app)
 
     await assert_events_after_reconciliation(

tests/integration/test_charm_upgrade.py

@@ -6,11 +6,11 @@
 import functools
 import pathlib
 
+import jubilant
 import pytest
 from juju.application import Application
 from juju.client import client
 from juju.model import Model
-from pytest_operator.plugin import OpsTest
 
 from charm_state import (
     BASE_VIRTUAL_MACHINES_CONFIG_NAME,
@@ -32,8 +32,8 @@
 
 @pytest.mark.asyncio
 async def test_charm_upgrade(
+    juju: jubilant.Juju,
     model: Model,
-    ops_test: OpsTest,
     charm_file: str,
     app_name: str,
     github_config: GitHubConfig,
@@ -48,20 +48,23 @@ async def test_charm_upgrade(
     """
     latest_edge_path = tmp_path / "github-runner.charm"
     # download the charm
-    retcode, stdout, stderr = await ops_test.juju(
-        "download",
-        "github-runner",
-        # do not specify revision
-        # --revision cannot be specified together with --arch, --base, --channel
-        "--channel",
-        "latest/edge",
-        "--series",
-        "jammy",
-        "--filepath",
-        str(latest_edge_path),
-        "--no-progress",
-    )
-    assert retcode == 0, f"failed to download charm, {stdout} {stderr}"
+    try:
+        juju.cli(
+            "download",
+            "github-runner",
+            # do not specify revision
+            # --revision cannot be specified together with --arch, --base, --channel
+            "--channel",
+            "latest/edge",
+            "--series",
+            "jammy",
+            "--filepath",
+            str(latest_edge_path),
+            "--no-progress",
+            include_model=False,
+        )
+    except jubilant.CLIError as exc:
+        pytest.fail(f"failed to download charm, {exc}")
 
     # deploy latest edge version of the charm
     application = await deploy_github_runner_charm(