test(tls-certificates): flat layout for test charms, minor doc fixes/improvements

interfaces/tls-certificates/pyproject.toml

@@ -80,10 +80,11 @@ extends = "../../pyproject.toml"
 include = ["src", "tests", "interface"]
 pythonVersion = "3.10"  # check no python > 3.10 features are used
 ignore = [
-    "tests/integration/charms/*/published/src/charmlibs",
+    "tests/integration/charms/*/library/src/charmlibs",
+    # symlink sources; the charm code is checked via the dereferenced copies in each charm's src/
+    "tests/integration/charms/common",
     # imports the Charmhub-hosted lib, which is only present in the packed charm
-    "tests/integration/charms/requirer/fetch_lib_charm.py",
-    "tests/integration/charms/requirer/fetch-lib-*",
+    "tests/integration/charms/fetch-lib-*",
 ]
 
 [tool.charmlibs.functional]

interfaces/tls-certificates/tests/integration/charms/common/local-library/README.md

@@ -0,0 +1,8 @@
+# Placeholder README for the library under test
+
+This directory is a local copy of the library under test. Test charms depend on it by creating a symlink to it and pointing their `tool.uv.sources` there.
+
+We need this local copy rather than just symlinking to the parent library directory so that when we `cp --recursive --dereference` the test charm to prepare it for packing, the library symlink is not recursive.
+
+- `pyproject.toml` and `src/` are symlinks to the real library at the package root so the charm always builds against the current source.
+- `README.md` is this placeholder. A readme is required because the library decalares `readme = "README.md", and hatchling fails the build if that file is missing.

interfaces/tls-certificates/tests/integration/charms/common/local-library/pyproject.toml

@@ -0,0 +1 @@
+../../../../../pyproject.toml

interfaces/tls-certificates/tests/integration/charms/common/local-library/src

@@ -0,0 +1 @@
+../../../../../src

interfaces/tls-certificates/tests/integration/charms/fetch-lib-latest-requirer-charm/charmcraft.yaml

@@ -0,0 +1 @@
+../common/requirer-charmcraft.yaml

interfaces/tls-certificates/tests/integration/charms/fetch-lib-latest-requirer-charm/src/charm.py

@@ -0,0 +1 @@
+../../common/requirer-fetch-lib-charm.py

interfaces/tls-certificates/tests/integration/charms/fetch-lib-pre-fix-requirer-charm/charmcraft.yaml

@@ -0,0 +1 @@
+../common/requirer-charmcraft.yaml

interfaces/tls-certificates/tests/integration/charms/fetch-lib-pre-fix-requirer-charm/src/charm.py

@@ -0,0 +1 @@
+../../common/requirer-fetch-lib-charm.py

interfaces/tls-certificates/tests/integration/charms/local-provider-charm/charmcraft.yaml

@@ -0,0 +1 @@
+../common/provider-charmcraft.yaml

interfaces/tls-certificates/tests/integration/charms/local-provider-charm/library

@@ -0,0 +1 @@
+../common/local-library

interfaces/tls-certificates/tests/integration/charms/local-provider-charm/src/charm.py

@@ -0,0 +1 @@
+../../common/provider-charm.py

interfaces/tls-certificates/tests/integration/charms/local-provider-charm/src/self_signed_certificates.py

@@ -0,0 +1 @@
+../../common/provider-self-signed-certificates.py

interfaces/tls-certificates/tests/integration/charms/local-requirer-charm/charmcraft.yaml

@@ -0,0 +1 @@
+../common/requirer-charmcraft.yaml

interfaces/tls-certificates/tests/integration/charms/local-requirer-charm/library

@@ -0,0 +1 @@
+../common/local-library

interfaces/tls-certificates/tests/integration/charms/local-requirer-charm/src/charm.py

@@ -0,0 +1 @@
+../../common/requirer-charm.py

interfaces/tls-certificates/tests/integration/charms/published-provider-charm/charmcraft.yaml

@@ -0,0 +1 @@
+../common/provider-charmcraft.yaml

interfaces/tls-certificates/tests/integration/charms/published-provider-charm/src/charm.py

@@ -0,0 +1 @@
+../../common/provider-charm.py

interfaces/tls-certificates/tests/integration/charms/published-provider-charm/src/self_signed_certificates.py

@@ -0,0 +1 @@
+../../common/provider-self-signed-certificates.py

interfaces/tls-certificates/tests/integration/charms/published-requirer-charm/charmcraft.yaml

@@ -0,0 +1 @@
+../common/requirer-charmcraft.yaml

interfaces/tls-certificates/tests/integration/charms/published-requirer-charm/src/charm.py

@@ -0,0 +1 @@
+../../common/requirer-charm.py

interfaces/tls-certificates/tests/integration/charms/pyproject.toml

@@ -0,0 +1 @@
+# empty file to satisfy extends in */[local-]library/pyproject.toml

interfaces/tls-certificates/tests/integration/pack.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 # This script is executed in this directory via `just pack-k8s` or `just pack-machine`.
-# Extra args are passed to this script, e.g. `just pack-k8s foo` -> $1 is 'foo'.
+# Extra args are passed to this script, e.g. `just pack-k8s <package> foo` -> $1 is 'foo'.
 # In CI, the `just pack-<substrate>` commands are invoked:
 #     - If this file exists and `just integration-<substrate>` would execute any tests
 #     - Before running integration tests
@@ -9,8 +9,8 @@
 # Environment variables:
 # $CHARMLIBS_SUBSTRATE will have the value 'k8s' or 'machine' (set by pack-k8s or pack-machine)
 # In CI, $CHARMLIBS_TAG is set based on pyproject.toml:tool.charmlibs.integration.tags
-# For local testing, set $CHARMLIBS_TAG directly or use the tag variable. For example:
-# just tag=24.04 pack-k8s some extra args
+# For local testing, set $CHARMLIBS_TAG directly or use the --tag option. For example:
+# just pack-k8s --tag=24.04 <package>
 set -xueo pipefail
 
 TMP_DIR=".tmp"  # clean temporary directory where charms will be packed
@@ -26,7 +26,7 @@ for charm in 'provider' 'requirer'; do
 
         : copy charm files to temporary directory for packing, dereferencing symlinks
         rm -rf "$charm_tmp_dir"
-        cp --recursive --dereference "charms/$charm/$variant" "$charm_tmp_dir"
+        cp --recursive --dereference "charms/$variant-$charm-charm" "$charm_tmp_dir"
 
         : pack charm
         cd "$charm_tmp_dir"
@@ -48,7 +48,7 @@ for variant_and_lib in 'fetch-lib-latest=4' 'fetch-lib-pre-fix=4.26'; do
     charm_tmp_dir="$TMP_DIR/requirer-$variant"
 
     rm -rf "$charm_tmp_dir"
-    cp --recursive --dereference "charms/requirer/$variant" "$charm_tmp_dir"
+    cp --recursive --dereference "charms/$variant-requirer-charm" "$charm_tmp_dir"
 
     : declare the Charmhub lib at the pinned version, then fetch and pack
     printf '\ncharm-libs:\n  - lib: tls_certificates_interface.tls_certificates\n    version: "%s"\n' \