Merge ~adam-collard/maas-ci/+git/system-tests:lxd-vm-bug into ~maas-committers/maas-ci/+git/system-tests:master

[Adam Collard]

Add info to pytest header, hide helpers from traceback

Example output from before: https://paste.ubuntu.com/p/dy9m9H9Nfj/ and after: https://paste.ubuntu.com/p/M8jsyDFFwF/

we can see the failure much clearer when the subprocess helper is elided

[MAAS Lander (maas-lander)]

UNIT TESTS
-b lxd-vm-bug lp:~adam-collard/maas-ci/+git/system-tests into -b master lp:~maas-committers/maas-ci/+git/system-tests

STATUS: SUCCESS
COMMIT: 0c0f08cf73b3cc5a152a6688dbfc86ead903ff86

review: Approve

[Diego Mascialino (dmascialino)]

review: Approve

[Jack Lloyd-Walters (lloydwaltersj)]

+1, with small question

review: Approve

diff --git a/systemtests/api.py b/systemtests/api.py
index 7e68c0e..5e164f0 100644
--- a/systemtests/api.py
+++ b/systemtests/api.py
@@ -106,12 +106,14 @@ class UnauthenticatedMAASAPIClient:
         self.lxd.logger = logger
 
     def execute(self, cmd: list[str], base_cmd: Optional[list[str]] = None) -> str:
+        __tracebackhide__ = True
         if base_cmd is None:
             base_cmd = self.MAAS_CMD
         result = self.lxd.execute(self.maas_container, base_cmd + cmd)
         return result.stdout
 
     def quietly_execute(self, cmd: list[str]) -> str:
+        __tracebackhide__ = True
         result = self.lxd.quietly_execute(self.maas_container, self.MAAS_CMD + cmd)
         return result.stdout
 
@@ -146,6 +148,7 @@ class AuthenticatedAPIClient:
         self.api_client.logger = logger
 
     def _execute(self, cmd: list[str]) -> str:
+        __tracebackhide__ = True
         return self.api_client.execute([self.session] + cmd)
 
     def execute(
@@ -154,6 +157,7 @@ class AuthenticatedAPIClient:
         extra_params: Optional[dict[str, str]] = None,
         json_output: bool = True,
     ) -> Any:
+        __tracebackhide__ = True
         if extra_params:
             cmd.extend([f"{k}={v}" for (k, v) in extra_params.items()])
         output = self._execute(cmd)
@@ -695,4 +699,5 @@ class QuietAuthenticatedAPIClient(AuthenticatedAPIClient):
         return f"<QuietAuthenticatedAPIClient for {self.api_client.url!r}>"
 
     def _execute(self, cmd: list[str]) -> str:
+        __tracebackhide__ = True
         return self.api_client.quietly_execute([self.session] + cmd)
diff --git a/systemtests/conftest.py b/systemtests/conftest.py
index 1c92187..cccd490 100644
--- a/systemtests/conftest.py
+++ b/systemtests/conftest.py
@@ -93,6 +93,22 @@ def config(request: pytest.FixtureRequest) -> dict[str, Any]:
     return config
 
 
+def pytest_report_header(config: pytest.Config) -> list[str]:
+    headers = []
+    systemtests_config = config.getoption("--ss-config")
+    package_type = "snap" if "snap" in systemtests_config else "deb"
+    headers.append(f"packagetype: {package_type}")
+    machines = ", ".join(
+        machine_config.name
+        for machine_config in generate_machines_config(systemtests_config)
+    )
+    headers.append(f"machines: {machines}")
+    tls = "tls" in systemtests_config
+    if tls:
+        headers.append("tlsenabled: true")
+    return headers
+
+
 @pytest.hookimpl(tryfirst=True, hookwrapper=True)  # type: ignore
 def pytest_runtest_makereport(item: Any, call: Any) -> Iterator[Any]:
     # execute all other hooks to obtain the report object
diff --git a/systemtests/lxd.py b/systemtests/lxd.py
index 29df65c..cc7ab97 100644
--- a/systemtests/lxd.py
+++ b/systemtests/lxd.py
@@ -55,6 +55,7 @@ class CLILXD:
         prefix: Optional[list[str]] = None,
         logger: Optional[logging.Logger] = None,
     ) -> subprocess.CompletedProcess[str]:
+        __tracebackhide__ = True
         if logger is None:
             logger = self.logger
         return run_with_logging(cmd, logger, prefix=prefix)
@@ -177,6 +178,8 @@ class CLILXD:
         executor: Callable[[], subprocess.CompletedProcess[str]],
         logger: Optional[logging.Logger],
     ) -> subprocess.CompletedProcess[str]:
+        __tracebackhide__ = True
+
         # Retry the run, excepting websocket: bad handshake errors
         @retry(exceptions=BadWebSocketHandshakeError, tries=3, logger=logger)
         def _retry_bad_handshake() -> subprocess.CompletedProcess[str]:
@@ -208,6 +211,7 @@ class CLILXD:
         command: list[str],
         environment: Optional[dict[str, str]] = None,
     ) -> subprocess.CompletedProcess[str]:
+        __tracebackhide__ = True
         logger = self.logger.getChild(container)
         lxc_command = self._get_lxc_command(container, environment)
 
@@ -222,6 +226,7 @@ class CLILXD:
         environment: Optional[dict[str, str]] = None,
     ) -> subprocess.CompletedProcess[str]:
         """Execute a command without logging it."""
+        __tracebackhide__ = True
         lxc_command = self._get_lxc_command(container, environment)
 
         executor = partial(
diff --git a/systemtests/subprocess.py b/systemtests/subprocess.py
index 500e304..51ef9a5 100644
--- a/systemtests/subprocess.py
+++ b/systemtests/subprocess.py
@@ -16,6 +16,7 @@ def run_with_logging(
     env: Optional[dict[str, str]] = None,
     prefix: Optional[list[str]] = None,
 ) -> subprocess.CompletedProcess[str]:
+    __tracebackhide__ = True
     if prefix is None:
         prefix = []
     logger.info("┌ " + " ".join(repr(arg) if "\n" in arg else arg for arg in cmd))
diff --git a/tox.ini b/tox.ini
index 920433a..5f06548 100644
--- a/tox.ini
+++ b/tox.ini
@@ -4,7 +4,7 @@ envlist = cog,lint,mypy,env_builder
 
 [testenv]
 commands=
-  pytest -k {envname} --log-file systemtests.{envname}.log --junit-xml=junit.{envname}.xml {posargs}
+  pytest --pyargs systemtests -k {envname} --log-file systemtests.{envname}.log --junit-xml=junit.{envname}.xml {posargs}
 setenv =
   env_builder: PYTEST_ADDOPTS=--maxfail=1