Merge branch 'mr/support-for-test-dependencies' into 'master'

Add `test` dependency kind

See merge request it/e3-core!145

Author: elsaferrara

src/e3/anod/deps.py

@@ -12,7 +12,6 @@
 if TYPE_CHECKING:
     from typing import Any, Hashable, Literal
     from e3.anod.spec import Anod, DEPENDENCY_PRIMITIVE
-    from e3.mypy import assert_never
 
 logger = e3.log.getLogger("e3.anod.deps")
 
@@ -38,6 +37,14 @@ def __str__(self) -> str:
 class Dependency:
     kind: DEPENDENCY_PRIMITIVE
 
+    ALLOWED_REQUIRE: dict[str, str] = {
+        "build_tree": "build",
+        "download": "download",
+        "installation": "install",
+        "source_pkg": "source",
+        "test": "test",
+    }
+
     def __init__(
         self,
         name: str,
@@ -52,6 +59,7 @@ def __init__(
             | Literal["installation"]
             | Literal["download"]
             | Literal["source_pkg"]
+            | Literal["test"]
         ) = "build_tree",
         track: bool = False,
         **kwargs: Any,
@@ -103,26 +111,14 @@ def __init__(
         else:
             raise e3.anod.error.SpecError(f"invalid qualifier type: {qualifier}")
 
-        if require not in (
-            "build_tree",
-            "download",
-            "installation",
-            "source_pkg",
-        ):
+        if require in self.ALLOWED_REQUIRE:
+            self.kind = self.ALLOWED_REQUIRE[require]  # type: ignore[assignment]
+        else:
             raise e3.anod.error.SpecError(
-                f"require should be build_tree, download, installation,"
-                f" or source_pkg not {require}."
+                f"Invalid require parameter {require!r}. "
+                f"Allowed values are {', '.join(self.ALLOWED_REQUIRE)}"
             )
-        if require == "build_tree":
-            self.kind = "build"
-        elif require == "download":
-            self.kind = "download"
-        elif require == "installation":
-            self.kind = "install"
-        elif require == "source_pkg":
-            self.kind = "source"
-        else:
-            assert_never()
+
         self.track = track
 
     def env(self, parent: Anod, default_env: BaseEnv) -> BaseEnv:

src/e3/anod/spec.py

@@ -66,7 +66,11 @@
 
     # Anod Dependency can target a build, install, or source
     DEPENDENCY_PRIMITIVE = Union[
-        BUILD_PRIMITIVE, DOWNLOAD_PRIMITIVE, INSTALL_PRIMITIVE, SOURCE_PRIMITIVE
+        BUILD_PRIMITIVE,
+        DOWNLOAD_PRIMITIVE,
+        INSTALL_PRIMITIVE,
+        SOURCE_PRIMITIVE,
+        TEST_PRIMITIVE,
     ]
 
     # Supported primitives are build, install, source, and test

tests/tests_e3/anod/context_data/spec14.anod

@@ -0,0 +1,12 @@
+from e3.anod.spec import Anod
+
+
+class Spec14(Anod):
+
+    @property
+    def build_deps(self):
+        return [Anod.Dependency(name="spec4", require="test")]
+
+    @Anod.primitive()
+    def build(self):
+        pass

tests/tests_e3/anod/context_test.py

@@ -367,6 +367,13 @@ def test_add_anod_action13(self):
         assert "x86-linux.spec13.download_bin" in keys
         assert "x86-linux.spec13.install" in keys
 
+    def test_add_anod_action14(self):
+        """Check test dependency."""
+        ac = self.create_context()
+        ac.add_anod_action("spec14", env=ac.default_env, primitive="build")
+        result = ac.schedule(ac.always_download_source_resolver)
+        assert "x86-linux.spec4.test" in list(result.vertex_data.keys())
+
     def test_source_fails_when_missing_source_primitive(self):
         """Source action should fail when the source primitive is undefined.
 

tests/tests_e3/anod/spec_test.py

@@ -289,14 +289,15 @@ def test_spec_check_dll_closure_single_file(ldd) -> None:  # type: ignore[no-unt
 
 def test_spec_wrong_dep():
     """Check exception message when wrong dependency is set."""
-    with pytest.raises(SpecError) as err:
+    with pytest.raises(
+        SpecError,
+        match=(
+            "Invalid require parameter 'invalid'. "
+            f"Allowed values are {', '.join(Anod.Dependency.ALLOWED_REQUIRE)}"
+        ),
+    ):
         Anod.Dependency("foo", require="invalid")
 
-    assert (
-        "require should be build_tree, download, installation,"
-        " or source_pkg not invalid" in str(err)
-    )
-
 
 def test_primitive():
     class NoPrimitive(Anod):