<div dir="ltr">v5 pushed to next-dts, thanks.</div> <div class="gmail_quote gmail_quote_container"><div dir="ltr" class="gmail_attr">On Fri, Sep 5, 2025 at 8:41 AM Andrew Bailey <<a href="mailto:abailey@iol.unh.edu">abailey@iol.unh.edu</a>> wrote: </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Mypy does not check functions and methods that are not entirely type hinted. This prevents full checks, so they have been added where missing. Full checks revealed some typing errors, pattern matching was applied where appropriate to ensure these types were handled properly. Additionally, the linter raised an error "unable to assign to a method" that occurred within a decorator trying to manipulate the str method of a given class. This was changed to use the set_attr function to pass the linter. Signed-off-by: Andrew Bailey <<a href="mailto:abailey@iol.unh.edu" target="_blank">abailey@iol.unh.edu</a>> --- .mailmap | 1 + dts/framework/context.py | 10 +++--- dts/framework/exception.py | 8 ++--- dts/framework/logger.py | 6 ++-- dts/framework/params/__init__.py | 8 ++--- dts/framework/remote_session/dpdk.py | 16 ++++----- dts/framework/remote_session/dpdk_shell.py | 2 +- .../remote_session/interactive_shell.py | 6 ++-- dts/framework/remote_session/python_shell.py | 2 +- .../remote_session/remote_session.py | 2 +- dts/framework/remote_session/shell_pool.py | 10 +++--- dts/framework/remote_session/testpmd_shell.py | 14 ++++---- dts/framework/runner.py | 2 +- dts/framework/settings.py | 11 +++--- dts/framework/test_result.py | 10 +++--- dts/framework/test_run.py | 36 +++++++++---------- dts/framework/test_suite.py | 4 +-- dts/framework/testbed_model/capability.py | 10 +++--- dts/framework/testbed_model/cpu.py | 4 +-- dts/framework/testbed_model/node.py | 2 +- dts/framework/testbed_model/os_session.py | 2 +- dts/framework/testbed_model/port.py | 4 +-- dts/framework/testbed_model/posix_session.py | 2 +- .../testbed_model/traffic_generator/scapy.py | 14 ++++---- .../traffic_generator/traffic_generator.py | 7 ++-- dts/framework/testbed_model/virtual_device.py | 2 +- dts/framework/utils.py | 6 ++-- dts/tests/TestSuite_blocklist.py | 8 ++--- dts/tests/TestSuite_dynamic_queue_conf.py | 8 ++--- ...stSuite_port_restart_config_persistency.py | 2 +- 30 files changed, 113 insertions(+), 106 deletions(-) diff --git a/.mailmap b/.mailmap index d4c04f3b81..7be3d8b76a 100644 --- a/.mailmap +++ b/.mailmap @@ -104,6 +104,7 @@ Andre Muezerie <<a href="mailto:andremue@linux.microsoft.com" target="_blank">andremue@linux.microsoft.com</a>> <<a href="mailto:andremue@microsoft.com" target="_blank">andremue@microsoft.com</a>> Andrea Arcangeli <<a href="mailto:aarcange@redhat.com" target="_blank">aarcange@redhat.com</a>> Andrea Grandi <<a href="mailto:andrea.grandi@intel.com" target="_blank">andrea.grandi@intel.com</a>> Andre Richter <<a href="mailto:andre.o.richter@gmail.com" target="_blank">andre.o.richter@gmail.com</a>> +Andrew Bailey <<a href="mailto:abailey@iol.unh.edu" target="_blank">abailey@iol.unh.edu</a>> Andrew Boyer <<a href="mailto:andrew.boyer@amd.com" target="_blank">andrew.boyer@amd.com</a>> <<a href="mailto:aboyer@pensando.io" target="_blank">aboyer@pensando.io</a>> Andrew Harvey <<a href="mailto:agh@cisco.com" target="_blank">agh@cisco.com</a>> Andrew Jackson <<a href="mailto:ajackson@solarflare.com" target="_blank">ajackson@solarflare.com</a>> diff --git a/dts/framework/context.py b/dts/framework/context.py index 4360bc8699..f98d31d3c1 100644 --- a/dts/framework/context.py +++ b/dts/framework/context.py @@ -4,8 +4,9 @@ """Runtime contexts.""" import functools +from collections.abc import Callable from dataclasses import MISSING, dataclass, field, fields -from typing import TYPE_CHECKING, ParamSpec +from typing import TYPE_CHECKING, Any, ParamSpec from framework.exception import InternalError from framework.remote_session.shell_pool import ShellPool @@ -16,6 +17,7 @@ if TYPE_CHECKING: from framework.remote_session.dpdk import DPDKBuildEnvironment, DPDKRuntimeEnvironment + from framework.testbed_model.capability import TestProtocol from framework.testbed_model.traffic_generator.traffic_generator import TrafficGenerator P = ParamSpec("P") @@ -97,12 +99,12 @@ def init_ctx(ctx: Context) -> None: def filter_cores( specifier: LogicalCoreCount | LogicalCoreList, ascending_cores: bool | None = None -): +) -> Callable[[type["TestProtocol"]], Callable]: """Decorates functions that require a temporary update to the lcore specifier.""" - def decorator(func): + def decorator(func: type["TestProtocol"]) -> Callable: @functools.wraps(func) - def wrapper(*args: P.args, **kwargs: P.kwargs): + def wrapper(*args: P.args, **kwargs: P.kwargs) -> Any: local_ctx = get_ctx().local old_specifier = local_ctx.lcore_filter_specifier diff --git a/dts/framework/exception.py b/dts/framework/exception.py index 47e3fac05c..84d42c7779 100644 --- a/dts/framework/exception.py +++ b/dts/framework/exception.py @@ -59,7 +59,7 @@ class SSHConnectionError(DTSError): _host: str _errors: list[str] - def __init__(self, host: str, errors: list[str] | None = None): + def __init__(self, host: str, errors: list[str] | None = None) -> None: """Define the meaning of the first two arguments. Args: @@ -88,7 +88,7 @@ class _SSHTimeoutError(DTSError): severity: ClassVar[ErrorSeverity] = ErrorSeverity.SSH_ERR _command: str - def __init__(self, command: str): + def __init__(self, command: str) -> None: """Define the meaning of the first argument. Args: @@ -119,7 +119,7 @@ class _SSHSessionDeadError(DTSError): severity: ClassVar[ErrorSeverity] = ErrorSeverity.SSH_ERR _host: str - def __init__(self, host: str): + def __init__(self, host: str) -> None: """Define the meaning of the first argument. Args: @@ -157,7 +157,7 @@ class RemoteCommandExecutionError(DTSError): _command_stderr: str _command_return_code: int - def __init__(self, command: str, command_stderr: str, command_return_code: int): + def __init__(self, command: str, command_stderr: str, command_return_code: int) -> None: """Define the meaning of the first two arguments. Args: diff --git a/dts/framework/logger.py b/dts/framework/logger.py index f43b442bc9..a0c81c3c47 100644 --- a/dts/framework/logger.py +++ b/dts/framework/logger.py @@ -15,7 +15,7 @@ import logging from logging import FileHandler, StreamHandler from pathlib import Path -from typing import ClassVar +from typing import Any, ClassVar date_fmt = "%Y/%m/%d %H:%M:%S" stream_fmt = "%(asctime)s - %(stage)s - %(name)s - %(levelname)s - %(message)s" @@ -36,12 +36,12 @@ class DTSLogger(logging.Logger): _stage: ClassVar[str] = "pre_run" _extra_file_handlers: list[FileHandler] = [] - def __init__(self, *args, **kwargs): + def __init__(self, *args: Any, **kwargs: Any) -> None: """Extend the constructor with extra file handlers.""" self._extra_file_handlers = [] super().__init__(*args, **kwargs) - def makeRecord(self, *args, **kwargs) -> logging.LogRecord: + def makeRecord(self, *args: Any, **kwargs: Any) -> logging.LogRecord: """Generates a record with additional stage information. This is the default method for the :class:`~logging.Logger` class. We extend it diff --git a/dts/framework/params/__init__.py b/dts/framework/params/__init__.py index 1ae227d7b4..e6a2d3c903 100644 --- a/dts/framework/params/__init__.py +++ b/dts/framework/params/__init__.py @@ -25,7 +25,7 @@ T = TypeVar("T") #: Type for a function taking one argument. -FnPtr = Callable[[Any], Any] +FnPtr = Callable[[T], T] #: Type for a switch parameter. Switch = Literal[True, None] #: Type for a yes/no switch parameter. @@ -44,7 +44,7 @@ def _reduce_functions(funcs: Iterable[FnPtr]) -> FnPtr: FnPtr: A function that calls the given functions from left to right. """ - def reduced_fn(value): + def reduced_fn(value: T) -> T: for fn in funcs: value = fn(value) return value @@ -75,8 +75,8 @@ class BitMask(enum.Flag): will allow ``BitMask`` to render as a hexadecimal value. """ - def _class_decorator(original_class): - original_class.__str__ = _reduce_functions(funcs) + def _class_decorator(original_class: T) -> T: + setattr(original_class, "__str__", _reduce_functions(funcs)) return original_class return _class_decorator diff --git a/dts/framework/remote_session/dpdk.py b/dts/framework/remote_session/dpdk.py index 606d6e22fe..7b9c0e89cb 100644 --- a/dts/framework/remote_session/dpdk.py +++ b/dts/framework/remote_session/dpdk.py @@ -62,7 +62,7 @@ class DPDKBuildEnvironment: compiler_version: str | None - def __init__(self, config: DPDKBuildConfiguration, node: Node): + def __init__(self, config: DPDKBuildConfiguration, node: Node) -> None: """DPDK build environment class constructor.""" self.config = config self._node = node @@ -74,7 +74,7 @@ def __init__(self, config: DPDKBuildConfiguration, node: Node): self.compiler_version = None - def setup(self): + def setup(self) -> None: """Set up the DPDK build on the target node. DPDK setup includes setting all internals needed for the build, the copying of DPDK @@ -118,7 +118,7 @@ def teardown(self) -> None: ) self._node.main_session.remove_remote_file(tarball_path) - def _set_remote_dpdk_tree_path(self, dpdk_tree: PurePath): + def _set_remote_dpdk_tree_path(self, dpdk_tree: PurePath) -> None: """Set the path to the remote DPDK source tree based on the provided DPDK location. Verify DPDK source tree existence on the SUT node, if exists sets the @@ -205,7 +205,7 @@ def _prepare_and_extract_dpdk_tarball(self, remote_tarball_path: PurePath) -> No strip_root_dir=True, ) - def _set_remote_dpdk_build_dir(self, build_dir: str): + def _set_remote_dpdk_build_dir(self, build_dir: str) -> None: """Set the `remote_dpdk_build_dir` on the SUT. Check existence on the SUT node and sets the @@ -277,7 +277,7 @@ def remote_dpdk_tree_path(self) -> PurePath: return self._node.tmp_dir.joinpath(self._remote_tmp_dpdk_tree_dir) @property - def remote_dpdk_build_dir(self) -> str | PurePath: + def remote_dpdk_build_dir(self) -> PurePath: """The remote DPDK build dir path.""" if self._remote_dpdk_build_dir: return self._remote_dpdk_build_dir @@ -286,7 +286,7 @@ def remote_dpdk_build_dir(self) -> str | PurePath: "Failed to get remote dpdk build dir because we don't know the " "location on the SUT node." ) - return "" + return PurePath("") @cached_property def dpdk_version(self) -> str | None: @@ -323,7 +323,7 @@ def __init__( config: DPDKRuntimeConfiguration, node: Node, build_env: DPDKBuildEnvironment | None = None, - ): + ) -> None: """DPDK environment constructor. Args: @@ -354,7 +354,7 @@ def __init__( self._ports_bound_to_dpdk = False self._kill_session = None - def setup(self): + def setup(self) -> None: """Set up the DPDK runtime on the target node.""" if self.build: self.build.setup() diff --git a/dts/framework/remote_session/dpdk_shell.py b/dts/framework/remote_session/dpdk_shell.py index d4aa02f39b..51b97d4ff6 100644 --- a/dts/framework/remote_session/dpdk_shell.py +++ b/dts/framework/remote_session/dpdk_shell.py @@ -78,7 +78,7 @@ def __init__( def path(self) -> PurePath: """Relative path to the shell executable from the build folder.""" - def _make_real_path(self): + def _make_real_path(self) -> PurePath: """Overrides :meth:`~.interactive_shell.InteractiveShell._make_real_path`. Adds the remote DPDK build directory to the path. diff --git a/dts/framework/remote_session/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index ba8489eafa..ce93247051 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -24,7 +24,7 @@ from abc import ABC, abstractmethod from collections.abc import Callable from pathlib import PurePath -from typing import ClassVar, Concatenate, ParamSpec, TypeAlias, TypeVar +from typing import Any, ClassVar, Concatenate, ParamSpec, TypeAlias, TypeVar from paramiko import Channel, channel from typing_extensions import Self @@ -126,7 +126,7 @@ def __init__( self._privileged = privileged self._timeout = SETTINGS.timeout - def _setup_ssh_channel(self): + def _setup_ssh_channel(self) -> None: self._ssh_channel = self._node.main_session.interactive_session.session.invoke_shell() self._stdin = self._ssh_channel.makefile_stdin("w") self._stdout = self._ssh_channel.makefile("r") @@ -277,7 +277,7 @@ def __enter__(self) -> Self: self.start_application() return self - def __exit__(self, *_) -> None: + def __exit__(self, *_: Any) -> None: """Exit the context block. Upon exiting a context block with this class, we want to ensure that the instance of the diff --git a/dts/framework/remote_session/python_shell.py b/dts/framework/remote_session/python_shell.py index 5b380a5c7a..5f39a244d6 100644 --- a/dts/framework/remote_session/python_shell.py +++ b/dts/framework/remote_session/python_shell.py @@ -33,6 +33,6 @@ def path(self) -> PurePath: return PurePath("python3") @only_active - def close(self): + def close(self) -> None: """Close Python shell.""" return super().close() diff --git a/dts/framework/remote_session/remote_session.py b/dts/framework/remote_session/remote_session.py index 89d4618c41..f616b92f1c 100644 --- a/dts/framework/remote_session/remote_session.py +++ b/dts/framework/remote_session/remote_session.py @@ -99,7 +99,7 @@ def __init__( node_config: NodeConfiguration, session_name: str, logger: DTSLogger, - ): + ) -> None: """Connect to the node during initialization. Args: diff --git a/dts/framework/remote_session/shell_pool.py b/dts/framework/remote_session/shell_pool.py index da956950d5..241737eab3 100644 --- a/dts/framework/remote_session/shell_pool.py +++ b/dts/framework/remote_session/shell_pool.py @@ -32,7 +32,7 @@ class ShellPool: _logger: DTSLogger _pools: list[set["InteractiveShell"]] - def __init__(self): + def __init__(self) -> None: """Shell pool constructor.""" self._logger = get_dts_logger("shell_pool") self._pools = [set()] @@ -50,12 +50,12 @@ def _current_pool(self) -> set["InteractiveShell"]: """The pool in use for the current scope.""" return self._pools[-1] - def register_shell(self, shell: "InteractiveShell"): + def register_shell(self, shell: "InteractiveShell") -> None: """Register a new shell to the current pool.""" self._logger.debug(f"Registering shell {shell} to pool level {self.pool_level}.") self._current_pool.add(shell) - def unregister_shell(self, shell: "InteractiveShell"): + def unregister_shell(self, shell: "InteractiveShell") -> None: """Unregister a shell from any pool.""" for level, pool in enumerate(self._pools): try: @@ -72,12 +72,12 @@ def unregister_shell(self, shell: "InteractiveShell"): except KeyError: pass - def start_new_pool(self): + def start_new_pool(self) -> None: """Start a new shell pool.""" self._logger.debug(f"Starting new shell pool and advancing to level {self.pool_level+1}.") self._pools.append(set()) - def terminate_current_pool(self): + def terminate_current_pool(self) -> None: """Terminate all the shells in the current pool, and restore the previous pool if any. If any failure occurs while closing any shell, this is tolerated allowing the termination diff --git a/dts/framework/remote_session/testpmd_shell.py b/dts/framework/remote_session/testpmd_shell.py index ad8cb273dc..1df3d5f792 100644 --- a/dts/framework/remote_session/testpmd_shell.py +++ b/dts/framework/remote_session/testpmd_shell.py @@ -64,7 +64,7 @@ class TestPmdDevice: pci_address: str - def __init__(self, pci_address_line: str): + def __init__(self, pci_address_line: str) -> None: """Initialize the device from the testpmd output line string. Args: @@ -90,7 +90,7 @@ class VLANOffloadFlag(Flag): QINQ_STRIP = auto() @classmethod - def from_str_dict(cls, d): + def from_str_dict(cls, d: dict[str, str]) -> Self: """Makes an instance from a dict containing the flag member names with an "on" value. Args: @@ -405,7 +405,7 @@ def make_device_private_info_parser() -> ParserFn: function that parses the device private info from the TestPmd port info output. """ - def _validate(info: str): + def _validate(info: str) -> str | None: info = info.strip() if info == "none" or info.startswith("Invalid file") or info.startswith("Failed to dump"): return None @@ -1449,7 +1449,7 @@ def requires_stopped_ports(func: TestPmdShellMethod) -> TestPmdShellMethod: """ @functools.wraps(func) - def _wrapper(self: "TestPmdShell", *args: P.args, **kwargs: P.kwargs): + def _wrapper(self: "TestPmdShell", *args: P.args, **kwargs: P.kwargs) -> Any: if self.ports_started: self._logger.debug("Ports need to be stopped to continue.") self.stop_all_ports() @@ -1470,7 +1470,7 @@ def requires_started_ports(func: TestPmdShellMethod) -> TestPmdShellMethod: """ @functools.wraps(func) - def _wrapper(self: "TestPmdShell", *args: P.args, **kwargs: P.kwargs): + def _wrapper(self: "TestPmdShell", *args: P.args, **kwargs: P.kwargs) -> Any: if not self.ports_started: self._logger.debug("Ports need to be started to continue.") self.start_all_ports() @@ -1492,7 +1492,7 @@ def add_remove_mtu(mtu: int = 1500) -> Callable[[TestPmdShellMethod], TestPmdShe def decorator(func: TestPmdShellMethod) -> TestPmdShellMethod: @functools.wraps(func) - def wrapper(self: "TestPmdShell", *args: P.args, **kwargs: P.kwargs): + def wrapper(self: "TestPmdShell", *args: P.args, **kwargs: P.kwargs) -> Any: original_mtu = self.ports[0].mtu self.set_port_mtu_all(mtu=mtu, verify=False) retval = func(self, *args, **kwargs) @@ -1644,7 +1644,7 @@ def wait_link_status_up(self, port_id: int, timeout=SETTINGS.timeout) -> bool: self._logger.error(f"The link for port {port_id} did not come up in the given timeout.") return "Link status: up" in port_info - def set_forward_mode(self, mode: SimpleForwardingModes, verify: bool = True): + def set_forward_mode(self, mode: SimpleForwardingModes, verify: bool = True) -> None: """Set packet forwarding mode. Args: diff --git a/dts/framework/runner.py b/dts/framework/runner.py index 0a3d92b0c8..4f2c05bd2f 100644 --- a/dts/framework/runner.py +++ b/dts/framework/runner.py @@ -31,7 +31,7 @@ class DTSRunner: _logger: DTSLogger _result: TestRunResult - def __init__(self): + def __init__(self) -> None: """Initialize the instance with configuration, logger, result and string constants.""" try: self._configuration = load_config(ValidationContext(settings=SETTINGS)) diff --git a/dts/framework/settings.py b/dts/framework/settings.py index 3f21615223..84b627a06a 100644 --- a/dts/framework/settings.py +++ b/dts/framework/settings.py @@ -108,7 +108,7 @@ from argparse import Action, ArgumentDefaultsHelpFormatter, _get_action_name from dataclasses import dataclass, field from pathlib import Path -from typing import Callable +from typing import Callable, NoReturn from pydantic import ValidationError @@ -174,7 +174,7 @@ def _make_env_var_name(action: Action, env_var_name: str | None) -> str: return env_var_name -def _get_env_var_name(action: Action) -> str | None: +def _get_env_var_name(action: Action | None) -> str | None: """Get the environment variable name of the given action.""" return getattr(action, _ENV_VAR_NAME_ATTR, None) @@ -237,12 +237,15 @@ def find_action( return action - def error(self, message): + def error(self, message) -> NoReturn: """Augments :meth:`~argparse.ArgumentParser.error` with environment variable awareness.""" for action in self._actions: if _is_from_env(action): action_name = _get_action_name(action) env_var_name = _get_env_var_name(action) + assert ( + env_var_name is not None + ), "Action was set from environment, but no environment variable name was found." env_var_value = os.environ.get(env_var_name) message = message.replace( @@ -257,7 +260,7 @@ def error(self, message): class _EnvVarHelpFormatter(ArgumentDefaultsHelpFormatter): """Custom formatter to add environment variables to the help page.""" - def _get_help_string(self, action): + def _get_help_string(self, action: Action) -> str | None: """Overrides :meth:`ArgumentDefaultsHelpFormatter._get_help_string`.""" help = super()._get_help_string(action) diff --git a/dts/framework/test_result.py b/dts/framework/test_result.py index 8ce6cc8fbf..c6bddc55a9 100644 --- a/dts/framework/test_result.py +++ b/dts/framework/test_result.py @@ -77,13 +77,13 @@ class ResultLeaf(BaseModel): result: Result reason: DTSError | None = None - def __lt__(self, other): + def __lt__(self, other: object) -> bool: """Compare another instance of the same class by :attr:`~ResultLeaf.result`.""" if isinstance(other, ResultLeaf): return self.result < other.result return True - def __eq__(self, other): + def __eq__(self, other: object) -> bool: """Compare equality with compatible classes by :attr:`~ResultLeaf.result`.""" match other: case ResultLeaf(result=result): @@ -128,7 +128,7 @@ def add_child(self, label: str) -> "ResultNode": self.children.append(child) return child - def mark_result_as(self, result: Result, ex: Exception | None = None) -> None: + def mark_result_as(self, result: Result, ex: BaseException | None = None) -> None: """Mark result for the current step. Args: @@ -149,7 +149,7 @@ def mark_result_as(self, result: Result, ex: Exception | None = None) -> None: self.children.append(ResultLeaf(result=result, reason=reason)) def mark_step_as( - self, step: ExecutionStep, result: Result, ex: Exception | None = None + self, step: ExecutionStep, result: Result, ex: BaseException | None = None ) -> None: """Mark an execution step with the given result. @@ -264,7 +264,7 @@ def serialize_errors(self, execution_errors: list[DTSError]) -> list[str]: """Serialize errors as plain text.""" return [str(err) for err in execution_errors] - def add_error(self, ex: Exception) -> None: + def add_error(self, ex: BaseException) -> None: """Add an execution error to the test run result.""" if isinstance(ex, DTSError): self.execution_errors.append(ex) diff --git a/dts/framework/test_run.py b/dts/framework/test_run.py index 4355aeeb4b..ca9066299e 100644 --- a/dts/framework/test_run.py +++ b/dts/framework/test_run.py @@ -162,7 +162,7 @@ class TestRun: config: TestRunConfiguration logger: DTSLogger - state: "State" + state: Union["State", None] ctx: Context result: TestRunResult selected_tests: list[TestScenario] @@ -178,7 +178,7 @@ def __init__( tests_config: dict[str, BaseConfig], nodes: Iterable[Node], result: TestRunResult, - ): + ) -> None: """Test run constructor. Args: @@ -226,7 +226,7 @@ def required_capabilities(self) -> set[Capability]: return caps - def spin(self): + def spin(self) -> None: """Spin the internal state machine that executes the test run.""" <a href="http://self.logger.info" rel="noreferrer" target="_blank">self.logger.info</a>(f"Running test run with SUT '{<a href="http://self.ctx.sut_node.name" rel="noreferrer" target="_blank">self.ctx.sut_node.name</a>}'.") @@ -258,11 +258,11 @@ class State(Protocol): test_run: TestRun result: TestRunResult | ResultNode - def before(self): + def before(self) -> None: """Hook before the state is processed.""" self.logger.set_stage(self.logger_name, self.log_file_path) - def after(self): + def after(self) -> None: """Hook after the state is processed.""" return @@ -289,12 +289,12 @@ def log_file_path(self) -> Path | None: def next(self) -> Union["State", None]: """Next state.""" - def on_error(self, ex: Exception) -> Union["State", None]: + def on_error(self, ex: BaseException) -> Union["State", None]: """Next state on error.""" - def handle_exception(self, ex: Exception) -> Union["State", None]: + def handle_exception(self, ex: BaseException) -> Union["State", None]: """Handles an exception raised by `next`.""" - next_state = self.on_error(ex) + next_state = self.on_error(Exception(ex)) match ex: case InternalError(): @@ -362,7 +362,7 @@ def next(self) -> State | None: ) return TestRunExecution(test_run, self.result) - def on_error(self, ex: Exception) -> State | None: + def on_error(self, ex: BaseException) -> State | None: """Next state on error.""" self.test_run.result.add_error(ex) return TestRunTeardown(self.test_run, self.result) @@ -411,7 +411,7 @@ def next(self) -> State | None: # No more test suites. We are done here. return TestRunTeardown(test_run, self.result) - def on_error(self, ex: Exception) -> State | None: + def on_error(self, ex: BaseException) -> State | None: """Next state on error.""" self.test_run.result.add_error(ex) return TestRunTeardown(self.test_run, self.result) @@ -443,7 +443,7 @@ def next(self) -> State | None: self.test_run.ctx.sut_node.teardown() return None - def on_error(self, ex: Exception) -> State | None: + def on_error(self, ex: BaseException) -> State | None: """Next state on error.""" self.test_run.result.add_error(ex) self.logger.warning( @@ -491,7 +491,7 @@ def next(self) -> State | None: result=self.result, ) - def on_error(self, ex: Exception) -> State | None: + def on_error(self, ex: BaseException) -> State | None: """Next state on error.""" self.result.mark_step_as("setup", Result.ERROR, ex) return TestSuiteTeardown(self.test_run, self.test_suite, self.result) @@ -543,7 +543,7 @@ def next(self) -> State | None: # No more test cases. We are done here. return TestSuiteTeardown(self.test_run, self.test_suite, self.result) - def on_error(self, ex: Exception) -> State | None: + def on_error(self, ex: BaseException) -> State | None: """Next state on error.""" self.test_run.result.add_error(ex) return TestSuiteTeardown(self.test_run, self.test_suite, self.result) @@ -568,7 +568,7 @@ def next(self) -> State | None: self.result.mark_step_as("teardown", Result.PASS) return TestRunExecution(self.test_run, self.test_run.result) - def on_error(self, ex: Exception) -> State | None: + def on_error(self, ex: BaseException) -> State | None: """Next state on error.""" self.logger.warning( "The environment may have not been cleaned up correctly. " @@ -577,7 +577,7 @@ def on_error(self, ex: Exception) -> State | None: self.result.mark_step_as("teardown", Result.ERROR, ex) return TestRunExecution(self.test_run, self.test_run.result) - def after(self): + def after(self) -> None: """Hook after state is processed.""" if ( self.result.get_overall_result() in [Result.FAIL, Result.ERROR] @@ -633,7 +633,7 @@ def next(self) -> State | None: SETTINGS.re_run, ) - def on_error(self, ex: Exception) -> State | None: + def on_error(self, ex: BaseException) -> State | None: """Next state on error.""" self.result.mark_step_as("setup", Result.ERROR, ex) self.result.mark_result_as(Result.BLOCK) @@ -686,7 +686,7 @@ def next(self) -> State | None: self.result, ) - def on_error(self, ex: Exception) -> State | None: + def on_error(self, ex: BaseException) -> State | None: """Next state on error.""" self.result.mark_result_as(Result.ERROR, ex) return TestCaseTeardown( @@ -720,7 +720,7 @@ def next(self) -> State | None: result=self.result.parent, ) - def on_error(self, ex: Exception) -> State | None: + def on_error(self, ex: BaseException) -> State | None: """Next state on error.""" self.logger.warning( "The environment may have not been cleaned up correctly. " diff --git a/dts/framework/test_suite.py b/dts/framework/test_suite.py index d4e06a567a..5ee5a039d7 100644 --- a/dts/framework/test_suite.py +++ b/dts/framework/test_suite.py @@ -92,7 +92,7 @@ class TestSuite(TestProtocol): _tg_ip_address_ingress: Union[IPv4Interface, IPv6Interface] _tg_ip_address_egress: Union[IPv4Interface, IPv6Interface] - def __init__(self, config: BaseConfig): + def __init__(self, config: BaseConfig) -> None: """Initialize the test suite testbed information and basic configuration. Args: @@ -681,7 +681,7 @@ def class_obj(self) -> type[TestSuite]: InternalError: If the test suite class is missing from the module. """ - def is_test_suite(obj) -> bool: + def is_test_suite(obj: type) -> bool: """Check whether `obj` is a :class:`TestSuite`. The `obj` is a subclass of :class:`TestSuite`, but not :class:`TestSuite` itself. diff --git a/dts/framework/testbed_model/capability.py b/dts/framework/testbed_model/capability.py index f895b22bb3..87be7e6b93 100644 --- a/dts/framework/testbed_model/capability.py +++ b/dts/framework/testbed_model/capability.py @@ -50,7 +50,7 @@ def test_scatter_mbuf_2048(self): from abc import ABC, abstractmethod from collections.abc import MutableSet from dataclasses import dataclass -from typing import TYPE_CHECKING, Callable, ClassVar, Protocol +from typing import TYPE_CHECKING, Any, Callable, ClassVar, Protocol from typing_extensions import Self @@ -374,7 +374,7 @@ def set_required(self, test_case_or_suite: type["TestProtocol"]) -> None: else: self.add_to_required(test_case_or_suite) - def __eq__(self, other) -> bool: + def __eq__(self, other: Any) -> bool: """Compare the :attr:`~TopologyCapability.topology_type`s. Args: @@ -385,7 +385,7 @@ def __eq__(self, other) -> bool: """ return self.topology_type == other.topology_type - def __lt__(self, other) -> bool: + def __lt__(self, other: Any) -> bool: """Compare the :attr:`~TopologyCapability.topology_type`s. Args: @@ -396,7 +396,7 @@ def __lt__(self, other) -> bool: """ return self.topology_type < other.topology_type - def __gt__(self, other) -> bool: + def __gt__(self, other: Any) -> bool: """Compare the :attr:`~TopologyCapability.topology_type`s. Args: @@ -407,7 +407,7 @@ def __gt__(self, other) -> bool: """ return other < self - def __le__(self, other) -> bool: + def __le__(self, other: Any) -> bool: """Compare the :attr:`~TopologyCapability.topology_type`s. Args: diff --git a/dts/framework/testbed_model/cpu.py b/dts/framework/testbed_model/cpu.py index b8bc601c22..6e2ecca080 100644 --- a/dts/framework/testbed_model/cpu.py +++ b/dts/framework/testbed_model/cpu.py @@ -80,7 +80,7 @@ class LogicalCoreList: _lcore_list: list[int] _lcore_str: str - def __init__(self, lcore_list: list[int] | list[str] | list[LogicalCore] | str): + def __init__(self, lcore_list: list[int] | list[str] | list[LogicalCore] | str) -> None: """Process `lcore_list`, then sort. There are four supported logical core list formats:: @@ -169,7 +169,7 @@ def __init__( lcore_list: list[LogicalCore], filter_specifier: LogicalCoreCount | LogicalCoreList, ascending: bool = True, - ): + ) -> None: """Filter according to the input filter specifier. The input `lcore_list` is copied and sorted by physical core before filtering. diff --git a/dts/framework/testbed_model/node.py b/dts/framework/testbed_model/node.py index 35cf6f1452..4f6150f18c 100644 --- a/dts/framework/testbed_model/node.py +++ b/dts/framework/testbed_model/node.py @@ -59,7 +59,7 @@ class Node: _compiler_version: str | None _setup: bool - def __init__(self, node_config: NodeConfiguration): + def __init__(self, node_config: NodeConfiguration) -> None: """Connect to the node and gather info during initialization. Extra gathered information: diff --git a/dts/framework/testbed_model/os_session.py b/dts/framework/testbed_model/os_session.py index b6e03aa83d..b182c3bde4 100644 --- a/dts/framework/testbed_model/os_session.py +++ b/dts/framework/testbed_model/os_session.py @@ -115,7 +115,7 @@ def __init__( node_config: NodeConfiguration, name: str, logger: DTSLogger, - ): + ) -> None: """Initialize the OS-aware session. Connect to the node right away and also create an interactive remote session. diff --git a/dts/framework/testbed_model/port.py b/dts/framework/testbed_model/port.py index fc58e2b993..2c0276971f 100644 --- a/dts/framework/testbed_model/port.py +++ b/dts/framework/testbed_model/port.py @@ -49,7 +49,7 @@ class Port: config: Final[PortConfig] _original_driver: str | None - def __init__(self, node: "Node", config: PortConfig): + def __init__(self, node: "Node", config: PortConfig) -> None: """Initialize the port from `node` and `config`. Args: @@ -128,7 +128,7 @@ def bound_for_dpdk(self) -> bool: """Is the port bound to the driver for DPDK?""" return self.current_driver == self.config.os_driver_for_dpdk - def configure_mtu(self, mtu: int): + def configure_mtu(self, mtu: int) -> None: """Configure the port's MTU value. Args: diff --git a/dts/framework/testbed_model/posix_session.py b/dts/framework/testbed_model/posix_session.py index c71bc93f0b..dec952685a 100644 --- a/dts/framework/testbed_model/posix_session.py +++ b/dts/framework/testbed_model/posix_session.py @@ -183,7 +183,7 @@ def create_remote_tarball( ) -> PurePosixPath: """Overrides :meth:`~.os_session.OSSession.create_remote_tarball`.""" - def generate_tar_exclude_args(exclude_patterns) -> str: + def generate_tar_exclude_args(exclude_patterns: str | list[str] | None) -> str: """Generate args to exclude patterns when creating a tarball. Args: diff --git a/dts/framework/testbed_model/traffic_generator/scapy.py b/dts/framework/testbed_model/traffic_generator/scapy.py index e21ba4ed96..a31807e8e4 100644 --- a/dts/framework/testbed_model/traffic_generator/scapy.py +++ b/dts/framework/testbed_model/traffic_generator/scapy.py @@ -16,7 +16,7 @@ from collections.abc import Callable from queue import Empty, SimpleQueue from threading import Event, Thread -from typing import ClassVar +from typing import Any, ClassVar from scapy.compat import base64_bytes from scapy.data import ETHER_TYPES, IP_PROTOS @@ -57,7 +57,7 @@ class ScapyAsyncSniffer(PythonShell): def __init__( self, node: Node, recv_port: Port, name: str | None = None, privileged: bool = True - ): + ) -> None: """Sniffer constructor. Args: @@ -189,7 +189,7 @@ def close(self) -> None: self._sniffer.join() super().close() - def _sniff(self, recv_port: Port): + def _sniff(self, recv_port: Port) -> None: """Sniff packets and use events and queue to communicate with the main thread. Raises: @@ -229,7 +229,7 @@ def _sniff(self, recv_port: Port): self._logger.debug("Stop sniffing.") self.send_command("\x03") # send Ctrl+C to trigger a KeyboardInterrupt in `sniff`. - def _set_packet_filter(self, filter_config: PacketFilteringConfig): + def _set_packet_filter(self, filter_config: PacketFilteringConfig) -> None: """Make and set a filtering function from `filter_config`. Args: @@ -296,7 +296,7 @@ class also extends :class:`.capturing_traffic_generator.CapturingTrafficGenerato #: Padding to add to the start of a line for python syntax compliance. _python_indentation: ClassVar[str] = " " * 4 - def __init__(self, tg_node: Node, config: ScapyTrafficGeneratorConfig, **kwargs): + def __init__(self, tg_node: Node, config: ScapyTrafficGeneratorConfig, **kwargs: Any) -> None: """Extend the constructor with Scapy TG specifics. Initializes both the traffic generator and the interactive shell used to handle Scapy @@ -315,7 +315,7 @@ def __init__(self, tg_node: Node, config: ScapyTrafficGeneratorConfig, **kwargs) super().__init__(tg_node=tg_node, config=config, **kwargs) - def setup(self, topology: Topology): + def setup(self, topology: Topology) -> None: """Extends :meth:`.traffic_generator.TrafficGenerator.setup`. Binds the TG node ports to the kernel drivers and starts up the async sniffer. @@ -332,7 +332,7 @@ def setup(self, topology: Topology): self._shell.send_command("from scapy.all import *") self._shell.send_command("from scapy.contrib.lldp import *") - def close(self): + def close(self) -> None: """Overrides :meth:`.traffic_generator.TrafficGenerator.close`. Stops the traffic generator and sniffer shells. diff --git a/dts/framework/testbed_model/traffic_generator/traffic_generator.py b/dts/framework/testbed_model/traffic_generator/traffic_generator.py index 8f53b07daf..cac119c183 100644 --- a/dts/framework/testbed_model/traffic_generator/traffic_generator.py +++ b/dts/framework/testbed_model/traffic_generator/traffic_generator.py @@ -9,6 +9,7 @@ """ from abc import ABC, abstractmethod +from typing import Any from scapy.packet import Packet @@ -34,7 +35,7 @@ class TrafficGenerator(ABC): _tg_node: Node _logger: DTSLogger - def __init__(self, tg_node: Node, config: TrafficGeneratorConfig, **kwargs): + def __init__(self, tg_node: Node, config: TrafficGeneratorConfig, **kwargs: Any) -> None: """Initialize the traffic generator. Additional keyword arguments can be passed through `kwargs` if needed for fulfilling other @@ -49,10 +50,10 @@ def __init__(self, tg_node: Node, config: TrafficGeneratorConfig, **kwargs): self._tg_node = tg_node self._logger = get_dts_logger(f"{self._<a href="http://tg_node.name" rel="noreferrer" target="_blank">tg_node.name</a>} {self._config.type}") - def setup(self, topology: Topology): + def setup(self, topology: Topology) -> None: """Setup the traffic generator.""" - def teardown(self): + def teardown(self) -> None: """Teardown the traffic generator.""" self.close() diff --git a/dts/framework/testbed_model/virtual_device.py b/dts/framework/testbed_model/virtual_device.py index 569d67b007..1a4794e695 100644 --- a/dts/framework/testbed_model/virtual_device.py +++ b/dts/framework/testbed_model/virtual_device.py @@ -16,7 +16,7 @@ class VirtualDevice: name: str - def __init__(self, name: str): + def __init__(self, name: str) -> None: """Initialize the virtual device. Args: diff --git a/dts/framework/utils.py b/dts/framework/utils.py index 0c81ab1b95..a70c9c7d95 100644 --- a/dts/framework/utils.py +++ b/dts/framework/utils.py @@ -147,14 +147,14 @@ class TarCompressionFormat(StrEnum): zstd = "zst" @property - def extension(self): + def extension(self) -> str: """Return the extension associated with the compression format. If the compression format is 'none', the extension will be in the format 'tar'. For other compression formats, the extension will be in the format 'tar.{compression format}'. """ - return f"{self.value}" if self == self.none else f"{self.none.value}.{self.value}" + return f"{self.value}" if self == self.none else f"{type(self).none.value}.{self.value}" def convert_to_list_of_string(value: Any | list[Any]) -> list[str]: @@ -213,7 +213,7 @@ def filter_func(tarinfo: tarfile.TarInfo) -> tarfile.TarInfo | None: return target_tarball_path -def extract_tarball(tar_path: str | Path): +def extract_tarball(tar_path: str | Path) -> None: """Extract the contents of a tarball. The tarball will be extracted in the same path as `tar_path` parent path. diff --git a/dts/tests/TestSuite_blocklist.py b/dts/tests/TestSuite_blocklist.py index ce7da1cc8f..c668bcd86c 100644 --- a/dts/tests/TestSuite_blocklist.py +++ b/dts/tests/TestSuite_blocklist.py @@ -16,7 +16,7 @@ class TestBlocklist(TestSuite): """DPDK device blocklisting test suite.""" - def verify_blocklisted_ports(self, ports_to_block: list[Port]): + def verify_blocklisted_ports(self, ports_to_block: list[Port]) -> None: """Runs testpmd with the given ports blocklisted and verifies the ports.""" with TestPmdShell(allowed_ports=[], blocked_ports=ports_to_block) as testpmd: allowlisted_ports = {port.device_name for port in testpmd.show_port_info_all()} @@ -30,7 +30,7 @@ def verify_blocklisted_ports(self, ports_to_block: list[Port]): self.verify(blocked, "At least one port was not blocklisted") @func_test - def no_blocklisted(self): + def no_blocklisted(self) -> None: """Run testpmd with no blocklisted device. Steps: @@ -41,7 +41,7 @@ def no_blocklisted(self): self.verify_blocklisted_ports([]) @func_test - def one_port_blocklisted(self): + def one_port_blocklisted(self) -> None: """Run testpmd with one blocklisted port. Steps: @@ -52,7 +52,7 @@ def one_port_blocklisted(self): self.verify_blocklisted_ports(self.topology.sut_ports[:1]) @func_test - def all_but_one_port_blocklisted(self): + def all_but_one_port_blocklisted(self) -> None: """Run testpmd with all but one blocklisted port. Steps: diff --git a/dts/tests/TestSuite_dynamic_queue_conf.py b/dts/tests/TestSuite_dynamic_queue_conf.py index 0e9cda1b9f..3e2f9d816f 100644 --- a/dts/tests/TestSuite_dynamic_queue_conf.py +++ b/dts/tests/TestSuite_dynamic_queue_conf.py @@ -277,24 +277,24 @@ def stop_queues( @requires(NicCapability.RUNTIME_RX_QUEUE_SETUP) @func_test - def rx_queue_stop(self): + def rx_queue_stop(self) -> None: """Run method for stopping queues with flag for Rx testing set to :data:`True`.""" self.stop_queues(True) @requires(NicCapability.RUNTIME_RX_QUEUE_SETUP) @func_test - def rx_queue_configuration(self): + def rx_queue_configuration(self) -> None: """Run method for configuring queues with flag for Rx testing set to :data:`True`.""" self.modify_ring_size(True) @requires(NicCapability.RUNTIME_TX_QUEUE_SETUP) @func_test - def tx_queue_stop(self): + def tx_queue_stop(self) -> None: """Run method for stopping queues with flag for Rx testing set to :data:`False`.""" self.stop_queues(False) @requires(NicCapability.RUNTIME_TX_QUEUE_SETUP) @func_test - def tx_queue_configuration(self): + def tx_queue_configuration(self) -> None: """Run method for configuring queues with flag for Rx testing set to :data:`False`.""" self.modify_ring_size(False) diff --git a/dts/tests/TestSuite_port_restart_config_persistency.py b/dts/tests/TestSuite_port_restart_config_persistency.py index 42ea221586..b773bdfade 100644 --- a/dts/tests/TestSuite_port_restart_config_persistency.py +++ b/dts/tests/TestSuite_port_restart_config_persistency.py @@ -21,7 +21,7 @@ class TestPortRestartConfigPersistency(TestSuite): """Port config persistency test suite.""" - def restart_port_and_verify(self, id, testpmd, changed_value) -> None: + def restart_port_and_verify(self, id: int, testpmd: TestPmdShell, changed_value: str) -> None: """Fetch port config, restart and verify persistency.""" testpmd.start_all_ports() testpmd.wait_link_status_up(port_id=id, timeout=10) -- 2.50.1 </blockquote></div>