diff mbox series

[1/1] dts: fix deterministic doc

Message ID 20250606093502.31767-1-cfamullaconrad@suse.com (mailing list archive)
State Superseded
Delegated to: Paul Szczepanek
Headers
Series [1/1] dts: fix deterministic doc |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/github-robot: build success github build: passed
ci/iol-dts-check-format-testing warning Testing issues
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/intel-Testing fail Testing issues
ci/iol-abi-testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-compile-amd64-testing warning Testing issues
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-sample-apps-testing success Testing PASS

Commit Message

Clemens Famulla-Conrad June 6, 2025, 9:35 a.m. UTC 
Previously, `capture_name` defaulted to a "dynamic" value.
This caused non-deterministic documentation and could lead
to overwriting capture files if the method was called
multiple times within a single Python process.

Bugzilla ID: 1718

Signed-off-by: Clemens Famulla-Conrad <cfamullaconrad@suse.com>
---
 .mailmap                                                     | 1 +
 .../traffic_generator/capturing_traffic_generator.py         | 5 ++++-
 2 files changed, 5 insertions(+), 1 deletion(-)

Comments

Paul Szczepanek June 9, 2025, 9:12 a.m. UTC | #1 
Thanks. This needs to pass the linter, see my suggestions below.

On 06/06/2025 10:35, Clemens Famulla-Conrad wrote:
> +        capture_name: str = None,

+        capture_name: str = "",

> +        if capture_name is None:
> +            capture_name = _get_default_capture_name()
> +

+        if not capture_name:
+            capture_name = _get_default_capture_name()
diff mbox series

Patch

diff --git a/.mailmap b/.mailmap
index 76f65e5114..cd5362f130 100644
--- a/.mailmap
+++ b/.mailmap
@@ -272,6 +272,7 @@  Cian Ferriter <cian.ferriter@intel.com>
 Ciara Loftus <ciara.loftus@intel.com>
 Ciara Power <ciara.power@intel.com>
 Claire Murphy <claire.k.murphy@intel.com>
+Clemens Famulla-Conrad <cfamullaconrad@suse.com>
 Cody Doucette <doucette@bu.edu>
 Congwen Zhang <zhang.congwen@zte.com.cn>
 Conor Fogarty <conor.fogarty@intel.com>
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 66a77da9c4..c1e4a898d4 100644
--- a/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py
+++ b/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py
@@ -70,7 +70,7 @@  def send_packets_and_capture(
         receive_port: Port,
         filter_config: PacketFilteringConfig,
         duration: float,
-        capture_name: str = _get_default_capture_name(),
+        capture_name: str = None,
     ) -> list[Packet]:
         """Send `packets` and capture received traffic.
 
@@ -104,6 +104,9 @@  def send_packets_and_capture(
             duration,
         )
 
+        if capture_name is None:
+            capture_name = _get_default_capture_name()
+
         self._logger.debug(f"Received packets: {get_packet_summaries(received_packets)}")
         self._write_capture_from_packets(capture_name, received_packets)
         return received_packets