* [PATCH v5 0/7] dts: remove imports from framework in test suites
@ 2026-08-06 13:53 Andrew Bailey
2026-08-06 13:53 ` [PATCH v5 1/7] dts: move exception module from framework to API Andrew Bailey
` (9 more replies)
0 siblings, 10 replies; 47+ messages in thread
From: Andrew Bailey @ 2026-08-06 13:53 UTC (permalink / raw)
To: dev, luca.vizzarro, patrickrobb1997
Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx
This series takes action to make modules accessible from api that were
only in framework before. This greatly cleans up the majority of test
suites, ridding them of almost all framework imports.
Signed-off-by: Dean Marx <dmarx@iol.unh.edu>
Signed-off-by: Andrew Bailey <abailey@iol.unh.edu>
---
v5:
* Resolved merge conflicts and rebased to main.
* Removed additional framework imports from test suites.
Andrew Bailey (7):
dts: move exception module from framework to API
dts: move utils from framework to API
dts: move context from framework to API
dts: move testbed model from framework to API
dts: move test suite module from framework to API
dts: move params directory from framework to API
dts: separate Linux session into interface and logic
...{framework.context.rst => api.context.rst} | 2 +-
...mework.exception.rst => api.exception.rst} | 2 +-
...work.params.eal.rst => api.params.eal.rst} | 2 +-
.../{framework.params.rst => api.params.rst} | 6 +-
....params.types.rst => api.params.types.rst} | 2 +-
...work.test_suite.rst => api.test_suite.rst} | 2 +-
...y.rst => api.testbed_model.capability.rst} | 2 +-
...odel.cpu.rst => api.testbed_model.cpu.rst} | 2 +-
...st => api.testbed_model.linux_session.rst} | 2 +-
...el.node.rst => api.testbed_model.node.rst} | 2 +-
...n.rst => api.testbed_model.os_session.rst} | 2 +-
...el.port.rst => api.testbed_model.port.rst} | 2 +-
...st => api.testbed_model.posix_session.rst} | 2 +-
doc/api/dts/api.testbed_model.rst | 28 ++
...ogy.rst => api.testbed_model.topology.rst} | 2 +-
...generator.capturing_traffic_generator.rst} | 2 +-
.../api.testbed_model.traffic_generator.rst | 16 +
...testbed_model.traffic_generator.scapy.rst} | 2 +-
...l.traffic_generator.traffic_generator.rst} | 2 +-
...t => api.testbed_model.virtual_device.rst} | 2 +-
.../{framework.utils.rst => api.utils.rst} | 2 +-
doc/api/dts/framework.testbed_model.rst | 28 --
...mework.testbed_model.traffic_generator.rst | 16 -
doc/api/dts/index.rst | 13 +-
dts/api/artifact.py | 6 +-
dts/api/capabilities.py | 14 +-
dts/{framework => api}/context.py | 14 +-
dts/api/cryptodev/__init__.py | 6 +-
dts/api/cryptodev/config.py | 6 +-
dts/{framework => api}/exception.py | 0
dts/api/packet.py | 18 +-
dts/{framework => api}/params/__init__.py | 0
dts/{framework => api}/params/eal.py | 8 +-
dts/{framework => api}/params/types.py | 16 +-
dts/api/test.py | 4 +-
dts/{framework => api}/test_suite.py | 15 +-
.../testbed_model/__init__.py | 0
.../testbed_model/capability.py | 18 +-
dts/{framework => api}/testbed_model/cpu.py | 4 +-
dts/api/testbed_model/linux_session.py | 45 ++
dts/{framework => api}/testbed_model/node.py | 6 +-
.../testbed_model/os_session.py | 8 +-
dts/{framework => api}/testbed_model/port.py | 2 +-
.../testbed_model/posix_session.py | 6 +-
.../testbed_model/topology.py | 20 +-
.../traffic_generator/__init__.py | 4 +-
.../capturing_traffic_generator.py | 4 +-
.../performance_traffic_generator.py | 0
.../testbed_model/traffic_generator/scapy.py | 14 +-
.../traffic_generator/traffic_generator.py | 8 +-
.../testbed_model/traffic_generator/trex.py | 18 +-
.../testbed_model/virtual_device.py | 0
dts/api/testpmd/__init__.py | 11 +-
dts/api/testpmd/config.py | 6 +-
dts/api/testpmd/types.py | 2 +-
dts/{framework => api}/utils.py | 2 +-
dts/framework/config/__init__.py | 6 +-
dts/framework/config/node.py | 2 +-
dts/framework/config/test_run.py | 12 +-
dts/framework/parser.py | 2 +-
dts/framework/remote_session/blocking_app.py | 8 +-
dts/framework/remote_session/dpdk.py | 16 +-
dts/framework/remote_session/dpdk_shell.py | 6 +-
.../interactive_remote_session.py | 2 +-
.../remote_session/interactive_shell.py | 8 +-
.../remote_session/remote_session.py | 4 +-
dts/framework/runner.py | 4 +-
dts/framework/test_result.py | 5 +-
dts/framework/test_run.py | 24 +-
dts/framework/testbed_model/linux_session.py | 462 ------------------
dts/tests/TestSuite_blocklist.py | 4 +-
dts/tests/TestSuite_buffer_scatter.py | 2 +-
dts/tests/TestSuite_checksum_offload.py | 2 +-
dts/tests/TestSuite_cryptodev_latency.py | 6 +-
dts/tests/TestSuite_cryptodev_throughput.py | 89 +---
dts/tests/TestSuite_dual_vlan.py | 2 +-
dts/tests/TestSuite_dynamic_config.py | 2 +-
dts/tests/TestSuite_dynamic_queue_conf.py | 4 +-
dts/tests/TestSuite_flow_offload.py | 12 +-
dts/tests/TestSuite_hello_world.py | 2 +-
dts/tests/TestSuite_l2fwd.py | 8 +-
dts/tests/TestSuite_mac_filter.py | 4 +-
dts/tests/TestSuite_mtu.py | 2 +-
dts/tests/TestSuite_packet_capture.py | 12 +-
dts/tests/TestSuite_port_control.py | 2 +-
...stSuite_port_restart_config_persistency.py | 2 +-
dts/tests/TestSuite_port_stats.py | 2 +-
dts/tests/TestSuite_promisc_support.py | 2 +-
dts/tests/TestSuite_qinq.py | 2 +-
dts/tests/TestSuite_queue_toggle.py | 2 +-
dts/tests/TestSuite_rss.py | 6 +-
dts/tests/TestSuite_rx_split.py | 4 +-
dts/tests/TestSuite_rx_tx_offload.py | 2 +-
.../TestSuite_single_core_forward_perf.py | 4 +-
dts/tests/TestSuite_smoke_tests.py | 6 +-
dts/tests/TestSuite_softnic.py | 6 +-
dts/tests/TestSuite_speed_capabilities.py | 2 +-
dts/tests/TestSuite_unified_packet.py | 2 +-
dts/tests/TestSuite_virtio_forward.py | 8 +-
dts/tests/TestSuite_vlan.py | 2 +-
100 files changed, 368 insertions(+), 826 deletions(-)
rename doc/api/dts/{framework.context.rst => api.context.rst} (80%)
rename doc/api/dts/{framework.exception.rst => api.exception.rst} (77%)
rename doc/api/dts/{framework.params.eal.rst => api.params.eal.rst} (79%)
rename doc/api/dts/{framework.params.rst => api.params.rst} (71%)
rename doc/api/dts/{framework.params.types.rst => api.params.types.rst} (80%)
rename doc/api/dts/{framework.test_suite.rst => api.test_suite.rst} (81%)
rename doc/api/dts/{framework.testbed_model.capability.rst => api.testbed_model.capability.rst} (74%)
rename doc/api/dts/{framework.testbed_model.cpu.rst => api.testbed_model.cpu.rst} (78%)
rename doc/api/dts/{framework.testbed_model.linux_session.rst => api.testbed_model.linux_session.rst} (74%)
rename doc/api/dts/{framework.testbed_model.node.rst => api.testbed_model.node.rst} (71%)
rename doc/api/dts/{framework.testbed_model.os_session.rst => api.testbed_model.os_session.rst} (76%)
rename doc/api/dts/{framework.testbed_model.port.rst => api.testbed_model.port.rst} (77%)
rename doc/api/dts/{framework.testbed_model.posix_session.rst => api.testbed_model.posix_session.rst} (74%)
create mode 100644 doc/api/dts/api.testbed_model.rst
rename doc/api/dts/{framework.testbed_model.topology.rst => api.testbed_model.topology.rst} (73%)
rename doc/api/dts/{framework.testbed_model.traffic_generator.capturing_traffic_generator.rst => api.testbed_model.traffic_generator.capturing_traffic_generator.rst} (68%)
create mode 100644 doc/api/dts/api.testbed_model.traffic_generator.rst
rename doc/api/dts/{framework.testbed_model.traffic_generator.scapy.rst => api.testbed_model.traffic_generator.scapy.rst} (70%)
rename doc/api/dts/{framework.testbed_model.traffic_generator.traffic_generator.rst => api.testbed_model.traffic_generator.traffic_generator.rst} (65%)
rename doc/api/dts/{framework.testbed_model.virtual_device.rst => api.testbed_model.virtual_device.rst} (72%)
rename doc/api/dts/{framework.utils.rst => api.utils.rst} (80%)
delete mode 100644 doc/api/dts/framework.testbed_model.rst
delete mode 100644 doc/api/dts/framework.testbed_model.traffic_generator.rst
rename dts/{framework => api}/context.py (90%)
rename dts/{framework => api}/exception.py (100%)
rename dts/{framework => api}/params/__init__.py (100%)
rename dts/{framework => api}/params/eal.py (89%)
rename dts/{framework => api}/params/types.py (93%)
rename dts/{framework => api}/test_suite.py (98%)
rename dts/{framework => api}/testbed_model/__init__.py (100%)
rename dts/{framework => api}/testbed_model/capability.py (98%)
rename dts/{framework => api}/testbed_model/cpu.py (99%)
create mode 100644 dts/api/testbed_model/linux_session.py
rename dts/{framework => api}/testbed_model/node.py (98%)
rename dts/{framework => api}/testbed_model/os_session.py (99%)
rename dts/{framework => api}/testbed_model/port.py (98%)
rename dts/{framework => api}/testbed_model/posix_session.py (99%)
rename dts/{framework => api}/testbed_model/topology.py (96%)
rename dts/{framework => api}/testbed_model/traffic_generator/__init__.py (95%)
rename dts/{framework => api}/testbed_model/traffic_generator/capturing_traffic_generator.py (98%)
rename dts/{framework => api}/testbed_model/traffic_generator/performance_traffic_generator.py (100%)
rename dts/{framework => api}/testbed_model/traffic_generator/scapy.py (98%)
rename dts/{framework => api}/testbed_model/traffic_generator/traffic_generator.py (91%)
rename dts/{framework => api}/testbed_model/traffic_generator/trex.py (96%)
rename dts/{framework => api}/testbed_model/virtual_device.py (100%)
rename dts/{framework => api}/utils.py (99%)
delete mode 100644 dts/framework/testbed_model/linux_session.py
--
2.55.0
^ permalink raw reply [flat|nested] 47+ messages in thread* [PATCH v5 1/7] dts: move exception module from framework to API 2026-08-06 13:53 [PATCH v5 0/7] dts: remove imports from framework in test suites Andrew Bailey @ 2026-08-06 13:53 ` Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 2/7] dts: move utils " Andrew Bailey ` (8 subsequent siblings) 9 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 13:53 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx Multiple test suites currently import the exception module from the framework in order to catch certain errors during test execution. Move this to the API. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- ...mework.exception.rst => api.exception.rst} | 2 +- doc/api/dts/index.rst | 2 +- dts/api/artifact.py | 2 +- dts/api/cryptodev/__init__.py | 2 +- dts/{framework => api}/exception.py | 0 dts/api/packet.py | 2 +- dts/api/test.py | 2 +- dts/api/testpmd/__init__.py | 2 +- dts/framework/config/__init__.py | 2 +- dts/framework/config/test_run.py | 2 +- dts/framework/context.py | 2 +- dts/framework/parser.py | 2 +- dts/framework/remote_session/dpdk.py | 2 +- .../interactive_remote_session.py | 2 +- .../remote_session/interactive_shell.py | 4 +- .../remote_session/remote_session.py | 4 +- dts/framework/runner.py | 2 +- dts/framework/test_result.py | 3 +- dts/framework/test_run.py | 4 +- dts/framework/test_suite.py | 2 +- dts/framework/testbed_model/capability.py | 2 +- dts/framework/testbed_model/linux_session.py | 2 +- dts/framework/testbed_model/node.py | 2 +- dts/framework/testbed_model/port.py | 2 +- dts/framework/testbed_model/posix_session.py | 2 +- dts/framework/testbed_model/topology.py | 2 +- .../traffic_generator/__init__.py | 2 +- .../testbed_model/traffic_generator/scapy.py | 2 +- .../testbed_model/traffic_generator/trex.py | 2 +- dts/framework/utils.py | 2 +- dts/tests/TestSuite_cryptodev_throughput.py | 83 ++++--------------- dts/tests/TestSuite_dynamic_queue_conf.py | 2 +- dts/tests/TestSuite_flow_offload.py | 10 +-- dts/tests/TestSuite_mac_filter.py | 2 +- dts/tests/TestSuite_rss.py | 2 +- dts/tests/TestSuite_rx_split.py | 2 +- 36 files changed, 58 insertions(+), 108 deletions(-) rename doc/api/dts/{framework.exception.rst => api.exception.rst} (77%) rename dts/{framework => api}/exception.py (100%) diff --git a/doc/api/dts/framework.exception.rst b/doc/api/dts/api.exception.rst similarity index 77% rename from doc/api/dts/framework.exception.rst rename to doc/api/dts/api.exception.rst index efb47dc5ae..8e6bff5ee7 100644 --- a/doc/api/dts/framework.exception.rst +++ b/doc/api/dts/api.exception.rst @@ -3,6 +3,6 @@ exception - Exceptions ====================== -.. automodule:: framework.exception +.. automodule:: api.exception :members: :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index c719297c11..01f630e7cd 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -36,7 +36,7 @@ Modules framework.logger framework.parser framework.utils - framework.exception + api.exception Indices and tables diff --git a/dts/api/artifact.py b/dts/api/artifact.py index 24a2b05063..7d04c7ab49 100644 --- a/dts/api/artifact.py +++ b/dts/api/artifact.py @@ -47,7 +47,7 @@ from paramiko import SFTPClient, SFTPFile from typing_extensions import Buffer -from framework.exception import InternalError +from api.exception import InternalError from framework.logger import DTSLogger, get_dts_logger from framework.settings import SETTINGS from framework.testbed_model.node import Node, NodeIdentifier, get_node diff --git a/dts/api/cryptodev/__init__.py b/dts/api/cryptodev/__init__.py index 15cffcb409..335b811620 100644 --- a/dts/api/cryptodev/__init__.py +++ b/dts/api/cryptodev/__init__.py @@ -22,8 +22,8 @@ ThroughputResults, VerifyResults, ) +from api.exception import RemoteCommandExecutionError, SkippedTestException from framework.context import get_ctx -from framework.exception import RemoteCommandExecutionError, SkippedTestException from framework.remote_session.dpdk_shell import compute_eal_params if TYPE_CHECKING: diff --git a/dts/framework/exception.py b/dts/api/exception.py similarity index 100% rename from dts/framework/exception.py rename to dts/api/exception.py diff --git a/dts/api/packet.py b/dts/api/packet.py index 3dda18e781..eaecf205f7 100644 --- a/dts/api/packet.py +++ b/dts/api/packet.py @@ -27,9 +27,9 @@ from scapy.layers.l2 import Ether from scapy.packet import Packet, Padding, raw +from api.exception import InternalError from api.test import fail, log_debug from framework.context import get_ctx -from framework.exception import InternalError from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( PacketFilteringConfig, ) diff --git a/dts/api/test.py b/dts/api/test.py index 7947c407d2..29d6842111 100644 --- a/dts/api/test.py +++ b/dts/api/test.py @@ -11,8 +11,8 @@ from api.artifact import Artifact from api.capabilities import LinkTopology +from api.exception import InternalError, SkippedTestException, TestCaseVerifyError from framework.context import get_ctx -from framework.exception import InternalError, SkippedTestException, TestCaseVerifyError from framework.logger import DTSLogger diff --git a/dts/api/testpmd/__init__.py b/dts/api/testpmd/__init__.py index b41a21300e..fef7430cb8 100644 --- a/dts/api/testpmd/__init__.py +++ b/dts/api/testpmd/__init__.py @@ -32,6 +32,7 @@ from typing_extensions import Unpack from api.capabilities import LinkTopology, NicCapability +from api.exception import InteractiveCommandExecutionError, InternalError from api.testpmd.config import PortTopology, SimpleForwardingModes, TestPmdParams from api.testpmd.types import ( ChecksumOffloadOptions, @@ -55,7 +56,6 @@ VLANOffloadFlag, ) from framework.context import get_ctx -from framework.exception import InteractiveCommandExecutionError, InternalError from framework.params.types import TestPmdParamsDict from framework.remote_session.dpdk_shell import DPDKShell from framework.remote_session.interactive_shell import only_active diff --git a/dts/framework/config/__init__.py b/dts/framework/config/__init__.py index 573f55471a..e24a351ecf 100644 --- a/dts/framework/config/__init__.py +++ b/dts/framework/config/__init__.py @@ -35,7 +35,7 @@ from pydantic import Field, TypeAdapter, ValidationError, model_validator from typing_extensions import Self -from framework.exception import ConfigurationError +from api.exception import ConfigurationError from .common import FrozenModel, ValidationContext from .node import NodeConfiguration diff --git a/dts/framework/config/test_run.py b/dts/framework/config/test_run.py index 81630df77d..9aa0938d4e 100644 --- a/dts/framework/config/test_run.py +++ b/dts/framework/config/test_run.py @@ -27,7 +27,7 @@ ) from typing_extensions import TYPE_CHECKING, Self -from framework.exception import InternalError +from api.exception import InternalError from framework.utils import REGEX_FOR_PORT_LINK, StrEnum from .common import FrozenModel, load_fields_from_settings diff --git a/dts/framework/context.py b/dts/framework/context.py index b1c36f90a6..709b99421e 100644 --- a/dts/framework/context.py +++ b/dts/framework/context.py @@ -8,7 +8,7 @@ from dataclasses import MISSING, dataclass, field, fields from typing import TYPE_CHECKING, Any, Optional, ParamSpec, Union -from framework.exception import InternalError +from api.exception import InternalError from framework.remote_session.shell_pool import ShellPool from framework.settings import SETTINGS from framework.testbed_model.cpu import LogicalCoreCount, LogicalCoreList diff --git a/dts/framework/parser.py b/dts/framework/parser.py index 3075c36857..ebf470ad30 100644 --- a/dts/framework/parser.py +++ b/dts/framework/parser.py @@ -15,7 +15,7 @@ from typing_extensions import Self -from framework.exception import InternalError +from api.exception import InternalError class ParserFn(TypedDict): diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index e43e1f2123..0618855fc5 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -14,6 +14,7 @@ from typing import ClassVar, Final from api.capabilities import LinkTopology +from api.exception import ConfigurationError, RemoteFileNotFoundError from framework.config.test_run import ( DPDKBuildConfiguration, DPDKBuildOptionsConfiguration, @@ -26,7 +27,6 @@ RemoteDPDKTreeLocation, ) from framework.context import get_ctx -from framework.exception import ConfigurationError, RemoteFileNotFoundError from framework.logger import DTSLogger, get_dts_logger from framework.params.eal import EalParams from framework.remote_session.remote_session import CommandResult diff --git a/dts/framework/remote_session/interactive_remote_session.py b/dts/framework/remote_session/interactive_remote_session.py index fc42e862bc..3c1f00aab2 100644 --- a/dts/framework/remote_session/interactive_remote_session.py +++ b/dts/framework/remote_session/interactive_remote_session.py @@ -15,8 +15,8 @@ SSHException, ) +from api.exception import SSHConnectionError from framework.config.node import NodeConfiguration -from framework.exception import SSHConnectionError from framework.logger import DTSLogger diff --git a/dts/framework/remote_session/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index 6bba58a4f6..367a01714d 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -29,12 +29,12 @@ from paramiko import Channel, channel from typing_extensions import Self -from framework.context import get_ctx -from framework.exception import ( +from api.exception import ( InteractiveCommandExecutionError, InteractiveSSHSessionDeadError, InteractiveSSHTimeoutError, ) +from framework.context import get_ctx from framework.logger import DTSLogger, get_dts_logger from framework.params import Params from framework.settings import SETTINGS diff --git a/dts/framework/remote_session/remote_session.py b/dts/framework/remote_session/remote_session.py index fb5f6fedf5..95515c9ee2 100644 --- a/dts/framework/remote_session/remote_session.py +++ b/dts/framework/remote_session/remote_session.py @@ -24,13 +24,13 @@ SSHException, ) -from framework.config.node import NodeConfiguration -from framework.exception import ( +from api.exception import ( RemoteCommandExecutionError, SSHConnectionError, SSHSessionDeadError, SSHTimeoutError, ) +from framework.config.node import NodeConfiguration from framework.logger import DTSLogger from framework.settings import SETTINGS diff --git a/dts/framework/runner.py b/dts/framework/runner.py index fa4f06844e..cb137fbf7b 100644 --- a/dts/framework/runner.py +++ b/dts/framework/runner.py @@ -12,8 +12,8 @@ import sys import textwrap +from api.exception import ConfigurationError from framework.config.common import ValidationContext -from framework.exception import ConfigurationError from framework.test_run import TestRun from framework.testbed_model.node import Node diff --git a/dts/framework/test_result.py b/dts/framework/test_result.py index 21faa55dc1..3cecb928ca 100644 --- a/dts/framework/test_result.py +++ b/dts/framework/test_result.py @@ -35,12 +35,11 @@ ) from typing_extensions import OrderedDict +from api.exception import DTSError, ErrorSeverity, InternalError from framework.remote_session.dpdk import DPDKBuildInfo from framework.settings import SETTINGS from framework.testbed_model.os_session import OSSessionInfo -from .exception import DTSError, ErrorSeverity, InternalError - class Result(IntEnum): """The possible states that a setup, a teardown or a test case may end up in.""" diff --git a/dts/framework/test_run.py b/dts/framework/test_run.py index c20a0fa885..75d82c1104 100644 --- a/dts/framework/test_run.py +++ b/dts/framework/test_run.py @@ -108,9 +108,9 @@ from typing import ClassVar, Protocol, Union from api.capabilities import LinkTopology +from api.exception import InternalError, SkippedTestException, TestCaseVerifyError from framework.config.test_run import TestRunConfiguration from framework.context import Context, init_ctx -from framework.exception import InternalError, SkippedTestException, TestCaseVerifyError from framework.logger import DTSLogger, get_dts_logger from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment from framework.settings import SETTINGS @@ -138,7 +138,7 @@ class TestRun: If an error occurs, the current stage is aborted, the error is recorded, everything in the inner stages is marked as blocked and the run continues in the next iteration of the same stage. The return code is the highest `severity` of all - :class:`~.framework.exception.DTSError`\s. + :class:`~.api.exception.DTSError`\s. Example: An error occurs in a test suite setup. The current test suite is aborted, diff --git a/dts/framework/test_suite.py b/dts/framework/test_suite.py index 69ce26040a..e06fdd28b9 100644 --- a/dts/framework/test_suite.py +++ b/dts/framework/test_suite.py @@ -29,11 +29,11 @@ from scapy.packet import Packet from typing_extensions import Self +from api.exception import ConfigurationError, InternalError from framework.config.common import FrozenModel from framework.testbed_model.capability import TestProtocol from framework.testbed_model.topology import Topology -from .exception import ConfigurationError, InternalError from .logger import DTSLogger, get_dts_logger from .utils import to_pascal_case diff --git a/dts/framework/testbed_model/capability.py b/dts/framework/testbed_model/capability.py index b10799ea4b..00b40a3b1e 100644 --- a/dts/framework/testbed_model/capability.py +++ b/dts/framework/testbed_model/capability.py @@ -64,7 +64,7 @@ def test_scatter_mbuf_2048(self): from typing_extensions import Self from api.capabilities import LinkTopology, NicCapability -from framework.exception import ConfigurationError, InternalError, SkippedTestException +from api.exception import ConfigurationError, InternalError, SkippedTestException from framework.logger import get_dts_logger from framework.testbed_model.node import Node from framework.testbed_model.port import DriverKind diff --git a/dts/framework/testbed_model/linux_session.py b/dts/framework/testbed_model/linux_session.py index c118f803b6..4495ae35cf 100644 --- a/dts/framework/testbed_model/linux_session.py +++ b/dts/framework/testbed_model/linux_session.py @@ -18,7 +18,7 @@ from typing_extensions import NotRequired -from framework.exception import ( +from api.exception import ( ConfigurationError, InternalError, RemoteCommandExecutionError, diff --git a/dts/framework/testbed_model/node.py b/dts/framework/testbed_model/node.py index 67a96ef4e5..4f42bf6aeb 100644 --- a/dts/framework/testbed_model/node.py +++ b/dts/framework/testbed_model/node.py @@ -17,11 +17,11 @@ from pathlib import PurePath from typing import Literal, TypeAlias +from api.exception import ConfigurationError, InternalError from framework.config.node import ( OS, NodeConfiguration, ) -from framework.exception import ConfigurationError, InternalError from framework.logger import DTSLogger, get_dts_logger from .cpu import Architecture, LogicalCore diff --git a/dts/framework/testbed_model/port.py b/dts/framework/testbed_model/port.py index d81bc4cda0..aea3e59c25 100644 --- a/dts/framework/testbed_model/port.py +++ b/dts/framework/testbed_model/port.py @@ -12,8 +12,8 @@ from functools import cached_property from typing import TYPE_CHECKING, Any, Final, Literal, NamedTuple +from api.exception import InternalError from framework.config.node import PortConfig -from framework.exception import InternalError if TYPE_CHECKING: from .node import Node diff --git a/dts/framework/testbed_model/posix_session.py b/dts/framework/testbed_model/posix_session.py index dec952685a..db2c3c0c40 100644 --- a/dts/framework/testbed_model/posix_session.py +++ b/dts/framework/testbed_model/posix_session.py @@ -16,7 +16,7 @@ from collections.abc import Iterable from pathlib import Path, PurePath, PurePosixPath -from framework.exception import DPDKBuildError, RemoteCommandExecutionError +from api.exception import DPDKBuildError, RemoteCommandExecutionError from framework.settings import SETTINGS from framework.utils import ( MesonArgs, diff --git a/dts/framework/testbed_model/topology.py b/dts/framework/testbed_model/topology.py index 1db444fc01..002faf0b7f 100644 --- a/dts/framework/testbed_model/topology.py +++ b/dts/framework/testbed_model/topology.py @@ -18,7 +18,7 @@ from typing_extensions import Self from api.capabilities import LinkTopology -from framework.exception import ConfigurationError, InternalError +from api.exception import ConfigurationError, InternalError from framework.testbed_model.linux_session import LinuxSession from framework.testbed_model.node import Node, NodeIdentifier diff --git a/dts/framework/testbed_model/traffic_generator/__init__.py b/dts/framework/testbed_model/traffic_generator/__init__.py index fca251f534..324b5e88f3 100644 --- a/dts/framework/testbed_model/traffic_generator/__init__.py +++ b/dts/framework/testbed_model/traffic_generator/__init__.py @@ -14,12 +14,12 @@ and a capturing traffic generator is required. """ +from api.exception import ConfigurationError from framework.config.test_run import ( ScapyTrafficGeneratorConfig, TrafficGeneratorConfig, TrexTrafficGeneratorConfig, ) -from framework.exception import ConfigurationError from framework.testbed_model.node import Node from .scapy import ScapyTrafficGenerator diff --git a/dts/framework/testbed_model/traffic_generator/scapy.py b/dts/framework/testbed_model/traffic_generator/scapy.py index 62853a34e4..70856cc1f0 100644 --- a/dts/framework/testbed_model/traffic_generator/scapy.py +++ b/dts/framework/testbed_model/traffic_generator/scapy.py @@ -25,9 +25,9 @@ from scapy.layers.l2 import Ether from scapy.packet import Packet +from api.exception import InteractiveSSHSessionDeadError, InternalError from framework.config.node import OS from framework.config.test_run import ScapyTrafficGeneratorConfig -from framework.exception import InteractiveSSHSessionDeadError, InternalError from framework.remote_session.python_shell import PythonShell from framework.testbed_model.node import Node from framework.testbed_model.port import Port diff --git a/dts/framework/testbed_model/traffic_generator/trex.py b/dts/framework/testbed_model/traffic_generator/trex.py index d53791b0a6..2c3beebc59 100644 --- a/dts/framework/testbed_model/traffic_generator/trex.py +++ b/dts/framework/testbed_model/traffic_generator/trex.py @@ -11,9 +11,9 @@ from scapy.packet import Packet +from api.exception import SSHTimeoutError from framework.config.node import OS, NodeConfiguration from framework.config.test_run import TrexTrafficGeneratorConfig -from framework.exception import SSHTimeoutError from framework.parser import TextParser from framework.remote_session.blocking_app import BlockingApp from framework.remote_session.python_shell import PythonShell diff --git a/dts/framework/utils.py b/dts/framework/utils.py index 5753c1b7fe..235f4bf426 100644 --- a/dts/framework/utils.py +++ b/dts/framework/utils.py @@ -26,7 +26,7 @@ from scapy.layers.inet import IP, TCP, UDP, Ether from scapy.packet import Packet -from .exception import InternalError +from api.exception import InternalError REGEX_FOR_PCI_ADDRESS: str = r"[0-9a-fA-F]{4}:[0-9a-fA-F]{2}:[0-9a-fA-F]{2}.[0-9]{1}" _REGEX_FOR_COLON_OR_HYPHEN_SEP_MAC: str = r"(?:[\da-fA-F]{2}[:-]){5}[\da-fA-F]{2}" diff --git a/dts/tests/TestSuite_cryptodev_throughput.py b/dts/tests/TestSuite_cryptodev_throughput.py index 2fc0d8779a..53682f35fa 100644 --- a/dts/tests/TestSuite_cryptodev_throughput.py +++ b/dts/tests/TestSuite_cryptodev_throughput.py @@ -29,9 +29,8 @@ from api.cryptodev.types import ( CryptodevResults, ) -from api.test import verify +from api.test import skip, verify from framework.context import get_ctx -from framework.exception import SkippedTestException from framework.test_suite import BaseConfig, TestSuite, crypto_test from framework.testbed_model.virtual_device import VirtualDevice @@ -153,12 +152,9 @@ def aes_cbc(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aes_cbc" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -183,12 +179,9 @@ def aes_cbc_sha1(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aes_cbc_sha1" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -218,12 +211,9 @@ def aes_cbc_sha2(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aes_cbc_sha2" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -252,12 +242,9 @@ def aes_cbc_sha2_digest_16(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aes_cbc_sha2_digest_16" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -286,12 +273,9 @@ def aead_aes_gcm(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aead_aes_gcm" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -318,12 +302,9 @@ def aes_docsisbpi(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aes_docsisbpi" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -348,12 +329,9 @@ def sha1_hmac(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "sha1_hmac" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -379,12 +357,9 @@ def snow3g_uea2_snow3g_uia2(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "snow3g_uea2_snow3g_uia2" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -414,12 +389,9 @@ def zuc_eea3_zuc_eia3(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "zuc_eea3_zuc_eia3" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -449,12 +421,9 @@ def kasumi_f8_kasumi_f9(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "kasumi_f8_kasumi_f9" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -486,12 +455,9 @@ def aesni_mb_vdev(self) -> None: * Create a cryptodev instance with crypto_aesni_mb and supplied buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aesni_mb_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, vdevs=[VirtualDevice("crypto_aesni_mb0")], @@ -523,12 +489,9 @@ def aesni_gcm_vdev(self): * Create a cryptodev instance with crypto_aesni_gcm and supplied buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aesni_gcm_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, vdevs=[VirtualDevice("crypto_aesni_gcm0")], @@ -556,12 +519,9 @@ def kasumi_vdev(self) -> None: * Create a cryptodev instance with crypto_kasumi and supplied buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "kasumi_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( vdevs=[VirtualDevice("crypto_kasumi0")], ptest=TestType.throughput, @@ -592,12 +552,9 @@ def snow3g_vdev(self) -> None: * Create a cryptodev instance with crypto_snow3g and supplied buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "snow3g_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, vdevs=[VirtualDevice("crypto_snow3g0")], @@ -629,12 +586,9 @@ def zuc_vdev(self) -> None: * Create a cryptodev instance with crypto_zuc and supplied buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "zuc_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, vdevs=[VirtualDevice("crypto_zuc0")], @@ -666,12 +620,9 @@ def open_ssl_vdev(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "open_ssl_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, vdevs=[VirtualDevice("crypto_openssl0")], diff --git a/dts/tests/TestSuite_dynamic_queue_conf.py b/dts/tests/TestSuite_dynamic_queue_conf.py index 5ac85bee7d..b62efa2b42 100644 --- a/dts/tests/TestSuite_dynamic_queue_conf.py +++ b/dts/tests/TestSuite_dynamic_queue_conf.py @@ -35,11 +35,11 @@ NicCapability, requires_nic_capability, ) +from api.exception import InteractiveCommandExecutionError from api.packet import send_packets from api.test import fail, verify from api.testpmd import TestPmd from api.testpmd.config import PortTopology, SimpleForwardingModes -from framework.exception import InteractiveCommandExecutionError from framework.test_suite import TestSuite, func_test diff --git a/dts/tests/TestSuite_flow_offload.py b/dts/tests/TestSuite_flow_offload.py index be11d09875..5902406a8e 100644 --- a/dts/tests/TestSuite_flow_offload.py +++ b/dts/tests/TestSuite_flow_offload.py @@ -21,15 +21,15 @@ from scapy.packet import Packet, Raw from api.capabilities import NicCapability, requires_nic_capability -from api.packet import send_packet_and_capture -from api.test import fail, log, verify -from api.testpmd import TestPmd -from api.testpmd.types import FlowRule -from framework.exception import ( +from api.exception import ( InteractiveCommandExecutionError, SkippedTestException, TestCaseVerifyError, ) +from api.packet import send_packet_and_capture +from api.test import fail, log, verify +from api.testpmd import TestPmd +from api.testpmd.types import FlowRule from framework.test_suite import TestSuite, func_test diff --git a/dts/tests/TestSuite_mac_filter.py b/dts/tests/TestSuite_mac_filter.py index a7e24b37d5..b44822d31c 100644 --- a/dts/tests/TestSuite_mac_filter.py +++ b/dts/tests/TestSuite_mac_filter.py @@ -23,10 +23,10 @@ NicCapability, requires_nic_capability, ) +from api.exception import InteractiveCommandExecutionError from api.packet import send_packet_and_capture from api.test import fail, verify from api.testpmd import TestPmd -from framework.exception import InteractiveCommandExecutionError from framework.test_suite import TestSuite, func_test diff --git a/dts/tests/TestSuite_rss.py b/dts/tests/TestSuite_rss.py index 2747c8a36c..1af0782ffc 100644 --- a/dts/tests/TestSuite_rss.py +++ b/dts/tests/TestSuite_rss.py @@ -20,6 +20,7 @@ requires_link_topology, requires_nic_capability, ) +from api.exception import InteractiveCommandExecutionError from api.packet import send_packets_and_capture from api.test import verify from api.testpmd import TestPmd @@ -29,7 +30,6 @@ RSSOffloadTypesFlag, TestPmdVerbosePacket, ) -from framework.exception import InteractiveCommandExecutionError from framework.test_suite import BaseConfig, TestSuite, func_test from framework.utils import StrEnum diff --git a/dts/tests/TestSuite_rx_split.py b/dts/tests/TestSuite_rx_split.py index 5117a569e2..470e48d0d3 100644 --- a/dts/tests/TestSuite_rx_split.py +++ b/dts/tests/TestSuite_rx_split.py @@ -18,12 +18,12 @@ NicCapability, requires_nic_capability, ) +from api.exception import InteractiveCommandExecutionError from api.packet import adjust_addresses, send_packet_and_capture from api.test import fail, verify from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import RxOffloadCapability, TxOffloadCapability -from framework.exception import InteractiveCommandExecutionError from framework.test_suite import TestSuite, func_test PAYLOAD = bytes(range(256)) -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* [PATCH v5 2/7] dts: move utils from framework to API 2026-08-06 13:53 [PATCH v5 0/7] dts: remove imports from framework in test suites Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 1/7] dts: move exception module from framework to API Andrew Bailey @ 2026-08-06 13:53 ` Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 3/7] dts: move context " Andrew Bailey ` (7 subsequent siblings) 9 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 13:53 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx The utils module is used to generate a set of random packets in certain test suites. Move this to the API. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- doc/api/dts/{framework.utils.rst => api.utils.rst} | 2 +- doc/api/dts/index.rst | 2 +- dts/api/cryptodev/config.py | 2 +- dts/api/packet.py | 2 +- dts/api/testpmd/config.py | 2 +- dts/api/testpmd/types.py | 2 +- dts/{framework => api}/utils.py | 0 dts/framework/config/node.py | 2 +- dts/framework/config/test_run.py | 2 +- dts/framework/remote_session/dpdk.py | 2 +- dts/framework/test_suite.py | 2 +- dts/framework/testbed_model/cpu.py | 2 +- dts/framework/testbed_model/linux_session.py | 2 +- dts/framework/testbed_model/os_session.py | 2 +- dts/framework/testbed_model/posix_session.py | 4 ++-- .../traffic_generator/capturing_traffic_generator.py | 2 +- .../testbed_model/traffic_generator/traffic_generator.py | 2 +- dts/framework/testbed_model/traffic_generator/trex.py | 2 +- dts/tests/TestSuite_l2fwd.py | 2 +- dts/tests/TestSuite_rss.py | 2 +- dts/tests/TestSuite_smoke_tests.py | 2 +- dts/tests/TestSuite_softnic.py | 2 +- 22 files changed, 22 insertions(+), 22 deletions(-) rename doc/api/dts/{framework.utils.rst => api.utils.rst} (80%) rename dts/{framework => api}/utils.py (100%) diff --git a/doc/api/dts/framework.utils.rst b/doc/api/dts/api.utils.rst similarity index 80% rename from doc/api/dts/framework.utils.rst rename to doc/api/dts/api.utils.rst index cc06d4c3c3..0b4baff1b5 100644 --- a/doc/api/dts/framework.utils.rst +++ b/doc/api/dts/api.utils.rst @@ -3,6 +3,6 @@ utils - Various Utilities ========================= -.. automodule:: framework.utils +.. automodule:: api.utils :members: :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index 01f630e7cd..783270f6e9 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -35,7 +35,7 @@ Modules framework.context framework.logger framework.parser - framework.utils + api.utils api.exception diff --git a/dts/api/cryptodev/config.py b/dts/api/cryptodev/config.py index 69ff7aa59a..a88e70d45c 100644 --- a/dts/api/cryptodev/config.py +++ b/dts/api/cryptodev/config.py @@ -6,9 +6,9 @@ from enum import auto from typing import Literal +from api.utils import StrEnum from framework.params import Params, Switch from framework.params.eal import EalParams -from framework.utils import StrEnum Silent = Literal[""] diff --git a/dts/api/packet.py b/dts/api/packet.py index eaecf205f7..98f995deb5 100644 --- a/dts/api/packet.py +++ b/dts/api/packet.py @@ -29,6 +29,7 @@ from api.exception import InternalError from api.test import fail, log_debug +from api.utils import get_packet_summaries from framework.context import get_ctx from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( PacketFilteringConfig, @@ -36,7 +37,6 @@ from framework.testbed_model.traffic_generator.performance_traffic_generator import ( PerformanceTrafficStats, ) -from framework.utils import get_packet_summaries def send_packet_and_capture( diff --git a/dts/api/testpmd/config.py b/dts/api/testpmd/config.py index f0581843ca..3850a4eb8a 100644 --- a/dts/api/testpmd/config.py +++ b/dts/api/testpmd/config.py @@ -13,6 +13,7 @@ from pathlib import PurePath from typing import Literal, NamedTuple +from api.utils import StrEnum from framework.params import ( Params, Switch, @@ -25,7 +26,6 @@ str_from_flag_value, ) from framework.params.eal import EalParams -from framework.utils import StrEnum from .types import RxOffloadCapability, TxOffloadCapability diff --git a/dts/api/testpmd/types.py b/dts/api/testpmd/types.py index bca40d6f34..7f8f449941 100644 --- a/dts/api/testpmd/types.py +++ b/dts/api/testpmd/types.py @@ -15,8 +15,8 @@ from typing_extensions import Self +from api.utils import REGEX_FOR_MAC_ADDRESS, StrEnum from framework.parser import ParserFn, TextParser -from framework.utils import REGEX_FOR_MAC_ADDRESS, StrEnum RxTxLiteralSwitch = Literal["rx", "tx"] diff --git a/dts/framework/utils.py b/dts/api/utils.py similarity index 100% rename from dts/framework/utils.py rename to dts/api/utils.py diff --git a/dts/framework/config/node.py b/dts/framework/config/node.py index 792290f11f..28f23389a7 100644 --- a/dts/framework/config/node.py +++ b/dts/framework/config/node.py @@ -14,7 +14,7 @@ from pydantic import Field, model_validator from typing_extensions import Self -from framework.utils import REGEX_FOR_IDENTIFIER, REGEX_FOR_PCI_ADDRESS, StrEnum +from api.utils import REGEX_FOR_IDENTIFIER, REGEX_FOR_PCI_ADDRESS, StrEnum from .common import FrozenModel diff --git a/dts/framework/config/test_run.py b/dts/framework/config/test_run.py index 9aa0938d4e..b87c7b2d19 100644 --- a/dts/framework/config/test_run.py +++ b/dts/framework/config/test_run.py @@ -28,7 +28,7 @@ from typing_extensions import TYPE_CHECKING, Self from api.exception import InternalError -from framework.utils import REGEX_FOR_PORT_LINK, StrEnum +from api.utils import REGEX_FOR_PORT_LINK, StrEnum from .common import FrozenModel, load_fields_from_settings diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index 0618855fc5..ba91c88d11 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -15,6 +15,7 @@ from api.capabilities import LinkTopology from api.exception import ConfigurationError, RemoteFileNotFoundError +from api.utils import MesonArgs, TarCompressionFormat from framework.config.test_run import ( DPDKBuildConfiguration, DPDKBuildOptionsConfiguration, @@ -34,7 +35,6 @@ from framework.testbed_model.node import Node from framework.testbed_model.os_session import OSSession from framework.testbed_model.virtual_device import VirtualDevice -from framework.utils import MesonArgs, TarCompressionFormat @dataclass(slots=True, frozen=True) diff --git a/dts/framework/test_suite.py b/dts/framework/test_suite.py index e06fdd28b9..426c98fdf6 100644 --- a/dts/framework/test_suite.py +++ b/dts/framework/test_suite.py @@ -30,12 +30,12 @@ from typing_extensions import Self from api.exception import ConfigurationError, InternalError +from api.utils import to_pascal_case from framework.config.common import FrozenModel from framework.testbed_model.capability import TestProtocol from framework.testbed_model.topology import Topology from .logger import DTSLogger, get_dts_logger -from .utils import to_pascal_case if TYPE_CHECKING: from framework.context import Context diff --git a/dts/framework/testbed_model/cpu.py b/dts/framework/testbed_model/cpu.py index a9471709dd..68e9c7dffb 100644 --- a/dts/framework/testbed_model/cpu.py +++ b/dts/framework/testbed_model/cpu.py @@ -24,7 +24,7 @@ from dataclasses import dataclass from enum import auto, unique -from framework.utils import StrEnum, expand_range +from api.utils import StrEnum, expand_range @unique diff --git a/dts/framework/testbed_model/linux_session.py b/dts/framework/testbed_model/linux_session.py index 4495ae35cf..26c53f069c 100644 --- a/dts/framework/testbed_model/linux_session.py +++ b/dts/framework/testbed_model/linux_session.py @@ -23,8 +23,8 @@ InternalError, RemoteCommandExecutionError, ) +from api.utils import expand_range from framework.testbed_model.port import PortInfo -from framework.utils import expand_range from .cpu import LogicalCore from .port import Port diff --git a/dts/framework/testbed_model/os_session.py b/dts/framework/testbed_model/os_session.py index f88427a53d..08122874e6 100644 --- a/dts/framework/testbed_model/os_session.py +++ b/dts/framework/testbed_model/os_session.py @@ -29,12 +29,12 @@ from enum import Flag, auto from pathlib import Path, PurePath, PurePosixPath +from api.utils import MesonArgs, TarCompressionFormat from framework.config.node import NodeConfiguration from framework.logger import DTSLogger from framework.remote_session.interactive_remote_session import InteractiveRemoteSession from framework.remote_session.remote_session import CommandResult, RemoteSession from framework.settings import SETTINGS -from framework.utils import MesonArgs, TarCompressionFormat from .cpu import Architecture, LogicalCore from .port import Port, PortInfo diff --git a/dts/framework/testbed_model/posix_session.py b/dts/framework/testbed_model/posix_session.py index db2c3c0c40..61c634dad1 100644 --- a/dts/framework/testbed_model/posix_session.py +++ b/dts/framework/testbed_model/posix_session.py @@ -17,14 +17,14 @@ from pathlib import Path, PurePath, PurePosixPath from api.exception import DPDKBuildError, RemoteCommandExecutionError -from framework.settings import SETTINGS -from framework.utils import ( +from api.utils import ( MesonArgs, TarCompressionFormat, convert_to_list_of_string, create_tarball, extract_tarball, ) +from framework.settings import SETTINGS from .cpu import Architecture from .os_session import FilePermissions, OSSession, OSSessionInfo diff --git a/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py b/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py index 7655751d7e..2804d64990 100644 --- a/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py +++ b/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py @@ -17,8 +17,8 @@ from scapy.packet import Packet from api.artifact import Artifact +from api.utils import get_packet_summaries from framework.testbed_model.port import Port -from framework.utils import get_packet_summaries from .traffic_generator import TrafficGenerator diff --git a/dts/framework/testbed_model/traffic_generator/traffic_generator.py b/dts/framework/testbed_model/traffic_generator/traffic_generator.py index cdda5a7c08..fedce77fdf 100644 --- a/dts/framework/testbed_model/traffic_generator/traffic_generator.py +++ b/dts/framework/testbed_model/traffic_generator/traffic_generator.py @@ -25,7 +25,7 @@ class TrafficGenerator(ABC): Exposes the common public methods of all traffic generators and defines private methods that must implement the traffic generation logic in subclasses. This class also extends from - :class:`framework.utils.MultiInheritanceBaseClass` to allow subclasses the ability to inherit + :class:`api.utils.MultiInheritanceBaseClass` to allow subclasses the ability to inherit from multiple classes to fulfil the traffic generating functionality without breaking single inheritance. """ diff --git a/dts/framework/testbed_model/traffic_generator/trex.py b/dts/framework/testbed_model/traffic_generator/trex.py index 2c3beebc59..7fd6234d27 100644 --- a/dts/framework/testbed_model/traffic_generator/trex.py +++ b/dts/framework/testbed_model/traffic_generator/trex.py @@ -12,6 +12,7 @@ from scapy.packet import Packet from api.exception import SSHTimeoutError +from api.utils import StrEnum from framework.config.node import OS, NodeConfiguration from framework.config.test_run import TrexTrafficGeneratorConfig from framework.parser import TextParser @@ -24,7 +25,6 @@ PerformanceTrafficGenerator, PerformanceTrafficStats, ) -from framework.utils import StrEnum @dataclass(slots=True) diff --git a/dts/tests/TestSuite_l2fwd.py b/dts/tests/TestSuite_l2fwd.py index 596b892730..1e99b82b8c 100644 --- a/dts/tests/TestSuite_l2fwd.py +++ b/dts/tests/TestSuite_l2fwd.py @@ -20,10 +20,10 @@ ) from api.testpmd import TestPmd from api.testpmd.config import EthPeer, SimpleForwardingModes +from api.utils import generate_random_packets from framework.context import filter_cores from framework.test_suite import TestSuite, func_test from framework.testbed_model.cpu import LogicalCoreCount -from framework.utils import generate_random_packets @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_rss.py b/dts/tests/TestSuite_rss.py index 1af0782ffc..1e60bdba07 100644 --- a/dts/tests/TestSuite_rss.py +++ b/dts/tests/TestSuite_rss.py @@ -30,8 +30,8 @@ RSSOffloadTypesFlag, TestPmdVerbosePacket, ) +from api.utils import StrEnum from framework.test_suite import BaseConfig, TestSuite, func_test -from framework.utils import StrEnum class Config(BaseConfig): diff --git a/dts/tests/TestSuite_smoke_tests.py b/dts/tests/TestSuite_smoke_tests.py index 271ad4301c..fce83604a6 100644 --- a/dts/tests/TestSuite_smoke_tests.py +++ b/dts/tests/TestSuite_smoke_tests.py @@ -20,11 +20,11 @@ ) from api.test import verify from api.testpmd import TestPmd +from api.utils import REGEX_FOR_PCI_ADDRESS from framework.config.node import PortConfig from framework.settings import SETTINGS from framework.test_suite import TestSuite, func_test from framework.testbed_model.linux_session import LinuxSession -from framework.utils import REGEX_FOR_PCI_ADDRESS @requires_link_topology(LinkTopology.NO_LINK) diff --git a/dts/tests/TestSuite_softnic.py b/dts/tests/TestSuite_softnic.py index fa91f7ee2f..c57a12c932 100644 --- a/dts/tests/TestSuite_softnic.py +++ b/dts/tests/TestSuite_softnic.py @@ -20,9 +20,9 @@ ) from api.testpmd import TestPmd from api.testpmd.config import EthPeer +from api.utils import generate_random_packets from framework.test_suite import TestSuite, func_test from framework.testbed_model.virtual_device import VirtualDevice -from framework.utils import generate_random_packets @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* [PATCH v5 3/7] dts: move context from framework to API 2026-08-06 13:53 [PATCH v5 0/7] dts: remove imports from framework in test suites Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 1/7] dts: move exception module from framework to API Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 2/7] dts: move utils " Andrew Bailey @ 2026-08-06 13:53 ` Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 4/7] dts: move testbed model " Andrew Bailey ` (6 subsequent siblings) 9 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 13:53 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx A couple test suites import and get the run context during execution. Move this to the API. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- .../dts/{framework.context.rst => api.context.rst} | 2 +- doc/api/dts/index.rst | 2 +- dts/api/artifact.py | 2 +- dts/{framework => api}/context.py | 0 dts/api/cryptodev/__init__.py | 2 +- dts/api/packet.py | 4 ++-- dts/api/test.py | 2 +- dts/api/testpmd/__init__.py | 2 +- dts/framework/remote_session/blocking_app.py | 2 +- dts/framework/remote_session/dpdk.py | 2 +- dts/framework/remote_session/dpdk_shell.py | 2 +- dts/framework/remote_session/interactive_shell.py | 2 +- dts/framework/test_run.py | 2 +- dts/framework/test_suite.py | 4 ++-- dts/framework/testbed_model/node.py | 2 +- dts/framework/testbed_model/topology.py | 14 +++++++------- dts/tests/TestSuite_cryptodev_latency.py | 2 +- dts/tests/TestSuite_cryptodev_throughput.py | 2 +- dts/tests/TestSuite_l2fwd.py | 2 +- 19 files changed, 26 insertions(+), 26 deletions(-) rename doc/api/dts/{framework.context.rst => api.context.rst} (80%) rename dts/{framework => api}/context.py (100%) diff --git a/doc/api/dts/framework.context.rst b/doc/api/dts/api.context.rst similarity index 80% rename from doc/api/dts/framework.context.rst rename to doc/api/dts/api.context.rst index 925c160360..65b4ab9a47 100644 --- a/doc/api/dts/framework.context.rst +++ b/doc/api/dts/api.context.rst @@ -3,6 +3,6 @@ context - DTS execution context =============================== -.. automodule:: framework.context +.. automodule:: api.context :members: :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index 783270f6e9..98269d6e80 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -32,7 +32,7 @@ Modules framework.test_suite framework.test_result framework.settings - framework.context + api.context framework.logger framework.parser api.utils diff --git a/dts/api/artifact.py b/dts/api/artifact.py index 7d04c7ab49..f3dd07de56 100644 --- a/dts/api/artifact.py +++ b/dts/api/artifact.py @@ -86,7 +86,7 @@ def make_file_path( path /= custom_path else: - from framework.context import get_ctx + from api.context import get_ctx try: ctx = get_ctx() diff --git a/dts/framework/context.py b/dts/api/context.py similarity index 100% rename from dts/framework/context.py rename to dts/api/context.py diff --git a/dts/api/cryptodev/__init__.py b/dts/api/cryptodev/__init__.py index 335b811620..198607696f 100644 --- a/dts/api/cryptodev/__init__.py +++ b/dts/api/cryptodev/__init__.py @@ -14,6 +14,7 @@ from typing_extensions import Unpack +from api.context import get_ctx from api.cryptodev.config import CryptoPmdParams, TestType from api.cryptodev.types import ( CryptodevResults, @@ -23,7 +24,6 @@ VerifyResults, ) from api.exception import RemoteCommandExecutionError, SkippedTestException -from framework.context import get_ctx from framework.remote_session.dpdk_shell import compute_eal_params if TYPE_CHECKING: diff --git a/dts/api/packet.py b/dts/api/packet.py index 98f995deb5..dda3087df4 100644 --- a/dts/api/packet.py +++ b/dts/api/packet.py @@ -27,10 +27,10 @@ from scapy.layers.l2 import Ether from scapy.packet import Packet, Padding, raw +from api.context import get_ctx from api.exception import InternalError from api.test import fail, log_debug from api.utils import get_packet_summaries -from framework.context import get_ctx from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( PacketFilteringConfig, ) @@ -82,7 +82,7 @@ def send_packets_and_capture( Returns: A list of received packets. """ - from framework.context import get_ctx + from api.context import get_ctx from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( CapturingTrafficGenerator, ) diff --git a/dts/api/test.py b/dts/api/test.py index 29d6842111..b6caf5c1ae 100644 --- a/dts/api/test.py +++ b/dts/api/test.py @@ -11,8 +11,8 @@ from api.artifact import Artifact from api.capabilities import LinkTopology +from api.context import get_ctx from api.exception import InternalError, SkippedTestException, TestCaseVerifyError -from framework.context import get_ctx from framework.logger import DTSLogger diff --git a/dts/api/testpmd/__init__.py b/dts/api/testpmd/__init__.py index fef7430cb8..ce41408eb6 100644 --- a/dts/api/testpmd/__init__.py +++ b/dts/api/testpmd/__init__.py @@ -32,6 +32,7 @@ from typing_extensions import Unpack from api.capabilities import LinkTopology, NicCapability +from api.context import get_ctx from api.exception import InteractiveCommandExecutionError, InternalError from api.testpmd.config import PortTopology, SimpleForwardingModes, TestPmdParams from api.testpmd.types import ( @@ -55,7 +56,6 @@ TxOffloadConfiguration, VLANOffloadFlag, ) -from framework.context import get_ctx from framework.params.types import TestPmdParamsDict from framework.remote_session.dpdk_shell import DPDKShell from framework.remote_session.interactive_shell import only_active diff --git a/dts/framework/remote_session/blocking_app.py b/dts/framework/remote_session/blocking_app.py index c3b02dcc62..07db6dfeb0 100644 --- a/dts/framework/remote_session/blocking_app.py +++ b/dts/framework/remote_session/blocking_app.py @@ -30,7 +30,7 @@ from typing_extensions import Self -from framework.context import get_ctx +from api.context import get_ctx from framework.params import Params from framework.params.eal import EalParams from framework.remote_session.dpdk_shell import compute_eal_params diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index ba91c88d11..ee34eb567d 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -14,6 +14,7 @@ from typing import ClassVar, Final from api.capabilities import LinkTopology +from api.context import get_ctx from api.exception import ConfigurationError, RemoteFileNotFoundError from api.utils import MesonArgs, TarCompressionFormat from framework.config.test_run import ( @@ -27,7 +28,6 @@ RemoteDPDKTarballLocation, RemoteDPDKTreeLocation, ) -from framework.context import get_ctx from framework.logger import DTSLogger, get_dts_logger from framework.params.eal import EalParams from framework.remote_session.remote_session import CommandResult diff --git a/dts/framework/remote_session/dpdk_shell.py b/dts/framework/remote_session/dpdk_shell.py index 269c2cada4..a8f169787c 100644 --- a/dts/framework/remote_session/dpdk_shell.py +++ b/dts/framework/remote_session/dpdk_shell.py @@ -10,7 +10,7 @@ from abc import ABC, abstractmethod from pathlib import PurePath -from framework.context import get_ctx +from api.context import get_ctx from framework.params.eal import EalParams from framework.remote_session.interactive_shell import ( InteractiveShell, diff --git a/dts/framework/remote_session/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index 367a01714d..362bc2a352 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -29,12 +29,12 @@ from paramiko import Channel, channel from typing_extensions import Self +from api.context import get_ctx from api.exception import ( InteractiveCommandExecutionError, InteractiveSSHSessionDeadError, InteractiveSSHTimeoutError, ) -from framework.context import get_ctx from framework.logger import DTSLogger, get_dts_logger from framework.params import Params from framework.settings import SETTINGS diff --git a/dts/framework/test_run.py b/dts/framework/test_run.py index 75d82c1104..8b9ae4a49a 100644 --- a/dts/framework/test_run.py +++ b/dts/framework/test_run.py @@ -108,9 +108,9 @@ from typing import ClassVar, Protocol, Union from api.capabilities import LinkTopology +from api.context import Context, init_ctx from api.exception import InternalError, SkippedTestException, TestCaseVerifyError from framework.config.test_run import TestRunConfiguration -from framework.context import Context, init_ctx from framework.logger import DTSLogger, get_dts_logger from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment from framework.settings import SETTINGS diff --git a/dts/framework/test_suite.py b/dts/framework/test_suite.py index 426c98fdf6..6066f7a77a 100644 --- a/dts/framework/test_suite.py +++ b/dts/framework/test_suite.py @@ -38,7 +38,7 @@ from .logger import DTSLogger, get_dts_logger if TYPE_CHECKING: - from framework.context import Context + from api.context import Context class BaseConfig(FrozenModel): @@ -92,7 +92,7 @@ def __init__(self, config: BaseConfig) -> None: Args: config: The test suite configuration. """ - from framework.context import get_ctx + from api.context import get_ctx self.config = config self._ctx = get_ctx() diff --git a/dts/framework/testbed_model/node.py b/dts/framework/testbed_model/node.py index 4f42bf6aeb..40dd7f0666 100644 --- a/dts/framework/testbed_model/node.py +++ b/dts/framework/testbed_model/node.py @@ -242,7 +242,7 @@ def get_node(node_identifier: NodeIdentifier) -> Node | None: if node_identifier == "local": return None - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() if node_identifier == "sut": diff --git a/dts/framework/testbed_model/topology.py b/dts/framework/testbed_model/topology.py index 002faf0b7f..6b8c5edee5 100644 --- a/dts/framework/testbed_model/topology.py +++ b/dts/framework/testbed_model/topology.py @@ -98,7 +98,7 @@ def node_and_ports_from_id(self, node_identifier: NodeIdentifier) -> tuple[Node, Raises: InternalError: If the given `node_identifier` is invalid. """ - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() match node_identifier: @@ -188,7 +188,7 @@ def instantiate_crypto_ports(self) -> None: Raises: InternalError: If crypto virtual functions could not be created on a port. """ - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() for port in ctx.sut_node.cryptodevs: @@ -214,7 +214,7 @@ def instantiate_vf_ports(self) -> None: Raises: InternalError: If virtual function creation fails. """ - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() @@ -243,7 +243,7 @@ def instantiate_vf_ports(self) -> None: def delete_vf_ports(self) -> None: """Delete virtual functions from the SUT node during test run teardown.""" - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() @@ -254,7 +254,7 @@ def delete_vf_ports(self) -> None: def delete_crypto_vf_ports(self) -> None: """Delete crypto virtual functions from the SUT node during test run teardown.""" - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() @@ -267,7 +267,7 @@ def bind_cryptodevs(self, driver: DriverKind): Args: driver: The driver to bind the crypto functions """ - from framework.context import get_ctx + from api.context import get_ctx self._bind_ports_to_drivers(get_ctx().sut_node, self.crypto_vf_ports, driver) @@ -326,7 +326,7 @@ def _prepare_devbind_script(self) -> None: Raises: InternalError: If dpdk-devbind.py could not be found. """ - from framework.context import get_ctx + from api.context import get_ctx local_script_path = Path("..", "usertools", "dpdk-devbind.py").resolve() valid_script_path = local_script_path.exists() diff --git a/dts/tests/TestSuite_cryptodev_latency.py b/dts/tests/TestSuite_cryptodev_latency.py index 4e7d814faa..ed6423eb26 100644 --- a/dts/tests/TestSuite_cryptodev_latency.py +++ b/dts/tests/TestSuite_cryptodev_latency.py @@ -13,6 +13,7 @@ LinkTopology, requires_link_topology, ) +from api.context import get_ctx from api.cryptodev import Cryptodev from api.cryptodev.config import ( AeadAlgName, @@ -30,7 +31,6 @@ CryptodevResults, ) from api.test import skip, verify -from framework.context import get_ctx from framework.test_suite import BaseConfig, TestSuite, crypto_test from framework.testbed_model.virtual_device import VirtualDevice diff --git a/dts/tests/TestSuite_cryptodev_throughput.py b/dts/tests/TestSuite_cryptodev_throughput.py index 53682f35fa..d69714e1fa 100644 --- a/dts/tests/TestSuite_cryptodev_throughput.py +++ b/dts/tests/TestSuite_cryptodev_throughput.py @@ -13,6 +13,7 @@ LinkTopology, requires_link_topology, ) +from api.context import get_ctx from api.cryptodev import Cryptodev from api.cryptodev.config import ( AeadAlgName, @@ -30,7 +31,6 @@ CryptodevResults, ) from api.test import skip, verify -from framework.context import get_ctx from framework.test_suite import BaseConfig, TestSuite, crypto_test from framework.testbed_model.virtual_device import VirtualDevice diff --git a/dts/tests/TestSuite_l2fwd.py b/dts/tests/TestSuite_l2fwd.py index 1e99b82b8c..574842e2e4 100644 --- a/dts/tests/TestSuite_l2fwd.py +++ b/dts/tests/TestSuite_l2fwd.py @@ -13,6 +13,7 @@ requires_link_topology, requires_nic_capability, ) +from api.context import filter_cores from api.packet import ( get_expected_packets, match_all_packets, @@ -21,7 +22,6 @@ from api.testpmd import TestPmd from api.testpmd.config import EthPeer, SimpleForwardingModes from api.utils import generate_random_packets -from framework.context import filter_cores from framework.test_suite import TestSuite, func_test from framework.testbed_model.cpu import LogicalCoreCount -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* [PATCH v5 4/7] dts: move testbed model from framework to API 2026-08-06 13:53 [PATCH v5 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (2 preceding siblings ...) 2026-08-06 13:53 ` [PATCH v5 3/7] dts: move context " Andrew Bailey @ 2026-08-06 13:53 ` Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 5/7] dts: move test suite module " Andrew Bailey ` (5 subsequent siblings) 9 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 13:53 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx Multiple test suites import modules from testbed model in the framework. Move this directory to the API. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- ...y.rst => api.testbed_model.capability.rst} | 2 +- ...odel.cpu.rst => api.testbed_model.cpu.rst} | 2 +- ...st => api.testbed_model.linux_session.rst} | 2 +- ...el.node.rst => api.testbed_model.node.rst} | 2 +- ...n.rst => api.testbed_model.os_session.rst} | 2 +- ...el.port.rst => api.testbed_model.port.rst} | 2 +- ...st => api.testbed_model.posix_session.rst} | 2 +- doc/api/dts/api.testbed_model.rst | 28 +++++++++++++++++++ ...ogy.rst => api.testbed_model.topology.rst} | 2 +- ...generator.capturing_traffic_generator.rst} | 2 +- .../api.testbed_model.traffic_generator.rst | 16 +++++++++++ ...testbed_model.traffic_generator.scapy.rst} | 2 +- ...l.traffic_generator.traffic_generator.rst} | 2 +- ...t => api.testbed_model.virtual_device.rst} | 2 +- doc/api/dts/framework.testbed_model.rst | 28 ------------------- ...mework.testbed_model.traffic_generator.rst | 16 ----------- doc/api/dts/index.rst | 2 +- dts/api/artifact.py | 2 +- dts/api/capabilities.py | 8 +++--- dts/api/context.py | 10 +++---- dts/api/packet.py | 10 +++---- .../testbed_model/__init__.py | 0 .../testbed_model/capability.py | 10 +++---- dts/{framework => api}/testbed_model/cpu.py | 2 +- .../testbed_model/linux_session.py | 2 +- dts/{framework => api}/testbed_model/node.py | 0 .../testbed_model/os_session.py | 6 ++-- dts/{framework => api}/testbed_model/port.py | 0 .../testbed_model/posix_session.py | 0 .../testbed_model/topology.py | 4 +-- .../traffic_generator/__init__.py | 2 +- .../capturing_traffic_generator.py | 2 +- .../performance_traffic_generator.py | 0 .../testbed_model/traffic_generator/scapy.py | 12 ++++---- .../traffic_generator/traffic_generator.py | 6 ++-- .../testbed_model/traffic_generator/trex.py | 14 +++++----- .../testbed_model/virtual_device.py | 0 dts/framework/params/eal.py | 6 ++-- dts/framework/params/types.py | 6 ++-- dts/framework/remote_session/blocking_app.py | 2 +- dts/framework/remote_session/dpdk.py | 8 +++--- dts/framework/remote_session/dpdk_shell.py | 2 +- .../remote_session/interactive_shell.py | 2 +- dts/framework/runner.py | 2 +- dts/framework/test_result.py | 2 +- dts/framework/test_run.py | 16 +++++------ dts/framework/test_suite.py | 4 +-- dts/tests/TestSuite_blocklist.py | 2 +- dts/tests/TestSuite_cryptodev_latency.py | 2 +- dts/tests/TestSuite_cryptodev_throughput.py | 2 +- dts/tests/TestSuite_l2fwd.py | 2 +- dts/tests/TestSuite_packet_capture.py | 8 +++--- dts/tests/TestSuite_smoke_tests.py | 2 +- dts/tests/TestSuite_softnic.py | 2 +- dts/tests/TestSuite_virtio_forward.py | 6 ++-- 55 files changed, 140 insertions(+), 140 deletions(-) rename doc/api/dts/{framework.testbed_model.capability.rst => api.testbed_model.capability.rst} (74%) rename doc/api/dts/{framework.testbed_model.cpu.rst => api.testbed_model.cpu.rst} (78%) rename doc/api/dts/{framework.testbed_model.linux_session.rst => api.testbed_model.linux_session.rst} (74%) rename doc/api/dts/{framework.testbed_model.node.rst => api.testbed_model.node.rst} (71%) rename doc/api/dts/{framework.testbed_model.os_session.rst => api.testbed_model.os_session.rst} (76%) rename doc/api/dts/{framework.testbed_model.port.rst => api.testbed_model.port.rst} (77%) rename doc/api/dts/{framework.testbed_model.posix_session.rst => api.testbed_model.posix_session.rst} (74%) create mode 100644 doc/api/dts/api.testbed_model.rst rename doc/api/dts/{framework.testbed_model.topology.rst => api.testbed_model.topology.rst} (73%) rename doc/api/dts/{framework.testbed_model.traffic_generator.capturing_traffic_generator.rst => api.testbed_model.traffic_generator.capturing_traffic_generator.rst} (68%) create mode 100644 doc/api/dts/api.testbed_model.traffic_generator.rst rename doc/api/dts/{framework.testbed_model.traffic_generator.scapy.rst => api.testbed_model.traffic_generator.scapy.rst} (70%) rename doc/api/dts/{framework.testbed_model.traffic_generator.traffic_generator.rst => api.testbed_model.traffic_generator.traffic_generator.rst} (65%) rename doc/api/dts/{framework.testbed_model.virtual_device.rst => api.testbed_model.virtual_device.rst} (72%) delete mode 100644 doc/api/dts/framework.testbed_model.rst delete mode 100644 doc/api/dts/framework.testbed_model.traffic_generator.rst rename dts/{framework => api}/testbed_model/__init__.py (100%) rename dts/{framework => api}/testbed_model/capability.py (99%) rename dts/{framework => api}/testbed_model/cpu.py (99%) rename dts/{framework => api}/testbed_model/linux_session.py (99%) rename dts/{framework => api}/testbed_model/node.py (100%) rename dts/{framework => api}/testbed_model/os_session.py (99%) rename dts/{framework => api}/testbed_model/port.py (100%) rename dts/{framework => api}/testbed_model/posix_session.py (100%) rename dts/{framework => api}/testbed_model/topology.py (99%) rename dts/{framework => api}/testbed_model/traffic_generator/__init__.py (97%) rename dts/{framework => api}/testbed_model/traffic_generator/capturing_traffic_generator.py (99%) rename dts/{framework => api}/testbed_model/traffic_generator/performance_traffic_generator.py (100%) rename dts/{framework => api}/testbed_model/traffic_generator/scapy.py (98%) rename dts/{framework => api}/testbed_model/traffic_generator/traffic_generator.py (94%) rename dts/{framework => api}/testbed_model/traffic_generator/trex.py (97%) rename dts/{framework => api}/testbed_model/virtual_device.py (100%) diff --git a/doc/api/dts/framework.testbed_model.capability.rst b/doc/api/dts/api.testbed_model.capability.rst similarity index 74% rename from doc/api/dts/framework.testbed_model.capability.rst rename to doc/api/dts/api.testbed_model.capability.rst index fab91cad83..88e396dddb 100644 --- a/doc/api/dts/framework.testbed_model.capability.rst +++ b/doc/api/dts/api.testbed_model.capability.rst @@ -3,6 +3,6 @@ capability - Testbed Capabilities ================================= -.. automodule:: framework.testbed_model.capability +.. automodule:: api.testbed_model.capability :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.cpu.rst b/doc/api/dts/api.testbed_model.cpu.rst similarity index 78% rename from doc/api/dts/framework.testbed_model.cpu.rst rename to doc/api/dts/api.testbed_model.cpu.rst index 997f2a9795..dbbb29480a 100644 --- a/doc/api/dts/framework.testbed_model.cpu.rst +++ b/doc/api/dts/api.testbed_model.cpu.rst @@ -3,6 +3,6 @@ cpu - CPU Representation and Utilities ====================================== -.. automodule:: framework.testbed_model.cpu +.. automodule:: api.testbed_model.cpu :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.linux_session.rst b/doc/api/dts/api.testbed_model.linux_session.rst similarity index 74% rename from doc/api/dts/framework.testbed_model.linux_session.rst rename to doc/api/dts/api.testbed_model.linux_session.rst index 7567816199..cfe79d8bca 100644 --- a/doc/api/dts/framework.testbed_model.linux_session.rst +++ b/doc/api/dts/api.testbed_model.linux_session.rst @@ -3,6 +3,6 @@ linux\_session - Linux Remote Session ===================================== -.. automodule:: framework.testbed_model.linux_session +.. automodule:: api.testbed_model.linux_session :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.node.rst b/doc/api/dts/api.testbed_model.node.rst similarity index 71% rename from doc/api/dts/framework.testbed_model.node.rst rename to doc/api/dts/api.testbed_model.node.rst index 23c6c46a00..15f522e5f7 100644 --- a/doc/api/dts/framework.testbed_model.node.rst +++ b/doc/api/dts/api.testbed_model.node.rst @@ -3,6 +3,6 @@ node - Base Node ================ -.. automodule:: framework.testbed_model.node +.. automodule:: api.testbed_model.node :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.os_session.rst b/doc/api/dts/api.testbed_model.os_session.rst similarity index 76% rename from doc/api/dts/framework.testbed_model.os_session.rst rename to doc/api/dts/api.testbed_model.os_session.rst index ecfb352311..e7e3f9894f 100644 --- a/doc/api/dts/framework.testbed_model.os_session.rst +++ b/doc/api/dts/api.testbed_model.os_session.rst @@ -3,6 +3,6 @@ os\_session - OS-aware Remote Session ABC ========================================= -.. automodule:: framework.testbed_model.os_session +.. automodule:: api.testbed_model.os_session :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.port.rst b/doc/api/dts/api.testbed_model.port.rst similarity index 77% rename from doc/api/dts/framework.testbed_model.port.rst rename to doc/api/dts/api.testbed_model.port.rst index fdb7ca8a1d..d64501aef0 100644 --- a/doc/api/dts/framework.testbed_model.port.rst +++ b/doc/api/dts/api.testbed_model.port.rst @@ -3,7 +3,7 @@ port - NIC Port Representation ============================== -.. automodule:: framework.testbed_model.port +.. automodule:: api.testbed_model.port :members: :show-inheritance: :noindex: diff --git a/doc/api/dts/framework.testbed_model.posix_session.rst b/doc/api/dts/api.testbed_model.posix_session.rst similarity index 74% rename from doc/api/dts/framework.testbed_model.posix_session.rst rename to doc/api/dts/api.testbed_model.posix_session.rst index e65585fd85..9f0e9ff18d 100644 --- a/doc/api/dts/framework.testbed_model.posix_session.rst +++ b/doc/api/dts/api.testbed_model.posix_session.rst @@ -3,6 +3,6 @@ posix\_session - Posix Remote Session ===================================== -.. automodule:: framework.testbed_model.posix_session +.. automodule:: api.testbed_model.posix_session :members: :show-inheritance: diff --git a/doc/api/dts/api.testbed_model.rst b/doc/api/dts/api.testbed_model.rst new file mode 100644 index 0000000000..5e2e5189b2 --- /dev/null +++ b/doc/api/dts/api.testbed_model.rst @@ -0,0 +1,28 @@ +.. SPDX-License-Identifier: BSD-3-Clause + +testbed\_model - Testbed Modelling Package +========================================== + +.. automodule:: api.testbed_model + :members: + :show-inheritance: + +.. toctree:: + :hidden: + :maxdepth: 2 + + api.testbed_model.traffic_generator + +.. toctree:: + :hidden: + :maxdepth: 1 + + api.testbed_model.os_session + api.testbed_model.linux_session + api.testbed_model.posix_session + api.testbed_model.node + api.testbed_model.capability + api.testbed_model.cpu + api.testbed_model.port + api.testbed_model.topology + api.testbed_model.virtual_device diff --git a/doc/api/dts/framework.testbed_model.topology.rst b/doc/api/dts/api.testbed_model.topology.rst similarity index 73% rename from doc/api/dts/framework.testbed_model.topology.rst rename to doc/api/dts/api.testbed_model.topology.rst index 496f2a895f..bb63fe38dc 100644 --- a/doc/api/dts/framework.testbed_model.topology.rst +++ b/doc/api/dts/api.testbed_model.topology.rst @@ -3,6 +3,6 @@ topology - Testbed Topology =========================== -.. automodule:: framework.testbed_model.topology +.. automodule:: api.testbed_model.topology :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst b/doc/api/dts/api.testbed_model.traffic_generator.capturing_traffic_generator.rst similarity index 68% rename from doc/api/dts/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst rename to doc/api/dts/api.testbed_model.traffic_generator.capturing_traffic_generator.rst index 29fa834042..cfe03201a7 100644 --- a/doc/api/dts/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst +++ b/doc/api/dts/api.testbed_model.traffic_generator.capturing_traffic_generator.rst @@ -3,6 +3,6 @@ capturing\_traffic\_generator - Base Capturing TG ABC ===================================================== -.. automodule:: framework.testbed_model.traffic_generator.capturing_traffic_generator +.. automodule:: api.testbed_model.traffic_generator.capturing_traffic_generator :members: :show-inheritance: diff --git a/doc/api/dts/api.testbed_model.traffic_generator.rst b/doc/api/dts/api.testbed_model.traffic_generator.rst new file mode 100644 index 0000000000..311bdcf6b9 --- /dev/null +++ b/doc/api/dts/api.testbed_model.traffic_generator.rst @@ -0,0 +1,16 @@ +.. SPDX-License-Identifier: BSD-3-Clause + +traffic\_generator Subpackage +============================= + +.. automodule:: api.testbed_model.traffic_generator + :members: + :show-inheritance: + +.. toctree:: + :hidden: + :maxdepth: 1 + + api.testbed_model.traffic_generator.traffic_generator + api.testbed_model.traffic_generator.capturing_traffic_generator + api.testbed_model.traffic_generator.scapy diff --git a/doc/api/dts/framework.testbed_model.traffic_generator.scapy.rst b/doc/api/dts/api.testbed_model.traffic_generator.scapy.rst similarity index 70% rename from doc/api/dts/framework.testbed_model.traffic_generator.scapy.rst rename to doc/api/dts/api.testbed_model.traffic_generator.scapy.rst index df78ac9514..949bb66632 100644 --- a/doc/api/dts/framework.testbed_model.traffic_generator.scapy.rst +++ b/doc/api/dts/api.testbed_model.traffic_generator.scapy.rst @@ -3,6 +3,6 @@ scapy - Capturing Traffic Generator =================================== -.. automodule:: framework.testbed_model.traffic_generator.scapy +.. automodule:: api.testbed_model.traffic_generator.scapy :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.traffic_generator.traffic_generator.rst b/doc/api/dts/api.testbed_model.traffic_generator.traffic_generator.rst similarity index 65% rename from doc/api/dts/framework.testbed_model.traffic_generator.traffic_generator.rst rename to doc/api/dts/api.testbed_model.traffic_generator.traffic_generator.rst index bfec728dee..1045e534b5 100644 --- a/doc/api/dts/framework.testbed_model.traffic_generator.traffic_generator.rst +++ b/doc/api/dts/api.testbed_model.traffic_generator.traffic_generator.rst @@ -3,6 +3,6 @@ traffic\_generator - Base TG ABC ================================ -.. automodule:: framework.testbed_model.traffic_generator.traffic_generator +.. automodule:: api.testbed_model.traffic_generator.traffic_generator :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.virtual_device.rst b/doc/api/dts/api.testbed_model.virtual_device.rst similarity index 72% rename from doc/api/dts/framework.testbed_model.virtual_device.rst rename to doc/api/dts/api.testbed_model.virtual_device.rst index a6b0420e75..97adc895f6 100644 --- a/doc/api/dts/framework.testbed_model.virtual_device.rst +++ b/doc/api/dts/api.testbed_model.virtual_device.rst @@ -3,6 +3,6 @@ virtual\_device - Virtual Devices ================================= -.. automodule:: framework.testbed_model.virtual_device +.. automodule:: api.testbed_model.virtual_device :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.rst b/doc/api/dts/framework.testbed_model.rst deleted file mode 100644 index f283178f6a..0000000000 --- a/doc/api/dts/framework.testbed_model.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. SPDX-License-Identifier: BSD-3-Clause - -testbed\_model - Testbed Modelling Package -========================================== - -.. automodule:: framework.testbed_model - :members: - :show-inheritance: - -.. toctree:: - :hidden: - :maxdepth: 2 - - framework.testbed_model.traffic_generator - -.. toctree:: - :hidden: - :maxdepth: 1 - - framework.testbed_model.os_session - framework.testbed_model.linux_session - framework.testbed_model.posix_session - framework.testbed_model.node - framework.testbed_model.capability - framework.testbed_model.cpu - framework.testbed_model.port - framework.testbed_model.topology - framework.testbed_model.virtual_device diff --git a/doc/api/dts/framework.testbed_model.traffic_generator.rst b/doc/api/dts/framework.testbed_model.traffic_generator.rst deleted file mode 100644 index 24c250ee3a..0000000000 --- a/doc/api/dts/framework.testbed_model.traffic_generator.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. SPDX-License-Identifier: BSD-3-Clause - -traffic\_generator Subpackage -============================= - -.. automodule:: framework.testbed_model.traffic_generator - :members: - :show-inheritance: - -.. toctree:: - :hidden: - :maxdepth: 1 - - framework.testbed_model.traffic_generator.traffic_generator - framework.testbed_model.traffic_generator.capturing_traffic_generator - framework.testbed_model.traffic_generator.scapy diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index 98269d6e80..f47e4af3f2 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -16,7 +16,7 @@ Packages tests api - framework.testbed_model + api.testbed_model framework.remote_session framework.params framework.config diff --git a/dts/api/artifact.py b/dts/api/artifact.py index f3dd07de56..74a8ac667f 100644 --- a/dts/api/artifact.py +++ b/dts/api/artifact.py @@ -48,9 +48,9 @@ from typing_extensions import Buffer from api.exception import InternalError +from api.testbed_model.node import Node, NodeIdentifier, get_node from framework.logger import DTSLogger, get_dts_logger from framework.settings import SETTINGS -from framework.testbed_model.node import Node, NodeIdentifier, get_node TextMode: TypeAlias = ( Literal["r", "r+", "w", "w+", "a", "a+", "x", "x+"] diff --git a/dts/api/capabilities.py b/dts/api/capabilities.py index b0c1d81d36..8ed832a588 100644 --- a/dts/api/capabilities.py +++ b/dts/api/capabilities.py @@ -23,7 +23,7 @@ .. code:: python from framework.test_suite import TestSuite, func_test - from framework.testbed_model.capability import LinkTopology, requires_link_topology + from api.testbed_model.capability import LinkTopology, requires_link_topology # The whole test suite (each test case within) doesn't require any links. @requires_link_topology(LinkTopology.NO_LINK) @func_test @@ -34,7 +34,7 @@ def hello_world_single_core(self): .. code:: python from framework.test_suite import TestSuite, func_test - from framework.testbed_model.capability import NicCapability, requires_nic_capability + from api.testbed_model.capability import NicCapability, requires_nic_capability class TestPmdBufferScatter(TestSuite): # only the test case requires the SCATTERED_RX_ENABLED capability # other test cases may not require it @@ -237,7 +237,7 @@ def requires_link_topology( Returns: The decorated test case or test suite. """ - from framework.testbed_model.capability import TopologyCapability + from api.testbed_model.capability import TopologyCapability def add_required_topology( test_case_or_suite: type["TestProtocol"], @@ -260,7 +260,7 @@ def requires_nic_capability( Returns: The decorated test case or test suite. """ - from framework.testbed_model.capability import DecoratedNicCapability + from api.testbed_model.capability import DecoratedNicCapability def add_required_capability( test_case_or_suite: type["TestProtocol"], diff --git a/dts/api/context.py b/dts/api/context.py index 709b99421e..57e14ef598 100644 --- a/dts/api/context.py +++ b/dts/api/context.py @@ -9,17 +9,17 @@ from typing import TYPE_CHECKING, Any, Optional, ParamSpec, Union from api.exception import InternalError +from api.testbed_model.cpu import LogicalCoreCount, LogicalCoreList +from api.testbed_model.node import Node +from api.testbed_model.topology import Topology from framework.remote_session.shell_pool import ShellPool from framework.settings import SETTINGS -from framework.testbed_model.cpu import LogicalCoreCount, LogicalCoreList -from framework.testbed_model.node import Node -from framework.testbed_model.topology import Topology if TYPE_CHECKING: + from api.testbed_model.capability import TestProtocol + from api.testbed_model.traffic_generator.traffic_generator import TrafficGenerator from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment from framework.test_suite import TestCase, TestSuite - from framework.testbed_model.capability import TestProtocol - from framework.testbed_model.traffic_generator.traffic_generator import TrafficGenerator P = ParamSpec("P") diff --git a/dts/api/packet.py b/dts/api/packet.py index dda3087df4..defbb758c8 100644 --- a/dts/api/packet.py +++ b/dts/api/packet.py @@ -30,13 +30,13 @@ from api.context import get_ctx from api.exception import InternalError from api.test import fail, log_debug -from api.utils import get_packet_summaries -from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( +from api.testbed_model.traffic_generator.capturing_traffic_generator import ( PacketFilteringConfig, ) -from framework.testbed_model.traffic_generator.performance_traffic_generator import ( +from api.testbed_model.traffic_generator.performance_traffic_generator import ( PerformanceTrafficStats, ) +from api.utils import get_packet_summaries def send_packet_and_capture( @@ -83,7 +83,7 @@ def send_packets_and_capture( A list of received packets. """ from api.context import get_ctx - from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( + from api.testbed_model.traffic_generator.capturing_traffic_generator import ( CapturingTrafficGenerator, ) @@ -339,7 +339,7 @@ def assess_performance_by_packet( Returns: Performance statistics of the generated test. """ - from framework.testbed_model.traffic_generator.performance_traffic_generator import ( + from api.testbed_model.traffic_generator.performance_traffic_generator import ( PerformanceTrafficGenerator, ) diff --git a/dts/framework/testbed_model/__init__.py b/dts/api/testbed_model/__init__.py similarity index 100% rename from dts/framework/testbed_model/__init__.py rename to dts/api/testbed_model/__init__.py diff --git a/dts/framework/testbed_model/capability.py b/dts/api/testbed_model/capability.py similarity index 99% rename from dts/framework/testbed_model/capability.py rename to dts/api/testbed_model/capability.py index 00b40a3b1e..2748daa8a4 100644 --- a/dts/framework/testbed_model/capability.py +++ b/dts/api/testbed_model/capability.py @@ -26,7 +26,7 @@ .. code:: python from framework.test_suite import TestSuite, func_test - from framework.testbed_model.capability import LinkTopology, requires + from api.testbed_model.capability import LinkTopology, requires # The whole test suite (each test case within) doesn't require any links. @requires_link_topology(LinkTopology.NO_LINK) @func_test @@ -37,7 +37,7 @@ def hello_world_single_core(self): .. code:: python from framework.test_suite import TestSuite, func_test - from framework.testbed_model.capability import NicCapability, requires + from api.testbed_model.capability import NicCapability, requires class TestPmdBufferScatter(TestSuite): # only the test case requires the SCATTERED_RX_ENABLED capability # other test cases may not require it @@ -65,10 +65,10 @@ def test_scatter_mbuf_2048(self): from api.capabilities import LinkTopology, NicCapability from api.exception import ConfigurationError, InternalError, SkippedTestException +from api.testbed_model.node import Node +from api.testbed_model.port import DriverKind +from api.testbed_model.topology import Topology from framework.logger import get_dts_logger -from framework.testbed_model.node import Node -from framework.testbed_model.port import DriverKind -from framework.testbed_model.topology import Topology if TYPE_CHECKING: from api.testpmd import TestPmd diff --git a/dts/framework/testbed_model/cpu.py b/dts/api/testbed_model/cpu.py similarity index 99% rename from dts/framework/testbed_model/cpu.py rename to dts/api/testbed_model/cpu.py index 68e9c7dffb..34fb6d0848 100644 --- a/dts/framework/testbed_model/cpu.py +++ b/dts/api/testbed_model/cpu.py @@ -29,7 +29,7 @@ @unique class Architecture(StrEnum): - r"""The supported architectures of :class:`~framework.testbed_model.node.Node`\s.""" + r"""The supported architectures of :class:`~api.testbed_model.node.Node`\s.""" #: i686 = auto() diff --git a/dts/framework/testbed_model/linux_session.py b/dts/api/testbed_model/linux_session.py similarity index 99% rename from dts/framework/testbed_model/linux_session.py rename to dts/api/testbed_model/linux_session.py index 26c53f069c..399968efd4 100644 --- a/dts/framework/testbed_model/linux_session.py +++ b/dts/api/testbed_model/linux_session.py @@ -23,8 +23,8 @@ InternalError, RemoteCommandExecutionError, ) +from api.testbed_model.port import PortInfo from api.utils import expand_range -from framework.testbed_model.port import PortInfo from .cpu import LogicalCore from .port import Port diff --git a/dts/framework/testbed_model/node.py b/dts/api/testbed_model/node.py similarity index 100% rename from dts/framework/testbed_model/node.py rename to dts/api/testbed_model/node.py diff --git a/dts/framework/testbed_model/os_session.py b/dts/api/testbed_model/os_session.py similarity index 99% rename from dts/framework/testbed_model/os_session.py rename to dts/api/testbed_model/os_session.py index 08122874e6..7944fda8c0 100644 --- a/dts/framework/testbed_model/os_session.py +++ b/dts/api/testbed_model/os_session.py @@ -73,11 +73,11 @@ class OSSessionInfo: Attributes: os_name: The name of the running operating system of - the :class:`~framework.testbed_model.node.Node`. + the :class:`~api.testbed_model.node.Node`. os_version: The version of the running operating system of - the :class:`~framework.testbed_model.node.Node`. + the :class:`~api.testbed_model.node.Node`. kernel_version: The kernel version of the running operating system of - the :class:`~framework.testbed_model.node.Node`. + the :class:`~api.testbed_model.node.Node`. """ os_name: str diff --git a/dts/framework/testbed_model/port.py b/dts/api/testbed_model/port.py similarity index 100% rename from dts/framework/testbed_model/port.py rename to dts/api/testbed_model/port.py diff --git a/dts/framework/testbed_model/posix_session.py b/dts/api/testbed_model/posix_session.py similarity index 100% rename from dts/framework/testbed_model/posix_session.py rename to dts/api/testbed_model/posix_session.py diff --git a/dts/framework/testbed_model/topology.py b/dts/api/testbed_model/topology.py similarity index 99% rename from dts/framework/testbed_model/topology.py rename to dts/api/testbed_model/topology.py index 6b8c5edee5..7d074f9ef4 100644 --- a/dts/framework/testbed_model/topology.py +++ b/dts/api/testbed_model/topology.py @@ -19,8 +19,8 @@ from api.capabilities import LinkTopology from api.exception import ConfigurationError, InternalError -from framework.testbed_model.linux_session import LinuxSession -from framework.testbed_model.node import Node, NodeIdentifier +from api.testbed_model.linux_session import LinuxSession +from api.testbed_model.node import Node, NodeIdentifier from .port import DriverKind, Port, PortConfig diff --git a/dts/framework/testbed_model/traffic_generator/__init__.py b/dts/api/testbed_model/traffic_generator/__init__.py similarity index 97% rename from dts/framework/testbed_model/traffic_generator/__init__.py rename to dts/api/testbed_model/traffic_generator/__init__.py index 324b5e88f3..11fa25448a 100644 --- a/dts/framework/testbed_model/traffic_generator/__init__.py +++ b/dts/api/testbed_model/traffic_generator/__init__.py @@ -15,12 +15,12 @@ """ from api.exception import ConfigurationError +from api.testbed_model.node import Node from framework.config.test_run import ( ScapyTrafficGeneratorConfig, TrafficGeneratorConfig, TrexTrafficGeneratorConfig, ) -from framework.testbed_model.node import Node from .scapy import ScapyTrafficGenerator from .traffic_generator import TrafficGenerator diff --git a/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py b/dts/api/testbed_model/traffic_generator/capturing_traffic_generator.py similarity index 99% rename from dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py rename to dts/api/testbed_model/traffic_generator/capturing_traffic_generator.py index 2804d64990..db274e5e82 100644 --- a/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py +++ b/dts/api/testbed_model/traffic_generator/capturing_traffic_generator.py @@ -17,8 +17,8 @@ from scapy.packet import Packet from api.artifact import Artifact +from api.testbed_model.port import Port from api.utils import get_packet_summaries -from framework.testbed_model.port import Port from .traffic_generator import TrafficGenerator diff --git a/dts/framework/testbed_model/traffic_generator/performance_traffic_generator.py b/dts/api/testbed_model/traffic_generator/performance_traffic_generator.py similarity index 100% rename from dts/framework/testbed_model/traffic_generator/performance_traffic_generator.py rename to dts/api/testbed_model/traffic_generator/performance_traffic_generator.py diff --git a/dts/framework/testbed_model/traffic_generator/scapy.py b/dts/api/testbed_model/traffic_generator/scapy.py similarity index 98% rename from dts/framework/testbed_model/traffic_generator/scapy.py rename to dts/api/testbed_model/traffic_generator/scapy.py index 70856cc1f0..1edc1af838 100644 --- a/dts/framework/testbed_model/traffic_generator/scapy.py +++ b/dts/api/testbed_model/traffic_generator/scapy.py @@ -26,15 +26,15 @@ from scapy.packet import Packet from api.exception import InteractiveSSHSessionDeadError, InternalError +from api.testbed_model.node import Node +from api.testbed_model.port import Port +from api.testbed_model.topology import Topology +from api.testbed_model.traffic_generator.capturing_traffic_generator import ( + PacketFilteringConfig, +) from framework.config.node import OS from framework.config.test_run import ScapyTrafficGeneratorConfig from framework.remote_session.python_shell import PythonShell -from framework.testbed_model.node import Node -from framework.testbed_model.port import Port -from framework.testbed_model.topology import Topology -from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( - PacketFilteringConfig, -) from .capturing_traffic_generator import CapturingTrafficGenerator diff --git a/dts/framework/testbed_model/traffic_generator/traffic_generator.py b/dts/api/testbed_model/traffic_generator/traffic_generator.py similarity index 94% rename from dts/framework/testbed_model/traffic_generator/traffic_generator.py rename to dts/api/testbed_model/traffic_generator/traffic_generator.py index fedce77fdf..5fd68e5144 100644 --- a/dts/framework/testbed_model/traffic_generator/traffic_generator.py +++ b/dts/api/testbed_model/traffic_generator/traffic_generator.py @@ -13,11 +13,11 @@ from scapy.packet import Packet +from api.testbed_model.node import Node +from api.testbed_model.port import Port +from api.testbed_model.topology import Topology from framework.config.test_run import TrafficGeneratorConfig from framework.logger import DTSLogger, get_dts_logger -from framework.testbed_model.node import Node -from framework.testbed_model.port import Port -from framework.testbed_model.topology import Topology class TrafficGenerator(ABC): diff --git a/dts/framework/testbed_model/traffic_generator/trex.py b/dts/api/testbed_model/traffic_generator/trex.py similarity index 97% rename from dts/framework/testbed_model/traffic_generator/trex.py rename to dts/api/testbed_model/traffic_generator/trex.py index 7fd6234d27..ffb1390706 100644 --- a/dts/framework/testbed_model/traffic_generator/trex.py +++ b/dts/api/testbed_model/traffic_generator/trex.py @@ -12,19 +12,19 @@ from scapy.packet import Packet from api.exception import SSHTimeoutError +from api.testbed_model.node import Node, create_session +from api.testbed_model.os_session import OSSession +from api.testbed_model.topology import Topology +from api.testbed_model.traffic_generator.performance_traffic_generator import ( + PerformanceTrafficGenerator, + PerformanceTrafficStats, +) from api.utils import StrEnum from framework.config.node import OS, NodeConfiguration from framework.config.test_run import TrexTrafficGeneratorConfig from framework.parser import TextParser from framework.remote_session.blocking_app import BlockingApp from framework.remote_session.python_shell import PythonShell -from framework.testbed_model.node import Node, create_session -from framework.testbed_model.os_session import OSSession -from framework.testbed_model.topology import Topology -from framework.testbed_model.traffic_generator.performance_traffic_generator import ( - PerformanceTrafficGenerator, - PerformanceTrafficStats, -) @dataclass(slots=True) diff --git a/dts/framework/testbed_model/virtual_device.py b/dts/api/testbed_model/virtual_device.py similarity index 100% rename from dts/framework/testbed_model/virtual_device.py rename to dts/api/testbed_model/virtual_device.py diff --git a/dts/framework/params/eal.py b/dts/framework/params/eal.py index e84a20f02f..86bfd3fcc6 100644 --- a/dts/framework/params/eal.py +++ b/dts/framework/params/eal.py @@ -6,12 +6,12 @@ from dataclasses import dataclass, field from typing import TYPE_CHECKING, Literal +from api.testbed_model.cpu import LogicalCoreList +from api.testbed_model.virtual_device import VirtualDevice from framework.params import Params, Switch -from framework.testbed_model.cpu import LogicalCoreList -from framework.testbed_model.virtual_device import VirtualDevice if TYPE_CHECKING: - from framework.testbed_model.port import Port + from api.testbed_model.port import Port def _port_to_pci(port: "Port") -> str: diff --git a/dts/framework/params/types.py b/dts/framework/params/types.py index a9f3749083..f9a51963a2 100644 --- a/dts/framework/params/types.py +++ b/dts/framework/params/types.py @@ -32,6 +32,9 @@ def create_testpmd(**kwargs: Unpack[TestPmdParamsDict]): TestType, TLSVersion, ) +from api.testbed_model.cpu import LogicalCoreList +from api.testbed_model.port import Port +from api.testbed_model.virtual_device import VirtualDevice from api.testpmd.config import ( AnonMempoolAllocationMode, EthPeer, @@ -55,9 +58,6 @@ def create_testpmd(**kwargs: Unpack[TestPmdParamsDict]): ) from api.testpmd.types import RxOffloadCapability, TxOffloadCapability from framework.params import Switch, YesNoSwitch -from framework.testbed_model.cpu import LogicalCoreList -from framework.testbed_model.port import Port -from framework.testbed_model.virtual_device import VirtualDevice class EalParamsDict(TypedDict, total=False): diff --git a/dts/framework/remote_session/blocking_app.py b/dts/framework/remote_session/blocking_app.py index 07db6dfeb0..84db3974b1 100644 --- a/dts/framework/remote_session/blocking_app.py +++ b/dts/framework/remote_session/blocking_app.py @@ -31,11 +31,11 @@ from typing_extensions import Self from api.context import get_ctx +from api.testbed_model.node import Node from framework.params import Params from framework.params.eal import EalParams from framework.remote_session.dpdk_shell import compute_eal_params from framework.remote_session.interactive_shell import InteractiveShell -from framework.testbed_model.node import Node P = TypeVar("P", bound=Params) diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index ee34eb567d..c02c68af77 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -16,6 +16,10 @@ from api.capabilities import LinkTopology from api.context import get_ctx from api.exception import ConfigurationError, RemoteFileNotFoundError +from api.testbed_model.cpu import LogicalCore, LogicalCoreCount, LogicalCoreList, lcore_filter +from api.testbed_model.node import Node +from api.testbed_model.os_session import OSSession +from api.testbed_model.virtual_device import VirtualDevice from api.utils import MesonArgs, TarCompressionFormat from framework.config.test_run import ( DPDKBuildConfiguration, @@ -31,10 +35,6 @@ from framework.logger import DTSLogger, get_dts_logger from framework.params.eal import EalParams from framework.remote_session.remote_session import CommandResult -from framework.testbed_model.cpu import LogicalCore, LogicalCoreCount, LogicalCoreList, lcore_filter -from framework.testbed_model.node import Node -from framework.testbed_model.os_session import OSSession -from framework.testbed_model.virtual_device import VirtualDevice @dataclass(slots=True, frozen=True) diff --git a/dts/framework/remote_session/dpdk_shell.py b/dts/framework/remote_session/dpdk_shell.py index a8f169787c..b807f9bdae 100644 --- a/dts/framework/remote_session/dpdk_shell.py +++ b/dts/framework/remote_session/dpdk_shell.py @@ -11,12 +11,12 @@ from pathlib import PurePath from api.context import get_ctx +from api.testbed_model.cpu import LogicalCoreList from framework.params.eal import EalParams from framework.remote_session.interactive_shell import ( InteractiveShell, only_active, ) -from framework.testbed_model.cpu import LogicalCoreList def compute_eal_params( diff --git a/dts/framework/remote_session/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index 362bc2a352..831861a9ac 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -35,10 +35,10 @@ InteractiveSSHSessionDeadError, InteractiveSSHTimeoutError, ) +from api.testbed_model.node import Node from framework.logger import DTSLogger, get_dts_logger from framework.params import Params from framework.settings import SETTINGS -from framework.testbed_model.node import Node P = ParamSpec("P") T = TypeVar("T", bound="InteractiveShell") diff --git a/dts/framework/runner.py b/dts/framework/runner.py index cb137fbf7b..ba5bc45cfc 100644 --- a/dts/framework/runner.py +++ b/dts/framework/runner.py @@ -13,9 +13,9 @@ import textwrap from api.exception import ConfigurationError +from api.testbed_model.node import Node from framework.config.common import ValidationContext from framework.test_run import TestRun -from framework.testbed_model.node import Node from .config import Configuration, load_config from .logger import DTSLogger, get_dts_logger diff --git a/dts/framework/test_result.py b/dts/framework/test_result.py index 3cecb928ca..5f945163ce 100644 --- a/dts/framework/test_result.py +++ b/dts/framework/test_result.py @@ -36,9 +36,9 @@ from typing_extensions import OrderedDict from api.exception import DTSError, ErrorSeverity, InternalError +from api.testbed_model.os_session import OSSessionInfo from framework.remote_session.dpdk import DPDKBuildInfo from framework.settings import SETTINGS -from framework.testbed_model.os_session import OSSessionInfo class Result(IntEnum): diff --git a/dts/framework/test_run.py b/dts/framework/test_run.py index 8b9ae4a49a..42a56d38c9 100644 --- a/dts/framework/test_run.py +++ b/dts/framework/test_run.py @@ -110,20 +110,20 @@ from api.capabilities import LinkTopology from api.context import Context, init_ctx from api.exception import InternalError, SkippedTestException, TestCaseVerifyError +from api.testbed_model.capability import ( + Capability, + get_supported_capabilities, + test_if_supported, +) +from api.testbed_model.node import Node +from api.testbed_model.topology import PortLink, Topology +from api.testbed_model.traffic_generator import create_traffic_generator from framework.config.test_run import TestRunConfiguration from framework.logger import DTSLogger, get_dts_logger from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment from framework.settings import SETTINGS from framework.test_result import Result, ResultNode, TestRunResult from framework.test_suite import BaseConfig, TestCase, TestCaseType, TestSuite -from framework.testbed_model.capability import ( - Capability, - get_supported_capabilities, - test_if_supported, -) -from framework.testbed_model.node import Node -from framework.testbed_model.topology import PortLink, Topology -from framework.testbed_model.traffic_generator import create_traffic_generator TestScenario = tuple[type[TestSuite], BaseConfig, deque[type[TestCase]]] diff --git a/dts/framework/test_suite.py b/dts/framework/test_suite.py index 6066f7a77a..786cfc7bff 100644 --- a/dts/framework/test_suite.py +++ b/dts/framework/test_suite.py @@ -30,10 +30,10 @@ from typing_extensions import Self from api.exception import ConfigurationError, InternalError +from api.testbed_model.capability import TestProtocol +from api.testbed_model.topology import Topology from api.utils import to_pascal_case from framework.config.common import FrozenModel -from framework.testbed_model.capability import TestProtocol -from framework.testbed_model.topology import Topology from .logger import DTSLogger, get_dts_logger diff --git a/dts/tests/TestSuite_blocklist.py b/dts/tests/TestSuite_blocklist.py index c57231de22..97e03b8fb7 100644 --- a/dts/tests/TestSuite_blocklist.py +++ b/dts/tests/TestSuite_blocklist.py @@ -11,9 +11,9 @@ requires_link_topology, ) from api.test import verify +from api.testbed_model.port import Port from api.testpmd import TestPmd from framework.test_suite import TestSuite, func_test -from framework.testbed_model.port import Port class TestBlocklist(TestSuite): diff --git a/dts/tests/TestSuite_cryptodev_latency.py b/dts/tests/TestSuite_cryptodev_latency.py index ed6423eb26..981c483a14 100644 --- a/dts/tests/TestSuite_cryptodev_latency.py +++ b/dts/tests/TestSuite_cryptodev_latency.py @@ -31,8 +31,8 @@ CryptodevResults, ) from api.test import skip, verify +from api.testbed_model.virtual_device import VirtualDevice from framework.test_suite import BaseConfig, TestSuite, crypto_test -from framework.testbed_model.virtual_device import VirtualDevice config_list: list[dict[str, int | float | str]] = [ {"buff_size": 64, "avg_cycles": 99_999.00, "avg_time_us": 9999.0}, diff --git a/dts/tests/TestSuite_cryptodev_throughput.py b/dts/tests/TestSuite_cryptodev_throughput.py index d69714e1fa..b861c52bae 100644 --- a/dts/tests/TestSuite_cryptodev_throughput.py +++ b/dts/tests/TestSuite_cryptodev_throughput.py @@ -31,8 +31,8 @@ CryptodevResults, ) from api.test import skip, verify +from api.testbed_model.virtual_device import VirtualDevice from framework.test_suite import BaseConfig, TestSuite, crypto_test -from framework.testbed_model.virtual_device import VirtualDevice config_list: list[dict[str, int | float | str]] = [ {"buff_size": 64, "Gbps": 1.00}, diff --git a/dts/tests/TestSuite_l2fwd.py b/dts/tests/TestSuite_l2fwd.py index 574842e2e4..5650366c36 100644 --- a/dts/tests/TestSuite_l2fwd.py +++ b/dts/tests/TestSuite_l2fwd.py @@ -19,11 +19,11 @@ match_all_packets, send_packets_and_capture, ) +from api.testbed_model.cpu import LogicalCoreCount from api.testpmd import TestPmd from api.testpmd.config import EthPeer, SimpleForwardingModes from api.utils import generate_random_packets from framework.test_suite import TestSuite, func_test -from framework.testbed_model.cpu import LogicalCoreCount @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_packet_capture.py b/dts/tests/TestSuite_packet_capture.py index 4bd15e2401..042b7019aa 100644 --- a/dts/tests/TestSuite_packet_capture.py +++ b/dts/tests/TestSuite_packet_capture.py @@ -36,15 +36,15 @@ send_packets_and_capture, ) from api.test import verify +from api.testbed_model.cpu import LogicalCoreList +from api.testbed_model.traffic_generator.capturing_traffic_generator import ( + PacketFilteringConfig, +) from api.testpmd import TestPmd from framework.params import Params from framework.remote_session.blocking_app import BlockingApp from framework.remote_session.dpdk_shell import compute_eal_params from framework.test_suite import TestSuite, func_test -from framework.testbed_model.cpu import LogicalCoreList -from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( - PacketFilteringConfig, -) @dataclass(kw_only=True) diff --git a/dts/tests/TestSuite_smoke_tests.py b/dts/tests/TestSuite_smoke_tests.py index fce83604a6..656e2e4bb7 100644 --- a/dts/tests/TestSuite_smoke_tests.py +++ b/dts/tests/TestSuite_smoke_tests.py @@ -19,12 +19,12 @@ requires_link_topology, ) from api.test import verify +from api.testbed_model.linux_session import LinuxSession from api.testpmd import TestPmd from api.utils import REGEX_FOR_PCI_ADDRESS from framework.config.node import PortConfig from framework.settings import SETTINGS from framework.test_suite import TestSuite, func_test -from framework.testbed_model.linux_session import LinuxSession @requires_link_topology(LinkTopology.NO_LINK) diff --git a/dts/tests/TestSuite_softnic.py b/dts/tests/TestSuite_softnic.py index c57a12c932..91a6d4eb9f 100644 --- a/dts/tests/TestSuite_softnic.py +++ b/dts/tests/TestSuite_softnic.py @@ -18,11 +18,11 @@ match_all_packets, send_packets_and_capture, ) +from api.testbed_model.virtual_device import VirtualDevice from api.testpmd import TestPmd from api.testpmd.config import EthPeer from api.utils import generate_random_packets from framework.test_suite import TestSuite, func_test -from framework.testbed_model.virtual_device import VirtualDevice @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_virtio_forward.py b/dts/tests/TestSuite_virtio_forward.py index 6efaa4e156..06bcd86ee4 100644 --- a/dts/tests/TestSuite_virtio_forward.py +++ b/dts/tests/TestSuite_virtio_forward.py @@ -12,12 +12,12 @@ from api.capabilities import LinkTopology from api.packet import send_packets_and_capture from api.test import log, verify +from api.testbed_model.capability import requires +from api.testbed_model.linux_session import LinuxSession +from api.testbed_model.virtual_device import VirtualDevice from api.testpmd import TestPmd from api.testpmd.config import PortTopology, SimpleForwardingModes from framework.test_suite import TestSuite, func_test -from framework.testbed_model.capability import requires -from framework.testbed_model.linux_session import LinuxSession -from framework.testbed_model.virtual_device import VirtualDevice class TestVirtioForward(TestSuite): -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* [PATCH v5 5/7] dts: move test suite module from framework to API 2026-08-06 13:53 [PATCH v5 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (3 preceding siblings ...) 2026-08-06 13:53 ` [PATCH v5 4/7] dts: move testbed model " Andrew Bailey @ 2026-08-06 13:53 ` Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 6/7] dts: move params directory " Andrew Bailey ` (4 subsequent siblings) 9 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 13:53 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx Currently, each test suite imports the TestSuite class from the DTS framework to use as a base class. However, the goal for 26.07 is to move all test suite imports to the API module. Moves and updates the test_suite file to the API directory, and updates all files that import test_suite to reflect this change. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- .../dts/{framework.test_suite.rst => api.test_suite.rst} | 2 +- doc/api/dts/index.rst | 2 +- dts/api/capabilities.py | 6 +++--- dts/api/context.py | 2 +- dts/api/packet.py | 2 +- dts/{framework => api}/test_suite.py | 3 +-- dts/api/testbed_model/capability.py | 6 +++--- dts/framework/config/__init__.py | 4 ++-- dts/framework/config/test_run.py | 8 ++++---- dts/framework/test_run.py | 2 +- dts/tests/TestSuite_blocklist.py | 2 +- dts/tests/TestSuite_buffer_scatter.py | 2 +- dts/tests/TestSuite_checksum_offload.py | 2 +- dts/tests/TestSuite_cryptodev_latency.py | 2 +- dts/tests/TestSuite_cryptodev_throughput.py | 2 +- dts/tests/TestSuite_dual_vlan.py | 2 +- dts/tests/TestSuite_dynamic_config.py | 2 +- dts/tests/TestSuite_dynamic_queue_conf.py | 2 +- dts/tests/TestSuite_flow_offload.py | 2 +- dts/tests/TestSuite_hello_world.py | 2 +- dts/tests/TestSuite_l2fwd.py | 2 +- dts/tests/TestSuite_mac_filter.py | 2 +- dts/tests/TestSuite_mtu.py | 2 +- dts/tests/TestSuite_packet_capture.py | 2 +- dts/tests/TestSuite_port_control.py | 2 +- dts/tests/TestSuite_port_restart_config_persistency.py | 2 +- dts/tests/TestSuite_port_stats.py | 2 +- dts/tests/TestSuite_promisc_support.py | 2 +- dts/tests/TestSuite_qinq.py | 2 +- dts/tests/TestSuite_queue_toggle.py | 2 +- dts/tests/TestSuite_rss.py | 2 +- dts/tests/TestSuite_rx_split.py | 2 +- dts/tests/TestSuite_rx_tx_offload.py | 2 +- dts/tests/TestSuite_single_core_forward_perf.py | 2 +- dts/tests/TestSuite_smoke_tests.py | 2 +- dts/tests/TestSuite_softnic.py | 2 +- dts/tests/TestSuite_speed_capabilities.py | 2 +- dts/tests/TestSuite_unified_packet.py | 2 +- dts/tests/TestSuite_virtio_forward.py | 2 +- dts/tests/TestSuite_vlan.py | 2 +- 40 files changed, 48 insertions(+), 49 deletions(-) rename doc/api/dts/{framework.test_suite.rst => api.test_suite.rst} (81%) rename dts/{framework => api}/test_suite.py (99%) diff --git a/doc/api/dts/framework.test_suite.rst b/doc/api/dts/api.test_suite.rst similarity index 81% rename from doc/api/dts/framework.test_suite.rst rename to doc/api/dts/api.test_suite.rst index 9517f51a4a..4acb7b103a 100644 --- a/doc/api/dts/framework.test_suite.rst +++ b/doc/api/dts/api.test_suite.rst @@ -3,6 +3,6 @@ test\_suite - Common Test Suite Features ======================================== -.. automodule:: framework.test_suite +.. automodule:: api.test_suite :members: :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index f47e4af3f2..7c282bbba1 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -29,7 +29,7 @@ Modules framework.runner framework.test_run - framework.test_suite + api.test_suite framework.test_result framework.settings api.context diff --git a/dts/api/capabilities.py b/dts/api/capabilities.py index 8ed832a588..933eb6bca7 100644 --- a/dts/api/capabilities.py +++ b/dts/api/capabilities.py @@ -22,7 +22,7 @@ Examples: .. code:: python - from framework.test_suite import TestSuite, func_test + from api.test_suite import TestSuite, func_test from api.testbed_model.capability import LinkTopology, requires_link_topology # The whole test suite (each test case within) doesn't require any links. @requires_link_topology(LinkTopology.NO_LINK) @@ -33,7 +33,7 @@ def hello_world_single_core(self): .. code:: python - from framework.test_suite import TestSuite, func_test + from api.test_suite import TestSuite, func_test from api.testbed_model.capability import NicCapability, requires_nic_capability class TestPmdBufferScatter(TestSuite): # only the test case requires the SCATTERED_RX_ENABLED capability @@ -47,7 +47,7 @@ def test_scatter_mbuf_2048(self): from typing import TYPE_CHECKING, Callable if TYPE_CHECKING: - from framework.test_suite import TestProtocol + from api.test_suite import TestProtocol class LinkTopology(IntEnum): diff --git a/dts/api/context.py b/dts/api/context.py index 57e14ef598..753b2101a0 100644 --- a/dts/api/context.py +++ b/dts/api/context.py @@ -16,10 +16,10 @@ from framework.settings import SETTINGS if TYPE_CHECKING: + from api.test_suite import TestCase, TestSuite from api.testbed_model.capability import TestProtocol from api.testbed_model.traffic_generator.traffic_generator import TrafficGenerator from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment - from framework.test_suite import TestCase, TestSuite P = ParamSpec("P") diff --git a/dts/api/packet.py b/dts/api/packet.py index defbb758c8..58f47f1646 100644 --- a/dts/api/packet.py +++ b/dts/api/packet.py @@ -175,7 +175,7 @@ def adjust_addresses(packets: list[Packet], expected: bool = False) -> list[Pack Raises: InternalError: If no tests are running. """ - from framework.test_suite import TestSuite + from api.test_suite import TestSuite if get_ctx().local.current_test_suite is None: raise InternalError("No current test suite, tests aren't running?") diff --git a/dts/framework/test_suite.py b/dts/api/test_suite.py similarity index 99% rename from dts/framework/test_suite.py rename to dts/api/test_suite.py index 786cfc7bff..0822f9bfe5 100644 --- a/dts/framework/test_suite.py +++ b/dts/api/test_suite.py @@ -34,8 +34,7 @@ from api.testbed_model.topology import Topology from api.utils import to_pascal_case from framework.config.common import FrozenModel - -from .logger import DTSLogger, get_dts_logger +from framework.logger import DTSLogger, get_dts_logger if TYPE_CHECKING: from api.context import Context diff --git a/dts/api/testbed_model/capability.py b/dts/api/testbed_model/capability.py index 2748daa8a4..bb581d4ab7 100644 --- a/dts/api/testbed_model/capability.py +++ b/dts/api/testbed_model/capability.py @@ -25,7 +25,7 @@ Examples: .. code:: python - from framework.test_suite import TestSuite, func_test + from api.test_suite import TestSuite, func_test from api.testbed_model.capability import LinkTopology, requires # The whole test suite (each test case within) doesn't require any links. @requires_link_topology(LinkTopology.NO_LINK) @@ -36,7 +36,7 @@ def hello_world_single_core(self): .. code:: python - from framework.test_suite import TestSuite, func_test + from api.test_suite import TestSuite, func_test from api.testbed_model.capability import NicCapability, requires class TestPmdBufferScatter(TestSuite): # only the test case requires the SCATTERED_RX_ENABLED capability @@ -71,8 +71,8 @@ def test_scatter_mbuf_2048(self): from framework.logger import get_dts_logger if TYPE_CHECKING: + from api.test_suite import TestCase from api.testpmd import TestPmd - from framework.test_suite import TestCase P = ParamSpec("P") TestPmdMethod = Callable[Concatenate["TestPmd", P], Any] diff --git a/dts/framework/config/__init__.py b/dts/framework/config/__init__.py index e24a351ecf..c8edf340bd 100644 --- a/dts/framework/config/__init__.py +++ b/dts/framework/config/__init__.py @@ -43,7 +43,7 @@ # Import only if type checking or building docs, to prevent circular imports. if TYPE_CHECKING: - from framework.test_suite import BaseConfig + from api.test_suite import BaseConfig NodesConfig = Annotated[list[NodeConfiguration], Field(min_length=1)] @@ -184,7 +184,7 @@ def load_config(ctx: ValidationContext) -> Configuration: nodes = _load_and_parse_model(ctx["settings"].nodes_config_path, NodesConfig, ctx) try: - from framework.test_suite import BaseConfig as BaseConfig + from api.test_suite import BaseConfig as BaseConfig Configuration.model_rebuild() return Configuration.model_validate( diff --git a/dts/framework/config/test_run.py b/dts/framework/config/test_run.py index b87c7b2d19..40fce48bf9 100644 --- a/dts/framework/config/test_run.py +++ b/dts/framework/config/test_run.py @@ -33,7 +33,7 @@ from .common import FrozenModel, load_fields_from_settings if TYPE_CHECKING: - from framework.test_suite import BaseConfig, TestCase, TestSuite, TestSuiteSpec + from api.test_suite import BaseConfig, TestCase, TestSuite, TestSuiteSpec @unique @@ -230,7 +230,7 @@ class TestSuiteConfig(FrozenModel): @cached_property def test_suite_spec(self) -> "TestSuiteSpec": """The specification of the requested test suite.""" - from framework.test_suite import find_by_name + from api.test_suite import find_by_name test_suite_spec = find_by_name(self.test_suite_name) assert test_suite_spec is not None, ( @@ -280,7 +280,7 @@ def fetch_all_test_suites() -> list[TestSuiteConfig]: This function does not include the smoke tests. """ - from framework.test_suite import AVAILABLE_TEST_SUITES + from api.test_suite import AVAILABLE_TEST_SUITES return [ TestSuiteConfig(test_suite=test_suite.name) @@ -506,7 +506,7 @@ def filter_tests( self, tests_config: dict[str, "BaseConfig"] ) -> Iterable[tuple[type["TestSuite"], "BaseConfig", deque[type["TestCase"]]]]: """Filter test suites and cases selected for execution.""" - from framework.test_suite import TestCaseType + from api.test_suite import TestCaseType test_suites = [TestSuiteConfig(test_suite="smoke_tests")] diff --git a/dts/framework/test_run.py b/dts/framework/test_run.py index 42a56d38c9..dfbdd0b5b5 100644 --- a/dts/framework/test_run.py +++ b/dts/framework/test_run.py @@ -110,6 +110,7 @@ from api.capabilities import LinkTopology from api.context import Context, init_ctx from api.exception import InternalError, SkippedTestException, TestCaseVerifyError +from api.test_suite import BaseConfig, TestCase, TestCaseType, TestSuite from api.testbed_model.capability import ( Capability, get_supported_capabilities, @@ -123,7 +124,6 @@ from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment from framework.settings import SETTINGS from framework.test_result import Result, ResultNode, TestRunResult -from framework.test_suite import BaseConfig, TestCase, TestCaseType, TestSuite TestScenario = tuple[type[TestSuite], BaseConfig, deque[type[TestCase]]] diff --git a/dts/tests/TestSuite_blocklist.py b/dts/tests/TestSuite_blocklist.py index 97e03b8fb7..31e69c0de9 100644 --- a/dts/tests/TestSuite_blocklist.py +++ b/dts/tests/TestSuite_blocklist.py @@ -11,9 +11,9 @@ requires_link_topology, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testbed_model.port import Port from api.testpmd import TestPmd -from framework.test_suite import TestSuite, func_test class TestBlocklist(TestSuite): diff --git a/dts/tests/TestSuite_buffer_scatter.py b/dts/tests/TestSuite_buffer_scatter.py index 539082f2e4..cd1a52ad5e 100644 --- a/dts/tests/TestSuite_buffer_scatter.py +++ b/dts/tests/TestSuite_buffer_scatter.py @@ -28,9 +28,9 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_checksum_offload.py b/dts/tests/TestSuite_checksum_offload.py index 90ca798e56..a2ea13991b 100644 --- a/dts/tests/TestSuite_checksum_offload.py +++ b/dts/tests/TestSuite_checksum_offload.py @@ -25,10 +25,10 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import ChecksumOffloadOptions, PacketOffloadFlag -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PORT_RX_OFFLOAD_IPV4_CKSUM) diff --git a/dts/tests/TestSuite_cryptodev_latency.py b/dts/tests/TestSuite_cryptodev_latency.py index 981c483a14..444a5b282c 100644 --- a/dts/tests/TestSuite_cryptodev_latency.py +++ b/dts/tests/TestSuite_cryptodev_latency.py @@ -31,8 +31,8 @@ CryptodevResults, ) from api.test import skip, verify +from api.test_suite import BaseConfig, TestSuite, crypto_test from api.testbed_model.virtual_device import VirtualDevice -from framework.test_suite import BaseConfig, TestSuite, crypto_test config_list: list[dict[str, int | float | str]] = [ {"buff_size": 64, "avg_cycles": 99_999.00, "avg_time_us": 9999.0}, diff --git a/dts/tests/TestSuite_cryptodev_throughput.py b/dts/tests/TestSuite_cryptodev_throughput.py index b861c52bae..59f64f2cd7 100644 --- a/dts/tests/TestSuite_cryptodev_throughput.py +++ b/dts/tests/TestSuite_cryptodev_throughput.py @@ -31,8 +31,8 @@ CryptodevResults, ) from api.test import skip, verify +from api.test_suite import BaseConfig, TestSuite, crypto_test from api.testbed_model.virtual_device import VirtualDevice -from framework.test_suite import BaseConfig, TestSuite, crypto_test config_list: list[dict[str, int | float | str]] = [ {"buff_size": 64, "Gbps": 1.00}, diff --git a/dts/tests/TestSuite_dual_vlan.py b/dts/tests/TestSuite_dual_vlan.py index 1b77dd2b47..f3347a6d52 100644 --- a/dts/tests/TestSuite_dual_vlan.py +++ b/dts/tests/TestSuite_dual_vlan.py @@ -21,9 +21,9 @@ from api.capabilities import LinkTopology, requires_link_topology from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test class TestDualVlan(TestSuite): diff --git a/dts/tests/TestSuite_dynamic_config.py b/dts/tests/TestSuite_dynamic_config.py index 7204ec4f73..b9e2c30da1 100644 --- a/dts/tests/TestSuite_dynamic_config.py +++ b/dts/tests/TestSuite_dynamic_config.py @@ -27,9 +27,9 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_dynamic_queue_conf.py b/dts/tests/TestSuite_dynamic_queue_conf.py index b62efa2b42..24584c7d60 100644 --- a/dts/tests/TestSuite_dynamic_queue_conf.py +++ b/dts/tests/TestSuite_dynamic_queue_conf.py @@ -38,9 +38,9 @@ from api.exception import InteractiveCommandExecutionError from api.packet import send_packets from api.test import fail, verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import PortTopology, SimpleForwardingModes -from framework.test_suite import TestSuite, func_test def setup_and_teardown_test( diff --git a/dts/tests/TestSuite_flow_offload.py b/dts/tests/TestSuite_flow_offload.py index 5902406a8e..09384b1983 100644 --- a/dts/tests/TestSuite_flow_offload.py +++ b/dts/tests/TestSuite_flow_offload.py @@ -28,9 +28,9 @@ ) from api.packet import send_packet_and_capture from api.test import fail, log, verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.types import FlowRule -from framework.test_suite import TestSuite, func_test @dataclass diff --git a/dts/tests/TestSuite_hello_world.py b/dts/tests/TestSuite_hello_world.py index bf1a93c782..cd62eb8f3e 100644 --- a/dts/tests/TestSuite_hello_world.py +++ b/dts/tests/TestSuite_hello_world.py @@ -9,8 +9,8 @@ """ from api.test import log +from api.test_suite import BaseConfig, TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import BaseConfig, TestSuite, func_test class Config(BaseConfig): diff --git a/dts/tests/TestSuite_l2fwd.py b/dts/tests/TestSuite_l2fwd.py index 5650366c36..f237821a04 100644 --- a/dts/tests/TestSuite_l2fwd.py +++ b/dts/tests/TestSuite_l2fwd.py @@ -19,11 +19,11 @@ match_all_packets, send_packets_and_capture, ) +from api.test_suite import TestSuite, func_test from api.testbed_model.cpu import LogicalCoreCount from api.testpmd import TestPmd from api.testpmd.config import EthPeer, SimpleForwardingModes from api.utils import generate_random_packets -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_mac_filter.py b/dts/tests/TestSuite_mac_filter.py index b44822d31c..eb1413f336 100644 --- a/dts/tests/TestSuite_mac_filter.py +++ b/dts/tests/TestSuite_mac_filter.py @@ -26,8 +26,8 @@ from api.exception import InteractiveCommandExecutionError from api.packet import send_packet_and_capture from api.test import fail, verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_mtu.py b/dts/tests/TestSuite_mtu.py index 8355495d33..c264db299e 100644 --- a/dts/tests/TestSuite_mtu.py +++ b/dts/tests/TestSuite_mtu.py @@ -23,8 +23,8 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import TestSuite, func_test STANDARD_FRAME = 1518 # --max-pkt-len will subtract l2 information at a minimum of 18 bytes. JUMBO_FRAME = 9018 diff --git a/dts/tests/TestSuite_packet_capture.py b/dts/tests/TestSuite_packet_capture.py index 042b7019aa..fd5cef5268 100644 --- a/dts/tests/TestSuite_packet_capture.py +++ b/dts/tests/TestSuite_packet_capture.py @@ -36,6 +36,7 @@ send_packets_and_capture, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testbed_model.cpu import LogicalCoreList from api.testbed_model.traffic_generator.capturing_traffic_generator import ( PacketFilteringConfig, @@ -44,7 +45,6 @@ from framework.params import Params from framework.remote_session.blocking_app import BlockingApp from framework.remote_session.dpdk_shell import compute_eal_params -from framework.test_suite import TestSuite, func_test @dataclass(kw_only=True) diff --git a/dts/tests/TestSuite_port_control.py b/dts/tests/TestSuite_port_control.py index b51fdc2959..c2f2de3493 100644 --- a/dts/tests/TestSuite_port_control.py +++ b/dts/tests/TestSuite_port_control.py @@ -18,9 +18,9 @@ ) from api.packet import send_packets_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_port_restart_config_persistency.py b/dts/tests/TestSuite_port_restart_config_persistency.py index 4ea22b6d70..88df35d33c 100644 --- a/dts/tests/TestSuite_port_restart_config_persistency.py +++ b/dts/tests/TestSuite_port_restart_config_persistency.py @@ -14,9 +14,9 @@ requires_nic_capability, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.types import TestPmdPortFlowCtrl -from framework.test_suite import TestSuite, func_test ALTERNATIVE_MTU: int = 800 STANDARD_MTU: int = 1500 diff --git a/dts/tests/TestSuite_port_stats.py b/dts/tests/TestSuite_port_stats.py index 3dc045f847..0328c6718c 100644 --- a/dts/tests/TestSuite_port_stats.py +++ b/dts/tests/TestSuite_port_stats.py @@ -25,10 +25,10 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import RtePTypes, TestPmdVerbosePacket -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_promisc_support.py b/dts/tests/TestSuite_promisc_support.py index a0c65dc662..c59c8c6078 100644 --- a/dts/tests/TestSuite_promisc_support.py +++ b/dts/tests/TestSuite_promisc_support.py @@ -21,8 +21,8 @@ send_packets_and_capture, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_qinq.py b/dts/tests/TestSuite_qinq.py index 505d71dbc8..5dde37d4db 100644 --- a/dts/tests/TestSuite_qinq.py +++ b/dts/tests/TestSuite_qinq.py @@ -18,8 +18,8 @@ from api.capabilities import NicCapability, requires_nic_capability from api.packet import send_packet_and_capture from api.test import log, verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import TestSuite, func_test class TestQinq(TestSuite): diff --git a/dts/tests/TestSuite_queue_toggle.py b/dts/tests/TestSuite_queue_toggle.py index e4edc89123..a9ea356b22 100644 --- a/dts/tests/TestSuite_queue_toggle.py +++ b/dts/tests/TestSuite_queue_toggle.py @@ -24,9 +24,9 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test @requires_link_topology(LinkTopology.TWO_LINKS) diff --git a/dts/tests/TestSuite_rss.py b/dts/tests/TestSuite_rss.py index 1e60bdba07..b538e93af9 100644 --- a/dts/tests/TestSuite_rss.py +++ b/dts/tests/TestSuite_rss.py @@ -23,6 +23,7 @@ from api.exception import InteractiveCommandExecutionError from api.packet import send_packets_and_capture from api.test import verify +from api.test_suite import BaseConfig, TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import ( @@ -31,7 +32,6 @@ TestPmdVerbosePacket, ) from api.utils import StrEnum -from framework.test_suite import BaseConfig, TestSuite, func_test class Config(BaseConfig): diff --git a/dts/tests/TestSuite_rx_split.py b/dts/tests/TestSuite_rx_split.py index 470e48d0d3..3b3e4cd620 100644 --- a/dts/tests/TestSuite_rx_split.py +++ b/dts/tests/TestSuite_rx_split.py @@ -21,10 +21,10 @@ from api.exception import InteractiveCommandExecutionError from api.packet import adjust_addresses, send_packet_and_capture from api.test import fail, verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import RxOffloadCapability, TxOffloadCapability -from framework.test_suite import TestSuite, func_test PAYLOAD = bytes(range(256)) ETHER_HDR_LEN = len(Ether(dst="00:00:00:00:00:00")) diff --git a/dts/tests/TestSuite_rx_tx_offload.py b/dts/tests/TestSuite_rx_tx_offload.py index b0da627d3c..c8d24baaae 100644 --- a/dts/tests/TestSuite_rx_tx_offload.py +++ b/dts/tests/TestSuite_rx_tx_offload.py @@ -13,12 +13,12 @@ requires_nic_capability, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.types import ( OffloadConfiguration, RxTxLiteralSwitch, ) -from framework.test_suite import TestSuite, func_test @requires_link_topology(LinkTopology.ONE_LINK) diff --git a/dts/tests/TestSuite_single_core_forward_perf.py b/dts/tests/TestSuite_single_core_forward_perf.py index 57aecdf7a4..f51ff76c4c 100644 --- a/dts/tests/TestSuite_single_core_forward_perf.py +++ b/dts/tests/TestSuite_single_core_forward_perf.py @@ -22,10 +22,10 @@ ) from api.packet import assess_performance_by_packet from api.test import verify, write_performance_json +from api.test_suite import BaseConfig, TestSuite, perf_test from api.testpmd import TestPmd from api.testpmd.config import RXRingParams, TXRingParams from framework.params.types import TestPmdParamsDict -from framework.test_suite import BaseConfig, TestSuite, perf_test class Config(BaseConfig): diff --git a/dts/tests/TestSuite_smoke_tests.py b/dts/tests/TestSuite_smoke_tests.py index 656e2e4bb7..b3eb325fc0 100644 --- a/dts/tests/TestSuite_smoke_tests.py +++ b/dts/tests/TestSuite_smoke_tests.py @@ -19,12 +19,12 @@ requires_link_topology, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testbed_model.linux_session import LinuxSession from api.testpmd import TestPmd from api.utils import REGEX_FOR_PCI_ADDRESS from framework.config.node import PortConfig from framework.settings import SETTINGS -from framework.test_suite import TestSuite, func_test @requires_link_topology(LinkTopology.NO_LINK) diff --git a/dts/tests/TestSuite_softnic.py b/dts/tests/TestSuite_softnic.py index 91a6d4eb9f..05a6d3aa18 100644 --- a/dts/tests/TestSuite_softnic.py +++ b/dts/tests/TestSuite_softnic.py @@ -18,11 +18,11 @@ match_all_packets, send_packets_and_capture, ) +from api.test_suite import TestSuite, func_test from api.testbed_model.virtual_device import VirtualDevice from api.testpmd import TestPmd from api.testpmd.config import EthPeer from api.utils import generate_random_packets -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_speed_capabilities.py b/dts/tests/TestSuite_speed_capabilities.py index 9cbd6f1ef7..c9b0f74feb 100644 --- a/dts/tests/TestSuite_speed_capabilities.py +++ b/dts/tests/TestSuite_speed_capabilities.py @@ -13,8 +13,8 @@ requires_link_topology, ) from api.test import verify +from api.test_suite import BaseConfig, TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import BaseConfig, TestSuite, func_test class Config(BaseConfig): diff --git a/dts/tests/TestSuite_unified_packet.py b/dts/tests/TestSuite_unified_packet.py index fcc7f7fbbb..bf3654f0d7 100644 --- a/dts/tests/TestSuite_unified_packet.py +++ b/dts/tests/TestSuite_unified_packet.py @@ -25,10 +25,10 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import RtePTypes, TestPmdVerbosePacket -from framework.test_suite import TestSuite, func_test class TestUnifiedPacket(TestSuite): diff --git a/dts/tests/TestSuite_virtio_forward.py b/dts/tests/TestSuite_virtio_forward.py index 06bcd86ee4..a16299d908 100644 --- a/dts/tests/TestSuite_virtio_forward.py +++ b/dts/tests/TestSuite_virtio_forward.py @@ -12,12 +12,12 @@ from api.capabilities import LinkTopology from api.packet import send_packets_and_capture from api.test import log, verify +from api.test_suite import TestSuite, func_test from api.testbed_model.capability import requires from api.testbed_model.linux_session import LinuxSession from api.testbed_model.virtual_device import VirtualDevice from api.testpmd import TestPmd from api.testpmd.config import PortTopology, SimpleForwardingModes -from framework.test_suite import TestSuite, func_test class TestVirtioForward(TestSuite): diff --git a/dts/tests/TestSuite_vlan.py b/dts/tests/TestSuite_vlan.py index 898673fc86..975e87b128 100644 --- a/dts/tests/TestSuite_vlan.py +++ b/dts/tests/TestSuite_vlan.py @@ -23,9 +23,9 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PORT_RX_OFFLOAD_VLAN_FILTER) -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* [PATCH v5 6/7] dts: move params directory from framework to API 2026-08-06 13:53 [PATCH v5 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (4 preceding siblings ...) 2026-08-06 13:53 ` [PATCH v5 5/7] dts: move test suite module " Andrew Bailey @ 2026-08-06 13:53 ` Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 7/7] dts: separate Linux session into interface and logic Andrew Bailey ` (3 subsequent siblings) 9 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 13:53 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx The params directory is imported in test suites such as packet capture to use as a base class for dumpcap. Move this to the API. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- .../{framework.params.eal.rst => api.params.eal.rst} | 2 +- doc/api/dts/{framework.params.rst => api.params.rst} | 6 +++--- ...framework.params.types.rst => api.params.types.rst} | 2 +- doc/api/dts/index.rst | 2 +- dts/api/cryptodev/__init__.py | 2 +- dts/api/cryptodev/config.py | 4 ++-- dts/{framework => api}/params/__init__.py | 0 dts/{framework => api}/params/eal.py | 2 +- dts/{framework => api}/params/types.py | 10 +++++++--- dts/api/testpmd/__init__.py | 7 ++++++- dts/api/testpmd/config.py | 6 +++--- dts/framework/remote_session/blocking_app.py | 4 ++-- dts/framework/remote_session/dpdk.py | 2 +- dts/framework/remote_session/dpdk_shell.py | 2 +- dts/framework/remote_session/interactive_shell.py | 2 +- dts/tests/TestSuite_packet_capture.py | 2 +- dts/tests/TestSuite_single_core_forward_perf.py | 2 +- 17 files changed, 33 insertions(+), 24 deletions(-) rename doc/api/dts/{framework.params.eal.rst => api.params.eal.rst} (79%) rename doc/api/dts/{framework.params.rst => api.params.rst} (71%) rename doc/api/dts/{framework.params.types.rst => api.params.types.rst} (80%) rename dts/{framework => api}/params/__init__.py (100%) rename dts/{framework => api}/params/eal.py (97%) rename dts/{framework => api}/params/types.py (96%) diff --git a/doc/api/dts/framework.params.eal.rst b/doc/api/dts/api.params.eal.rst similarity index 79% rename from doc/api/dts/framework.params.eal.rst rename to doc/api/dts/api.params.eal.rst index 6999b00233..4531cb1fe1 100644 --- a/doc/api/dts/framework.params.eal.rst +++ b/doc/api/dts/api.params.eal.rst @@ -3,6 +3,6 @@ eal - EAL Parameters Modelling ============================== -.. automodule:: framework.params.eal +.. automodule:: api.params.eal :members: :show-inheritance: diff --git a/doc/api/dts/framework.params.rst b/doc/api/dts/api.params.rst similarity index 71% rename from doc/api/dts/framework.params.rst rename to doc/api/dts/api.params.rst index d8c6af9667..3ea7f9215e 100644 --- a/doc/api/dts/framework.params.rst +++ b/doc/api/dts/api.params.rst @@ -3,7 +3,7 @@ params - Command Line Parameters Modelling ========================================== -.. automodule:: framework.params +.. automodule:: api.params :members: :show-inheritance: @@ -11,5 +11,5 @@ params - Command Line Parameters Modelling :hidden: :maxdepth: 1 - framework.params.eal - framework.params.types + api.params.eal + api.params.types diff --git a/doc/api/dts/framework.params.types.rst b/doc/api/dts/api.params.types.rst similarity index 80% rename from doc/api/dts/framework.params.types.rst rename to doc/api/dts/api.params.types.rst index 6d609038be..4754b3a665 100644 --- a/doc/api/dts/framework.params.types.rst +++ b/doc/api/dts/api.params.types.rst @@ -3,6 +3,6 @@ params.types - Parameters Modelling Types ========================================= -.. automodule:: framework.params.types +.. automodule:: api.params.types :members: :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index 7c282bbba1..e89e782ac0 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -18,7 +18,7 @@ Packages api api.testbed_model framework.remote_session - framework.params + api.params framework.config Modules diff --git a/dts/api/cryptodev/__init__.py b/dts/api/cryptodev/__init__.py index 198607696f..496079c2af 100644 --- a/dts/api/cryptodev/__init__.py +++ b/dts/api/cryptodev/__init__.py @@ -27,7 +27,7 @@ from framework.remote_session.dpdk_shell import compute_eal_params if TYPE_CHECKING: - from framework.params.types import CryptoPmdParamsDict + from api.params.types import CryptoPmdParamsDict from pathlib import PurePath diff --git a/dts/api/cryptodev/config.py b/dts/api/cryptodev/config.py index a88e70d45c..3420c2fe91 100644 --- a/dts/api/cryptodev/config.py +++ b/dts/api/cryptodev/config.py @@ -6,9 +6,9 @@ from enum import auto from typing import Literal +from api.params import Params, Switch +from api.params.eal import EalParams from api.utils import StrEnum -from framework.params import Params, Switch -from framework.params.eal import EalParams Silent = Literal[""] diff --git a/dts/framework/params/__init__.py b/dts/api/params/__init__.py similarity index 100% rename from dts/framework/params/__init__.py rename to dts/api/params/__init__.py diff --git a/dts/framework/params/eal.py b/dts/api/params/eal.py similarity index 97% rename from dts/framework/params/eal.py rename to dts/api/params/eal.py index 86bfd3fcc6..64fa45ae12 100644 --- a/dts/framework/params/eal.py +++ b/dts/api/params/eal.py @@ -6,9 +6,9 @@ from dataclasses import dataclass, field from typing import TYPE_CHECKING, Literal +from api.params import Params, Switch from api.testbed_model.cpu import LogicalCoreList from api.testbed_model.virtual_device import VirtualDevice -from framework.params import Params, Switch if TYPE_CHECKING: from api.testbed_model.port import Port diff --git a/dts/framework/params/types.py b/dts/api/params/types.py similarity index 96% rename from dts/framework/params/types.py rename to dts/api/params/types.py index f9a51963a2..c4b718eebe 100644 --- a/dts/framework/params/types.py +++ b/dts/api/params/types.py @@ -12,8 +12,10 @@ def create_testpmd(**kwargs: Unpack[TestPmdParamsDict]): params = TestPmdParams(**kwargs) """ +from __future__ import annotations + from pathlib import PurePath -from typing import TypedDict +from typing import TYPE_CHECKING, TypedDict from api.cryptodev.config import ( AeadAlgName, @@ -56,8 +58,10 @@ def create_testpmd(**kwargs: Unpack[TestPmdParamsDict]): TXRingParams, TxUDPPortPair, ) -from api.testpmd.types import RxOffloadCapability, TxOffloadCapability -from framework.params import Switch, YesNoSwitch + +if TYPE_CHECKING: + from api.testpmd.types import RxOffloadCapability, TxOffloadCapability +from api.params import Switch, YesNoSwitch class EalParamsDict(TypedDict, total=False): diff --git a/dts/api/testpmd/__init__.py b/dts/api/testpmd/__init__.py index ce41408eb6..33504640e3 100644 --- a/dts/api/testpmd/__init__.py +++ b/dts/api/testpmd/__init__.py @@ -14,6 +14,8 @@ testpmd.close() """ +from __future__ import annotations + import functools import re import time @@ -21,6 +23,7 @@ from enum import Flag from pathlib import PurePath from typing import ( + TYPE_CHECKING, Any, Callable, ClassVar, @@ -56,7 +59,9 @@ TxOffloadConfiguration, VLANOffloadFlag, ) -from framework.params.types import TestPmdParamsDict + +if TYPE_CHECKING: + from api.params.types import TestPmdParamsDict from framework.remote_session.dpdk_shell import DPDKShell from framework.remote_session.interactive_shell import only_active from framework.settings import SETTINGS diff --git a/dts/api/testpmd/config.py b/dts/api/testpmd/config.py index 3850a4eb8a..c72c1b2c90 100644 --- a/dts/api/testpmd/config.py +++ b/dts/api/testpmd/config.py @@ -13,8 +13,7 @@ from pathlib import PurePath from typing import Literal, NamedTuple -from api.utils import StrEnum -from framework.params import ( +from api.params import ( Params, Switch, YesNoSwitch, @@ -25,7 +24,8 @@ modify_str, str_from_flag_value, ) -from framework.params.eal import EalParams +from api.params.eal import EalParams +from api.utils import StrEnum from .types import RxOffloadCapability, TxOffloadCapability diff --git a/dts/framework/remote_session/blocking_app.py b/dts/framework/remote_session/blocking_app.py index 84db3974b1..537d937eca 100644 --- a/dts/framework/remote_session/blocking_app.py +++ b/dts/framework/remote_session/blocking_app.py @@ -31,9 +31,9 @@ from typing_extensions import Self from api.context import get_ctx +from api.params import Params +from api.params.eal import EalParams from api.testbed_model.node import Node -from framework.params import Params -from framework.params.eal import EalParams from framework.remote_session.dpdk_shell import compute_eal_params from framework.remote_session.interactive_shell import InteractiveShell diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index c02c68af77..4de61ece68 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -16,6 +16,7 @@ from api.capabilities import LinkTopology from api.context import get_ctx from api.exception import ConfigurationError, RemoteFileNotFoundError +from api.params.eal import EalParams from api.testbed_model.cpu import LogicalCore, LogicalCoreCount, LogicalCoreList, lcore_filter from api.testbed_model.node import Node from api.testbed_model.os_session import OSSession @@ -33,7 +34,6 @@ RemoteDPDKTreeLocation, ) from framework.logger import DTSLogger, get_dts_logger -from framework.params.eal import EalParams from framework.remote_session.remote_session import CommandResult diff --git a/dts/framework/remote_session/dpdk_shell.py b/dts/framework/remote_session/dpdk_shell.py index b807f9bdae..61cc4687f3 100644 --- a/dts/framework/remote_session/dpdk_shell.py +++ b/dts/framework/remote_session/dpdk_shell.py @@ -11,8 +11,8 @@ from pathlib import PurePath from api.context import get_ctx +from api.params.eal import EalParams from api.testbed_model.cpu import LogicalCoreList -from framework.params.eal import EalParams from framework.remote_session.interactive_shell import ( InteractiveShell, only_active, diff --git a/dts/framework/remote_session/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index 831861a9ac..f9b7a7720d 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -35,9 +35,9 @@ InteractiveSSHSessionDeadError, InteractiveSSHTimeoutError, ) +from api.params import Params from api.testbed_model.node import Node from framework.logger import DTSLogger, get_dts_logger -from framework.params import Params from framework.settings import SETTINGS P = ParamSpec("P") diff --git a/dts/tests/TestSuite_packet_capture.py b/dts/tests/TestSuite_packet_capture.py index fd5cef5268..ba67c9e1c6 100644 --- a/dts/tests/TestSuite_packet_capture.py +++ b/dts/tests/TestSuite_packet_capture.py @@ -35,6 +35,7 @@ match_all_packets, send_packets_and_capture, ) +from api.params import Params from api.test import verify from api.test_suite import TestSuite, func_test from api.testbed_model.cpu import LogicalCoreList @@ -42,7 +43,6 @@ PacketFilteringConfig, ) from api.testpmd import TestPmd -from framework.params import Params from framework.remote_session.blocking_app import BlockingApp from framework.remote_session.dpdk_shell import compute_eal_params diff --git a/dts/tests/TestSuite_single_core_forward_perf.py b/dts/tests/TestSuite_single_core_forward_perf.py index f51ff76c4c..4b22c5d091 100644 --- a/dts/tests/TestSuite_single_core_forward_perf.py +++ b/dts/tests/TestSuite_single_core_forward_perf.py @@ -21,11 +21,11 @@ requires_link_topology, ) from api.packet import assess_performance_by_packet +from api.params.types import TestPmdParamsDict from api.test import verify, write_performance_json from api.test_suite import BaseConfig, TestSuite, perf_test from api.testpmd import TestPmd from api.testpmd.config import RXRingParams, TXRingParams -from framework.params.types import TestPmdParamsDict class Config(BaseConfig): -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* [PATCH v5 7/7] dts: separate Linux session into interface and logic 2026-08-06 13:53 [PATCH v5 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (5 preceding siblings ...) 2026-08-06 13:53 ` [PATCH v5 6/7] dts: move params directory " Andrew Bailey @ 2026-08-06 13:53 ` Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (2 subsequent siblings) 9 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 13:53 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx Separate Linux session into an interface for the API, and a logical module in the framework. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- doc/api/dts/index.rst | 1 + dts/api/testbed_model/linux_session.py | 453 +------------------------ dts/api/testbed_model/node.py | 2 +- 3 files changed, 20 insertions(+), 436 deletions(-) diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index e89e782ac0..14d12eb038 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -35,6 +35,7 @@ Modules api.context framework.logger framework.parser + framework.linux_session api.utils api.exception diff --git a/dts/api/testbed_model/linux_session.py b/dts/api/testbed_model/linux_session.py index 399968efd4..a0b61b67df 100644 --- a/dts/api/testbed_model/linux_session.py +++ b/dts/api/testbed_model/linux_session.py @@ -9,454 +9,37 @@ This intermediate module implements the common parts of mostly POSIX compliant distributions. """ -import json -import re -from collections.abc import Iterable -from functools import cached_property +from abc import abstractmethod from pathlib import PurePath -from typing import TypedDict -from typing_extensions import NotRequired - -from api.exception import ( - ConfigurationError, - InternalError, - RemoteCommandExecutionError, -) -from api.testbed_model.port import PortInfo -from api.utils import expand_range - -from .cpu import LogicalCore -from .port import Port from .posix_session import PosixSession -class LshwConfigurationOutput(TypedDict): - """The relevant parts of ``lshw``'s ``configuration`` section.""" - - #: - driver: str - #: - link: str - #: - firmware: str - - -class LshwOutput(TypedDict): - """A model of the relevant information from ``lshw``'s json output. - - Example: - :: - - { - ... - "businfo" : "pci@0000:08:00.0", - "logicalname" : "enp8s0", - "version" : "00", - "serial" : "52:54:00:59:e1:ac", - ... - "configuration" : { - ... - "link" : "yes", - ... - }, - ... - """ - - #: - vendor: NotRequired[str] - #: - product: NotRequired[str] - #: - version: NotRequired[str] - #: - businfo: str - #: - logicalname: NotRequired[str] - #: - serial: NotRequired[str] - #: - configuration: LshwConfigurationOutput - - class LinuxSession(PosixSession): """The implementation of non-Posix compliant parts of Linux.""" - @staticmethod - def _get_privileged_command(command: str) -> str: - command = command.replace(r"'", r"\'") - return f"sudo -- sh -c '{command}'" - - def get_remote_cpus(self) -> list[LogicalCore]: - """Overrides :meth:`~.os_session.OSSession.get_remote_cpus`.""" - cpu_info = self.send_command("lscpu -p=CPU,CORE,SOCKET,NODE|grep -v \\#").stdout - lcores = [] - for cpu_line in cpu_info.splitlines(): - lcore, core, socket, node = map(int, cpu_line.split(",")) - lcores.append(LogicalCore(lcore, core, socket, node)) - return lcores - - def get_dpdk_file_prefix(self, dpdk_prefix: str) -> str: - """Overrides :meth:`~.os_session.OSSession.get_dpdk_file_prefix`.""" - return dpdk_prefix - - def setup_hugepages(self, number_of: int, hugepage_size: int, force_first_numa: bool) -> None: - """Overrides :meth:`~.os_session.OSSession.setup_hugepages`. - - Raises: - ConfigurationError: If the given `hugepage_size` is not supported by the OS. - """ - self._logger.info("Getting Hugepage information.") - if ( - f"hugepages-{hugepage_size}kB" - not in self.send_command("ls /sys/kernel/mm/hugepages").stdout - ): - raise ConfigurationError("hugepage size not supported by operating system") - hugepages_total = self._get_hugepages_total(hugepage_size) - self._numa_nodes = self._get_numa_nodes() - - if force_first_numa or hugepages_total < number_of: - # when forcing numa, we need to clear existing hugepages regardless - # of size, so they can be moved to the first numa node - self._configure_huge_pages(number_of, hugepage_size, force_first_numa) - else: - self._logger.info("Hugepages already configured.") - self._mount_huge_pages() - - def _get_hugepages_total(self, hugepage_size: int) -> int: - hugepages_total = self.send_command( - f"cat /sys/kernel/mm/hugepages/hugepages-{hugepage_size}kB/nr_hugepages" - ).stdout - return int(hugepages_total) - - def _get_numa_nodes(self) -> list[int]: - try: - numa_count = self.send_command( - "cat /sys/devices/system/node/online", verify=True - ).stdout - numa_range = expand_range(numa_count) - except RemoteCommandExecutionError: - # the file doesn't exist, meaning the node doesn't support numa - numa_range = [] - return numa_range - - def _mount_huge_pages(self) -> None: - self._logger.info("Re-mounting Hugepages.") - hugapge_fs_cmd = "awk '/hugetlbfs/ { print $2 }' /proc/mounts" - self.send_command(f"umount $({hugapge_fs_cmd})", privileged=True) - result = self.send_command(hugapge_fs_cmd) - if result.stdout == "": - remote_mount_path = "/mnt/huge" - self.send_command(f"mkdir -p {remote_mount_path}", privileged=True) - self.send_command(f"mount -t hugetlbfs nodev {remote_mount_path}", privileged=True) - - def _supports_numa(self) -> bool: - # the system supports numa if self._numa_nodes is non-empty and there are more - # than one numa node (in the latter case it may actually support numa, but - # there's no reason to do any numa specific configuration) - return len(self._numa_nodes) > 1 - - def _configure_huge_pages(self, number_of: int, size: int, force_first_numa: bool) -> None: - self._logger.info("Configuring Hugepages.") - hugepage_config_path = f"/sys/kernel/mm/hugepages/hugepages-{size}kB/nr_hugepages" - if force_first_numa and self._supports_numa(): - # clear non-numa hugepages - self.send_command(f"echo 0 | tee {hugepage_config_path}", privileged=True) - hugepage_config_path = ( - f"/sys/devices/system/node/node{self._numa_nodes[0]}/hugepages" - f"/hugepages-{size}kB/nr_hugepages" - ) - - self.send_command(f"echo {number_of} | tee {hugepage_config_path}", privileged=True) - - def get_port_info(self, pci_address: str) -> PortInfo: - """Overrides :meth:`~.os_session.OSSession.get_port_info`. - - Raises: - ConfigurationError: If the port could not be found. - """ - bus_info = f"pci@{pci_address}" - port = next((port for port in self._lshw_net_info if port.get("businfo") == bus_info), None) - if port is None: - raise ConfigurationError(f"Port {pci_address} could not be found on the node.") - - logical_name = port.get("logicalname", "") - mac_address = port.get("serial", "") - - configuration = port.get("configuration", {}) - driver = configuration.get("driver", "") - is_link_up = configuration.get("link", "down") == "up" - - return PortInfo(mac_address, logical_name, driver, is_link_up) - - def unbind_ports(self, ports: list[Port]): - """Overrides :meth:`~.os_session.OSSession.unbind_ports`. - - The :attr:`~.devbind_script_path` property must be setup in order to call this method. - """ - ports_pci_addrs = " ".join(port.pci for port in ports) - - self.send_command( - f"{self.devbind_script_path} -u --force {ports_pci_addrs}", - privileged=True, - verify=True, - ) - - if self._lshw_net_info: - del self._lshw_net_info - - def get_nic_info(self) -> list[dict[str, str]]: - """Overrides :meth`~.os_session.OSSession.get_nic_info`. - - Raises: - ConfigurationError: If the NIC info could not be found. - """ - port_to_data = { - port.get("businfo"): port for port in self._lshw_net_info if port.get("businfo") - } - - all_nic_info: list[dict[str, str]] = [] - for port in self._config.ports: - pci_addr = port.pci - - lshw_result = self.send_command( - f"sudo lshw -c network -businfo | grep '{pci_addr}' | cut -d'@' -f1" - ) - if lshw_result.return_code != 0 or lshw_result.stdout == "": - raise ConfigurationError(f"Unable to get bus type for port {pci_addr}.") - bus_type = lshw_result.stdout - - bus_info = f"{bus_type}@{pci_addr}" - nic_port: LshwOutput | None = port_to_data[bus_info] - if nic_port is None: - raise ConfigurationError(f"Port {pci_addr} could not be found on the node.") - - config: LshwConfigurationOutput | None = nic_port["configuration"] - if config is None: - raise ConfigurationError( - f"Configuration info for port {pci_addr} could not be found on the node." - ) - - if "logicalname" not in nic_port: - raise ConfigurationError( - f"Logical name for port {pci_addr} could not be found on the node." - ) - - ethtool_result = self.send_command( - f"ethtool {nic_port['logicalname']} | grep 'Speed:' | awk '{{print $2}}'" - ) - if ethtool_result.return_code == 0 and ethtool_result.stdout: - nic_speed = ethtool_result.stdout - else: - self._logger.error(f"Unable to get speed for NIC: {pci_addr}") - nic_speed = None - - dut_json = { - "make": nic_port["vendor"] if "vendor" in nic_port else "Unknown", - "model": nic_port["product"] if "product" in nic_port else "Unknown", - "hardware version": nic_port["version"] if "version" in nic_port else "Unknown", - "firmware version": config["firmware"] if "firmware" in config else "Unknown", - "deviceBusType": bus_type, - "deviceId": nic_port["serial"] if "serial" in nic_port else "Unknown", - "pmd": config["driver"] if "driver" in config else "Unknown", - "speed": nic_speed or "Unknown", - } - all_nic_info.append(dut_json) - - return all_nic_info - - def bind_ports_to_driver(self, ports: list[Port], driver_name: str) -> None: - """Overrides :meth:`~.os_session.OSSession.bind_ports_to_driver`. - - The :attr:`~.devbind_script_path` property must be setup in order to call this method. - """ - ports_pci_addrs = " ".join(port.pci for port in ports) - - self.send_command( - f"{self.devbind_script_path} -b {driver_name} --force {ports_pci_addrs}", - privileged=True, - verify=True, - ) - - del self._lshw_net_info - - def bring_up_link(self, ports: Iterable[Port]) -> None: - """Overrides :meth:`~.os_session.OSSession.bring_up_link`.""" - for port in ports: - self.send_command( - f"ip link set dev {port.logical_name} up", privileged=True, verify=True - ) - - del self._lshw_net_info - + @abstractmethod def set_interface_link_up(self, name: str) -> None: - """Overrides :meth:`~.os_session.OSSession.set_interface_link_up`.""" - self.send_command(f"ip link set dev {name} up", privileged=True, verify=True) - - def delete_interface(self, name: str) -> None: - """Overrides :meth:`~.os_session.OSSession.delete_interface`.""" - self.send_command(f"ip link delete {name}", privileged=True) - - @cached_property - def devbind_script_path(self) -> PurePath: - """The path to the dpdk-devbind.py script on the node. - - Needs to be manually assigned first in order to be used. - - Raises: - InternalError: If accessed before environment setup. - """ - raise InternalError("Accessed devbind script path before setup.") - - def load_vfio(self, pf_port: Port) -> None: - """Overrides :meth:`~os_session.OSSession,load_vfio`.""" - cmd_result = self.send_command(f"lspci -nn -s {pf_port.pci}") - device = re.search(r":([0-9a-fA-F]{4})\]", cmd_result.stdout) - if device and device.group(1) in ["37c8", "0435", "19e2"]: - self.send_command( - "modprobe -r vfio_iommu_type1; modprobe -r vfio_pci", - privileged=True, - ) - self.send_command( - "modprobe -r vfio_virqfd; modprobe -r vfio", - privileged=True, - ) - self.send_command( - "modprobe vfio-pci disable_denylist=1 enable_sriov=1", privileged=True - ) - self.send_command( - "echo 1 | tee /sys/module/vfio/parameters/enable_unsafe_noiommu_mode", - privileged=True, - ) - else: - self.send_command("modprobe vfio-pci", privileged=True) - self.refresh_lshw() - - def create_crypto_vfs(self, pf_port: list[Port]) -> None: - """Overrides :meth:`~os_session.OSSession.create_crypto_vfs`. - - Raises: - InternalError: If there are existing VFs which have to be deleted. - """ - for port in pf_port: - self.delete_crypto_vfs(port) - for port in pf_port: - sys_bus_path = f"/sys/bus/pci/devices/{port.pci}".replace(":", "\\:") - curr_num_vfs = int( - self.send_command(f"cat {sys_bus_path}/sriov_numvfs", privileged=True).stdout - ) - if 0 < curr_num_vfs: - raise InternalError("There are existing VFs on the port which must be deleted.") - num_vfs = int( - self.send_command(f"cat {sys_bus_path}/sriov_totalvfs", privileged=True).stdout - ) - self.send_command( - f"echo {num_vfs} | sudo tee {sys_bus_path}/sriov_numvfs", privileged=True - ) - - self.refresh_lshw() + """Set the link status of an interface to up. - def create_vfs(self, pf_port: Port) -> None: - """Overrides :meth:`~.os_session.OSSession.create_vfs`. - - Raises: - InternalError: If there are existing VFs which have to be deleted. + Args: + name: The name of the interface. """ - sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") - curr_num_vfs = int( - self.send_command(f"cat {sys_bus_path}/sriov_numvfs", privileged=True).stdout - ) - if 0 < curr_num_vfs: - raise InternalError("There are existing VFs on the port which must be deleted.") - if curr_num_vfs == 0: - self.send_command(f"echo 1 | sudo tee {sys_bus_path}/sriov_numvfs", privileged=True) - self.refresh_lshw() - def delete_crypto_vfs(self, pf_port: Port) -> None: - """Overrides :meth:`~.os_session.OSSession.delete_crypto_vfs`. + @abstractmethod + def delete_interface(self, name: str) -> None: + """Delete a virtual interface. - The :attr:`~.devbind_script_path` property must be setup in order to call this method. + Args: + name: the name of the interface to delete. """ - if vfs := self.get_pci_addr_of_crypto_vfs(pf_port): - vf_pci_addrs = " ".join(vf for vf in vfs) - self.send_command( - f"{self.devbind_script_path} -u --force {vf_pci_addrs}", - privileged=True, - verify=True, - ) - self.unbind_ports([pf_port]) - self.send_command( - f"echo 1 | sudo tee /sys/bus/pci/devices/{pf_port.pci}/remove".replace(":", "\\:"), - privileged=True, - ) - self.send_command("echo 1 | sudo tee /sys/bus/pci/rescan", privileged=True) - - def delete_vfs(self, pf_port: Port) -> None: - """Overrides :meth:`~.os_session.OSSession.delete_vfs`.""" - sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") - curr_num_vfs = int( - self.send_command(f"cat {sys_bus_path}/sriov_numvfs", privileged=True).stdout - ) - if curr_num_vfs == 0: - self._logger.debug(f"No VFs found on port {pf_port.pci}, skipping deletion") - else: - self.send_command(f"echo 0 | sudo tee {sys_bus_path}/sriov_numvfs", privileged=True) - - def get_pci_addr_of_crypto_vfs(self, pf_port: Port) -> list[str]: - """Overrides :meth:`~.os_session.OSSession.get_pci_addr_of_crypto_vfs`.""" - sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") - curr_num_vfs = int(self.send_command(f"cat {sys_bus_path}/sriov_numvfs").stdout) - if curr_num_vfs > 0: - pci_addrs = self.send_command( - f"readlink {sys_bus_path}/virtfn*", - privileged=True, - ) - return [pci.replace("../", "") for pci in pci_addrs.stdout.splitlines()] - return [] - - def get_pci_addr_of_vfs(self, pf_port: Port) -> list[str]: - """Overrides :meth:`~.os_session.OSSession.get_pci_addr_of_vfs`.""" - sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") - curr_num_vfs = int(self.send_command(f"cat {sys_bus_path}/sriov_numvfs").stdout) - if curr_num_vfs > 0: - pci_addrs = self.send_command( - 'awk -F "PCI_SLOT_NAME=" "/PCI_SLOT_NAME=/ {print \\$2}" ' - + f"{sys_bus_path}/virtfn*/uevent", - privileged=True, - ) - return pci_addrs.stdout.splitlines() - else: - return [] - @cached_property - def _lshw_net_info(self) -> list[LshwOutput]: - output = self.send_command("lshw -quiet -json -C network", verify=True) - return json.loads(output.stdout) - - def refresh_lshw(self) -> None: - """Force refresh of cached lshw network info.""" - if "_lshw_net_info" in self.__dict__: - del self.__dict__["_lshw_net_info"] - _ = self._lshw_net_info - - def _update_port_attr(self, port: Port, attr_value: str | None, attr_name: str) -> None: - if attr_value: - setattr(port, attr_name, attr_value) - self._logger.debug(f"Found '{attr_name}' of port {port.pci}: '{attr_value}'.") - else: - self._logger.warning( - f"Attempted to get '{attr_name}' of port {port.pci}, but it doesn't exist." - ) - - def configure_port_mtu(self, mtu: int, port: Port) -> None: - """Overrides :meth:`~.os_session.OSSession.configure_port_mtu`.""" - self.send_command( - f"ip link set dev {port.logical_name} mtu {mtu}", - privileged=True, - verify=True, - ) + @property + @abstractmethod + def devbind_script_path(self) -> PurePath: + """The path to the dpdk-devbind.py script on the node.""" - def configure_ipv4_forwarding(self, enable: bool) -> None: - """Overrides :meth:`~.os_session.OSSession.configure_ipv4_forwarding`.""" - state = 1 if enable else 0 - self.send_command(f"sysctl -w net.ipv4.ip_forward={state}", privileged=True) + @devbind_script_path.setter + @abstractmethod + def devbind_script_path(self, value: PurePath): + """Set the devbind script path after environment setup.""" diff --git a/dts/api/testbed_model/node.py b/dts/api/testbed_model/node.py index 40dd7f0666..ae9886e531 100644 --- a/dts/api/testbed_model/node.py +++ b/dts/api/testbed_model/node.py @@ -22,10 +22,10 @@ OS, NodeConfiguration, ) +from framework.linux_session import LinuxSession from framework.logger import DTSLogger, get_dts_logger from .cpu import Architecture, LogicalCore -from .linux_session import LinuxSession from .os_session import OSSession, OSSessionInfo from .port import Port -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* [PATCH v6 0/7] dts: remove imports from framework in test suites 2026-08-06 13:53 [PATCH v5 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (6 preceding siblings ...) 2026-08-06 13:53 ` [PATCH v5 7/7] dts: separate Linux session into interface and logic Andrew Bailey @ 2026-08-06 17:16 ` Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 1/7] doc: improve 26.07 release notes Andrew Bailey ` (6 more replies) 2026-08-06 17:50 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey 2026-08-07 16:16 ` [PATCH v7 0/7] dts: remove imports from framework in test suites Andrew Bailey 9 siblings, 7 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx This series takes action to make modules accessible from api that were only in framework before. This greatly cleans up the majority of test suites, ridding them of almost all framework imports. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- v5: * Resolved merge conflicts and rebased to main. * Removed additional framework imports from test suites. v6: * Included missing linux_session py file * Included missing linux_session rst file Bruce Richardson (1): doc: improve 26.07 release notes Chengwen Feng (1): dmadev: fix incomplete configuration validation Dariusz Sosnowski (2): ethdev: remove flow metadata symbol aliases net/mlx5: remove versioned symbols aliases David Marchand (1): version: 26.11.0-rc0 Robin Jarry (1): lib: remove ICMP and IPv6 deprecated functions and macros Thomas Monjalon (1): version: 26.07.0 .github/workflows/build.yml | 4 +- ABI_VERSION | 2 +- VERSION | 2 +- app/test/test_dmadev_api.c | 186 ++++++++++++++++++++++-- devtools/libabigail.abignore | 7 - doc/guides/rel_notes/index.rst | 1 + doc/guides/rel_notes/release_26_07.rst | 193 +++++-------------------- doc/guides/rel_notes/release_26_11.rst | 145 +++++++++++++++++++ drivers/net/mlx5/meson.build | 2 - drivers/net/mlx5/mlx5_driver_event.c | 22 +-- drivers/net/mlx5/mlx5_flow.c | 18 +-- lib/dmadev/rte_dmadev.c | 156 ++++++++++++++------ lib/ethdev/meson.build | 2 - lib/ethdev/rte_flow.c | 13 +- lib/fib/rte_fib6.h | 5 - lib/lpm/rte_lpm6.h | 4 - lib/net/rte_icmp.h | 4 - lib/rib/rte_rib6.h | 74 ---------- lib/table/rte_table_lpm_ipv6.h | 3 - 19 files changed, 489 insertions(+), 354 deletions(-) create mode 100644 doc/guides/rel_notes/release_26_11.rst -- 2.55.0 ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v6 1/7] doc: improve 26.07 release notes 2026-08-06 17:16 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey @ 2026-08-06 17:16 ` Andrew Bailey 2026-08-06 17:19 ` Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 2/7] version: 26.07.0 Andrew Bailey ` (5 subsequent siblings) 6 siblings, 1 reply; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Bruce Richardson, Thomas Monjalon From: Bruce Richardson <bruce.richardson@intel.com> * The change in mempool behaviour is the change in this release with the largest impact, so call that out first in the release notes, so as to get maximum visibility for it. * For release note component updates where only a single item is called out, remove the bullet point character. * The drivers should be in alphabetical order by category in the release notes, so move two drivers to give correct ordering. * The format of the API section as documented does not have headings in bold. This simpler format is also what is used for the 25.11 and previous release notes. Update text for 26.07 to match the documented and previously used style. * Some minor fixes for the text. * Comments and empty section removed. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Signed-off-by: Thomas Monjalon <thomas@monjalon.net> --- doc/guides/rel_notes/release_26_07.rst | 193 +++++-------------------- 1 file changed, 39 insertions(+), 154 deletions(-) diff --git a/doc/guides/rel_notes/release_26_07.rst b/doc/guides/rel_notes/release_26_07.rst index 0a7eb2ee74..3d18ba2dd0 100644 --- a/doc/guides/rel_notes/release_26_07.rst +++ b/doc/guides/rel_notes/release_26_07.rst @@ -6,69 +6,9 @@ DPDK Release 26.07 ================== -.. **Read this first.** - - The text in the sections below explains how to update the release notes. - - Use proper spelling, capitalization and punctuation in all sections. - - Variable and config names should be quoted as fixed width text: - ``LIKE_THIS``. - - Build the docs and view the output file to ensure the changes are correct:: - - ninja -C build doc - xdg-open build/doc/guides/html/rel_notes/release_26_07.html - - New Features ------------ -.. This section should contain new features added in this release. - Sample format: - - * **Add a title in the past tense with a full stop.** - - Add a short 1-2 sentence description in the past tense. - The description should be enough to allow someone scanning - the release notes to understand the new feature. - - If the feature adds a lot of sub-features you can use a bullet list - like this: - - * Added feature foo to do something. - * Enhanced feature bar to do something else. - - Refer to the previous release notes for examples. - - Suggested order in release notes items: - * Core libs (EAL, mempool, ring, mbuf, buses) - * Device abstraction libs and PMDs (ordered alphabetically by vendor name) - - ethdev (lib, PMDs) - - cryptodev (lib, PMDs) - - eventdev (lib, PMDs) - - etc - * Other libs - * Apps, Examples, Tools (if significant) - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ======================================================= - -* **Added option to change memory limits per page size.** - - Added the EAL option ``--pagesz-mem`` - to override the default per-page-size memory limits. - Each maximum can be configured with a pair ``<pagesz>:<limit>``. - -* **Added option to disable auto probing.** - - Added EAL options affecting the initial bus probing. - - * ``-A`` or ``--no-auto-probing`` disable the initial bus probing: no device is probed during - ``rte_eal_init`` and the application is responsible for probing each device, - * ``--auto-probing`` enables the initial bus probing, which is the current default behavior. - * **Changed mempool cache behaviour.** * The mempool cache flush/refill algorithm was improved, @@ -83,6 +23,20 @@ New Features * The size of the ``struct rte_mempool_cache`` was kept for API/ABI compatibility purposes. +* **Added option to change memory limits per page size.** + + Added the EAL option ``--pagesz-mem`` + to override the default per-page-size memory limits. + Each maximum can be configured with a pair ``<pagesz>:<limit>``. + +* **Added option to disable device auto probing.** + + Added EAL options affecting the initial bus probing to find devices. + + * ``-A`` or ``--no-auto-probing`` disables the initial bus probing: no device is probed during + ``rte_eal_init`` and the application is responsible for probing each device. + * ``--auto-probing`` enables the initial bus probing, which is the current default behavior. + * **Added RISC-V vector paths.** * Increased the default SIMD bitwidth to allow using the vector extension. @@ -112,7 +66,7 @@ New Features * **Added no-IOMMU mode to UACCE bus.** - Added no-IOMMU mode for devices without or not enabling IOMMU/SVA. + Added no-IOMMU mode for devices that do not have or do not enable IOMMU/SVA support. * **Added unplug operation support to VMBUS bus.** @@ -131,13 +85,9 @@ New Features to support adding and removing memory regions without resetting the whole guest memory map. -* **Added LinkData sxe2 ethernet driver.** - - Added network driver for the LinkData network adapters. - * **Updated Google gve driver.** - * Added hardware timestamping support on DQO queues. + Added hardware timestamping support on DQO queues. * **Updated Intel iavf driver.** @@ -147,18 +97,22 @@ New Features * **Updated Intel ice driver.** - * Added ``rl_burst_size`` devarg to configure the scheduler rate-limiter - burst size, reducing Tx latency jitter for time-sensitive traffic. + Added ``rl_burst_size`` devarg to configure the scheduler rate-limiter + burst size, reducing Tx latency jitter for time-sensitive traffic. + +* **Added LinkData sxe2 ethernet driver.** + + Added network driver for the LinkData network adapters. * **Updated Microsoft mana driver.** - * Added device reset support to the MANA PMD, - doing automatic recovery from hardware service reset events, - and notification to upper layers of the reset lifecycle. + Added device reset support to the MANA PMD, + doing automatic recovery from hardware service reset events, + and notification to upper layers of the reset lifecycle. * **Updated NVIDIA mlx5 ethernet driver.** - * Added support for selective Rx in scalar SPRQ Rx path. + Added support for selective Rx in scalar SPRQ Rx path. * **Updated NXP dpaa2 driver.** @@ -189,16 +143,12 @@ New Features * Added ``eof`` devarg to use link state to signal end of receive file input. * Added unit test suite. -* **Updated Marvell cnxk crypto driver.** - - * Added support for ML-KEM and ML-DSA on CN20K platform. - * **Updated Wangxun ngbe driver.** - * Implemented UDP Segmentation Offload (USO) in the transmit path. - The ``RTE_ETH_TX_OFFLOAD_UDP_TSO`` capability was advertised - since the driver's initial integration but the data path was missing; - it is now functional. + Implemented UDP Segmentation Offload (USO) in the transmit path. + The ``RTE_ETH_TX_OFFLOAD_UDP_TSO`` capability was advertised + since the driver's initial integration but the data path was missing; + it is now functional. * **Updated Wangxun txgbe driver.** @@ -223,6 +173,10 @@ New Features On ARM, both IPsec MB and OpenSSL are required for full functionality. +* **Updated Marvell cnxk crypto driver.** + + Added support for ML-KEM and ML-DSA on CN20K platform. + * **Updated lcore validation in power library.** Lcore ID validation was moved into the cpufreq framework before driver dispatch. @@ -276,15 +230,6 @@ New Features Removed Items ------------- -.. This section should contain removed items in this release. Sample format: - - * Add a short 1-2 sentence description of the removed item - in the past tense. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ======================================================= - * crypto/openssl: Removed support for OpenSSL 1.x versions from the OpenSSL crypto PMD. The OpenSSL crypto PMD now requires OpenSSL 3.0 as the minimum version, @@ -304,25 +249,9 @@ Removed Items API Changes ----------- -.. This section should contain API changes. Sample format: - - * sample: Add a short 1-2 sentence description of the API change - which was announced in the previous releases and made in this release. - Start with a scope label like "ethdev:". - Use fixed width quotes for ``function_names`` or ``struct_names``. - Use the past tense. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ======================================================= +* eal: Promoted ``rte_memeq_timingsafe()`` from experimental to stable. -* **eal: promoted timing-safe memory comparison from experimental to stable.** - - The inline function ``rte_memeq_timingsafe()`` is no longer marked experimental. - -* **ethdev: promoted flow metadata API from experimental to stable.** - - The following ethdev symbols are no longer marked experimental: +* ethdev: Promoted the following flow metadata symbols from experimental to stable: - ``rte_flow_dynf_metadata_register`` - ``rte_flow_dynf_metadata_offs`` @@ -331,16 +260,15 @@ API Changes - ``rte_flow_dynf_metadata_get`` - ``rte_flow_dynf_metadata_set`` -* **mlx5: promoted driver event and steering management APIs from experimental to stable.** - - The following mlx5 functions are no longer marked experimental: +* mlx5: Promoted the following driver event and steering management functions + from experimental to stable: - ``rte_pmd_mlx5_driver_event_cb_register`` - ``rte_pmd_mlx5_driver_event_cb_unregister`` - ``rte_pmd_mlx5_enable_steering`` - ``rte_pmd_mlx5_disable_steering`` -* **ip_frag: changed handling of malformed fragments.** +* ip_frag: Changed handling of malformed fragments. - Duplicate fragments are tolerated instead of failing reassembly. - Overlapping fragments are rejected on arrival rather than during reassembly. @@ -354,55 +282,12 @@ API Changes ABI Changes ----------- -.. This section should contain ABI changes. Sample format: - - * sample: Add a short 1-2 sentence description of the ABI change - which was announced in the previous releases and made in this release. - Start with a scope label like "ethdev:". - Use fixed width quotes for ``function_names`` or ``struct_names``. - Use the past tense. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ======================================================= - * No ABI change that would break compatibility with 25.11. -Known Issues ------------- - -.. This section should contain new known issues in this release. Sample format: - - * **Add title in present tense with full stop.** - - Add a short 1-2 sentence description of the known issue - in the present tense. Add information on any known workarounds. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ======================================================= - - Tested Platforms ---------------- -.. This section should contain a list of platforms that were tested - with this release. - - The format is: - - * <vendor> platform with <vendor> <type of devices> combinations - - * List of CPU - * List of OS - * List of devices - * Other relevant details... - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ======================================================= - * Intel\ |reg| platforms with Intel\ |reg| NICs combinations * CPU -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* Re: [PATCH v6 1/7] doc: improve 26.07 release notes 2026-08-06 17:16 ` [PATCH v6 1/7] doc: improve 26.07 release notes Andrew Bailey @ 2026-08-06 17:19 ` Andrew Bailey 0 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:19 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Bruce Richardson, Thomas Monjalon [-- Attachment #1: Type: text/plain, Size: 80 bytes --] Hi all, I sent the wrong patchfiles out, please ignore. Thanks, Andrew Bailey [-- Attachment #2: Type: text/html, Size: 139 bytes --] ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v6 2/7] version: 26.07.0 2026-08-06 17:16 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 1/7] doc: improve 26.07 release notes Andrew Bailey @ 2026-08-06 17:16 ` Andrew Bailey 2026-08-06 17:19 ` Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 3/7] version: 26.11.0-rc0 Andrew Bailey ` (4 subsequent siblings) 6 siblings, 1 reply; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Thomas Monjalon From: Thomas Monjalon <thomas@monjalon.net> Signed-off-by: Thomas Monjalon <thomas@monjalon.net> --- VERSION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VERSION b/VERSION index 1fe6dfa9bd..403cc28f7a 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -26.07.0-rc4 +26.07.0 -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* Re: [PATCH v6 2/7] version: 26.07.0 2026-08-06 17:16 ` [PATCH v6 2/7] version: 26.07.0 Andrew Bailey @ 2026-08-06 17:19 ` Andrew Bailey 0 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:19 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Thomas Monjalon [-- Attachment #1: Type: text/plain, Size: 80 bytes --] Hi all, I sent the wrong patchfiles out, please ignore. Thanks, Andrew Bailey [-- Attachment #2: Type: text/html, Size: 118 bytes --] ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v6 3/7] version: 26.11.0-rc0 2026-08-06 17:16 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 1/7] doc: improve 26.07 release notes Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 2/7] version: 26.07.0 Andrew Bailey @ 2026-08-06 17:16 ` Andrew Bailey 2026-08-06 17:20 ` Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 4/7] ethdev: remove flow metadata symbol aliases Andrew Bailey ` (3 subsequent siblings) 6 siblings, 1 reply; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, David Marchand, Thomas Monjalon, Bruce Richardson From: David Marchand <david.marchand@redhat.com> Start a new release cycle with empty release notes. The ABI version becomes 27.0. The ABI exceptions are dropped and CI ABI checks are disabled because compatibility is not preserved. Note: we need to bump the version for symbol compat in ethdev and net/mlx5 temporarily. Next commits will drop this compat entirely. Signed-off-by: David Marchand <david.marchand@redhat.com> Acked-by: Thomas Monjalon <thomas@monjalon.net> Acked-by: Bruce Richardson <bruce.richardson@intel.com> --- .github/workflows/build.yml | 4 +- ABI_VERSION | 2 +- VERSION | 2 +- devtools/libabigail.abignore | 7 -- doc/guides/rel_notes/index.rst | 1 + doc/guides/rel_notes/release_26_11.rst | 136 +++++++++++++++++++++++++ drivers/net/mlx5/mlx5_driver_event.c | 4 +- drivers/net/mlx5/mlx5_flow.c | 4 +- lib/ethdev/rte_flow.c | 2 +- 9 files changed, 146 insertions(+), 16 deletions(-) create mode 100644 doc/guides/rel_notes/release_26_11.rst diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index f0ef39d34f..c63a9a3982 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -12,7 +12,7 @@ defaults: env: REF_GIT_BRANCH: main REF_GIT_REPO: https://github.com/DPDK/dpdk - REF_GIT_TAG: v26.03 + REF_GIT_TAG: none jobs: checkpatch: @@ -96,7 +96,7 @@ jobs: checks: stdatomic - os: ubuntu-22.04 compiler: gcc - checks: abi+debug+doc+examples+tests + checks: debug+doc+examples+tests - os: ubuntu-22.04 compiler: clang checks: asan+doc+tests diff --git a/ABI_VERSION b/ABI_VERSION index d38d431146..a0d6856dbe 100644 --- a/ABI_VERSION +++ b/ABI_VERSION @@ -1 +1 @@ -26.2 +27.0 diff --git a/VERSION b/VERSION index 403cc28f7a..a14edb8414 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -26.07.0 +26.11.0-rc0 diff --git a/devtools/libabigail.abignore b/devtools/libabigail.abignore index 2a0efd718e..21b8cd6113 100644 --- a/devtools/libabigail.abignore +++ b/devtools/libabigail.abignore @@ -33,10 +33,3 @@ ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ; Temporary exceptions till next major ABI version ; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; - -; Ignore new bit selective_rx in rte_eth_rxseg_capa bitmap hole -[suppress_type] - name = rte_eth_rxseg_capa - type_kind = struct - has_size_change = no - has_data_member_inserted_at = 6 diff --git a/doc/guides/rel_notes/index.rst b/doc/guides/rel_notes/index.rst index 5771a3f47b..d39ee24449 100644 --- a/doc/guides/rel_notes/index.rst +++ b/doc/guides/rel_notes/index.rst @@ -8,6 +8,7 @@ Release Notes :maxdepth: 1 :numbered: + release_26_11 release_26_07 release_26_03 release_25_11 diff --git a/doc/guides/rel_notes/release_26_11.rst b/doc/guides/rel_notes/release_26_11.rst new file mode 100644 index 0000000000..938617ca75 --- /dev/null +++ b/doc/guides/rel_notes/release_26_11.rst @@ -0,0 +1,136 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2026 The DPDK contributors + +.. include:: <isonum.txt> + +DPDK Release 26.11 +================== + +.. **Read this first.** + + The text in the sections below explains how to update the release notes. + + Use proper spelling, capitalization and punctuation in all sections. + + Variable and config names should be quoted as fixed width text: + ``LIKE_THIS``. + + Build the docs and view the output file to ensure the changes are correct:: + + ninja -C build doc + xdg-open build/doc/guides/html/rel_notes/release_26_11.html + + +New Features +------------ + +.. This section should contain new features added in this release. + Sample format: + + * **Add a title in the past tense with a full stop.** + + Add a short 1-2 sentence description in the past tense. + The description should be enough to allow someone scanning + the release notes to understand the new feature. + + If the feature adds a lot of sub-features you can use a bullet list + like this: + + * Added feature foo to do something. + * Enhanced feature bar to do something else. + + Refer to the previous release notes for examples. + + Suggested order in release notes items: + * Core libs (EAL, mempool, ring, mbuf, buses) + * Device abstraction libs and PMDs (ordered alphabetically by vendor name) + - ethdev (lib, PMDs) + - cryptodev (lib, PMDs) + - eventdev (lib, PMDs) + - etc + * Other libs + * Apps, Examples, Tools (if significant) + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ======================================================= + + +Removed Items +------------- + +.. This section should contain removed items in this release. Sample format: + + * Add a short 1-2 sentence description of the removed item + in the past tense. + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ======================================================= + + +API Changes +----------- + +.. This section should contain API changes. Sample format: + + * sample: Add a short 1-2 sentence description of the API change + which was announced in the previous releases and made in this release. + Start with a scope label like "ethdev:". + Use fixed width quotes for ``function_names`` or ``struct_names``. + Use the past tense. + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ======================================================= + + +ABI Changes +----------- + +.. This section should contain ABI changes. Sample format: + + * sample: Add a short 1-2 sentence description of the ABI change + which was announced in the previous releases and made in this release. + Start with a scope label like "ethdev:". + Use fixed width quotes for ``function_names`` or ``struct_names``. + Use the past tense. + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ======================================================= + + +Known Issues +------------ + +.. This section should contain new known issues in this release. Sample format: + + * **Add title in present tense with full stop.** + + Add a short 1-2 sentence description of the known issue + in the present tense. Add information on any known workarounds. + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ======================================================= + + +Tested Platforms +---------------- + +.. This section should contain a list of platforms that were tested + with this release. + + The format is: + + * <vendor> platform with <vendor> <type of devices> combinations + + * List of CPU + * List of OS + * List of devices + * Other relevant details... + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ======================================================= diff --git a/drivers/net/mlx5/mlx5_driver_event.c b/drivers/net/mlx5/mlx5_driver_event.c index d0e22d6151..52e6ad7824 100644 --- a/drivers/net/mlx5/mlx5_driver_event.c +++ b/drivers/net/mlx5/mlx5_driver_event.c @@ -236,7 +236,7 @@ notify_existing_devices(rte_pmd_mlx5_driver_event_callback_t cb, void *opaque) notify_existing_queues(port_id, cb, opaque); } -RTE_DEFAULT_SYMBOL(26, int, rte_pmd_mlx5_driver_event_cb_register, +RTE_DEFAULT_SYMBOL(27, int, rte_pmd_mlx5_driver_event_cb_register, (rte_pmd_mlx5_driver_event_callback_t cb, void *opaque)) { struct registered_cb *r; @@ -269,7 +269,7 @@ RTE_VERSION_EXPERIMENTAL_SYMBOL(int, rte_pmd_mlx5_driver_event_cb_register, return rte_pmd_mlx5_driver_event_cb_register(cb, opaque); } -RTE_DEFAULT_SYMBOL(26, int, rte_pmd_mlx5_driver_event_cb_unregister, +RTE_DEFAULT_SYMBOL(27, int, rte_pmd_mlx5_driver_event_cb_unregister, (rte_pmd_mlx5_driver_event_callback_t cb)) { struct registered_cb *r; diff --git a/drivers/net/mlx5/mlx5_flow.c b/drivers/net/mlx5/mlx5_flow.c index e8141d2100..fb90caf178 100644 --- a/drivers/net/mlx5/mlx5_flow.c +++ b/drivers/net/mlx5/mlx5_flow.c @@ -12537,7 +12537,7 @@ flow_disable_steering_run_on_related(struct rte_eth_dev *dev, } } -RTE_DEFAULT_SYMBOL(26, void, rte_pmd_mlx5_disable_steering, (void)) +RTE_DEFAULT_SYMBOL(27, void, rte_pmd_mlx5_disable_steering, (void)) { uint16_t port_id; @@ -12566,7 +12566,7 @@ RTE_VERSION_EXPERIMENTAL_SYMBOL(void, rte_pmd_mlx5_disable_steering, (void)) rte_pmd_mlx5_disable_steering(); } -RTE_DEFAULT_SYMBOL(26, int, rte_pmd_mlx5_enable_steering, (void)) +RTE_DEFAULT_SYMBOL(27, int, rte_pmd_mlx5_enable_steering, (void)) { uint16_t port_id; diff --git a/lib/ethdev/rte_flow.c b/lib/ethdev/rte_flow.c index 651630b2f8..799c5c4843 100644 --- a/lib/ethdev/rte_flow.c +++ b/lib/ethdev/rte_flow.c @@ -282,7 +282,7 @@ static const struct rte_flow_desc_data rte_flow_desc_action[] = { MK_FLOW_ACTION(JUMP_TO_TABLE_INDEX, sizeof(struct rte_flow_action_jump_to_table_index)), }; -RTE_DEFAULT_SYMBOL(26, int, rte_flow_dynf_metadata_register, (void)) +RTE_DEFAULT_SYMBOL(27, int, rte_flow_dynf_metadata_register, (void)) { int offset; int flag; -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* Re: [PATCH v6 3/7] version: 26.11.0-rc0 2026-08-06 17:16 ` [PATCH v6 3/7] version: 26.11.0-rc0 Andrew Bailey @ 2026-08-06 17:20 ` Andrew Bailey 0 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:20 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, David Marchand, Thomas Monjalon, Bruce Richardson [-- Attachment #1: Type: text/plain, Size: 80 bytes --] Hi all, I sent the wrong patchfiles out, please ignore. Thanks, Andrew Bailey [-- Attachment #2: Type: text/html, Size: 118 bytes --] ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v6 4/7] ethdev: remove flow metadata symbol aliases 2026-08-06 17:16 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (2 preceding siblings ...) 2026-08-06 17:16 ` [PATCH v6 3/7] version: 26.11.0-rc0 Andrew Bailey @ 2026-08-06 17:16 ` Andrew Bailey 2026-08-06 17:20 ` Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 5/7] net/mlx5: remove versioned symbols aliases Andrew Bailey ` (2 subsequent siblings) 6 siblings, 1 reply; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Dariusz Sosnowski, David Marchand From: Dariusz Sosnowski <dsosnowski@nvidia.com> Version aliases for rte_flow_dynf_metadata_register and EXPERIMENTAL version on rte_flow_dynf_metadata_offs and rte_flow_dynf_metadata_mask symbols added in commit 56045d198968 ("ethdev: add aliases for flow metadata symbols") are not needed after ABI version bump. This patch removes them. Signed-off-by: Dariusz Sosnowski <dsosnowski@nvidia.com> Acked-by: David Marchand <david.marchand@redhat.com> --- lib/ethdev/meson.build | 2 -- lib/ethdev/rte_flow.c | 13 +++++-------- 2 files changed, 5 insertions(+), 10 deletions(-) diff --git a/lib/ethdev/meson.build b/lib/ethdev/meson.build index 63fd866af9..8ba6c708a2 100644 --- a/lib/ethdev/meson.build +++ b/lib/ethdev/meson.build @@ -1,8 +1,6 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation -use_function_versioning = true - sources = files( 'ethdev_driver.c', 'ethdev_private.c', diff --git a/lib/ethdev/rte_flow.c b/lib/ethdev/rte_flow.c index 799c5c4843..60c9a3d06f 100644 --- a/lib/ethdev/rte_flow.c +++ b/lib/ethdev/rte_flow.c @@ -23,11 +23,11 @@ #define FLOW_LOG RTE_ETHDEV_LOG_LINE /* Mbuf dynamic field name for metadata. */ -RTE_EXPORT_EXPERIMENTAL_SYMBOL(rte_flow_dynf_metadata_offs, 19.11) +RTE_EXPORT_SYMBOL(rte_flow_dynf_metadata_offs) int32_t rte_flow_dynf_metadata_offs = -1; /* Mbuf dynamic field flag bit number for metadata. */ -RTE_EXPORT_EXPERIMENTAL_SYMBOL(rte_flow_dynf_metadata_mask, 19.11) +RTE_EXPORT_SYMBOL(rte_flow_dynf_metadata_mask) uint64_t rte_flow_dynf_metadata_mask; /** @@ -282,7 +282,9 @@ static const struct rte_flow_desc_data rte_flow_desc_action[] = { MK_FLOW_ACTION(JUMP_TO_TABLE_INDEX, sizeof(struct rte_flow_action_jump_to_table_index)), }; -RTE_DEFAULT_SYMBOL(27, int, rte_flow_dynf_metadata_register, (void)) +RTE_EXPORT_SYMBOL(rte_flow_dynf_metadata_register) +int +rte_flow_dynf_metadata_register(void) { int offset; int flag; @@ -315,11 +317,6 @@ RTE_DEFAULT_SYMBOL(27, int, rte_flow_dynf_metadata_register, (void)) return -rte_errno; } -RTE_VERSION_EXPERIMENTAL_SYMBOL(int, rte_flow_dynf_metadata_register, (void)) -{ - return rte_flow_dynf_metadata_register(); -} - static inline void fts_enter(struct rte_eth_dev *dev) { -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* Re: [PATCH v6 4/7] ethdev: remove flow metadata symbol aliases 2026-08-06 17:16 ` [PATCH v6 4/7] ethdev: remove flow metadata symbol aliases Andrew Bailey @ 2026-08-06 17:20 ` Andrew Bailey 0 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:20 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Dariusz Sosnowski, David Marchand [-- Attachment #1: Type: text/plain, Size: 80 bytes --] Hi all, I sent the wrong patchfiles out, please ignore. Thanks, Andrew Bailey [-- Attachment #2: Type: text/html, Size: 118 bytes --] ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v6 5/7] net/mlx5: remove versioned symbols aliases 2026-08-06 17:16 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (3 preceding siblings ...) 2026-08-06 17:16 ` [PATCH v6 4/7] ethdev: remove flow metadata symbol aliases Andrew Bailey @ 2026-08-06 17:16 ` Andrew Bailey 2026-08-06 17:20 ` Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 6/7] dmadev: fix incomplete configuration validation Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 7/7] lib: remove ICMP and IPv6 deprecated functions and macros Andrew Bailey 6 siblings, 1 reply; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Dariusz Sosnowski, David Marchand From: Dariusz Sosnowski <dsosnowski@nvidia.com> Version function symbols added in commit 556b2a33727a ("net/mlx5: add aliases for some promoted symbols"): - rte_pmd_mlx5_driver_event_cb_register - rte_pmd_mlx5_driver_event_cb_unregister - rte_pmd_mlx5_enable_steering - rte_pmd_mlx5_disable_steering are not needed after ABI version bump. This patch removes versioned symbols. Signed-off-by: Dariusz Sosnowski <dsosnowski@nvidia.com> Acked-by: David Marchand <david.marchand@redhat.com> --- drivers/net/mlx5/meson.build | 2 -- drivers/net/mlx5/mlx5_driver_event.c | 22 ++++++---------------- drivers/net/mlx5/mlx5_flow.c | 18 ++++++------------ 3 files changed, 12 insertions(+), 30 deletions(-) diff --git a/drivers/net/mlx5/meson.build b/drivers/net/mlx5/meson.build index 0fa6322779..82a7dfe782 100644 --- a/drivers/net/mlx5/meson.build +++ b/drivers/net/mlx5/meson.build @@ -2,8 +2,6 @@ # Copyright 2018 6WIND S.A. # Copyright 2018 Mellanox Technologies, Ltd -use_function_versioning = true - if not (is_linux or is_windows) build = false reason = 'only supported on Linux and Windows' diff --git a/drivers/net/mlx5/mlx5_driver_event.c b/drivers/net/mlx5/mlx5_driver_event.c index 52e6ad7824..89e49331c8 100644 --- a/drivers/net/mlx5/mlx5_driver_event.c +++ b/drivers/net/mlx5/mlx5_driver_event.c @@ -236,8 +236,9 @@ notify_existing_devices(rte_pmd_mlx5_driver_event_callback_t cb, void *opaque) notify_existing_queues(port_id, cb, opaque); } -RTE_DEFAULT_SYMBOL(27, int, rte_pmd_mlx5_driver_event_cb_register, - (rte_pmd_mlx5_driver_event_callback_t cb, void *opaque)) +RTE_EXPORT_SYMBOL(rte_pmd_mlx5_driver_event_cb_register) +int +rte_pmd_mlx5_driver_event_cb_register(rte_pmd_mlx5_driver_event_callback_t cb, void *opaque) { struct registered_cb *r; @@ -263,14 +264,9 @@ RTE_DEFAULT_SYMBOL(27, int, rte_pmd_mlx5_driver_event_cb_register, return 0; } -RTE_VERSION_EXPERIMENTAL_SYMBOL(int, rte_pmd_mlx5_driver_event_cb_register, - (rte_pmd_mlx5_driver_event_callback_t cb, void *opaque)) -{ - return rte_pmd_mlx5_driver_event_cb_register(cb, opaque); -} - -RTE_DEFAULT_SYMBOL(27, int, rte_pmd_mlx5_driver_event_cb_unregister, - (rte_pmd_mlx5_driver_event_callback_t cb)) +RTE_EXPORT_SYMBOL(rte_pmd_mlx5_driver_event_cb_unregister) +int +rte_pmd_mlx5_driver_event_cb_unregister(rte_pmd_mlx5_driver_event_callback_t cb) { struct registered_cb *r; bool found = false; @@ -293,12 +289,6 @@ RTE_DEFAULT_SYMBOL(27, int, rte_pmd_mlx5_driver_event_cb_unregister, return 0; } -RTE_VERSION_EXPERIMENTAL_SYMBOL(int, rte_pmd_mlx5_driver_event_cb_unregister, - (rte_pmd_mlx5_driver_event_callback_t cb)) -{ - return rte_pmd_mlx5_driver_event_cb_unregister(cb); -} - RTE_FINI(rte_pmd_mlx5_driver_event_cb_cleanup) { struct registered_cb *r; diff --git a/drivers/net/mlx5/mlx5_flow.c b/drivers/net/mlx5/mlx5_flow.c index fb90caf178..b0eac185b5 100644 --- a/drivers/net/mlx5/mlx5_flow.c +++ b/drivers/net/mlx5/mlx5_flow.c @@ -12537,7 +12537,9 @@ flow_disable_steering_run_on_related(struct rte_eth_dev *dev, } } -RTE_DEFAULT_SYMBOL(27, void, rte_pmd_mlx5_disable_steering, (void)) +RTE_EXPORT_SYMBOL(rte_pmd_mlx5_disable_steering) +void +rte_pmd_mlx5_disable_steering(void) { uint16_t port_id; @@ -12561,12 +12563,9 @@ RTE_DEFAULT_SYMBOL(27, void, rte_pmd_mlx5_disable_steering, (void)) mlx5_steering_disabled = true; } -RTE_VERSION_EXPERIMENTAL_SYMBOL(void, rte_pmd_mlx5_disable_steering, (void)) -{ - rte_pmd_mlx5_disable_steering(); -} - -RTE_DEFAULT_SYMBOL(27, int, rte_pmd_mlx5_enable_steering, (void)) +RTE_EXPORT_SYMBOL(rte_pmd_mlx5_enable_steering) +int +rte_pmd_mlx5_enable_steering(void) { uint16_t port_id; @@ -12583,11 +12582,6 @@ RTE_DEFAULT_SYMBOL(27, int, rte_pmd_mlx5_enable_steering, (void)) return 0; } -RTE_VERSION_EXPERIMENTAL_SYMBOL(int, rte_pmd_mlx5_enable_steering, (void)) -{ - return rte_pmd_mlx5_enable_steering(); -} - bool mlx5_vport_rx_metadata_passing_enabled(const struct mlx5_dev_ctx_shared *sh) { -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* Re: [PATCH v6 5/7] net/mlx5: remove versioned symbols aliases 2026-08-06 17:16 ` [PATCH v6 5/7] net/mlx5: remove versioned symbols aliases Andrew Bailey @ 2026-08-06 17:20 ` Andrew Bailey 0 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:20 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Dariusz Sosnowski, David Marchand [-- Attachment #1: Type: text/plain, Size: 80 bytes --] Hi all, I sent the wrong patchfiles out, please ignore. Thanks, Andrew Bailey [-- Attachment #2: Type: text/html, Size: 118 bytes --] ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v6 6/7] dmadev: fix incomplete configuration validation 2026-08-06 17:16 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (4 preceding siblings ...) 2026-08-06 17:16 ` [PATCH v6 5/7] net/mlx5: remove versioned symbols aliases Andrew Bailey @ 2026-08-06 17:16 ` Andrew Bailey 2026-08-06 17:21 ` Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 7/7] lib: remove ICMP and IPv6 deprecated functions and macros Andrew Bailey 6 siblings, 1 reply; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Chengwen Feng From: Chengwen Feng <fengchengwen@huawei.com> Add a dma_check_vchan_conf() helper to validate rte_dma_vchan_conf fields that do not depend on device capabilities: direction enum, port_type enum, domain type enum, and all reserved[] arrays. In rte_dma_configure(), reject undefined flag bits and non-zero priority when the device lacks priority scheduling support. Add negative-case tests for new checks in rte_dma_configure() (undefined flags, capa-unaware flags/priority) and in rte_dma_vchan_setup() (enum values, reserved fields, domain mismatch, capability enforcement). Fixes: b36970f2e13e ("dmadev: introduce DMA device library") Signed-off-by: Chengwen Feng <fengchengwen@huawei.com> --- app/test/test_dmadev_api.c | 186 ++++++++++++++++++++++++++++++++++--- lib/dmadev/rte_dmadev.c | 156 +++++++++++++++++++++---------- 2 files changed, 283 insertions(+), 59 deletions(-) diff --git a/app/test/test_dmadev_api.c b/app/test/test_dmadev_api.c index 1ba053696b..fb2a1afcaa 100644 --- a/app/test/test_dmadev_api.c +++ b/app/test/test_dmadev_api.c @@ -130,6 +130,55 @@ test_dma_info_get(void) return TEST_SUCCESS; } +static int +check_configure_extra(struct rte_dma_info *info) +{ + struct rte_dma_conf conf = { 0 }; + int ret; + + /* Check undefined flags */ + for (int i = 2; i < 64; i++) { + memset(&conf, 0, sizeof(conf)); + conf.nb_vchans = info->max_vchans; + conf.flags = RTE_BIT64(i); + ret = rte_dma_configure(test_dev_id, &conf); + RTE_TEST_ASSERT(ret == -EINVAL, + "Expected -EINVAL for undefined flag bit %d, %d", i, ret); + } + + /* Check enable silent mode without support */ + if (!(info->dev_capa & RTE_DMA_CAPA_SILENT)) { + memset(&conf, 0, sizeof(conf)); + conf.nb_vchans = info->max_vchans; + conf.flags = RTE_DMA_CFG_FLAG_SILENT; + ret = rte_dma_configure(test_dev_id, &conf); + RTE_TEST_ASSERT(ret == -EINVAL, + "Expected -EINVAL for SILENT without capa, %d", ret); + } + + /* Check enable enqueue/dequeue mode without support */ + if (!(info->dev_capa & RTE_DMA_CAPA_OPS_ENQ_DEQ)) { + memset(&conf, 0, sizeof(conf)); + conf.nb_vchans = info->max_vchans; + conf.flags = RTE_DMA_CFG_FLAG_ENQ_DEQ; + ret = rte_dma_configure(test_dev_id, &conf); + RTE_TEST_ASSERT(ret == -EINVAL, + "Expected -EINVAL for ENQ_DEQ without capa, %d", ret); + } + + /* Check non-zero priority without SP capability */ + if (!(info->dev_capa & RTE_DMA_CAPA_PRI_POLICY_SP)) { + memset(&conf, 0, sizeof(conf)); + conf.nb_vchans = info->max_vchans; + conf.priority = 1; + ret = rte_dma_configure(test_dev_id, &conf); + RTE_TEST_ASSERT(ret == -EINVAL, + "Expected -EINVAL for non-zero priority without SP, %d", ret); + } + + return 0; +} + static int test_dma_configure(void) { @@ -156,12 +205,9 @@ test_dma_configure(void) ret = rte_dma_configure(test_dev_id, &conf); RTE_TEST_ASSERT(ret == -EINVAL, "Expected -EINVAL, %d", ret); - /* Check enable silent mode */ - memset(&conf, 0, sizeof(conf)); - conf.nb_vchans = info.max_vchans; - conf.flags = RTE_DMA_CFG_FLAG_SILENT; - ret = rte_dma_configure(test_dev_id, &conf); - RTE_TEST_ASSERT(ret == -EINVAL, "Expected -EINVAL, %d", ret); + /* Check flags, priority extra validations */ + ret = check_configure_extra(&info); + RTE_TEST_ASSERT_SUCCESS(ret, "Failed to check configure extra"); /* Configure success */ memset(&conf, 0, sizeof(conf)); @@ -209,12 +255,21 @@ check_direction(void) } static int -check_port_type(struct rte_dma_info *dev_info) +check_vchan_port(struct rte_dma_info *dev_info) { struct rte_dma_vchan_conf vchan_conf; int ret; - /* Check src port type validation */ + /* Check invalid port_type enum values */ + memset(&vchan_conf, 0, sizeof(vchan_conf)); + vchan_conf.direction = RTE_DMA_DIR_MEM_TO_MEM; + vchan_conf.nb_desc = dev_info->min_desc; + vchan_conf.src_port.port_type = RTE_DMA_PORT_PCIE + 1; + ret = rte_dma_vchan_setup(test_dev_id, 0, &vchan_conf); + RTE_TEST_ASSERT(ret == -EINVAL, + "Expected -EINVAL for invalid port_type, %d", ret); + + /* Check src port type vs direction mismatch */ memset(&vchan_conf, 0, sizeof(vchan_conf)); vchan_conf.direction = RTE_DMA_DIR_MEM_TO_MEM; vchan_conf.nb_desc = dev_info->min_desc; @@ -222,7 +277,7 @@ check_port_type(struct rte_dma_info *dev_info) ret = rte_dma_vchan_setup(test_dev_id, 0, &vchan_conf); RTE_TEST_ASSERT(ret == -EINVAL, "Expected -EINVAL, %d", ret); - /* Check dst port type validation */ + /* Check dst port type vs direction mismatch */ memset(&vchan_conf, 0, sizeof(vchan_conf)); vchan_conf.direction = RTE_DMA_DIR_MEM_TO_MEM; vchan_conf.nb_desc = dev_info->min_desc; @@ -230,6 +285,105 @@ check_port_type(struct rte_dma_info *dev_info) ret = rte_dma_vchan_setup(test_dev_id, 0, &vchan_conf); RTE_TEST_ASSERT(ret == -EINVAL, "Expected -EINVAL, %d", ret); + /* Check non-zero reserved fields in src_port */ + memset(&vchan_conf, 0, sizeof(vchan_conf)); + vchan_conf.direction = RTE_DMA_DIR_MEM_TO_MEM; + vchan_conf.nb_desc = dev_info->min_desc; + vchan_conf.src_port.reserved[0] = 1; + ret = rte_dma_vchan_setup(test_dev_id, 0, &vchan_conf); + RTE_TEST_ASSERT(ret == -EINVAL, + "Expected -EINVAL for non-zero src_port.reserved, %d", ret); + + /* Check non-zero reserved fields in dst_port */ + memset(&vchan_conf, 0, sizeof(vchan_conf)); + vchan_conf.direction = RTE_DMA_DIR_MEM_TO_MEM; + vchan_conf.nb_desc = dev_info->min_desc; + vchan_conf.dst_port.reserved[0] = 1; + ret = rte_dma_vchan_setup(test_dev_id, 0, &vchan_conf); + RTE_TEST_ASSERT(ret == -EINVAL, + "Expected -EINVAL for non-zero dst_port.reserved, %d", ret); + + return 0; +} + +static int +check_vchan_domain(struct rte_dma_info *dev_info) +{ + struct rte_dma_vchan_conf vchan_conf; + int ret; + + /* Check invalid domain type enum */ + memset(&vchan_conf, 0, sizeof(vchan_conf)); + vchan_conf.direction = RTE_DMA_DIR_MEM_TO_MEM; + vchan_conf.nb_desc = dev_info->min_desc; + vchan_conf.domain.type = RTE_DMA_INTER_OS_DOMAIN + 1; + ret = rte_dma_vchan_setup(test_dev_id, 0, &vchan_conf); + RTE_TEST_ASSERT(ret == -EINVAL, + "Expected -EINVAL for invalid domain type, %d", ret); + + /* Check non-zero domain.reserved */ + memset(&vchan_conf, 0, sizeof(vchan_conf)); + vchan_conf.direction = RTE_DMA_DIR_MEM_TO_MEM; + vchan_conf.nb_desc = dev_info->min_desc; + vchan_conf.domain.reserved[0] = 1; + ret = rte_dma_vchan_setup(test_dev_id, 0, &vchan_conf); + RTE_TEST_ASSERT(ret == -EINVAL, + "Expected -EINVAL for non-zero domain.reserved, %d", ret); + + /* Check inter-domain type without MEM_TO_MEM direction */ + memset(&vchan_conf, 0, sizeof(vchan_conf)); + vchan_conf.direction = RTE_DMA_DIR_MEM_TO_DEV; + vchan_conf.nb_desc = dev_info->min_desc; + vchan_conf.domain.type = RTE_DMA_INTER_PROCESS_DOMAIN; + ret = rte_dma_vchan_setup(test_dev_id, 0, &vchan_conf); + RTE_TEST_ASSERT(ret == -EINVAL, + "Expected -EINVAL for inter-domain non-MEM_TO_MEM, %d", ret); + + /* Check domain INTER_PROCESS without capability */ + memset(&vchan_conf, 0, sizeof(vchan_conf)); + vchan_conf.direction = RTE_DMA_DIR_MEM_TO_MEM; + vchan_conf.nb_desc = dev_info->min_desc; + vchan_conf.domain.type = RTE_DMA_INTER_PROCESS_DOMAIN; + ret = rte_dma_vchan_setup(test_dev_id, 0, &vchan_conf); + RTE_TEST_ASSERT(ret == -EINVAL, + "Expected -EINVAL for INTER_PROCESS without capa, %d", ret); + + /* Check domain INTER_OS without capability */ + memset(&vchan_conf, 0, sizeof(vchan_conf)); + vchan_conf.direction = RTE_DMA_DIR_MEM_TO_MEM; + vchan_conf.nb_desc = dev_info->min_desc; + vchan_conf.domain.type = RTE_DMA_INTER_OS_DOMAIN; + ret = rte_dma_vchan_setup(test_dev_id, 0, &vchan_conf); + RTE_TEST_ASSERT(ret == -EINVAL, + "Expected -EINVAL for INTER_OS without capa, %d", ret); + + return 0; +} + +static int +check_auto_free_conf(struct rte_dma_info *dev_info) +{ + struct rte_dma_vchan_conf vchan_conf; + int ret; + + /* Check non-zero reserved fields in auto_free */ + memset(&vchan_conf, 0, sizeof(vchan_conf)); + vchan_conf.direction = RTE_DMA_DIR_MEM_TO_MEM; + vchan_conf.nb_desc = dev_info->min_desc; + vchan_conf.auto_free.reserved[0] = 1; + ret = rte_dma_vchan_setup(test_dev_id, 0, &vchan_conf); + RTE_TEST_ASSERT(ret == -EINVAL, + "Expected -EINVAL for non-zero auto_free.reserved, %d", ret); + + /* Check auto_free.m2d.pool without M2D auto-free capability */ + memset(&vchan_conf, 0, sizeof(vchan_conf)); + vchan_conf.direction = RTE_DMA_DIR_MEM_TO_MEM; + vchan_conf.nb_desc = dev_info->min_desc; + vchan_conf.auto_free.m2d.pool = (struct rte_mempool *)(uintptr_t)0x1; + ret = rte_dma_vchan_setup(test_dev_id, 0, &vchan_conf); + RTE_TEST_ASSERT(ret == -EINVAL, + "Expected -EINVAL for auto_free without M2D capa, %d", ret); + return 0; } @@ -274,9 +428,17 @@ test_dma_vchan_setup(void) ret = rte_dma_vchan_setup(test_dev_id, 0, &vchan_conf); RTE_TEST_ASSERT(ret == -EINVAL, "Expected -EINVAL, %d", ret); - /* Check port type */ - ret = check_port_type(&dev_info); - RTE_TEST_ASSERT_SUCCESS(ret, "Failed to check port type"); + /* Check port type and reserved fields */ + ret = check_vchan_port(&dev_info); + RTE_TEST_ASSERT_SUCCESS(ret, "Failed to check vchan port"); + + /* Check domain param validation */ + ret = check_vchan_domain(&dev_info); + RTE_TEST_ASSERT_SUCCESS(ret, "Failed to check vchan domain"); + + /* Check auto_free config validation */ + ret = check_auto_free_conf(&dev_info); + RTE_TEST_ASSERT_SUCCESS(ret, "Failed to check auto_free conf"); /* Check vchan setup success */ memset(&vchan_conf, 0, sizeof(vchan_conf)); diff --git a/lib/dmadev/rte_dmadev.c b/lib/dmadev/rte_dmadev.c index 822bb7c89f..2311f01906 100644 --- a/lib/dmadev/rte_dmadev.c +++ b/lib/dmadev/rte_dmadev.c @@ -480,6 +480,7 @@ RTE_EXPORT_SYMBOL(rte_dma_configure) int rte_dma_configure(int16_t dev_id, const struct rte_dma_conf *dev_conf) { + const uint64_t valid_flags = RTE_DMA_CFG_FLAG_SILENT | RTE_DMA_CFG_FLAG_ENQ_DEQ; struct rte_dma_info dev_info; struct rte_dma_dev *dev; int ret; @@ -510,18 +511,28 @@ rte_dma_configure(int16_t dev_id, const struct rte_dma_conf *dev_conf) "Device %d configure too many vchans", dev_id); return -EINVAL; } + + if (dev_info.dev_capa & RTE_DMA_CAPA_PRI_POLICY_SP) { + if (dev_conf->priority >= dev_info.nb_priorities) { + RTE_DMA_LOG(ERR, "Device %d configure invalid priority", dev_id); + return -EINVAL; + } + } else { + if (dev_conf->priority != 0) { + RTE_DMA_LOG(ERR, "Device %d should not configure priority", dev_id); + return -EINVAL; + } + } + + if ((dev_conf->flags & ~valid_flags) != 0) { + RTE_DMA_LOG(ERR, "Device %d configure invalid flags", dev_id); + return -EINVAL; + } if ((dev_conf->flags & RTE_DMA_CFG_FLAG_SILENT) && !(dev_info.dev_capa & RTE_DMA_CAPA_SILENT)) { RTE_DMA_LOG(ERR, "Device %d don't support silent", dev_id); return -EINVAL; } - - if ((dev_info.dev_capa & RTE_DMA_CAPA_PRI_POLICY_SP) && - (dev_conf->priority >= dev_info.nb_priorities)) { - RTE_DMA_LOG(ERR, "Device %d configure invalid priority", dev_id); - return -EINVAL; - } - if ((dev_conf->flags & RTE_DMA_CFG_FLAG_ENQ_DEQ) && !(dev_info.dev_capa & RTE_DMA_CAPA_OPS_ENQ_DEQ)) { RTE_DMA_LOG(ERR, "Device %d don't support enqueue/dequeue", dev_id); @@ -632,13 +643,85 @@ rte_dma_close(int16_t dev_id) return ret; } +/* Perform verification on rte_dma_vchan_conf only. */ +static int +dma_check_vchan_conf(int16_t dev_id, const struct rte_dma_vchan_conf *conf) +{ + bool src_is_dev, dst_is_dev; + + if (conf->direction != RTE_DMA_DIR_MEM_TO_MEM && + conf->direction != RTE_DMA_DIR_MEM_TO_DEV && + conf->direction != RTE_DMA_DIR_DEV_TO_MEM && + conf->direction != RTE_DMA_DIR_DEV_TO_DEV) { + RTE_DMA_LOG(ERR, "Device %d direction invalid!", dev_id); + return -EINVAL; + } + + if (conf->src_port.port_type != RTE_DMA_PORT_NONE && + conf->src_port.port_type != RTE_DMA_PORT_PCIE) { + RTE_DMA_LOG(ERR, "Device %d source port type unsupported", dev_id); + return -EINVAL; + } + if (conf->src_port.reserved[0] != 0 || conf->src_port.reserved[1] != 0) { + RTE_DMA_LOG(ERR, "Device %d src_port has non-zero reserved fields", dev_id); + return -EINVAL; + } + src_is_dev = conf->direction == RTE_DMA_DIR_DEV_TO_MEM || + conf->direction == RTE_DMA_DIR_DEV_TO_DEV; + if ((conf->src_port.port_type == RTE_DMA_PORT_NONE && src_is_dev) || + (conf->src_port.port_type != RTE_DMA_PORT_NONE && !src_is_dev)) { + RTE_DMA_LOG(ERR, "Device %d source port type invalid", dev_id); + return -EINVAL; + } + + if (conf->dst_port.port_type != RTE_DMA_PORT_NONE && + conf->dst_port.port_type != RTE_DMA_PORT_PCIE) { + RTE_DMA_LOG(ERR, "Device %d destination port type unsupported", dev_id); + return -EINVAL; + } + if (conf->dst_port.reserved[0] != 0 || conf->dst_port.reserved[1] != 0) { + RTE_DMA_LOG(ERR, "Device %d dst_port has non-zero reserved fields", dev_id); + return -EINVAL; + } + dst_is_dev = conf->direction == RTE_DMA_DIR_MEM_TO_DEV || + conf->direction == RTE_DMA_DIR_DEV_TO_DEV; + if ((conf->dst_port.port_type == RTE_DMA_PORT_NONE && dst_is_dev) || + (conf->dst_port.port_type != RTE_DMA_PORT_NONE && !dst_is_dev)) { + RTE_DMA_LOG(ERR, + "Device %d destination port type invalid", dev_id); + return -EINVAL; + } + + if (conf->auto_free.reserved[0] != 0 || conf->auto_free.reserved[1] != 0) { + RTE_DMA_LOG(ERR, "Device %d auto_free has non-zero reserved fields", dev_id); + return -EINVAL; + } + + if (conf->domain.type != RTE_DMA_INTER_DOMAIN_NONE && + conf->domain.type != RTE_DMA_INTER_PROCESS_DOMAIN && + conf->domain.type != RTE_DMA_INTER_OS_DOMAIN) { + RTE_DMA_LOG(ERR, "Device %d domain type invalid!", dev_id); + return -EINVAL; + } + if (conf->domain.reserved[0] != 0 || conf->domain.reserved[1] != 0) { + RTE_DMA_LOG(ERR, "Device %d domain has non-zero reserved fields", dev_id); + return -EINVAL; + } + if (conf->domain.type != RTE_DMA_INTER_DOMAIN_NONE && + conf->direction != RTE_DMA_DIR_MEM_TO_MEM) { + RTE_DMA_LOG(ERR, "Device %d inter domain only support mem-to-mem transfer", dev_id); + return -EINVAL; + } + + return 0; +} + RTE_EXPORT_SYMBOL(rte_dma_vchan_setup) int rte_dma_vchan_setup(int16_t dev_id, uint16_t vchan, const struct rte_dma_vchan_conf *conf) { struct rte_dma_info dev_info; - bool src_is_dev, dst_is_dev; struct rte_dma_dev *dev; int ret; @@ -653,6 +736,10 @@ rte_dma_vchan_setup(int16_t dev_id, uint16_t vchan, return -EBUSY; } + ret = dma_check_vchan_conf(dev_id, conf); + if (ret != 0) + return ret; + ret = rte_dma_info_get(dev_id, &dev_info); if (ret != 0) { RTE_DMA_LOG(ERR, "Device %d get device info fail", dev_id); @@ -666,34 +753,7 @@ rte_dma_vchan_setup(int16_t dev_id, uint16_t vchan, RTE_DMA_LOG(ERR, "Device %d vchan out range!", dev_id); return -EINVAL; } - if (conf->domain.type != RTE_DMA_INTER_DOMAIN_NONE && - conf->direction != RTE_DMA_DIR_MEM_TO_MEM) { - RTE_DMA_LOG(ERR, "Device %d inter domain only support mem-to-mem transfer", dev_id); - return -EINVAL; - } - if (conf->domain.type == RTE_DMA_INTER_OS_DOMAIN && - !(dev_info.dev_capa & RTE_DMA_CAPA_INTER_OS_DOMAIN)) { - RTE_DMA_LOG(ERR, "Device %d does not support inter os domain", dev_id); - return -EINVAL; - } - if (conf->domain.type == RTE_DMA_INTER_PROCESS_DOMAIN && - !(dev_info.dev_capa & RTE_DMA_CAPA_INTER_PROCESS_DOMAIN)) { - RTE_DMA_LOG(ERR, "Device %d does not support inter process domain", dev_id); - return -EINVAL; - } - if ((conf->domain.type == RTE_DMA_INTER_PROCESS_DOMAIN || - conf->domain.type == RTE_DMA_INTER_OS_DOMAIN) && - (conf->domain.reserved[0] != 0 || conf->domain.reserved[1] != 0)) { - RTE_DMA_LOG(ERR, "Device %d does not support non-zero reserved fields", dev_id); - return -EINVAL; - } - if (conf->direction != RTE_DMA_DIR_MEM_TO_MEM && - conf->direction != RTE_DMA_DIR_MEM_TO_DEV && - conf->direction != RTE_DMA_DIR_DEV_TO_MEM && - conf->direction != RTE_DMA_DIR_DEV_TO_DEV) { - RTE_DMA_LOG(ERR, "Device %d direction invalid!", dev_id); - return -EINVAL; - } + if (conf->direction == RTE_DMA_DIR_MEM_TO_MEM && !(dev_info.dev_capa & RTE_DMA_CAPA_MEM_TO_MEM)) { RTE_DMA_LOG(ERR, @@ -724,19 +784,21 @@ rte_dma_vchan_setup(int16_t dev_id, uint16_t vchan, "Device %d number of descriptors invalid", dev_id); return -EINVAL; } - src_is_dev = conf->direction == RTE_DMA_DIR_DEV_TO_MEM || - conf->direction == RTE_DMA_DIR_DEV_TO_DEV; - if ((conf->src_port.port_type == RTE_DMA_PORT_NONE && src_is_dev) || - (conf->src_port.port_type != RTE_DMA_PORT_NONE && !src_is_dev)) { - RTE_DMA_LOG(ERR, "Device %d source port type invalid", dev_id); + + if (conf->auto_free.m2d.pool != NULL && + !(dev_info.dev_capa & RTE_DMA_CAPA_M2D_AUTO_FREE)) { + RTE_DMA_LOG(ERR, "Device %d does not support m2d auto free", dev_id); return -EINVAL; } - dst_is_dev = conf->direction == RTE_DMA_DIR_MEM_TO_DEV || - conf->direction == RTE_DMA_DIR_DEV_TO_DEV; - if ((conf->dst_port.port_type == RTE_DMA_PORT_NONE && dst_is_dev) || - (conf->dst_port.port_type != RTE_DMA_PORT_NONE && !dst_is_dev)) { - RTE_DMA_LOG(ERR, - "Device %d destination port type invalid", dev_id); + + if (conf->domain.type == RTE_DMA_INTER_OS_DOMAIN && + !(dev_info.dev_capa & RTE_DMA_CAPA_INTER_OS_DOMAIN)) { + RTE_DMA_LOG(ERR, "Device %d does not support inter os domain", dev_id); + return -EINVAL; + } + if (conf->domain.type == RTE_DMA_INTER_PROCESS_DOMAIN && + !(dev_info.dev_capa & RTE_DMA_CAPA_INTER_PROCESS_DOMAIN)) { + RTE_DMA_LOG(ERR, "Device %d does not support inter process domain", dev_id); return -EINVAL; } -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* Re: [PATCH v6 6/7] dmadev: fix incomplete configuration validation 2026-08-06 17:16 ` [PATCH v6 6/7] dmadev: fix incomplete configuration validation Andrew Bailey @ 2026-08-06 17:21 ` Andrew Bailey 0 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:21 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Chengwen Feng [-- Attachment #1: Type: text/plain, Size: 80 bytes --] Hi all, I sent the wrong patchfiles out, please ignore. Thanks, Andrew Bailey [-- Attachment #2: Type: text/html, Size: 118 bytes --] ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v6 7/7] lib: remove ICMP and IPv6 deprecated functions and macros 2026-08-06 17:16 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (5 preceding siblings ...) 2026-08-06 17:16 ` [PATCH v6 6/7] dmadev: fix incomplete configuration validation Andrew Bailey @ 2026-08-06 17:16 ` Andrew Bailey 2026-08-06 17:21 ` Andrew Bailey 6 siblings, 1 reply; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Robin Jarry, David Marchand From: Robin Jarry <rjarry@redhat.com> These symbols were marked as deprecated in DPDK 24.11. Remove them completely. Signed-off-by: Robin Jarry <rjarry@redhat.com> Acked-by: David Marchand <david.marchand@redhat.com> --- doc/guides/rel_notes/release_26_11.rst | 9 ++++ lib/fib/rte_fib6.h | 5 -- lib/lpm/rte_lpm6.h | 4 -- lib/net/rte_icmp.h | 4 -- lib/rib/rte_rib6.h | 74 -------------------------- lib/table/rte_table_lpm_ipv6.h | 3 -- 6 files changed, 9 insertions(+), 90 deletions(-) diff --git a/doc/guides/rel_notes/release_26_11.rst b/doc/guides/rel_notes/release_26_11.rst index 938617ca75..c8cc86295d 100644 --- a/doc/guides/rel_notes/release_26_11.rst +++ b/doc/guides/rel_notes/release_26_11.rst @@ -68,6 +68,15 @@ Removed Items Also, make sure to start the actual text at the margin. ======================================================= +* Removed deprecated symbols: + + * fib: ``RTE_FIB6_IPV6_ADDR_SIZE``, ``RTE_FIB6_MAXDEPTH`` + * lpm: ``RTE_LPM6_IPV6_ADDR_SIZE``, ``RTE_LPM6_MAX_DEPTH`` + * net: ``RTE_IP_ICMP_ECHO_REPLY``, ``RTE_IP_ICMP_ECHO_REQUEST`` + * rib: ``RTE_RIB6_IPV6_ADDR_SIZE``, ``get_msk_part``, ``rte_rib6_copy_addr``, + ``rte_rib6_is_equal`` + * table: ``RTE_LPM_IPV6_ADDR_SIZE`` + API Changes ----------- diff --git a/lib/fib/rte_fib6.h b/lib/fib/rte_fib6.h index 4527328bf0..fcbd10de15 100644 --- a/lib/fib/rte_fib6.h +++ b/lib/fib/rte_fib6.h @@ -17,7 +17,6 @@ #include <stdint.h> -#include <rte_common.h> #include <rte_ip6.h> #include <rte_rcu_qsbr.h> @@ -25,10 +24,6 @@ extern "C" { #endif -#define RTE_FIB6_IPV6_ADDR_SIZE (RTE_DEPRECATED(RTE_FIB6_IPV6_ADDR_SIZE) RTE_IPV6_ADDR_SIZE) -/** Maximum depth value possible for IPv6 FIB. */ -#define RTE_FIB6_MAXDEPTH (RTE_DEPRECATED(RTE_FIB6_MAXDEPTH) RTE_IPV6_MAX_DEPTH) - /* Maximum length of a FIB name. */ #define RTE_FIB6_NAMESIZE 64 diff --git a/lib/lpm/rte_lpm6.h b/lib/lpm/rte_lpm6.h index 08b5618613..c5928b9d88 100644 --- a/lib/lpm/rte_lpm6.h +++ b/lib/lpm/rte_lpm6.h @@ -11,16 +11,12 @@ #include <stdint.h> -#include <rte_common.h> #include <rte_ip6.h> #ifdef __cplusplus extern "C" { #endif - -#define RTE_LPM6_MAX_DEPTH (RTE_DEPRECATED(RTE_LPM6_MAX_DEPTH) RTE_IPV6_MAX_DEPTH) -#define RTE_LPM6_IPV6_ADDR_SIZE (RTE_DEPRECATED(RTE_LPM6_IPV6_ADDR_SIZE) RTE_IPV6_ADDR_SIZE) /** Max number of characters in LPM name. */ #define RTE_LPM6_NAMESIZE 32 diff --git a/lib/net/rte_icmp.h b/lib/net/rte_icmp.h index cca73b3733..a504c921de 100644 --- a/lib/net/rte_icmp.h +++ b/lib/net/rte_icmp.h @@ -51,13 +51,9 @@ struct __rte_packed_begin rte_icmp_hdr { /* ICMP packet types */ #define RTE_ICMP_TYPE_ECHO_REPLY 0 -#define RTE_IP_ICMP_ECHO_REPLY \ - (RTE_DEPRECATED(RTE_IP_ICMP_ECHO_REPLY) RTE_ICMP_TYPE_ECHO_REPLY) #define RTE_ICMP_TYPE_DEST_UNREACHABLE 3 #define RTE_ICMP_TYPE_REDIRECT 5 #define RTE_ICMP_TYPE_ECHO_REQUEST 8 -#define RTE_IP_ICMP_ECHO_REQUEST \ - (RTE_DEPRECATED(RTE_IP_ICMP_ECHO_REQUEST) RTE_ICMP_TYPE_ECHO_REQUEST) #define RTE_ICMP_TYPE_TTL_EXCEEDED 11 #define RTE_ICMP_TYPE_PARAM_PROBLEM 12 #define RTE_ICMP_TYPE_TIMESTAMP_REQUEST 13 diff --git a/lib/rib/rte_rib6.h b/lib/rib/rte_rib6.h index d66d9e7c07..e3fb464ae6 100644 --- a/lib/rib/rte_rib6.h +++ b/lib/rib/rte_rib6.h @@ -15,15 +15,12 @@ */ #include <rte_memcpy.h> -#include <rte_common.h> #include <rte_ip6.h> #ifdef __cplusplus extern "C" { #endif -#define RTE_RIB6_IPV6_ADDR_SIZE (RTE_DEPRECATED(RTE_RIB6_IPV6_ADDR_SIZE) RTE_IPV6_ADDR_SIZE) - /** * rte_rib6_get_nxt() flags */ @@ -49,77 +46,6 @@ struct rte_rib6_conf { int max_nodes; }; -/** - * Copy IPv6 address from one location to another - * - * @param dst - * pointer to the place to copy - * @param src - * pointer from where to copy - */ -static inline void rte_rib6_copy_addr(uint8_t *dst, const uint8_t *src) - __rte_deprecated_msg("use direct struct assignment"); - -static inline void -rte_rib6_copy_addr(uint8_t *dst, const uint8_t *src) -{ - if ((dst == NULL) || (src == NULL)) - return; - rte_memcpy(dst, src, RTE_IPV6_ADDR_SIZE); -} - -/** - * Compare two IPv6 addresses - * - * @param ip1 - * pointer to the first ipv6 address - * @param ip2 - * pointer to the second ipv6 address - * - * @return - * 1 if equal - * 0 otherwise - */ -static inline int rte_rib6_is_equal(const uint8_t *ip1, const uint8_t *ip2) - __rte_deprecated_msg("use rte_ipv6_addr_eq"); - -static inline int -rte_rib6_is_equal(const uint8_t *ip1, const uint8_t *ip2) { - int i; - - if ((ip1 == NULL) || (ip2 == NULL)) - return 0; - for (i = 0; i < RTE_IPV6_ADDR_SIZE; i++) { - if (ip1[i] != ip2[i]) - return 0; - } - return 1; -} - -/** - * Get 8-bit part of 128-bit IPv6 mask - * - * @param depth - * ipv6 prefix length - * @param byte - * position of a 8-bit chunk in the 128-bit mask - * - * @return - * 8-bit chunk of the 128-bit IPv6 mask - */ -static inline uint8_t get_msk_part(uint8_t depth, int byte) __rte_deprecated; - -static inline uint8_t -get_msk_part(uint8_t depth, int byte) { - uint8_t part; - - byte &= 0xf; - depth = RTE_MIN(depth, 128); - part = RTE_MAX((int16_t)depth - (byte * 8), 0); - part = (part > 8) ? 8 : part; - return (uint16_t)(~UINT8_MAX) >> part; -} - /** * Lookup an IP into the RIB structure * diff --git a/lib/table/rte_table_lpm_ipv6.h b/lib/table/rte_table_lpm_ipv6.h index 3ea8883606..a9fbc906f3 100644 --- a/lib/table/rte_table_lpm_ipv6.h +++ b/lib/table/rte_table_lpm_ipv6.h @@ -39,7 +39,6 @@ #include <stdint.h> -#include <rte_common.h> #include <rte_ip6.h> #include "rte_table.h" @@ -48,8 +47,6 @@ extern "C" { #endif -#define RTE_LPM_IPV6_ADDR_SIZE (RTE_DEPRECATED(RTE_LPM_IPV6_ADDR_SIZE) RTE_IPV6_ADDR_SIZE) - /** LPM table parameters */ struct rte_table_lpm_ipv6_params { /** Table name */ -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* Re: [PATCH v6 7/7] lib: remove ICMP and IPv6 deprecated functions and macros 2026-08-06 17:16 ` [PATCH v6 7/7] lib: remove ICMP and IPv6 deprecated functions and macros Andrew Bailey @ 2026-08-06 17:21 ` Andrew Bailey 0 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:21 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Robin Jarry, David Marchand [-- Attachment #1: Type: text/plain, Size: 80 bytes --] Hi all, I sent the wrong patchfiles out, please ignore. Thanks, Andrew Bailey [-- Attachment #2: Type: text/html, Size: 139 bytes --] ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v6 0/7] dts: remove imports from framework in test suites 2026-08-06 13:53 [PATCH v5 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (7 preceding siblings ...) 2026-08-06 17:16 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey @ 2026-08-06 17:50 ` Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 1/7] dts: move exception module from framework to API Andrew Bailey ` (6 more replies) 2026-08-07 16:16 ` [PATCH v7 0/7] dts: remove imports from framework in test suites Andrew Bailey 9 siblings, 7 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:50 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx This series takes action to make modules accessible from api that were only in framework before. This greatly cleans up the majority of test suites, ridding them of almost all framework imports. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- v5: * Resolved merge conflicts and rebased to main. * Removed additional framework imports from test suites. v6: * Included missing linux_session py file * Included missing linux_session rst file Andrew Bailey (7): dts: move exception module from framework to API dts: move utils from framework to API dts: move context from framework to API dts: move testbed model from framework to API dts: move test suite module from framework to API dts: move params directory from framework to API dts: separate Linux session into interface and logic ...{framework.context.rst => api.context.rst} | 2 +- ...mework.exception.rst => api.exception.rst} | 2 +- ...work.params.eal.rst => api.params.eal.rst} | 2 +- .../{framework.params.rst => api.params.rst} | 6 +- ....params.types.rst => api.params.types.rst} | 2 +- ...work.test_suite.rst => api.test_suite.rst} | 2 +- ...y.rst => api.testbed_model.capability.rst} | 2 +- ...odel.cpu.rst => api.testbed_model.cpu.rst} | 2 +- ...st => api.testbed_model.linux_session.rst} | 2 +- ...el.node.rst => api.testbed_model.node.rst} | 2 +- ...n.rst => api.testbed_model.os_session.rst} | 2 +- ...el.port.rst => api.testbed_model.port.rst} | 2 +- ...st => api.testbed_model.posix_session.rst} | 2 +- doc/api/dts/api.testbed_model.rst | 28 ++++++ ...ogy.rst => api.testbed_model.topology.rst} | 2 +- ...generator.capturing_traffic_generator.rst} | 2 +- .../api.testbed_model.traffic_generator.rst | 16 ++++ ...testbed_model.traffic_generator.scapy.rst} | 2 +- ...l.traffic_generator.traffic_generator.rst} | 2 +- ...t => api.testbed_model.virtual_device.rst} | 2 +- .../{framework.utils.rst => api.utils.rst} | 2 +- doc/api/dts/framework.linux_session.rst | 9 ++ doc/api/dts/framework.testbed_model.rst | 28 ------ ...mework.testbed_model.traffic_generator.rst | 16 ---- doc/api/dts/index.rst | 13 +-- dts/api/artifact.py | 6 +- dts/api/capabilities.py | 14 +-- dts/{framework => api}/context.py | 14 +-- dts/api/cryptodev/__init__.py | 6 +- dts/api/cryptodev/config.py | 6 +- dts/{framework => api}/exception.py | 0 dts/api/packet.py | 18 ++-- dts/{framework => api}/params/__init__.py | 0 dts/{framework => api}/params/eal.py | 8 +- dts/{framework => api}/params/types.py | 16 ++-- dts/api/test.py | 4 +- dts/{framework => api}/test_suite.py | 15 ++-- .../testbed_model/__init__.py | 0 .../testbed_model/capability.py | 18 ++-- dts/{framework => api}/testbed_model/cpu.py | 4 +- dts/api/testbed_model/linux_session.py | 45 ++++++++++ dts/{framework => api}/testbed_model/node.py | 6 +- .../testbed_model/os_session.py | 8 +- dts/{framework => api}/testbed_model/port.py | 2 +- .../testbed_model/posix_session.py | 6 +- .../testbed_model/topology.py | 20 ++--- .../traffic_generator/__init__.py | 4 +- .../capturing_traffic_generator.py | 4 +- .../performance_traffic_generator.py | 0 .../testbed_model/traffic_generator/scapy.py | 14 +-- .../traffic_generator/traffic_generator.py | 8 +- .../testbed_model/traffic_generator/trex.py | 18 ++-- .../testbed_model/virtual_device.py | 0 dts/api/testpmd/__init__.py | 11 ++- dts/api/testpmd/config.py | 6 +- dts/api/testpmd/types.py | 2 +- dts/{framework => api}/utils.py | 2 +- dts/framework/config/__init__.py | 6 +- dts/framework/config/node.py | 2 +- dts/framework/config/test_run.py | 12 +-- .../{testbed_model => }/linux_session.py | 12 ++- dts/framework/parser.py | 2 +- dts/framework/remote_session/blocking_app.py | 8 +- dts/framework/remote_session/dpdk.py | 16 ++-- dts/framework/remote_session/dpdk_shell.py | 6 +- .../interactive_remote_session.py | 2 +- .../remote_session/interactive_shell.py | 8 +- .../remote_session/remote_session.py | 4 +- dts/framework/runner.py | 4 +- dts/framework/test_result.py | 5 +- dts/framework/test_run.py | 24 ++--- dts/tests/TestSuite_blocklist.py | 4 +- dts/tests/TestSuite_buffer_scatter.py | 2 +- dts/tests/TestSuite_checksum_offload.py | 2 +- dts/tests/TestSuite_cryptodev_latency.py | 6 +- dts/tests/TestSuite_cryptodev_throughput.py | 89 +++++-------------- dts/tests/TestSuite_dual_vlan.py | 2 +- dts/tests/TestSuite_dynamic_config.py | 2 +- dts/tests/TestSuite_dynamic_queue_conf.py | 4 +- dts/tests/TestSuite_flow_offload.py | 12 +-- dts/tests/TestSuite_hello_world.py | 2 +- dts/tests/TestSuite_l2fwd.py | 8 +- dts/tests/TestSuite_mac_filter.py | 4 +- dts/tests/TestSuite_mtu.py | 2 +- dts/tests/TestSuite_packet_capture.py | 12 +-- dts/tests/TestSuite_port_control.py | 2 +- ...stSuite_port_restart_config_persistency.py | 2 +- dts/tests/TestSuite_port_stats.py | 2 +- dts/tests/TestSuite_promisc_support.py | 2 +- dts/tests/TestSuite_qinq.py | 2 +- dts/tests/TestSuite_queue_toggle.py | 2 +- dts/tests/TestSuite_rss.py | 6 +- dts/tests/TestSuite_rx_split.py | 4 +- dts/tests/TestSuite_rx_tx_offload.py | 2 +- .../TestSuite_single_core_forward_perf.py | 4 +- dts/tests/TestSuite_smoke_tests.py | 6 +- dts/tests/TestSuite_softnic.py | 6 +- dts/tests/TestSuite_speed_capabilities.py | 2 +- dts/tests/TestSuite_unified_packet.py | 2 +- dts/tests/TestSuite_virtio_forward.py | 8 +- dts/tests/TestSuite_vlan.py | 2 +- 101 files changed, 382 insertions(+), 371 deletions(-) rename doc/api/dts/{framework.context.rst => api.context.rst} (80%) rename doc/api/dts/{framework.exception.rst => api.exception.rst} (77%) rename doc/api/dts/{framework.params.eal.rst => api.params.eal.rst} (79%) rename doc/api/dts/{framework.params.rst => api.params.rst} (71%) rename doc/api/dts/{framework.params.types.rst => api.params.types.rst} (80%) rename doc/api/dts/{framework.test_suite.rst => api.test_suite.rst} (81%) rename doc/api/dts/{framework.testbed_model.capability.rst => api.testbed_model.capability.rst} (74%) rename doc/api/dts/{framework.testbed_model.cpu.rst => api.testbed_model.cpu.rst} (78%) rename doc/api/dts/{framework.testbed_model.linux_session.rst => api.testbed_model.linux_session.rst} (74%) rename doc/api/dts/{framework.testbed_model.node.rst => api.testbed_model.node.rst} (71%) rename doc/api/dts/{framework.testbed_model.os_session.rst => api.testbed_model.os_session.rst} (76%) rename doc/api/dts/{framework.testbed_model.port.rst => api.testbed_model.port.rst} (77%) rename doc/api/dts/{framework.testbed_model.posix_session.rst => api.testbed_model.posix_session.rst} (74%) create mode 100644 doc/api/dts/api.testbed_model.rst rename doc/api/dts/{framework.testbed_model.topology.rst => api.testbed_model.topology.rst} (73%) rename doc/api/dts/{framework.testbed_model.traffic_generator.capturing_traffic_generator.rst => api.testbed_model.traffic_generator.capturing_traffic_generator.rst} (68%) create mode 100644 doc/api/dts/api.testbed_model.traffic_generator.rst rename doc/api/dts/{framework.testbed_model.traffic_generator.scapy.rst => api.testbed_model.traffic_generator.scapy.rst} (70%) rename doc/api/dts/{framework.testbed_model.traffic_generator.traffic_generator.rst => api.testbed_model.traffic_generator.traffic_generator.rst} (65%) rename doc/api/dts/{framework.testbed_model.virtual_device.rst => api.testbed_model.virtual_device.rst} (72%) rename doc/api/dts/{framework.utils.rst => api.utils.rst} (80%) create mode 100644 doc/api/dts/framework.linux_session.rst delete mode 100644 doc/api/dts/framework.testbed_model.rst delete mode 100644 doc/api/dts/framework.testbed_model.traffic_generator.rst rename dts/{framework => api}/context.py (90%) rename dts/{framework => api}/exception.py (100%) rename dts/{framework => api}/params/__init__.py (100%) rename dts/{framework => api}/params/eal.py (89%) rename dts/{framework => api}/params/types.py (93%) rename dts/{framework => api}/test_suite.py (98%) rename dts/{framework => api}/testbed_model/__init__.py (100%) rename dts/{framework => api}/testbed_model/capability.py (98%) rename dts/{framework => api}/testbed_model/cpu.py (99%) create mode 100644 dts/api/testbed_model/linux_session.py rename dts/{framework => api}/testbed_model/node.py (98%) rename dts/{framework => api}/testbed_model/os_session.py (99%) rename dts/{framework => api}/testbed_model/port.py (98%) rename dts/{framework => api}/testbed_model/posix_session.py (99%) rename dts/{framework => api}/testbed_model/topology.py (96%) rename dts/{framework => api}/testbed_model/traffic_generator/__init__.py (95%) rename dts/{framework => api}/testbed_model/traffic_generator/capturing_traffic_generator.py (98%) rename dts/{framework => api}/testbed_model/traffic_generator/performance_traffic_generator.py (100%) rename dts/{framework => api}/testbed_model/traffic_generator/scapy.py (98%) rename dts/{framework => api}/testbed_model/traffic_generator/traffic_generator.py (91%) rename dts/{framework => api}/testbed_model/traffic_generator/trex.py (96%) rename dts/{framework => api}/testbed_model/virtual_device.py (100%) rename dts/{framework => api}/utils.py (99%) rename dts/framework/{testbed_model => }/linux_session.py (98%) -- 2.55.0 ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v6 1/7] dts: move exception module from framework to API 2026-08-06 17:50 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey @ 2026-08-06 17:50 ` Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 2/7] dts: move utils " Andrew Bailey ` (5 subsequent siblings) 6 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:50 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx Multiple test suites currently import the exception module from the framework in order to catch certain errors during test execution. Move this to the API. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- ...mework.exception.rst => api.exception.rst} | 2 +- doc/api/dts/index.rst | 2 +- dts/api/artifact.py | 2 +- dts/api/cryptodev/__init__.py | 2 +- dts/{framework => api}/exception.py | 0 dts/api/packet.py | 2 +- dts/api/test.py | 2 +- dts/api/testpmd/__init__.py | 2 +- dts/framework/config/__init__.py | 2 +- dts/framework/config/test_run.py | 2 +- dts/framework/context.py | 2 +- dts/framework/parser.py | 2 +- dts/framework/remote_session/dpdk.py | 2 +- .../interactive_remote_session.py | 2 +- .../remote_session/interactive_shell.py | 4 +- .../remote_session/remote_session.py | 4 +- dts/framework/runner.py | 2 +- dts/framework/test_result.py | 3 +- dts/framework/test_run.py | 4 +- dts/framework/test_suite.py | 2 +- dts/framework/testbed_model/capability.py | 2 +- dts/framework/testbed_model/linux_session.py | 2 +- dts/framework/testbed_model/node.py | 2 +- dts/framework/testbed_model/port.py | 2 +- dts/framework/testbed_model/posix_session.py | 2 +- dts/framework/testbed_model/topology.py | 2 +- .../traffic_generator/__init__.py | 2 +- .../testbed_model/traffic_generator/scapy.py | 2 +- .../testbed_model/traffic_generator/trex.py | 2 +- dts/framework/utils.py | 2 +- dts/tests/TestSuite_cryptodev_throughput.py | 83 ++++--------------- dts/tests/TestSuite_dynamic_queue_conf.py | 2 +- dts/tests/TestSuite_flow_offload.py | 10 +-- dts/tests/TestSuite_mac_filter.py | 2 +- dts/tests/TestSuite_rss.py | 2 +- dts/tests/TestSuite_rx_split.py | 2 +- 36 files changed, 58 insertions(+), 108 deletions(-) rename doc/api/dts/{framework.exception.rst => api.exception.rst} (77%) rename dts/{framework => api}/exception.py (100%) diff --git a/doc/api/dts/framework.exception.rst b/doc/api/dts/api.exception.rst similarity index 77% rename from doc/api/dts/framework.exception.rst rename to doc/api/dts/api.exception.rst index efb47dc5ae..8e6bff5ee7 100644 --- a/doc/api/dts/framework.exception.rst +++ b/doc/api/dts/api.exception.rst @@ -3,6 +3,6 @@ exception - Exceptions ====================== -.. automodule:: framework.exception +.. automodule:: api.exception :members: :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index c719297c11..01f630e7cd 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -36,7 +36,7 @@ Modules framework.logger framework.parser framework.utils - framework.exception + api.exception Indices and tables diff --git a/dts/api/artifact.py b/dts/api/artifact.py index 24a2b05063..7d04c7ab49 100644 --- a/dts/api/artifact.py +++ b/dts/api/artifact.py @@ -47,7 +47,7 @@ from paramiko import SFTPClient, SFTPFile from typing_extensions import Buffer -from framework.exception import InternalError +from api.exception import InternalError from framework.logger import DTSLogger, get_dts_logger from framework.settings import SETTINGS from framework.testbed_model.node import Node, NodeIdentifier, get_node diff --git a/dts/api/cryptodev/__init__.py b/dts/api/cryptodev/__init__.py index 15cffcb409..335b811620 100644 --- a/dts/api/cryptodev/__init__.py +++ b/dts/api/cryptodev/__init__.py @@ -22,8 +22,8 @@ ThroughputResults, VerifyResults, ) +from api.exception import RemoteCommandExecutionError, SkippedTestException from framework.context import get_ctx -from framework.exception import RemoteCommandExecutionError, SkippedTestException from framework.remote_session.dpdk_shell import compute_eal_params if TYPE_CHECKING: diff --git a/dts/framework/exception.py b/dts/api/exception.py similarity index 100% rename from dts/framework/exception.py rename to dts/api/exception.py diff --git a/dts/api/packet.py b/dts/api/packet.py index 3dda18e781..eaecf205f7 100644 --- a/dts/api/packet.py +++ b/dts/api/packet.py @@ -27,9 +27,9 @@ from scapy.layers.l2 import Ether from scapy.packet import Packet, Padding, raw +from api.exception import InternalError from api.test import fail, log_debug from framework.context import get_ctx -from framework.exception import InternalError from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( PacketFilteringConfig, ) diff --git a/dts/api/test.py b/dts/api/test.py index 7947c407d2..29d6842111 100644 --- a/dts/api/test.py +++ b/dts/api/test.py @@ -11,8 +11,8 @@ from api.artifact import Artifact from api.capabilities import LinkTopology +from api.exception import InternalError, SkippedTestException, TestCaseVerifyError from framework.context import get_ctx -from framework.exception import InternalError, SkippedTestException, TestCaseVerifyError from framework.logger import DTSLogger diff --git a/dts/api/testpmd/__init__.py b/dts/api/testpmd/__init__.py index b41a21300e..fef7430cb8 100644 --- a/dts/api/testpmd/__init__.py +++ b/dts/api/testpmd/__init__.py @@ -32,6 +32,7 @@ from typing_extensions import Unpack from api.capabilities import LinkTopology, NicCapability +from api.exception import InteractiveCommandExecutionError, InternalError from api.testpmd.config import PortTopology, SimpleForwardingModes, TestPmdParams from api.testpmd.types import ( ChecksumOffloadOptions, @@ -55,7 +56,6 @@ VLANOffloadFlag, ) from framework.context import get_ctx -from framework.exception import InteractiveCommandExecutionError, InternalError from framework.params.types import TestPmdParamsDict from framework.remote_session.dpdk_shell import DPDKShell from framework.remote_session.interactive_shell import only_active diff --git a/dts/framework/config/__init__.py b/dts/framework/config/__init__.py index 573f55471a..e24a351ecf 100644 --- a/dts/framework/config/__init__.py +++ b/dts/framework/config/__init__.py @@ -35,7 +35,7 @@ from pydantic import Field, TypeAdapter, ValidationError, model_validator from typing_extensions import Self -from framework.exception import ConfigurationError +from api.exception import ConfigurationError from .common import FrozenModel, ValidationContext from .node import NodeConfiguration diff --git a/dts/framework/config/test_run.py b/dts/framework/config/test_run.py index 81630df77d..9aa0938d4e 100644 --- a/dts/framework/config/test_run.py +++ b/dts/framework/config/test_run.py @@ -27,7 +27,7 @@ ) from typing_extensions import TYPE_CHECKING, Self -from framework.exception import InternalError +from api.exception import InternalError from framework.utils import REGEX_FOR_PORT_LINK, StrEnum from .common import FrozenModel, load_fields_from_settings diff --git a/dts/framework/context.py b/dts/framework/context.py index b1c36f90a6..709b99421e 100644 --- a/dts/framework/context.py +++ b/dts/framework/context.py @@ -8,7 +8,7 @@ from dataclasses import MISSING, dataclass, field, fields from typing import TYPE_CHECKING, Any, Optional, ParamSpec, Union -from framework.exception import InternalError +from api.exception import InternalError from framework.remote_session.shell_pool import ShellPool from framework.settings import SETTINGS from framework.testbed_model.cpu import LogicalCoreCount, LogicalCoreList diff --git a/dts/framework/parser.py b/dts/framework/parser.py index 3075c36857..ebf470ad30 100644 --- a/dts/framework/parser.py +++ b/dts/framework/parser.py @@ -15,7 +15,7 @@ from typing_extensions import Self -from framework.exception import InternalError +from api.exception import InternalError class ParserFn(TypedDict): diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index e43e1f2123..0618855fc5 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -14,6 +14,7 @@ from typing import ClassVar, Final from api.capabilities import LinkTopology +from api.exception import ConfigurationError, RemoteFileNotFoundError from framework.config.test_run import ( DPDKBuildConfiguration, DPDKBuildOptionsConfiguration, @@ -26,7 +27,6 @@ RemoteDPDKTreeLocation, ) from framework.context import get_ctx -from framework.exception import ConfigurationError, RemoteFileNotFoundError from framework.logger import DTSLogger, get_dts_logger from framework.params.eal import EalParams from framework.remote_session.remote_session import CommandResult diff --git a/dts/framework/remote_session/interactive_remote_session.py b/dts/framework/remote_session/interactive_remote_session.py index fc42e862bc..3c1f00aab2 100644 --- a/dts/framework/remote_session/interactive_remote_session.py +++ b/dts/framework/remote_session/interactive_remote_session.py @@ -15,8 +15,8 @@ SSHException, ) +from api.exception import SSHConnectionError from framework.config.node import NodeConfiguration -from framework.exception import SSHConnectionError from framework.logger import DTSLogger diff --git a/dts/framework/remote_session/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index 6bba58a4f6..367a01714d 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -29,12 +29,12 @@ from paramiko import Channel, channel from typing_extensions import Self -from framework.context import get_ctx -from framework.exception import ( +from api.exception import ( InteractiveCommandExecutionError, InteractiveSSHSessionDeadError, InteractiveSSHTimeoutError, ) +from framework.context import get_ctx from framework.logger import DTSLogger, get_dts_logger from framework.params import Params from framework.settings import SETTINGS diff --git a/dts/framework/remote_session/remote_session.py b/dts/framework/remote_session/remote_session.py index fb5f6fedf5..95515c9ee2 100644 --- a/dts/framework/remote_session/remote_session.py +++ b/dts/framework/remote_session/remote_session.py @@ -24,13 +24,13 @@ SSHException, ) -from framework.config.node import NodeConfiguration -from framework.exception import ( +from api.exception import ( RemoteCommandExecutionError, SSHConnectionError, SSHSessionDeadError, SSHTimeoutError, ) +from framework.config.node import NodeConfiguration from framework.logger import DTSLogger from framework.settings import SETTINGS diff --git a/dts/framework/runner.py b/dts/framework/runner.py index fa4f06844e..cb137fbf7b 100644 --- a/dts/framework/runner.py +++ b/dts/framework/runner.py @@ -12,8 +12,8 @@ import sys import textwrap +from api.exception import ConfigurationError from framework.config.common import ValidationContext -from framework.exception import ConfigurationError from framework.test_run import TestRun from framework.testbed_model.node import Node diff --git a/dts/framework/test_result.py b/dts/framework/test_result.py index 21faa55dc1..3cecb928ca 100644 --- a/dts/framework/test_result.py +++ b/dts/framework/test_result.py @@ -35,12 +35,11 @@ ) from typing_extensions import OrderedDict +from api.exception import DTSError, ErrorSeverity, InternalError from framework.remote_session.dpdk import DPDKBuildInfo from framework.settings import SETTINGS from framework.testbed_model.os_session import OSSessionInfo -from .exception import DTSError, ErrorSeverity, InternalError - class Result(IntEnum): """The possible states that a setup, a teardown or a test case may end up in.""" diff --git a/dts/framework/test_run.py b/dts/framework/test_run.py index c20a0fa885..75d82c1104 100644 --- a/dts/framework/test_run.py +++ b/dts/framework/test_run.py @@ -108,9 +108,9 @@ from typing import ClassVar, Protocol, Union from api.capabilities import LinkTopology +from api.exception import InternalError, SkippedTestException, TestCaseVerifyError from framework.config.test_run import TestRunConfiguration from framework.context import Context, init_ctx -from framework.exception import InternalError, SkippedTestException, TestCaseVerifyError from framework.logger import DTSLogger, get_dts_logger from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment from framework.settings import SETTINGS @@ -138,7 +138,7 @@ class TestRun: If an error occurs, the current stage is aborted, the error is recorded, everything in the inner stages is marked as blocked and the run continues in the next iteration of the same stage. The return code is the highest `severity` of all - :class:`~.framework.exception.DTSError`\s. + :class:`~.api.exception.DTSError`\s. Example: An error occurs in a test suite setup. The current test suite is aborted, diff --git a/dts/framework/test_suite.py b/dts/framework/test_suite.py index 69ce26040a..e06fdd28b9 100644 --- a/dts/framework/test_suite.py +++ b/dts/framework/test_suite.py @@ -29,11 +29,11 @@ from scapy.packet import Packet from typing_extensions import Self +from api.exception import ConfigurationError, InternalError from framework.config.common import FrozenModel from framework.testbed_model.capability import TestProtocol from framework.testbed_model.topology import Topology -from .exception import ConfigurationError, InternalError from .logger import DTSLogger, get_dts_logger from .utils import to_pascal_case diff --git a/dts/framework/testbed_model/capability.py b/dts/framework/testbed_model/capability.py index b10799ea4b..00b40a3b1e 100644 --- a/dts/framework/testbed_model/capability.py +++ b/dts/framework/testbed_model/capability.py @@ -64,7 +64,7 @@ def test_scatter_mbuf_2048(self): from typing_extensions import Self from api.capabilities import LinkTopology, NicCapability -from framework.exception import ConfigurationError, InternalError, SkippedTestException +from api.exception import ConfigurationError, InternalError, SkippedTestException from framework.logger import get_dts_logger from framework.testbed_model.node import Node from framework.testbed_model.port import DriverKind diff --git a/dts/framework/testbed_model/linux_session.py b/dts/framework/testbed_model/linux_session.py index c118f803b6..4495ae35cf 100644 --- a/dts/framework/testbed_model/linux_session.py +++ b/dts/framework/testbed_model/linux_session.py @@ -18,7 +18,7 @@ from typing_extensions import NotRequired -from framework.exception import ( +from api.exception import ( ConfigurationError, InternalError, RemoteCommandExecutionError, diff --git a/dts/framework/testbed_model/node.py b/dts/framework/testbed_model/node.py index 67a96ef4e5..4f42bf6aeb 100644 --- a/dts/framework/testbed_model/node.py +++ b/dts/framework/testbed_model/node.py @@ -17,11 +17,11 @@ from pathlib import PurePath from typing import Literal, TypeAlias +from api.exception import ConfigurationError, InternalError from framework.config.node import ( OS, NodeConfiguration, ) -from framework.exception import ConfigurationError, InternalError from framework.logger import DTSLogger, get_dts_logger from .cpu import Architecture, LogicalCore diff --git a/dts/framework/testbed_model/port.py b/dts/framework/testbed_model/port.py index d81bc4cda0..aea3e59c25 100644 --- a/dts/framework/testbed_model/port.py +++ b/dts/framework/testbed_model/port.py @@ -12,8 +12,8 @@ from functools import cached_property from typing import TYPE_CHECKING, Any, Final, Literal, NamedTuple +from api.exception import InternalError from framework.config.node import PortConfig -from framework.exception import InternalError if TYPE_CHECKING: from .node import Node diff --git a/dts/framework/testbed_model/posix_session.py b/dts/framework/testbed_model/posix_session.py index dec952685a..db2c3c0c40 100644 --- a/dts/framework/testbed_model/posix_session.py +++ b/dts/framework/testbed_model/posix_session.py @@ -16,7 +16,7 @@ from collections.abc import Iterable from pathlib import Path, PurePath, PurePosixPath -from framework.exception import DPDKBuildError, RemoteCommandExecutionError +from api.exception import DPDKBuildError, RemoteCommandExecutionError from framework.settings import SETTINGS from framework.utils import ( MesonArgs, diff --git a/dts/framework/testbed_model/topology.py b/dts/framework/testbed_model/topology.py index 1db444fc01..002faf0b7f 100644 --- a/dts/framework/testbed_model/topology.py +++ b/dts/framework/testbed_model/topology.py @@ -18,7 +18,7 @@ from typing_extensions import Self from api.capabilities import LinkTopology -from framework.exception import ConfigurationError, InternalError +from api.exception import ConfigurationError, InternalError from framework.testbed_model.linux_session import LinuxSession from framework.testbed_model.node import Node, NodeIdentifier diff --git a/dts/framework/testbed_model/traffic_generator/__init__.py b/dts/framework/testbed_model/traffic_generator/__init__.py index fca251f534..324b5e88f3 100644 --- a/dts/framework/testbed_model/traffic_generator/__init__.py +++ b/dts/framework/testbed_model/traffic_generator/__init__.py @@ -14,12 +14,12 @@ and a capturing traffic generator is required. """ +from api.exception import ConfigurationError from framework.config.test_run import ( ScapyTrafficGeneratorConfig, TrafficGeneratorConfig, TrexTrafficGeneratorConfig, ) -from framework.exception import ConfigurationError from framework.testbed_model.node import Node from .scapy import ScapyTrafficGenerator diff --git a/dts/framework/testbed_model/traffic_generator/scapy.py b/dts/framework/testbed_model/traffic_generator/scapy.py index 62853a34e4..70856cc1f0 100644 --- a/dts/framework/testbed_model/traffic_generator/scapy.py +++ b/dts/framework/testbed_model/traffic_generator/scapy.py @@ -25,9 +25,9 @@ from scapy.layers.l2 import Ether from scapy.packet import Packet +from api.exception import InteractiveSSHSessionDeadError, InternalError from framework.config.node import OS from framework.config.test_run import ScapyTrafficGeneratorConfig -from framework.exception import InteractiveSSHSessionDeadError, InternalError from framework.remote_session.python_shell import PythonShell from framework.testbed_model.node import Node from framework.testbed_model.port import Port diff --git a/dts/framework/testbed_model/traffic_generator/trex.py b/dts/framework/testbed_model/traffic_generator/trex.py index d53791b0a6..2c3beebc59 100644 --- a/dts/framework/testbed_model/traffic_generator/trex.py +++ b/dts/framework/testbed_model/traffic_generator/trex.py @@ -11,9 +11,9 @@ from scapy.packet import Packet +from api.exception import SSHTimeoutError from framework.config.node import OS, NodeConfiguration from framework.config.test_run import TrexTrafficGeneratorConfig -from framework.exception import SSHTimeoutError from framework.parser import TextParser from framework.remote_session.blocking_app import BlockingApp from framework.remote_session.python_shell import PythonShell diff --git a/dts/framework/utils.py b/dts/framework/utils.py index 5753c1b7fe..235f4bf426 100644 --- a/dts/framework/utils.py +++ b/dts/framework/utils.py @@ -26,7 +26,7 @@ from scapy.layers.inet import IP, TCP, UDP, Ether from scapy.packet import Packet -from .exception import InternalError +from api.exception import InternalError REGEX_FOR_PCI_ADDRESS: str = r"[0-9a-fA-F]{4}:[0-9a-fA-F]{2}:[0-9a-fA-F]{2}.[0-9]{1}" _REGEX_FOR_COLON_OR_HYPHEN_SEP_MAC: str = r"(?:[\da-fA-F]{2}[:-]){5}[\da-fA-F]{2}" diff --git a/dts/tests/TestSuite_cryptodev_throughput.py b/dts/tests/TestSuite_cryptodev_throughput.py index 2fc0d8779a..53682f35fa 100644 --- a/dts/tests/TestSuite_cryptodev_throughput.py +++ b/dts/tests/TestSuite_cryptodev_throughput.py @@ -29,9 +29,8 @@ from api.cryptodev.types import ( CryptodevResults, ) -from api.test import verify +from api.test import skip, verify from framework.context import get_ctx -from framework.exception import SkippedTestException from framework.test_suite import BaseConfig, TestSuite, crypto_test from framework.testbed_model.virtual_device import VirtualDevice @@ -153,12 +152,9 @@ def aes_cbc(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aes_cbc" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -183,12 +179,9 @@ def aes_cbc_sha1(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aes_cbc_sha1" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -218,12 +211,9 @@ def aes_cbc_sha2(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aes_cbc_sha2" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -252,12 +242,9 @@ def aes_cbc_sha2_digest_16(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aes_cbc_sha2_digest_16" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -286,12 +273,9 @@ def aead_aes_gcm(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aead_aes_gcm" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -318,12 +302,9 @@ def aes_docsisbpi(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aes_docsisbpi" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -348,12 +329,9 @@ def sha1_hmac(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "sha1_hmac" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -379,12 +357,9 @@ def snow3g_uea2_snow3g_uia2(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "snow3g_uea2_snow3g_uia2" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -414,12 +389,9 @@ def zuc_eea3_zuc_eia3(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "zuc_eea3_zuc_eia3" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -449,12 +421,9 @@ def kasumi_f8_kasumi_f9(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "kasumi_f8_kasumi_f9" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -486,12 +455,9 @@ def aesni_mb_vdev(self) -> None: * Create a cryptodev instance with crypto_aesni_mb and supplied buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aesni_mb_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, vdevs=[VirtualDevice("crypto_aesni_mb0")], @@ -523,12 +489,9 @@ def aesni_gcm_vdev(self): * Create a cryptodev instance with crypto_aesni_gcm and supplied buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aesni_gcm_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, vdevs=[VirtualDevice("crypto_aesni_gcm0")], @@ -556,12 +519,9 @@ def kasumi_vdev(self) -> None: * Create a cryptodev instance with crypto_kasumi and supplied buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "kasumi_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( vdevs=[VirtualDevice("crypto_kasumi0")], ptest=TestType.throughput, @@ -592,12 +552,9 @@ def snow3g_vdev(self) -> None: * Create a cryptodev instance with crypto_snow3g and supplied buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "snow3g_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, vdevs=[VirtualDevice("crypto_snow3g0")], @@ -629,12 +586,9 @@ def zuc_vdev(self) -> None: * Create a cryptodev instance with crypto_zuc and supplied buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "zuc_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, vdevs=[VirtualDevice("crypto_zuc0")], @@ -666,12 +620,9 @@ def open_ssl_vdev(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "open_ssl_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, vdevs=[VirtualDevice("crypto_openssl0")], diff --git a/dts/tests/TestSuite_dynamic_queue_conf.py b/dts/tests/TestSuite_dynamic_queue_conf.py index 5ac85bee7d..b62efa2b42 100644 --- a/dts/tests/TestSuite_dynamic_queue_conf.py +++ b/dts/tests/TestSuite_dynamic_queue_conf.py @@ -35,11 +35,11 @@ NicCapability, requires_nic_capability, ) +from api.exception import InteractiveCommandExecutionError from api.packet import send_packets from api.test import fail, verify from api.testpmd import TestPmd from api.testpmd.config import PortTopology, SimpleForwardingModes -from framework.exception import InteractiveCommandExecutionError from framework.test_suite import TestSuite, func_test diff --git a/dts/tests/TestSuite_flow_offload.py b/dts/tests/TestSuite_flow_offload.py index be11d09875..5902406a8e 100644 --- a/dts/tests/TestSuite_flow_offload.py +++ b/dts/tests/TestSuite_flow_offload.py @@ -21,15 +21,15 @@ from scapy.packet import Packet, Raw from api.capabilities import NicCapability, requires_nic_capability -from api.packet import send_packet_and_capture -from api.test import fail, log, verify -from api.testpmd import TestPmd -from api.testpmd.types import FlowRule -from framework.exception import ( +from api.exception import ( InteractiveCommandExecutionError, SkippedTestException, TestCaseVerifyError, ) +from api.packet import send_packet_and_capture +from api.test import fail, log, verify +from api.testpmd import TestPmd +from api.testpmd.types import FlowRule from framework.test_suite import TestSuite, func_test diff --git a/dts/tests/TestSuite_mac_filter.py b/dts/tests/TestSuite_mac_filter.py index a7e24b37d5..b44822d31c 100644 --- a/dts/tests/TestSuite_mac_filter.py +++ b/dts/tests/TestSuite_mac_filter.py @@ -23,10 +23,10 @@ NicCapability, requires_nic_capability, ) +from api.exception import InteractiveCommandExecutionError from api.packet import send_packet_and_capture from api.test import fail, verify from api.testpmd import TestPmd -from framework.exception import InteractiveCommandExecutionError from framework.test_suite import TestSuite, func_test diff --git a/dts/tests/TestSuite_rss.py b/dts/tests/TestSuite_rss.py index 2747c8a36c..1af0782ffc 100644 --- a/dts/tests/TestSuite_rss.py +++ b/dts/tests/TestSuite_rss.py @@ -20,6 +20,7 @@ requires_link_topology, requires_nic_capability, ) +from api.exception import InteractiveCommandExecutionError from api.packet import send_packets_and_capture from api.test import verify from api.testpmd import TestPmd @@ -29,7 +30,6 @@ RSSOffloadTypesFlag, TestPmdVerbosePacket, ) -from framework.exception import InteractiveCommandExecutionError from framework.test_suite import BaseConfig, TestSuite, func_test from framework.utils import StrEnum diff --git a/dts/tests/TestSuite_rx_split.py b/dts/tests/TestSuite_rx_split.py index 5117a569e2..470e48d0d3 100644 --- a/dts/tests/TestSuite_rx_split.py +++ b/dts/tests/TestSuite_rx_split.py @@ -18,12 +18,12 @@ NicCapability, requires_nic_capability, ) +from api.exception import InteractiveCommandExecutionError from api.packet import adjust_addresses, send_packet_and_capture from api.test import fail, verify from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import RxOffloadCapability, TxOffloadCapability -from framework.exception import InteractiveCommandExecutionError from framework.test_suite import TestSuite, func_test PAYLOAD = bytes(range(256)) -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* [PATCH v6 2/7] dts: move utils from framework to API 2026-08-06 17:50 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 1/7] dts: move exception module from framework to API Andrew Bailey @ 2026-08-06 17:50 ` Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 3/7] dts: move context " Andrew Bailey ` (4 subsequent siblings) 6 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:50 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx The utils module is used to generate a set of random packets in certain test suites. Move this to the API. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- doc/api/dts/{framework.utils.rst => api.utils.rst} | 2 +- doc/api/dts/index.rst | 2 +- dts/api/cryptodev/config.py | 2 +- dts/api/packet.py | 2 +- dts/api/testpmd/config.py | 2 +- dts/api/testpmd/types.py | 2 +- dts/{framework => api}/utils.py | 0 dts/framework/config/node.py | 2 +- dts/framework/config/test_run.py | 2 +- dts/framework/remote_session/dpdk.py | 2 +- dts/framework/test_suite.py | 2 +- dts/framework/testbed_model/cpu.py | 2 +- dts/framework/testbed_model/linux_session.py | 2 +- dts/framework/testbed_model/os_session.py | 2 +- dts/framework/testbed_model/posix_session.py | 4 ++-- .../traffic_generator/capturing_traffic_generator.py | 2 +- .../testbed_model/traffic_generator/traffic_generator.py | 2 +- dts/framework/testbed_model/traffic_generator/trex.py | 2 +- dts/tests/TestSuite_l2fwd.py | 2 +- dts/tests/TestSuite_rss.py | 2 +- dts/tests/TestSuite_smoke_tests.py | 2 +- dts/tests/TestSuite_softnic.py | 2 +- 22 files changed, 22 insertions(+), 22 deletions(-) rename doc/api/dts/{framework.utils.rst => api.utils.rst} (80%) rename dts/{framework => api}/utils.py (100%) diff --git a/doc/api/dts/framework.utils.rst b/doc/api/dts/api.utils.rst similarity index 80% rename from doc/api/dts/framework.utils.rst rename to doc/api/dts/api.utils.rst index cc06d4c3c3..0b4baff1b5 100644 --- a/doc/api/dts/framework.utils.rst +++ b/doc/api/dts/api.utils.rst @@ -3,6 +3,6 @@ utils - Various Utilities ========================= -.. automodule:: framework.utils +.. automodule:: api.utils :members: :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index 01f630e7cd..783270f6e9 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -35,7 +35,7 @@ Modules framework.context framework.logger framework.parser - framework.utils + api.utils api.exception diff --git a/dts/api/cryptodev/config.py b/dts/api/cryptodev/config.py index 69ff7aa59a..a88e70d45c 100644 --- a/dts/api/cryptodev/config.py +++ b/dts/api/cryptodev/config.py @@ -6,9 +6,9 @@ from enum import auto from typing import Literal +from api.utils import StrEnum from framework.params import Params, Switch from framework.params.eal import EalParams -from framework.utils import StrEnum Silent = Literal[""] diff --git a/dts/api/packet.py b/dts/api/packet.py index eaecf205f7..98f995deb5 100644 --- a/dts/api/packet.py +++ b/dts/api/packet.py @@ -29,6 +29,7 @@ from api.exception import InternalError from api.test import fail, log_debug +from api.utils import get_packet_summaries from framework.context import get_ctx from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( PacketFilteringConfig, @@ -36,7 +37,6 @@ from framework.testbed_model.traffic_generator.performance_traffic_generator import ( PerformanceTrafficStats, ) -from framework.utils import get_packet_summaries def send_packet_and_capture( diff --git a/dts/api/testpmd/config.py b/dts/api/testpmd/config.py index f0581843ca..3850a4eb8a 100644 --- a/dts/api/testpmd/config.py +++ b/dts/api/testpmd/config.py @@ -13,6 +13,7 @@ from pathlib import PurePath from typing import Literal, NamedTuple +from api.utils import StrEnum from framework.params import ( Params, Switch, @@ -25,7 +26,6 @@ str_from_flag_value, ) from framework.params.eal import EalParams -from framework.utils import StrEnum from .types import RxOffloadCapability, TxOffloadCapability diff --git a/dts/api/testpmd/types.py b/dts/api/testpmd/types.py index bca40d6f34..7f8f449941 100644 --- a/dts/api/testpmd/types.py +++ b/dts/api/testpmd/types.py @@ -15,8 +15,8 @@ from typing_extensions import Self +from api.utils import REGEX_FOR_MAC_ADDRESS, StrEnum from framework.parser import ParserFn, TextParser -from framework.utils import REGEX_FOR_MAC_ADDRESS, StrEnum RxTxLiteralSwitch = Literal["rx", "tx"] diff --git a/dts/framework/utils.py b/dts/api/utils.py similarity index 100% rename from dts/framework/utils.py rename to dts/api/utils.py diff --git a/dts/framework/config/node.py b/dts/framework/config/node.py index 792290f11f..28f23389a7 100644 --- a/dts/framework/config/node.py +++ b/dts/framework/config/node.py @@ -14,7 +14,7 @@ from pydantic import Field, model_validator from typing_extensions import Self -from framework.utils import REGEX_FOR_IDENTIFIER, REGEX_FOR_PCI_ADDRESS, StrEnum +from api.utils import REGEX_FOR_IDENTIFIER, REGEX_FOR_PCI_ADDRESS, StrEnum from .common import FrozenModel diff --git a/dts/framework/config/test_run.py b/dts/framework/config/test_run.py index 9aa0938d4e..b87c7b2d19 100644 --- a/dts/framework/config/test_run.py +++ b/dts/framework/config/test_run.py @@ -28,7 +28,7 @@ from typing_extensions import TYPE_CHECKING, Self from api.exception import InternalError -from framework.utils import REGEX_FOR_PORT_LINK, StrEnum +from api.utils import REGEX_FOR_PORT_LINK, StrEnum from .common import FrozenModel, load_fields_from_settings diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index 0618855fc5..ba91c88d11 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -15,6 +15,7 @@ from api.capabilities import LinkTopology from api.exception import ConfigurationError, RemoteFileNotFoundError +from api.utils import MesonArgs, TarCompressionFormat from framework.config.test_run import ( DPDKBuildConfiguration, DPDKBuildOptionsConfiguration, @@ -34,7 +35,6 @@ from framework.testbed_model.node import Node from framework.testbed_model.os_session import OSSession from framework.testbed_model.virtual_device import VirtualDevice -from framework.utils import MesonArgs, TarCompressionFormat @dataclass(slots=True, frozen=True) diff --git a/dts/framework/test_suite.py b/dts/framework/test_suite.py index e06fdd28b9..426c98fdf6 100644 --- a/dts/framework/test_suite.py +++ b/dts/framework/test_suite.py @@ -30,12 +30,12 @@ from typing_extensions import Self from api.exception import ConfigurationError, InternalError +from api.utils import to_pascal_case from framework.config.common import FrozenModel from framework.testbed_model.capability import TestProtocol from framework.testbed_model.topology import Topology from .logger import DTSLogger, get_dts_logger -from .utils import to_pascal_case if TYPE_CHECKING: from framework.context import Context diff --git a/dts/framework/testbed_model/cpu.py b/dts/framework/testbed_model/cpu.py index a9471709dd..68e9c7dffb 100644 --- a/dts/framework/testbed_model/cpu.py +++ b/dts/framework/testbed_model/cpu.py @@ -24,7 +24,7 @@ from dataclasses import dataclass from enum import auto, unique -from framework.utils import StrEnum, expand_range +from api.utils import StrEnum, expand_range @unique diff --git a/dts/framework/testbed_model/linux_session.py b/dts/framework/testbed_model/linux_session.py index 4495ae35cf..26c53f069c 100644 --- a/dts/framework/testbed_model/linux_session.py +++ b/dts/framework/testbed_model/linux_session.py @@ -23,8 +23,8 @@ InternalError, RemoteCommandExecutionError, ) +from api.utils import expand_range from framework.testbed_model.port import PortInfo -from framework.utils import expand_range from .cpu import LogicalCore from .port import Port diff --git a/dts/framework/testbed_model/os_session.py b/dts/framework/testbed_model/os_session.py index f88427a53d..08122874e6 100644 --- a/dts/framework/testbed_model/os_session.py +++ b/dts/framework/testbed_model/os_session.py @@ -29,12 +29,12 @@ from enum import Flag, auto from pathlib import Path, PurePath, PurePosixPath +from api.utils import MesonArgs, TarCompressionFormat from framework.config.node import NodeConfiguration from framework.logger import DTSLogger from framework.remote_session.interactive_remote_session import InteractiveRemoteSession from framework.remote_session.remote_session import CommandResult, RemoteSession from framework.settings import SETTINGS -from framework.utils import MesonArgs, TarCompressionFormat from .cpu import Architecture, LogicalCore from .port import Port, PortInfo diff --git a/dts/framework/testbed_model/posix_session.py b/dts/framework/testbed_model/posix_session.py index db2c3c0c40..61c634dad1 100644 --- a/dts/framework/testbed_model/posix_session.py +++ b/dts/framework/testbed_model/posix_session.py @@ -17,14 +17,14 @@ from pathlib import Path, PurePath, PurePosixPath from api.exception import DPDKBuildError, RemoteCommandExecutionError -from framework.settings import SETTINGS -from framework.utils import ( +from api.utils import ( MesonArgs, TarCompressionFormat, convert_to_list_of_string, create_tarball, extract_tarball, ) +from framework.settings import SETTINGS from .cpu import Architecture from .os_session import FilePermissions, OSSession, OSSessionInfo diff --git a/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py b/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py index 7655751d7e..2804d64990 100644 --- a/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py +++ b/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py @@ -17,8 +17,8 @@ from scapy.packet import Packet from api.artifact import Artifact +from api.utils import get_packet_summaries from framework.testbed_model.port import Port -from framework.utils import get_packet_summaries from .traffic_generator import TrafficGenerator diff --git a/dts/framework/testbed_model/traffic_generator/traffic_generator.py b/dts/framework/testbed_model/traffic_generator/traffic_generator.py index cdda5a7c08..fedce77fdf 100644 --- a/dts/framework/testbed_model/traffic_generator/traffic_generator.py +++ b/dts/framework/testbed_model/traffic_generator/traffic_generator.py @@ -25,7 +25,7 @@ class TrafficGenerator(ABC): Exposes the common public methods of all traffic generators and defines private methods that must implement the traffic generation logic in subclasses. This class also extends from - :class:`framework.utils.MultiInheritanceBaseClass` to allow subclasses the ability to inherit + :class:`api.utils.MultiInheritanceBaseClass` to allow subclasses the ability to inherit from multiple classes to fulfil the traffic generating functionality without breaking single inheritance. """ diff --git a/dts/framework/testbed_model/traffic_generator/trex.py b/dts/framework/testbed_model/traffic_generator/trex.py index 2c3beebc59..7fd6234d27 100644 --- a/dts/framework/testbed_model/traffic_generator/trex.py +++ b/dts/framework/testbed_model/traffic_generator/trex.py @@ -12,6 +12,7 @@ from scapy.packet import Packet from api.exception import SSHTimeoutError +from api.utils import StrEnum from framework.config.node import OS, NodeConfiguration from framework.config.test_run import TrexTrafficGeneratorConfig from framework.parser import TextParser @@ -24,7 +25,6 @@ PerformanceTrafficGenerator, PerformanceTrafficStats, ) -from framework.utils import StrEnum @dataclass(slots=True) diff --git a/dts/tests/TestSuite_l2fwd.py b/dts/tests/TestSuite_l2fwd.py index 596b892730..1e99b82b8c 100644 --- a/dts/tests/TestSuite_l2fwd.py +++ b/dts/tests/TestSuite_l2fwd.py @@ -20,10 +20,10 @@ ) from api.testpmd import TestPmd from api.testpmd.config import EthPeer, SimpleForwardingModes +from api.utils import generate_random_packets from framework.context import filter_cores from framework.test_suite import TestSuite, func_test from framework.testbed_model.cpu import LogicalCoreCount -from framework.utils import generate_random_packets @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_rss.py b/dts/tests/TestSuite_rss.py index 1af0782ffc..1e60bdba07 100644 --- a/dts/tests/TestSuite_rss.py +++ b/dts/tests/TestSuite_rss.py @@ -30,8 +30,8 @@ RSSOffloadTypesFlag, TestPmdVerbosePacket, ) +from api.utils import StrEnum from framework.test_suite import BaseConfig, TestSuite, func_test -from framework.utils import StrEnum class Config(BaseConfig): diff --git a/dts/tests/TestSuite_smoke_tests.py b/dts/tests/TestSuite_smoke_tests.py index 271ad4301c..fce83604a6 100644 --- a/dts/tests/TestSuite_smoke_tests.py +++ b/dts/tests/TestSuite_smoke_tests.py @@ -20,11 +20,11 @@ ) from api.test import verify from api.testpmd import TestPmd +from api.utils import REGEX_FOR_PCI_ADDRESS from framework.config.node import PortConfig from framework.settings import SETTINGS from framework.test_suite import TestSuite, func_test from framework.testbed_model.linux_session import LinuxSession -from framework.utils import REGEX_FOR_PCI_ADDRESS @requires_link_topology(LinkTopology.NO_LINK) diff --git a/dts/tests/TestSuite_softnic.py b/dts/tests/TestSuite_softnic.py index fa91f7ee2f..c57a12c932 100644 --- a/dts/tests/TestSuite_softnic.py +++ b/dts/tests/TestSuite_softnic.py @@ -20,9 +20,9 @@ ) from api.testpmd import TestPmd from api.testpmd.config import EthPeer +from api.utils import generate_random_packets from framework.test_suite import TestSuite, func_test from framework.testbed_model.virtual_device import VirtualDevice -from framework.utils import generate_random_packets @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* [PATCH v6 3/7] dts: move context from framework to API 2026-08-06 17:50 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 1/7] dts: move exception module from framework to API Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 2/7] dts: move utils " Andrew Bailey @ 2026-08-06 17:50 ` Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 4/7] dts: move testbed model " Andrew Bailey ` (3 subsequent siblings) 6 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:50 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx A couple test suites import and get the run context during execution. Move this to the API. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- .../dts/{framework.context.rst => api.context.rst} | 2 +- doc/api/dts/index.rst | 2 +- dts/api/artifact.py | 2 +- dts/{framework => api}/context.py | 0 dts/api/cryptodev/__init__.py | 2 +- dts/api/packet.py | 4 ++-- dts/api/test.py | 2 +- dts/api/testpmd/__init__.py | 2 +- dts/framework/remote_session/blocking_app.py | 2 +- dts/framework/remote_session/dpdk.py | 2 +- dts/framework/remote_session/dpdk_shell.py | 2 +- dts/framework/remote_session/interactive_shell.py | 2 +- dts/framework/test_run.py | 2 +- dts/framework/test_suite.py | 4 ++-- dts/framework/testbed_model/node.py | 2 +- dts/framework/testbed_model/topology.py | 14 +++++++------- dts/tests/TestSuite_cryptodev_latency.py | 2 +- dts/tests/TestSuite_cryptodev_throughput.py | 2 +- dts/tests/TestSuite_l2fwd.py | 2 +- 19 files changed, 26 insertions(+), 26 deletions(-) rename doc/api/dts/{framework.context.rst => api.context.rst} (80%) rename dts/{framework => api}/context.py (100%) diff --git a/doc/api/dts/framework.context.rst b/doc/api/dts/api.context.rst similarity index 80% rename from doc/api/dts/framework.context.rst rename to doc/api/dts/api.context.rst index 925c160360..65b4ab9a47 100644 --- a/doc/api/dts/framework.context.rst +++ b/doc/api/dts/api.context.rst @@ -3,6 +3,6 @@ context - DTS execution context =============================== -.. automodule:: framework.context +.. automodule:: api.context :members: :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index 783270f6e9..98269d6e80 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -32,7 +32,7 @@ Modules framework.test_suite framework.test_result framework.settings - framework.context + api.context framework.logger framework.parser api.utils diff --git a/dts/api/artifact.py b/dts/api/artifact.py index 7d04c7ab49..f3dd07de56 100644 --- a/dts/api/artifact.py +++ b/dts/api/artifact.py @@ -86,7 +86,7 @@ def make_file_path( path /= custom_path else: - from framework.context import get_ctx + from api.context import get_ctx try: ctx = get_ctx() diff --git a/dts/framework/context.py b/dts/api/context.py similarity index 100% rename from dts/framework/context.py rename to dts/api/context.py diff --git a/dts/api/cryptodev/__init__.py b/dts/api/cryptodev/__init__.py index 335b811620..198607696f 100644 --- a/dts/api/cryptodev/__init__.py +++ b/dts/api/cryptodev/__init__.py @@ -14,6 +14,7 @@ from typing_extensions import Unpack +from api.context import get_ctx from api.cryptodev.config import CryptoPmdParams, TestType from api.cryptodev.types import ( CryptodevResults, @@ -23,7 +24,6 @@ VerifyResults, ) from api.exception import RemoteCommandExecutionError, SkippedTestException -from framework.context import get_ctx from framework.remote_session.dpdk_shell import compute_eal_params if TYPE_CHECKING: diff --git a/dts/api/packet.py b/dts/api/packet.py index 98f995deb5..dda3087df4 100644 --- a/dts/api/packet.py +++ b/dts/api/packet.py @@ -27,10 +27,10 @@ from scapy.layers.l2 import Ether from scapy.packet import Packet, Padding, raw +from api.context import get_ctx from api.exception import InternalError from api.test import fail, log_debug from api.utils import get_packet_summaries -from framework.context import get_ctx from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( PacketFilteringConfig, ) @@ -82,7 +82,7 @@ def send_packets_and_capture( Returns: A list of received packets. """ - from framework.context import get_ctx + from api.context import get_ctx from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( CapturingTrafficGenerator, ) diff --git a/dts/api/test.py b/dts/api/test.py index 29d6842111..b6caf5c1ae 100644 --- a/dts/api/test.py +++ b/dts/api/test.py @@ -11,8 +11,8 @@ from api.artifact import Artifact from api.capabilities import LinkTopology +from api.context import get_ctx from api.exception import InternalError, SkippedTestException, TestCaseVerifyError -from framework.context import get_ctx from framework.logger import DTSLogger diff --git a/dts/api/testpmd/__init__.py b/dts/api/testpmd/__init__.py index fef7430cb8..ce41408eb6 100644 --- a/dts/api/testpmd/__init__.py +++ b/dts/api/testpmd/__init__.py @@ -32,6 +32,7 @@ from typing_extensions import Unpack from api.capabilities import LinkTopology, NicCapability +from api.context import get_ctx from api.exception import InteractiveCommandExecutionError, InternalError from api.testpmd.config import PortTopology, SimpleForwardingModes, TestPmdParams from api.testpmd.types import ( @@ -55,7 +56,6 @@ TxOffloadConfiguration, VLANOffloadFlag, ) -from framework.context import get_ctx from framework.params.types import TestPmdParamsDict from framework.remote_session.dpdk_shell import DPDKShell from framework.remote_session.interactive_shell import only_active diff --git a/dts/framework/remote_session/blocking_app.py b/dts/framework/remote_session/blocking_app.py index c3b02dcc62..07db6dfeb0 100644 --- a/dts/framework/remote_session/blocking_app.py +++ b/dts/framework/remote_session/blocking_app.py @@ -30,7 +30,7 @@ from typing_extensions import Self -from framework.context import get_ctx +from api.context import get_ctx from framework.params import Params from framework.params.eal import EalParams from framework.remote_session.dpdk_shell import compute_eal_params diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index ba91c88d11..ee34eb567d 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -14,6 +14,7 @@ from typing import ClassVar, Final from api.capabilities import LinkTopology +from api.context import get_ctx from api.exception import ConfigurationError, RemoteFileNotFoundError from api.utils import MesonArgs, TarCompressionFormat from framework.config.test_run import ( @@ -27,7 +28,6 @@ RemoteDPDKTarballLocation, RemoteDPDKTreeLocation, ) -from framework.context import get_ctx from framework.logger import DTSLogger, get_dts_logger from framework.params.eal import EalParams from framework.remote_session.remote_session import CommandResult diff --git a/dts/framework/remote_session/dpdk_shell.py b/dts/framework/remote_session/dpdk_shell.py index 269c2cada4..a8f169787c 100644 --- a/dts/framework/remote_session/dpdk_shell.py +++ b/dts/framework/remote_session/dpdk_shell.py @@ -10,7 +10,7 @@ from abc import ABC, abstractmethod from pathlib import PurePath -from framework.context import get_ctx +from api.context import get_ctx from framework.params.eal import EalParams from framework.remote_session.interactive_shell import ( InteractiveShell, diff --git a/dts/framework/remote_session/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index 367a01714d..362bc2a352 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -29,12 +29,12 @@ from paramiko import Channel, channel from typing_extensions import Self +from api.context import get_ctx from api.exception import ( InteractiveCommandExecutionError, InteractiveSSHSessionDeadError, InteractiveSSHTimeoutError, ) -from framework.context import get_ctx from framework.logger import DTSLogger, get_dts_logger from framework.params import Params from framework.settings import SETTINGS diff --git a/dts/framework/test_run.py b/dts/framework/test_run.py index 75d82c1104..8b9ae4a49a 100644 --- a/dts/framework/test_run.py +++ b/dts/framework/test_run.py @@ -108,9 +108,9 @@ from typing import ClassVar, Protocol, Union from api.capabilities import LinkTopology +from api.context import Context, init_ctx from api.exception import InternalError, SkippedTestException, TestCaseVerifyError from framework.config.test_run import TestRunConfiguration -from framework.context import Context, init_ctx from framework.logger import DTSLogger, get_dts_logger from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment from framework.settings import SETTINGS diff --git a/dts/framework/test_suite.py b/dts/framework/test_suite.py index 426c98fdf6..6066f7a77a 100644 --- a/dts/framework/test_suite.py +++ b/dts/framework/test_suite.py @@ -38,7 +38,7 @@ from .logger import DTSLogger, get_dts_logger if TYPE_CHECKING: - from framework.context import Context + from api.context import Context class BaseConfig(FrozenModel): @@ -92,7 +92,7 @@ def __init__(self, config: BaseConfig) -> None: Args: config: The test suite configuration. """ - from framework.context import get_ctx + from api.context import get_ctx self.config = config self._ctx = get_ctx() diff --git a/dts/framework/testbed_model/node.py b/dts/framework/testbed_model/node.py index 4f42bf6aeb..40dd7f0666 100644 --- a/dts/framework/testbed_model/node.py +++ b/dts/framework/testbed_model/node.py @@ -242,7 +242,7 @@ def get_node(node_identifier: NodeIdentifier) -> Node | None: if node_identifier == "local": return None - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() if node_identifier == "sut": diff --git a/dts/framework/testbed_model/topology.py b/dts/framework/testbed_model/topology.py index 002faf0b7f..6b8c5edee5 100644 --- a/dts/framework/testbed_model/topology.py +++ b/dts/framework/testbed_model/topology.py @@ -98,7 +98,7 @@ def node_and_ports_from_id(self, node_identifier: NodeIdentifier) -> tuple[Node, Raises: InternalError: If the given `node_identifier` is invalid. """ - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() match node_identifier: @@ -188,7 +188,7 @@ def instantiate_crypto_ports(self) -> None: Raises: InternalError: If crypto virtual functions could not be created on a port. """ - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() for port in ctx.sut_node.cryptodevs: @@ -214,7 +214,7 @@ def instantiate_vf_ports(self) -> None: Raises: InternalError: If virtual function creation fails. """ - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() @@ -243,7 +243,7 @@ def instantiate_vf_ports(self) -> None: def delete_vf_ports(self) -> None: """Delete virtual functions from the SUT node during test run teardown.""" - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() @@ -254,7 +254,7 @@ def delete_vf_ports(self) -> None: def delete_crypto_vf_ports(self) -> None: """Delete crypto virtual functions from the SUT node during test run teardown.""" - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() @@ -267,7 +267,7 @@ def bind_cryptodevs(self, driver: DriverKind): Args: driver: The driver to bind the crypto functions """ - from framework.context import get_ctx + from api.context import get_ctx self._bind_ports_to_drivers(get_ctx().sut_node, self.crypto_vf_ports, driver) @@ -326,7 +326,7 @@ def _prepare_devbind_script(self) -> None: Raises: InternalError: If dpdk-devbind.py could not be found. """ - from framework.context import get_ctx + from api.context import get_ctx local_script_path = Path("..", "usertools", "dpdk-devbind.py").resolve() valid_script_path = local_script_path.exists() diff --git a/dts/tests/TestSuite_cryptodev_latency.py b/dts/tests/TestSuite_cryptodev_latency.py index 4e7d814faa..ed6423eb26 100644 --- a/dts/tests/TestSuite_cryptodev_latency.py +++ b/dts/tests/TestSuite_cryptodev_latency.py @@ -13,6 +13,7 @@ LinkTopology, requires_link_topology, ) +from api.context import get_ctx from api.cryptodev import Cryptodev from api.cryptodev.config import ( AeadAlgName, @@ -30,7 +31,6 @@ CryptodevResults, ) from api.test import skip, verify -from framework.context import get_ctx from framework.test_suite import BaseConfig, TestSuite, crypto_test from framework.testbed_model.virtual_device import VirtualDevice diff --git a/dts/tests/TestSuite_cryptodev_throughput.py b/dts/tests/TestSuite_cryptodev_throughput.py index 53682f35fa..d69714e1fa 100644 --- a/dts/tests/TestSuite_cryptodev_throughput.py +++ b/dts/tests/TestSuite_cryptodev_throughput.py @@ -13,6 +13,7 @@ LinkTopology, requires_link_topology, ) +from api.context import get_ctx from api.cryptodev import Cryptodev from api.cryptodev.config import ( AeadAlgName, @@ -30,7 +31,6 @@ CryptodevResults, ) from api.test import skip, verify -from framework.context import get_ctx from framework.test_suite import BaseConfig, TestSuite, crypto_test from framework.testbed_model.virtual_device import VirtualDevice diff --git a/dts/tests/TestSuite_l2fwd.py b/dts/tests/TestSuite_l2fwd.py index 1e99b82b8c..574842e2e4 100644 --- a/dts/tests/TestSuite_l2fwd.py +++ b/dts/tests/TestSuite_l2fwd.py @@ -13,6 +13,7 @@ requires_link_topology, requires_nic_capability, ) +from api.context import filter_cores from api.packet import ( get_expected_packets, match_all_packets, @@ -21,7 +22,6 @@ from api.testpmd import TestPmd from api.testpmd.config import EthPeer, SimpleForwardingModes from api.utils import generate_random_packets -from framework.context import filter_cores from framework.test_suite import TestSuite, func_test from framework.testbed_model.cpu import LogicalCoreCount -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* [PATCH v6 4/7] dts: move testbed model from framework to API 2026-08-06 17:50 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (2 preceding siblings ...) 2026-08-06 17:50 ` [PATCH v6 3/7] dts: move context " Andrew Bailey @ 2026-08-06 17:50 ` Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 5/7] dts: move test suite module " Andrew Bailey ` (2 subsequent siblings) 6 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:50 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx Multiple test suites import modules from testbed model in the framework. Move this directory to the API. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- ...y.rst => api.testbed_model.capability.rst} | 2 +- ...odel.cpu.rst => api.testbed_model.cpu.rst} | 2 +- ...st => api.testbed_model.linux_session.rst} | 2 +- ...el.node.rst => api.testbed_model.node.rst} | 2 +- ...n.rst => api.testbed_model.os_session.rst} | 2 +- ...el.port.rst => api.testbed_model.port.rst} | 2 +- ...st => api.testbed_model.posix_session.rst} | 2 +- doc/api/dts/api.testbed_model.rst | 28 +++++++++++++++++++ ...ogy.rst => api.testbed_model.topology.rst} | 2 +- ...generator.capturing_traffic_generator.rst} | 2 +- .../api.testbed_model.traffic_generator.rst | 16 +++++++++++ ...testbed_model.traffic_generator.scapy.rst} | 2 +- ...l.traffic_generator.traffic_generator.rst} | 2 +- ...t => api.testbed_model.virtual_device.rst} | 2 +- doc/api/dts/framework.testbed_model.rst | 28 ------------------- ...mework.testbed_model.traffic_generator.rst | 16 ----------- doc/api/dts/index.rst | 2 +- dts/api/artifact.py | 2 +- dts/api/capabilities.py | 8 +++--- dts/api/context.py | 10 +++---- dts/api/packet.py | 10 +++---- .../testbed_model/__init__.py | 0 .../testbed_model/capability.py | 10 +++---- dts/{framework => api}/testbed_model/cpu.py | 2 +- .../testbed_model/linux_session.py | 2 +- dts/{framework => api}/testbed_model/node.py | 0 .../testbed_model/os_session.py | 6 ++-- dts/{framework => api}/testbed_model/port.py | 0 .../testbed_model/posix_session.py | 0 .../testbed_model/topology.py | 4 +-- .../traffic_generator/__init__.py | 2 +- .../capturing_traffic_generator.py | 2 +- .../performance_traffic_generator.py | 0 .../testbed_model/traffic_generator/scapy.py | 12 ++++---- .../traffic_generator/traffic_generator.py | 6 ++-- .../testbed_model/traffic_generator/trex.py | 14 +++++----- .../testbed_model/virtual_device.py | 0 dts/framework/params/eal.py | 6 ++-- dts/framework/params/types.py | 6 ++-- dts/framework/remote_session/blocking_app.py | 2 +- dts/framework/remote_session/dpdk.py | 8 +++--- dts/framework/remote_session/dpdk_shell.py | 2 +- .../remote_session/interactive_shell.py | 2 +- dts/framework/runner.py | 2 +- dts/framework/test_result.py | 2 +- dts/framework/test_run.py | 16 +++++------ dts/framework/test_suite.py | 4 +-- dts/tests/TestSuite_blocklist.py | 2 +- dts/tests/TestSuite_cryptodev_latency.py | 2 +- dts/tests/TestSuite_cryptodev_throughput.py | 2 +- dts/tests/TestSuite_l2fwd.py | 2 +- dts/tests/TestSuite_packet_capture.py | 8 +++--- dts/tests/TestSuite_smoke_tests.py | 2 +- dts/tests/TestSuite_softnic.py | 2 +- dts/tests/TestSuite_virtio_forward.py | 6 ++-- 55 files changed, 140 insertions(+), 140 deletions(-) rename doc/api/dts/{framework.testbed_model.capability.rst => api.testbed_model.capability.rst} (74%) rename doc/api/dts/{framework.testbed_model.cpu.rst => api.testbed_model.cpu.rst} (78%) rename doc/api/dts/{framework.testbed_model.linux_session.rst => api.testbed_model.linux_session.rst} (74%) rename doc/api/dts/{framework.testbed_model.node.rst => api.testbed_model.node.rst} (71%) rename doc/api/dts/{framework.testbed_model.os_session.rst => api.testbed_model.os_session.rst} (76%) rename doc/api/dts/{framework.testbed_model.port.rst => api.testbed_model.port.rst} (77%) rename doc/api/dts/{framework.testbed_model.posix_session.rst => api.testbed_model.posix_session.rst} (74%) create mode 100644 doc/api/dts/api.testbed_model.rst rename doc/api/dts/{framework.testbed_model.topology.rst => api.testbed_model.topology.rst} (73%) rename doc/api/dts/{framework.testbed_model.traffic_generator.capturing_traffic_generator.rst => api.testbed_model.traffic_generator.capturing_traffic_generator.rst} (68%) create mode 100644 doc/api/dts/api.testbed_model.traffic_generator.rst rename doc/api/dts/{framework.testbed_model.traffic_generator.scapy.rst => api.testbed_model.traffic_generator.scapy.rst} (70%) rename doc/api/dts/{framework.testbed_model.traffic_generator.traffic_generator.rst => api.testbed_model.traffic_generator.traffic_generator.rst} (65%) rename doc/api/dts/{framework.testbed_model.virtual_device.rst => api.testbed_model.virtual_device.rst} (72%) delete mode 100644 doc/api/dts/framework.testbed_model.rst delete mode 100644 doc/api/dts/framework.testbed_model.traffic_generator.rst rename dts/{framework => api}/testbed_model/__init__.py (100%) rename dts/{framework => api}/testbed_model/capability.py (99%) rename dts/{framework => api}/testbed_model/cpu.py (99%) rename dts/{framework => api}/testbed_model/linux_session.py (99%) rename dts/{framework => api}/testbed_model/node.py (100%) rename dts/{framework => api}/testbed_model/os_session.py (99%) rename dts/{framework => api}/testbed_model/port.py (100%) rename dts/{framework => api}/testbed_model/posix_session.py (100%) rename dts/{framework => api}/testbed_model/topology.py (99%) rename dts/{framework => api}/testbed_model/traffic_generator/__init__.py (97%) rename dts/{framework => api}/testbed_model/traffic_generator/capturing_traffic_generator.py (99%) rename dts/{framework => api}/testbed_model/traffic_generator/performance_traffic_generator.py (100%) rename dts/{framework => api}/testbed_model/traffic_generator/scapy.py (98%) rename dts/{framework => api}/testbed_model/traffic_generator/traffic_generator.py (94%) rename dts/{framework => api}/testbed_model/traffic_generator/trex.py (97%) rename dts/{framework => api}/testbed_model/virtual_device.py (100%) diff --git a/doc/api/dts/framework.testbed_model.capability.rst b/doc/api/dts/api.testbed_model.capability.rst similarity index 74% rename from doc/api/dts/framework.testbed_model.capability.rst rename to doc/api/dts/api.testbed_model.capability.rst index fab91cad83..88e396dddb 100644 --- a/doc/api/dts/framework.testbed_model.capability.rst +++ b/doc/api/dts/api.testbed_model.capability.rst @@ -3,6 +3,6 @@ capability - Testbed Capabilities ================================= -.. automodule:: framework.testbed_model.capability +.. automodule:: api.testbed_model.capability :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.cpu.rst b/doc/api/dts/api.testbed_model.cpu.rst similarity index 78% rename from doc/api/dts/framework.testbed_model.cpu.rst rename to doc/api/dts/api.testbed_model.cpu.rst index 997f2a9795..dbbb29480a 100644 --- a/doc/api/dts/framework.testbed_model.cpu.rst +++ b/doc/api/dts/api.testbed_model.cpu.rst @@ -3,6 +3,6 @@ cpu - CPU Representation and Utilities ====================================== -.. automodule:: framework.testbed_model.cpu +.. automodule:: api.testbed_model.cpu :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.linux_session.rst b/doc/api/dts/api.testbed_model.linux_session.rst similarity index 74% rename from doc/api/dts/framework.testbed_model.linux_session.rst rename to doc/api/dts/api.testbed_model.linux_session.rst index 7567816199..cfe79d8bca 100644 --- a/doc/api/dts/framework.testbed_model.linux_session.rst +++ b/doc/api/dts/api.testbed_model.linux_session.rst @@ -3,6 +3,6 @@ linux\_session - Linux Remote Session ===================================== -.. automodule:: framework.testbed_model.linux_session +.. automodule:: api.testbed_model.linux_session :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.node.rst b/doc/api/dts/api.testbed_model.node.rst similarity index 71% rename from doc/api/dts/framework.testbed_model.node.rst rename to doc/api/dts/api.testbed_model.node.rst index 23c6c46a00..15f522e5f7 100644 --- a/doc/api/dts/framework.testbed_model.node.rst +++ b/doc/api/dts/api.testbed_model.node.rst @@ -3,6 +3,6 @@ node - Base Node ================ -.. automodule:: framework.testbed_model.node +.. automodule:: api.testbed_model.node :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.os_session.rst b/doc/api/dts/api.testbed_model.os_session.rst similarity index 76% rename from doc/api/dts/framework.testbed_model.os_session.rst rename to doc/api/dts/api.testbed_model.os_session.rst index ecfb352311..e7e3f9894f 100644 --- a/doc/api/dts/framework.testbed_model.os_session.rst +++ b/doc/api/dts/api.testbed_model.os_session.rst @@ -3,6 +3,6 @@ os\_session - OS-aware Remote Session ABC ========================================= -.. automodule:: framework.testbed_model.os_session +.. automodule:: api.testbed_model.os_session :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.port.rst b/doc/api/dts/api.testbed_model.port.rst similarity index 77% rename from doc/api/dts/framework.testbed_model.port.rst rename to doc/api/dts/api.testbed_model.port.rst index fdb7ca8a1d..d64501aef0 100644 --- a/doc/api/dts/framework.testbed_model.port.rst +++ b/doc/api/dts/api.testbed_model.port.rst @@ -3,7 +3,7 @@ port - NIC Port Representation ============================== -.. automodule:: framework.testbed_model.port +.. automodule:: api.testbed_model.port :members: :show-inheritance: :noindex: diff --git a/doc/api/dts/framework.testbed_model.posix_session.rst b/doc/api/dts/api.testbed_model.posix_session.rst similarity index 74% rename from doc/api/dts/framework.testbed_model.posix_session.rst rename to doc/api/dts/api.testbed_model.posix_session.rst index e65585fd85..9f0e9ff18d 100644 --- a/doc/api/dts/framework.testbed_model.posix_session.rst +++ b/doc/api/dts/api.testbed_model.posix_session.rst @@ -3,6 +3,6 @@ posix\_session - Posix Remote Session ===================================== -.. automodule:: framework.testbed_model.posix_session +.. automodule:: api.testbed_model.posix_session :members: :show-inheritance: diff --git a/doc/api/dts/api.testbed_model.rst b/doc/api/dts/api.testbed_model.rst new file mode 100644 index 0000000000..5e2e5189b2 --- /dev/null +++ b/doc/api/dts/api.testbed_model.rst @@ -0,0 +1,28 @@ +.. SPDX-License-Identifier: BSD-3-Clause + +testbed\_model - Testbed Modelling Package +========================================== + +.. automodule:: api.testbed_model + :members: + :show-inheritance: + +.. toctree:: + :hidden: + :maxdepth: 2 + + api.testbed_model.traffic_generator + +.. toctree:: + :hidden: + :maxdepth: 1 + + api.testbed_model.os_session + api.testbed_model.linux_session + api.testbed_model.posix_session + api.testbed_model.node + api.testbed_model.capability + api.testbed_model.cpu + api.testbed_model.port + api.testbed_model.topology + api.testbed_model.virtual_device diff --git a/doc/api/dts/framework.testbed_model.topology.rst b/doc/api/dts/api.testbed_model.topology.rst similarity index 73% rename from doc/api/dts/framework.testbed_model.topology.rst rename to doc/api/dts/api.testbed_model.topology.rst index 496f2a895f..bb63fe38dc 100644 --- a/doc/api/dts/framework.testbed_model.topology.rst +++ b/doc/api/dts/api.testbed_model.topology.rst @@ -3,6 +3,6 @@ topology - Testbed Topology =========================== -.. automodule:: framework.testbed_model.topology +.. automodule:: api.testbed_model.topology :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst b/doc/api/dts/api.testbed_model.traffic_generator.capturing_traffic_generator.rst similarity index 68% rename from doc/api/dts/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst rename to doc/api/dts/api.testbed_model.traffic_generator.capturing_traffic_generator.rst index 29fa834042..cfe03201a7 100644 --- a/doc/api/dts/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst +++ b/doc/api/dts/api.testbed_model.traffic_generator.capturing_traffic_generator.rst @@ -3,6 +3,6 @@ capturing\_traffic\_generator - Base Capturing TG ABC ===================================================== -.. automodule:: framework.testbed_model.traffic_generator.capturing_traffic_generator +.. automodule:: api.testbed_model.traffic_generator.capturing_traffic_generator :members: :show-inheritance: diff --git a/doc/api/dts/api.testbed_model.traffic_generator.rst b/doc/api/dts/api.testbed_model.traffic_generator.rst new file mode 100644 index 0000000000..311bdcf6b9 --- /dev/null +++ b/doc/api/dts/api.testbed_model.traffic_generator.rst @@ -0,0 +1,16 @@ +.. SPDX-License-Identifier: BSD-3-Clause + +traffic\_generator Subpackage +============================= + +.. automodule:: api.testbed_model.traffic_generator + :members: + :show-inheritance: + +.. toctree:: + :hidden: + :maxdepth: 1 + + api.testbed_model.traffic_generator.traffic_generator + api.testbed_model.traffic_generator.capturing_traffic_generator + api.testbed_model.traffic_generator.scapy diff --git a/doc/api/dts/framework.testbed_model.traffic_generator.scapy.rst b/doc/api/dts/api.testbed_model.traffic_generator.scapy.rst similarity index 70% rename from doc/api/dts/framework.testbed_model.traffic_generator.scapy.rst rename to doc/api/dts/api.testbed_model.traffic_generator.scapy.rst index df78ac9514..949bb66632 100644 --- a/doc/api/dts/framework.testbed_model.traffic_generator.scapy.rst +++ b/doc/api/dts/api.testbed_model.traffic_generator.scapy.rst @@ -3,6 +3,6 @@ scapy - Capturing Traffic Generator =================================== -.. automodule:: framework.testbed_model.traffic_generator.scapy +.. automodule:: api.testbed_model.traffic_generator.scapy :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.traffic_generator.traffic_generator.rst b/doc/api/dts/api.testbed_model.traffic_generator.traffic_generator.rst similarity index 65% rename from doc/api/dts/framework.testbed_model.traffic_generator.traffic_generator.rst rename to doc/api/dts/api.testbed_model.traffic_generator.traffic_generator.rst index bfec728dee..1045e534b5 100644 --- a/doc/api/dts/framework.testbed_model.traffic_generator.traffic_generator.rst +++ b/doc/api/dts/api.testbed_model.traffic_generator.traffic_generator.rst @@ -3,6 +3,6 @@ traffic\_generator - Base TG ABC ================================ -.. automodule:: framework.testbed_model.traffic_generator.traffic_generator +.. automodule:: api.testbed_model.traffic_generator.traffic_generator :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.virtual_device.rst b/doc/api/dts/api.testbed_model.virtual_device.rst similarity index 72% rename from doc/api/dts/framework.testbed_model.virtual_device.rst rename to doc/api/dts/api.testbed_model.virtual_device.rst index a6b0420e75..97adc895f6 100644 --- a/doc/api/dts/framework.testbed_model.virtual_device.rst +++ b/doc/api/dts/api.testbed_model.virtual_device.rst @@ -3,6 +3,6 @@ virtual\_device - Virtual Devices ================================= -.. automodule:: framework.testbed_model.virtual_device +.. automodule:: api.testbed_model.virtual_device :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.rst b/doc/api/dts/framework.testbed_model.rst deleted file mode 100644 index f283178f6a..0000000000 --- a/doc/api/dts/framework.testbed_model.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. SPDX-License-Identifier: BSD-3-Clause - -testbed\_model - Testbed Modelling Package -========================================== - -.. automodule:: framework.testbed_model - :members: - :show-inheritance: - -.. toctree:: - :hidden: - :maxdepth: 2 - - framework.testbed_model.traffic_generator - -.. toctree:: - :hidden: - :maxdepth: 1 - - framework.testbed_model.os_session - framework.testbed_model.linux_session - framework.testbed_model.posix_session - framework.testbed_model.node - framework.testbed_model.capability - framework.testbed_model.cpu - framework.testbed_model.port - framework.testbed_model.topology - framework.testbed_model.virtual_device diff --git a/doc/api/dts/framework.testbed_model.traffic_generator.rst b/doc/api/dts/framework.testbed_model.traffic_generator.rst deleted file mode 100644 index 24c250ee3a..0000000000 --- a/doc/api/dts/framework.testbed_model.traffic_generator.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. SPDX-License-Identifier: BSD-3-Clause - -traffic\_generator Subpackage -============================= - -.. automodule:: framework.testbed_model.traffic_generator - :members: - :show-inheritance: - -.. toctree:: - :hidden: - :maxdepth: 1 - - framework.testbed_model.traffic_generator.traffic_generator - framework.testbed_model.traffic_generator.capturing_traffic_generator - framework.testbed_model.traffic_generator.scapy diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index 98269d6e80..f47e4af3f2 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -16,7 +16,7 @@ Packages tests api - framework.testbed_model + api.testbed_model framework.remote_session framework.params framework.config diff --git a/dts/api/artifact.py b/dts/api/artifact.py index f3dd07de56..74a8ac667f 100644 --- a/dts/api/artifact.py +++ b/dts/api/artifact.py @@ -48,9 +48,9 @@ from typing_extensions import Buffer from api.exception import InternalError +from api.testbed_model.node import Node, NodeIdentifier, get_node from framework.logger import DTSLogger, get_dts_logger from framework.settings import SETTINGS -from framework.testbed_model.node import Node, NodeIdentifier, get_node TextMode: TypeAlias = ( Literal["r", "r+", "w", "w+", "a", "a+", "x", "x+"] diff --git a/dts/api/capabilities.py b/dts/api/capabilities.py index b0c1d81d36..8ed832a588 100644 --- a/dts/api/capabilities.py +++ b/dts/api/capabilities.py @@ -23,7 +23,7 @@ .. code:: python from framework.test_suite import TestSuite, func_test - from framework.testbed_model.capability import LinkTopology, requires_link_topology + from api.testbed_model.capability import LinkTopology, requires_link_topology # The whole test suite (each test case within) doesn't require any links. @requires_link_topology(LinkTopology.NO_LINK) @func_test @@ -34,7 +34,7 @@ def hello_world_single_core(self): .. code:: python from framework.test_suite import TestSuite, func_test - from framework.testbed_model.capability import NicCapability, requires_nic_capability + from api.testbed_model.capability import NicCapability, requires_nic_capability class TestPmdBufferScatter(TestSuite): # only the test case requires the SCATTERED_RX_ENABLED capability # other test cases may not require it @@ -237,7 +237,7 @@ def requires_link_topology( Returns: The decorated test case or test suite. """ - from framework.testbed_model.capability import TopologyCapability + from api.testbed_model.capability import TopologyCapability def add_required_topology( test_case_or_suite: type["TestProtocol"], @@ -260,7 +260,7 @@ def requires_nic_capability( Returns: The decorated test case or test suite. """ - from framework.testbed_model.capability import DecoratedNicCapability + from api.testbed_model.capability import DecoratedNicCapability def add_required_capability( test_case_or_suite: type["TestProtocol"], diff --git a/dts/api/context.py b/dts/api/context.py index 709b99421e..57e14ef598 100644 --- a/dts/api/context.py +++ b/dts/api/context.py @@ -9,17 +9,17 @@ from typing import TYPE_CHECKING, Any, Optional, ParamSpec, Union from api.exception import InternalError +from api.testbed_model.cpu import LogicalCoreCount, LogicalCoreList +from api.testbed_model.node import Node +from api.testbed_model.topology import Topology from framework.remote_session.shell_pool import ShellPool from framework.settings import SETTINGS -from framework.testbed_model.cpu import LogicalCoreCount, LogicalCoreList -from framework.testbed_model.node import Node -from framework.testbed_model.topology import Topology if TYPE_CHECKING: + from api.testbed_model.capability import TestProtocol + from api.testbed_model.traffic_generator.traffic_generator import TrafficGenerator from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment from framework.test_suite import TestCase, TestSuite - from framework.testbed_model.capability import TestProtocol - from framework.testbed_model.traffic_generator.traffic_generator import TrafficGenerator P = ParamSpec("P") diff --git a/dts/api/packet.py b/dts/api/packet.py index dda3087df4..defbb758c8 100644 --- a/dts/api/packet.py +++ b/dts/api/packet.py @@ -30,13 +30,13 @@ from api.context import get_ctx from api.exception import InternalError from api.test import fail, log_debug -from api.utils import get_packet_summaries -from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( +from api.testbed_model.traffic_generator.capturing_traffic_generator import ( PacketFilteringConfig, ) -from framework.testbed_model.traffic_generator.performance_traffic_generator import ( +from api.testbed_model.traffic_generator.performance_traffic_generator import ( PerformanceTrafficStats, ) +from api.utils import get_packet_summaries def send_packet_and_capture( @@ -83,7 +83,7 @@ def send_packets_and_capture( A list of received packets. """ from api.context import get_ctx - from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( + from api.testbed_model.traffic_generator.capturing_traffic_generator import ( CapturingTrafficGenerator, ) @@ -339,7 +339,7 @@ def assess_performance_by_packet( Returns: Performance statistics of the generated test. """ - from framework.testbed_model.traffic_generator.performance_traffic_generator import ( + from api.testbed_model.traffic_generator.performance_traffic_generator import ( PerformanceTrafficGenerator, ) diff --git a/dts/framework/testbed_model/__init__.py b/dts/api/testbed_model/__init__.py similarity index 100% rename from dts/framework/testbed_model/__init__.py rename to dts/api/testbed_model/__init__.py diff --git a/dts/framework/testbed_model/capability.py b/dts/api/testbed_model/capability.py similarity index 99% rename from dts/framework/testbed_model/capability.py rename to dts/api/testbed_model/capability.py index 00b40a3b1e..2748daa8a4 100644 --- a/dts/framework/testbed_model/capability.py +++ b/dts/api/testbed_model/capability.py @@ -26,7 +26,7 @@ .. code:: python from framework.test_suite import TestSuite, func_test - from framework.testbed_model.capability import LinkTopology, requires + from api.testbed_model.capability import LinkTopology, requires # The whole test suite (each test case within) doesn't require any links. @requires_link_topology(LinkTopology.NO_LINK) @func_test @@ -37,7 +37,7 @@ def hello_world_single_core(self): .. code:: python from framework.test_suite import TestSuite, func_test - from framework.testbed_model.capability import NicCapability, requires + from api.testbed_model.capability import NicCapability, requires class TestPmdBufferScatter(TestSuite): # only the test case requires the SCATTERED_RX_ENABLED capability # other test cases may not require it @@ -65,10 +65,10 @@ def test_scatter_mbuf_2048(self): from api.capabilities import LinkTopology, NicCapability from api.exception import ConfigurationError, InternalError, SkippedTestException +from api.testbed_model.node import Node +from api.testbed_model.port import DriverKind +from api.testbed_model.topology import Topology from framework.logger import get_dts_logger -from framework.testbed_model.node import Node -from framework.testbed_model.port import DriverKind -from framework.testbed_model.topology import Topology if TYPE_CHECKING: from api.testpmd import TestPmd diff --git a/dts/framework/testbed_model/cpu.py b/dts/api/testbed_model/cpu.py similarity index 99% rename from dts/framework/testbed_model/cpu.py rename to dts/api/testbed_model/cpu.py index 68e9c7dffb..34fb6d0848 100644 --- a/dts/framework/testbed_model/cpu.py +++ b/dts/api/testbed_model/cpu.py @@ -29,7 +29,7 @@ @unique class Architecture(StrEnum): - r"""The supported architectures of :class:`~framework.testbed_model.node.Node`\s.""" + r"""The supported architectures of :class:`~api.testbed_model.node.Node`\s.""" #: i686 = auto() diff --git a/dts/framework/testbed_model/linux_session.py b/dts/api/testbed_model/linux_session.py similarity index 99% rename from dts/framework/testbed_model/linux_session.py rename to dts/api/testbed_model/linux_session.py index 26c53f069c..399968efd4 100644 --- a/dts/framework/testbed_model/linux_session.py +++ b/dts/api/testbed_model/linux_session.py @@ -23,8 +23,8 @@ InternalError, RemoteCommandExecutionError, ) +from api.testbed_model.port import PortInfo from api.utils import expand_range -from framework.testbed_model.port import PortInfo from .cpu import LogicalCore from .port import Port diff --git a/dts/framework/testbed_model/node.py b/dts/api/testbed_model/node.py similarity index 100% rename from dts/framework/testbed_model/node.py rename to dts/api/testbed_model/node.py diff --git a/dts/framework/testbed_model/os_session.py b/dts/api/testbed_model/os_session.py similarity index 99% rename from dts/framework/testbed_model/os_session.py rename to dts/api/testbed_model/os_session.py index 08122874e6..7944fda8c0 100644 --- a/dts/framework/testbed_model/os_session.py +++ b/dts/api/testbed_model/os_session.py @@ -73,11 +73,11 @@ class OSSessionInfo: Attributes: os_name: The name of the running operating system of - the :class:`~framework.testbed_model.node.Node`. + the :class:`~api.testbed_model.node.Node`. os_version: The version of the running operating system of - the :class:`~framework.testbed_model.node.Node`. + the :class:`~api.testbed_model.node.Node`. kernel_version: The kernel version of the running operating system of - the :class:`~framework.testbed_model.node.Node`. + the :class:`~api.testbed_model.node.Node`. """ os_name: str diff --git a/dts/framework/testbed_model/port.py b/dts/api/testbed_model/port.py similarity index 100% rename from dts/framework/testbed_model/port.py rename to dts/api/testbed_model/port.py diff --git a/dts/framework/testbed_model/posix_session.py b/dts/api/testbed_model/posix_session.py similarity index 100% rename from dts/framework/testbed_model/posix_session.py rename to dts/api/testbed_model/posix_session.py diff --git a/dts/framework/testbed_model/topology.py b/dts/api/testbed_model/topology.py similarity index 99% rename from dts/framework/testbed_model/topology.py rename to dts/api/testbed_model/topology.py index 6b8c5edee5..7d074f9ef4 100644 --- a/dts/framework/testbed_model/topology.py +++ b/dts/api/testbed_model/topology.py @@ -19,8 +19,8 @@ from api.capabilities import LinkTopology from api.exception import ConfigurationError, InternalError -from framework.testbed_model.linux_session import LinuxSession -from framework.testbed_model.node import Node, NodeIdentifier +from api.testbed_model.linux_session import LinuxSession +from api.testbed_model.node import Node, NodeIdentifier from .port import DriverKind, Port, PortConfig diff --git a/dts/framework/testbed_model/traffic_generator/__init__.py b/dts/api/testbed_model/traffic_generator/__init__.py similarity index 97% rename from dts/framework/testbed_model/traffic_generator/__init__.py rename to dts/api/testbed_model/traffic_generator/__init__.py index 324b5e88f3..11fa25448a 100644 --- a/dts/framework/testbed_model/traffic_generator/__init__.py +++ b/dts/api/testbed_model/traffic_generator/__init__.py @@ -15,12 +15,12 @@ """ from api.exception import ConfigurationError +from api.testbed_model.node import Node from framework.config.test_run import ( ScapyTrafficGeneratorConfig, TrafficGeneratorConfig, TrexTrafficGeneratorConfig, ) -from framework.testbed_model.node import Node from .scapy import ScapyTrafficGenerator from .traffic_generator import TrafficGenerator diff --git a/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py b/dts/api/testbed_model/traffic_generator/capturing_traffic_generator.py similarity index 99% rename from dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py rename to dts/api/testbed_model/traffic_generator/capturing_traffic_generator.py index 2804d64990..db274e5e82 100644 --- a/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py +++ b/dts/api/testbed_model/traffic_generator/capturing_traffic_generator.py @@ -17,8 +17,8 @@ from scapy.packet import Packet from api.artifact import Artifact +from api.testbed_model.port import Port from api.utils import get_packet_summaries -from framework.testbed_model.port import Port from .traffic_generator import TrafficGenerator diff --git a/dts/framework/testbed_model/traffic_generator/performance_traffic_generator.py b/dts/api/testbed_model/traffic_generator/performance_traffic_generator.py similarity index 100% rename from dts/framework/testbed_model/traffic_generator/performance_traffic_generator.py rename to dts/api/testbed_model/traffic_generator/performance_traffic_generator.py diff --git a/dts/framework/testbed_model/traffic_generator/scapy.py b/dts/api/testbed_model/traffic_generator/scapy.py similarity index 98% rename from dts/framework/testbed_model/traffic_generator/scapy.py rename to dts/api/testbed_model/traffic_generator/scapy.py index 70856cc1f0..1edc1af838 100644 --- a/dts/framework/testbed_model/traffic_generator/scapy.py +++ b/dts/api/testbed_model/traffic_generator/scapy.py @@ -26,15 +26,15 @@ from scapy.packet import Packet from api.exception import InteractiveSSHSessionDeadError, InternalError +from api.testbed_model.node import Node +from api.testbed_model.port import Port +from api.testbed_model.topology import Topology +from api.testbed_model.traffic_generator.capturing_traffic_generator import ( + PacketFilteringConfig, +) from framework.config.node import OS from framework.config.test_run import ScapyTrafficGeneratorConfig from framework.remote_session.python_shell import PythonShell -from framework.testbed_model.node import Node -from framework.testbed_model.port import Port -from framework.testbed_model.topology import Topology -from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( - PacketFilteringConfig, -) from .capturing_traffic_generator import CapturingTrafficGenerator diff --git a/dts/framework/testbed_model/traffic_generator/traffic_generator.py b/dts/api/testbed_model/traffic_generator/traffic_generator.py similarity index 94% rename from dts/framework/testbed_model/traffic_generator/traffic_generator.py rename to dts/api/testbed_model/traffic_generator/traffic_generator.py index fedce77fdf..5fd68e5144 100644 --- a/dts/framework/testbed_model/traffic_generator/traffic_generator.py +++ b/dts/api/testbed_model/traffic_generator/traffic_generator.py @@ -13,11 +13,11 @@ from scapy.packet import Packet +from api.testbed_model.node import Node +from api.testbed_model.port import Port +from api.testbed_model.topology import Topology from framework.config.test_run import TrafficGeneratorConfig from framework.logger import DTSLogger, get_dts_logger -from framework.testbed_model.node import Node -from framework.testbed_model.port import Port -from framework.testbed_model.topology import Topology class TrafficGenerator(ABC): diff --git a/dts/framework/testbed_model/traffic_generator/trex.py b/dts/api/testbed_model/traffic_generator/trex.py similarity index 97% rename from dts/framework/testbed_model/traffic_generator/trex.py rename to dts/api/testbed_model/traffic_generator/trex.py index 7fd6234d27..ffb1390706 100644 --- a/dts/framework/testbed_model/traffic_generator/trex.py +++ b/dts/api/testbed_model/traffic_generator/trex.py @@ -12,19 +12,19 @@ from scapy.packet import Packet from api.exception import SSHTimeoutError +from api.testbed_model.node import Node, create_session +from api.testbed_model.os_session import OSSession +from api.testbed_model.topology import Topology +from api.testbed_model.traffic_generator.performance_traffic_generator import ( + PerformanceTrafficGenerator, + PerformanceTrafficStats, +) from api.utils import StrEnum from framework.config.node import OS, NodeConfiguration from framework.config.test_run import TrexTrafficGeneratorConfig from framework.parser import TextParser from framework.remote_session.blocking_app import BlockingApp from framework.remote_session.python_shell import PythonShell -from framework.testbed_model.node import Node, create_session -from framework.testbed_model.os_session import OSSession -from framework.testbed_model.topology import Topology -from framework.testbed_model.traffic_generator.performance_traffic_generator import ( - PerformanceTrafficGenerator, - PerformanceTrafficStats, -) @dataclass(slots=True) diff --git a/dts/framework/testbed_model/virtual_device.py b/dts/api/testbed_model/virtual_device.py similarity index 100% rename from dts/framework/testbed_model/virtual_device.py rename to dts/api/testbed_model/virtual_device.py diff --git a/dts/framework/params/eal.py b/dts/framework/params/eal.py index e84a20f02f..86bfd3fcc6 100644 --- a/dts/framework/params/eal.py +++ b/dts/framework/params/eal.py @@ -6,12 +6,12 @@ from dataclasses import dataclass, field from typing import TYPE_CHECKING, Literal +from api.testbed_model.cpu import LogicalCoreList +from api.testbed_model.virtual_device import VirtualDevice from framework.params import Params, Switch -from framework.testbed_model.cpu import LogicalCoreList -from framework.testbed_model.virtual_device import VirtualDevice if TYPE_CHECKING: - from framework.testbed_model.port import Port + from api.testbed_model.port import Port def _port_to_pci(port: "Port") -> str: diff --git a/dts/framework/params/types.py b/dts/framework/params/types.py index a9f3749083..f9a51963a2 100644 --- a/dts/framework/params/types.py +++ b/dts/framework/params/types.py @@ -32,6 +32,9 @@ def create_testpmd(**kwargs: Unpack[TestPmdParamsDict]): TestType, TLSVersion, ) +from api.testbed_model.cpu import LogicalCoreList +from api.testbed_model.port import Port +from api.testbed_model.virtual_device import VirtualDevice from api.testpmd.config import ( AnonMempoolAllocationMode, EthPeer, @@ -55,9 +58,6 @@ def create_testpmd(**kwargs: Unpack[TestPmdParamsDict]): ) from api.testpmd.types import RxOffloadCapability, TxOffloadCapability from framework.params import Switch, YesNoSwitch -from framework.testbed_model.cpu import LogicalCoreList -from framework.testbed_model.port import Port -from framework.testbed_model.virtual_device import VirtualDevice class EalParamsDict(TypedDict, total=False): diff --git a/dts/framework/remote_session/blocking_app.py b/dts/framework/remote_session/blocking_app.py index 07db6dfeb0..84db3974b1 100644 --- a/dts/framework/remote_session/blocking_app.py +++ b/dts/framework/remote_session/blocking_app.py @@ -31,11 +31,11 @@ from typing_extensions import Self from api.context import get_ctx +from api.testbed_model.node import Node from framework.params import Params from framework.params.eal import EalParams from framework.remote_session.dpdk_shell import compute_eal_params from framework.remote_session.interactive_shell import InteractiveShell -from framework.testbed_model.node import Node P = TypeVar("P", bound=Params) diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index ee34eb567d..c02c68af77 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -16,6 +16,10 @@ from api.capabilities import LinkTopology from api.context import get_ctx from api.exception import ConfigurationError, RemoteFileNotFoundError +from api.testbed_model.cpu import LogicalCore, LogicalCoreCount, LogicalCoreList, lcore_filter +from api.testbed_model.node import Node +from api.testbed_model.os_session import OSSession +from api.testbed_model.virtual_device import VirtualDevice from api.utils import MesonArgs, TarCompressionFormat from framework.config.test_run import ( DPDKBuildConfiguration, @@ -31,10 +35,6 @@ from framework.logger import DTSLogger, get_dts_logger from framework.params.eal import EalParams from framework.remote_session.remote_session import CommandResult -from framework.testbed_model.cpu import LogicalCore, LogicalCoreCount, LogicalCoreList, lcore_filter -from framework.testbed_model.node import Node -from framework.testbed_model.os_session import OSSession -from framework.testbed_model.virtual_device import VirtualDevice @dataclass(slots=True, frozen=True) diff --git a/dts/framework/remote_session/dpdk_shell.py b/dts/framework/remote_session/dpdk_shell.py index a8f169787c..b807f9bdae 100644 --- a/dts/framework/remote_session/dpdk_shell.py +++ b/dts/framework/remote_session/dpdk_shell.py @@ -11,12 +11,12 @@ from pathlib import PurePath from api.context import get_ctx +from api.testbed_model.cpu import LogicalCoreList from framework.params.eal import EalParams from framework.remote_session.interactive_shell import ( InteractiveShell, only_active, ) -from framework.testbed_model.cpu import LogicalCoreList def compute_eal_params( diff --git a/dts/framework/remote_session/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index 362bc2a352..831861a9ac 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -35,10 +35,10 @@ InteractiveSSHSessionDeadError, InteractiveSSHTimeoutError, ) +from api.testbed_model.node import Node from framework.logger import DTSLogger, get_dts_logger from framework.params import Params from framework.settings import SETTINGS -from framework.testbed_model.node import Node P = ParamSpec("P") T = TypeVar("T", bound="InteractiveShell") diff --git a/dts/framework/runner.py b/dts/framework/runner.py index cb137fbf7b..ba5bc45cfc 100644 --- a/dts/framework/runner.py +++ b/dts/framework/runner.py @@ -13,9 +13,9 @@ import textwrap from api.exception import ConfigurationError +from api.testbed_model.node import Node from framework.config.common import ValidationContext from framework.test_run import TestRun -from framework.testbed_model.node import Node from .config import Configuration, load_config from .logger import DTSLogger, get_dts_logger diff --git a/dts/framework/test_result.py b/dts/framework/test_result.py index 3cecb928ca..5f945163ce 100644 --- a/dts/framework/test_result.py +++ b/dts/framework/test_result.py @@ -36,9 +36,9 @@ from typing_extensions import OrderedDict from api.exception import DTSError, ErrorSeverity, InternalError +from api.testbed_model.os_session import OSSessionInfo from framework.remote_session.dpdk import DPDKBuildInfo from framework.settings import SETTINGS -from framework.testbed_model.os_session import OSSessionInfo class Result(IntEnum): diff --git a/dts/framework/test_run.py b/dts/framework/test_run.py index 8b9ae4a49a..42a56d38c9 100644 --- a/dts/framework/test_run.py +++ b/dts/framework/test_run.py @@ -110,20 +110,20 @@ from api.capabilities import LinkTopology from api.context import Context, init_ctx from api.exception import InternalError, SkippedTestException, TestCaseVerifyError +from api.testbed_model.capability import ( + Capability, + get_supported_capabilities, + test_if_supported, +) +from api.testbed_model.node import Node +from api.testbed_model.topology import PortLink, Topology +from api.testbed_model.traffic_generator import create_traffic_generator from framework.config.test_run import TestRunConfiguration from framework.logger import DTSLogger, get_dts_logger from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment from framework.settings import SETTINGS from framework.test_result import Result, ResultNode, TestRunResult from framework.test_suite import BaseConfig, TestCase, TestCaseType, TestSuite -from framework.testbed_model.capability import ( - Capability, - get_supported_capabilities, - test_if_supported, -) -from framework.testbed_model.node import Node -from framework.testbed_model.topology import PortLink, Topology -from framework.testbed_model.traffic_generator import create_traffic_generator TestScenario = tuple[type[TestSuite], BaseConfig, deque[type[TestCase]]] diff --git a/dts/framework/test_suite.py b/dts/framework/test_suite.py index 6066f7a77a..786cfc7bff 100644 --- a/dts/framework/test_suite.py +++ b/dts/framework/test_suite.py @@ -30,10 +30,10 @@ from typing_extensions import Self from api.exception import ConfigurationError, InternalError +from api.testbed_model.capability import TestProtocol +from api.testbed_model.topology import Topology from api.utils import to_pascal_case from framework.config.common import FrozenModel -from framework.testbed_model.capability import TestProtocol -from framework.testbed_model.topology import Topology from .logger import DTSLogger, get_dts_logger diff --git a/dts/tests/TestSuite_blocklist.py b/dts/tests/TestSuite_blocklist.py index c57231de22..97e03b8fb7 100644 --- a/dts/tests/TestSuite_blocklist.py +++ b/dts/tests/TestSuite_blocklist.py @@ -11,9 +11,9 @@ requires_link_topology, ) from api.test import verify +from api.testbed_model.port import Port from api.testpmd import TestPmd from framework.test_suite import TestSuite, func_test -from framework.testbed_model.port import Port class TestBlocklist(TestSuite): diff --git a/dts/tests/TestSuite_cryptodev_latency.py b/dts/tests/TestSuite_cryptodev_latency.py index ed6423eb26..981c483a14 100644 --- a/dts/tests/TestSuite_cryptodev_latency.py +++ b/dts/tests/TestSuite_cryptodev_latency.py @@ -31,8 +31,8 @@ CryptodevResults, ) from api.test import skip, verify +from api.testbed_model.virtual_device import VirtualDevice from framework.test_suite import BaseConfig, TestSuite, crypto_test -from framework.testbed_model.virtual_device import VirtualDevice config_list: list[dict[str, int | float | str]] = [ {"buff_size": 64, "avg_cycles": 99_999.00, "avg_time_us": 9999.0}, diff --git a/dts/tests/TestSuite_cryptodev_throughput.py b/dts/tests/TestSuite_cryptodev_throughput.py index d69714e1fa..b861c52bae 100644 --- a/dts/tests/TestSuite_cryptodev_throughput.py +++ b/dts/tests/TestSuite_cryptodev_throughput.py @@ -31,8 +31,8 @@ CryptodevResults, ) from api.test import skip, verify +from api.testbed_model.virtual_device import VirtualDevice from framework.test_suite import BaseConfig, TestSuite, crypto_test -from framework.testbed_model.virtual_device import VirtualDevice config_list: list[dict[str, int | float | str]] = [ {"buff_size": 64, "Gbps": 1.00}, diff --git a/dts/tests/TestSuite_l2fwd.py b/dts/tests/TestSuite_l2fwd.py index 574842e2e4..5650366c36 100644 --- a/dts/tests/TestSuite_l2fwd.py +++ b/dts/tests/TestSuite_l2fwd.py @@ -19,11 +19,11 @@ match_all_packets, send_packets_and_capture, ) +from api.testbed_model.cpu import LogicalCoreCount from api.testpmd import TestPmd from api.testpmd.config import EthPeer, SimpleForwardingModes from api.utils import generate_random_packets from framework.test_suite import TestSuite, func_test -from framework.testbed_model.cpu import LogicalCoreCount @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_packet_capture.py b/dts/tests/TestSuite_packet_capture.py index 4bd15e2401..042b7019aa 100644 --- a/dts/tests/TestSuite_packet_capture.py +++ b/dts/tests/TestSuite_packet_capture.py @@ -36,15 +36,15 @@ send_packets_and_capture, ) from api.test import verify +from api.testbed_model.cpu import LogicalCoreList +from api.testbed_model.traffic_generator.capturing_traffic_generator import ( + PacketFilteringConfig, +) from api.testpmd import TestPmd from framework.params import Params from framework.remote_session.blocking_app import BlockingApp from framework.remote_session.dpdk_shell import compute_eal_params from framework.test_suite import TestSuite, func_test -from framework.testbed_model.cpu import LogicalCoreList -from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( - PacketFilteringConfig, -) @dataclass(kw_only=True) diff --git a/dts/tests/TestSuite_smoke_tests.py b/dts/tests/TestSuite_smoke_tests.py index fce83604a6..656e2e4bb7 100644 --- a/dts/tests/TestSuite_smoke_tests.py +++ b/dts/tests/TestSuite_smoke_tests.py @@ -19,12 +19,12 @@ requires_link_topology, ) from api.test import verify +from api.testbed_model.linux_session import LinuxSession from api.testpmd import TestPmd from api.utils import REGEX_FOR_PCI_ADDRESS from framework.config.node import PortConfig from framework.settings import SETTINGS from framework.test_suite import TestSuite, func_test -from framework.testbed_model.linux_session import LinuxSession @requires_link_topology(LinkTopology.NO_LINK) diff --git a/dts/tests/TestSuite_softnic.py b/dts/tests/TestSuite_softnic.py index c57a12c932..91a6d4eb9f 100644 --- a/dts/tests/TestSuite_softnic.py +++ b/dts/tests/TestSuite_softnic.py @@ -18,11 +18,11 @@ match_all_packets, send_packets_and_capture, ) +from api.testbed_model.virtual_device import VirtualDevice from api.testpmd import TestPmd from api.testpmd.config import EthPeer from api.utils import generate_random_packets from framework.test_suite import TestSuite, func_test -from framework.testbed_model.virtual_device import VirtualDevice @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_virtio_forward.py b/dts/tests/TestSuite_virtio_forward.py index 6efaa4e156..06bcd86ee4 100644 --- a/dts/tests/TestSuite_virtio_forward.py +++ b/dts/tests/TestSuite_virtio_forward.py @@ -12,12 +12,12 @@ from api.capabilities import LinkTopology from api.packet import send_packets_and_capture from api.test import log, verify +from api.testbed_model.capability import requires +from api.testbed_model.linux_session import LinuxSession +from api.testbed_model.virtual_device import VirtualDevice from api.testpmd import TestPmd from api.testpmd.config import PortTopology, SimpleForwardingModes from framework.test_suite import TestSuite, func_test -from framework.testbed_model.capability import requires -from framework.testbed_model.linux_session import LinuxSession -from framework.testbed_model.virtual_device import VirtualDevice class TestVirtioForward(TestSuite): -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* [PATCH v6 5/7] dts: move test suite module from framework to API 2026-08-06 17:50 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (3 preceding siblings ...) 2026-08-06 17:50 ` [PATCH v6 4/7] dts: move testbed model " Andrew Bailey @ 2026-08-06 17:50 ` Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 6/7] dts: move params directory " Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 7/7] dts: separate Linux session into interface and logic Andrew Bailey 6 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:50 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx Currently, each test suite imports the TestSuite class from the DTS framework to use as a base class. However, the goal for 26.07 is to move all test suite imports to the API module. Moves and updates the test_suite file to the API directory, and updates all files that import test_suite to reflect this change. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- .../dts/{framework.test_suite.rst => api.test_suite.rst} | 2 +- doc/api/dts/index.rst | 2 +- dts/api/capabilities.py | 6 +++--- dts/api/context.py | 2 +- dts/api/packet.py | 2 +- dts/{framework => api}/test_suite.py | 3 +-- dts/api/testbed_model/capability.py | 6 +++--- dts/framework/config/__init__.py | 4 ++-- dts/framework/config/test_run.py | 8 ++++---- dts/framework/test_run.py | 2 +- dts/tests/TestSuite_blocklist.py | 2 +- dts/tests/TestSuite_buffer_scatter.py | 2 +- dts/tests/TestSuite_checksum_offload.py | 2 +- dts/tests/TestSuite_cryptodev_latency.py | 2 +- dts/tests/TestSuite_cryptodev_throughput.py | 2 +- dts/tests/TestSuite_dual_vlan.py | 2 +- dts/tests/TestSuite_dynamic_config.py | 2 +- dts/tests/TestSuite_dynamic_queue_conf.py | 2 +- dts/tests/TestSuite_flow_offload.py | 2 +- dts/tests/TestSuite_hello_world.py | 2 +- dts/tests/TestSuite_l2fwd.py | 2 +- dts/tests/TestSuite_mac_filter.py | 2 +- dts/tests/TestSuite_mtu.py | 2 +- dts/tests/TestSuite_packet_capture.py | 2 +- dts/tests/TestSuite_port_control.py | 2 +- dts/tests/TestSuite_port_restart_config_persistency.py | 2 +- dts/tests/TestSuite_port_stats.py | 2 +- dts/tests/TestSuite_promisc_support.py | 2 +- dts/tests/TestSuite_qinq.py | 2 +- dts/tests/TestSuite_queue_toggle.py | 2 +- dts/tests/TestSuite_rss.py | 2 +- dts/tests/TestSuite_rx_split.py | 2 +- dts/tests/TestSuite_rx_tx_offload.py | 2 +- dts/tests/TestSuite_single_core_forward_perf.py | 2 +- dts/tests/TestSuite_smoke_tests.py | 2 +- dts/tests/TestSuite_softnic.py | 2 +- dts/tests/TestSuite_speed_capabilities.py | 2 +- dts/tests/TestSuite_unified_packet.py | 2 +- dts/tests/TestSuite_virtio_forward.py | 2 +- dts/tests/TestSuite_vlan.py | 2 +- 40 files changed, 48 insertions(+), 49 deletions(-) rename doc/api/dts/{framework.test_suite.rst => api.test_suite.rst} (81%) rename dts/{framework => api}/test_suite.py (99%) diff --git a/doc/api/dts/framework.test_suite.rst b/doc/api/dts/api.test_suite.rst similarity index 81% rename from doc/api/dts/framework.test_suite.rst rename to doc/api/dts/api.test_suite.rst index 9517f51a4a..4acb7b103a 100644 --- a/doc/api/dts/framework.test_suite.rst +++ b/doc/api/dts/api.test_suite.rst @@ -3,6 +3,6 @@ test\_suite - Common Test Suite Features ======================================== -.. automodule:: framework.test_suite +.. automodule:: api.test_suite :members: :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index f47e4af3f2..7c282bbba1 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -29,7 +29,7 @@ Modules framework.runner framework.test_run - framework.test_suite + api.test_suite framework.test_result framework.settings api.context diff --git a/dts/api/capabilities.py b/dts/api/capabilities.py index 8ed832a588..933eb6bca7 100644 --- a/dts/api/capabilities.py +++ b/dts/api/capabilities.py @@ -22,7 +22,7 @@ Examples: .. code:: python - from framework.test_suite import TestSuite, func_test + from api.test_suite import TestSuite, func_test from api.testbed_model.capability import LinkTopology, requires_link_topology # The whole test suite (each test case within) doesn't require any links. @requires_link_topology(LinkTopology.NO_LINK) @@ -33,7 +33,7 @@ def hello_world_single_core(self): .. code:: python - from framework.test_suite import TestSuite, func_test + from api.test_suite import TestSuite, func_test from api.testbed_model.capability import NicCapability, requires_nic_capability class TestPmdBufferScatter(TestSuite): # only the test case requires the SCATTERED_RX_ENABLED capability @@ -47,7 +47,7 @@ def test_scatter_mbuf_2048(self): from typing import TYPE_CHECKING, Callable if TYPE_CHECKING: - from framework.test_suite import TestProtocol + from api.test_suite import TestProtocol class LinkTopology(IntEnum): diff --git a/dts/api/context.py b/dts/api/context.py index 57e14ef598..753b2101a0 100644 --- a/dts/api/context.py +++ b/dts/api/context.py @@ -16,10 +16,10 @@ from framework.settings import SETTINGS if TYPE_CHECKING: + from api.test_suite import TestCase, TestSuite from api.testbed_model.capability import TestProtocol from api.testbed_model.traffic_generator.traffic_generator import TrafficGenerator from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment - from framework.test_suite import TestCase, TestSuite P = ParamSpec("P") diff --git a/dts/api/packet.py b/dts/api/packet.py index defbb758c8..58f47f1646 100644 --- a/dts/api/packet.py +++ b/dts/api/packet.py @@ -175,7 +175,7 @@ def adjust_addresses(packets: list[Packet], expected: bool = False) -> list[Pack Raises: InternalError: If no tests are running. """ - from framework.test_suite import TestSuite + from api.test_suite import TestSuite if get_ctx().local.current_test_suite is None: raise InternalError("No current test suite, tests aren't running?") diff --git a/dts/framework/test_suite.py b/dts/api/test_suite.py similarity index 99% rename from dts/framework/test_suite.py rename to dts/api/test_suite.py index 786cfc7bff..0822f9bfe5 100644 --- a/dts/framework/test_suite.py +++ b/dts/api/test_suite.py @@ -34,8 +34,7 @@ from api.testbed_model.topology import Topology from api.utils import to_pascal_case from framework.config.common import FrozenModel - -from .logger import DTSLogger, get_dts_logger +from framework.logger import DTSLogger, get_dts_logger if TYPE_CHECKING: from api.context import Context diff --git a/dts/api/testbed_model/capability.py b/dts/api/testbed_model/capability.py index 2748daa8a4..bb581d4ab7 100644 --- a/dts/api/testbed_model/capability.py +++ b/dts/api/testbed_model/capability.py @@ -25,7 +25,7 @@ Examples: .. code:: python - from framework.test_suite import TestSuite, func_test + from api.test_suite import TestSuite, func_test from api.testbed_model.capability import LinkTopology, requires # The whole test suite (each test case within) doesn't require any links. @requires_link_topology(LinkTopology.NO_LINK) @@ -36,7 +36,7 @@ def hello_world_single_core(self): .. code:: python - from framework.test_suite import TestSuite, func_test + from api.test_suite import TestSuite, func_test from api.testbed_model.capability import NicCapability, requires class TestPmdBufferScatter(TestSuite): # only the test case requires the SCATTERED_RX_ENABLED capability @@ -71,8 +71,8 @@ def test_scatter_mbuf_2048(self): from framework.logger import get_dts_logger if TYPE_CHECKING: + from api.test_suite import TestCase from api.testpmd import TestPmd - from framework.test_suite import TestCase P = ParamSpec("P") TestPmdMethod = Callable[Concatenate["TestPmd", P], Any] diff --git a/dts/framework/config/__init__.py b/dts/framework/config/__init__.py index e24a351ecf..c8edf340bd 100644 --- a/dts/framework/config/__init__.py +++ b/dts/framework/config/__init__.py @@ -43,7 +43,7 @@ # Import only if type checking or building docs, to prevent circular imports. if TYPE_CHECKING: - from framework.test_suite import BaseConfig + from api.test_suite import BaseConfig NodesConfig = Annotated[list[NodeConfiguration], Field(min_length=1)] @@ -184,7 +184,7 @@ def load_config(ctx: ValidationContext) -> Configuration: nodes = _load_and_parse_model(ctx["settings"].nodes_config_path, NodesConfig, ctx) try: - from framework.test_suite import BaseConfig as BaseConfig + from api.test_suite import BaseConfig as BaseConfig Configuration.model_rebuild() return Configuration.model_validate( diff --git a/dts/framework/config/test_run.py b/dts/framework/config/test_run.py index b87c7b2d19..40fce48bf9 100644 --- a/dts/framework/config/test_run.py +++ b/dts/framework/config/test_run.py @@ -33,7 +33,7 @@ from .common import FrozenModel, load_fields_from_settings if TYPE_CHECKING: - from framework.test_suite import BaseConfig, TestCase, TestSuite, TestSuiteSpec + from api.test_suite import BaseConfig, TestCase, TestSuite, TestSuiteSpec @unique @@ -230,7 +230,7 @@ class TestSuiteConfig(FrozenModel): @cached_property def test_suite_spec(self) -> "TestSuiteSpec": """The specification of the requested test suite.""" - from framework.test_suite import find_by_name + from api.test_suite import find_by_name test_suite_spec = find_by_name(self.test_suite_name) assert test_suite_spec is not None, ( @@ -280,7 +280,7 @@ def fetch_all_test_suites() -> list[TestSuiteConfig]: This function does not include the smoke tests. """ - from framework.test_suite import AVAILABLE_TEST_SUITES + from api.test_suite import AVAILABLE_TEST_SUITES return [ TestSuiteConfig(test_suite=test_suite.name) @@ -506,7 +506,7 @@ def filter_tests( self, tests_config: dict[str, "BaseConfig"] ) -> Iterable[tuple[type["TestSuite"], "BaseConfig", deque[type["TestCase"]]]]: """Filter test suites and cases selected for execution.""" - from framework.test_suite import TestCaseType + from api.test_suite import TestCaseType test_suites = [TestSuiteConfig(test_suite="smoke_tests")] diff --git a/dts/framework/test_run.py b/dts/framework/test_run.py index 42a56d38c9..dfbdd0b5b5 100644 --- a/dts/framework/test_run.py +++ b/dts/framework/test_run.py @@ -110,6 +110,7 @@ from api.capabilities import LinkTopology from api.context import Context, init_ctx from api.exception import InternalError, SkippedTestException, TestCaseVerifyError +from api.test_suite import BaseConfig, TestCase, TestCaseType, TestSuite from api.testbed_model.capability import ( Capability, get_supported_capabilities, @@ -123,7 +124,6 @@ from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment from framework.settings import SETTINGS from framework.test_result import Result, ResultNode, TestRunResult -from framework.test_suite import BaseConfig, TestCase, TestCaseType, TestSuite TestScenario = tuple[type[TestSuite], BaseConfig, deque[type[TestCase]]] diff --git a/dts/tests/TestSuite_blocklist.py b/dts/tests/TestSuite_blocklist.py index 97e03b8fb7..31e69c0de9 100644 --- a/dts/tests/TestSuite_blocklist.py +++ b/dts/tests/TestSuite_blocklist.py @@ -11,9 +11,9 @@ requires_link_topology, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testbed_model.port import Port from api.testpmd import TestPmd -from framework.test_suite import TestSuite, func_test class TestBlocklist(TestSuite): diff --git a/dts/tests/TestSuite_buffer_scatter.py b/dts/tests/TestSuite_buffer_scatter.py index 539082f2e4..cd1a52ad5e 100644 --- a/dts/tests/TestSuite_buffer_scatter.py +++ b/dts/tests/TestSuite_buffer_scatter.py @@ -28,9 +28,9 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_checksum_offload.py b/dts/tests/TestSuite_checksum_offload.py index 90ca798e56..a2ea13991b 100644 --- a/dts/tests/TestSuite_checksum_offload.py +++ b/dts/tests/TestSuite_checksum_offload.py @@ -25,10 +25,10 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import ChecksumOffloadOptions, PacketOffloadFlag -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PORT_RX_OFFLOAD_IPV4_CKSUM) diff --git a/dts/tests/TestSuite_cryptodev_latency.py b/dts/tests/TestSuite_cryptodev_latency.py index 981c483a14..444a5b282c 100644 --- a/dts/tests/TestSuite_cryptodev_latency.py +++ b/dts/tests/TestSuite_cryptodev_latency.py @@ -31,8 +31,8 @@ CryptodevResults, ) from api.test import skip, verify +from api.test_suite import BaseConfig, TestSuite, crypto_test from api.testbed_model.virtual_device import VirtualDevice -from framework.test_suite import BaseConfig, TestSuite, crypto_test config_list: list[dict[str, int | float | str]] = [ {"buff_size": 64, "avg_cycles": 99_999.00, "avg_time_us": 9999.0}, diff --git a/dts/tests/TestSuite_cryptodev_throughput.py b/dts/tests/TestSuite_cryptodev_throughput.py index b861c52bae..59f64f2cd7 100644 --- a/dts/tests/TestSuite_cryptodev_throughput.py +++ b/dts/tests/TestSuite_cryptodev_throughput.py @@ -31,8 +31,8 @@ CryptodevResults, ) from api.test import skip, verify +from api.test_suite import BaseConfig, TestSuite, crypto_test from api.testbed_model.virtual_device import VirtualDevice -from framework.test_suite import BaseConfig, TestSuite, crypto_test config_list: list[dict[str, int | float | str]] = [ {"buff_size": 64, "Gbps": 1.00}, diff --git a/dts/tests/TestSuite_dual_vlan.py b/dts/tests/TestSuite_dual_vlan.py index 1b77dd2b47..f3347a6d52 100644 --- a/dts/tests/TestSuite_dual_vlan.py +++ b/dts/tests/TestSuite_dual_vlan.py @@ -21,9 +21,9 @@ from api.capabilities import LinkTopology, requires_link_topology from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test class TestDualVlan(TestSuite): diff --git a/dts/tests/TestSuite_dynamic_config.py b/dts/tests/TestSuite_dynamic_config.py index 7204ec4f73..b9e2c30da1 100644 --- a/dts/tests/TestSuite_dynamic_config.py +++ b/dts/tests/TestSuite_dynamic_config.py @@ -27,9 +27,9 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_dynamic_queue_conf.py b/dts/tests/TestSuite_dynamic_queue_conf.py index b62efa2b42..24584c7d60 100644 --- a/dts/tests/TestSuite_dynamic_queue_conf.py +++ b/dts/tests/TestSuite_dynamic_queue_conf.py @@ -38,9 +38,9 @@ from api.exception import InteractiveCommandExecutionError from api.packet import send_packets from api.test import fail, verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import PortTopology, SimpleForwardingModes -from framework.test_suite import TestSuite, func_test def setup_and_teardown_test( diff --git a/dts/tests/TestSuite_flow_offload.py b/dts/tests/TestSuite_flow_offload.py index 5902406a8e..09384b1983 100644 --- a/dts/tests/TestSuite_flow_offload.py +++ b/dts/tests/TestSuite_flow_offload.py @@ -28,9 +28,9 @@ ) from api.packet import send_packet_and_capture from api.test import fail, log, verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.types import FlowRule -from framework.test_suite import TestSuite, func_test @dataclass diff --git a/dts/tests/TestSuite_hello_world.py b/dts/tests/TestSuite_hello_world.py index bf1a93c782..cd62eb8f3e 100644 --- a/dts/tests/TestSuite_hello_world.py +++ b/dts/tests/TestSuite_hello_world.py @@ -9,8 +9,8 @@ """ from api.test import log +from api.test_suite import BaseConfig, TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import BaseConfig, TestSuite, func_test class Config(BaseConfig): diff --git a/dts/tests/TestSuite_l2fwd.py b/dts/tests/TestSuite_l2fwd.py index 5650366c36..f237821a04 100644 --- a/dts/tests/TestSuite_l2fwd.py +++ b/dts/tests/TestSuite_l2fwd.py @@ -19,11 +19,11 @@ match_all_packets, send_packets_and_capture, ) +from api.test_suite import TestSuite, func_test from api.testbed_model.cpu import LogicalCoreCount from api.testpmd import TestPmd from api.testpmd.config import EthPeer, SimpleForwardingModes from api.utils import generate_random_packets -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_mac_filter.py b/dts/tests/TestSuite_mac_filter.py index b44822d31c..eb1413f336 100644 --- a/dts/tests/TestSuite_mac_filter.py +++ b/dts/tests/TestSuite_mac_filter.py @@ -26,8 +26,8 @@ from api.exception import InteractiveCommandExecutionError from api.packet import send_packet_and_capture from api.test import fail, verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_mtu.py b/dts/tests/TestSuite_mtu.py index 8355495d33..c264db299e 100644 --- a/dts/tests/TestSuite_mtu.py +++ b/dts/tests/TestSuite_mtu.py @@ -23,8 +23,8 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import TestSuite, func_test STANDARD_FRAME = 1518 # --max-pkt-len will subtract l2 information at a minimum of 18 bytes. JUMBO_FRAME = 9018 diff --git a/dts/tests/TestSuite_packet_capture.py b/dts/tests/TestSuite_packet_capture.py index 042b7019aa..fd5cef5268 100644 --- a/dts/tests/TestSuite_packet_capture.py +++ b/dts/tests/TestSuite_packet_capture.py @@ -36,6 +36,7 @@ send_packets_and_capture, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testbed_model.cpu import LogicalCoreList from api.testbed_model.traffic_generator.capturing_traffic_generator import ( PacketFilteringConfig, @@ -44,7 +45,6 @@ from framework.params import Params from framework.remote_session.blocking_app import BlockingApp from framework.remote_session.dpdk_shell import compute_eal_params -from framework.test_suite import TestSuite, func_test @dataclass(kw_only=True) diff --git a/dts/tests/TestSuite_port_control.py b/dts/tests/TestSuite_port_control.py index b51fdc2959..c2f2de3493 100644 --- a/dts/tests/TestSuite_port_control.py +++ b/dts/tests/TestSuite_port_control.py @@ -18,9 +18,9 @@ ) from api.packet import send_packets_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_port_restart_config_persistency.py b/dts/tests/TestSuite_port_restart_config_persistency.py index 4ea22b6d70..88df35d33c 100644 --- a/dts/tests/TestSuite_port_restart_config_persistency.py +++ b/dts/tests/TestSuite_port_restart_config_persistency.py @@ -14,9 +14,9 @@ requires_nic_capability, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.types import TestPmdPortFlowCtrl -from framework.test_suite import TestSuite, func_test ALTERNATIVE_MTU: int = 800 STANDARD_MTU: int = 1500 diff --git a/dts/tests/TestSuite_port_stats.py b/dts/tests/TestSuite_port_stats.py index 3dc045f847..0328c6718c 100644 --- a/dts/tests/TestSuite_port_stats.py +++ b/dts/tests/TestSuite_port_stats.py @@ -25,10 +25,10 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import RtePTypes, TestPmdVerbosePacket -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_promisc_support.py b/dts/tests/TestSuite_promisc_support.py index a0c65dc662..c59c8c6078 100644 --- a/dts/tests/TestSuite_promisc_support.py +++ b/dts/tests/TestSuite_promisc_support.py @@ -21,8 +21,8 @@ send_packets_and_capture, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_qinq.py b/dts/tests/TestSuite_qinq.py index 505d71dbc8..5dde37d4db 100644 --- a/dts/tests/TestSuite_qinq.py +++ b/dts/tests/TestSuite_qinq.py @@ -18,8 +18,8 @@ from api.capabilities import NicCapability, requires_nic_capability from api.packet import send_packet_and_capture from api.test import log, verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import TestSuite, func_test class TestQinq(TestSuite): diff --git a/dts/tests/TestSuite_queue_toggle.py b/dts/tests/TestSuite_queue_toggle.py index e4edc89123..a9ea356b22 100644 --- a/dts/tests/TestSuite_queue_toggle.py +++ b/dts/tests/TestSuite_queue_toggle.py @@ -24,9 +24,9 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test @requires_link_topology(LinkTopology.TWO_LINKS) diff --git a/dts/tests/TestSuite_rss.py b/dts/tests/TestSuite_rss.py index 1e60bdba07..b538e93af9 100644 --- a/dts/tests/TestSuite_rss.py +++ b/dts/tests/TestSuite_rss.py @@ -23,6 +23,7 @@ from api.exception import InteractiveCommandExecutionError from api.packet import send_packets_and_capture from api.test import verify +from api.test_suite import BaseConfig, TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import ( @@ -31,7 +32,6 @@ TestPmdVerbosePacket, ) from api.utils import StrEnum -from framework.test_suite import BaseConfig, TestSuite, func_test class Config(BaseConfig): diff --git a/dts/tests/TestSuite_rx_split.py b/dts/tests/TestSuite_rx_split.py index 470e48d0d3..3b3e4cd620 100644 --- a/dts/tests/TestSuite_rx_split.py +++ b/dts/tests/TestSuite_rx_split.py @@ -21,10 +21,10 @@ from api.exception import InteractiveCommandExecutionError from api.packet import adjust_addresses, send_packet_and_capture from api.test import fail, verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import RxOffloadCapability, TxOffloadCapability -from framework.test_suite import TestSuite, func_test PAYLOAD = bytes(range(256)) ETHER_HDR_LEN = len(Ether(dst="00:00:00:00:00:00")) diff --git a/dts/tests/TestSuite_rx_tx_offload.py b/dts/tests/TestSuite_rx_tx_offload.py index b0da627d3c..c8d24baaae 100644 --- a/dts/tests/TestSuite_rx_tx_offload.py +++ b/dts/tests/TestSuite_rx_tx_offload.py @@ -13,12 +13,12 @@ requires_nic_capability, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.types import ( OffloadConfiguration, RxTxLiteralSwitch, ) -from framework.test_suite import TestSuite, func_test @requires_link_topology(LinkTopology.ONE_LINK) diff --git a/dts/tests/TestSuite_single_core_forward_perf.py b/dts/tests/TestSuite_single_core_forward_perf.py index 57aecdf7a4..f51ff76c4c 100644 --- a/dts/tests/TestSuite_single_core_forward_perf.py +++ b/dts/tests/TestSuite_single_core_forward_perf.py @@ -22,10 +22,10 @@ ) from api.packet import assess_performance_by_packet from api.test import verify, write_performance_json +from api.test_suite import BaseConfig, TestSuite, perf_test from api.testpmd import TestPmd from api.testpmd.config import RXRingParams, TXRingParams from framework.params.types import TestPmdParamsDict -from framework.test_suite import BaseConfig, TestSuite, perf_test class Config(BaseConfig): diff --git a/dts/tests/TestSuite_smoke_tests.py b/dts/tests/TestSuite_smoke_tests.py index 656e2e4bb7..b3eb325fc0 100644 --- a/dts/tests/TestSuite_smoke_tests.py +++ b/dts/tests/TestSuite_smoke_tests.py @@ -19,12 +19,12 @@ requires_link_topology, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testbed_model.linux_session import LinuxSession from api.testpmd import TestPmd from api.utils import REGEX_FOR_PCI_ADDRESS from framework.config.node import PortConfig from framework.settings import SETTINGS -from framework.test_suite import TestSuite, func_test @requires_link_topology(LinkTopology.NO_LINK) diff --git a/dts/tests/TestSuite_softnic.py b/dts/tests/TestSuite_softnic.py index 91a6d4eb9f..05a6d3aa18 100644 --- a/dts/tests/TestSuite_softnic.py +++ b/dts/tests/TestSuite_softnic.py @@ -18,11 +18,11 @@ match_all_packets, send_packets_and_capture, ) +from api.test_suite import TestSuite, func_test from api.testbed_model.virtual_device import VirtualDevice from api.testpmd import TestPmd from api.testpmd.config import EthPeer from api.utils import generate_random_packets -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_speed_capabilities.py b/dts/tests/TestSuite_speed_capabilities.py index 9cbd6f1ef7..c9b0f74feb 100644 --- a/dts/tests/TestSuite_speed_capabilities.py +++ b/dts/tests/TestSuite_speed_capabilities.py @@ -13,8 +13,8 @@ requires_link_topology, ) from api.test import verify +from api.test_suite import BaseConfig, TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import BaseConfig, TestSuite, func_test class Config(BaseConfig): diff --git a/dts/tests/TestSuite_unified_packet.py b/dts/tests/TestSuite_unified_packet.py index fcc7f7fbbb..bf3654f0d7 100644 --- a/dts/tests/TestSuite_unified_packet.py +++ b/dts/tests/TestSuite_unified_packet.py @@ -25,10 +25,10 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import RtePTypes, TestPmdVerbosePacket -from framework.test_suite import TestSuite, func_test class TestUnifiedPacket(TestSuite): diff --git a/dts/tests/TestSuite_virtio_forward.py b/dts/tests/TestSuite_virtio_forward.py index 06bcd86ee4..a16299d908 100644 --- a/dts/tests/TestSuite_virtio_forward.py +++ b/dts/tests/TestSuite_virtio_forward.py @@ -12,12 +12,12 @@ from api.capabilities import LinkTopology from api.packet import send_packets_and_capture from api.test import log, verify +from api.test_suite import TestSuite, func_test from api.testbed_model.capability import requires from api.testbed_model.linux_session import LinuxSession from api.testbed_model.virtual_device import VirtualDevice from api.testpmd import TestPmd from api.testpmd.config import PortTopology, SimpleForwardingModes -from framework.test_suite import TestSuite, func_test class TestVirtioForward(TestSuite): diff --git a/dts/tests/TestSuite_vlan.py b/dts/tests/TestSuite_vlan.py index 898673fc86..975e87b128 100644 --- a/dts/tests/TestSuite_vlan.py +++ b/dts/tests/TestSuite_vlan.py @@ -23,9 +23,9 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PORT_RX_OFFLOAD_VLAN_FILTER) -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* [PATCH v6 6/7] dts: move params directory from framework to API 2026-08-06 17:50 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (4 preceding siblings ...) 2026-08-06 17:50 ` [PATCH v6 5/7] dts: move test suite module " Andrew Bailey @ 2026-08-06 17:50 ` Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 7/7] dts: separate Linux session into interface and logic Andrew Bailey 6 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:50 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx The params directory is imported in test suites such as packet capture to use as a base class for dumpcap. Move this to the API. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- .../{framework.params.eal.rst => api.params.eal.rst} | 2 +- doc/api/dts/{framework.params.rst => api.params.rst} | 6 +++--- ...framework.params.types.rst => api.params.types.rst} | 2 +- doc/api/dts/index.rst | 2 +- dts/api/cryptodev/__init__.py | 2 +- dts/api/cryptodev/config.py | 4 ++-- dts/{framework => api}/params/__init__.py | 0 dts/{framework => api}/params/eal.py | 2 +- dts/{framework => api}/params/types.py | 10 +++++++--- dts/api/testpmd/__init__.py | 7 ++++++- dts/api/testpmd/config.py | 6 +++--- dts/framework/remote_session/blocking_app.py | 4 ++-- dts/framework/remote_session/dpdk.py | 2 +- dts/framework/remote_session/dpdk_shell.py | 2 +- dts/framework/remote_session/interactive_shell.py | 2 +- dts/tests/TestSuite_packet_capture.py | 2 +- dts/tests/TestSuite_single_core_forward_perf.py | 2 +- 17 files changed, 33 insertions(+), 24 deletions(-) rename doc/api/dts/{framework.params.eal.rst => api.params.eal.rst} (79%) rename doc/api/dts/{framework.params.rst => api.params.rst} (71%) rename doc/api/dts/{framework.params.types.rst => api.params.types.rst} (80%) rename dts/{framework => api}/params/__init__.py (100%) rename dts/{framework => api}/params/eal.py (97%) rename dts/{framework => api}/params/types.py (96%) diff --git a/doc/api/dts/framework.params.eal.rst b/doc/api/dts/api.params.eal.rst similarity index 79% rename from doc/api/dts/framework.params.eal.rst rename to doc/api/dts/api.params.eal.rst index 6999b00233..4531cb1fe1 100644 --- a/doc/api/dts/framework.params.eal.rst +++ b/doc/api/dts/api.params.eal.rst @@ -3,6 +3,6 @@ eal - EAL Parameters Modelling ============================== -.. automodule:: framework.params.eal +.. automodule:: api.params.eal :members: :show-inheritance: diff --git a/doc/api/dts/framework.params.rst b/doc/api/dts/api.params.rst similarity index 71% rename from doc/api/dts/framework.params.rst rename to doc/api/dts/api.params.rst index d8c6af9667..3ea7f9215e 100644 --- a/doc/api/dts/framework.params.rst +++ b/doc/api/dts/api.params.rst @@ -3,7 +3,7 @@ params - Command Line Parameters Modelling ========================================== -.. automodule:: framework.params +.. automodule:: api.params :members: :show-inheritance: @@ -11,5 +11,5 @@ params - Command Line Parameters Modelling :hidden: :maxdepth: 1 - framework.params.eal - framework.params.types + api.params.eal + api.params.types diff --git a/doc/api/dts/framework.params.types.rst b/doc/api/dts/api.params.types.rst similarity index 80% rename from doc/api/dts/framework.params.types.rst rename to doc/api/dts/api.params.types.rst index 6d609038be..4754b3a665 100644 --- a/doc/api/dts/framework.params.types.rst +++ b/doc/api/dts/api.params.types.rst @@ -3,6 +3,6 @@ params.types - Parameters Modelling Types ========================================= -.. automodule:: framework.params.types +.. automodule:: api.params.types :members: :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index 7c282bbba1..e89e782ac0 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -18,7 +18,7 @@ Packages api api.testbed_model framework.remote_session - framework.params + api.params framework.config Modules diff --git a/dts/api/cryptodev/__init__.py b/dts/api/cryptodev/__init__.py index 198607696f..496079c2af 100644 --- a/dts/api/cryptodev/__init__.py +++ b/dts/api/cryptodev/__init__.py @@ -27,7 +27,7 @@ from framework.remote_session.dpdk_shell import compute_eal_params if TYPE_CHECKING: - from framework.params.types import CryptoPmdParamsDict + from api.params.types import CryptoPmdParamsDict from pathlib import PurePath diff --git a/dts/api/cryptodev/config.py b/dts/api/cryptodev/config.py index a88e70d45c..3420c2fe91 100644 --- a/dts/api/cryptodev/config.py +++ b/dts/api/cryptodev/config.py @@ -6,9 +6,9 @@ from enum import auto from typing import Literal +from api.params import Params, Switch +from api.params.eal import EalParams from api.utils import StrEnum -from framework.params import Params, Switch -from framework.params.eal import EalParams Silent = Literal[""] diff --git a/dts/framework/params/__init__.py b/dts/api/params/__init__.py similarity index 100% rename from dts/framework/params/__init__.py rename to dts/api/params/__init__.py diff --git a/dts/framework/params/eal.py b/dts/api/params/eal.py similarity index 97% rename from dts/framework/params/eal.py rename to dts/api/params/eal.py index 86bfd3fcc6..64fa45ae12 100644 --- a/dts/framework/params/eal.py +++ b/dts/api/params/eal.py @@ -6,9 +6,9 @@ from dataclasses import dataclass, field from typing import TYPE_CHECKING, Literal +from api.params import Params, Switch from api.testbed_model.cpu import LogicalCoreList from api.testbed_model.virtual_device import VirtualDevice -from framework.params import Params, Switch if TYPE_CHECKING: from api.testbed_model.port import Port diff --git a/dts/framework/params/types.py b/dts/api/params/types.py similarity index 96% rename from dts/framework/params/types.py rename to dts/api/params/types.py index f9a51963a2..c4b718eebe 100644 --- a/dts/framework/params/types.py +++ b/dts/api/params/types.py @@ -12,8 +12,10 @@ def create_testpmd(**kwargs: Unpack[TestPmdParamsDict]): params = TestPmdParams(**kwargs) """ +from __future__ import annotations + from pathlib import PurePath -from typing import TypedDict +from typing import TYPE_CHECKING, TypedDict from api.cryptodev.config import ( AeadAlgName, @@ -56,8 +58,10 @@ def create_testpmd(**kwargs: Unpack[TestPmdParamsDict]): TXRingParams, TxUDPPortPair, ) -from api.testpmd.types import RxOffloadCapability, TxOffloadCapability -from framework.params import Switch, YesNoSwitch + +if TYPE_CHECKING: + from api.testpmd.types import RxOffloadCapability, TxOffloadCapability +from api.params import Switch, YesNoSwitch class EalParamsDict(TypedDict, total=False): diff --git a/dts/api/testpmd/__init__.py b/dts/api/testpmd/__init__.py index ce41408eb6..33504640e3 100644 --- a/dts/api/testpmd/__init__.py +++ b/dts/api/testpmd/__init__.py @@ -14,6 +14,8 @@ testpmd.close() """ +from __future__ import annotations + import functools import re import time @@ -21,6 +23,7 @@ from enum import Flag from pathlib import PurePath from typing import ( + TYPE_CHECKING, Any, Callable, ClassVar, @@ -56,7 +59,9 @@ TxOffloadConfiguration, VLANOffloadFlag, ) -from framework.params.types import TestPmdParamsDict + +if TYPE_CHECKING: + from api.params.types import TestPmdParamsDict from framework.remote_session.dpdk_shell import DPDKShell from framework.remote_session.interactive_shell import only_active from framework.settings import SETTINGS diff --git a/dts/api/testpmd/config.py b/dts/api/testpmd/config.py index 3850a4eb8a..c72c1b2c90 100644 --- a/dts/api/testpmd/config.py +++ b/dts/api/testpmd/config.py @@ -13,8 +13,7 @@ from pathlib import PurePath from typing import Literal, NamedTuple -from api.utils import StrEnum -from framework.params import ( +from api.params import ( Params, Switch, YesNoSwitch, @@ -25,7 +24,8 @@ modify_str, str_from_flag_value, ) -from framework.params.eal import EalParams +from api.params.eal import EalParams +from api.utils import StrEnum from .types import RxOffloadCapability, TxOffloadCapability diff --git a/dts/framework/remote_session/blocking_app.py b/dts/framework/remote_session/blocking_app.py index 84db3974b1..537d937eca 100644 --- a/dts/framework/remote_session/blocking_app.py +++ b/dts/framework/remote_session/blocking_app.py @@ -31,9 +31,9 @@ from typing_extensions import Self from api.context import get_ctx +from api.params import Params +from api.params.eal import EalParams from api.testbed_model.node import Node -from framework.params import Params -from framework.params.eal import EalParams from framework.remote_session.dpdk_shell import compute_eal_params from framework.remote_session.interactive_shell import InteractiveShell diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index c02c68af77..4de61ece68 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -16,6 +16,7 @@ from api.capabilities import LinkTopology from api.context import get_ctx from api.exception import ConfigurationError, RemoteFileNotFoundError +from api.params.eal import EalParams from api.testbed_model.cpu import LogicalCore, LogicalCoreCount, LogicalCoreList, lcore_filter from api.testbed_model.node import Node from api.testbed_model.os_session import OSSession @@ -33,7 +34,6 @@ RemoteDPDKTreeLocation, ) from framework.logger import DTSLogger, get_dts_logger -from framework.params.eal import EalParams from framework.remote_session.remote_session import CommandResult diff --git a/dts/framework/remote_session/dpdk_shell.py b/dts/framework/remote_session/dpdk_shell.py index b807f9bdae..61cc4687f3 100644 --- a/dts/framework/remote_session/dpdk_shell.py +++ b/dts/framework/remote_session/dpdk_shell.py @@ -11,8 +11,8 @@ from pathlib import PurePath from api.context import get_ctx +from api.params.eal import EalParams from api.testbed_model.cpu import LogicalCoreList -from framework.params.eal import EalParams from framework.remote_session.interactive_shell import ( InteractiveShell, only_active, diff --git a/dts/framework/remote_session/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index 831861a9ac..f9b7a7720d 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -35,9 +35,9 @@ InteractiveSSHSessionDeadError, InteractiveSSHTimeoutError, ) +from api.params import Params from api.testbed_model.node import Node from framework.logger import DTSLogger, get_dts_logger -from framework.params import Params from framework.settings import SETTINGS P = ParamSpec("P") diff --git a/dts/tests/TestSuite_packet_capture.py b/dts/tests/TestSuite_packet_capture.py index fd5cef5268..ba67c9e1c6 100644 --- a/dts/tests/TestSuite_packet_capture.py +++ b/dts/tests/TestSuite_packet_capture.py @@ -35,6 +35,7 @@ match_all_packets, send_packets_and_capture, ) +from api.params import Params from api.test import verify from api.test_suite import TestSuite, func_test from api.testbed_model.cpu import LogicalCoreList @@ -42,7 +43,6 @@ PacketFilteringConfig, ) from api.testpmd import TestPmd -from framework.params import Params from framework.remote_session.blocking_app import BlockingApp from framework.remote_session.dpdk_shell import compute_eal_params diff --git a/dts/tests/TestSuite_single_core_forward_perf.py b/dts/tests/TestSuite_single_core_forward_perf.py index f51ff76c4c..4b22c5d091 100644 --- a/dts/tests/TestSuite_single_core_forward_perf.py +++ b/dts/tests/TestSuite_single_core_forward_perf.py @@ -21,11 +21,11 @@ requires_link_topology, ) from api.packet import assess_performance_by_packet +from api.params.types import TestPmdParamsDict from api.test import verify, write_performance_json from api.test_suite import BaseConfig, TestSuite, perf_test from api.testpmd import TestPmd from api.testpmd.config import RXRingParams, TXRingParams -from framework.params.types import TestPmdParamsDict class Config(BaseConfig): -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* [PATCH v6 7/7] dts: separate Linux session into interface and logic 2026-08-06 17:50 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (5 preceding siblings ...) 2026-08-06 17:50 ` [PATCH v6 6/7] dts: move params directory " Andrew Bailey @ 2026-08-06 17:50 ` Andrew Bailey 6 siblings, 0 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-06 17:50 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx Separate Linux session into an interface for the API, and a logical module in the framework. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- doc/api/dts/framework.linux_session.rst | 9 + doc/api/dts/index.rst | 1 + dts/api/testbed_model/linux_session.py | 453 +---------------------- dts/api/testbed_model/node.py | 2 +- dts/framework/linux_session.py | 460 ++++++++++++++++++++++++ 5 files changed, 489 insertions(+), 436 deletions(-) create mode 100644 doc/api/dts/framework.linux_session.rst create mode 100644 dts/framework/linux_session.py diff --git a/doc/api/dts/framework.linux_session.rst b/doc/api/dts/framework.linux_session.rst new file mode 100644 index 0000000000..95a4fca977 --- /dev/null +++ b/doc/api/dts/framework.linux_session.rst @@ -0,0 +1,9 @@ +.. SPDX-License-Identifier: BSD-3-Clause + +framework.linux\_session +======================== + +.. automodule:: framework.linux_session + :members: + :show-inheritance: + diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index e89e782ac0..14d12eb038 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -35,6 +35,7 @@ Modules api.context framework.logger framework.parser + framework.linux_session api.utils api.exception diff --git a/dts/api/testbed_model/linux_session.py b/dts/api/testbed_model/linux_session.py index 399968efd4..a0b61b67df 100644 --- a/dts/api/testbed_model/linux_session.py +++ b/dts/api/testbed_model/linux_session.py @@ -9,454 +9,37 @@ This intermediate module implements the common parts of mostly POSIX compliant distributions. """ -import json -import re -from collections.abc import Iterable -from functools import cached_property +from abc import abstractmethod from pathlib import PurePath -from typing import TypedDict -from typing_extensions import NotRequired - -from api.exception import ( - ConfigurationError, - InternalError, - RemoteCommandExecutionError, -) -from api.testbed_model.port import PortInfo -from api.utils import expand_range - -from .cpu import LogicalCore -from .port import Port from .posix_session import PosixSession -class LshwConfigurationOutput(TypedDict): - """The relevant parts of ``lshw``'s ``configuration`` section.""" - - #: - driver: str - #: - link: str - #: - firmware: str - - -class LshwOutput(TypedDict): - """A model of the relevant information from ``lshw``'s json output. - - Example: - :: - - { - ... - "businfo" : "pci@0000:08:00.0", - "logicalname" : "enp8s0", - "version" : "00", - "serial" : "52:54:00:59:e1:ac", - ... - "configuration" : { - ... - "link" : "yes", - ... - }, - ... - """ - - #: - vendor: NotRequired[str] - #: - product: NotRequired[str] - #: - version: NotRequired[str] - #: - businfo: str - #: - logicalname: NotRequired[str] - #: - serial: NotRequired[str] - #: - configuration: LshwConfigurationOutput - - class LinuxSession(PosixSession): """The implementation of non-Posix compliant parts of Linux.""" - @staticmethod - def _get_privileged_command(command: str) -> str: - command = command.replace(r"'", r"\'") - return f"sudo -- sh -c '{command}'" - - def get_remote_cpus(self) -> list[LogicalCore]: - """Overrides :meth:`~.os_session.OSSession.get_remote_cpus`.""" - cpu_info = self.send_command("lscpu -p=CPU,CORE,SOCKET,NODE|grep -v \\#").stdout - lcores = [] - for cpu_line in cpu_info.splitlines(): - lcore, core, socket, node = map(int, cpu_line.split(",")) - lcores.append(LogicalCore(lcore, core, socket, node)) - return lcores - - def get_dpdk_file_prefix(self, dpdk_prefix: str) -> str: - """Overrides :meth:`~.os_session.OSSession.get_dpdk_file_prefix`.""" - return dpdk_prefix - - def setup_hugepages(self, number_of: int, hugepage_size: int, force_first_numa: bool) -> None: - """Overrides :meth:`~.os_session.OSSession.setup_hugepages`. - - Raises: - ConfigurationError: If the given `hugepage_size` is not supported by the OS. - """ - self._logger.info("Getting Hugepage information.") - if ( - f"hugepages-{hugepage_size}kB" - not in self.send_command("ls /sys/kernel/mm/hugepages").stdout - ): - raise ConfigurationError("hugepage size not supported by operating system") - hugepages_total = self._get_hugepages_total(hugepage_size) - self._numa_nodes = self._get_numa_nodes() - - if force_first_numa or hugepages_total < number_of: - # when forcing numa, we need to clear existing hugepages regardless - # of size, so they can be moved to the first numa node - self._configure_huge_pages(number_of, hugepage_size, force_first_numa) - else: - self._logger.info("Hugepages already configured.") - self._mount_huge_pages() - - def _get_hugepages_total(self, hugepage_size: int) -> int: - hugepages_total = self.send_command( - f"cat /sys/kernel/mm/hugepages/hugepages-{hugepage_size}kB/nr_hugepages" - ).stdout - return int(hugepages_total) - - def _get_numa_nodes(self) -> list[int]: - try: - numa_count = self.send_command( - "cat /sys/devices/system/node/online", verify=True - ).stdout - numa_range = expand_range(numa_count) - except RemoteCommandExecutionError: - # the file doesn't exist, meaning the node doesn't support numa - numa_range = [] - return numa_range - - def _mount_huge_pages(self) -> None: - self._logger.info("Re-mounting Hugepages.") - hugapge_fs_cmd = "awk '/hugetlbfs/ { print $2 }' /proc/mounts" - self.send_command(f"umount $({hugapge_fs_cmd})", privileged=True) - result = self.send_command(hugapge_fs_cmd) - if result.stdout == "": - remote_mount_path = "/mnt/huge" - self.send_command(f"mkdir -p {remote_mount_path}", privileged=True) - self.send_command(f"mount -t hugetlbfs nodev {remote_mount_path}", privileged=True) - - def _supports_numa(self) -> bool: - # the system supports numa if self._numa_nodes is non-empty and there are more - # than one numa node (in the latter case it may actually support numa, but - # there's no reason to do any numa specific configuration) - return len(self._numa_nodes) > 1 - - def _configure_huge_pages(self, number_of: int, size: int, force_first_numa: bool) -> None: - self._logger.info("Configuring Hugepages.") - hugepage_config_path = f"/sys/kernel/mm/hugepages/hugepages-{size}kB/nr_hugepages" - if force_first_numa and self._supports_numa(): - # clear non-numa hugepages - self.send_command(f"echo 0 | tee {hugepage_config_path}", privileged=True) - hugepage_config_path = ( - f"/sys/devices/system/node/node{self._numa_nodes[0]}/hugepages" - f"/hugepages-{size}kB/nr_hugepages" - ) - - self.send_command(f"echo {number_of} | tee {hugepage_config_path}", privileged=True) - - def get_port_info(self, pci_address: str) -> PortInfo: - """Overrides :meth:`~.os_session.OSSession.get_port_info`. - - Raises: - ConfigurationError: If the port could not be found. - """ - bus_info = f"pci@{pci_address}" - port = next((port for port in self._lshw_net_info if port.get("businfo") == bus_info), None) - if port is None: - raise ConfigurationError(f"Port {pci_address} could not be found on the node.") - - logical_name = port.get("logicalname", "") - mac_address = port.get("serial", "") - - configuration = port.get("configuration", {}) - driver = configuration.get("driver", "") - is_link_up = configuration.get("link", "down") == "up" - - return PortInfo(mac_address, logical_name, driver, is_link_up) - - def unbind_ports(self, ports: list[Port]): - """Overrides :meth:`~.os_session.OSSession.unbind_ports`. - - The :attr:`~.devbind_script_path` property must be setup in order to call this method. - """ - ports_pci_addrs = " ".join(port.pci for port in ports) - - self.send_command( - f"{self.devbind_script_path} -u --force {ports_pci_addrs}", - privileged=True, - verify=True, - ) - - if self._lshw_net_info: - del self._lshw_net_info - - def get_nic_info(self) -> list[dict[str, str]]: - """Overrides :meth`~.os_session.OSSession.get_nic_info`. - - Raises: - ConfigurationError: If the NIC info could not be found. - """ - port_to_data = { - port.get("businfo"): port for port in self._lshw_net_info if port.get("businfo") - } - - all_nic_info: list[dict[str, str]] = [] - for port in self._config.ports: - pci_addr = port.pci - - lshw_result = self.send_command( - f"sudo lshw -c network -businfo | grep '{pci_addr}' | cut -d'@' -f1" - ) - if lshw_result.return_code != 0 or lshw_result.stdout == "": - raise ConfigurationError(f"Unable to get bus type for port {pci_addr}.") - bus_type = lshw_result.stdout - - bus_info = f"{bus_type}@{pci_addr}" - nic_port: LshwOutput | None = port_to_data[bus_info] - if nic_port is None: - raise ConfigurationError(f"Port {pci_addr} could not be found on the node.") - - config: LshwConfigurationOutput | None = nic_port["configuration"] - if config is None: - raise ConfigurationError( - f"Configuration info for port {pci_addr} could not be found on the node." - ) - - if "logicalname" not in nic_port: - raise ConfigurationError( - f"Logical name for port {pci_addr} could not be found on the node." - ) - - ethtool_result = self.send_command( - f"ethtool {nic_port['logicalname']} | grep 'Speed:' | awk '{{print $2}}'" - ) - if ethtool_result.return_code == 0 and ethtool_result.stdout: - nic_speed = ethtool_result.stdout - else: - self._logger.error(f"Unable to get speed for NIC: {pci_addr}") - nic_speed = None - - dut_json = { - "make": nic_port["vendor"] if "vendor" in nic_port else "Unknown", - "model": nic_port["product"] if "product" in nic_port else "Unknown", - "hardware version": nic_port["version"] if "version" in nic_port else "Unknown", - "firmware version": config["firmware"] if "firmware" in config else "Unknown", - "deviceBusType": bus_type, - "deviceId": nic_port["serial"] if "serial" in nic_port else "Unknown", - "pmd": config["driver"] if "driver" in config else "Unknown", - "speed": nic_speed or "Unknown", - } - all_nic_info.append(dut_json) - - return all_nic_info - - def bind_ports_to_driver(self, ports: list[Port], driver_name: str) -> None: - """Overrides :meth:`~.os_session.OSSession.bind_ports_to_driver`. - - The :attr:`~.devbind_script_path` property must be setup in order to call this method. - """ - ports_pci_addrs = " ".join(port.pci for port in ports) - - self.send_command( - f"{self.devbind_script_path} -b {driver_name} --force {ports_pci_addrs}", - privileged=True, - verify=True, - ) - - del self._lshw_net_info - - def bring_up_link(self, ports: Iterable[Port]) -> None: - """Overrides :meth:`~.os_session.OSSession.bring_up_link`.""" - for port in ports: - self.send_command( - f"ip link set dev {port.logical_name} up", privileged=True, verify=True - ) - - del self._lshw_net_info - + @abstractmethod def set_interface_link_up(self, name: str) -> None: - """Overrides :meth:`~.os_session.OSSession.set_interface_link_up`.""" - self.send_command(f"ip link set dev {name} up", privileged=True, verify=True) - - def delete_interface(self, name: str) -> None: - """Overrides :meth:`~.os_session.OSSession.delete_interface`.""" - self.send_command(f"ip link delete {name}", privileged=True) - - @cached_property - def devbind_script_path(self) -> PurePath: - """The path to the dpdk-devbind.py script on the node. - - Needs to be manually assigned first in order to be used. - - Raises: - InternalError: If accessed before environment setup. - """ - raise InternalError("Accessed devbind script path before setup.") - - def load_vfio(self, pf_port: Port) -> None: - """Overrides :meth:`~os_session.OSSession,load_vfio`.""" - cmd_result = self.send_command(f"lspci -nn -s {pf_port.pci}") - device = re.search(r":([0-9a-fA-F]{4})\]", cmd_result.stdout) - if device and device.group(1) in ["37c8", "0435", "19e2"]: - self.send_command( - "modprobe -r vfio_iommu_type1; modprobe -r vfio_pci", - privileged=True, - ) - self.send_command( - "modprobe -r vfio_virqfd; modprobe -r vfio", - privileged=True, - ) - self.send_command( - "modprobe vfio-pci disable_denylist=1 enable_sriov=1", privileged=True - ) - self.send_command( - "echo 1 | tee /sys/module/vfio/parameters/enable_unsafe_noiommu_mode", - privileged=True, - ) - else: - self.send_command("modprobe vfio-pci", privileged=True) - self.refresh_lshw() - - def create_crypto_vfs(self, pf_port: list[Port]) -> None: - """Overrides :meth:`~os_session.OSSession.create_crypto_vfs`. - - Raises: - InternalError: If there are existing VFs which have to be deleted. - """ - for port in pf_port: - self.delete_crypto_vfs(port) - for port in pf_port: - sys_bus_path = f"/sys/bus/pci/devices/{port.pci}".replace(":", "\\:") - curr_num_vfs = int( - self.send_command(f"cat {sys_bus_path}/sriov_numvfs", privileged=True).stdout - ) - if 0 < curr_num_vfs: - raise InternalError("There are existing VFs on the port which must be deleted.") - num_vfs = int( - self.send_command(f"cat {sys_bus_path}/sriov_totalvfs", privileged=True).stdout - ) - self.send_command( - f"echo {num_vfs} | sudo tee {sys_bus_path}/sriov_numvfs", privileged=True - ) - - self.refresh_lshw() + """Set the link status of an interface to up. - def create_vfs(self, pf_port: Port) -> None: - """Overrides :meth:`~.os_session.OSSession.create_vfs`. - - Raises: - InternalError: If there are existing VFs which have to be deleted. + Args: + name: The name of the interface. """ - sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") - curr_num_vfs = int( - self.send_command(f"cat {sys_bus_path}/sriov_numvfs", privileged=True).stdout - ) - if 0 < curr_num_vfs: - raise InternalError("There are existing VFs on the port which must be deleted.") - if curr_num_vfs == 0: - self.send_command(f"echo 1 | sudo tee {sys_bus_path}/sriov_numvfs", privileged=True) - self.refresh_lshw() - def delete_crypto_vfs(self, pf_port: Port) -> None: - """Overrides :meth:`~.os_session.OSSession.delete_crypto_vfs`. + @abstractmethod + def delete_interface(self, name: str) -> None: + """Delete a virtual interface. - The :attr:`~.devbind_script_path` property must be setup in order to call this method. + Args: + name: the name of the interface to delete. """ - if vfs := self.get_pci_addr_of_crypto_vfs(pf_port): - vf_pci_addrs = " ".join(vf for vf in vfs) - self.send_command( - f"{self.devbind_script_path} -u --force {vf_pci_addrs}", - privileged=True, - verify=True, - ) - self.unbind_ports([pf_port]) - self.send_command( - f"echo 1 | sudo tee /sys/bus/pci/devices/{pf_port.pci}/remove".replace(":", "\\:"), - privileged=True, - ) - self.send_command("echo 1 | sudo tee /sys/bus/pci/rescan", privileged=True) - - def delete_vfs(self, pf_port: Port) -> None: - """Overrides :meth:`~.os_session.OSSession.delete_vfs`.""" - sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") - curr_num_vfs = int( - self.send_command(f"cat {sys_bus_path}/sriov_numvfs", privileged=True).stdout - ) - if curr_num_vfs == 0: - self._logger.debug(f"No VFs found on port {pf_port.pci}, skipping deletion") - else: - self.send_command(f"echo 0 | sudo tee {sys_bus_path}/sriov_numvfs", privileged=True) - - def get_pci_addr_of_crypto_vfs(self, pf_port: Port) -> list[str]: - """Overrides :meth:`~.os_session.OSSession.get_pci_addr_of_crypto_vfs`.""" - sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") - curr_num_vfs = int(self.send_command(f"cat {sys_bus_path}/sriov_numvfs").stdout) - if curr_num_vfs > 0: - pci_addrs = self.send_command( - f"readlink {sys_bus_path}/virtfn*", - privileged=True, - ) - return [pci.replace("../", "") for pci in pci_addrs.stdout.splitlines()] - return [] - - def get_pci_addr_of_vfs(self, pf_port: Port) -> list[str]: - """Overrides :meth:`~.os_session.OSSession.get_pci_addr_of_vfs`.""" - sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") - curr_num_vfs = int(self.send_command(f"cat {sys_bus_path}/sriov_numvfs").stdout) - if curr_num_vfs > 0: - pci_addrs = self.send_command( - 'awk -F "PCI_SLOT_NAME=" "/PCI_SLOT_NAME=/ {print \\$2}" ' - + f"{sys_bus_path}/virtfn*/uevent", - privileged=True, - ) - return pci_addrs.stdout.splitlines() - else: - return [] - @cached_property - def _lshw_net_info(self) -> list[LshwOutput]: - output = self.send_command("lshw -quiet -json -C network", verify=True) - return json.loads(output.stdout) - - def refresh_lshw(self) -> None: - """Force refresh of cached lshw network info.""" - if "_lshw_net_info" in self.__dict__: - del self.__dict__["_lshw_net_info"] - _ = self._lshw_net_info - - def _update_port_attr(self, port: Port, attr_value: str | None, attr_name: str) -> None: - if attr_value: - setattr(port, attr_name, attr_value) - self._logger.debug(f"Found '{attr_name}' of port {port.pci}: '{attr_value}'.") - else: - self._logger.warning( - f"Attempted to get '{attr_name}' of port {port.pci}, but it doesn't exist." - ) - - def configure_port_mtu(self, mtu: int, port: Port) -> None: - """Overrides :meth:`~.os_session.OSSession.configure_port_mtu`.""" - self.send_command( - f"ip link set dev {port.logical_name} mtu {mtu}", - privileged=True, - verify=True, - ) + @property + @abstractmethod + def devbind_script_path(self) -> PurePath: + """The path to the dpdk-devbind.py script on the node.""" - def configure_ipv4_forwarding(self, enable: bool) -> None: - """Overrides :meth:`~.os_session.OSSession.configure_ipv4_forwarding`.""" - state = 1 if enable else 0 - self.send_command(f"sysctl -w net.ipv4.ip_forward={state}", privileged=True) + @devbind_script_path.setter + @abstractmethod + def devbind_script_path(self, value: PurePath): + """Set the devbind script path after environment setup.""" diff --git a/dts/api/testbed_model/node.py b/dts/api/testbed_model/node.py index 40dd7f0666..ae9886e531 100644 --- a/dts/api/testbed_model/node.py +++ b/dts/api/testbed_model/node.py @@ -22,10 +22,10 @@ OS, NodeConfiguration, ) +from framework.linux_session import LinuxSession from framework.logger import DTSLogger, get_dts_logger from .cpu import Architecture, LogicalCore -from .linux_session import LinuxSession from .os_session import OSSession, OSSessionInfo from .port import Port diff --git a/dts/framework/linux_session.py b/dts/framework/linux_session.py new file mode 100644 index 0000000000..2828f52965 --- /dev/null +++ b/dts/framework/linux_session.py @@ -0,0 +1,460 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2023 PANTHEON.tech s.r.o. +# Copyright(c) 2023 University of New Hampshire + +"""Linux OS translator. + +Translate OS-unaware calls into Linux calls/utilities. Most of Linux distributions are mostly +compliant with POSIX standards, so this module only implements the parts that aren't. +This intermediate module implements the common parts of mostly POSIX compliant distributions. +""" + +import json +import re +from collections.abc import Iterable +from functools import cached_property +from pathlib import PurePath +from typing import TypedDict + +from typing_extensions import NotRequired + +from api.exception import ( + ConfigurationError, + InternalError, + RemoteCommandExecutionError, +) +from api.testbed_model.cpu import LogicalCore +from api.testbed_model.port import Port, PortInfo +from api.testbed_model.posix_session import PosixSession +from api.utils import expand_range + + +class LshwConfigurationOutput(TypedDict): + """The relevant parts of ``lshw``'s ``configuration`` section.""" + + #: + driver: str + #: + link: str + #: + firmware: str + + +class LshwOutput(TypedDict): + """A model of the relevant information from ``lshw``'s json output. + + Example: + :: + + { + ... + "businfo" : "pci@0000:08:00.0", + "logicalname" : "enp8s0", + "version" : "00", + "serial" : "52:54:00:59:e1:ac", + ... + "configuration" : { + ... + "link" : "yes", + ... + }, + ... + """ + + #: + vendor: NotRequired[str] + #: + product: NotRequired[str] + #: + version: NotRequired[str] + #: + businfo: str + #: + logicalname: NotRequired[str] + #: + serial: NotRequired[str] + #: + configuration: LshwConfigurationOutput + + +class LinuxSession(PosixSession): + """The implementation of non-Posix compliant parts of Linux.""" + + @staticmethod + def _get_privileged_command(command: str) -> str: + command = command.replace(r"'", r"\'") + return f"sudo -- sh -c '{command}'" + + def get_remote_cpus(self) -> list[LogicalCore]: + """Overrides :meth:`~.os_session.OSSession.get_remote_cpus`.""" + cpu_info = self.send_command("lscpu -p=CPU,CORE,SOCKET,NODE|grep -v \\#").stdout + lcores = [] + for cpu_line in cpu_info.splitlines(): + lcore, core, socket, node = map(int, cpu_line.split(",")) + lcores.append(LogicalCore(lcore, core, socket, node)) + return lcores + + def get_dpdk_file_prefix(self, dpdk_prefix: str) -> str: + """Overrides :meth:`~.os_session.OSSession.get_dpdk_file_prefix`.""" + return dpdk_prefix + + def setup_hugepages(self, number_of: int, hugepage_size: int, force_first_numa: bool) -> None: + """Overrides :meth:`~.os_session.OSSession.setup_hugepages`. + + Raises: + ConfigurationError: If the given `hugepage_size` is not supported by the OS. + """ + self._logger.info("Getting Hugepage information.") + if ( + f"hugepages-{hugepage_size}kB" + not in self.send_command("ls /sys/kernel/mm/hugepages").stdout + ): + raise ConfigurationError("hugepage size not supported by operating system") + hugepages_total = self._get_hugepages_total(hugepage_size) + self._numa_nodes = self._get_numa_nodes() + + if force_first_numa or hugepages_total < number_of: + # when forcing numa, we need to clear existing hugepages regardless + # of size, so they can be moved to the first numa node + self._configure_huge_pages(number_of, hugepage_size, force_first_numa) + else: + self._logger.info("Hugepages already configured.") + self._mount_huge_pages() + + def _get_hugepages_total(self, hugepage_size: int) -> int: + hugepages_total = self.send_command( + f"cat /sys/kernel/mm/hugepages/hugepages-{hugepage_size}kB/nr_hugepages" + ).stdout + return int(hugepages_total) + + def _get_numa_nodes(self) -> list[int]: + try: + numa_count = self.send_command( + "cat /sys/devices/system/node/online", verify=True + ).stdout + numa_range = expand_range(numa_count) + except RemoteCommandExecutionError: + # the file doesn't exist, meaning the node doesn't support numa + numa_range = [] + return numa_range + + def _mount_huge_pages(self) -> None: + self._logger.info("Re-mounting Hugepages.") + hugapge_fs_cmd = "awk '/hugetlbfs/ { print $2 }' /proc/mounts" + self.send_command(f"umount $({hugapge_fs_cmd})", privileged=True) + result = self.send_command(hugapge_fs_cmd) + if result.stdout == "": + remote_mount_path = "/mnt/huge" + self.send_command(f"mkdir -p {remote_mount_path}", privileged=True) + self.send_command(f"mount -t hugetlbfs nodev {remote_mount_path}", privileged=True) + + def _supports_numa(self) -> bool: + # the system supports numa if self._numa_nodes is non-empty and there are more + # than one numa node (in the latter case it may actually support numa, but + # there's no reason to do any numa specific configuration) + return len(self._numa_nodes) > 1 + + def _configure_huge_pages(self, number_of: int, size: int, force_first_numa: bool) -> None: + self._logger.info("Configuring Hugepages.") + hugepage_config_path = f"/sys/kernel/mm/hugepages/hugepages-{size}kB/nr_hugepages" + if force_first_numa and self._supports_numa(): + # clear non-numa hugepages + self.send_command(f"echo 0 | tee {hugepage_config_path}", privileged=True) + hugepage_config_path = ( + f"/sys/devices/system/node/node{self._numa_nodes[0]}/hugepages" + f"/hugepages-{size}kB/nr_hugepages" + ) + + self.send_command(f"echo {number_of} | tee {hugepage_config_path}", privileged=True) + + def get_port_info(self, pci_address: str) -> PortInfo: + """Overrides :meth:`~.os_session.OSSession.get_port_info`. + + Raises: + ConfigurationError: If the port could not be found. + """ + bus_info = f"pci@{pci_address}" + port = next((port for port in self._lshw_net_info if port.get("businfo") == bus_info), None) + if port is None: + raise ConfigurationError(f"Port {pci_address} could not be found on the node.") + + logical_name = port.get("logicalname", "") + mac_address = port.get("serial", "") + + configuration = port.get("configuration", {}) + driver = configuration.get("driver", "") + is_link_up = configuration.get("link", "down") == "up" + + return PortInfo(mac_address, logical_name, driver, is_link_up) + + def unbind_ports(self, ports: list[Port]): + """Overrides :meth:`~.os_session.OSSession.unbind_ports`. + + The :attr:`~.devbind_script_path` property must be setup in order to call this method. + """ + ports_pci_addrs = " ".join(port.pci for port in ports) + + self.send_command( + f"{self.devbind_script_path} -u --force {ports_pci_addrs}", + privileged=True, + verify=True, + ) + + if self._lshw_net_info: + del self._lshw_net_info + + def get_nic_info(self) -> list[dict[str, str]]: + """Overrides :meth`~.os_session.OSSession.get_nic_info`. + + Raises: + ConfigurationError: If the NIC info could not be found. + """ + port_to_data = { + port.get("businfo"): port for port in self._lshw_net_info if port.get("businfo") + } + + all_nic_info: list[dict[str, str]] = [] + for port in self._config.ports: + pci_addr = port.pci + + lshw_result = self.send_command( + f"sudo lshw -c network -businfo | grep '{pci_addr}' | cut -d'@' -f1" + ) + if lshw_result.return_code != 0 or lshw_result.stdout == "": + raise ConfigurationError(f"Unable to get bus type for port {pci_addr}.") + bus_type = lshw_result.stdout + + bus_info = f"{bus_type}@{pci_addr}" + nic_port: LshwOutput | None = port_to_data[bus_info] + if nic_port is None: + raise ConfigurationError(f"Port {pci_addr} could not be found on the node.") + + config: LshwConfigurationOutput | None = nic_port["configuration"] + if config is None: + raise ConfigurationError( + f"Configuration info for port {pci_addr} could not be found on the node." + ) + + if "logicalname" not in nic_port: + raise ConfigurationError( + f"Logical name for port {pci_addr} could not be found on the node." + ) + + ethtool_result = self.send_command( + f"ethtool {nic_port['logicalname']} | grep 'Speed:' | awk '{{print $2}}'" + ) + if ethtool_result.return_code == 0 and ethtool_result.stdout: + nic_speed = ethtool_result.stdout + else: + self._logger.error(f"Unable to get speed for NIC: {pci_addr}") + nic_speed = None + + dut_json = { + "make": nic_port["vendor"] if "vendor" in nic_port else "Unknown", + "model": nic_port["product"] if "product" in nic_port else "Unknown", + "hardware version": nic_port["version"] if "version" in nic_port else "Unknown", + "firmware version": config["firmware"] if "firmware" in config else "Unknown", + "deviceBusType": bus_type, + "deviceId": nic_port["serial"] if "serial" in nic_port else "Unknown", + "pmd": config["driver"] if "driver" in config else "Unknown", + "speed": nic_speed or "Unknown", + } + all_nic_info.append(dut_json) + + return all_nic_info + + def bind_ports_to_driver(self, ports: list[Port], driver_name: str) -> None: + """Overrides :meth:`~.os_session.OSSession.bind_ports_to_driver`. + + The :attr:`~.devbind_script_path` property must be setup in order to call this method. + """ + ports_pci_addrs = " ".join(port.pci for port in ports) + + self.send_command( + f"{self.devbind_script_path} -b {driver_name} --force {ports_pci_addrs}", + privileged=True, + verify=True, + ) + + del self._lshw_net_info + + def bring_up_link(self, ports: Iterable[Port]) -> None: + """Overrides :meth:`~.os_session.OSSession.bring_up_link`.""" + for port in ports: + self.send_command( + f"ip link set dev {port.logical_name} up", privileged=True, verify=True + ) + + del self._lshw_net_info + + def set_interface_link_up(self, name: str) -> None: + """Overrides :meth:`~.os_session.OSSession.set_interface_link_up`.""" + self.send_command(f"ip link set dev {name} up", privileged=True, verify=True) + + def delete_interface(self, name: str) -> None: + """Overrides :meth:`~.os_session.OSSession.delete_interface`.""" + self.send_command(f"ip link delete {name}", privileged=True) + + @cached_property + def devbind_script_path(self) -> PurePath: + """The path to the dpdk-devbind.py script on the node. + + Needs to be manually assigned first in order to be used. + + Raises: + InternalError: If accessed before environment setup. + """ + raise InternalError("Accessed devbind script path before setup.") + + def load_vfio(self, pf_port: Port) -> None: + """Overrides :meth:`~os_session.OSSession,load_vfio`.""" + cmd_result = self.send_command(f"lspci -nn -s {pf_port.pci}") + device = re.search(r":([0-9a-fA-F]{4})\]", cmd_result.stdout) + if device and device.group(1) in ["37c8", "0435", "19e2"]: + self.send_command( + "modprobe -r vfio_iommu_type1; modprobe -r vfio_pci", + privileged=True, + ) + self.send_command( + "modprobe -r vfio_virqfd; modprobe -r vfio", + privileged=True, + ) + self.send_command( + "modprobe vfio-pci disable_denylist=1 enable_sriov=1", privileged=True + ) + self.send_command( + "echo 1 | tee /sys/module/vfio/parameters/enable_unsafe_noiommu_mode", + privileged=True, + ) + else: + self.send_command("modprobe vfio-pci", privileged=True) + self.refresh_lshw() + + def create_crypto_vfs(self, pf_port: list[Port]) -> None: + """Overrides :meth:`~os_session.OSSession.create_crypto_vfs`. + + Raises: + InternalError: If there are existing VFs which have to be deleted. + """ + for port in pf_port: + self.delete_crypto_vfs(port) + for port in pf_port: + sys_bus_path = f"/sys/bus/pci/devices/{port.pci}".replace(":", "\\:") + curr_num_vfs = int( + self.send_command(f"cat {sys_bus_path}/sriov_numvfs", privileged=True).stdout + ) + if 0 < curr_num_vfs: + raise InternalError("There are existing VFs on the port which must be deleted.") + num_vfs = int( + self.send_command(f"cat {sys_bus_path}/sriov_totalvfs", privileged=True).stdout + ) + self.send_command( + f"echo {num_vfs} | sudo tee {sys_bus_path}/sriov_numvfs", privileged=True + ) + + self.refresh_lshw() + + def create_vfs(self, pf_port: Port) -> None: + """Overrides :meth:`~.os_session.OSSession.create_vfs`. + + Raises: + InternalError: If there are existing VFs which have to be deleted. + """ + sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") + curr_num_vfs = int( + self.send_command(f"cat {sys_bus_path}/sriov_numvfs", privileged=True).stdout + ) + if 0 < curr_num_vfs: + raise InternalError("There are existing VFs on the port which must be deleted.") + if curr_num_vfs == 0: + self.send_command(f"echo 1 | sudo tee {sys_bus_path}/sriov_numvfs", privileged=True) + self.refresh_lshw() + + def delete_crypto_vfs(self, pf_port: Port) -> None: + """Overrides :meth:`~.os_session.OSSession.delete_crypto_vfs`. + + The :attr:`~.devbind_script_path` property must be setup in order to call this method. + """ + if vfs := self.get_pci_addr_of_crypto_vfs(pf_port): + vf_pci_addrs = " ".join(vf for vf in vfs) + self.send_command( + f"{self.devbind_script_path} -u --force {vf_pci_addrs}", + privileged=True, + verify=True, + ) + self.unbind_ports([pf_port]) + self.send_command( + f"echo 1 | sudo tee /sys/bus/pci/devices/{pf_port.pci}/remove".replace(":", "\\:"), + privileged=True, + ) + self.send_command("echo 1 | sudo tee /sys/bus/pci/rescan", privileged=True) + + def delete_vfs(self, pf_port: Port) -> None: + """Overrides :meth:`~.os_session.OSSession.delete_vfs`.""" + sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") + curr_num_vfs = int( + self.send_command(f"cat {sys_bus_path}/sriov_numvfs", privileged=True).stdout + ) + if curr_num_vfs == 0: + self._logger.debug(f"No VFs found on port {pf_port.pci}, skipping deletion") + else: + self.send_command(f"echo 0 | sudo tee {sys_bus_path}/sriov_numvfs", privileged=True) + + def get_pci_addr_of_crypto_vfs(self, pf_port: Port) -> list[str]: + """Overrides :meth:`~.os_session.OSSession.get_pci_addr_of_crypto_vfs`.""" + sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") + curr_num_vfs = int(self.send_command(f"cat {sys_bus_path}/sriov_numvfs").stdout) + if curr_num_vfs > 0: + pci_addrs = self.send_command( + f"readlink {sys_bus_path}/virtfn*", + privileged=True, + ) + return [pci.replace("../", "") for pci in pci_addrs.stdout.splitlines()] + return [] + + def get_pci_addr_of_vfs(self, pf_port: Port) -> list[str]: + """Overrides :meth:`~.os_session.OSSession.get_pci_addr_of_vfs`.""" + sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") + curr_num_vfs = int(self.send_command(f"cat {sys_bus_path}/sriov_numvfs").stdout) + if curr_num_vfs > 0: + pci_addrs = self.send_command( + 'awk -F "PCI_SLOT_NAME=" "/PCI_SLOT_NAME=/ {print \\$2}" ' + + f"{sys_bus_path}/virtfn*/uevent", + privileged=True, + ) + return pci_addrs.stdout.splitlines() + else: + return [] + + @cached_property + def _lshw_net_info(self) -> list[LshwOutput]: + output = self.send_command("lshw -quiet -json -C network", verify=True) + return json.loads(output.stdout) + + def refresh_lshw(self) -> None: + """Force refresh of cached lshw network info.""" + if "_lshw_net_info" in self.__dict__: + del self.__dict__["_lshw_net_info"] + _ = self._lshw_net_info + + def _update_port_attr(self, port: Port, attr_value: str | None, attr_name: str) -> None: + if attr_value: + setattr(port, attr_name, attr_value) + self._logger.debug(f"Found '{attr_name}' of port {port.pci}: '{attr_value}'.") + else: + self._logger.warning( + f"Attempted to get '{attr_name}' of port {port.pci}, but it doesn't exist." + ) + + def configure_port_mtu(self, mtu: int, port: Port) -> None: + """Overrides :meth:`~.os_session.OSSession.configure_port_mtu`.""" + self.send_command( + f"ip link set dev {port.logical_name} mtu {mtu}", + privileged=True, + verify=True, + ) + + def configure_ipv4_forwarding(self, enable: bool) -> None: + """Overrides :meth:`~.os_session.OSSession.configure_ipv4_forwarding`.""" + state = 1 if enable else 0 + self.send_command(f"sysctl -w net.ipv4.ip_forward={state}", privileged=True) -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* [PATCH v7 0/7] dts: remove imports from framework in test suites 2026-08-06 13:53 [PATCH v5 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (8 preceding siblings ...) 2026-08-06 17:50 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey @ 2026-08-07 16:16 ` Andrew Bailey 2026-08-07 16:16 ` [PATCH v7 1/7] dts: move exception module from framework to API Andrew Bailey ` (7 more replies) 9 siblings, 8 replies; 47+ messages in thread From: Andrew Bailey @ 2026-08-07 16:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx This series takes action to make modules accessible from api that were only in framework before. This greatly cleans up the majority of test suites, ridding them of almost all framework imports. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- v5: * Resolved merge conflicts and rebased to main. * Removed additional framework imports from test suites. v6: * Included missing linux_session py file. * Included missing linux_session rst file. v7: * Resolved issue where linux sessions was not imported properly. Andrew Bailey (7): dts: move exception module from framework to API dts: move utils from framework to API dts: move context from framework to API dts: move testbed model from framework to API dts: move test suite module from framework to API dts: move params directory from framework to API dts: separate Linux session into interface and logic ...{framework.context.rst => api.context.rst} | 2 +- ...mework.exception.rst => api.exception.rst} | 2 +- ...work.params.eal.rst => api.params.eal.rst} | 2 +- .../{framework.params.rst => api.params.rst} | 6 +- ....params.types.rst => api.params.types.rst} | 2 +- ...work.test_suite.rst => api.test_suite.rst} | 2 +- ...y.rst => api.testbed_model.capability.rst} | 2 +- ...odel.cpu.rst => api.testbed_model.cpu.rst} | 2 +- ...st => api.testbed_model.linux_session.rst} | 2 +- ...el.node.rst => api.testbed_model.node.rst} | 2 +- ...n.rst => api.testbed_model.os_session.rst} | 2 +- ...el.port.rst => api.testbed_model.port.rst} | 2 +- ...st => api.testbed_model.posix_session.rst} | 2 +- doc/api/dts/api.testbed_model.rst | 28 ++++++ ...ogy.rst => api.testbed_model.topology.rst} | 2 +- ...generator.capturing_traffic_generator.rst} | 2 +- .../api.testbed_model.traffic_generator.rst | 16 ++++ ...testbed_model.traffic_generator.scapy.rst} | 2 +- ...l.traffic_generator.traffic_generator.rst} | 2 +- ...t => api.testbed_model.virtual_device.rst} | 2 +- .../{framework.utils.rst => api.utils.rst} | 2 +- doc/api/dts/framework.linux_session.rst | 9 ++ doc/api/dts/framework.testbed_model.rst | 28 ------ ...mework.testbed_model.traffic_generator.rst | 16 ---- doc/api/dts/index.rst | 13 +-- dts/api/artifact.py | 6 +- dts/api/capabilities.py | 14 +-- dts/{framework => api}/context.py | 14 +-- dts/api/cryptodev/__init__.py | 6 +- dts/api/cryptodev/config.py | 6 +- dts/{framework => api}/exception.py | 0 dts/api/packet.py | 18 ++-- dts/{framework => api}/params/__init__.py | 0 dts/{framework => api}/params/eal.py | 8 +- dts/{framework => api}/params/types.py | 16 ++-- dts/api/test.py | 4 +- dts/{framework => api}/test_suite.py | 15 ++-- .../testbed_model/__init__.py | 0 .../testbed_model/capability.py | 18 ++-- dts/{framework => api}/testbed_model/cpu.py | 4 +- dts/api/testbed_model/linux_session.py | 43 +++++++++ dts/{framework => api}/testbed_model/node.py | 6 +- .../testbed_model/os_session.py | 8 +- dts/{framework => api}/testbed_model/port.py | 2 +- .../testbed_model/posix_session.py | 6 +- .../testbed_model/topology.py | 20 ++--- .../traffic_generator/__init__.py | 4 +- .../capturing_traffic_generator.py | 4 +- .../performance_traffic_generator.py | 0 .../testbed_model/traffic_generator/scapy.py | 14 +-- .../traffic_generator/traffic_generator.py | 8 +- .../testbed_model/traffic_generator/trex.py | 18 ++-- .../testbed_model/virtual_device.py | 0 dts/api/testpmd/__init__.py | 11 ++- dts/api/testpmd/config.py | 6 +- dts/api/testpmd/types.py | 2 +- dts/{framework => api}/utils.py | 2 +- dts/framework/config/__init__.py | 6 +- dts/framework/config/node.py | 2 +- dts/framework/config/test_run.py | 12 +-- .../{testbed_model => }/linux_session.py | 15 ++-- dts/framework/parser.py | 2 +- dts/framework/remote_session/blocking_app.py | 8 +- dts/framework/remote_session/dpdk.py | 16 ++-- dts/framework/remote_session/dpdk_shell.py | 6 +- .../interactive_remote_session.py | 2 +- .../remote_session/interactive_shell.py | 8 +- .../remote_session/remote_session.py | 4 +- dts/framework/runner.py | 4 +- dts/framework/test_result.py | 5 +- dts/framework/test_run.py | 24 ++--- dts/tests/TestSuite_blocklist.py | 4 +- dts/tests/TestSuite_buffer_scatter.py | 2 +- dts/tests/TestSuite_checksum_offload.py | 2 +- dts/tests/TestSuite_cryptodev_latency.py | 6 +- dts/tests/TestSuite_cryptodev_throughput.py | 89 +++++-------------- dts/tests/TestSuite_dual_vlan.py | 2 +- dts/tests/TestSuite_dynamic_config.py | 2 +- dts/tests/TestSuite_dynamic_queue_conf.py | 4 +- dts/tests/TestSuite_flow_offload.py | 12 +-- dts/tests/TestSuite_hello_world.py | 2 +- dts/tests/TestSuite_l2fwd.py | 8 +- dts/tests/TestSuite_mac_filter.py | 4 +- dts/tests/TestSuite_mtu.py | 2 +- dts/tests/TestSuite_packet_capture.py | 12 +-- dts/tests/TestSuite_port_control.py | 2 +- ...stSuite_port_restart_config_persistency.py | 2 +- dts/tests/TestSuite_port_stats.py | 2 +- dts/tests/TestSuite_promisc_support.py | 2 +- dts/tests/TestSuite_qinq.py | 2 +- dts/tests/TestSuite_queue_toggle.py | 2 +- dts/tests/TestSuite_rss.py | 6 +- dts/tests/TestSuite_rx_split.py | 4 +- dts/tests/TestSuite_rx_tx_offload.py | 2 +- .../TestSuite_single_core_forward_perf.py | 4 +- dts/tests/TestSuite_smoke_tests.py | 6 +- dts/tests/TestSuite_softnic.py | 6 +- dts/tests/TestSuite_speed_capabilities.py | 2 +- dts/tests/TestSuite_unified_packet.py | 2 +- dts/tests/TestSuite_virtio_forward.py | 8 +- dts/tests/TestSuite_vlan.py | 2 +- 101 files changed, 382 insertions(+), 372 deletions(-) rename doc/api/dts/{framework.context.rst => api.context.rst} (80%) rename doc/api/dts/{framework.exception.rst => api.exception.rst} (77%) rename doc/api/dts/{framework.params.eal.rst => api.params.eal.rst} (79%) rename doc/api/dts/{framework.params.rst => api.params.rst} (71%) rename doc/api/dts/{framework.params.types.rst => api.params.types.rst} (80%) rename doc/api/dts/{framework.test_suite.rst => api.test_suite.rst} (81%) rename doc/api/dts/{framework.testbed_model.capability.rst => api.testbed_model.capability.rst} (74%) rename doc/api/dts/{framework.testbed_model.cpu.rst => api.testbed_model.cpu.rst} (78%) rename doc/api/dts/{framework.testbed_model.linux_session.rst => api.testbed_model.linux_session.rst} (74%) rename doc/api/dts/{framework.testbed_model.node.rst => api.testbed_model.node.rst} (71%) rename doc/api/dts/{framework.testbed_model.os_session.rst => api.testbed_model.os_session.rst} (76%) rename doc/api/dts/{framework.testbed_model.port.rst => api.testbed_model.port.rst} (77%) rename doc/api/dts/{framework.testbed_model.posix_session.rst => api.testbed_model.posix_session.rst} (74%) create mode 100644 doc/api/dts/api.testbed_model.rst rename doc/api/dts/{framework.testbed_model.topology.rst => api.testbed_model.topology.rst} (73%) rename doc/api/dts/{framework.testbed_model.traffic_generator.capturing_traffic_generator.rst => api.testbed_model.traffic_generator.capturing_traffic_generator.rst} (68%) create mode 100644 doc/api/dts/api.testbed_model.traffic_generator.rst rename doc/api/dts/{framework.testbed_model.traffic_generator.scapy.rst => api.testbed_model.traffic_generator.scapy.rst} (70%) rename doc/api/dts/{framework.testbed_model.traffic_generator.traffic_generator.rst => api.testbed_model.traffic_generator.traffic_generator.rst} (65%) rename doc/api/dts/{framework.testbed_model.virtual_device.rst => api.testbed_model.virtual_device.rst} (72%) rename doc/api/dts/{framework.utils.rst => api.utils.rst} (80%) create mode 100644 doc/api/dts/framework.linux_session.rst delete mode 100644 doc/api/dts/framework.testbed_model.rst delete mode 100644 doc/api/dts/framework.testbed_model.traffic_generator.rst rename dts/{framework => api}/context.py (90%) rename dts/{framework => api}/exception.py (100%) rename dts/{framework => api}/params/__init__.py (100%) rename dts/{framework => api}/params/eal.py (89%) rename dts/{framework => api}/params/types.py (93%) rename dts/{framework => api}/test_suite.py (98%) rename dts/{framework => api}/testbed_model/__init__.py (100%) rename dts/{framework => api}/testbed_model/capability.py (98%) rename dts/{framework => api}/testbed_model/cpu.py (99%) create mode 100644 dts/api/testbed_model/linux_session.py rename dts/{framework => api}/testbed_model/node.py (98%) rename dts/{framework => api}/testbed_model/os_session.py (99%) rename dts/{framework => api}/testbed_model/port.py (98%) rename dts/{framework => api}/testbed_model/posix_session.py (99%) rename dts/{framework => api}/testbed_model/topology.py (96%) rename dts/{framework => api}/testbed_model/traffic_generator/__init__.py (95%) rename dts/{framework => api}/testbed_model/traffic_generator/capturing_traffic_generator.py (98%) rename dts/{framework => api}/testbed_model/traffic_generator/performance_traffic_generator.py (100%) rename dts/{framework => api}/testbed_model/traffic_generator/scapy.py (98%) rename dts/{framework => api}/testbed_model/traffic_generator/traffic_generator.py (91%) rename dts/{framework => api}/testbed_model/traffic_generator/trex.py (96%) rename dts/{framework => api}/testbed_model/virtual_device.py (100%) rename dts/{framework => api}/utils.py (99%) rename dts/framework/{testbed_model => }/linux_session.py (98%) -- 2.55.0 ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v7 1/7] dts: move exception module from framework to API 2026-08-07 16:16 ` [PATCH v7 0/7] dts: remove imports from framework in test suites Andrew Bailey @ 2026-08-07 16:16 ` Andrew Bailey 2026-08-20 13:48 ` Luca Vizzarro 2026-08-07 16:16 ` [PATCH v7 2/7] dts: move utils " Andrew Bailey ` (6 subsequent siblings) 7 siblings, 1 reply; 47+ messages in thread From: Andrew Bailey @ 2026-08-07 16:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx Multiple test suites currently import the exception module from the framework in order to catch certain errors during test execution. Move this to the API. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- ...mework.exception.rst => api.exception.rst} | 2 +- doc/api/dts/index.rst | 2 +- dts/api/artifact.py | 2 +- dts/api/cryptodev/__init__.py | 2 +- dts/{framework => api}/exception.py | 0 dts/api/packet.py | 2 +- dts/api/test.py | 2 +- dts/api/testpmd/__init__.py | 2 +- dts/framework/config/__init__.py | 2 +- dts/framework/config/test_run.py | 2 +- dts/framework/context.py | 2 +- dts/framework/parser.py | 2 +- dts/framework/remote_session/dpdk.py | 2 +- .../interactive_remote_session.py | 2 +- .../remote_session/interactive_shell.py | 4 +- .../remote_session/remote_session.py | 4 +- dts/framework/runner.py | 2 +- dts/framework/test_result.py | 3 +- dts/framework/test_run.py | 4 +- dts/framework/test_suite.py | 2 +- dts/framework/testbed_model/capability.py | 2 +- dts/framework/testbed_model/linux_session.py | 2 +- dts/framework/testbed_model/node.py | 2 +- dts/framework/testbed_model/port.py | 2 +- dts/framework/testbed_model/posix_session.py | 2 +- dts/framework/testbed_model/topology.py | 2 +- .../traffic_generator/__init__.py | 2 +- .../testbed_model/traffic_generator/scapy.py | 2 +- .../testbed_model/traffic_generator/trex.py | 2 +- dts/framework/utils.py | 2 +- dts/tests/TestSuite_cryptodev_throughput.py | 83 ++++--------------- dts/tests/TestSuite_dynamic_queue_conf.py | 2 +- dts/tests/TestSuite_flow_offload.py | 10 +-- dts/tests/TestSuite_mac_filter.py | 2 +- dts/tests/TestSuite_rss.py | 2 +- dts/tests/TestSuite_rx_split.py | 2 +- 36 files changed, 58 insertions(+), 108 deletions(-) rename doc/api/dts/{framework.exception.rst => api.exception.rst} (77%) rename dts/{framework => api}/exception.py (100%) diff --git a/doc/api/dts/framework.exception.rst b/doc/api/dts/api.exception.rst similarity index 77% rename from doc/api/dts/framework.exception.rst rename to doc/api/dts/api.exception.rst index efb47dc5ae..8e6bff5ee7 100644 --- a/doc/api/dts/framework.exception.rst +++ b/doc/api/dts/api.exception.rst @@ -3,6 +3,6 @@ exception - Exceptions ====================== -.. automodule:: framework.exception +.. automodule:: api.exception :members: :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index c719297c11..01f630e7cd 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -36,7 +36,7 @@ Modules framework.logger framework.parser framework.utils - framework.exception + api.exception Indices and tables diff --git a/dts/api/artifact.py b/dts/api/artifact.py index 24a2b05063..7d04c7ab49 100644 --- a/dts/api/artifact.py +++ b/dts/api/artifact.py @@ -47,7 +47,7 @@ from paramiko import SFTPClient, SFTPFile from typing_extensions import Buffer -from framework.exception import InternalError +from api.exception import InternalError from framework.logger import DTSLogger, get_dts_logger from framework.settings import SETTINGS from framework.testbed_model.node import Node, NodeIdentifier, get_node diff --git a/dts/api/cryptodev/__init__.py b/dts/api/cryptodev/__init__.py index 15cffcb409..335b811620 100644 --- a/dts/api/cryptodev/__init__.py +++ b/dts/api/cryptodev/__init__.py @@ -22,8 +22,8 @@ ThroughputResults, VerifyResults, ) +from api.exception import RemoteCommandExecutionError, SkippedTestException from framework.context import get_ctx -from framework.exception import RemoteCommandExecutionError, SkippedTestException from framework.remote_session.dpdk_shell import compute_eal_params if TYPE_CHECKING: diff --git a/dts/framework/exception.py b/dts/api/exception.py similarity index 100% rename from dts/framework/exception.py rename to dts/api/exception.py diff --git a/dts/api/packet.py b/dts/api/packet.py index 3dda18e781..eaecf205f7 100644 --- a/dts/api/packet.py +++ b/dts/api/packet.py @@ -27,9 +27,9 @@ from scapy.layers.l2 import Ether from scapy.packet import Packet, Padding, raw +from api.exception import InternalError from api.test import fail, log_debug from framework.context import get_ctx -from framework.exception import InternalError from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( PacketFilteringConfig, ) diff --git a/dts/api/test.py b/dts/api/test.py index 7947c407d2..29d6842111 100644 --- a/dts/api/test.py +++ b/dts/api/test.py @@ -11,8 +11,8 @@ from api.artifact import Artifact from api.capabilities import LinkTopology +from api.exception import InternalError, SkippedTestException, TestCaseVerifyError from framework.context import get_ctx -from framework.exception import InternalError, SkippedTestException, TestCaseVerifyError from framework.logger import DTSLogger diff --git a/dts/api/testpmd/__init__.py b/dts/api/testpmd/__init__.py index b41a21300e..fef7430cb8 100644 --- a/dts/api/testpmd/__init__.py +++ b/dts/api/testpmd/__init__.py @@ -32,6 +32,7 @@ from typing_extensions import Unpack from api.capabilities import LinkTopology, NicCapability +from api.exception import InteractiveCommandExecutionError, InternalError from api.testpmd.config import PortTopology, SimpleForwardingModes, TestPmdParams from api.testpmd.types import ( ChecksumOffloadOptions, @@ -55,7 +56,6 @@ VLANOffloadFlag, ) from framework.context import get_ctx -from framework.exception import InteractiveCommandExecutionError, InternalError from framework.params.types import TestPmdParamsDict from framework.remote_session.dpdk_shell import DPDKShell from framework.remote_session.interactive_shell import only_active diff --git a/dts/framework/config/__init__.py b/dts/framework/config/__init__.py index 573f55471a..e24a351ecf 100644 --- a/dts/framework/config/__init__.py +++ b/dts/framework/config/__init__.py @@ -35,7 +35,7 @@ from pydantic import Field, TypeAdapter, ValidationError, model_validator from typing_extensions import Self -from framework.exception import ConfigurationError +from api.exception import ConfigurationError from .common import FrozenModel, ValidationContext from .node import NodeConfiguration diff --git a/dts/framework/config/test_run.py b/dts/framework/config/test_run.py index 81630df77d..9aa0938d4e 100644 --- a/dts/framework/config/test_run.py +++ b/dts/framework/config/test_run.py @@ -27,7 +27,7 @@ ) from typing_extensions import TYPE_CHECKING, Self -from framework.exception import InternalError +from api.exception import InternalError from framework.utils import REGEX_FOR_PORT_LINK, StrEnum from .common import FrozenModel, load_fields_from_settings diff --git a/dts/framework/context.py b/dts/framework/context.py index b1c36f90a6..709b99421e 100644 --- a/dts/framework/context.py +++ b/dts/framework/context.py @@ -8,7 +8,7 @@ from dataclasses import MISSING, dataclass, field, fields from typing import TYPE_CHECKING, Any, Optional, ParamSpec, Union -from framework.exception import InternalError +from api.exception import InternalError from framework.remote_session.shell_pool import ShellPool from framework.settings import SETTINGS from framework.testbed_model.cpu import LogicalCoreCount, LogicalCoreList diff --git a/dts/framework/parser.py b/dts/framework/parser.py index 3075c36857..ebf470ad30 100644 --- a/dts/framework/parser.py +++ b/dts/framework/parser.py @@ -15,7 +15,7 @@ from typing_extensions import Self -from framework.exception import InternalError +from api.exception import InternalError class ParserFn(TypedDict): diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index e43e1f2123..0618855fc5 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -14,6 +14,7 @@ from typing import ClassVar, Final from api.capabilities import LinkTopology +from api.exception import ConfigurationError, RemoteFileNotFoundError from framework.config.test_run import ( DPDKBuildConfiguration, DPDKBuildOptionsConfiguration, @@ -26,7 +27,6 @@ RemoteDPDKTreeLocation, ) from framework.context import get_ctx -from framework.exception import ConfigurationError, RemoteFileNotFoundError from framework.logger import DTSLogger, get_dts_logger from framework.params.eal import EalParams from framework.remote_session.remote_session import CommandResult diff --git a/dts/framework/remote_session/interactive_remote_session.py b/dts/framework/remote_session/interactive_remote_session.py index fc42e862bc..3c1f00aab2 100644 --- a/dts/framework/remote_session/interactive_remote_session.py +++ b/dts/framework/remote_session/interactive_remote_session.py @@ -15,8 +15,8 @@ SSHException, ) +from api.exception import SSHConnectionError from framework.config.node import NodeConfiguration -from framework.exception import SSHConnectionError from framework.logger import DTSLogger diff --git a/dts/framework/remote_session/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index 6bba58a4f6..367a01714d 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -29,12 +29,12 @@ from paramiko import Channel, channel from typing_extensions import Self -from framework.context import get_ctx -from framework.exception import ( +from api.exception import ( InteractiveCommandExecutionError, InteractiveSSHSessionDeadError, InteractiveSSHTimeoutError, ) +from framework.context import get_ctx from framework.logger import DTSLogger, get_dts_logger from framework.params import Params from framework.settings import SETTINGS diff --git a/dts/framework/remote_session/remote_session.py b/dts/framework/remote_session/remote_session.py index fb5f6fedf5..95515c9ee2 100644 --- a/dts/framework/remote_session/remote_session.py +++ b/dts/framework/remote_session/remote_session.py @@ -24,13 +24,13 @@ SSHException, ) -from framework.config.node import NodeConfiguration -from framework.exception import ( +from api.exception import ( RemoteCommandExecutionError, SSHConnectionError, SSHSessionDeadError, SSHTimeoutError, ) +from framework.config.node import NodeConfiguration from framework.logger import DTSLogger from framework.settings import SETTINGS diff --git a/dts/framework/runner.py b/dts/framework/runner.py index fa4f06844e..cb137fbf7b 100644 --- a/dts/framework/runner.py +++ b/dts/framework/runner.py @@ -12,8 +12,8 @@ import sys import textwrap +from api.exception import ConfigurationError from framework.config.common import ValidationContext -from framework.exception import ConfigurationError from framework.test_run import TestRun from framework.testbed_model.node import Node diff --git a/dts/framework/test_result.py b/dts/framework/test_result.py index 21faa55dc1..3cecb928ca 100644 --- a/dts/framework/test_result.py +++ b/dts/framework/test_result.py @@ -35,12 +35,11 @@ ) from typing_extensions import OrderedDict +from api.exception import DTSError, ErrorSeverity, InternalError from framework.remote_session.dpdk import DPDKBuildInfo from framework.settings import SETTINGS from framework.testbed_model.os_session import OSSessionInfo -from .exception import DTSError, ErrorSeverity, InternalError - class Result(IntEnum): """The possible states that a setup, a teardown or a test case may end up in.""" diff --git a/dts/framework/test_run.py b/dts/framework/test_run.py index c20a0fa885..75d82c1104 100644 --- a/dts/framework/test_run.py +++ b/dts/framework/test_run.py @@ -108,9 +108,9 @@ from typing import ClassVar, Protocol, Union from api.capabilities import LinkTopology +from api.exception import InternalError, SkippedTestException, TestCaseVerifyError from framework.config.test_run import TestRunConfiguration from framework.context import Context, init_ctx -from framework.exception import InternalError, SkippedTestException, TestCaseVerifyError from framework.logger import DTSLogger, get_dts_logger from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment from framework.settings import SETTINGS @@ -138,7 +138,7 @@ class TestRun: If an error occurs, the current stage is aborted, the error is recorded, everything in the inner stages is marked as blocked and the run continues in the next iteration of the same stage. The return code is the highest `severity` of all - :class:`~.framework.exception.DTSError`\s. + :class:`~.api.exception.DTSError`\s. Example: An error occurs in a test suite setup. The current test suite is aborted, diff --git a/dts/framework/test_suite.py b/dts/framework/test_suite.py index 69ce26040a..e06fdd28b9 100644 --- a/dts/framework/test_suite.py +++ b/dts/framework/test_suite.py @@ -29,11 +29,11 @@ from scapy.packet import Packet from typing_extensions import Self +from api.exception import ConfigurationError, InternalError from framework.config.common import FrozenModel from framework.testbed_model.capability import TestProtocol from framework.testbed_model.topology import Topology -from .exception import ConfigurationError, InternalError from .logger import DTSLogger, get_dts_logger from .utils import to_pascal_case diff --git a/dts/framework/testbed_model/capability.py b/dts/framework/testbed_model/capability.py index b10799ea4b..00b40a3b1e 100644 --- a/dts/framework/testbed_model/capability.py +++ b/dts/framework/testbed_model/capability.py @@ -64,7 +64,7 @@ def test_scatter_mbuf_2048(self): from typing_extensions import Self from api.capabilities import LinkTopology, NicCapability -from framework.exception import ConfigurationError, InternalError, SkippedTestException +from api.exception import ConfigurationError, InternalError, SkippedTestException from framework.logger import get_dts_logger from framework.testbed_model.node import Node from framework.testbed_model.port import DriverKind diff --git a/dts/framework/testbed_model/linux_session.py b/dts/framework/testbed_model/linux_session.py index c118f803b6..4495ae35cf 100644 --- a/dts/framework/testbed_model/linux_session.py +++ b/dts/framework/testbed_model/linux_session.py @@ -18,7 +18,7 @@ from typing_extensions import NotRequired -from framework.exception import ( +from api.exception import ( ConfigurationError, InternalError, RemoteCommandExecutionError, diff --git a/dts/framework/testbed_model/node.py b/dts/framework/testbed_model/node.py index 67a96ef4e5..4f42bf6aeb 100644 --- a/dts/framework/testbed_model/node.py +++ b/dts/framework/testbed_model/node.py @@ -17,11 +17,11 @@ from pathlib import PurePath from typing import Literal, TypeAlias +from api.exception import ConfigurationError, InternalError from framework.config.node import ( OS, NodeConfiguration, ) -from framework.exception import ConfigurationError, InternalError from framework.logger import DTSLogger, get_dts_logger from .cpu import Architecture, LogicalCore diff --git a/dts/framework/testbed_model/port.py b/dts/framework/testbed_model/port.py index d81bc4cda0..aea3e59c25 100644 --- a/dts/framework/testbed_model/port.py +++ b/dts/framework/testbed_model/port.py @@ -12,8 +12,8 @@ from functools import cached_property from typing import TYPE_CHECKING, Any, Final, Literal, NamedTuple +from api.exception import InternalError from framework.config.node import PortConfig -from framework.exception import InternalError if TYPE_CHECKING: from .node import Node diff --git a/dts/framework/testbed_model/posix_session.py b/dts/framework/testbed_model/posix_session.py index dec952685a..db2c3c0c40 100644 --- a/dts/framework/testbed_model/posix_session.py +++ b/dts/framework/testbed_model/posix_session.py @@ -16,7 +16,7 @@ from collections.abc import Iterable from pathlib import Path, PurePath, PurePosixPath -from framework.exception import DPDKBuildError, RemoteCommandExecutionError +from api.exception import DPDKBuildError, RemoteCommandExecutionError from framework.settings import SETTINGS from framework.utils import ( MesonArgs, diff --git a/dts/framework/testbed_model/topology.py b/dts/framework/testbed_model/topology.py index 1db444fc01..002faf0b7f 100644 --- a/dts/framework/testbed_model/topology.py +++ b/dts/framework/testbed_model/topology.py @@ -18,7 +18,7 @@ from typing_extensions import Self from api.capabilities import LinkTopology -from framework.exception import ConfigurationError, InternalError +from api.exception import ConfigurationError, InternalError from framework.testbed_model.linux_session import LinuxSession from framework.testbed_model.node import Node, NodeIdentifier diff --git a/dts/framework/testbed_model/traffic_generator/__init__.py b/dts/framework/testbed_model/traffic_generator/__init__.py index fca251f534..324b5e88f3 100644 --- a/dts/framework/testbed_model/traffic_generator/__init__.py +++ b/dts/framework/testbed_model/traffic_generator/__init__.py @@ -14,12 +14,12 @@ and a capturing traffic generator is required. """ +from api.exception import ConfigurationError from framework.config.test_run import ( ScapyTrafficGeneratorConfig, TrafficGeneratorConfig, TrexTrafficGeneratorConfig, ) -from framework.exception import ConfigurationError from framework.testbed_model.node import Node from .scapy import ScapyTrafficGenerator diff --git a/dts/framework/testbed_model/traffic_generator/scapy.py b/dts/framework/testbed_model/traffic_generator/scapy.py index 62853a34e4..70856cc1f0 100644 --- a/dts/framework/testbed_model/traffic_generator/scapy.py +++ b/dts/framework/testbed_model/traffic_generator/scapy.py @@ -25,9 +25,9 @@ from scapy.layers.l2 import Ether from scapy.packet import Packet +from api.exception import InteractiveSSHSessionDeadError, InternalError from framework.config.node import OS from framework.config.test_run import ScapyTrafficGeneratorConfig -from framework.exception import InteractiveSSHSessionDeadError, InternalError from framework.remote_session.python_shell import PythonShell from framework.testbed_model.node import Node from framework.testbed_model.port import Port diff --git a/dts/framework/testbed_model/traffic_generator/trex.py b/dts/framework/testbed_model/traffic_generator/trex.py index d53791b0a6..2c3beebc59 100644 --- a/dts/framework/testbed_model/traffic_generator/trex.py +++ b/dts/framework/testbed_model/traffic_generator/trex.py @@ -11,9 +11,9 @@ from scapy.packet import Packet +from api.exception import SSHTimeoutError from framework.config.node import OS, NodeConfiguration from framework.config.test_run import TrexTrafficGeneratorConfig -from framework.exception import SSHTimeoutError from framework.parser import TextParser from framework.remote_session.blocking_app import BlockingApp from framework.remote_session.python_shell import PythonShell diff --git a/dts/framework/utils.py b/dts/framework/utils.py index 5753c1b7fe..235f4bf426 100644 --- a/dts/framework/utils.py +++ b/dts/framework/utils.py @@ -26,7 +26,7 @@ from scapy.layers.inet import IP, TCP, UDP, Ether from scapy.packet import Packet -from .exception import InternalError +from api.exception import InternalError REGEX_FOR_PCI_ADDRESS: str = r"[0-9a-fA-F]{4}:[0-9a-fA-F]{2}:[0-9a-fA-F]{2}.[0-9]{1}" _REGEX_FOR_COLON_OR_HYPHEN_SEP_MAC: str = r"(?:[\da-fA-F]{2}[:-]){5}[\da-fA-F]{2}" diff --git a/dts/tests/TestSuite_cryptodev_throughput.py b/dts/tests/TestSuite_cryptodev_throughput.py index 2fc0d8779a..53682f35fa 100644 --- a/dts/tests/TestSuite_cryptodev_throughput.py +++ b/dts/tests/TestSuite_cryptodev_throughput.py @@ -29,9 +29,8 @@ from api.cryptodev.types import ( CryptodevResults, ) -from api.test import verify +from api.test import skip, verify from framework.context import get_ctx -from framework.exception import SkippedTestException from framework.test_suite import BaseConfig, TestSuite, crypto_test from framework.testbed_model.virtual_device import VirtualDevice @@ -153,12 +152,9 @@ def aes_cbc(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aes_cbc" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -183,12 +179,9 @@ def aes_cbc_sha1(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aes_cbc_sha1" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -218,12 +211,9 @@ def aes_cbc_sha2(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aes_cbc_sha2" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -252,12 +242,9 @@ def aes_cbc_sha2_digest_16(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aes_cbc_sha2_digest_16" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -286,12 +273,9 @@ def aead_aes_gcm(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aead_aes_gcm" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -318,12 +302,9 @@ def aes_docsisbpi(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aes_docsisbpi" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -348,12 +329,9 @@ def sha1_hmac(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "sha1_hmac" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -379,12 +357,9 @@ def snow3g_uea2_snow3g_uia2(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "snow3g_uea2_snow3g_uia2" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -414,12 +389,9 @@ def zuc_eea3_zuc_eia3(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "zuc_eea3_zuc_eia3" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -449,12 +421,9 @@ def kasumi_f8_kasumi_f9(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "kasumi_f8_kasumi_f9" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, devtype=self.device_type, @@ -486,12 +455,9 @@ def aesni_mb_vdev(self) -> None: * Create a cryptodev instance with crypto_aesni_mb and supplied buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aesni_mb_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, vdevs=[VirtualDevice("crypto_aesni_mb0")], @@ -523,12 +489,9 @@ def aesni_gcm_vdev(self): * Create a cryptodev instance with crypto_aesni_gcm and supplied buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "aesni_gcm_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, vdevs=[VirtualDevice("crypto_aesni_gcm0")], @@ -556,12 +519,9 @@ def kasumi_vdev(self) -> None: * Create a cryptodev instance with crypto_kasumi and supplied buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "kasumi_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( vdevs=[VirtualDevice("crypto_kasumi0")], ptest=TestType.throughput, @@ -592,12 +552,9 @@ def snow3g_vdev(self) -> None: * Create a cryptodev instance with crypto_snow3g and supplied buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "snow3g_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, vdevs=[VirtualDevice("crypto_snow3g0")], @@ -629,12 +586,9 @@ def zuc_vdev(self) -> None: * Create a cryptodev instance with crypto_zuc and supplied buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "zuc_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, vdevs=[VirtualDevice("crypto_zuc0")], @@ -666,12 +620,9 @@ def open_ssl_vdev(self) -> None: * Create a cryptodev instance with provided device type and buffer sizes. Verify: * The resulting Gbps is greater than expected_gbps*(1-delta_tolerance). - - Raises: - SkippedTestException: When configuration is not provided. """ if "open_ssl_vdev" not in self.throughput_test_parameters: - raise SkippedTestException("test not configured") + skip("test not configured") app = Cryptodev( ptest=TestType.throughput, vdevs=[VirtualDevice("crypto_openssl0")], diff --git a/dts/tests/TestSuite_dynamic_queue_conf.py b/dts/tests/TestSuite_dynamic_queue_conf.py index 5ac85bee7d..b62efa2b42 100644 --- a/dts/tests/TestSuite_dynamic_queue_conf.py +++ b/dts/tests/TestSuite_dynamic_queue_conf.py @@ -35,11 +35,11 @@ NicCapability, requires_nic_capability, ) +from api.exception import InteractiveCommandExecutionError from api.packet import send_packets from api.test import fail, verify from api.testpmd import TestPmd from api.testpmd.config import PortTopology, SimpleForwardingModes -from framework.exception import InteractiveCommandExecutionError from framework.test_suite import TestSuite, func_test diff --git a/dts/tests/TestSuite_flow_offload.py b/dts/tests/TestSuite_flow_offload.py index be11d09875..5902406a8e 100644 --- a/dts/tests/TestSuite_flow_offload.py +++ b/dts/tests/TestSuite_flow_offload.py @@ -21,15 +21,15 @@ from scapy.packet import Packet, Raw from api.capabilities import NicCapability, requires_nic_capability -from api.packet import send_packet_and_capture -from api.test import fail, log, verify -from api.testpmd import TestPmd -from api.testpmd.types import FlowRule -from framework.exception import ( +from api.exception import ( InteractiveCommandExecutionError, SkippedTestException, TestCaseVerifyError, ) +from api.packet import send_packet_and_capture +from api.test import fail, log, verify +from api.testpmd import TestPmd +from api.testpmd.types import FlowRule from framework.test_suite import TestSuite, func_test diff --git a/dts/tests/TestSuite_mac_filter.py b/dts/tests/TestSuite_mac_filter.py index a7e24b37d5..b44822d31c 100644 --- a/dts/tests/TestSuite_mac_filter.py +++ b/dts/tests/TestSuite_mac_filter.py @@ -23,10 +23,10 @@ NicCapability, requires_nic_capability, ) +from api.exception import InteractiveCommandExecutionError from api.packet import send_packet_and_capture from api.test import fail, verify from api.testpmd import TestPmd -from framework.exception import InteractiveCommandExecutionError from framework.test_suite import TestSuite, func_test diff --git a/dts/tests/TestSuite_rss.py b/dts/tests/TestSuite_rss.py index 2747c8a36c..1af0782ffc 100644 --- a/dts/tests/TestSuite_rss.py +++ b/dts/tests/TestSuite_rss.py @@ -20,6 +20,7 @@ requires_link_topology, requires_nic_capability, ) +from api.exception import InteractiveCommandExecutionError from api.packet import send_packets_and_capture from api.test import verify from api.testpmd import TestPmd @@ -29,7 +30,6 @@ RSSOffloadTypesFlag, TestPmdVerbosePacket, ) -from framework.exception import InteractiveCommandExecutionError from framework.test_suite import BaseConfig, TestSuite, func_test from framework.utils import StrEnum diff --git a/dts/tests/TestSuite_rx_split.py b/dts/tests/TestSuite_rx_split.py index 5117a569e2..470e48d0d3 100644 --- a/dts/tests/TestSuite_rx_split.py +++ b/dts/tests/TestSuite_rx_split.py @@ -18,12 +18,12 @@ NicCapability, requires_nic_capability, ) +from api.exception import InteractiveCommandExecutionError from api.packet import adjust_addresses, send_packet_and_capture from api.test import fail, verify from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import RxOffloadCapability, TxOffloadCapability -from framework.exception import InteractiveCommandExecutionError from framework.test_suite import TestSuite, func_test PAYLOAD = bytes(range(256)) -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* Re: [PATCH v7 1/7] dts: move exception module from framework to API 2026-08-07 16:16 ` [PATCH v7 1/7] dts: move exception module from framework to API Andrew Bailey @ 2026-08-20 13:48 ` Luca Vizzarro 0 siblings, 0 replies; 47+ messages in thread From: Luca Vizzarro @ 2026-08-20 13:48 UTC (permalink / raw) To: Andrew Bailey, dev, patrickrobb1997; +Cc: knimoji, lylavoie, dladd, Dean Marx Hi Andrew, This is mostly ok, no big objections as exceptions are mostly definitions. Luca ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v7 2/7] dts: move utils from framework to API 2026-08-07 16:16 ` [PATCH v7 0/7] dts: remove imports from framework in test suites Andrew Bailey 2026-08-07 16:16 ` [PATCH v7 1/7] dts: move exception module from framework to API Andrew Bailey @ 2026-08-07 16:16 ` Andrew Bailey 2026-08-20 13:50 ` Luca Vizzarro 2026-08-07 16:16 ` [PATCH v7 3/7] dts: move context " Andrew Bailey ` (5 subsequent siblings) 7 siblings, 1 reply; 47+ messages in thread From: Andrew Bailey @ 2026-08-07 16:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx The utils module is used to generate a set of random packets in certain test suites. Move this to the API. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- doc/api/dts/{framework.utils.rst => api.utils.rst} | 2 +- doc/api/dts/index.rst | 2 +- dts/api/cryptodev/config.py | 2 +- dts/api/packet.py | 2 +- dts/api/testpmd/config.py | 2 +- dts/api/testpmd/types.py | 2 +- dts/{framework => api}/utils.py | 0 dts/framework/config/node.py | 2 +- dts/framework/config/test_run.py | 2 +- dts/framework/remote_session/dpdk.py | 2 +- dts/framework/test_suite.py | 2 +- dts/framework/testbed_model/cpu.py | 2 +- dts/framework/testbed_model/linux_session.py | 2 +- dts/framework/testbed_model/os_session.py | 2 +- dts/framework/testbed_model/posix_session.py | 4 ++-- .../traffic_generator/capturing_traffic_generator.py | 2 +- .../testbed_model/traffic_generator/traffic_generator.py | 2 +- dts/framework/testbed_model/traffic_generator/trex.py | 2 +- dts/tests/TestSuite_l2fwd.py | 2 +- dts/tests/TestSuite_rss.py | 2 +- dts/tests/TestSuite_smoke_tests.py | 2 +- dts/tests/TestSuite_softnic.py | 2 +- 22 files changed, 22 insertions(+), 22 deletions(-) rename doc/api/dts/{framework.utils.rst => api.utils.rst} (80%) rename dts/{framework => api}/utils.py (100%) diff --git a/doc/api/dts/framework.utils.rst b/doc/api/dts/api.utils.rst similarity index 80% rename from doc/api/dts/framework.utils.rst rename to doc/api/dts/api.utils.rst index cc06d4c3c3..0b4baff1b5 100644 --- a/doc/api/dts/framework.utils.rst +++ b/doc/api/dts/api.utils.rst @@ -3,6 +3,6 @@ utils - Various Utilities ========================= -.. automodule:: framework.utils +.. automodule:: api.utils :members: :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index 01f630e7cd..783270f6e9 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -35,7 +35,7 @@ Modules framework.context framework.logger framework.parser - framework.utils + api.utils api.exception diff --git a/dts/api/cryptodev/config.py b/dts/api/cryptodev/config.py index 69ff7aa59a..a88e70d45c 100644 --- a/dts/api/cryptodev/config.py +++ b/dts/api/cryptodev/config.py @@ -6,9 +6,9 @@ from enum import auto from typing import Literal +from api.utils import StrEnum from framework.params import Params, Switch from framework.params.eal import EalParams -from framework.utils import StrEnum Silent = Literal[""] diff --git a/dts/api/packet.py b/dts/api/packet.py index eaecf205f7..98f995deb5 100644 --- a/dts/api/packet.py +++ b/dts/api/packet.py @@ -29,6 +29,7 @@ from api.exception import InternalError from api.test import fail, log_debug +from api.utils import get_packet_summaries from framework.context import get_ctx from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( PacketFilteringConfig, @@ -36,7 +37,6 @@ from framework.testbed_model.traffic_generator.performance_traffic_generator import ( PerformanceTrafficStats, ) -from framework.utils import get_packet_summaries def send_packet_and_capture( diff --git a/dts/api/testpmd/config.py b/dts/api/testpmd/config.py index f0581843ca..3850a4eb8a 100644 --- a/dts/api/testpmd/config.py +++ b/dts/api/testpmd/config.py @@ -13,6 +13,7 @@ from pathlib import PurePath from typing import Literal, NamedTuple +from api.utils import StrEnum from framework.params import ( Params, Switch, @@ -25,7 +26,6 @@ str_from_flag_value, ) from framework.params.eal import EalParams -from framework.utils import StrEnum from .types import RxOffloadCapability, TxOffloadCapability diff --git a/dts/api/testpmd/types.py b/dts/api/testpmd/types.py index bca40d6f34..7f8f449941 100644 --- a/dts/api/testpmd/types.py +++ b/dts/api/testpmd/types.py @@ -15,8 +15,8 @@ from typing_extensions import Self +from api.utils import REGEX_FOR_MAC_ADDRESS, StrEnum from framework.parser import ParserFn, TextParser -from framework.utils import REGEX_FOR_MAC_ADDRESS, StrEnum RxTxLiteralSwitch = Literal["rx", "tx"] diff --git a/dts/framework/utils.py b/dts/api/utils.py similarity index 100% rename from dts/framework/utils.py rename to dts/api/utils.py diff --git a/dts/framework/config/node.py b/dts/framework/config/node.py index 792290f11f..28f23389a7 100644 --- a/dts/framework/config/node.py +++ b/dts/framework/config/node.py @@ -14,7 +14,7 @@ from pydantic import Field, model_validator from typing_extensions import Self -from framework.utils import REGEX_FOR_IDENTIFIER, REGEX_FOR_PCI_ADDRESS, StrEnum +from api.utils import REGEX_FOR_IDENTIFIER, REGEX_FOR_PCI_ADDRESS, StrEnum from .common import FrozenModel diff --git a/dts/framework/config/test_run.py b/dts/framework/config/test_run.py index 9aa0938d4e..b87c7b2d19 100644 --- a/dts/framework/config/test_run.py +++ b/dts/framework/config/test_run.py @@ -28,7 +28,7 @@ from typing_extensions import TYPE_CHECKING, Self from api.exception import InternalError -from framework.utils import REGEX_FOR_PORT_LINK, StrEnum +from api.utils import REGEX_FOR_PORT_LINK, StrEnum from .common import FrozenModel, load_fields_from_settings diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index 0618855fc5..ba91c88d11 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -15,6 +15,7 @@ from api.capabilities import LinkTopology from api.exception import ConfigurationError, RemoteFileNotFoundError +from api.utils import MesonArgs, TarCompressionFormat from framework.config.test_run import ( DPDKBuildConfiguration, DPDKBuildOptionsConfiguration, @@ -34,7 +35,6 @@ from framework.testbed_model.node import Node from framework.testbed_model.os_session import OSSession from framework.testbed_model.virtual_device import VirtualDevice -from framework.utils import MesonArgs, TarCompressionFormat @dataclass(slots=True, frozen=True) diff --git a/dts/framework/test_suite.py b/dts/framework/test_suite.py index e06fdd28b9..426c98fdf6 100644 --- a/dts/framework/test_suite.py +++ b/dts/framework/test_suite.py @@ -30,12 +30,12 @@ from typing_extensions import Self from api.exception import ConfigurationError, InternalError +from api.utils import to_pascal_case from framework.config.common import FrozenModel from framework.testbed_model.capability import TestProtocol from framework.testbed_model.topology import Topology from .logger import DTSLogger, get_dts_logger -from .utils import to_pascal_case if TYPE_CHECKING: from framework.context import Context diff --git a/dts/framework/testbed_model/cpu.py b/dts/framework/testbed_model/cpu.py index a9471709dd..68e9c7dffb 100644 --- a/dts/framework/testbed_model/cpu.py +++ b/dts/framework/testbed_model/cpu.py @@ -24,7 +24,7 @@ from dataclasses import dataclass from enum import auto, unique -from framework.utils import StrEnum, expand_range +from api.utils import StrEnum, expand_range @unique diff --git a/dts/framework/testbed_model/linux_session.py b/dts/framework/testbed_model/linux_session.py index 4495ae35cf..26c53f069c 100644 --- a/dts/framework/testbed_model/linux_session.py +++ b/dts/framework/testbed_model/linux_session.py @@ -23,8 +23,8 @@ InternalError, RemoteCommandExecutionError, ) +from api.utils import expand_range from framework.testbed_model.port import PortInfo -from framework.utils import expand_range from .cpu import LogicalCore from .port import Port diff --git a/dts/framework/testbed_model/os_session.py b/dts/framework/testbed_model/os_session.py index f88427a53d..08122874e6 100644 --- a/dts/framework/testbed_model/os_session.py +++ b/dts/framework/testbed_model/os_session.py @@ -29,12 +29,12 @@ from enum import Flag, auto from pathlib import Path, PurePath, PurePosixPath +from api.utils import MesonArgs, TarCompressionFormat from framework.config.node import NodeConfiguration from framework.logger import DTSLogger from framework.remote_session.interactive_remote_session import InteractiveRemoteSession from framework.remote_session.remote_session import CommandResult, RemoteSession from framework.settings import SETTINGS -from framework.utils import MesonArgs, TarCompressionFormat from .cpu import Architecture, LogicalCore from .port import Port, PortInfo diff --git a/dts/framework/testbed_model/posix_session.py b/dts/framework/testbed_model/posix_session.py index db2c3c0c40..61c634dad1 100644 --- a/dts/framework/testbed_model/posix_session.py +++ b/dts/framework/testbed_model/posix_session.py @@ -17,14 +17,14 @@ from pathlib import Path, PurePath, PurePosixPath from api.exception import DPDKBuildError, RemoteCommandExecutionError -from framework.settings import SETTINGS -from framework.utils import ( +from api.utils import ( MesonArgs, TarCompressionFormat, convert_to_list_of_string, create_tarball, extract_tarball, ) +from framework.settings import SETTINGS from .cpu import Architecture from .os_session import FilePermissions, OSSession, OSSessionInfo diff --git a/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py b/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py index 7655751d7e..2804d64990 100644 --- a/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py +++ b/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py @@ -17,8 +17,8 @@ from scapy.packet import Packet from api.artifact import Artifact +from api.utils import get_packet_summaries from framework.testbed_model.port import Port -from framework.utils import get_packet_summaries from .traffic_generator import TrafficGenerator diff --git a/dts/framework/testbed_model/traffic_generator/traffic_generator.py b/dts/framework/testbed_model/traffic_generator/traffic_generator.py index cdda5a7c08..fedce77fdf 100644 --- a/dts/framework/testbed_model/traffic_generator/traffic_generator.py +++ b/dts/framework/testbed_model/traffic_generator/traffic_generator.py @@ -25,7 +25,7 @@ class TrafficGenerator(ABC): Exposes the common public methods of all traffic generators and defines private methods that must implement the traffic generation logic in subclasses. This class also extends from - :class:`framework.utils.MultiInheritanceBaseClass` to allow subclasses the ability to inherit + :class:`api.utils.MultiInheritanceBaseClass` to allow subclasses the ability to inherit from multiple classes to fulfil the traffic generating functionality without breaking single inheritance. """ diff --git a/dts/framework/testbed_model/traffic_generator/trex.py b/dts/framework/testbed_model/traffic_generator/trex.py index 2c3beebc59..7fd6234d27 100644 --- a/dts/framework/testbed_model/traffic_generator/trex.py +++ b/dts/framework/testbed_model/traffic_generator/trex.py @@ -12,6 +12,7 @@ from scapy.packet import Packet from api.exception import SSHTimeoutError +from api.utils import StrEnum from framework.config.node import OS, NodeConfiguration from framework.config.test_run import TrexTrafficGeneratorConfig from framework.parser import TextParser @@ -24,7 +25,6 @@ PerformanceTrafficGenerator, PerformanceTrafficStats, ) -from framework.utils import StrEnum @dataclass(slots=True) diff --git a/dts/tests/TestSuite_l2fwd.py b/dts/tests/TestSuite_l2fwd.py index 596b892730..1e99b82b8c 100644 --- a/dts/tests/TestSuite_l2fwd.py +++ b/dts/tests/TestSuite_l2fwd.py @@ -20,10 +20,10 @@ ) from api.testpmd import TestPmd from api.testpmd.config import EthPeer, SimpleForwardingModes +from api.utils import generate_random_packets from framework.context import filter_cores from framework.test_suite import TestSuite, func_test from framework.testbed_model.cpu import LogicalCoreCount -from framework.utils import generate_random_packets @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_rss.py b/dts/tests/TestSuite_rss.py index 1af0782ffc..1e60bdba07 100644 --- a/dts/tests/TestSuite_rss.py +++ b/dts/tests/TestSuite_rss.py @@ -30,8 +30,8 @@ RSSOffloadTypesFlag, TestPmdVerbosePacket, ) +from api.utils import StrEnum from framework.test_suite import BaseConfig, TestSuite, func_test -from framework.utils import StrEnum class Config(BaseConfig): diff --git a/dts/tests/TestSuite_smoke_tests.py b/dts/tests/TestSuite_smoke_tests.py index 271ad4301c..fce83604a6 100644 --- a/dts/tests/TestSuite_smoke_tests.py +++ b/dts/tests/TestSuite_smoke_tests.py @@ -20,11 +20,11 @@ ) from api.test import verify from api.testpmd import TestPmd +from api.utils import REGEX_FOR_PCI_ADDRESS from framework.config.node import PortConfig from framework.settings import SETTINGS from framework.test_suite import TestSuite, func_test from framework.testbed_model.linux_session import LinuxSession -from framework.utils import REGEX_FOR_PCI_ADDRESS @requires_link_topology(LinkTopology.NO_LINK) diff --git a/dts/tests/TestSuite_softnic.py b/dts/tests/TestSuite_softnic.py index fa91f7ee2f..c57a12c932 100644 --- a/dts/tests/TestSuite_softnic.py +++ b/dts/tests/TestSuite_softnic.py @@ -20,9 +20,9 @@ ) from api.testpmd import TestPmd from api.testpmd.config import EthPeer +from api.utils import generate_random_packets from framework.test_suite import TestSuite, func_test from framework.testbed_model.virtual_device import VirtualDevice -from framework.utils import generate_random_packets @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* Re: [PATCH v7 2/7] dts: move utils from framework to API 2026-08-07 16:16 ` [PATCH v7 2/7] dts: move utils " Andrew Bailey @ 2026-08-20 13:50 ` Luca Vizzarro 0 siblings, 0 replies; 47+ messages in thread From: Luca Vizzarro @ 2026-08-20 13:50 UTC (permalink / raw) To: Andrew Bailey, dev, patrickrobb1997; +Cc: knimoji, lylavoie, dladd, Dean Marx This is a bit trickier as the utils do contain a lot of implementations. The idea behind the API package is to just provide interfaces and not actual implementations. I am not too fussed with just porting all of this over just because it's misc utils really... but it's not my favourite solution either. Can't really think of one either unfortunately ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v7 3/7] dts: move context from framework to API 2026-08-07 16:16 ` [PATCH v7 0/7] dts: remove imports from framework in test suites Andrew Bailey 2026-08-07 16:16 ` [PATCH v7 1/7] dts: move exception module from framework to API Andrew Bailey 2026-08-07 16:16 ` [PATCH v7 2/7] dts: move utils " Andrew Bailey @ 2026-08-07 16:16 ` Andrew Bailey 2026-08-20 13:51 ` Luca Vizzarro 2026-08-07 16:16 ` [PATCH v7 4/7] dts: move testbed model " Andrew Bailey ` (4 subsequent siblings) 7 siblings, 1 reply; 47+ messages in thread From: Andrew Bailey @ 2026-08-07 16:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx A couple test suites import and get the run context during execution. Move this to the API. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- .../dts/{framework.context.rst => api.context.rst} | 2 +- doc/api/dts/index.rst | 2 +- dts/api/artifact.py | 2 +- dts/{framework => api}/context.py | 0 dts/api/cryptodev/__init__.py | 2 +- dts/api/packet.py | 4 ++-- dts/api/test.py | 2 +- dts/api/testpmd/__init__.py | 2 +- dts/framework/remote_session/blocking_app.py | 2 +- dts/framework/remote_session/dpdk.py | 2 +- dts/framework/remote_session/dpdk_shell.py | 2 +- dts/framework/remote_session/interactive_shell.py | 2 +- dts/framework/test_run.py | 2 +- dts/framework/test_suite.py | 4 ++-- dts/framework/testbed_model/node.py | 2 +- dts/framework/testbed_model/topology.py | 14 +++++++------- dts/tests/TestSuite_cryptodev_latency.py | 2 +- dts/tests/TestSuite_cryptodev_throughput.py | 2 +- dts/tests/TestSuite_l2fwd.py | 2 +- 19 files changed, 26 insertions(+), 26 deletions(-) rename doc/api/dts/{framework.context.rst => api.context.rst} (80%) rename dts/{framework => api}/context.py (100%) diff --git a/doc/api/dts/framework.context.rst b/doc/api/dts/api.context.rst similarity index 80% rename from doc/api/dts/framework.context.rst rename to doc/api/dts/api.context.rst index 925c160360..65b4ab9a47 100644 --- a/doc/api/dts/framework.context.rst +++ b/doc/api/dts/api.context.rst @@ -3,6 +3,6 @@ context - DTS execution context =============================== -.. automodule:: framework.context +.. automodule:: api.context :members: :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index 783270f6e9..98269d6e80 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -32,7 +32,7 @@ Modules framework.test_suite framework.test_result framework.settings - framework.context + api.context framework.logger framework.parser api.utils diff --git a/dts/api/artifact.py b/dts/api/artifact.py index 7d04c7ab49..f3dd07de56 100644 --- a/dts/api/artifact.py +++ b/dts/api/artifact.py @@ -86,7 +86,7 @@ def make_file_path( path /= custom_path else: - from framework.context import get_ctx + from api.context import get_ctx try: ctx = get_ctx() diff --git a/dts/framework/context.py b/dts/api/context.py similarity index 100% rename from dts/framework/context.py rename to dts/api/context.py diff --git a/dts/api/cryptodev/__init__.py b/dts/api/cryptodev/__init__.py index 335b811620..198607696f 100644 --- a/dts/api/cryptodev/__init__.py +++ b/dts/api/cryptodev/__init__.py @@ -14,6 +14,7 @@ from typing_extensions import Unpack +from api.context import get_ctx from api.cryptodev.config import CryptoPmdParams, TestType from api.cryptodev.types import ( CryptodevResults, @@ -23,7 +24,6 @@ VerifyResults, ) from api.exception import RemoteCommandExecutionError, SkippedTestException -from framework.context import get_ctx from framework.remote_session.dpdk_shell import compute_eal_params if TYPE_CHECKING: diff --git a/dts/api/packet.py b/dts/api/packet.py index 98f995deb5..dda3087df4 100644 --- a/dts/api/packet.py +++ b/dts/api/packet.py @@ -27,10 +27,10 @@ from scapy.layers.l2 import Ether from scapy.packet import Packet, Padding, raw +from api.context import get_ctx from api.exception import InternalError from api.test import fail, log_debug from api.utils import get_packet_summaries -from framework.context import get_ctx from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( PacketFilteringConfig, ) @@ -82,7 +82,7 @@ def send_packets_and_capture( Returns: A list of received packets. """ - from framework.context import get_ctx + from api.context import get_ctx from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( CapturingTrafficGenerator, ) diff --git a/dts/api/test.py b/dts/api/test.py index 29d6842111..b6caf5c1ae 100644 --- a/dts/api/test.py +++ b/dts/api/test.py @@ -11,8 +11,8 @@ from api.artifact import Artifact from api.capabilities import LinkTopology +from api.context import get_ctx from api.exception import InternalError, SkippedTestException, TestCaseVerifyError -from framework.context import get_ctx from framework.logger import DTSLogger diff --git a/dts/api/testpmd/__init__.py b/dts/api/testpmd/__init__.py index fef7430cb8..ce41408eb6 100644 --- a/dts/api/testpmd/__init__.py +++ b/dts/api/testpmd/__init__.py @@ -32,6 +32,7 @@ from typing_extensions import Unpack from api.capabilities import LinkTopology, NicCapability +from api.context import get_ctx from api.exception import InteractiveCommandExecutionError, InternalError from api.testpmd.config import PortTopology, SimpleForwardingModes, TestPmdParams from api.testpmd.types import ( @@ -55,7 +56,6 @@ TxOffloadConfiguration, VLANOffloadFlag, ) -from framework.context import get_ctx from framework.params.types import TestPmdParamsDict from framework.remote_session.dpdk_shell import DPDKShell from framework.remote_session.interactive_shell import only_active diff --git a/dts/framework/remote_session/blocking_app.py b/dts/framework/remote_session/blocking_app.py index c3b02dcc62..07db6dfeb0 100644 --- a/dts/framework/remote_session/blocking_app.py +++ b/dts/framework/remote_session/blocking_app.py @@ -30,7 +30,7 @@ from typing_extensions import Self -from framework.context import get_ctx +from api.context import get_ctx from framework.params import Params from framework.params.eal import EalParams from framework.remote_session.dpdk_shell import compute_eal_params diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index ba91c88d11..ee34eb567d 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -14,6 +14,7 @@ from typing import ClassVar, Final from api.capabilities import LinkTopology +from api.context import get_ctx from api.exception import ConfigurationError, RemoteFileNotFoundError from api.utils import MesonArgs, TarCompressionFormat from framework.config.test_run import ( @@ -27,7 +28,6 @@ RemoteDPDKTarballLocation, RemoteDPDKTreeLocation, ) -from framework.context import get_ctx from framework.logger import DTSLogger, get_dts_logger from framework.params.eal import EalParams from framework.remote_session.remote_session import CommandResult diff --git a/dts/framework/remote_session/dpdk_shell.py b/dts/framework/remote_session/dpdk_shell.py index 269c2cada4..a8f169787c 100644 --- a/dts/framework/remote_session/dpdk_shell.py +++ b/dts/framework/remote_session/dpdk_shell.py @@ -10,7 +10,7 @@ from abc import ABC, abstractmethod from pathlib import PurePath -from framework.context import get_ctx +from api.context import get_ctx from framework.params.eal import EalParams from framework.remote_session.interactive_shell import ( InteractiveShell, diff --git a/dts/framework/remote_session/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index 367a01714d..362bc2a352 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -29,12 +29,12 @@ from paramiko import Channel, channel from typing_extensions import Self +from api.context import get_ctx from api.exception import ( InteractiveCommandExecutionError, InteractiveSSHSessionDeadError, InteractiveSSHTimeoutError, ) -from framework.context import get_ctx from framework.logger import DTSLogger, get_dts_logger from framework.params import Params from framework.settings import SETTINGS diff --git a/dts/framework/test_run.py b/dts/framework/test_run.py index 75d82c1104..8b9ae4a49a 100644 --- a/dts/framework/test_run.py +++ b/dts/framework/test_run.py @@ -108,9 +108,9 @@ from typing import ClassVar, Protocol, Union from api.capabilities import LinkTopology +from api.context import Context, init_ctx from api.exception import InternalError, SkippedTestException, TestCaseVerifyError from framework.config.test_run import TestRunConfiguration -from framework.context import Context, init_ctx from framework.logger import DTSLogger, get_dts_logger from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment from framework.settings import SETTINGS diff --git a/dts/framework/test_suite.py b/dts/framework/test_suite.py index 426c98fdf6..6066f7a77a 100644 --- a/dts/framework/test_suite.py +++ b/dts/framework/test_suite.py @@ -38,7 +38,7 @@ from .logger import DTSLogger, get_dts_logger if TYPE_CHECKING: - from framework.context import Context + from api.context import Context class BaseConfig(FrozenModel): @@ -92,7 +92,7 @@ def __init__(self, config: BaseConfig) -> None: Args: config: The test suite configuration. """ - from framework.context import get_ctx + from api.context import get_ctx self.config = config self._ctx = get_ctx() diff --git a/dts/framework/testbed_model/node.py b/dts/framework/testbed_model/node.py index 4f42bf6aeb..40dd7f0666 100644 --- a/dts/framework/testbed_model/node.py +++ b/dts/framework/testbed_model/node.py @@ -242,7 +242,7 @@ def get_node(node_identifier: NodeIdentifier) -> Node | None: if node_identifier == "local": return None - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() if node_identifier == "sut": diff --git a/dts/framework/testbed_model/topology.py b/dts/framework/testbed_model/topology.py index 002faf0b7f..6b8c5edee5 100644 --- a/dts/framework/testbed_model/topology.py +++ b/dts/framework/testbed_model/topology.py @@ -98,7 +98,7 @@ def node_and_ports_from_id(self, node_identifier: NodeIdentifier) -> tuple[Node, Raises: InternalError: If the given `node_identifier` is invalid. """ - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() match node_identifier: @@ -188,7 +188,7 @@ def instantiate_crypto_ports(self) -> None: Raises: InternalError: If crypto virtual functions could not be created on a port. """ - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() for port in ctx.sut_node.cryptodevs: @@ -214,7 +214,7 @@ def instantiate_vf_ports(self) -> None: Raises: InternalError: If virtual function creation fails. """ - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() @@ -243,7 +243,7 @@ def instantiate_vf_ports(self) -> None: def delete_vf_ports(self) -> None: """Delete virtual functions from the SUT node during test run teardown.""" - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() @@ -254,7 +254,7 @@ def delete_vf_ports(self) -> None: def delete_crypto_vf_ports(self) -> None: """Delete crypto virtual functions from the SUT node during test run teardown.""" - from framework.context import get_ctx + from api.context import get_ctx ctx = get_ctx() @@ -267,7 +267,7 @@ def bind_cryptodevs(self, driver: DriverKind): Args: driver: The driver to bind the crypto functions """ - from framework.context import get_ctx + from api.context import get_ctx self._bind_ports_to_drivers(get_ctx().sut_node, self.crypto_vf_ports, driver) @@ -326,7 +326,7 @@ def _prepare_devbind_script(self) -> None: Raises: InternalError: If dpdk-devbind.py could not be found. """ - from framework.context import get_ctx + from api.context import get_ctx local_script_path = Path("..", "usertools", "dpdk-devbind.py").resolve() valid_script_path = local_script_path.exists() diff --git a/dts/tests/TestSuite_cryptodev_latency.py b/dts/tests/TestSuite_cryptodev_latency.py index 4e7d814faa..ed6423eb26 100644 --- a/dts/tests/TestSuite_cryptodev_latency.py +++ b/dts/tests/TestSuite_cryptodev_latency.py @@ -13,6 +13,7 @@ LinkTopology, requires_link_topology, ) +from api.context import get_ctx from api.cryptodev import Cryptodev from api.cryptodev.config import ( AeadAlgName, @@ -30,7 +31,6 @@ CryptodevResults, ) from api.test import skip, verify -from framework.context import get_ctx from framework.test_suite import BaseConfig, TestSuite, crypto_test from framework.testbed_model.virtual_device import VirtualDevice diff --git a/dts/tests/TestSuite_cryptodev_throughput.py b/dts/tests/TestSuite_cryptodev_throughput.py index 53682f35fa..d69714e1fa 100644 --- a/dts/tests/TestSuite_cryptodev_throughput.py +++ b/dts/tests/TestSuite_cryptodev_throughput.py @@ -13,6 +13,7 @@ LinkTopology, requires_link_topology, ) +from api.context import get_ctx from api.cryptodev import Cryptodev from api.cryptodev.config import ( AeadAlgName, @@ -30,7 +31,6 @@ CryptodevResults, ) from api.test import skip, verify -from framework.context import get_ctx from framework.test_suite import BaseConfig, TestSuite, crypto_test from framework.testbed_model.virtual_device import VirtualDevice diff --git a/dts/tests/TestSuite_l2fwd.py b/dts/tests/TestSuite_l2fwd.py index 1e99b82b8c..574842e2e4 100644 --- a/dts/tests/TestSuite_l2fwd.py +++ b/dts/tests/TestSuite_l2fwd.py @@ -13,6 +13,7 @@ requires_link_topology, requires_nic_capability, ) +from api.context import filter_cores from api.packet import ( get_expected_packets, match_all_packets, @@ -21,7 +22,6 @@ from api.testpmd import TestPmd from api.testpmd.config import EthPeer, SimpleForwardingModes from api.utils import generate_random_packets -from framework.context import filter_cores from framework.test_suite import TestSuite, func_test from framework.testbed_model.cpu import LogicalCoreCount -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* Re: [PATCH v7 3/7] dts: move context from framework to API 2026-08-07 16:16 ` [PATCH v7 3/7] dts: move context " Andrew Bailey @ 2026-08-20 13:51 ` Luca Vizzarro 0 siblings, 0 replies; 47+ messages in thread From: Luca Vizzarro @ 2026-08-20 13:51 UTC (permalink / raw) To: Andrew Bailey, dev, patrickrobb1997; +Cc: knimoji, lylavoie, dladd, Dean Marx This is mostly ok as context is mostly a definition. The problem here is that this also contains the context state variable which should not be exposed publicly and should not reside in the api package. ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v7 4/7] dts: move testbed model from framework to API 2026-08-07 16:16 ` [PATCH v7 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (2 preceding siblings ...) 2026-08-07 16:16 ` [PATCH v7 3/7] dts: move context " Andrew Bailey @ 2026-08-07 16:16 ` Andrew Bailey 2026-08-20 13:53 ` Luca Vizzarro 2026-08-07 16:16 ` [PATCH v7 5/7] dts: move test suite module " Andrew Bailey ` (3 subsequent siblings) 7 siblings, 1 reply; 47+ messages in thread From: Andrew Bailey @ 2026-08-07 16:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx Multiple test suites import modules from testbed model in the framework. Move this directory to the API. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- ...y.rst => api.testbed_model.capability.rst} | 2 +- ...odel.cpu.rst => api.testbed_model.cpu.rst} | 2 +- ...st => api.testbed_model.linux_session.rst} | 2 +- ...el.node.rst => api.testbed_model.node.rst} | 2 +- ...n.rst => api.testbed_model.os_session.rst} | 2 +- ...el.port.rst => api.testbed_model.port.rst} | 2 +- ...st => api.testbed_model.posix_session.rst} | 2 +- doc/api/dts/api.testbed_model.rst | 28 +++++++++++++++++++ ...ogy.rst => api.testbed_model.topology.rst} | 2 +- ...generator.capturing_traffic_generator.rst} | 2 +- .../api.testbed_model.traffic_generator.rst | 16 +++++++++++ ...testbed_model.traffic_generator.scapy.rst} | 2 +- ...l.traffic_generator.traffic_generator.rst} | 2 +- ...t => api.testbed_model.virtual_device.rst} | 2 +- doc/api/dts/framework.testbed_model.rst | 28 ------------------- ...mework.testbed_model.traffic_generator.rst | 16 ----------- doc/api/dts/index.rst | 2 +- dts/api/artifact.py | 2 +- dts/api/capabilities.py | 8 +++--- dts/api/context.py | 10 +++---- dts/api/packet.py | 10 +++---- .../testbed_model/__init__.py | 0 .../testbed_model/capability.py | 10 +++---- dts/{framework => api}/testbed_model/cpu.py | 2 +- .../testbed_model/linux_session.py | 2 +- dts/{framework => api}/testbed_model/node.py | 0 .../testbed_model/os_session.py | 6 ++-- dts/{framework => api}/testbed_model/port.py | 0 .../testbed_model/posix_session.py | 0 .../testbed_model/topology.py | 4 +-- .../traffic_generator/__init__.py | 2 +- .../capturing_traffic_generator.py | 2 +- .../performance_traffic_generator.py | 0 .../testbed_model/traffic_generator/scapy.py | 12 ++++---- .../traffic_generator/traffic_generator.py | 6 ++-- .../testbed_model/traffic_generator/trex.py | 14 +++++----- .../testbed_model/virtual_device.py | 0 dts/framework/params/eal.py | 6 ++-- dts/framework/params/types.py | 6 ++-- dts/framework/remote_session/blocking_app.py | 2 +- dts/framework/remote_session/dpdk.py | 8 +++--- dts/framework/remote_session/dpdk_shell.py | 2 +- .../remote_session/interactive_shell.py | 2 +- dts/framework/runner.py | 2 +- dts/framework/test_result.py | 2 +- dts/framework/test_run.py | 16 +++++------ dts/framework/test_suite.py | 4 +-- dts/tests/TestSuite_blocklist.py | 2 +- dts/tests/TestSuite_cryptodev_latency.py | 2 +- dts/tests/TestSuite_cryptodev_throughput.py | 2 +- dts/tests/TestSuite_l2fwd.py | 2 +- dts/tests/TestSuite_packet_capture.py | 8 +++--- dts/tests/TestSuite_smoke_tests.py | 2 +- dts/tests/TestSuite_softnic.py | 2 +- dts/tests/TestSuite_virtio_forward.py | 6 ++-- 55 files changed, 140 insertions(+), 140 deletions(-) rename doc/api/dts/{framework.testbed_model.capability.rst => api.testbed_model.capability.rst} (74%) rename doc/api/dts/{framework.testbed_model.cpu.rst => api.testbed_model.cpu.rst} (78%) rename doc/api/dts/{framework.testbed_model.linux_session.rst => api.testbed_model.linux_session.rst} (74%) rename doc/api/dts/{framework.testbed_model.node.rst => api.testbed_model.node.rst} (71%) rename doc/api/dts/{framework.testbed_model.os_session.rst => api.testbed_model.os_session.rst} (76%) rename doc/api/dts/{framework.testbed_model.port.rst => api.testbed_model.port.rst} (77%) rename doc/api/dts/{framework.testbed_model.posix_session.rst => api.testbed_model.posix_session.rst} (74%) create mode 100644 doc/api/dts/api.testbed_model.rst rename doc/api/dts/{framework.testbed_model.topology.rst => api.testbed_model.topology.rst} (73%) rename doc/api/dts/{framework.testbed_model.traffic_generator.capturing_traffic_generator.rst => api.testbed_model.traffic_generator.capturing_traffic_generator.rst} (68%) create mode 100644 doc/api/dts/api.testbed_model.traffic_generator.rst rename doc/api/dts/{framework.testbed_model.traffic_generator.scapy.rst => api.testbed_model.traffic_generator.scapy.rst} (70%) rename doc/api/dts/{framework.testbed_model.traffic_generator.traffic_generator.rst => api.testbed_model.traffic_generator.traffic_generator.rst} (65%) rename doc/api/dts/{framework.testbed_model.virtual_device.rst => api.testbed_model.virtual_device.rst} (72%) delete mode 100644 doc/api/dts/framework.testbed_model.rst delete mode 100644 doc/api/dts/framework.testbed_model.traffic_generator.rst rename dts/{framework => api}/testbed_model/__init__.py (100%) rename dts/{framework => api}/testbed_model/capability.py (99%) rename dts/{framework => api}/testbed_model/cpu.py (99%) rename dts/{framework => api}/testbed_model/linux_session.py (99%) rename dts/{framework => api}/testbed_model/node.py (100%) rename dts/{framework => api}/testbed_model/os_session.py (99%) rename dts/{framework => api}/testbed_model/port.py (100%) rename dts/{framework => api}/testbed_model/posix_session.py (100%) rename dts/{framework => api}/testbed_model/topology.py (99%) rename dts/{framework => api}/testbed_model/traffic_generator/__init__.py (97%) rename dts/{framework => api}/testbed_model/traffic_generator/capturing_traffic_generator.py (99%) rename dts/{framework => api}/testbed_model/traffic_generator/performance_traffic_generator.py (100%) rename dts/{framework => api}/testbed_model/traffic_generator/scapy.py (98%) rename dts/{framework => api}/testbed_model/traffic_generator/traffic_generator.py (94%) rename dts/{framework => api}/testbed_model/traffic_generator/trex.py (97%) rename dts/{framework => api}/testbed_model/virtual_device.py (100%) diff --git a/doc/api/dts/framework.testbed_model.capability.rst b/doc/api/dts/api.testbed_model.capability.rst similarity index 74% rename from doc/api/dts/framework.testbed_model.capability.rst rename to doc/api/dts/api.testbed_model.capability.rst index fab91cad83..88e396dddb 100644 --- a/doc/api/dts/framework.testbed_model.capability.rst +++ b/doc/api/dts/api.testbed_model.capability.rst @@ -3,6 +3,6 @@ capability - Testbed Capabilities ================================= -.. automodule:: framework.testbed_model.capability +.. automodule:: api.testbed_model.capability :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.cpu.rst b/doc/api/dts/api.testbed_model.cpu.rst similarity index 78% rename from doc/api/dts/framework.testbed_model.cpu.rst rename to doc/api/dts/api.testbed_model.cpu.rst index 997f2a9795..dbbb29480a 100644 --- a/doc/api/dts/framework.testbed_model.cpu.rst +++ b/doc/api/dts/api.testbed_model.cpu.rst @@ -3,6 +3,6 @@ cpu - CPU Representation and Utilities ====================================== -.. automodule:: framework.testbed_model.cpu +.. automodule:: api.testbed_model.cpu :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.linux_session.rst b/doc/api/dts/api.testbed_model.linux_session.rst similarity index 74% rename from doc/api/dts/framework.testbed_model.linux_session.rst rename to doc/api/dts/api.testbed_model.linux_session.rst index 7567816199..cfe79d8bca 100644 --- a/doc/api/dts/framework.testbed_model.linux_session.rst +++ b/doc/api/dts/api.testbed_model.linux_session.rst @@ -3,6 +3,6 @@ linux\_session - Linux Remote Session ===================================== -.. automodule:: framework.testbed_model.linux_session +.. automodule:: api.testbed_model.linux_session :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.node.rst b/doc/api/dts/api.testbed_model.node.rst similarity index 71% rename from doc/api/dts/framework.testbed_model.node.rst rename to doc/api/dts/api.testbed_model.node.rst index 23c6c46a00..15f522e5f7 100644 --- a/doc/api/dts/framework.testbed_model.node.rst +++ b/doc/api/dts/api.testbed_model.node.rst @@ -3,6 +3,6 @@ node - Base Node ================ -.. automodule:: framework.testbed_model.node +.. automodule:: api.testbed_model.node :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.os_session.rst b/doc/api/dts/api.testbed_model.os_session.rst similarity index 76% rename from doc/api/dts/framework.testbed_model.os_session.rst rename to doc/api/dts/api.testbed_model.os_session.rst index ecfb352311..e7e3f9894f 100644 --- a/doc/api/dts/framework.testbed_model.os_session.rst +++ b/doc/api/dts/api.testbed_model.os_session.rst @@ -3,6 +3,6 @@ os\_session - OS-aware Remote Session ABC ========================================= -.. automodule:: framework.testbed_model.os_session +.. automodule:: api.testbed_model.os_session :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.port.rst b/doc/api/dts/api.testbed_model.port.rst similarity index 77% rename from doc/api/dts/framework.testbed_model.port.rst rename to doc/api/dts/api.testbed_model.port.rst index fdb7ca8a1d..d64501aef0 100644 --- a/doc/api/dts/framework.testbed_model.port.rst +++ b/doc/api/dts/api.testbed_model.port.rst @@ -3,7 +3,7 @@ port - NIC Port Representation ============================== -.. automodule:: framework.testbed_model.port +.. automodule:: api.testbed_model.port :members: :show-inheritance: :noindex: diff --git a/doc/api/dts/framework.testbed_model.posix_session.rst b/doc/api/dts/api.testbed_model.posix_session.rst similarity index 74% rename from doc/api/dts/framework.testbed_model.posix_session.rst rename to doc/api/dts/api.testbed_model.posix_session.rst index e65585fd85..9f0e9ff18d 100644 --- a/doc/api/dts/framework.testbed_model.posix_session.rst +++ b/doc/api/dts/api.testbed_model.posix_session.rst @@ -3,6 +3,6 @@ posix\_session - Posix Remote Session ===================================== -.. automodule:: framework.testbed_model.posix_session +.. automodule:: api.testbed_model.posix_session :members: :show-inheritance: diff --git a/doc/api/dts/api.testbed_model.rst b/doc/api/dts/api.testbed_model.rst new file mode 100644 index 0000000000..5e2e5189b2 --- /dev/null +++ b/doc/api/dts/api.testbed_model.rst @@ -0,0 +1,28 @@ +.. SPDX-License-Identifier: BSD-3-Clause + +testbed\_model - Testbed Modelling Package +========================================== + +.. automodule:: api.testbed_model + :members: + :show-inheritance: + +.. toctree:: + :hidden: + :maxdepth: 2 + + api.testbed_model.traffic_generator + +.. toctree:: + :hidden: + :maxdepth: 1 + + api.testbed_model.os_session + api.testbed_model.linux_session + api.testbed_model.posix_session + api.testbed_model.node + api.testbed_model.capability + api.testbed_model.cpu + api.testbed_model.port + api.testbed_model.topology + api.testbed_model.virtual_device diff --git a/doc/api/dts/framework.testbed_model.topology.rst b/doc/api/dts/api.testbed_model.topology.rst similarity index 73% rename from doc/api/dts/framework.testbed_model.topology.rst rename to doc/api/dts/api.testbed_model.topology.rst index 496f2a895f..bb63fe38dc 100644 --- a/doc/api/dts/framework.testbed_model.topology.rst +++ b/doc/api/dts/api.testbed_model.topology.rst @@ -3,6 +3,6 @@ topology - Testbed Topology =========================== -.. automodule:: framework.testbed_model.topology +.. automodule:: api.testbed_model.topology :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst b/doc/api/dts/api.testbed_model.traffic_generator.capturing_traffic_generator.rst similarity index 68% rename from doc/api/dts/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst rename to doc/api/dts/api.testbed_model.traffic_generator.capturing_traffic_generator.rst index 29fa834042..cfe03201a7 100644 --- a/doc/api/dts/framework.testbed_model.traffic_generator.capturing_traffic_generator.rst +++ b/doc/api/dts/api.testbed_model.traffic_generator.capturing_traffic_generator.rst @@ -3,6 +3,6 @@ capturing\_traffic\_generator - Base Capturing TG ABC ===================================================== -.. automodule:: framework.testbed_model.traffic_generator.capturing_traffic_generator +.. automodule:: api.testbed_model.traffic_generator.capturing_traffic_generator :members: :show-inheritance: diff --git a/doc/api/dts/api.testbed_model.traffic_generator.rst b/doc/api/dts/api.testbed_model.traffic_generator.rst new file mode 100644 index 0000000000..311bdcf6b9 --- /dev/null +++ b/doc/api/dts/api.testbed_model.traffic_generator.rst @@ -0,0 +1,16 @@ +.. SPDX-License-Identifier: BSD-3-Clause + +traffic\_generator Subpackage +============================= + +.. automodule:: api.testbed_model.traffic_generator + :members: + :show-inheritance: + +.. toctree:: + :hidden: + :maxdepth: 1 + + api.testbed_model.traffic_generator.traffic_generator + api.testbed_model.traffic_generator.capturing_traffic_generator + api.testbed_model.traffic_generator.scapy diff --git a/doc/api/dts/framework.testbed_model.traffic_generator.scapy.rst b/doc/api/dts/api.testbed_model.traffic_generator.scapy.rst similarity index 70% rename from doc/api/dts/framework.testbed_model.traffic_generator.scapy.rst rename to doc/api/dts/api.testbed_model.traffic_generator.scapy.rst index df78ac9514..949bb66632 100644 --- a/doc/api/dts/framework.testbed_model.traffic_generator.scapy.rst +++ b/doc/api/dts/api.testbed_model.traffic_generator.scapy.rst @@ -3,6 +3,6 @@ scapy - Capturing Traffic Generator =================================== -.. automodule:: framework.testbed_model.traffic_generator.scapy +.. automodule:: api.testbed_model.traffic_generator.scapy :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.traffic_generator.traffic_generator.rst b/doc/api/dts/api.testbed_model.traffic_generator.traffic_generator.rst similarity index 65% rename from doc/api/dts/framework.testbed_model.traffic_generator.traffic_generator.rst rename to doc/api/dts/api.testbed_model.traffic_generator.traffic_generator.rst index bfec728dee..1045e534b5 100644 --- a/doc/api/dts/framework.testbed_model.traffic_generator.traffic_generator.rst +++ b/doc/api/dts/api.testbed_model.traffic_generator.traffic_generator.rst @@ -3,6 +3,6 @@ traffic\_generator - Base TG ABC ================================ -.. automodule:: framework.testbed_model.traffic_generator.traffic_generator +.. automodule:: api.testbed_model.traffic_generator.traffic_generator :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.virtual_device.rst b/doc/api/dts/api.testbed_model.virtual_device.rst similarity index 72% rename from doc/api/dts/framework.testbed_model.virtual_device.rst rename to doc/api/dts/api.testbed_model.virtual_device.rst index a6b0420e75..97adc895f6 100644 --- a/doc/api/dts/framework.testbed_model.virtual_device.rst +++ b/doc/api/dts/api.testbed_model.virtual_device.rst @@ -3,6 +3,6 @@ virtual\_device - Virtual Devices ================================= -.. automodule:: framework.testbed_model.virtual_device +.. automodule:: api.testbed_model.virtual_device :members: :show-inheritance: diff --git a/doc/api/dts/framework.testbed_model.rst b/doc/api/dts/framework.testbed_model.rst deleted file mode 100644 index f283178f6a..0000000000 --- a/doc/api/dts/framework.testbed_model.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. SPDX-License-Identifier: BSD-3-Clause - -testbed\_model - Testbed Modelling Package -========================================== - -.. automodule:: framework.testbed_model - :members: - :show-inheritance: - -.. toctree:: - :hidden: - :maxdepth: 2 - - framework.testbed_model.traffic_generator - -.. toctree:: - :hidden: - :maxdepth: 1 - - framework.testbed_model.os_session - framework.testbed_model.linux_session - framework.testbed_model.posix_session - framework.testbed_model.node - framework.testbed_model.capability - framework.testbed_model.cpu - framework.testbed_model.port - framework.testbed_model.topology - framework.testbed_model.virtual_device diff --git a/doc/api/dts/framework.testbed_model.traffic_generator.rst b/doc/api/dts/framework.testbed_model.traffic_generator.rst deleted file mode 100644 index 24c250ee3a..0000000000 --- a/doc/api/dts/framework.testbed_model.traffic_generator.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. SPDX-License-Identifier: BSD-3-Clause - -traffic\_generator Subpackage -============================= - -.. automodule:: framework.testbed_model.traffic_generator - :members: - :show-inheritance: - -.. toctree:: - :hidden: - :maxdepth: 1 - - framework.testbed_model.traffic_generator.traffic_generator - framework.testbed_model.traffic_generator.capturing_traffic_generator - framework.testbed_model.traffic_generator.scapy diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index 98269d6e80..f47e4af3f2 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -16,7 +16,7 @@ Packages tests api - framework.testbed_model + api.testbed_model framework.remote_session framework.params framework.config diff --git a/dts/api/artifact.py b/dts/api/artifact.py index f3dd07de56..74a8ac667f 100644 --- a/dts/api/artifact.py +++ b/dts/api/artifact.py @@ -48,9 +48,9 @@ from typing_extensions import Buffer from api.exception import InternalError +from api.testbed_model.node import Node, NodeIdentifier, get_node from framework.logger import DTSLogger, get_dts_logger from framework.settings import SETTINGS -from framework.testbed_model.node import Node, NodeIdentifier, get_node TextMode: TypeAlias = ( Literal["r", "r+", "w", "w+", "a", "a+", "x", "x+"] diff --git a/dts/api/capabilities.py b/dts/api/capabilities.py index b0c1d81d36..8ed832a588 100644 --- a/dts/api/capabilities.py +++ b/dts/api/capabilities.py @@ -23,7 +23,7 @@ .. code:: python from framework.test_suite import TestSuite, func_test - from framework.testbed_model.capability import LinkTopology, requires_link_topology + from api.testbed_model.capability import LinkTopology, requires_link_topology # The whole test suite (each test case within) doesn't require any links. @requires_link_topology(LinkTopology.NO_LINK) @func_test @@ -34,7 +34,7 @@ def hello_world_single_core(self): .. code:: python from framework.test_suite import TestSuite, func_test - from framework.testbed_model.capability import NicCapability, requires_nic_capability + from api.testbed_model.capability import NicCapability, requires_nic_capability class TestPmdBufferScatter(TestSuite): # only the test case requires the SCATTERED_RX_ENABLED capability # other test cases may not require it @@ -237,7 +237,7 @@ def requires_link_topology( Returns: The decorated test case or test suite. """ - from framework.testbed_model.capability import TopologyCapability + from api.testbed_model.capability import TopologyCapability def add_required_topology( test_case_or_suite: type["TestProtocol"], @@ -260,7 +260,7 @@ def requires_nic_capability( Returns: The decorated test case or test suite. """ - from framework.testbed_model.capability import DecoratedNicCapability + from api.testbed_model.capability import DecoratedNicCapability def add_required_capability( test_case_or_suite: type["TestProtocol"], diff --git a/dts/api/context.py b/dts/api/context.py index 709b99421e..57e14ef598 100644 --- a/dts/api/context.py +++ b/dts/api/context.py @@ -9,17 +9,17 @@ from typing import TYPE_CHECKING, Any, Optional, ParamSpec, Union from api.exception import InternalError +from api.testbed_model.cpu import LogicalCoreCount, LogicalCoreList +from api.testbed_model.node import Node +from api.testbed_model.topology import Topology from framework.remote_session.shell_pool import ShellPool from framework.settings import SETTINGS -from framework.testbed_model.cpu import LogicalCoreCount, LogicalCoreList -from framework.testbed_model.node import Node -from framework.testbed_model.topology import Topology if TYPE_CHECKING: + from api.testbed_model.capability import TestProtocol + from api.testbed_model.traffic_generator.traffic_generator import TrafficGenerator from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment from framework.test_suite import TestCase, TestSuite - from framework.testbed_model.capability import TestProtocol - from framework.testbed_model.traffic_generator.traffic_generator import TrafficGenerator P = ParamSpec("P") diff --git a/dts/api/packet.py b/dts/api/packet.py index dda3087df4..defbb758c8 100644 --- a/dts/api/packet.py +++ b/dts/api/packet.py @@ -30,13 +30,13 @@ from api.context import get_ctx from api.exception import InternalError from api.test import fail, log_debug -from api.utils import get_packet_summaries -from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( +from api.testbed_model.traffic_generator.capturing_traffic_generator import ( PacketFilteringConfig, ) -from framework.testbed_model.traffic_generator.performance_traffic_generator import ( +from api.testbed_model.traffic_generator.performance_traffic_generator import ( PerformanceTrafficStats, ) +from api.utils import get_packet_summaries def send_packet_and_capture( @@ -83,7 +83,7 @@ def send_packets_and_capture( A list of received packets. """ from api.context import get_ctx - from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( + from api.testbed_model.traffic_generator.capturing_traffic_generator import ( CapturingTrafficGenerator, ) @@ -339,7 +339,7 @@ def assess_performance_by_packet( Returns: Performance statistics of the generated test. """ - from framework.testbed_model.traffic_generator.performance_traffic_generator import ( + from api.testbed_model.traffic_generator.performance_traffic_generator import ( PerformanceTrafficGenerator, ) diff --git a/dts/framework/testbed_model/__init__.py b/dts/api/testbed_model/__init__.py similarity index 100% rename from dts/framework/testbed_model/__init__.py rename to dts/api/testbed_model/__init__.py diff --git a/dts/framework/testbed_model/capability.py b/dts/api/testbed_model/capability.py similarity index 99% rename from dts/framework/testbed_model/capability.py rename to dts/api/testbed_model/capability.py index 00b40a3b1e..2748daa8a4 100644 --- a/dts/framework/testbed_model/capability.py +++ b/dts/api/testbed_model/capability.py @@ -26,7 +26,7 @@ .. code:: python from framework.test_suite import TestSuite, func_test - from framework.testbed_model.capability import LinkTopology, requires + from api.testbed_model.capability import LinkTopology, requires # The whole test suite (each test case within) doesn't require any links. @requires_link_topology(LinkTopology.NO_LINK) @func_test @@ -37,7 +37,7 @@ def hello_world_single_core(self): .. code:: python from framework.test_suite import TestSuite, func_test - from framework.testbed_model.capability import NicCapability, requires + from api.testbed_model.capability import NicCapability, requires class TestPmdBufferScatter(TestSuite): # only the test case requires the SCATTERED_RX_ENABLED capability # other test cases may not require it @@ -65,10 +65,10 @@ def test_scatter_mbuf_2048(self): from api.capabilities import LinkTopology, NicCapability from api.exception import ConfigurationError, InternalError, SkippedTestException +from api.testbed_model.node import Node +from api.testbed_model.port import DriverKind +from api.testbed_model.topology import Topology from framework.logger import get_dts_logger -from framework.testbed_model.node import Node -from framework.testbed_model.port import DriverKind -from framework.testbed_model.topology import Topology if TYPE_CHECKING: from api.testpmd import TestPmd diff --git a/dts/framework/testbed_model/cpu.py b/dts/api/testbed_model/cpu.py similarity index 99% rename from dts/framework/testbed_model/cpu.py rename to dts/api/testbed_model/cpu.py index 68e9c7dffb..34fb6d0848 100644 --- a/dts/framework/testbed_model/cpu.py +++ b/dts/api/testbed_model/cpu.py @@ -29,7 +29,7 @@ @unique class Architecture(StrEnum): - r"""The supported architectures of :class:`~framework.testbed_model.node.Node`\s.""" + r"""The supported architectures of :class:`~api.testbed_model.node.Node`\s.""" #: i686 = auto() diff --git a/dts/framework/testbed_model/linux_session.py b/dts/api/testbed_model/linux_session.py similarity index 99% rename from dts/framework/testbed_model/linux_session.py rename to dts/api/testbed_model/linux_session.py index 26c53f069c..399968efd4 100644 --- a/dts/framework/testbed_model/linux_session.py +++ b/dts/api/testbed_model/linux_session.py @@ -23,8 +23,8 @@ InternalError, RemoteCommandExecutionError, ) +from api.testbed_model.port import PortInfo from api.utils import expand_range -from framework.testbed_model.port import PortInfo from .cpu import LogicalCore from .port import Port diff --git a/dts/framework/testbed_model/node.py b/dts/api/testbed_model/node.py similarity index 100% rename from dts/framework/testbed_model/node.py rename to dts/api/testbed_model/node.py diff --git a/dts/framework/testbed_model/os_session.py b/dts/api/testbed_model/os_session.py similarity index 99% rename from dts/framework/testbed_model/os_session.py rename to dts/api/testbed_model/os_session.py index 08122874e6..7944fda8c0 100644 --- a/dts/framework/testbed_model/os_session.py +++ b/dts/api/testbed_model/os_session.py @@ -73,11 +73,11 @@ class OSSessionInfo: Attributes: os_name: The name of the running operating system of - the :class:`~framework.testbed_model.node.Node`. + the :class:`~api.testbed_model.node.Node`. os_version: The version of the running operating system of - the :class:`~framework.testbed_model.node.Node`. + the :class:`~api.testbed_model.node.Node`. kernel_version: The kernel version of the running operating system of - the :class:`~framework.testbed_model.node.Node`. + the :class:`~api.testbed_model.node.Node`. """ os_name: str diff --git a/dts/framework/testbed_model/port.py b/dts/api/testbed_model/port.py similarity index 100% rename from dts/framework/testbed_model/port.py rename to dts/api/testbed_model/port.py diff --git a/dts/framework/testbed_model/posix_session.py b/dts/api/testbed_model/posix_session.py similarity index 100% rename from dts/framework/testbed_model/posix_session.py rename to dts/api/testbed_model/posix_session.py diff --git a/dts/framework/testbed_model/topology.py b/dts/api/testbed_model/topology.py similarity index 99% rename from dts/framework/testbed_model/topology.py rename to dts/api/testbed_model/topology.py index 6b8c5edee5..7d074f9ef4 100644 --- a/dts/framework/testbed_model/topology.py +++ b/dts/api/testbed_model/topology.py @@ -19,8 +19,8 @@ from api.capabilities import LinkTopology from api.exception import ConfigurationError, InternalError -from framework.testbed_model.linux_session import LinuxSession -from framework.testbed_model.node import Node, NodeIdentifier +from api.testbed_model.linux_session import LinuxSession +from api.testbed_model.node import Node, NodeIdentifier from .port import DriverKind, Port, PortConfig diff --git a/dts/framework/testbed_model/traffic_generator/__init__.py b/dts/api/testbed_model/traffic_generator/__init__.py similarity index 97% rename from dts/framework/testbed_model/traffic_generator/__init__.py rename to dts/api/testbed_model/traffic_generator/__init__.py index 324b5e88f3..11fa25448a 100644 --- a/dts/framework/testbed_model/traffic_generator/__init__.py +++ b/dts/api/testbed_model/traffic_generator/__init__.py @@ -15,12 +15,12 @@ """ from api.exception import ConfigurationError +from api.testbed_model.node import Node from framework.config.test_run import ( ScapyTrafficGeneratorConfig, TrafficGeneratorConfig, TrexTrafficGeneratorConfig, ) -from framework.testbed_model.node import Node from .scapy import ScapyTrafficGenerator from .traffic_generator import TrafficGenerator diff --git a/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py b/dts/api/testbed_model/traffic_generator/capturing_traffic_generator.py similarity index 99% rename from dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py rename to dts/api/testbed_model/traffic_generator/capturing_traffic_generator.py index 2804d64990..db274e5e82 100644 --- a/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py +++ b/dts/api/testbed_model/traffic_generator/capturing_traffic_generator.py @@ -17,8 +17,8 @@ from scapy.packet import Packet from api.artifact import Artifact +from api.testbed_model.port import Port from api.utils import get_packet_summaries -from framework.testbed_model.port import Port from .traffic_generator import TrafficGenerator diff --git a/dts/framework/testbed_model/traffic_generator/performance_traffic_generator.py b/dts/api/testbed_model/traffic_generator/performance_traffic_generator.py similarity index 100% rename from dts/framework/testbed_model/traffic_generator/performance_traffic_generator.py rename to dts/api/testbed_model/traffic_generator/performance_traffic_generator.py diff --git a/dts/framework/testbed_model/traffic_generator/scapy.py b/dts/api/testbed_model/traffic_generator/scapy.py similarity index 98% rename from dts/framework/testbed_model/traffic_generator/scapy.py rename to dts/api/testbed_model/traffic_generator/scapy.py index 70856cc1f0..1edc1af838 100644 --- a/dts/framework/testbed_model/traffic_generator/scapy.py +++ b/dts/api/testbed_model/traffic_generator/scapy.py @@ -26,15 +26,15 @@ from scapy.packet import Packet from api.exception import InteractiveSSHSessionDeadError, InternalError +from api.testbed_model.node import Node +from api.testbed_model.port import Port +from api.testbed_model.topology import Topology +from api.testbed_model.traffic_generator.capturing_traffic_generator import ( + PacketFilteringConfig, +) from framework.config.node import OS from framework.config.test_run import ScapyTrafficGeneratorConfig from framework.remote_session.python_shell import PythonShell -from framework.testbed_model.node import Node -from framework.testbed_model.port import Port -from framework.testbed_model.topology import Topology -from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( - PacketFilteringConfig, -) from .capturing_traffic_generator import CapturingTrafficGenerator diff --git a/dts/framework/testbed_model/traffic_generator/traffic_generator.py b/dts/api/testbed_model/traffic_generator/traffic_generator.py similarity index 94% rename from dts/framework/testbed_model/traffic_generator/traffic_generator.py rename to dts/api/testbed_model/traffic_generator/traffic_generator.py index fedce77fdf..5fd68e5144 100644 --- a/dts/framework/testbed_model/traffic_generator/traffic_generator.py +++ b/dts/api/testbed_model/traffic_generator/traffic_generator.py @@ -13,11 +13,11 @@ from scapy.packet import Packet +from api.testbed_model.node import Node +from api.testbed_model.port import Port +from api.testbed_model.topology import Topology from framework.config.test_run import TrafficGeneratorConfig from framework.logger import DTSLogger, get_dts_logger -from framework.testbed_model.node import Node -from framework.testbed_model.port import Port -from framework.testbed_model.topology import Topology class TrafficGenerator(ABC): diff --git a/dts/framework/testbed_model/traffic_generator/trex.py b/dts/api/testbed_model/traffic_generator/trex.py similarity index 97% rename from dts/framework/testbed_model/traffic_generator/trex.py rename to dts/api/testbed_model/traffic_generator/trex.py index 7fd6234d27..ffb1390706 100644 --- a/dts/framework/testbed_model/traffic_generator/trex.py +++ b/dts/api/testbed_model/traffic_generator/trex.py @@ -12,19 +12,19 @@ from scapy.packet import Packet from api.exception import SSHTimeoutError +from api.testbed_model.node import Node, create_session +from api.testbed_model.os_session import OSSession +from api.testbed_model.topology import Topology +from api.testbed_model.traffic_generator.performance_traffic_generator import ( + PerformanceTrafficGenerator, + PerformanceTrafficStats, +) from api.utils import StrEnum from framework.config.node import OS, NodeConfiguration from framework.config.test_run import TrexTrafficGeneratorConfig from framework.parser import TextParser from framework.remote_session.blocking_app import BlockingApp from framework.remote_session.python_shell import PythonShell -from framework.testbed_model.node import Node, create_session -from framework.testbed_model.os_session import OSSession -from framework.testbed_model.topology import Topology -from framework.testbed_model.traffic_generator.performance_traffic_generator import ( - PerformanceTrafficGenerator, - PerformanceTrafficStats, -) @dataclass(slots=True) diff --git a/dts/framework/testbed_model/virtual_device.py b/dts/api/testbed_model/virtual_device.py similarity index 100% rename from dts/framework/testbed_model/virtual_device.py rename to dts/api/testbed_model/virtual_device.py diff --git a/dts/framework/params/eal.py b/dts/framework/params/eal.py index e84a20f02f..86bfd3fcc6 100644 --- a/dts/framework/params/eal.py +++ b/dts/framework/params/eal.py @@ -6,12 +6,12 @@ from dataclasses import dataclass, field from typing import TYPE_CHECKING, Literal +from api.testbed_model.cpu import LogicalCoreList +from api.testbed_model.virtual_device import VirtualDevice from framework.params import Params, Switch -from framework.testbed_model.cpu import LogicalCoreList -from framework.testbed_model.virtual_device import VirtualDevice if TYPE_CHECKING: - from framework.testbed_model.port import Port + from api.testbed_model.port import Port def _port_to_pci(port: "Port") -> str: diff --git a/dts/framework/params/types.py b/dts/framework/params/types.py index a9f3749083..f9a51963a2 100644 --- a/dts/framework/params/types.py +++ b/dts/framework/params/types.py @@ -32,6 +32,9 @@ def create_testpmd(**kwargs: Unpack[TestPmdParamsDict]): TestType, TLSVersion, ) +from api.testbed_model.cpu import LogicalCoreList +from api.testbed_model.port import Port +from api.testbed_model.virtual_device import VirtualDevice from api.testpmd.config import ( AnonMempoolAllocationMode, EthPeer, @@ -55,9 +58,6 @@ def create_testpmd(**kwargs: Unpack[TestPmdParamsDict]): ) from api.testpmd.types import RxOffloadCapability, TxOffloadCapability from framework.params import Switch, YesNoSwitch -from framework.testbed_model.cpu import LogicalCoreList -from framework.testbed_model.port import Port -from framework.testbed_model.virtual_device import VirtualDevice class EalParamsDict(TypedDict, total=False): diff --git a/dts/framework/remote_session/blocking_app.py b/dts/framework/remote_session/blocking_app.py index 07db6dfeb0..84db3974b1 100644 --- a/dts/framework/remote_session/blocking_app.py +++ b/dts/framework/remote_session/blocking_app.py @@ -31,11 +31,11 @@ from typing_extensions import Self from api.context import get_ctx +from api.testbed_model.node import Node from framework.params import Params from framework.params.eal import EalParams from framework.remote_session.dpdk_shell import compute_eal_params from framework.remote_session.interactive_shell import InteractiveShell -from framework.testbed_model.node import Node P = TypeVar("P", bound=Params) diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index ee34eb567d..c02c68af77 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -16,6 +16,10 @@ from api.capabilities import LinkTopology from api.context import get_ctx from api.exception import ConfigurationError, RemoteFileNotFoundError +from api.testbed_model.cpu import LogicalCore, LogicalCoreCount, LogicalCoreList, lcore_filter +from api.testbed_model.node import Node +from api.testbed_model.os_session import OSSession +from api.testbed_model.virtual_device import VirtualDevice from api.utils import MesonArgs, TarCompressionFormat from framework.config.test_run import ( DPDKBuildConfiguration, @@ -31,10 +35,6 @@ from framework.logger import DTSLogger, get_dts_logger from framework.params.eal import EalParams from framework.remote_session.remote_session import CommandResult -from framework.testbed_model.cpu import LogicalCore, LogicalCoreCount, LogicalCoreList, lcore_filter -from framework.testbed_model.node import Node -from framework.testbed_model.os_session import OSSession -from framework.testbed_model.virtual_device import VirtualDevice @dataclass(slots=True, frozen=True) diff --git a/dts/framework/remote_session/dpdk_shell.py b/dts/framework/remote_session/dpdk_shell.py index a8f169787c..b807f9bdae 100644 --- a/dts/framework/remote_session/dpdk_shell.py +++ b/dts/framework/remote_session/dpdk_shell.py @@ -11,12 +11,12 @@ from pathlib import PurePath from api.context import get_ctx +from api.testbed_model.cpu import LogicalCoreList from framework.params.eal import EalParams from framework.remote_session.interactive_shell import ( InteractiveShell, only_active, ) -from framework.testbed_model.cpu import LogicalCoreList def compute_eal_params( diff --git a/dts/framework/remote_session/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index 362bc2a352..831861a9ac 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -35,10 +35,10 @@ InteractiveSSHSessionDeadError, InteractiveSSHTimeoutError, ) +from api.testbed_model.node import Node from framework.logger import DTSLogger, get_dts_logger from framework.params import Params from framework.settings import SETTINGS -from framework.testbed_model.node import Node P = ParamSpec("P") T = TypeVar("T", bound="InteractiveShell") diff --git a/dts/framework/runner.py b/dts/framework/runner.py index cb137fbf7b..ba5bc45cfc 100644 --- a/dts/framework/runner.py +++ b/dts/framework/runner.py @@ -13,9 +13,9 @@ import textwrap from api.exception import ConfigurationError +from api.testbed_model.node import Node from framework.config.common import ValidationContext from framework.test_run import TestRun -from framework.testbed_model.node import Node from .config import Configuration, load_config from .logger import DTSLogger, get_dts_logger diff --git a/dts/framework/test_result.py b/dts/framework/test_result.py index 3cecb928ca..5f945163ce 100644 --- a/dts/framework/test_result.py +++ b/dts/framework/test_result.py @@ -36,9 +36,9 @@ from typing_extensions import OrderedDict from api.exception import DTSError, ErrorSeverity, InternalError +from api.testbed_model.os_session import OSSessionInfo from framework.remote_session.dpdk import DPDKBuildInfo from framework.settings import SETTINGS -from framework.testbed_model.os_session import OSSessionInfo class Result(IntEnum): diff --git a/dts/framework/test_run.py b/dts/framework/test_run.py index 8b9ae4a49a..42a56d38c9 100644 --- a/dts/framework/test_run.py +++ b/dts/framework/test_run.py @@ -110,20 +110,20 @@ from api.capabilities import LinkTopology from api.context import Context, init_ctx from api.exception import InternalError, SkippedTestException, TestCaseVerifyError +from api.testbed_model.capability import ( + Capability, + get_supported_capabilities, + test_if_supported, +) +from api.testbed_model.node import Node +from api.testbed_model.topology import PortLink, Topology +from api.testbed_model.traffic_generator import create_traffic_generator from framework.config.test_run import TestRunConfiguration from framework.logger import DTSLogger, get_dts_logger from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment from framework.settings import SETTINGS from framework.test_result import Result, ResultNode, TestRunResult from framework.test_suite import BaseConfig, TestCase, TestCaseType, TestSuite -from framework.testbed_model.capability import ( - Capability, - get_supported_capabilities, - test_if_supported, -) -from framework.testbed_model.node import Node -from framework.testbed_model.topology import PortLink, Topology -from framework.testbed_model.traffic_generator import create_traffic_generator TestScenario = tuple[type[TestSuite], BaseConfig, deque[type[TestCase]]] diff --git a/dts/framework/test_suite.py b/dts/framework/test_suite.py index 6066f7a77a..786cfc7bff 100644 --- a/dts/framework/test_suite.py +++ b/dts/framework/test_suite.py @@ -30,10 +30,10 @@ from typing_extensions import Self from api.exception import ConfigurationError, InternalError +from api.testbed_model.capability import TestProtocol +from api.testbed_model.topology import Topology from api.utils import to_pascal_case from framework.config.common import FrozenModel -from framework.testbed_model.capability import TestProtocol -from framework.testbed_model.topology import Topology from .logger import DTSLogger, get_dts_logger diff --git a/dts/tests/TestSuite_blocklist.py b/dts/tests/TestSuite_blocklist.py index c57231de22..97e03b8fb7 100644 --- a/dts/tests/TestSuite_blocklist.py +++ b/dts/tests/TestSuite_blocklist.py @@ -11,9 +11,9 @@ requires_link_topology, ) from api.test import verify +from api.testbed_model.port import Port from api.testpmd import TestPmd from framework.test_suite import TestSuite, func_test -from framework.testbed_model.port import Port class TestBlocklist(TestSuite): diff --git a/dts/tests/TestSuite_cryptodev_latency.py b/dts/tests/TestSuite_cryptodev_latency.py index ed6423eb26..981c483a14 100644 --- a/dts/tests/TestSuite_cryptodev_latency.py +++ b/dts/tests/TestSuite_cryptodev_latency.py @@ -31,8 +31,8 @@ CryptodevResults, ) from api.test import skip, verify +from api.testbed_model.virtual_device import VirtualDevice from framework.test_suite import BaseConfig, TestSuite, crypto_test -from framework.testbed_model.virtual_device import VirtualDevice config_list: list[dict[str, int | float | str]] = [ {"buff_size": 64, "avg_cycles": 99_999.00, "avg_time_us": 9999.0}, diff --git a/dts/tests/TestSuite_cryptodev_throughput.py b/dts/tests/TestSuite_cryptodev_throughput.py index d69714e1fa..b861c52bae 100644 --- a/dts/tests/TestSuite_cryptodev_throughput.py +++ b/dts/tests/TestSuite_cryptodev_throughput.py @@ -31,8 +31,8 @@ CryptodevResults, ) from api.test import skip, verify +from api.testbed_model.virtual_device import VirtualDevice from framework.test_suite import BaseConfig, TestSuite, crypto_test -from framework.testbed_model.virtual_device import VirtualDevice config_list: list[dict[str, int | float | str]] = [ {"buff_size": 64, "Gbps": 1.00}, diff --git a/dts/tests/TestSuite_l2fwd.py b/dts/tests/TestSuite_l2fwd.py index 574842e2e4..5650366c36 100644 --- a/dts/tests/TestSuite_l2fwd.py +++ b/dts/tests/TestSuite_l2fwd.py @@ -19,11 +19,11 @@ match_all_packets, send_packets_and_capture, ) +from api.testbed_model.cpu import LogicalCoreCount from api.testpmd import TestPmd from api.testpmd.config import EthPeer, SimpleForwardingModes from api.utils import generate_random_packets from framework.test_suite import TestSuite, func_test -from framework.testbed_model.cpu import LogicalCoreCount @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_packet_capture.py b/dts/tests/TestSuite_packet_capture.py index 4bd15e2401..042b7019aa 100644 --- a/dts/tests/TestSuite_packet_capture.py +++ b/dts/tests/TestSuite_packet_capture.py @@ -36,15 +36,15 @@ send_packets_and_capture, ) from api.test import verify +from api.testbed_model.cpu import LogicalCoreList +from api.testbed_model.traffic_generator.capturing_traffic_generator import ( + PacketFilteringConfig, +) from api.testpmd import TestPmd from framework.params import Params from framework.remote_session.blocking_app import BlockingApp from framework.remote_session.dpdk_shell import compute_eal_params from framework.test_suite import TestSuite, func_test -from framework.testbed_model.cpu import LogicalCoreList -from framework.testbed_model.traffic_generator.capturing_traffic_generator import ( - PacketFilteringConfig, -) @dataclass(kw_only=True) diff --git a/dts/tests/TestSuite_smoke_tests.py b/dts/tests/TestSuite_smoke_tests.py index fce83604a6..656e2e4bb7 100644 --- a/dts/tests/TestSuite_smoke_tests.py +++ b/dts/tests/TestSuite_smoke_tests.py @@ -19,12 +19,12 @@ requires_link_topology, ) from api.test import verify +from api.testbed_model.linux_session import LinuxSession from api.testpmd import TestPmd from api.utils import REGEX_FOR_PCI_ADDRESS from framework.config.node import PortConfig from framework.settings import SETTINGS from framework.test_suite import TestSuite, func_test -from framework.testbed_model.linux_session import LinuxSession @requires_link_topology(LinkTopology.NO_LINK) diff --git a/dts/tests/TestSuite_softnic.py b/dts/tests/TestSuite_softnic.py index c57a12c932..91a6d4eb9f 100644 --- a/dts/tests/TestSuite_softnic.py +++ b/dts/tests/TestSuite_softnic.py @@ -18,11 +18,11 @@ match_all_packets, send_packets_and_capture, ) +from api.testbed_model.virtual_device import VirtualDevice from api.testpmd import TestPmd from api.testpmd.config import EthPeer from api.utils import generate_random_packets from framework.test_suite import TestSuite, func_test -from framework.testbed_model.virtual_device import VirtualDevice @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_virtio_forward.py b/dts/tests/TestSuite_virtio_forward.py index 6efaa4e156..06bcd86ee4 100644 --- a/dts/tests/TestSuite_virtio_forward.py +++ b/dts/tests/TestSuite_virtio_forward.py @@ -12,12 +12,12 @@ from api.capabilities import LinkTopology from api.packet import send_packets_and_capture from api.test import log, verify +from api.testbed_model.capability import requires +from api.testbed_model.linux_session import LinuxSession +from api.testbed_model.virtual_device import VirtualDevice from api.testpmd import TestPmd from api.testpmd.config import PortTopology, SimpleForwardingModes from framework.test_suite import TestSuite, func_test -from framework.testbed_model.capability import requires -from framework.testbed_model.linux_session import LinuxSession -from framework.testbed_model.virtual_device import VirtualDevice class TestVirtioForward(TestSuite): -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* Re: [PATCH v7 4/7] dts: move testbed model from framework to API 2026-08-07 16:16 ` [PATCH v7 4/7] dts: move testbed model " Andrew Bailey @ 2026-08-20 13:53 ` Luca Vizzarro 0 siblings, 0 replies; 47+ messages in thread From: Luca Vizzarro @ 2026-08-20 13:53 UTC (permalink / raw) To: Andrew Bailey, dev, patrickrobb1997; +Cc: knimoji, lylavoie, dladd, Dean Marx This one is a lot less ideal. For example scapy and trex provide whole implementations. These shouldn't live in the API package. As mentioned before the API package is meant to be a reliable interface to the test writer, so in theory only abstract functions should live there. I understand most of the testbed model package is indeed definitions so it's just a few things that need taking care of. ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v7 5/7] dts: move test suite module from framework to API 2026-08-07 16:16 ` [PATCH v7 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (3 preceding siblings ...) 2026-08-07 16:16 ` [PATCH v7 4/7] dts: move testbed model " Andrew Bailey @ 2026-08-07 16:16 ` Andrew Bailey 2026-08-20 13:55 ` Luca Vizzarro 2026-08-07 16:16 ` [PATCH v7 6/7] dts: move params directory " Andrew Bailey ` (2 subsequent siblings) 7 siblings, 1 reply; 47+ messages in thread From: Andrew Bailey @ 2026-08-07 16:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx Currently, each test suite imports the TestSuite class from the DTS framework to use as a base class. However, the goal for 26.07 is to move all test suite imports to the API module. Moves and updates the test_suite file to the API directory, and updates all files that import test_suite to reflect this change. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- .../dts/{framework.test_suite.rst => api.test_suite.rst} | 2 +- doc/api/dts/index.rst | 2 +- dts/api/capabilities.py | 6 +++--- dts/api/context.py | 2 +- dts/api/packet.py | 2 +- dts/{framework => api}/test_suite.py | 3 +-- dts/api/testbed_model/capability.py | 6 +++--- dts/framework/config/__init__.py | 4 ++-- dts/framework/config/test_run.py | 8 ++++---- dts/framework/test_run.py | 2 +- dts/tests/TestSuite_blocklist.py | 2 +- dts/tests/TestSuite_buffer_scatter.py | 2 +- dts/tests/TestSuite_checksum_offload.py | 2 +- dts/tests/TestSuite_cryptodev_latency.py | 2 +- dts/tests/TestSuite_cryptodev_throughput.py | 2 +- dts/tests/TestSuite_dual_vlan.py | 2 +- dts/tests/TestSuite_dynamic_config.py | 2 +- dts/tests/TestSuite_dynamic_queue_conf.py | 2 +- dts/tests/TestSuite_flow_offload.py | 2 +- dts/tests/TestSuite_hello_world.py | 2 +- dts/tests/TestSuite_l2fwd.py | 2 +- dts/tests/TestSuite_mac_filter.py | 2 +- dts/tests/TestSuite_mtu.py | 2 +- dts/tests/TestSuite_packet_capture.py | 2 +- dts/tests/TestSuite_port_control.py | 2 +- dts/tests/TestSuite_port_restart_config_persistency.py | 2 +- dts/tests/TestSuite_port_stats.py | 2 +- dts/tests/TestSuite_promisc_support.py | 2 +- dts/tests/TestSuite_qinq.py | 2 +- dts/tests/TestSuite_queue_toggle.py | 2 +- dts/tests/TestSuite_rss.py | 2 +- dts/tests/TestSuite_rx_split.py | 2 +- dts/tests/TestSuite_rx_tx_offload.py | 2 +- dts/tests/TestSuite_single_core_forward_perf.py | 2 +- dts/tests/TestSuite_smoke_tests.py | 2 +- dts/tests/TestSuite_softnic.py | 2 +- dts/tests/TestSuite_speed_capabilities.py | 2 +- dts/tests/TestSuite_unified_packet.py | 2 +- dts/tests/TestSuite_virtio_forward.py | 2 +- dts/tests/TestSuite_vlan.py | 2 +- 40 files changed, 48 insertions(+), 49 deletions(-) rename doc/api/dts/{framework.test_suite.rst => api.test_suite.rst} (81%) rename dts/{framework => api}/test_suite.py (99%) diff --git a/doc/api/dts/framework.test_suite.rst b/doc/api/dts/api.test_suite.rst similarity index 81% rename from doc/api/dts/framework.test_suite.rst rename to doc/api/dts/api.test_suite.rst index 9517f51a4a..4acb7b103a 100644 --- a/doc/api/dts/framework.test_suite.rst +++ b/doc/api/dts/api.test_suite.rst @@ -3,6 +3,6 @@ test\_suite - Common Test Suite Features ======================================== -.. automodule:: framework.test_suite +.. automodule:: api.test_suite :members: :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index f47e4af3f2..7c282bbba1 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -29,7 +29,7 @@ Modules framework.runner framework.test_run - framework.test_suite + api.test_suite framework.test_result framework.settings api.context diff --git a/dts/api/capabilities.py b/dts/api/capabilities.py index 8ed832a588..933eb6bca7 100644 --- a/dts/api/capabilities.py +++ b/dts/api/capabilities.py @@ -22,7 +22,7 @@ Examples: .. code:: python - from framework.test_suite import TestSuite, func_test + from api.test_suite import TestSuite, func_test from api.testbed_model.capability import LinkTopology, requires_link_topology # The whole test suite (each test case within) doesn't require any links. @requires_link_topology(LinkTopology.NO_LINK) @@ -33,7 +33,7 @@ def hello_world_single_core(self): .. code:: python - from framework.test_suite import TestSuite, func_test + from api.test_suite import TestSuite, func_test from api.testbed_model.capability import NicCapability, requires_nic_capability class TestPmdBufferScatter(TestSuite): # only the test case requires the SCATTERED_RX_ENABLED capability @@ -47,7 +47,7 @@ def test_scatter_mbuf_2048(self): from typing import TYPE_CHECKING, Callable if TYPE_CHECKING: - from framework.test_suite import TestProtocol + from api.test_suite import TestProtocol class LinkTopology(IntEnum): diff --git a/dts/api/context.py b/dts/api/context.py index 57e14ef598..753b2101a0 100644 --- a/dts/api/context.py +++ b/dts/api/context.py @@ -16,10 +16,10 @@ from framework.settings import SETTINGS if TYPE_CHECKING: + from api.test_suite import TestCase, TestSuite from api.testbed_model.capability import TestProtocol from api.testbed_model.traffic_generator.traffic_generator import TrafficGenerator from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment - from framework.test_suite import TestCase, TestSuite P = ParamSpec("P") diff --git a/dts/api/packet.py b/dts/api/packet.py index defbb758c8..58f47f1646 100644 --- a/dts/api/packet.py +++ b/dts/api/packet.py @@ -175,7 +175,7 @@ def adjust_addresses(packets: list[Packet], expected: bool = False) -> list[Pack Raises: InternalError: If no tests are running. """ - from framework.test_suite import TestSuite + from api.test_suite import TestSuite if get_ctx().local.current_test_suite is None: raise InternalError("No current test suite, tests aren't running?") diff --git a/dts/framework/test_suite.py b/dts/api/test_suite.py similarity index 99% rename from dts/framework/test_suite.py rename to dts/api/test_suite.py index 786cfc7bff..0822f9bfe5 100644 --- a/dts/framework/test_suite.py +++ b/dts/api/test_suite.py @@ -34,8 +34,7 @@ from api.testbed_model.topology import Topology from api.utils import to_pascal_case from framework.config.common import FrozenModel - -from .logger import DTSLogger, get_dts_logger +from framework.logger import DTSLogger, get_dts_logger if TYPE_CHECKING: from api.context import Context diff --git a/dts/api/testbed_model/capability.py b/dts/api/testbed_model/capability.py index 2748daa8a4..bb581d4ab7 100644 --- a/dts/api/testbed_model/capability.py +++ b/dts/api/testbed_model/capability.py @@ -25,7 +25,7 @@ Examples: .. code:: python - from framework.test_suite import TestSuite, func_test + from api.test_suite import TestSuite, func_test from api.testbed_model.capability import LinkTopology, requires # The whole test suite (each test case within) doesn't require any links. @requires_link_topology(LinkTopology.NO_LINK) @@ -36,7 +36,7 @@ def hello_world_single_core(self): .. code:: python - from framework.test_suite import TestSuite, func_test + from api.test_suite import TestSuite, func_test from api.testbed_model.capability import NicCapability, requires class TestPmdBufferScatter(TestSuite): # only the test case requires the SCATTERED_RX_ENABLED capability @@ -71,8 +71,8 @@ def test_scatter_mbuf_2048(self): from framework.logger import get_dts_logger if TYPE_CHECKING: + from api.test_suite import TestCase from api.testpmd import TestPmd - from framework.test_suite import TestCase P = ParamSpec("P") TestPmdMethod = Callable[Concatenate["TestPmd", P], Any] diff --git a/dts/framework/config/__init__.py b/dts/framework/config/__init__.py index e24a351ecf..c8edf340bd 100644 --- a/dts/framework/config/__init__.py +++ b/dts/framework/config/__init__.py @@ -43,7 +43,7 @@ # Import only if type checking or building docs, to prevent circular imports. if TYPE_CHECKING: - from framework.test_suite import BaseConfig + from api.test_suite import BaseConfig NodesConfig = Annotated[list[NodeConfiguration], Field(min_length=1)] @@ -184,7 +184,7 @@ def load_config(ctx: ValidationContext) -> Configuration: nodes = _load_and_parse_model(ctx["settings"].nodes_config_path, NodesConfig, ctx) try: - from framework.test_suite import BaseConfig as BaseConfig + from api.test_suite import BaseConfig as BaseConfig Configuration.model_rebuild() return Configuration.model_validate( diff --git a/dts/framework/config/test_run.py b/dts/framework/config/test_run.py index b87c7b2d19..40fce48bf9 100644 --- a/dts/framework/config/test_run.py +++ b/dts/framework/config/test_run.py @@ -33,7 +33,7 @@ from .common import FrozenModel, load_fields_from_settings if TYPE_CHECKING: - from framework.test_suite import BaseConfig, TestCase, TestSuite, TestSuiteSpec + from api.test_suite import BaseConfig, TestCase, TestSuite, TestSuiteSpec @unique @@ -230,7 +230,7 @@ class TestSuiteConfig(FrozenModel): @cached_property def test_suite_spec(self) -> "TestSuiteSpec": """The specification of the requested test suite.""" - from framework.test_suite import find_by_name + from api.test_suite import find_by_name test_suite_spec = find_by_name(self.test_suite_name) assert test_suite_spec is not None, ( @@ -280,7 +280,7 @@ def fetch_all_test_suites() -> list[TestSuiteConfig]: This function does not include the smoke tests. """ - from framework.test_suite import AVAILABLE_TEST_SUITES + from api.test_suite import AVAILABLE_TEST_SUITES return [ TestSuiteConfig(test_suite=test_suite.name) @@ -506,7 +506,7 @@ def filter_tests( self, tests_config: dict[str, "BaseConfig"] ) -> Iterable[tuple[type["TestSuite"], "BaseConfig", deque[type["TestCase"]]]]: """Filter test suites and cases selected for execution.""" - from framework.test_suite import TestCaseType + from api.test_suite import TestCaseType test_suites = [TestSuiteConfig(test_suite="smoke_tests")] diff --git a/dts/framework/test_run.py b/dts/framework/test_run.py index 42a56d38c9..dfbdd0b5b5 100644 --- a/dts/framework/test_run.py +++ b/dts/framework/test_run.py @@ -110,6 +110,7 @@ from api.capabilities import LinkTopology from api.context import Context, init_ctx from api.exception import InternalError, SkippedTestException, TestCaseVerifyError +from api.test_suite import BaseConfig, TestCase, TestCaseType, TestSuite from api.testbed_model.capability import ( Capability, get_supported_capabilities, @@ -123,7 +124,6 @@ from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment from framework.settings import SETTINGS from framework.test_result import Result, ResultNode, TestRunResult -from framework.test_suite import BaseConfig, TestCase, TestCaseType, TestSuite TestScenario = tuple[type[TestSuite], BaseConfig, deque[type[TestCase]]] diff --git a/dts/tests/TestSuite_blocklist.py b/dts/tests/TestSuite_blocklist.py index 97e03b8fb7..31e69c0de9 100644 --- a/dts/tests/TestSuite_blocklist.py +++ b/dts/tests/TestSuite_blocklist.py @@ -11,9 +11,9 @@ requires_link_topology, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testbed_model.port import Port from api.testpmd import TestPmd -from framework.test_suite import TestSuite, func_test class TestBlocklist(TestSuite): diff --git a/dts/tests/TestSuite_buffer_scatter.py b/dts/tests/TestSuite_buffer_scatter.py index 539082f2e4..cd1a52ad5e 100644 --- a/dts/tests/TestSuite_buffer_scatter.py +++ b/dts/tests/TestSuite_buffer_scatter.py @@ -28,9 +28,9 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_checksum_offload.py b/dts/tests/TestSuite_checksum_offload.py index 90ca798e56..a2ea13991b 100644 --- a/dts/tests/TestSuite_checksum_offload.py +++ b/dts/tests/TestSuite_checksum_offload.py @@ -25,10 +25,10 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import ChecksumOffloadOptions, PacketOffloadFlag -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PORT_RX_OFFLOAD_IPV4_CKSUM) diff --git a/dts/tests/TestSuite_cryptodev_latency.py b/dts/tests/TestSuite_cryptodev_latency.py index 981c483a14..444a5b282c 100644 --- a/dts/tests/TestSuite_cryptodev_latency.py +++ b/dts/tests/TestSuite_cryptodev_latency.py @@ -31,8 +31,8 @@ CryptodevResults, ) from api.test import skip, verify +from api.test_suite import BaseConfig, TestSuite, crypto_test from api.testbed_model.virtual_device import VirtualDevice -from framework.test_suite import BaseConfig, TestSuite, crypto_test config_list: list[dict[str, int | float | str]] = [ {"buff_size": 64, "avg_cycles": 99_999.00, "avg_time_us": 9999.0}, diff --git a/dts/tests/TestSuite_cryptodev_throughput.py b/dts/tests/TestSuite_cryptodev_throughput.py index b861c52bae..59f64f2cd7 100644 --- a/dts/tests/TestSuite_cryptodev_throughput.py +++ b/dts/tests/TestSuite_cryptodev_throughput.py @@ -31,8 +31,8 @@ CryptodevResults, ) from api.test import skip, verify +from api.test_suite import BaseConfig, TestSuite, crypto_test from api.testbed_model.virtual_device import VirtualDevice -from framework.test_suite import BaseConfig, TestSuite, crypto_test config_list: list[dict[str, int | float | str]] = [ {"buff_size": 64, "Gbps": 1.00}, diff --git a/dts/tests/TestSuite_dual_vlan.py b/dts/tests/TestSuite_dual_vlan.py index 1b77dd2b47..f3347a6d52 100644 --- a/dts/tests/TestSuite_dual_vlan.py +++ b/dts/tests/TestSuite_dual_vlan.py @@ -21,9 +21,9 @@ from api.capabilities import LinkTopology, requires_link_topology from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test class TestDualVlan(TestSuite): diff --git a/dts/tests/TestSuite_dynamic_config.py b/dts/tests/TestSuite_dynamic_config.py index 7204ec4f73..b9e2c30da1 100644 --- a/dts/tests/TestSuite_dynamic_config.py +++ b/dts/tests/TestSuite_dynamic_config.py @@ -27,9 +27,9 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_dynamic_queue_conf.py b/dts/tests/TestSuite_dynamic_queue_conf.py index b62efa2b42..24584c7d60 100644 --- a/dts/tests/TestSuite_dynamic_queue_conf.py +++ b/dts/tests/TestSuite_dynamic_queue_conf.py @@ -38,9 +38,9 @@ from api.exception import InteractiveCommandExecutionError from api.packet import send_packets from api.test import fail, verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import PortTopology, SimpleForwardingModes -from framework.test_suite import TestSuite, func_test def setup_and_teardown_test( diff --git a/dts/tests/TestSuite_flow_offload.py b/dts/tests/TestSuite_flow_offload.py index 5902406a8e..09384b1983 100644 --- a/dts/tests/TestSuite_flow_offload.py +++ b/dts/tests/TestSuite_flow_offload.py @@ -28,9 +28,9 @@ ) from api.packet import send_packet_and_capture from api.test import fail, log, verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.types import FlowRule -from framework.test_suite import TestSuite, func_test @dataclass diff --git a/dts/tests/TestSuite_hello_world.py b/dts/tests/TestSuite_hello_world.py index bf1a93c782..cd62eb8f3e 100644 --- a/dts/tests/TestSuite_hello_world.py +++ b/dts/tests/TestSuite_hello_world.py @@ -9,8 +9,8 @@ """ from api.test import log +from api.test_suite import BaseConfig, TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import BaseConfig, TestSuite, func_test class Config(BaseConfig): diff --git a/dts/tests/TestSuite_l2fwd.py b/dts/tests/TestSuite_l2fwd.py index 5650366c36..f237821a04 100644 --- a/dts/tests/TestSuite_l2fwd.py +++ b/dts/tests/TestSuite_l2fwd.py @@ -19,11 +19,11 @@ match_all_packets, send_packets_and_capture, ) +from api.test_suite import TestSuite, func_test from api.testbed_model.cpu import LogicalCoreCount from api.testpmd import TestPmd from api.testpmd.config import EthPeer, SimpleForwardingModes from api.utils import generate_random_packets -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_mac_filter.py b/dts/tests/TestSuite_mac_filter.py index b44822d31c..eb1413f336 100644 --- a/dts/tests/TestSuite_mac_filter.py +++ b/dts/tests/TestSuite_mac_filter.py @@ -26,8 +26,8 @@ from api.exception import InteractiveCommandExecutionError from api.packet import send_packet_and_capture from api.test import fail, verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_mtu.py b/dts/tests/TestSuite_mtu.py index 8355495d33..c264db299e 100644 --- a/dts/tests/TestSuite_mtu.py +++ b/dts/tests/TestSuite_mtu.py @@ -23,8 +23,8 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import TestSuite, func_test STANDARD_FRAME = 1518 # --max-pkt-len will subtract l2 information at a minimum of 18 bytes. JUMBO_FRAME = 9018 diff --git a/dts/tests/TestSuite_packet_capture.py b/dts/tests/TestSuite_packet_capture.py index 042b7019aa..fd5cef5268 100644 --- a/dts/tests/TestSuite_packet_capture.py +++ b/dts/tests/TestSuite_packet_capture.py @@ -36,6 +36,7 @@ send_packets_and_capture, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testbed_model.cpu import LogicalCoreList from api.testbed_model.traffic_generator.capturing_traffic_generator import ( PacketFilteringConfig, @@ -44,7 +45,6 @@ from framework.params import Params from framework.remote_session.blocking_app import BlockingApp from framework.remote_session.dpdk_shell import compute_eal_params -from framework.test_suite import TestSuite, func_test @dataclass(kw_only=True) diff --git a/dts/tests/TestSuite_port_control.py b/dts/tests/TestSuite_port_control.py index b51fdc2959..c2f2de3493 100644 --- a/dts/tests/TestSuite_port_control.py +++ b/dts/tests/TestSuite_port_control.py @@ -18,9 +18,9 @@ ) from api.packet import send_packets_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_port_restart_config_persistency.py b/dts/tests/TestSuite_port_restart_config_persistency.py index 4ea22b6d70..88df35d33c 100644 --- a/dts/tests/TestSuite_port_restart_config_persistency.py +++ b/dts/tests/TestSuite_port_restart_config_persistency.py @@ -14,9 +14,9 @@ requires_nic_capability, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.types import TestPmdPortFlowCtrl -from framework.test_suite import TestSuite, func_test ALTERNATIVE_MTU: int = 800 STANDARD_MTU: int = 1500 diff --git a/dts/tests/TestSuite_port_stats.py b/dts/tests/TestSuite_port_stats.py index 3dc045f847..0328c6718c 100644 --- a/dts/tests/TestSuite_port_stats.py +++ b/dts/tests/TestSuite_port_stats.py @@ -25,10 +25,10 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import RtePTypes, TestPmdVerbosePacket -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_promisc_support.py b/dts/tests/TestSuite_promisc_support.py index a0c65dc662..c59c8c6078 100644 --- a/dts/tests/TestSuite_promisc_support.py +++ b/dts/tests/TestSuite_promisc_support.py @@ -21,8 +21,8 @@ send_packets_and_capture, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_qinq.py b/dts/tests/TestSuite_qinq.py index 505d71dbc8..5dde37d4db 100644 --- a/dts/tests/TestSuite_qinq.py +++ b/dts/tests/TestSuite_qinq.py @@ -18,8 +18,8 @@ from api.capabilities import NicCapability, requires_nic_capability from api.packet import send_packet_and_capture from api.test import log, verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import TestSuite, func_test class TestQinq(TestSuite): diff --git a/dts/tests/TestSuite_queue_toggle.py b/dts/tests/TestSuite_queue_toggle.py index e4edc89123..a9ea356b22 100644 --- a/dts/tests/TestSuite_queue_toggle.py +++ b/dts/tests/TestSuite_queue_toggle.py @@ -24,9 +24,9 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test @requires_link_topology(LinkTopology.TWO_LINKS) diff --git a/dts/tests/TestSuite_rss.py b/dts/tests/TestSuite_rss.py index 1e60bdba07..b538e93af9 100644 --- a/dts/tests/TestSuite_rss.py +++ b/dts/tests/TestSuite_rss.py @@ -23,6 +23,7 @@ from api.exception import InteractiveCommandExecutionError from api.packet import send_packets_and_capture from api.test import verify +from api.test_suite import BaseConfig, TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import ( @@ -31,7 +32,6 @@ TestPmdVerbosePacket, ) from api.utils import StrEnum -from framework.test_suite import BaseConfig, TestSuite, func_test class Config(BaseConfig): diff --git a/dts/tests/TestSuite_rx_split.py b/dts/tests/TestSuite_rx_split.py index 470e48d0d3..3b3e4cd620 100644 --- a/dts/tests/TestSuite_rx_split.py +++ b/dts/tests/TestSuite_rx_split.py @@ -21,10 +21,10 @@ from api.exception import InteractiveCommandExecutionError from api.packet import adjust_addresses, send_packet_and_capture from api.test import fail, verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import RxOffloadCapability, TxOffloadCapability -from framework.test_suite import TestSuite, func_test PAYLOAD = bytes(range(256)) ETHER_HDR_LEN = len(Ether(dst="00:00:00:00:00:00")) diff --git a/dts/tests/TestSuite_rx_tx_offload.py b/dts/tests/TestSuite_rx_tx_offload.py index b0da627d3c..c8d24baaae 100644 --- a/dts/tests/TestSuite_rx_tx_offload.py +++ b/dts/tests/TestSuite_rx_tx_offload.py @@ -13,12 +13,12 @@ requires_nic_capability, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.types import ( OffloadConfiguration, RxTxLiteralSwitch, ) -from framework.test_suite import TestSuite, func_test @requires_link_topology(LinkTopology.ONE_LINK) diff --git a/dts/tests/TestSuite_single_core_forward_perf.py b/dts/tests/TestSuite_single_core_forward_perf.py index 57aecdf7a4..f51ff76c4c 100644 --- a/dts/tests/TestSuite_single_core_forward_perf.py +++ b/dts/tests/TestSuite_single_core_forward_perf.py @@ -22,10 +22,10 @@ ) from api.packet import assess_performance_by_packet from api.test import verify, write_performance_json +from api.test_suite import BaseConfig, TestSuite, perf_test from api.testpmd import TestPmd from api.testpmd.config import RXRingParams, TXRingParams from framework.params.types import TestPmdParamsDict -from framework.test_suite import BaseConfig, TestSuite, perf_test class Config(BaseConfig): diff --git a/dts/tests/TestSuite_smoke_tests.py b/dts/tests/TestSuite_smoke_tests.py index 656e2e4bb7..b3eb325fc0 100644 --- a/dts/tests/TestSuite_smoke_tests.py +++ b/dts/tests/TestSuite_smoke_tests.py @@ -19,12 +19,12 @@ requires_link_topology, ) from api.test import verify +from api.test_suite import TestSuite, func_test from api.testbed_model.linux_session import LinuxSession from api.testpmd import TestPmd from api.utils import REGEX_FOR_PCI_ADDRESS from framework.config.node import PortConfig from framework.settings import SETTINGS -from framework.test_suite import TestSuite, func_test @requires_link_topology(LinkTopology.NO_LINK) diff --git a/dts/tests/TestSuite_softnic.py b/dts/tests/TestSuite_softnic.py index 91a6d4eb9f..05a6d3aa18 100644 --- a/dts/tests/TestSuite_softnic.py +++ b/dts/tests/TestSuite_softnic.py @@ -18,11 +18,11 @@ match_all_packets, send_packets_and_capture, ) +from api.test_suite import TestSuite, func_test from api.testbed_model.virtual_device import VirtualDevice from api.testpmd import TestPmd from api.testpmd.config import EthPeer from api.utils import generate_random_packets -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PHYSICAL_FUNCTION) diff --git a/dts/tests/TestSuite_speed_capabilities.py b/dts/tests/TestSuite_speed_capabilities.py index 9cbd6f1ef7..c9b0f74feb 100644 --- a/dts/tests/TestSuite_speed_capabilities.py +++ b/dts/tests/TestSuite_speed_capabilities.py @@ -13,8 +13,8 @@ requires_link_topology, ) from api.test import verify +from api.test_suite import BaseConfig, TestSuite, func_test from api.testpmd import TestPmd -from framework.test_suite import BaseConfig, TestSuite, func_test class Config(BaseConfig): diff --git a/dts/tests/TestSuite_unified_packet.py b/dts/tests/TestSuite_unified_packet.py index fcc7f7fbbb..bf3654f0d7 100644 --- a/dts/tests/TestSuite_unified_packet.py +++ b/dts/tests/TestSuite_unified_packet.py @@ -25,10 +25,10 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes from api.testpmd.types import RtePTypes, TestPmdVerbosePacket -from framework.test_suite import TestSuite, func_test class TestUnifiedPacket(TestSuite): diff --git a/dts/tests/TestSuite_virtio_forward.py b/dts/tests/TestSuite_virtio_forward.py index 06bcd86ee4..a16299d908 100644 --- a/dts/tests/TestSuite_virtio_forward.py +++ b/dts/tests/TestSuite_virtio_forward.py @@ -12,12 +12,12 @@ from api.capabilities import LinkTopology from api.packet import send_packets_and_capture from api.test import log, verify +from api.test_suite import TestSuite, func_test from api.testbed_model.capability import requires from api.testbed_model.linux_session import LinuxSession from api.testbed_model.virtual_device import VirtualDevice from api.testpmd import TestPmd from api.testpmd.config import PortTopology, SimpleForwardingModes -from framework.test_suite import TestSuite, func_test class TestVirtioForward(TestSuite): diff --git a/dts/tests/TestSuite_vlan.py b/dts/tests/TestSuite_vlan.py index 898673fc86..975e87b128 100644 --- a/dts/tests/TestSuite_vlan.py +++ b/dts/tests/TestSuite_vlan.py @@ -23,9 +23,9 @@ ) from api.packet import send_packet_and_capture from api.test import verify +from api.test_suite import TestSuite, func_test from api.testpmd import TestPmd from api.testpmd.config import SimpleForwardingModes -from framework.test_suite import TestSuite, func_test @requires_nic_capability(NicCapability.PORT_RX_OFFLOAD_VLAN_FILTER) -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* Re: [PATCH v7 5/7] dts: move test suite module from framework to API 2026-08-07 16:16 ` [PATCH v7 5/7] dts: move test suite module " Andrew Bailey @ 2026-08-20 13:55 ` Luca Vizzarro 0 siblings, 0 replies; 47+ messages in thread From: Luca Vizzarro @ 2026-08-20 13:55 UTC (permalink / raw) To: Andrew Bailey, dev, patrickrobb1997; +Cc: knimoji, lylavoie, dladd, Dean Marx I think this is ok as it's mostly defining what a test suite is. ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v7 6/7] dts: move params directory from framework to API 2026-08-07 16:16 ` [PATCH v7 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (4 preceding siblings ...) 2026-08-07 16:16 ` [PATCH v7 5/7] dts: move test suite module " Andrew Bailey @ 2026-08-07 16:16 ` Andrew Bailey 2026-08-20 13:56 ` Luca Vizzarro 2026-08-07 16:16 ` [PATCH v7 7/7] dts: separate Linux session into interface and logic Andrew Bailey 2026-08-20 14:04 ` [PATCH v7 0/7] dts: remove imports from framework in test suites Luca Vizzarro 7 siblings, 1 reply; 47+ messages in thread From: Andrew Bailey @ 2026-08-07 16:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx The params directory is imported in test suites such as packet capture to use as a base class for dumpcap. Move this to the API. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- .../{framework.params.eal.rst => api.params.eal.rst} | 2 +- doc/api/dts/{framework.params.rst => api.params.rst} | 6 +++--- ...framework.params.types.rst => api.params.types.rst} | 2 +- doc/api/dts/index.rst | 2 +- dts/api/cryptodev/__init__.py | 2 +- dts/api/cryptodev/config.py | 4 ++-- dts/{framework => api}/params/__init__.py | 0 dts/{framework => api}/params/eal.py | 2 +- dts/{framework => api}/params/types.py | 10 +++++++--- dts/api/testpmd/__init__.py | 7 ++++++- dts/api/testpmd/config.py | 6 +++--- dts/framework/remote_session/blocking_app.py | 4 ++-- dts/framework/remote_session/dpdk.py | 2 +- dts/framework/remote_session/dpdk_shell.py | 2 +- dts/framework/remote_session/interactive_shell.py | 2 +- dts/tests/TestSuite_packet_capture.py | 2 +- dts/tests/TestSuite_single_core_forward_perf.py | 2 +- 17 files changed, 33 insertions(+), 24 deletions(-) rename doc/api/dts/{framework.params.eal.rst => api.params.eal.rst} (79%) rename doc/api/dts/{framework.params.rst => api.params.rst} (71%) rename doc/api/dts/{framework.params.types.rst => api.params.types.rst} (80%) rename dts/{framework => api}/params/__init__.py (100%) rename dts/{framework => api}/params/eal.py (97%) rename dts/{framework => api}/params/types.py (96%) diff --git a/doc/api/dts/framework.params.eal.rst b/doc/api/dts/api.params.eal.rst similarity index 79% rename from doc/api/dts/framework.params.eal.rst rename to doc/api/dts/api.params.eal.rst index 6999b00233..4531cb1fe1 100644 --- a/doc/api/dts/framework.params.eal.rst +++ b/doc/api/dts/api.params.eal.rst @@ -3,6 +3,6 @@ eal - EAL Parameters Modelling ============================== -.. automodule:: framework.params.eal +.. automodule:: api.params.eal :members: :show-inheritance: diff --git a/doc/api/dts/framework.params.rst b/doc/api/dts/api.params.rst similarity index 71% rename from doc/api/dts/framework.params.rst rename to doc/api/dts/api.params.rst index d8c6af9667..3ea7f9215e 100644 --- a/doc/api/dts/framework.params.rst +++ b/doc/api/dts/api.params.rst @@ -3,7 +3,7 @@ params - Command Line Parameters Modelling ========================================== -.. automodule:: framework.params +.. automodule:: api.params :members: :show-inheritance: @@ -11,5 +11,5 @@ params - Command Line Parameters Modelling :hidden: :maxdepth: 1 - framework.params.eal - framework.params.types + api.params.eal + api.params.types diff --git a/doc/api/dts/framework.params.types.rst b/doc/api/dts/api.params.types.rst similarity index 80% rename from doc/api/dts/framework.params.types.rst rename to doc/api/dts/api.params.types.rst index 6d609038be..4754b3a665 100644 --- a/doc/api/dts/framework.params.types.rst +++ b/doc/api/dts/api.params.types.rst @@ -3,6 +3,6 @@ params.types - Parameters Modelling Types ========================================= -.. automodule:: framework.params.types +.. automodule:: api.params.types :members: :show-inheritance: diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index 7c282bbba1..e89e782ac0 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -18,7 +18,7 @@ Packages api api.testbed_model framework.remote_session - framework.params + api.params framework.config Modules diff --git a/dts/api/cryptodev/__init__.py b/dts/api/cryptodev/__init__.py index 198607696f..496079c2af 100644 --- a/dts/api/cryptodev/__init__.py +++ b/dts/api/cryptodev/__init__.py @@ -27,7 +27,7 @@ from framework.remote_session.dpdk_shell import compute_eal_params if TYPE_CHECKING: - from framework.params.types import CryptoPmdParamsDict + from api.params.types import CryptoPmdParamsDict from pathlib import PurePath diff --git a/dts/api/cryptodev/config.py b/dts/api/cryptodev/config.py index a88e70d45c..3420c2fe91 100644 --- a/dts/api/cryptodev/config.py +++ b/dts/api/cryptodev/config.py @@ -6,9 +6,9 @@ from enum import auto from typing import Literal +from api.params import Params, Switch +from api.params.eal import EalParams from api.utils import StrEnum -from framework.params import Params, Switch -from framework.params.eal import EalParams Silent = Literal[""] diff --git a/dts/framework/params/__init__.py b/dts/api/params/__init__.py similarity index 100% rename from dts/framework/params/__init__.py rename to dts/api/params/__init__.py diff --git a/dts/framework/params/eal.py b/dts/api/params/eal.py similarity index 97% rename from dts/framework/params/eal.py rename to dts/api/params/eal.py index 86bfd3fcc6..64fa45ae12 100644 --- a/dts/framework/params/eal.py +++ b/dts/api/params/eal.py @@ -6,9 +6,9 @@ from dataclasses import dataclass, field from typing import TYPE_CHECKING, Literal +from api.params import Params, Switch from api.testbed_model.cpu import LogicalCoreList from api.testbed_model.virtual_device import VirtualDevice -from framework.params import Params, Switch if TYPE_CHECKING: from api.testbed_model.port import Port diff --git a/dts/framework/params/types.py b/dts/api/params/types.py similarity index 96% rename from dts/framework/params/types.py rename to dts/api/params/types.py index f9a51963a2..c4b718eebe 100644 --- a/dts/framework/params/types.py +++ b/dts/api/params/types.py @@ -12,8 +12,10 @@ def create_testpmd(**kwargs: Unpack[TestPmdParamsDict]): params = TestPmdParams(**kwargs) """ +from __future__ import annotations + from pathlib import PurePath -from typing import TypedDict +from typing import TYPE_CHECKING, TypedDict from api.cryptodev.config import ( AeadAlgName, @@ -56,8 +58,10 @@ def create_testpmd(**kwargs: Unpack[TestPmdParamsDict]): TXRingParams, TxUDPPortPair, ) -from api.testpmd.types import RxOffloadCapability, TxOffloadCapability -from framework.params import Switch, YesNoSwitch + +if TYPE_CHECKING: + from api.testpmd.types import RxOffloadCapability, TxOffloadCapability +from api.params import Switch, YesNoSwitch class EalParamsDict(TypedDict, total=False): diff --git a/dts/api/testpmd/__init__.py b/dts/api/testpmd/__init__.py index ce41408eb6..33504640e3 100644 --- a/dts/api/testpmd/__init__.py +++ b/dts/api/testpmd/__init__.py @@ -14,6 +14,8 @@ testpmd.close() """ +from __future__ import annotations + import functools import re import time @@ -21,6 +23,7 @@ from enum import Flag from pathlib import PurePath from typing import ( + TYPE_CHECKING, Any, Callable, ClassVar, @@ -56,7 +59,9 @@ TxOffloadConfiguration, VLANOffloadFlag, ) -from framework.params.types import TestPmdParamsDict + +if TYPE_CHECKING: + from api.params.types import TestPmdParamsDict from framework.remote_session.dpdk_shell import DPDKShell from framework.remote_session.interactive_shell import only_active from framework.settings import SETTINGS diff --git a/dts/api/testpmd/config.py b/dts/api/testpmd/config.py index 3850a4eb8a..c72c1b2c90 100644 --- a/dts/api/testpmd/config.py +++ b/dts/api/testpmd/config.py @@ -13,8 +13,7 @@ from pathlib import PurePath from typing import Literal, NamedTuple -from api.utils import StrEnum -from framework.params import ( +from api.params import ( Params, Switch, YesNoSwitch, @@ -25,7 +24,8 @@ modify_str, str_from_flag_value, ) -from framework.params.eal import EalParams +from api.params.eal import EalParams +from api.utils import StrEnum from .types import RxOffloadCapability, TxOffloadCapability diff --git a/dts/framework/remote_session/blocking_app.py b/dts/framework/remote_session/blocking_app.py index 84db3974b1..537d937eca 100644 --- a/dts/framework/remote_session/blocking_app.py +++ b/dts/framework/remote_session/blocking_app.py @@ -31,9 +31,9 @@ from typing_extensions import Self from api.context import get_ctx +from api.params import Params +from api.params.eal import EalParams from api.testbed_model.node import Node -from framework.params import Params -from framework.params.eal import EalParams from framework.remote_session.dpdk_shell import compute_eal_params from framework.remote_session.interactive_shell import InteractiveShell diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index c02c68af77..4de61ece68 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -16,6 +16,7 @@ from api.capabilities import LinkTopology from api.context import get_ctx from api.exception import ConfigurationError, RemoteFileNotFoundError +from api.params.eal import EalParams from api.testbed_model.cpu import LogicalCore, LogicalCoreCount, LogicalCoreList, lcore_filter from api.testbed_model.node import Node from api.testbed_model.os_session import OSSession @@ -33,7 +34,6 @@ RemoteDPDKTreeLocation, ) from framework.logger import DTSLogger, get_dts_logger -from framework.params.eal import EalParams from framework.remote_session.remote_session import CommandResult diff --git a/dts/framework/remote_session/dpdk_shell.py b/dts/framework/remote_session/dpdk_shell.py index b807f9bdae..61cc4687f3 100644 --- a/dts/framework/remote_session/dpdk_shell.py +++ b/dts/framework/remote_session/dpdk_shell.py @@ -11,8 +11,8 @@ from pathlib import PurePath from api.context import get_ctx +from api.params.eal import EalParams from api.testbed_model.cpu import LogicalCoreList -from framework.params.eal import EalParams from framework.remote_session.interactive_shell import ( InteractiveShell, only_active, diff --git a/dts/framework/remote_session/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index 831861a9ac..f9b7a7720d 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -35,9 +35,9 @@ InteractiveSSHSessionDeadError, InteractiveSSHTimeoutError, ) +from api.params import Params from api.testbed_model.node import Node from framework.logger import DTSLogger, get_dts_logger -from framework.params import Params from framework.settings import SETTINGS P = ParamSpec("P") diff --git a/dts/tests/TestSuite_packet_capture.py b/dts/tests/TestSuite_packet_capture.py index fd5cef5268..ba67c9e1c6 100644 --- a/dts/tests/TestSuite_packet_capture.py +++ b/dts/tests/TestSuite_packet_capture.py @@ -35,6 +35,7 @@ match_all_packets, send_packets_and_capture, ) +from api.params import Params from api.test import verify from api.test_suite import TestSuite, func_test from api.testbed_model.cpu import LogicalCoreList @@ -42,7 +43,6 @@ PacketFilteringConfig, ) from api.testpmd import TestPmd -from framework.params import Params from framework.remote_session.blocking_app import BlockingApp from framework.remote_session.dpdk_shell import compute_eal_params diff --git a/dts/tests/TestSuite_single_core_forward_perf.py b/dts/tests/TestSuite_single_core_forward_perf.py index f51ff76c4c..4b22c5d091 100644 --- a/dts/tests/TestSuite_single_core_forward_perf.py +++ b/dts/tests/TestSuite_single_core_forward_perf.py @@ -21,11 +21,11 @@ requires_link_topology, ) from api.packet import assess_performance_by_packet +from api.params.types import TestPmdParamsDict from api.test import verify, write_performance_json from api.test_suite import BaseConfig, TestSuite, perf_test from api.testpmd import TestPmd from api.testpmd.config import RXRingParams, TXRingParams -from framework.params.types import TestPmdParamsDict class Config(BaseConfig): -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* Re: [PATCH v7 6/7] dts: move params directory from framework to API 2026-08-07 16:16 ` [PATCH v7 6/7] dts: move params directory " Andrew Bailey @ 2026-08-20 13:56 ` Luca Vizzarro 0 siblings, 0 replies; 47+ messages in thread From: Luca Vizzarro @ 2026-08-20 13:56 UTC (permalink / raw) To: Andrew Bailey, dev, patrickrobb1997; +Cc: knimoji, lylavoie, dladd, Dean Marx This looks good, thanks. ^ permalink raw reply [flat|nested] 47+ messages in thread
* [PATCH v7 7/7] dts: separate Linux session into interface and logic 2026-08-07 16:16 ` [PATCH v7 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (5 preceding siblings ...) 2026-08-07 16:16 ` [PATCH v7 6/7] dts: move params directory " Andrew Bailey @ 2026-08-07 16:16 ` Andrew Bailey 2026-08-20 14:03 ` Luca Vizzarro 2026-08-20 14:04 ` [PATCH v7 0/7] dts: remove imports from framework in test suites Luca Vizzarro 7 siblings, 1 reply; 47+ messages in thread From: Andrew Bailey @ 2026-08-07 16:16 UTC (permalink / raw) To: dev, luca.vizzarro, patrickrobb1997 Cc: knimoji, lylavoie, dladd, Andrew Bailey, Dean Marx Separate Linux session into an interface for the API, and a logical module in the framework. Signed-off-by: Dean Marx <dmarx@iol.unh.edu> Signed-off-by: Andrew Bailey <abailey@iol.unh.edu> --- doc/api/dts/framework.linux_session.rst | 9 + doc/api/dts/index.rst | 1 + dts/api/testbed_model/linux_session.py | 457 +---------------------- dts/api/testbed_model/node.py | 2 +- dts/framework/linux_session.py | 461 ++++++++++++++++++++++++ 5 files changed, 491 insertions(+), 439 deletions(-) create mode 100644 doc/api/dts/framework.linux_session.rst create mode 100644 dts/framework/linux_session.py diff --git a/doc/api/dts/framework.linux_session.rst b/doc/api/dts/framework.linux_session.rst new file mode 100644 index 0000000000..95a4fca977 --- /dev/null +++ b/doc/api/dts/framework.linux_session.rst @@ -0,0 +1,9 @@ +.. SPDX-License-Identifier: BSD-3-Clause + +framework.linux\_session +======================== + +.. automodule:: framework.linux_session + :members: + :show-inheritance: + diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst index e89e782ac0..14d12eb038 100644 --- a/doc/api/dts/index.rst +++ b/doc/api/dts/index.rst @@ -35,6 +35,7 @@ Modules api.context framework.logger framework.parser + framework.linux_session api.utils api.exception diff --git a/dts/api/testbed_model/linux_session.py b/dts/api/testbed_model/linux_session.py index 399968efd4..cf988d4d03 100644 --- a/dts/api/testbed_model/linux_session.py +++ b/dts/api/testbed_model/linux_session.py @@ -9,454 +9,35 @@ This intermediate module implements the common parts of mostly POSIX compliant distributions. """ -import json -import re -from collections.abc import Iterable -from functools import cached_property +from abc import ABC, abstractmethod from pathlib import PurePath -from typing import TypedDict -from typing_extensions import NotRequired -from api.exception import ( - ConfigurationError, - InternalError, - RemoteCommandExecutionError, -) -from api.testbed_model.port import PortInfo -from api.utils import expand_range - -from .cpu import LogicalCore -from .port import Port -from .posix_session import PosixSession - - -class LshwConfigurationOutput(TypedDict): - """The relevant parts of ``lshw``'s ``configuration`` section.""" - - #: - driver: str - #: - link: str - #: - firmware: str - - -class LshwOutput(TypedDict): - """A model of the relevant information from ``lshw``'s json output. - - Example: - :: - - { - ... - "businfo" : "pci@0000:08:00.0", - "logicalname" : "enp8s0", - "version" : "00", - "serial" : "52:54:00:59:e1:ac", - ... - "configuration" : { - ... - "link" : "yes", - ... - }, - ... - """ - - #: - vendor: NotRequired[str] - #: - product: NotRequired[str] - #: - version: NotRequired[str] - #: - businfo: str - #: - logicalname: NotRequired[str] - #: - serial: NotRequired[str] - #: - configuration: LshwConfigurationOutput - - -class LinuxSession(PosixSession): +class LinuxSession(ABC): """The implementation of non-Posix compliant parts of Linux.""" - @staticmethod - def _get_privileged_command(command: str) -> str: - command = command.replace(r"'", r"\'") - return f"sudo -- sh -c '{command}'" - - def get_remote_cpus(self) -> list[LogicalCore]: - """Overrides :meth:`~.os_session.OSSession.get_remote_cpus`.""" - cpu_info = self.send_command("lscpu -p=CPU,CORE,SOCKET,NODE|grep -v \\#").stdout - lcores = [] - for cpu_line in cpu_info.splitlines(): - lcore, core, socket, node = map(int, cpu_line.split(",")) - lcores.append(LogicalCore(lcore, core, socket, node)) - return lcores - - def get_dpdk_file_prefix(self, dpdk_prefix: str) -> str: - """Overrides :meth:`~.os_session.OSSession.get_dpdk_file_prefix`.""" - return dpdk_prefix - - def setup_hugepages(self, number_of: int, hugepage_size: int, force_first_numa: bool) -> None: - """Overrides :meth:`~.os_session.OSSession.setup_hugepages`. - - Raises: - ConfigurationError: If the given `hugepage_size` is not supported by the OS. - """ - self._logger.info("Getting Hugepage information.") - if ( - f"hugepages-{hugepage_size}kB" - not in self.send_command("ls /sys/kernel/mm/hugepages").stdout - ): - raise ConfigurationError("hugepage size not supported by operating system") - hugepages_total = self._get_hugepages_total(hugepage_size) - self._numa_nodes = self._get_numa_nodes() - - if force_first_numa or hugepages_total < number_of: - # when forcing numa, we need to clear existing hugepages regardless - # of size, so they can be moved to the first numa node - self._configure_huge_pages(number_of, hugepage_size, force_first_numa) - else: - self._logger.info("Hugepages already configured.") - self._mount_huge_pages() - - def _get_hugepages_total(self, hugepage_size: int) -> int: - hugepages_total = self.send_command( - f"cat /sys/kernel/mm/hugepages/hugepages-{hugepage_size}kB/nr_hugepages" - ).stdout - return int(hugepages_total) - - def _get_numa_nodes(self) -> list[int]: - try: - numa_count = self.send_command( - "cat /sys/devices/system/node/online", verify=True - ).stdout - numa_range = expand_range(numa_count) - except RemoteCommandExecutionError: - # the file doesn't exist, meaning the node doesn't support numa - numa_range = [] - return numa_range - - def _mount_huge_pages(self) -> None: - self._logger.info("Re-mounting Hugepages.") - hugapge_fs_cmd = "awk '/hugetlbfs/ { print $2 }' /proc/mounts" - self.send_command(f"umount $({hugapge_fs_cmd})", privileged=True) - result = self.send_command(hugapge_fs_cmd) - if result.stdout == "": - remote_mount_path = "/mnt/huge" - self.send_command(f"mkdir -p {remote_mount_path}", privileged=True) - self.send_command(f"mount -t hugetlbfs nodev {remote_mount_path}", privileged=True) - - def _supports_numa(self) -> bool: - # the system supports numa if self._numa_nodes is non-empty and there are more - # than one numa node (in the latter case it may actually support numa, but - # there's no reason to do any numa specific configuration) - return len(self._numa_nodes) > 1 - - def _configure_huge_pages(self, number_of: int, size: int, force_first_numa: bool) -> None: - self._logger.info("Configuring Hugepages.") - hugepage_config_path = f"/sys/kernel/mm/hugepages/hugepages-{size}kB/nr_hugepages" - if force_first_numa and self._supports_numa(): - # clear non-numa hugepages - self.send_command(f"echo 0 | tee {hugepage_config_path}", privileged=True) - hugepage_config_path = ( - f"/sys/devices/system/node/node{self._numa_nodes[0]}/hugepages" - f"/hugepages-{size}kB/nr_hugepages" - ) - - self.send_command(f"echo {number_of} | tee {hugepage_config_path}", privileged=True) - - def get_port_info(self, pci_address: str) -> PortInfo: - """Overrides :meth:`~.os_session.OSSession.get_port_info`. - - Raises: - ConfigurationError: If the port could not be found. - """ - bus_info = f"pci@{pci_address}" - port = next((port for port in self._lshw_net_info if port.get("businfo") == bus_info), None) - if port is None: - raise ConfigurationError(f"Port {pci_address} could not be found on the node.") - - logical_name = port.get("logicalname", "") - mac_address = port.get("serial", "") - - configuration = port.get("configuration", {}) - driver = configuration.get("driver", "") - is_link_up = configuration.get("link", "down") == "up" - - return PortInfo(mac_address, logical_name, driver, is_link_up) - - def unbind_ports(self, ports: list[Port]): - """Overrides :meth:`~.os_session.OSSession.unbind_ports`. - - The :attr:`~.devbind_script_path` property must be setup in order to call this method. - """ - ports_pci_addrs = " ".join(port.pci for port in ports) - - self.send_command( - f"{self.devbind_script_path} -u --force {ports_pci_addrs}", - privileged=True, - verify=True, - ) - - if self._lshw_net_info: - del self._lshw_net_info - - def get_nic_info(self) -> list[dict[str, str]]: - """Overrides :meth`~.os_session.OSSession.get_nic_info`. - - Raises: - ConfigurationError: If the NIC info could not be found. - """ - port_to_data = { - port.get("businfo"): port for port in self._lshw_net_info if port.get("businfo") - } - - all_nic_info: list[dict[str, str]] = [] - for port in self._config.ports: - pci_addr = port.pci - - lshw_result = self.send_command( - f"sudo lshw -c network -businfo | grep '{pci_addr}' | cut -d'@' -f1" - ) - if lshw_result.return_code != 0 or lshw_result.stdout == "": - raise ConfigurationError(f"Unable to get bus type for port {pci_addr}.") - bus_type = lshw_result.stdout - - bus_info = f"{bus_type}@{pci_addr}" - nic_port: LshwOutput | None = port_to_data[bus_info] - if nic_port is None: - raise ConfigurationError(f"Port {pci_addr} could not be found on the node.") - - config: LshwConfigurationOutput | None = nic_port["configuration"] - if config is None: - raise ConfigurationError( - f"Configuration info for port {pci_addr} could not be found on the node." - ) - - if "logicalname" not in nic_port: - raise ConfigurationError( - f"Logical name for port {pci_addr} could not be found on the node." - ) - - ethtool_result = self.send_command( - f"ethtool {nic_port['logicalname']} | grep 'Speed:' | awk '{{print $2}}'" - ) - if ethtool_result.return_code == 0 and ethtool_result.stdout: - nic_speed = ethtool_result.stdout - else: - self._logger.error(f"Unable to get speed for NIC: {pci_addr}") - nic_speed = None - - dut_json = { - "make": nic_port["vendor"] if "vendor" in nic_port else "Unknown", - "model": nic_port["product"] if "product" in nic_port else "Unknown", - "hardware version": nic_port["version"] if "version" in nic_port else "Unknown", - "firmware version": config["firmware"] if "firmware" in config else "Unknown", - "deviceBusType": bus_type, - "deviceId": nic_port["serial"] if "serial" in nic_port else "Unknown", - "pmd": config["driver"] if "driver" in config else "Unknown", - "speed": nic_speed or "Unknown", - } - all_nic_info.append(dut_json) - - return all_nic_info - - def bind_ports_to_driver(self, ports: list[Port], driver_name: str) -> None: - """Overrides :meth:`~.os_session.OSSession.bind_ports_to_driver`. - - The :attr:`~.devbind_script_path` property must be setup in order to call this method. - """ - ports_pci_addrs = " ".join(port.pci for port in ports) - - self.send_command( - f"{self.devbind_script_path} -b {driver_name} --force {ports_pci_addrs}", - privileged=True, - verify=True, - ) - - del self._lshw_net_info - - def bring_up_link(self, ports: Iterable[Port]) -> None: - """Overrides :meth:`~.os_session.OSSession.bring_up_link`.""" - for port in ports: - self.send_command( - f"ip link set dev {port.logical_name} up", privileged=True, verify=True - ) - - del self._lshw_net_info - + @abstractmethod def set_interface_link_up(self, name: str) -> None: - """Overrides :meth:`~.os_session.OSSession.set_interface_link_up`.""" - self.send_command(f"ip link set dev {name} up", privileged=True, verify=True) - - def delete_interface(self, name: str) -> None: - """Overrides :meth:`~.os_session.OSSession.delete_interface`.""" - self.send_command(f"ip link delete {name}", privileged=True) + """Set the link status of an interface to up. - @cached_property - def devbind_script_path(self) -> PurePath: - """The path to the dpdk-devbind.py script on the node. - - Needs to be manually assigned first in order to be used. - - Raises: - InternalError: If accessed before environment setup. - """ - raise InternalError("Accessed devbind script path before setup.") - - def load_vfio(self, pf_port: Port) -> None: - """Overrides :meth:`~os_session.OSSession,load_vfio`.""" - cmd_result = self.send_command(f"lspci -nn -s {pf_port.pci}") - device = re.search(r":([0-9a-fA-F]{4})\]", cmd_result.stdout) - if device and device.group(1) in ["37c8", "0435", "19e2"]: - self.send_command( - "modprobe -r vfio_iommu_type1; modprobe -r vfio_pci", - privileged=True, - ) - self.send_command( - "modprobe -r vfio_virqfd; modprobe -r vfio", - privileged=True, - ) - self.send_command( - "modprobe vfio-pci disable_denylist=1 enable_sriov=1", privileged=True - ) - self.send_command( - "echo 1 | tee /sys/module/vfio/parameters/enable_unsafe_noiommu_mode", - privileged=True, - ) - else: - self.send_command("modprobe vfio-pci", privileged=True) - self.refresh_lshw() - - def create_crypto_vfs(self, pf_port: list[Port]) -> None: - """Overrides :meth:`~os_session.OSSession.create_crypto_vfs`. - - Raises: - InternalError: If there are existing VFs which have to be deleted. - """ - for port in pf_port: - self.delete_crypto_vfs(port) - for port in pf_port: - sys_bus_path = f"/sys/bus/pci/devices/{port.pci}".replace(":", "\\:") - curr_num_vfs = int( - self.send_command(f"cat {sys_bus_path}/sriov_numvfs", privileged=True).stdout - ) - if 0 < curr_num_vfs: - raise InternalError("There are existing VFs on the port which must be deleted.") - num_vfs = int( - self.send_command(f"cat {sys_bus_path}/sriov_totalvfs", privileged=True).stdout - ) - self.send_command( - f"echo {num_vfs} | sudo tee {sys_bus_path}/sriov_numvfs", privileged=True - ) - - self.refresh_lshw() - - def create_vfs(self, pf_port: Port) -> None: - """Overrides :meth:`~.os_session.OSSession.create_vfs`. - - Raises: - InternalError: If there are existing VFs which have to be deleted. + Args: + name: The name of the interface. """ - sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") - curr_num_vfs = int( - self.send_command(f"cat {sys_bus_path}/sriov_numvfs", privileged=True).stdout - ) - if 0 < curr_num_vfs: - raise InternalError("There are existing VFs on the port which must be deleted.") - if curr_num_vfs == 0: - self.send_command(f"echo 1 | sudo tee {sys_bus_path}/sriov_numvfs", privileged=True) - self.refresh_lshw() - def delete_crypto_vfs(self, pf_port: Port) -> None: - """Overrides :meth:`~.os_session.OSSession.delete_crypto_vfs`. + @abstractmethod + def delete_interface(self, name: str) -> None: + """Delete a virtual interface. - The :attr:`~.devbind_script_path` property must be setup in order to call this method. + Args: + name: the name of the interface to delete. """ - if vfs := self.get_pci_addr_of_crypto_vfs(pf_port): - vf_pci_addrs = " ".join(vf for vf in vfs) - self.send_command( - f"{self.devbind_script_path} -u --force {vf_pci_addrs}", - privileged=True, - verify=True, - ) - self.unbind_ports([pf_port]) - self.send_command( - f"echo 1 | sudo tee /sys/bus/pci/devices/{pf_port.pci}/remove".replace(":", "\\:"), - privileged=True, - ) - self.send_command("echo 1 | sudo tee /sys/bus/pci/rescan", privileged=True) - - def delete_vfs(self, pf_port: Port) -> None: - """Overrides :meth:`~.os_session.OSSession.delete_vfs`.""" - sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") - curr_num_vfs = int( - self.send_command(f"cat {sys_bus_path}/sriov_numvfs", privileged=True).stdout - ) - if curr_num_vfs == 0: - self._logger.debug(f"No VFs found on port {pf_port.pci}, skipping deletion") - else: - self.send_command(f"echo 0 | sudo tee {sys_bus_path}/sriov_numvfs", privileged=True) - - def get_pci_addr_of_crypto_vfs(self, pf_port: Port) -> list[str]: - """Overrides :meth:`~.os_session.OSSession.get_pci_addr_of_crypto_vfs`.""" - sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") - curr_num_vfs = int(self.send_command(f"cat {sys_bus_path}/sriov_numvfs").stdout) - if curr_num_vfs > 0: - pci_addrs = self.send_command( - f"readlink {sys_bus_path}/virtfn*", - privileged=True, - ) - return [pci.replace("../", "") for pci in pci_addrs.stdout.splitlines()] - return [] - - def get_pci_addr_of_vfs(self, pf_port: Port) -> list[str]: - """Overrides :meth:`~.os_session.OSSession.get_pci_addr_of_vfs`.""" - sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") - curr_num_vfs = int(self.send_command(f"cat {sys_bus_path}/sriov_numvfs").stdout) - if curr_num_vfs > 0: - pci_addrs = self.send_command( - 'awk -F "PCI_SLOT_NAME=" "/PCI_SLOT_NAME=/ {print \\$2}" ' - + f"{sys_bus_path}/virtfn*/uevent", - privileged=True, - ) - return pci_addrs.stdout.splitlines() - else: - return [] - @cached_property - def _lshw_net_info(self) -> list[LshwOutput]: - output = self.send_command("lshw -quiet -json -C network", verify=True) - return json.loads(output.stdout) - - def refresh_lshw(self) -> None: - """Force refresh of cached lshw network info.""" - if "_lshw_net_info" in self.__dict__: - del self.__dict__["_lshw_net_info"] - _ = self._lshw_net_info - - def _update_port_attr(self, port: Port, attr_value: str | None, attr_name: str) -> None: - if attr_value: - setattr(port, attr_name, attr_value) - self._logger.debug(f"Found '{attr_name}' of port {port.pci}: '{attr_value}'.") - else: - self._logger.warning( - f"Attempted to get '{attr_name}' of port {port.pci}, but it doesn't exist." - ) - - def configure_port_mtu(self, mtu: int, port: Port) -> None: - """Overrides :meth:`~.os_session.OSSession.configure_port_mtu`.""" - self.send_command( - f"ip link set dev {port.logical_name} mtu {mtu}", - privileged=True, - verify=True, - ) + @property + @abstractmethod + def devbind_script_path(self) -> PurePath: + """The path to the dpdk-devbind.py script on the node.""" - def configure_ipv4_forwarding(self, enable: bool) -> None: - """Overrides :meth:`~.os_session.OSSession.configure_ipv4_forwarding`.""" - state = 1 if enable else 0 - self.send_command(f"sysctl -w net.ipv4.ip_forward={state}", privileged=True) + @devbind_script_path.setter + @abstractmethod + def devbind_script_path(self, value: PurePath): + """Set the devbind script path after environment setup.""" diff --git a/dts/api/testbed_model/node.py b/dts/api/testbed_model/node.py index 40dd7f0666..ae9886e531 100644 --- a/dts/api/testbed_model/node.py +++ b/dts/api/testbed_model/node.py @@ -22,10 +22,10 @@ OS, NodeConfiguration, ) +from framework.linux_session import LinuxSession from framework.logger import DTSLogger, get_dts_logger from .cpu import Architecture, LogicalCore -from .linux_session import LinuxSession from .os_session import OSSession, OSSessionInfo from .port import Port diff --git a/dts/framework/linux_session.py b/dts/framework/linux_session.py new file mode 100644 index 0000000000..812e03b8e9 --- /dev/null +++ b/dts/framework/linux_session.py @@ -0,0 +1,461 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2023 PANTHEON.tech s.r.o. +# Copyright(c) 2023 University of New Hampshire + +"""Linux OS translator. + +Translate OS-unaware calls into Linux calls/utilities. Most of Linux distributions are mostly +compliant with POSIX standards, so this module only implements the parts that aren't. +This intermediate module implements the common parts of mostly POSIX compliant distributions. +""" + +import json +import re +from collections.abc import Iterable +from functools import cached_property +from pathlib import PurePath +from typing import TypedDict + +from typing_extensions import NotRequired + +from api.exception import ( + ConfigurationError, + InternalError, + RemoteCommandExecutionError, +) +from api.testbed_model.cpu import LogicalCore +from api.testbed_model.linux_session import LinuxSession as LinuxSessionBase +from api.testbed_model.port import Port, PortInfo +from api.testbed_model.posix_session import PosixSession +from api.utils import expand_range + + +class LshwConfigurationOutput(TypedDict): + """The relevant parts of ``lshw``'s ``configuration`` section.""" + + #: + driver: str + #: + link: str + #: + firmware: str + + +class LshwOutput(TypedDict): + """A model of the relevant information from ``lshw``'s json output. + + Example: + :: + + { + ... + "businfo" : "pci@0000:08:00.0", + "logicalname" : "enp8s0", + "version" : "00", + "serial" : "52:54:00:59:e1:ac", + ... + "configuration" : { + ... + "link" : "yes", + ... + }, + ... + """ + + #: + vendor: NotRequired[str] + #: + product: NotRequired[str] + #: + version: NotRequired[str] + #: + businfo: str + #: + logicalname: NotRequired[str] + #: + serial: NotRequired[str] + #: + configuration: LshwConfigurationOutput + + +class LinuxSession(PosixSession, LinuxSessionBase): + """The implementation of non-Posix compliant parts of Linux.""" + + @staticmethod + def _get_privileged_command(command: str) -> str: + command = command.replace(r"'", r"\'") + return f"sudo -- sh -c '{command}'" + + def get_remote_cpus(self) -> list[LogicalCore]: + """Overrides :meth:`~.os_session.OSSession.get_remote_cpus`.""" + cpu_info = self.send_command("lscpu -p=CPU,CORE,SOCKET,NODE|grep -v \\#").stdout + lcores = [] + for cpu_line in cpu_info.splitlines(): + lcore, core, socket, node = map(int, cpu_line.split(",")) + lcores.append(LogicalCore(lcore, core, socket, node)) + return lcores + + def get_dpdk_file_prefix(self, dpdk_prefix: str) -> str: + """Overrides :meth:`~.os_session.OSSession.get_dpdk_file_prefix`.""" + return dpdk_prefix + + def setup_hugepages(self, number_of: int, hugepage_size: int, force_first_numa: bool) -> None: + """Overrides :meth:`~.os_session.OSSession.setup_hugepages`. + + Raises: + ConfigurationError: If the given `hugepage_size` is not supported by the OS. + """ + self._logger.info("Getting Hugepage information.") + if ( + f"hugepages-{hugepage_size}kB" + not in self.send_command("ls /sys/kernel/mm/hugepages").stdout + ): + raise ConfigurationError("hugepage size not supported by operating system") + hugepages_total = self._get_hugepages_total(hugepage_size) + self._numa_nodes = self._get_numa_nodes() + + if force_first_numa or hugepages_total < number_of: + # when forcing numa, we need to clear existing hugepages regardless + # of size, so they can be moved to the first numa node + self._configure_huge_pages(number_of, hugepage_size, force_first_numa) + else: + self._logger.info("Hugepages already configured.") + self._mount_huge_pages() + + def _get_hugepages_total(self, hugepage_size: int) -> int: + hugepages_total = self.send_command( + f"cat /sys/kernel/mm/hugepages/hugepages-{hugepage_size}kB/nr_hugepages" + ).stdout + return int(hugepages_total) + + def _get_numa_nodes(self) -> list[int]: + try: + numa_count = self.send_command( + "cat /sys/devices/system/node/online", verify=True + ).stdout + numa_range = expand_range(numa_count) + except RemoteCommandExecutionError: + # the file doesn't exist, meaning the node doesn't support numa + numa_range = [] + return numa_range + + def _mount_huge_pages(self) -> None: + self._logger.info("Re-mounting Hugepages.") + hugapge_fs_cmd = "awk '/hugetlbfs/ { print $2 }' /proc/mounts" + self.send_command(f"umount $({hugapge_fs_cmd})", privileged=True) + result = self.send_command(hugapge_fs_cmd) + if result.stdout == "": + remote_mount_path = "/mnt/huge" + self.send_command(f"mkdir -p {remote_mount_path}", privileged=True) + self.send_command(f"mount -t hugetlbfs nodev {remote_mount_path}", privileged=True) + + def _supports_numa(self) -> bool: + # the system supports numa if self._numa_nodes is non-empty and there are more + # than one numa node (in the latter case it may actually support numa, but + # there's no reason to do any numa specific configuration) + return len(self._numa_nodes) > 1 + + def _configure_huge_pages(self, number_of: int, size: int, force_first_numa: bool) -> None: + self._logger.info("Configuring Hugepages.") + hugepage_config_path = f"/sys/kernel/mm/hugepages/hugepages-{size}kB/nr_hugepages" + if force_first_numa and self._supports_numa(): + # clear non-numa hugepages + self.send_command(f"echo 0 | tee {hugepage_config_path}", privileged=True) + hugepage_config_path = ( + f"/sys/devices/system/node/node{self._numa_nodes[0]}/hugepages" + f"/hugepages-{size}kB/nr_hugepages" + ) + + self.send_command(f"echo {number_of} | tee {hugepage_config_path}", privileged=True) + + def get_port_info(self, pci_address: str) -> PortInfo: + """Overrides :meth:`~.os_session.OSSession.get_port_info`. + + Raises: + ConfigurationError: If the port could not be found. + """ + bus_info = f"pci@{pci_address}" + port = next((port for port in self._lshw_net_info if port.get("businfo") == bus_info), None) + if port is None: + raise ConfigurationError(f"Port {pci_address} could not be found on the node.") + + logical_name = port.get("logicalname", "") + mac_address = port.get("serial", "") + + configuration = port.get("configuration", {}) + driver = configuration.get("driver", "") + is_link_up = configuration.get("link", "down") == "up" + + return PortInfo(mac_address, logical_name, driver, is_link_up) + + def unbind_ports(self, ports: list[Port]): + """Overrides :meth:`~.os_session.OSSession.unbind_ports`. + + The :attr:`~.devbind_script_path` property must be setup in order to call this method. + """ + ports_pci_addrs = " ".join(port.pci for port in ports) + + self.send_command( + f"{self.devbind_script_path} -u --force {ports_pci_addrs}", + privileged=True, + verify=True, + ) + + if self._lshw_net_info: + del self._lshw_net_info + + def get_nic_info(self) -> list[dict[str, str]]: + """Overrides :meth`~.os_session.OSSession.get_nic_info`. + + Raises: + ConfigurationError: If the NIC info could not be found. + """ + port_to_data = { + port.get("businfo"): port for port in self._lshw_net_info if port.get("businfo") + } + + all_nic_info: list[dict[str, str]] = [] + for port in self._config.ports: + pci_addr = port.pci + + lshw_result = self.send_command( + f"sudo lshw -c network -businfo | grep '{pci_addr}' | cut -d'@' -f1" + ) + if lshw_result.return_code != 0 or lshw_result.stdout == "": + raise ConfigurationError(f"Unable to get bus type for port {pci_addr}.") + bus_type = lshw_result.stdout + + bus_info = f"{bus_type}@{pci_addr}" + nic_port: LshwOutput | None = port_to_data[bus_info] + if nic_port is None: + raise ConfigurationError(f"Port {pci_addr} could not be found on the node.") + + config: LshwConfigurationOutput | None = nic_port["configuration"] + if config is None: + raise ConfigurationError( + f"Configuration info for port {pci_addr} could not be found on the node." + ) + + if "logicalname" not in nic_port: + raise ConfigurationError( + f"Logical name for port {pci_addr} could not be found on the node." + ) + + ethtool_result = self.send_command( + f"ethtool {nic_port['logicalname']} | grep 'Speed:' | awk '{{print $2}}'" + ) + if ethtool_result.return_code == 0 and ethtool_result.stdout: + nic_speed = ethtool_result.stdout + else: + self._logger.error(f"Unable to get speed for NIC: {pci_addr}") + nic_speed = None + + dut_json = { + "make": nic_port["vendor"] if "vendor" in nic_port else "Unknown", + "model": nic_port["product"] if "product" in nic_port else "Unknown", + "hardware version": nic_port["version"] if "version" in nic_port else "Unknown", + "firmware version": config["firmware"] if "firmware" in config else "Unknown", + "deviceBusType": bus_type, + "deviceId": nic_port["serial"] if "serial" in nic_port else "Unknown", + "pmd": config["driver"] if "driver" in config else "Unknown", + "speed": nic_speed or "Unknown", + } + all_nic_info.append(dut_json) + + return all_nic_info + + def bind_ports_to_driver(self, ports: list[Port], driver_name: str) -> None: + """Overrides :meth:`~.os_session.OSSession.bind_ports_to_driver`. + + The :attr:`~.devbind_script_path` property must be setup in order to call this method. + """ + ports_pci_addrs = " ".join(port.pci for port in ports) + + self.send_command( + f"{self.devbind_script_path} -b {driver_name} --force {ports_pci_addrs}", + privileged=True, + verify=True, + ) + + del self._lshw_net_info + + def bring_up_link(self, ports: Iterable[Port]) -> None: + """Overrides :meth:`~.os_session.OSSession.bring_up_link`.""" + for port in ports: + self.send_command( + f"ip link set dev {port.logical_name} up", privileged=True, verify=True + ) + + del self._lshw_net_info + + def set_interface_link_up(self, name: str) -> None: + """Overrides :meth:`~.os_session.OSSession.set_interface_link_up`.""" + self.send_command(f"ip link set dev {name} up", privileged=True, verify=True) + + def delete_interface(self, name: str) -> None: + """Overrides :meth:`~.os_session.OSSession.delete_interface`.""" + self.send_command(f"ip link delete {name}", privileged=True) + + @cached_property + def devbind_script_path(self) -> PurePath: + """The path to the dpdk-devbind.py script on the node. + + Needs to be manually assigned first in order to be used. + + Raises: + InternalError: If accessed before environment setup. + """ + raise InternalError("Accessed devbind script path before setup.") + + def load_vfio(self, pf_port: Port) -> None: + """Overrides :meth:`~os_session.OSSession,load_vfio`.""" + cmd_result = self.send_command(f"lspci -nn -s {pf_port.pci}") + device = re.search(r":([0-9a-fA-F]{4})\]", cmd_result.stdout) + if device and device.group(1) in ["37c8", "0435", "19e2"]: + self.send_command( + "modprobe -r vfio_iommu_type1; modprobe -r vfio_pci", + privileged=True, + ) + self.send_command( + "modprobe -r vfio_virqfd; modprobe -r vfio", + privileged=True, + ) + self.send_command( + "modprobe vfio-pci disable_denylist=1 enable_sriov=1", privileged=True + ) + self.send_command( + "echo 1 | tee /sys/module/vfio/parameters/enable_unsafe_noiommu_mode", + privileged=True, + ) + else: + self.send_command("modprobe vfio-pci", privileged=True) + self.refresh_lshw() + + def create_crypto_vfs(self, pf_port: list[Port]) -> None: + """Overrides :meth:`~os_session.OSSession.create_crypto_vfs`. + + Raises: + InternalError: If there are existing VFs which have to be deleted. + """ + for port in pf_port: + self.delete_crypto_vfs(port) + for port in pf_port: + sys_bus_path = f"/sys/bus/pci/devices/{port.pci}".replace(":", "\\:") + curr_num_vfs = int( + self.send_command(f"cat {sys_bus_path}/sriov_numvfs", privileged=True).stdout + ) + if 0 < curr_num_vfs: + raise InternalError("There are existing VFs on the port which must be deleted.") + num_vfs = int( + self.send_command(f"cat {sys_bus_path}/sriov_totalvfs", privileged=True).stdout + ) + self.send_command( + f"echo {num_vfs} | sudo tee {sys_bus_path}/sriov_numvfs", privileged=True + ) + + self.refresh_lshw() + + def create_vfs(self, pf_port: Port) -> None: + """Overrides :meth:`~.os_session.OSSession.create_vfs`. + + Raises: + InternalError: If there are existing VFs which have to be deleted. + """ + sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") + curr_num_vfs = int( + self.send_command(f"cat {sys_bus_path}/sriov_numvfs", privileged=True).stdout + ) + if 0 < curr_num_vfs: + raise InternalError("There are existing VFs on the port which must be deleted.") + if curr_num_vfs == 0: + self.send_command(f"echo 1 | sudo tee {sys_bus_path}/sriov_numvfs", privileged=True) + self.refresh_lshw() + + def delete_crypto_vfs(self, pf_port: Port) -> None: + """Overrides :meth:`~.os_session.OSSession.delete_crypto_vfs`. + + The :attr:`~.devbind_script_path` property must be setup in order to call this method. + """ + if vfs := self.get_pci_addr_of_crypto_vfs(pf_port): + vf_pci_addrs = " ".join(vf for vf in vfs) + self.send_command( + f"{self.devbind_script_path} -u --force {vf_pci_addrs}", + privileged=True, + verify=True, + ) + self.unbind_ports([pf_port]) + self.send_command( + f"echo 1 | sudo tee /sys/bus/pci/devices/{pf_port.pci}/remove".replace(":", "\\:"), + privileged=True, + ) + self.send_command("echo 1 | sudo tee /sys/bus/pci/rescan", privileged=True) + + def delete_vfs(self, pf_port: Port) -> None: + """Overrides :meth:`~.os_session.OSSession.delete_vfs`.""" + sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") + curr_num_vfs = int( + self.send_command(f"cat {sys_bus_path}/sriov_numvfs", privileged=True).stdout + ) + if curr_num_vfs == 0: + self._logger.debug(f"No VFs found on port {pf_port.pci}, skipping deletion") + else: + self.send_command(f"echo 0 | sudo tee {sys_bus_path}/sriov_numvfs", privileged=True) + + def get_pci_addr_of_crypto_vfs(self, pf_port: Port) -> list[str]: + """Overrides :meth:`~.os_session.OSSession.get_pci_addr_of_crypto_vfs`.""" + sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") + curr_num_vfs = int(self.send_command(f"cat {sys_bus_path}/sriov_numvfs").stdout) + if curr_num_vfs > 0: + pci_addrs = self.send_command( + f"readlink {sys_bus_path}/virtfn*", + privileged=True, + ) + return [pci.replace("../", "") for pci in pci_addrs.stdout.splitlines()] + return [] + + def get_pci_addr_of_vfs(self, pf_port: Port) -> list[str]: + """Overrides :meth:`~.os_session.OSSession.get_pci_addr_of_vfs`.""" + sys_bus_path = f"/sys/bus/pci/devices/{pf_port.pci}".replace(":", "\\:") + curr_num_vfs = int(self.send_command(f"cat {sys_bus_path}/sriov_numvfs").stdout) + if curr_num_vfs > 0: + pci_addrs = self.send_command( + 'awk -F "PCI_SLOT_NAME=" "/PCI_SLOT_NAME=/ {print \\$2}" ' + + f"{sys_bus_path}/virtfn*/uevent", + privileged=True, + ) + return pci_addrs.stdout.splitlines() + else: + return [] + + @cached_property + def _lshw_net_info(self) -> list[LshwOutput]: + output = self.send_command("lshw -quiet -json -C network", verify=True) + return json.loads(output.stdout) + + def refresh_lshw(self) -> None: + """Force refresh of cached lshw network info.""" + if "_lshw_net_info" in self.__dict__: + del self.__dict__["_lshw_net_info"] + _ = self._lshw_net_info + + def _update_port_attr(self, port: Port, attr_value: str | None, attr_name: str) -> None: + if attr_value: + setattr(port, attr_name, attr_value) + self._logger.debug(f"Found '{attr_name}' of port {port.pci}: '{attr_value}'.") + else: + self._logger.warning( + f"Attempted to get '{attr_name}' of port {port.pci}, but it doesn't exist." + ) + + def configure_port_mtu(self, mtu: int, port: Port) -> None: + """Overrides :meth:`~.os_session.OSSession.configure_port_mtu`.""" + self.send_command( + f"ip link set dev {port.logical_name} mtu {mtu}", + privileged=True, + verify=True, + ) + + def configure_ipv4_forwarding(self, enable: bool) -> None: + """Overrides :meth:`~.os_session.OSSession.configure_ipv4_forwarding`.""" + state = 1 if enable else 0 + self.send_command(f"sysctl -w net.ipv4.ip_forward={state}", privileged=True) -- 2.55.0 ^ permalink raw reply related [flat|nested] 47+ messages in thread
* Re: [PATCH v7 7/7] dts: separate Linux session into interface and logic 2026-08-07 16:16 ` [PATCH v7 7/7] dts: separate Linux session into interface and logic Andrew Bailey @ 2026-08-20 14:03 ` Luca Vizzarro 0 siblings, 0 replies; 47+ messages in thread From: Luca Vizzarro @ 2026-08-20 14:03 UTC (permalink / raw) To: Andrew Bailey, dev, patrickrobb1997; +Cc: knimoji, lylavoie, dladd, Dean Marx This looks like it should've been done with the testbed model refactor? It's a bit confusing to read the changes separately here. It may be best to move linux session to API first and then the rest of the testbed model separately to avoid it being confusing. ^ permalink raw reply [flat|nested] 47+ messages in thread
* Re: [PATCH v7 0/7] dts: remove imports from framework in test suites 2026-08-07 16:16 ` [PATCH v7 0/7] dts: remove imports from framework in test suites Andrew Bailey ` (6 preceding siblings ...) 2026-08-07 16:16 ` [PATCH v7 7/7] dts: separate Linux session into interface and logic Andrew Bailey @ 2026-08-20 14:04 ` Luca Vizzarro 7 siblings, 0 replies; 47+ messages in thread From: Luca Vizzarro @ 2026-08-20 14:04 UTC (permalink / raw) To: Andrew Bailey, dev, patrickrobb1997; +Cc: knimoji, lylavoie, dladd, Dean Marx Hi Andrew, This still needs some refinement. I couldn't give a more thorough review because I can't apply it on main so it also needs some rebasing. I see the CI also fails on the imports, so that also needs fixing. Luca ^ permalink raw reply [flat|nested] 47+ messages in thread
end of thread, other threads:[~2026-08-20 14:05 UTC | newest] Thread overview: 47+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2026-08-06 13:53 [PATCH v5 0/7] dts: remove imports from framework in test suites Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 1/7] dts: move exception module from framework to API Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 2/7] dts: move utils " Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 3/7] dts: move context " Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 4/7] dts: move testbed model " Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 5/7] dts: move test suite module " Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 6/7] dts: move params directory " Andrew Bailey 2026-08-06 13:53 ` [PATCH v5 7/7] dts: separate Linux session into interface and logic Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 1/7] doc: improve 26.07 release notes Andrew Bailey 2026-08-06 17:19 ` Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 2/7] version: 26.07.0 Andrew Bailey 2026-08-06 17:19 ` Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 3/7] version: 26.11.0-rc0 Andrew Bailey 2026-08-06 17:20 ` Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 4/7] ethdev: remove flow metadata symbol aliases Andrew Bailey 2026-08-06 17:20 ` Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 5/7] net/mlx5: remove versioned symbols aliases Andrew Bailey 2026-08-06 17:20 ` Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 6/7] dmadev: fix incomplete configuration validation Andrew Bailey 2026-08-06 17:21 ` Andrew Bailey 2026-08-06 17:16 ` [PATCH v6 7/7] lib: remove ICMP and IPv6 deprecated functions and macros Andrew Bailey 2026-08-06 17:21 ` Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 0/7] dts: remove imports from framework in test suites Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 1/7] dts: move exception module from framework to API Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 2/7] dts: move utils " Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 3/7] dts: move context " Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 4/7] dts: move testbed model " Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 5/7] dts: move test suite module " Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 6/7] dts: move params directory " Andrew Bailey 2026-08-06 17:50 ` [PATCH v6 7/7] dts: separate Linux session into interface and logic Andrew Bailey 2026-08-07 16:16 ` [PATCH v7 0/7] dts: remove imports from framework in test suites Andrew Bailey 2026-08-07 16:16 ` [PATCH v7 1/7] dts: move exception module from framework to API Andrew Bailey 2026-08-20 13:48 ` Luca Vizzarro 2026-08-07 16:16 ` [PATCH v7 2/7] dts: move utils " Andrew Bailey 2026-08-20 13:50 ` Luca Vizzarro 2026-08-07 16:16 ` [PATCH v7 3/7] dts: move context " Andrew Bailey 2026-08-20 13:51 ` Luca Vizzarro 2026-08-07 16:16 ` [PATCH v7 4/7] dts: move testbed model " Andrew Bailey 2026-08-20 13:53 ` Luca Vizzarro 2026-08-07 16:16 ` [PATCH v7 5/7] dts: move test suite module " Andrew Bailey 2026-08-20 13:55 ` Luca Vizzarro 2026-08-07 16:16 ` [PATCH v7 6/7] dts: move params directory " Andrew Bailey 2026-08-20 13:56 ` Luca Vizzarro 2026-08-07 16:16 ` [PATCH v7 7/7] dts: separate Linux session into interface and logic Andrew Bailey 2026-08-20 14:03 ` Luca Vizzarro 2026-08-20 14:04 ` [PATCH v7 0/7] dts: remove imports from framework in test suites Luca Vizzarro
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox