Merge ~adam-collard/maas-ci/+git/system-tests:mypy-cleanup into ~maas-committers/maas-ci/+git/system-tests:master

[Adam Collard]

chore: remove type:ignore from conftest, lxd

move isort config to pyproject.toml

temporal: use relative imports

[MAAS Lander (maas-lander)]

UNIT TESTS
-b mypy-cleanup lp:~adam-collard/maas-ci/+git/system-tests into -b master lp:~maas-committers/maas-ci/+git/system-tests

STATUS: SUCCESS
COMMIT: 91f7f2f49a3e1b61ac73cfc3dc205f8074570871

review: Approve

[Jack Lloyd-Walters (lloydwaltersj)]

+1

review: Approve

diff --git a/pyproject.toml b/pyproject.toml
index a3b6850..cdbd428 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -19,3 +19,7 @@ log_file_date_format = "%Y-%m-%d %H:%M:%S"
 install_types = true
 non_interactive = true
 strict = true
+
+[tool.isort]
+profile = "black"
+src_paths = ["systemtests", "utils", "temporal"]
diff --git a/systemtests/conftest.py b/systemtests/conftest.py
index 72957ee..fe750a5 100644
--- a/systemtests/conftest.py
+++ b/systemtests/conftest.py
@@ -197,7 +197,7 @@ def pytest_report_header(config: pytest.Config) -> list[str]:
 
 
 @pytest.hookimpl(tryfirst=True, hookwrapper=True)
-def pytest_runtest_makereport(item: Any, call: Any) -> Iterator[Any]:
+def pytest_runtest_makereport(item: Any, call: Any) -> Iterator[None]:
     # execute all other hooks to obtain the report object
     del call
     outcome: _Result
@@ -210,10 +210,10 @@ def pytest_runtest_makereport(item: Any, call: Any) -> Iterator[Any]:
         rep.sections.append(("Test logging", testlog.getvalue()))
 
 
[e-mail](hookwrapper=True)  # type: ignore
[e-mail](hookwrapper=True)
 def pytest_terminal_summary(
     terminalreporter: TerminalReporter, exitstatus: int, config: pytest.Config
-):
+) -> Iterator[None]:
     yield
     # Split the string up to avoid awk accidentally matching when
     # traceback is reported
diff --git a/systemtests/lxd.py b/systemtests/lxd.py
index 5f7061f..ced4b64 100644
--- a/systemtests/lxd.py
+++ b/systemtests/lxd.py
@@ -255,10 +255,6 @@ class Instance:
         return _FilesWrapper(self, self._run)
 
     def get_ip_address(self) -> str:
-        # XXX quieten mypy due to https://github.com/python/mypy/issues/9689
-        @retry(
-            exceptions=ValueError, tries=30, delay=2, backoff=1.1, logger=self.logger
-        )  # type:ignore
         def _get_ip_address() -> str:
             result = self._run(
                 [
@@ -280,7 +276,12 @@ class Instance:
                     f"Unable to find IP address for eth0 on {self._instance_name}"
                 )
 
-        return _get_ip_address()
+        # mypy workaround due to https://github.com/python/mypy/issues/9689
+        retriable_get_ip_address = retry(
+            exceptions=ValueError, tries=30, delay=2, backoff=1.1, logger=self.logger
+        )(_get_ip_address)
+
+        return retriable_get_ip_address()
 
     def list_devices(self) -> list[str]:
         result = self._run(["lxc", "config", "device", "list", self._instance_name])
@@ -303,19 +304,19 @@ class Instance:
     def remove_device(self, name: str) -> None:
         """Remove a device from this instance."""
 
-        # XXX quieten mypy due to https://github.com/python/mypy/issues/9689
-        @retry(
-            exceptions=subprocess.CalledProcessError,
-            tries=5,
-            delay=0.5,
-            logger=self.logger,
-        )  # type:ignore
         def _remove_device() -> subprocess.CompletedProcess[str]:
             return self._run(
                 ["lxc", "config", "device", "remove", self._instance_name, name],
             )
 
-        _remove_device()
+        # mypy workaround due to https://github.com/python/mypy/issues/9689
+        retriable_remove_device = retry(
+            exceptions=subprocess.CalledProcessError,
+            tries=5,
+            delay=0.5,
+            logger=self.logger,
+        )(_remove_device)
+        retriable_remove_device()
 
     def start(self) -> subprocess.CompletedProcess[str]:
         return self._run(["lxc", "start", self._instance_name])
@@ -408,10 +409,6 @@ class CLILXD:
             logger.info(f"Container {name} already exists.")
         logger.info("Waiting for boot to finish...")
 
-        # XXX quieten mypy due to https://github.com/python/mypy/issues/9689
-        @retry(
-            exceptions=CloudInitDisabled, tries=120, delay=1, logger=logger
-        )  # type:ignore
         def _cloud_init_wait() -> None:
             """Wait for cloud-init to finish, and for snapd to seed."""
             cloud_init_process = instance.execute(
@@ -423,7 +420,11 @@ class CLILXD:
                 ["timeout", "2000", "snap", "wait", "system", "seed.loaded"]
             )
 
-        _cloud_init_wait()
+        # mypy workaround due to https://github.com/python/mypy/issues/9689
+        retriable_cloud_init_wait = retry(
+            exceptions=CloudInitDisabled, tries=120, delay=1, logger=logger
+        )(_cloud_init_wait)
+        retriable_cloud_init_wait()
         logger.info("Boot finished.")
         return instance
 
diff --git a/temporal/build_results.py b/temporal/build_results.py
index d7ea890..a658d80 100644
--- a/temporal/build_results.py
+++ b/temporal/build_results.py
@@ -7,7 +7,7 @@ from contextlib import contextmanager
 from dataclasses import dataclass, field
 from typing import Any, Iterable, Iterator
 
-from common_tasks import cleanup_files
+from .common_tasks import cleanup_files
 
 TestSummary = dict[str, dict[str, Any]]
 FeatureSummary = dict[str, Any]
diff --git a/temporal/e2e_worker.py b/temporal/e2e_worker.py
index 97c5260..7dca420 100644
--- a/temporal/e2e_worker.py
+++ b/temporal/e2e_worker.py
@@ -1,6 +1,6 @@
-from common_tasks import start_worker
-from e2e_workflow import activities as e2e_activities
-from e2e_workflow import workflows as e2e_workflows
+from .common_tasks import start_worker
+from .e2e_workflow import activities as e2e_activities
+from .e2e_workflow import workflows as e2e_workflows
 
 if __name__ == "__main__":
     start_worker(
diff --git a/temporal/e2e_workflow.py b/temporal/e2e_workflow.py
index 9b874b1..582182a 100644
--- a/temporal/e2e_workflow.py
+++ b/temporal/e2e_workflow.py
@@ -3,14 +3,15 @@ from dataclasses import dataclass, field
 from typing import Any
 
 import yaml
-from build_results import nested_dict, todict
-from common_tasks import aslist, get_logs, image_name_from_mapping, workflow_parameters
-from image_building_workflow import image_building_param, image_building_workflow
-from image_reporting_workflow import image_reporting_param, image_reporting_workflow
-from image_testing_workflow import image_testing_param, image_testing_workflow
 from temporalio import activity, workflow
 from temporalio.common import RetryPolicy
 
+from .build_results import nested_dict, todict
+from .common_tasks import aslist, get_logs, image_name_from_mapping, workflow_parameters
+from .image_building_workflow import image_building_param, image_building_workflow
+from .image_reporting_workflow import image_reporting_param, image_reporting_workflow
+from .image_testing_workflow import image_testing_param, image_testing_workflow
+
 
 @dataclass
 class e2e_workflow_params(workflow_parameters):
@@ -35,7 +36,7 @@ class e2e_workflow_params(workflow_parameters):
     skip_result_publishing: bool = False
 
     overwrite_results: bool = False
-    # reccommended to leave this false until the rescue issue at CI is fixed
+    # recommended to leave this false until the rescue issue at CI is fixed
     parallel_tests: bool = False
 
     use_build: int | None = None
diff --git a/temporal/image_building_worker.py b/temporal/image_building_worker.py
index 885f578..c3a9961 100644
--- a/temporal/image_building_worker.py
+++ b/temporal/image_building_worker.py
@@ -1,6 +1,6 @@
-from common_tasks import start_worker
-from image_building_workflow import activities as image_build_activities
-from image_building_workflow import workflows as image_build_workflows
+from .common_tasks import start_worker
+from .image_building_workflow import activities as image_build_activities
+from .image_building_workflow import workflows as image_build_workflows
 
 if __name__ == "__main__":
     start_worker(
diff --git a/temporal/image_building_workflow.py b/temporal/image_building_workflow.py
index 5cbbd8d..bac7ce3 100644
--- a/temporal/image_building_workflow.py
+++ b/temporal/image_building_workflow.py
@@ -2,7 +2,10 @@ import re
 from dataclasses import dataclass, field
 from typing import Any
 
-from common_tasks import (
+from temporalio import activity, workflow
+from temporalio.common import RetryPolicy
+
+from .common_tasks import (
     aslist,
     await_build_complete,
     await_build_exists,
@@ -14,8 +17,6 @@ from common_tasks import (
     request_build,
     workflow_parameters,
 )
-from temporalio import activity, workflow
-from temporalio.common import RetryPolicy
 
 
 @dataclass
diff --git a/temporal/image_reporting_worker.py b/temporal/image_reporting_worker.py
index bd1f08b..8e0a1ae 100644
--- a/temporal/image_reporting_worker.py
+++ b/temporal/image_reporting_worker.py
@@ -1,6 +1,6 @@
-from common_tasks import start_worker
-from image_reporting_workflow import activities as image_reporting_activities
-from image_reporting_workflow import workflows as image_reporting_workflows
+from .common_tasks import start_worker
+from .image_reporting_workflow import activities as image_reporting_activities
+from .image_reporting_workflow import workflows as image_reporting_workflows
 
 if __name__ == "__main__":
     start_worker(
diff --git a/temporal/image_reporting_workflow.py b/temporal/image_reporting_workflow.py
index b0ecf8f..5c6a111 100644
--- a/temporal/image_reporting_workflow.py
+++ b/temporal/image_reporting_workflow.py
@@ -5,7 +5,10 @@ from dataclasses import dataclass, field
 from typing import Any
 
 import yaml
-from build_results import (
+from temporalio import activity, workflow
+from temporalio.common import RetryPolicy
+
+from .build_results import (
     FeatureStatus,
     ImageTestResults,
     checkout_and_commit,
@@ -15,7 +18,7 @@ from build_results import (
     execute,
     get_step_from_results,
 )
-from common_tasks import (
+from .common_tasks import (
     check_jenkins_reachable,
     get_build,
     get_config,
@@ -23,8 +26,6 @@ from common_tasks import (
     get_results,
     workflow_parameters,
 )
-from temporalio import activity, workflow
-from temporalio.common import RetryPolicy
 
 STEPS_TO_PARSE = ["deploy", "test_image"]
 
diff --git a/temporal/image_testing_worker.py b/temporal/image_testing_worker.py
index f28bb23..ebf7a82 100644
--- a/temporal/image_testing_worker.py
+++ b/temporal/image_testing_worker.py
@@ -1,6 +1,6 @@
-from common_tasks import start_worker
-from image_testing_workflow import activities as image_test_activities
-from image_testing_workflow import workflows as image_test_workflows
+from .common_tasks import start_worker
+from .image_testing_workflow import activities as image_test_activities
+from .image_testing_workflow import workflows as image_test_workflows
 
 if __name__ == "__main__":
     start_worker(
diff --git a/temporal/image_testing_workflow.py b/temporal/image_testing_workflow.py
index 311bf08..3670db5 100644
--- a/temporal/image_testing_workflow.py
+++ b/temporal/image_testing_workflow.py
@@ -1,7 +1,10 @@
 from dataclasses import dataclass
 from typing import Any
 
-from common_tasks import (
+from temporalio import activity, workflow
+from temporalio.common import RetryPolicy
+
+from .common_tasks import (
     aslist,
     await_build_complete,
     await_build_exists,
@@ -11,8 +14,6 @@ from common_tasks import (
     request_build,
     workflow_parameters,
 )
-from temporalio import activity, workflow
-from temporalio.common import RetryPolicy
 
 
 @dataclass
@@ -38,7 +39,7 @@ class image_testing_param(workflow_parameters):
 @activity.defn
 async def request_images_test(params: image_testing_param) -> int:
     """Start an image testing job, returning the job number."""
-    job_params: dict[str, Any] = {
+    job_params: dict[str, str] = {
         "IMAGE_NAMES": ",".join(image for image in aslist(params.image_name)),
         "SYSTEMTESTS_GIT_REPO": params.system_test_repo,
         "SYSTEMTESTS_GIT_BRANCH": params.system_test_branch,
diff --git a/temporal/monolithic_worker.py b/temporal/monolithic_worker.py
index 94f061a..73e4329 100644
--- a/temporal/monolithic_worker.py
+++ b/temporal/monolithic_worker.py
@@ -1,12 +1,12 @@
-from common_tasks import start_worker
-from e2e_workflow import activities as e2e_activities
-from e2e_workflow import workflows as e2e_workflows
-from image_building_workflow import activities as image_build_activities
-from image_building_workflow import workflows as image_build_workflows
-from image_reporting_workflow import activities as image_reporting_activities
-from image_reporting_workflow import workflows as image_reporting_workflows
-from image_testing_workflow import activities as image_test_activities
-from image_testing_workflow import workflows as image_test_workflows
+from .common_tasks import start_worker
+from .e2e_workflow import activities as e2e_activities
+from .e2e_workflow import workflows as e2e_workflows
+from .image_building_workflow import activities as image_build_activities
+from .image_building_workflow import workflows as image_build_workflows
+from .image_reporting_workflow import activities as image_reporting_activities
+from .image_reporting_workflow import workflows as image_reporting_workflows
+from .image_testing_workflow import activities as image_test_activities
+from .image_testing_workflow import workflows as image_test_workflows
 
 if __name__ == "__main__":
     start_worker(
diff --git a/temporal/test_images.py b/temporal/test_images.py
index c78208a..c6806e6 100644
--- a/temporal/test_images.py
+++ b/temporal/test_images.py
@@ -6,9 +6,10 @@ from datetime import datetime
 from typing import Any
 
 import yaml
-from e2e_workflow import e2e_workflow, e2e_workflow_params
 from temporalio.client import Client
 
+from .e2e_workflow import e2e_workflow, e2e_workflow_params
+
 
 async def main(
     params: e2e_workflow_params,
diff --git a/tox.ini b/tox.ini
index f347a7b..f11676e 100644
--- a/tox.ini
+++ b/tox.ini
@@ -66,7 +66,7 @@ description=Reformat Python code and README.md
 deps= -rrequirements.txt
 skip_install = true
 commands=
-  isort --profile black systemtests utils temporal
+  isort systemtests utils temporal
   black systemtests utils temporal
   cog -r README.md
 
@@ -76,7 +76,7 @@ deps= -rrequirements.txt
 allowlist_externals=sh
 skip_install = true
 commands=
-  isort --profile black --check-only systemtests utils temporal
+  isort --check-only systemtests utils temporal
   black --check systemtests utils temporal
   cog --verbosity=0 --check README.md
   flake8 systemtests utils temporal
@@ -94,8 +94,7 @@ deps=
   mypy
   types-netaddr
 commands=
-  mypy -p systemtests -p utils --install-types
-  mypy temporal
+  mypy -p systemtests -p temporal -p utils --install-types
 
 [testenv:generate_config]
 description=Generate config.yaml