[v1] dts: move artifact class to API
Checks
Commit Message
Moved the artifact module to API and
updated docs and tests to match the move.
Signed-off-by: Paul Szczepanek <paul.szczepanek@arm.com>
Reviewed-by: Luca Vizzarro <luca.vizzarro@arm.com>
---
...{framework.testbed_model.artifact.rst => api.artifact.rst} | 2 +-
doc/api/dts/api.rst | 1 +
doc/api/dts/framework.testbed_model.rst | 1 -
dts/{framework/testbed_model => api}/artifact.py | 2 +-
dts/framework/logger.py | 4 ++--
.../traffic_generator/capturing_traffic_generator.py | 2 +-
dts/tests/TestSuite_packet_capture.py | 2 +-
dts/tests/TestSuite_softnic.py | 2 +-
8 files changed, 8 insertions(+), 8 deletions(-)
rename doc/api/dts/{framework.testbed_model.artifact.rst => api.artifact.rst} (72%)
rename dts/{framework/testbed_model => api}/artifact.py (99%)
--
2.39.5
Comments
Reviewed-by: Dean Marx <dmarx@iol.unh.edu>
Reviewed-by: Patrick Robb <probb@iol.unh.edu>
Tested-by: Patrick Robb <probb@iol.unh.edu>
Applied to next-dts, thanks.
similarity index 72%
rename from doc/api/dts/framework.testbed_model.artifact.rst
rename to doc/api/dts/api.artifact.rst
@@ -3,6 +3,6 @@
artifact - File Management
==========================
-.. automodule:: framework.testbed_model.artifact
+.. automodule:: api.artifact
:members:
:show-inheritance:
@@ -17,6 +17,7 @@ api - DTS API
:hidden:
:maxdepth: 1
+ api.artifact
api.capabilities
api.packet
api.test
@@ -17,7 +17,6 @@ testbed\_model - Testbed Modelling Package
:hidden:
:maxdepth: 1
- framework.testbed_model.artifact
framework.testbed_model.os_session
framework.testbed_model.linux_session
framework.testbed_model.posix_session
similarity index 99%
rename from dts/framework/testbed_model/artifact.py
rename to dts/api/artifact.py
@@ -10,7 +10,7 @@
.. code:: python
- from framework.testbed_model.artifact import Artifact
+ from api.artifact import Artifact
# Create an artifact on a remote node
artifact = Artifact(node="sut", file_name="example.txt")
@@ -18,7 +18,7 @@
from typing import TYPE_CHECKING, Any, ClassVar, NamedTuple
if TYPE_CHECKING:
- from framework.testbed_model.artifact import Artifact
+ from api.artifact import Artifact
date_fmt = "%Y/%m/%d %H:%M:%S"
stream_fmt = "%(asctime)s - %(stage)s - %(name)s - %(levelname)s - %(message)s"
@@ -140,7 +140,7 @@ def _add_artifact_handlers(self, log_file_name: str) -> list[ArtifactHandler]:
Returns:
The newly created artifact handlers.
"""
- from framework.testbed_model.artifact import Artifact
+ from api.artifact import Artifact
log_artifact = Artifact("local", f"{log_file_name}.log")
handler = StreamHandler(log_artifact.open("w"))
@@ -16,7 +16,7 @@
import scapy.utils
from scapy.packet import Packet
-from framework.testbed_model.artifact import Artifact
+from api.artifact import Artifact
from framework.testbed_model.port import Port
from framework.utils import get_packet_summaries
@@ -25,6 +25,7 @@
from scapy.packet import Packet, Raw, raw
from scapy.utils import rdpcap
+from api.artifact import Artifact
from api.capabilities import (
LinkTopology,
requires_link_topology,
@@ -40,7 +41,6 @@
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.artifact import Artifact
from framework.testbed_model.cpu import LogicalCoreList
from framework.testbed_model.traffic_generator.capturing_traffic_generator import (
PacketFilteringConfig,
@@ -6,6 +6,7 @@
Create a softnic virtual device and verify it successfully forwards packets.
"""
+from api.artifact import Artifact
from api.capabilities import (
LinkTopology,
NicCapability,
@@ -20,7 +21,6 @@
from api.testpmd import TestPmd
from api.testpmd.config import EthPeer
from framework.test_suite import TestSuite, func_test
-from framework.testbed_model.artifact import Artifact
from framework.testbed_model.virtual_device import VirtualDevice
from framework.utils import generate_random_packets