Merge ~weii-wang/content-cache-charm:fix-integration-test into content-cache-charm:master

[Weii Wang]

Use charmcraft to build charm in integration tests

The pytest-operator for integration testing uses `charm` instead of `charmcraft` to build reactive charm. `charm` uses the host environment to build the charm. when the host contains an incorrect version of Python, `charm` will package the incorrect Python package into the charm. `charmcraft` builds the charm using the LXD container with the appropriate Ubuntu image, so there is no such problem with `charmcraft`.

In this commit, change the integration test to call `charmcraft` instead of using `ops_test.build_charm` to build the charm.

The pytest-operator for integration testing uses `charm` instead of `charmcraft` to build reactive charm. `charm` uses the host environment to build the charm. when the host contains an incorrect version of Python, `charm` will package the incorrect Python package into the charm. `charmcraft` builds the charm using the LXD container with the appropriate Ubuntu image, so there is no such problem with `charmcraft`.

In this MP, change the integration test to call `charmcraft` instead of using `ops_test.build_charm` to build the charm.

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Colin Watson (cjwatson)]

review: Approve

[Haw Loeung (hloeung)]

LGTM too, see comments. Let me know if you want to fix it or land as is.

Thanks!

review: Approve (+1)

[Haw Loeung (hloeung)]

Also, can we move the description of change into the commit message? Much easier to see "why" via "git log" rather than having to open up this Launchpad MP.

[Weii Wang (weii-wang)]

> Also, can we move the description of change into the commit message? Much
> easier to see "why" via "git log" rather than having to open up this Launchpad
> MP.

I updated the code to use short-form bases in the metadata.yaml. Also, updated the commit message of this PR. Thanks!

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision 9a8fe20a0882a7bbd53e02edd565f1b107cd8a11

diff --git a/tests/integration/integration_test.py b/tests/integration/integration_test.py
index aa43008..4463a53 100644
--- a/tests/integration/integration_test.py
+++ b/tests/integration/integration_test.py
@@ -1,3 +1,6 @@
+import csv
+import logging
+import pathlib
 import re
 import socket
 import textwrap
@@ -7,6 +10,10 @@ import pytest_asyncio
 import requests
 import yaml
 
+from pytest_operator.plugin import check_deps
+
+logger = logging.getLogger()
+
 
 def supported_series():
     with open("metadata.yaml", encoding="utf-8") as f:
@@ -14,13 +21,48 @@ def supported_series():
     return metadata['series']
 
 
+def series_version_mapping():
+    reader = csv.DictReader(pathlib.Path("/usr/share/distro-info/ubuntu.csv").open())
+    return {row["series"]: row["version"].split(" ")[0] for row in reader}
+
+
 @pytest.fixture(params=supported_series(), scope="module", name="series")
 def fixture_series(request):
     return request.param
 
 
+@pytest_asyncio.fixture(scope="module", name="charm_file")
+async def charm_file_fixture(ops_test, series, tmp_path_factory):
+    tmp_path = tmp_path_factory.mktemp(f"charm-{series}")
+    charmcraft_file = pathlib.Path(".") / "charmcraft.yaml"
+    charmcraft = yaml.safe_load(charmcraft_file.read_text())
+    metadata_file = pathlib.Path(".") / "metadata.yaml"
+    charm_name = yaml.safe_load(metadata_file.read_text())["name"]
+    base_version = series_version_mapping()[series]
+    base_index = None
+    for idx, base in enumerate(charmcraft["bases"]):
+        if base["channel"] == base_version:
+            base_index = idx
+    logger.info(f"build charm {charm_name}")
+    check_deps("charmcraft")
+    cmd = ("charmcraft", "pack", "-p", pathlib.Path.cwd(), "--bases-index", str(base_index))
+    logger.info(f"run command: {cmd}")
+    return_code, stdout, stderr = await ops_test.run(*cmd, cwd=tmp_path)
+    if return_code != 0:
+        m = re.search(r"Failed to build charm.*full execution logs in '([^']+)'", stderr)
+        if m:
+            try:
+                stderr = pathlib.Path(m.group(1)).read_text()
+            except FileNotFoundError:
+                logger.error(f"Failed to read full build log from {m.group(1)}")
+        raise RuntimeError(f"Failed to build charm:\n{stderr}\n{stdout}")
+    charm_file = next(tmp_path.glob(f"{charm_name}*.charm"))
+    logger.info(f"built charm file: {charm_file}")
+    return charm_file
+
+
 @pytest_asyncio.fixture(scope="module", name="application")
-async def fixture_application(ops_test, series):
+async def fixture_application(ops_test, series, charm_file):
     def dns_lookup_ipv4(hostname):
         records = socket.getaddrinfo(hostname, 0)
         for record in records:
@@ -28,9 +70,8 @@ async def fixture_application(ops_test, series):
                 return record[4][0]
         raise RuntimeError("No IPv4 DNS record for host: {}".format(hostname))
 
-    my_charm = await ops_test.build_charm(".")
     application_name = "content-cache-{}".format(series)
-    await ops_test.model.deploy(my_charm, series=series, application_name=application_name)
+    await ops_test.model.deploy(charm_file, series=series, application_name=application_name)
     # Get the IPv4 address for site to prevent some test environment IPv6 connectivity issues
     website_ip = dns_lookup_ipv4("archive.ubuntu.com")
     application = ops_test.model.applications[application_name]