testprotocols 0.4.0__tar.gz → 0.5.0__tar.gz

{testprotocols-0.4.0/src/testprotocols.egg-info → testprotocols-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: testprotocols
-Version: 0.4.0
+Version: 0.5.0
 Summary: Common Test Resource Layer — capability and device protocols for telco testing.
 Author-email: Alottabits <rjvisser@alottabits.com>
 Maintainer-email: Alottabits <rjvisser@alottabits.com>

{testprotocols-0.4.0 → testprotocols-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "testprotocols"
-version = "0.4.0"
+version = "0.5.0"
 description = "Common Test Resource Layer — capability and device protocols for telco testing."
 requires-python = ">=3.12"
 dependencies = []

{testprotocols-0.4.0 → testprotocols-0.5.0}/src/testprotocols/__init__.py

@@ -1,6 +1,6 @@
 """testprotocols — capability and device Protocols for telco resources under test."""
 
-__version__ = "0.1.0"
+__version__ = "0.5.0"
 
 from testprotocols.aftr_gateway import AftrGateway
 from testprotocols.appliance_nat import ApplianceNat

{testprotocols-0.4.0 → testprotocols-0.5.0}/src/testprotocols/devices/base.py

@@ -10,8 +10,8 @@ class BaseDeviceProtocol(Protocol):
     """Universal identity surface every test-device archetype carries.
 
     Substrate- and framework-neutral: any concrete driver that exposes a
-    ``device_name`` and a ``device_type`` satisfies this — palco's
-    ``PalcoDevice`` (where both are ``@property``), a hypothetical
+    ``device_name`` and a ``device_type`` satisfies this — vitro's
+    ``VitroDevice`` (where both are ``@property``), a hypothetical
     boardfarm ``BoardfarmDevice``, a pyATS ``Device`` wrapper, a
     pure-Python simulator. Archetype Protocols in
     ``testprotocols.devices.*`` inherit from this so consumers
@@ -19,7 +19,7 @@ class BaseDeviceProtocol(Protocol):
     messages without reaching into framework-specific base classes.
 
     Deliberately scoped to the universal pair — name + type. Anything a
-    specific framework wants to expose (palco's ``config`` /
+    specific framework wants to expose (vitro's ``config`` /
     ``get_interactive_consoles``, boardfarm's lifecycle hooks, etc.) is
     the framework's own concern. Frameworks declare a connector Protocol
     on their side that extends this base; testbed plugins compose
@@ -28,8 +28,8 @@ class BaseDeviceProtocol(Protocol):
     """
 
     # Read-only identity. Declared as properties (not settable variables) so that
-    # implementers exposing them as ``@property`` (VitroDevice, palco's
-    # PalcoDevice) statically satisfy the Protocol — a settable-variable member
+    # implementers exposing them as ``@property`` (e.g. vitro's
+    # VitroDevice) statically satisfy the Protocol — a settable-variable member
     # would reject a read-only property. A plain ``device_name: str`` attribute
     # also satisfies a read-only-property member, so this is the more permissive,
     # correct declaration for read-only identity.

{testprotocols-0.4.0 → testprotocols-0.5.0}/src/testprotocols/iperf_client.py

@@ -25,9 +25,32 @@ class IperfClient(Protocol):
         time: int = 10,
         client_port: int | None = None,
         udp_only: bool | None = None,
+        reverse: bool = False,
+        omit_s: int | None = None,
+        json_output: bool = False,
+        window: str | None = None,
     ) -> tuple[int, str]:
         """Start an iperf traffic sender towards *host* on *traffic_port*.
 
+        Typed option parameters (each defaults to "absent": no flag emitted):
+
+        - ``reverse``: iperf3 reverse mode (``-R``) — the listening receiver
+          transmits; the sender still initiates the connection.
+        - ``omit_s``: skip the first N seconds (``-O <n>``, the TCP slow-start
+          ramp); omitted seconds extend the wall clock and are excluded from
+          the end-of-test summary.
+        - ``json_output``: machine-readable output (``--json``).
+        - ``window``: pin the socket buffer (``-w <size>``, e.g. ``"8M"``) on
+          BOTH ends — iperf3 forwards it to the server in the test-parameter
+          exchange. Pinning disables OS receive/send autotuning; the effective
+          value is capped by ``net.core.rmem_max``/``wmem_max`` (NOT
+          ``tcp_rmem``/``tcp_wmem``), so the host must be provisioned
+          accordingly.
+
+        ``direction`` is DEPRECATED: a raw CLI fragment appended verbatim
+        after the typed flags. Kept as an escape hatch only; use the typed
+        parameters instead.
+
         Returns a tuple of (pid, log_file_path).
         """
         ...

{testprotocols-0.4.0 → testprotocols-0.5.0}/src/testprotocols/models/__init__.py

@@ -1,4 +1,4 @@
-"""Shared data models for palco-templates."""
+"""Shared data models for testprotocols."""
 
 from __future__ import annotations
 

{testprotocols-0.4.0 → testprotocols-0.5.0}/src/testprotocols/wifi_radio.py

@@ -6,7 +6,7 @@ tx power / mode configuration, regulatory-domain control, and DFS-state
 read.
 
 The template is per-device with band-keyed methods (matching the
-existing palco pattern in IpInterface and WifiClient). A device with
+existing vitro pattern in IpInterface and WifiClient). A device with
 multiple radios on the same band (e.g. dual-5GHz) is not modelled in
 this release; band-string keying assumes one radio per band per device.
 

{testprotocols-0.4.0 → testprotocols-0.5.0/src/testprotocols.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: testprotocols
-Version: 0.4.0
+Version: 0.5.0
 Summary: Common Test Resource Layer — capability and device protocols for telco testing.
 Author-email: Alottabits <rjvisser@alottabits.com>
 Maintainer-email: Alottabits <rjvisser@alottabits.com>