[PATCH 0/2] dts: add blocklist test suite

[PATCH 0/2] dts: add blocklist test suite

[Luca Vizzarro]

Hello,

sending in an re-implementation of the blocklist test suite.
This new version slightly differs in the way it verifies if a
NIC was blocked or not, but should be equivalent to the original from
old DTS.

Best,

Luca

Luca Vizzarro (2):
  dts: add blocked ports to EalParams
  dts: add blocklist test suite

 dts/framework/config/conf_yaml_schema.json    |  3 +-
 dts/framework/params/eal.py                   |  6 +-
 dts/framework/params/types.py                 |  3 +-
 dts/framework/remote_session/dpdk_shell.py    |  4 +-
 dts/framework/remote_session/testpmd_shell.py |  2 +-
 dts/tests/TestSuite_blocklist.py              | 68 +++++++++++++++++++
 6 files changed, 80 insertions(+), 6 deletions(-)
 create mode 100644 dts/tests/TestSuite_blocklist.py

-- 
2.34.1

[PATCH 1/2] dts: add blocked ports to EalParams

[Luca Vizzarro]

Make the "ports" attribute of EalParams as it actually is to
"allowed_ports", and add "blocked_ports".

Signed-off-by: Luca Vizzarro <luca.vizzarro@arm.com>
Reviewed-by: Paul Szczepanek <paul.szczepanek@arm.com>
---
 dts/framework/params/eal.py                   | 6 +++++-
 dts/framework/params/types.py                 | 3 ++-
 dts/framework/remote_session/dpdk_shell.py    | 4 ++--
 dts/framework/remote_session/testpmd_shell.py | 2 +-
 4 files changed, 10 insertions(+), 5 deletions(-)

diff --git a/dts/framework/params/eal.py b/dts/framework/params/eal.py
index 8d7766fefc..b893d874a7 100644
--- a/dts/framework/params/eal.py
+++ b/dts/framework/params/eal.py
@@ -42,9 +42,13 @@ class EalParams(Params):
     vdevs: list[VirtualDevice] | None = field(
         default=None, metadata=Params.multiple() | Params.long("vdev")
     )
-    ports: list[Port] | None = field(
+    allowed_ports: list[Port] | None = field(
         default=None,
         metadata=Params.convert_value(_port_to_pci) | Params.multiple() | Params.short("a"),
     )
+    blocked_ports: list[Port] | None = field(
+        default=None,
+        metadata=Params.convert_value(_port_to_pci) | Params.multiple() | Params.short("b"),
+    )
     other_eal_param: Params | None = None
     _separator: Literal[True] = field(default=True, init=False, metadata=Params.short("-"))
diff --git a/dts/framework/params/types.py b/dts/framework/params/types.py
index e668f658d8..0a4179fdd0 100644
--- a/dts/framework/params/types.py
+++ b/dts/framework/params/types.py
@@ -49,7 +49,8 @@ class EalParamsDict(TypedDict, total=False):
     prefix: str
     no_pci: Switch
     vdevs: list[VirtualDevice] | None
-    ports: list[Port] | None
+    allowed_ports: list[Port] | None
+    blocked_ports: list[Port] | None
     other_eal_param: Params | None
 
 
diff --git a/dts/framework/remote_session/dpdk_shell.py b/dts/framework/remote_session/dpdk_shell.py
index 296639f37d..6b4cec2466 100644
--- a/dts/framework/remote_session/dpdk_shell.py
+++ b/dts/framework/remote_session/dpdk_shell.py
@@ -54,8 +54,8 @@ def compute_eal_params(
         sut_node.dpdk_prefix_list.append(prefix)
     params.prefix = prefix
 
-    if params.ports is None:
-        params.ports = sut_node.ports
+    if params.allowed_ports is None:
+        params.allowed_ports = sut_node.ports
 
     return params
 
diff --git a/dts/framework/remote_session/testpmd_shell.py b/dts/framework/remote_session/testpmd_shell.py
index ec22f72221..baa773ed70 100644
--- a/dts/framework/remote_session/testpmd_shell.py
+++ b/dts/framework/remote_session/testpmd_shell.py
@@ -638,7 +638,7 @@ def start(self, verify: bool = True) -> None:
                 self._logger.debug(f"Failed to start packet forwarding: \n{start_cmd_output}")
                 raise InteractiveCommandExecutionError("Testpmd failed to start packet forwarding.")
 
-            number_of_ports = len(self._app_params.ports or [])
+            number_of_ports = len(self._app_params.allowed_ports or [])
             for port_id in range(number_of_ports):
                 if not self.wait_link_status_up(port_id):
                     raise InteractiveCommandExecutionError(
-- 
2.34.1

[PATCH 2/2] dts: add blocklist test suite

[Luca Vizzarro]

This test suite tests the port blocklisting functionality built in
testpmd.

Signed-off-by: Luca Vizzarro <luca.vizzarro@arm.com>
Reviewed-by: Paul Szczepanek <paul.szczepanek@arm.com>
---
 dts/framework/config/conf_yaml_schema.json |  3 +-
 dts/tests/TestSuite_blocklist.py           | 68 ++++++++++++++++++++++
 2 files changed, 70 insertions(+), 1 deletion(-)
 create mode 100644 dts/tests/TestSuite_blocklist.py

diff --git a/dts/framework/config/conf_yaml_schema.json b/dts/framework/config/conf_yaml_schema.json
index f02a310bb5..e9414ebff1 100644
--- a/dts/framework/config/conf_yaml_schema.json
+++ b/dts/framework/config/conf_yaml_schema.json
@@ -187,7 +187,8 @@
       "enum": [
         "hello_world",
         "os_udp",
-        "pmd_buffer_scatter"
+        "pmd_buffer_scatter",
+        "blocklist"
       ]
     },
     "test_target": {
diff --git a/dts/tests/TestSuite_blocklist.py b/dts/tests/TestSuite_blocklist.py
new file mode 100644
index 0000000000..7d7f323e36
--- /dev/null
+++ b/dts/tests/TestSuite_blocklist.py
@@ -0,0 +1,68 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2024 Arm Limited
+
+"""The DPDK device blocklisting test suite.
+
+This testing suite ensures tests the port blocklisting functionality of testpmd.
+"""
+
+from framework.remote_session.testpmd_shell import TestPmdShell
+from framework.test_suite import TestSuite
+from framework.testbed_model.port import Port
+
+
+class TestBlocklist(TestSuite):
+    """DPDK device blocklisting test suite.
+
+    For this test suite to work at least 2 ports need to be configured for the SUT node.
+    """
+
+    def set_up_suite(self) -> None:
+        """Verify setup."""
+        self.verify(len(self.sut_node.ports) >= 2, "At least two ports are required for this test")
+
+    def verify_blocklisted_ports(self, ports_to_block: list[Port]):
+        """Runs testpmd with the given ports blocklisted and verifies the ports."""
+        testpmd = TestPmdShell(self.sut_node, allowed_ports=[], blocked_ports=ports_to_block)
+
+        allowlisted_ports = {port.device_name for port in testpmd.show_port_info_all()}
+        blocklisted_ports = {port.pci for port in ports_to_block}
+
+        # sanity check
+        allowed_len = len(allowlisted_ports - blocklisted_ports)
+        self.verify(allowed_len > 0, "At least one port should have been allowed")
+
+        blocked = not allowlisted_ports & blocklisted_ports
+        self.verify(blocked, "At least one port was not blocklisted")
+
+        testpmd.close()
+
+    def test_bl_no_blocklisted(self):
+        """Run testpmd with no blocklisted device.
+
+        Steps:
+            Run testpmd without specifying allowed or blocked ports.
+        Verify:
+            That no ports were blocked.
+        """
+        self.verify_blocklisted_ports([])
+
+    def test_bl_one_port_blocklisted(self):
+        """Run testpmd with one blocklisted port.
+
+        Steps:
+            Run testpmd with one only one blocklisted port and allowing all the other ones.
+        Verify:
+            That the port was successfully blocklisted.
+        """
+        self.verify_blocklisted_ports(self.sut_node.ports[:1])
+
+    def test_bl_all_but_one_port_blocklisted(self):
+        """Run testpmd with all but one blocklisted port.
+
+        Steps:
+            Run testpmd with only one allowed port, blocking all the other ones.
+        Verify:
+            That all specified ports were successfully blocklisted.
+        """
+        self.verify_blocklisted_ports(self.sut_node.ports[:-1])
-- 
2.34.1