From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
by inbox.dpdk.org (Postfix) with ESMTP id 9717C432BB;
Mon, 6 Nov 2023 18:18:59 +0100 (CET)
Received: from mails.dpdk.org (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id D5A6C42DE4;
Mon, 6 Nov 2023 18:16:35 +0100 (CET)
Received: from mail-ed1-f52.google.com (mail-ed1-f52.google.com
[209.85.208.52]) by mails.dpdk.org (Postfix) with ESMTP id 7559942D87
for <dev@dpdk.org>; Mon, 6 Nov 2023 18:16:32 +0100 (CET)
Received: by mail-ed1-f52.google.com with SMTP id
4fb4d7f45d1cf-54394328f65so7889584a12.3
for <dev@dpdk.org>; Mon, 06 Nov 2023 09:16:32 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=pantheon.tech; s=google; t=1699290992; x=1699895792; darn=dpdk.org;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:from:to:cc:subject:date
:message-id:reply-to;
bh=ic2HSjaaUtpFow78DherjJZEUbGpTzSWTYcIUK3zrxE=;
b=EtICj0Y5TZVZPqybixOX++NORl/g6jCLjItab07h11oVGwF7NiyViA7HBBRapc66uK
gwxu1aeH7zwhmQurnFQbAh9uOqOO+ZjxVKdrbsNZXb0ciDugA62xEoAM2SRKMHMXuQ17
jqVfR2sAKTF9aNNxoGgRYBXmgzc5rZFTXDmalAzDHvxJU4XJdh0onutDw+mkcm4PhvD/
+i/AYvb6YwskvtCNdmfqpXhlxdqgFCUQC62meryc/SMkhrwDkm8BWkf2iWmWDIMwGVqK
ILQ/fb6vU2Jd8w5wBwVFK8RC02zsAGPxZQRwrsr5LcVHzKbnHVU6lDj2yxkuVCHpXVy0
zlTw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20230601; t=1699290992; x=1699895792;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc
:subject:date:message-id:reply-to;
bh=ic2HSjaaUtpFow78DherjJZEUbGpTzSWTYcIUK3zrxE=;
b=a79ZItMvs8puQQYz1DWpEPoAOIjh7R72K0yo35Iw7iFj/dffg7tiAUoodRlT8uo2Eq
pCUNDpZbwBdLwOQIKWuhMCV5QVev1029v+t4/xuMbBmUED1afyWZfeATB8cMTvyYh1cJ
/RwNd0EB4cRTr3XeuWLPF2NoqNlwVQRYd6JCaQitrV+C2YVDNrkQjHafjA3HutfqfwPm
EmHlef/e3BBX6QShLL6Qt3YsjL727v+T+PcMn3L3hnzKMENVL5g0Fwy2ELexf+280uX5
N7cKnPSkGn7m1tyKhe7u1yNivFMOi4xKIqEf6WYgpFfy7qQfzVZtDS4PfuSesQd9Yvnk
iCZw==
X-Gm-Message-State: AOJu0Yy+ozFuiU9pPd8hIJvnh5n34z0fi9AqU3F2x15pFrLn+WtwN1F+
Mu0PK8tmcoZhDPfBJ9XOcNlJpw==
X-Google-Smtp-Source: AGHT+IFmiILaeGuw0eqepbPfPB6sIpv4A9n2AKn1+ea20xFbxPQY/rOOVrwYbQDgCQf4DVnEY7KvTg==
X-Received: by 2002:a17:907:70c:b0:9d3:5d4a:8b6a with SMTP id
xb12-20020a170907070c00b009d35d4a8b6amr14778323ejb.42.1699290991998;
Mon, 06 Nov 2023 09:16:31 -0800 (PST)
Received: from jlinkes-PT-Latitude-5530.. (ip-46.34.243.197.o2inet.sk.
[46.34.243.197]) by smtp.gmail.com with ESMTPSA id
s10-20020a170906354a00b009b947aacb4bsm47016eja.191.2023.11.06.09.16.30
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Mon, 06 Nov 2023 09:16:31 -0800 (PST)
From: =?UTF-8?q?Juraj=20Linke=C5=A1?= <juraj.linkes@pantheon.tech>
To: thomas@monjalon.net, Honnappa.Nagarahalli@arm.com,
bruce.richardson@intel.com, jspewock@iol.unh.edu, probb@iol.unh.edu,
paul.szczepanek@arm.com, yoan.picchi@foss.arm.com
Cc: dev@dpdk.org, =?UTF-8?q?Juraj=20Linke=C5=A1?= <juraj.linkes@pantheon.tech>
Subject: [PATCH v5 20/23] dts: scapy tg docstring update
Date: Mon, 6 Nov 2023 18:15:58 +0100
Message-Id: <20231106171601.160749-21-juraj.linkes@pantheon.tech>
X-Mailer: git-send-email 2.34.1
In-Reply-To: <20231106171601.160749-1-juraj.linkes@pantheon.tech>
References: <20230831100407.59865-1-juraj.linkes@pantheon.tech>
<20231106171601.160749-1-juraj.linkes@pantheon.tech>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Format according to the Google format and PEP257, with slight
deviations.
Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>
---
.../testbed_model/traffic_generator/scapy.py | 91 +++++++++++--------
1 file changed, 54 insertions(+), 37 deletions(-)
diff --git a/dts/framework/testbed_model/traffic_generator/scapy.py b/dts/framework/testbed_model/traffic_generator/scapy.py
index 51864b6e6b..d0fe03055a 100644
--- a/dts/framework/testbed_model/traffic_generator/scapy.py
+++ b/dts/framework/testbed_model/traffic_generator/scapy.py
@@ -2,14 +2,15 @@
# Copyright(c) 2022 University of New Hampshire
# Copyright(c) 2023 PANTHEON.tech s.r.o.
-"""Scapy traffic generator.
+"""The Scapy traffic generator.
-Traffic generator used for functional testing, implemented using the Scapy library.
+A traffic generator used for functional testing, implemented with
+`the Scapy library <https://scapy.readthedocs.io/en/latest/>`_.
The traffic generator uses an XML-RPC server to run Scapy on the remote TG node.
-The XML-RPC server runs in an interactive remote SSH session running Python console,
-where we start the server. The communication with the server is facilitated with
-a local server proxy.
+The traffic generator uses the :mod:`xmlrpc.server` module to run an XML-RPC server
+in an interactive remote Python SSH session. The communication with the server is facilitated
+with a local server proxy from the :mod:`xmlrpc.client` module.
"""
import inspect
@@ -69,20 +70,20 @@ def scapy_send_packets_and_capture(
recv_iface: str,
duration: float,
) -> list[bytes]:
- """RPC function to send and capture packets.
+ """The RPC function to send and capture packets.
- The function is meant to be executed on the remote TG node.
+ The function is meant to be executed on the remote TG node via the server proxy.
Args:
xmlrpc_packets: The packets to send. These need to be converted to
- xmlrpc.client.Binary before sending to the remote server.
+ :class:`~xmlrpc.client.Binary` objects before sending to the remote server.
send_iface: The logical name of the egress interface.
recv_iface: The logical name of the ingress interface.
duration: Capture for this amount of time, in seconds.
Returns:
A list of bytes. Each item in the list represents one packet, which needs
- to be converted back upon transfer from the remote node.
+ to be converted back upon transfer from the remote node.
"""
scapy_packets = [scapy.all.Packet(packet.data) for packet in xmlrpc_packets]
sniffer = scapy.all.AsyncSniffer(
@@ -98,19 +99,15 @@ def scapy_send_packets_and_capture(
def scapy_send_packets(
xmlrpc_packets: list[xmlrpc.client.Binary], send_iface: str
) -> None:
- """RPC function to send packets.
+ """The RPC function to send packets.
- The function is meant to be executed on the remote TG node.
- It doesn't return anything, only sends packets.
+ The function is meant to be executed on the remote TG node via the server proxy.
+ It only sends `xmlrpc_packets`, without capturing them.
Args:
xmlrpc_packets: The packets to send. These need to be converted to
- xmlrpc.client.Binary before sending to the remote server.
+ :class:`~xmlrpc.client.Binary` objects before sending to the remote server.
send_iface: The logical name of the egress interface.
-
- Returns:
- A list of bytes. Each item in the list represents one packet, which needs
- to be converted back upon transfer from the remote node.
"""
scapy_packets = [scapy.all.Packet(packet.data) for packet in xmlrpc_packets]
scapy.all.sendp(scapy_packets, iface=send_iface, realtime=True, verbose=True)
@@ -130,11 +127,19 @@ def scapy_send_packets(
class QuittableXMLRPCServer(SimpleXMLRPCServer):
- """Basic XML-RPC server that may be extended
- by functions serializable by the marshal module.
+ r"""Basic XML-RPC server.
+
+ The server may be augmented by functions serializable by the :mod:`marshal` module.
"""
def __init__(self, *args, **kwargs):
+ """Extend the XML-RPC server initialization.
+
+ Args:
+ args: The positional arguments that will be passed to the superclass's constructor.
+ kwargs: The keyword arguments that will be passed to the superclass's constructor.
+ The `allow_none` argument will be set to ``True``.
+ """
kwargs["allow_none"] = True
super().__init__(*args, **kwargs)
self.register_introspection_functions()
@@ -142,13 +147,12 @@ def __init__(self, *args, **kwargs):
self.register_function(self.add_rpc_function)
def quit(self) -> None:
+ """Quit the server."""
self._BaseServer__shutdown_request = True
return None
def add_rpc_function(self, name: str, function_bytes: xmlrpc.client.Binary) -> None:
- """Add a function to the server.
-
- This is meant to be executed remotely.
+ """Add a function to the server from the local server proxy.
Args:
name: The name of the function.
@@ -159,6 +163,11 @@ def add_rpc_function(self, name: str, function_bytes: xmlrpc.client.Binary) -> N
self.register_function(function)
def serve_forever(self, poll_interval: float = 0.5) -> None:
+ """Extend the superclass method with an additional print.
+
+ Once executed in the local server proxy, the print gives us a clear string to expect
+ when starting the server. The print means the function was executed on the XML-RPC server.
+ """
print("XMLRPC OK")
super().serve_forever(poll_interval)
@@ -166,19 +175,12 @@ def serve_forever(self, poll_interval: float = 0.5) -> None:
class ScapyTrafficGenerator(CapturingTrafficGenerator):
"""Provides access to scapy functions via an RPC interface.
- The traffic generator first starts an XML-RPC on the remote TG node.
- Then it populates the server with functions which use the Scapy library
- to send/receive traffic.
-
- Any packets sent to the remote server are first converted to bytes.
- They are received as xmlrpc.client.Binary objects on the server side.
- When the server sends the packets back, they are also received as
- xmlrpc.client.Binary object on the client side, are converted back to Scapy
- packets and only then returned from the methods.
+ The class extends the base with remote execution of scapy functions.
- Arguments:
- tg_node: The node where the traffic generator resides.
- config: The user configuration of the traffic generator.
+ Any packets sent to the remote server are first converted to bytes. They are received as
+ :class:`~xmlrpc.client.Binary` objects on the server side. When the server sends the packets
+ back, they are also received as :class:`~xmlrpc.client.Binary` objects on the client side, are
+ converted back to :class:`scapy.packet.Packet` objects and only then returned from the methods.
Attributes:
session: The exclusive interactive remote session created by the Scapy
@@ -192,6 +194,22 @@ class ScapyTrafficGenerator(CapturingTrafficGenerator):
_config: ScapyTrafficGeneratorConfig
def __init__(self, tg_node: Node, config: ScapyTrafficGeneratorConfig):
+ """Extend the constructor with Scapy TG specifics.
+
+ The traffic generator first starts an XML-RPC on the remote `tg_node`.
+ Then it populates the server with functions which use the Scapy library
+ to send/receive traffic:
+
+ * :func:`scapy_send_packets_and_capture`
+ * :func:`scapy_send_packets`
+
+ To enable verbose logging from the xmlrpc client, use the :option:`--verbose`
+ command line argument or the :envvar:`DTS_VERBOSE` environment variable.
+
+ Args:
+ tg_node: The node where the traffic generator resides.
+ config: The traffic generator's test run configuration.
+ """
super().__init__(tg_node, config)
assert (
@@ -237,10 +255,8 @@ def _start_xmlrpc_server_in_remote_python(self, listen_port: int) -> None:
[line for line in src.splitlines() if not line.isspace() and line != ""]
)
- spacing = "\n" * 4
-
# execute it in the python terminal
- self.session.send_command(spacing + src + spacing)
+ self.session.send_command(src + "\n")
self.session.send_command(
f"server = QuittableXMLRPCServer(('0.0.0.0', {listen_port}));"
f"server.serve_forever()",
@@ -274,6 +290,7 @@ def _send_packets_and_capture(
return scapy_packets
def close(self) -> None:
+ """Close the traffic generator."""
try:
self.rpc_server_proxy.quit()
except ConnectionRefusedError:
--
2.34.1