[RFC PATCH 2/7] dts: isolate test specification to config

[Nicholas Pratte]

This makes sense to me!

Reviewed-by: Nicholas Pratte <npratte at iol.unh.edu>

On Mon, Feb 3, 2025 at 10:17 AM Luca Vizzarro <luca.vizzarro at arm.com> wrote:
>
> In an effort to improve separation of concerns, make the TestRunConfig
> class responsible for processing the configured test suites. Moreover,
> give TestSuiteConfig a facility to yield references to the selected test
> cases.
>
> Signed-off-by: Luca Vizzarro <luca.vizzarro at arm.com>
> ---
>  dts/framework/config/__init__.py | 84 +++++++++++---------------------
>  dts/framework/config/test_run.py | 59 +++++++++++++++++-----
>  2 files changed, 76 insertions(+), 67 deletions(-)
>
> diff --git a/dts/framework/config/__init__.py b/dts/framework/config/__init__.py
> index f8ac2c0d18..7761a8b56f 100644
> --- a/dts/framework/config/__init__.py
> +++ b/dts/framework/config/__init__.py
> @@ -27,9 +27,8 @@
>        and makes it thread safe should we ever want to move in that direction.
>  """
>
> -from functools import cached_property
>  from pathlib import Path
> -from typing import Annotated, Any, Literal, NamedTuple, TypeVar, cast
> +from typing import Annotated, Any, Literal, TypeVar, cast
>
>  import yaml
>  from pydantic import Field, TypeAdapter, ValidationError, field_validator, model_validator
> @@ -46,18 +45,6 @@
>  )
>  from .test_run import TestRunConfiguration
>
> -
> -class TestRunWithNodesConfiguration(NamedTuple):
> -    """Tuple containing the configuration of the test run and its associated nodes."""
> -
> -    #:
> -    test_run_config: TestRunConfiguration
> -    #:
> -    sut_node_config: SutNodeConfiguration
> -    #:
> -    tg_node_config: TGNodeConfiguration
> -
> -
>  TestRunsConfig = Annotated[list[TestRunConfiguration], Field(min_length=1)]
>
>  NodesConfig = Annotated[list[NodeConfigurationTypes], Field(min_length=1)]
> @@ -71,40 +58,6 @@ class Configuration(FrozenModel):
>      #: Node configurations.
>      nodes: NodesConfig
>
> -    @cached_property
> -    def test_runs_with_nodes(self) -> list[TestRunWithNodesConfiguration]:
> -        """List of test runs with the associated nodes."""
> -        test_runs_with_nodes = []
> -
> -        for test_run_no, test_run in enumerate(self.test_runs):
> -            sut_node_name = test_run.system_under_test_node
> -            sut_node = next(filter(lambda n: n.name == sut_node_name, self.nodes), None)
> -
> -            assert sut_node is not None, (
> -                f"test_runs.{test_run_no}.sut_node_config.node_name "
> -                f"({test_run.system_under_test_node}) is not a valid node name"
> -            )
> -            assert isinstance(sut_node, SutNodeConfiguration), (
> -                f"test_runs.{test_run_no}.sut_node_config.node_name is a valid node name, "
> -                "but it is not a valid SUT node"
> -            )
> -
> -            tg_node_name = test_run.traffic_generator_node
> -            tg_node = next(filter(lambda n: n.name == tg_node_name, self.nodes), None)
> -
> -            assert tg_node is not None, (
> -                f"test_runs.{test_run_no}.tg_node_name "
> -                f"({test_run.traffic_generator_node}) is not a valid node name"
> -            )
> -            assert isinstance(tg_node, TGNodeConfiguration), (
> -                f"test_runs.{test_run_no}.tg_node_name is a valid node name, "
> -                "but it is not a valid TG node"
> -            )
> -
> -            test_runs_with_nodes.append(TestRunWithNodesConfiguration(test_run, sut_node, tg_node))
> -
> -        return test_runs_with_nodes
> -
>      @field_validator("nodes")
>      @classmethod
>      def validate_node_names(cls, nodes: list[NodeConfiguration]) -> list[NodeConfiguration]:
> @@ -164,14 +117,33 @@ def validate_port_links(self) -> Self:
>          return self
>
>      @model_validator(mode="after")
> -    def validate_test_runs_with_nodes(self) -> Self:
> -        """Validate the test runs to nodes associations.
> -
> -        This validator relies on the cached property `test_runs_with_nodes` to run for the first
> -        time in this call, therefore triggering the assertions if needed.
> -        """
> -        if self.test_runs_with_nodes:
> -            pass
> +    def validate_test_runs_against_nodes(self) -> Self:
> +        """Validate the test runs to nodes associations."""
> +        for test_run_no, test_run in enumerate(self.test_runs):
> +            sut_node_name = test_run.system_under_test_node
> +            sut_node = next((n for n in self.nodes if n.name == sut_node_name), None)
> +
> +            assert sut_node is not None, (
> +                f"Test run {test_run_no}.system_under_test_node "
> +                f"({sut_node_name}) is not a valid node name."
> +            )
> +            assert isinstance(sut_node, SutNodeConfiguration), (
> +                f"Test run {test_run_no}.system_under_test_node is a valid node name, "
> +                "but it is not a valid SUT node."
> +            )
> +
> +            tg_node_name = test_run.traffic_generator_node
> +            tg_node = next((n for n in self.nodes if n.name == tg_node_name), None)
> +
> +            assert tg_node is not None, (
> +                f"Test run {test_run_no}.traffic_generator_name "
> +                f"({tg_node_name}) is not a valid node name."
> +            )
> +            assert isinstance(tg_node, TGNodeConfiguration), (
> +                f"Test run {test_run_no}.traffic_generator_name is a valid node name, "
> +                "but it is not a valid TG node."
> +            )
> +
>          return self
>
>
> diff --git a/dts/framework/config/test_run.py b/dts/framework/config/test_run.py
> index 2092da725e..9ea898b15c 100644
> --- a/dts/framework/config/test_run.py
> +++ b/dts/framework/config/test_run.py
> @@ -11,6 +11,8 @@
>
>  import re
>  import tarfile
> +from collections import deque
> +from collections.abc import Iterable
>  from enum import auto, unique
>  from functools import cached_property
>  from pathlib import Path, PurePath
> @@ -25,7 +27,7 @@
>  from .common import FrozenModel, load_fields_from_settings
>
>  if TYPE_CHECKING:
> -    from framework.test_suite import TestSuiteSpec
> +    from framework.test_suite import TestCase, TestSuite, TestSuiteSpec
>
>
>  @unique
> @@ -233,6 +235,21 @@ def test_suite_spec(self) -> "TestSuiteSpec":
>          ), f"{self.test_suite_name} is not a valid test suite module name."
>          return test_suite_spec
>
> +    @cached_property
> +    def test_cases(self) -> list[type["TestCase"]]:
> +        """The objects of the selected test cases."""
> +        available_test_cases = {t.name: t for t in self.test_suite_spec.class_obj.get_test_cases()}
> +        selected_test_cases = []
> +
> +        for requested_test_case in self.test_cases_names:
> +            assert requested_test_case in available_test_cases, (
> +                f"{requested_test_case} is not a valid test case "
> +                f"of test suite {self.test_suite_name}."
> +            )
> +            selected_test_cases.append(available_test_cases[requested_test_case])
> +
> +        return selected_test_cases or list(available_test_cases.values())
> +
>      @model_validator(mode="before")
>      @classmethod
>      def convert_from_string(cls, data: Any) -> Any:
> @@ -246,17 +263,11 @@ def convert_from_string(cls, data: Any) -> Any:
>      def validate_names(self) -> Self:
>          """Validate the supplied test suite and test cases names.
>
> -        This validator relies on the cached property `test_suite_spec` to run for the first
> -        time in this call, therefore triggering the assertions if needed.
> +        This validator relies on the cached properties `test_suite_spec` and `test_cases` to run for
> +        the first time in this call, therefore triggering the assertions if needed.
>          """
> -        available_test_cases = map(
> -            lambda t: t.name, self.test_suite_spec.class_obj.get_test_cases()
> -        )
> -        for requested_test_case in self.test_cases_names:
> -            assert requested_test_case in available_test_cases, (
> -                f"{requested_test_case} is not a valid test case "
> -                f"of test suite {self.test_suite_name}."
> -            )
> +        if self.test_cases:
> +            pass
>
>          return self
>
> @@ -383,3 +394,29 @@ class TestRunConfiguration(FrozenModel):
>      fields_from_settings = model_validator(mode="before")(
>          load_fields_from_settings("test_suites", "random_seed")
>      )
> +
> +    def filter_tests(
> +        self,
> +    ) -> Iterable[tuple[type["TestSuite"], deque[type["TestCase"]]]]:
> +        """Filter test suites and cases selected for execution."""
> +        from framework.test_suite import TestCaseType
> +
> +        test_suites = [TestSuiteConfig(test_suite="smoke_tests")]
> +
> +        if self.skip_smoke_tests:
> +            test_suites = self.test_suites
> +        else:
> +            test_suites += self.test_suites
> +
> +        return (
> +            (
> +                t.test_suite_spec.class_obj,
> +                deque(
> +                    tt
> +                    for tt in t.test_cases
> +                    if (tt.test_type is TestCaseType.FUNCTIONAL and self.func)
> +                    or (tt.test_type is TestCaseType.PERFORMANCE and self.perf)
> +                ),
> +            )
> +            for t in test_suites
> +        )
> --
> 2.43.0
>