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 <[email protected]> --- .../dts/{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 | 8 ++++++-- 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, 32 insertions(+), 23 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 (97%) 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 1ba8e0d977..bbfe3622c2 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 97% rename from dts/framework/params/types.py rename to dts/api/params/types.py index f2fa69f8b8..2c215cfe54 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,7 +58,9 @@ def create_testpmd(**kwargs: Unpack[TestPmdParamsDict]): TXRingParams, TxUDPPortPair, ) -from framework.params import Switch, YesNoSwitch + +if TYPE_CHECKING: + 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 9f47a15433..85ebe2ea65 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 8b688834ee..96fe5e79fb 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, @@ -24,7 +23,8 @@ modify_str, str_from_flag_value, ) -from framework.params.eal import EalParams +from api.params.eal import EalParams +from api.utils import StrEnum class PortTopology(StrEnum): 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 713a564d25..afdf7526d9 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -15,6 +15,7 @@ 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 @@ -32,7 +33,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 ec539bad95..f7f0669eea 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 f1eb435759..24f2cebf17 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.52.0
