From patchwork Wed Jul 24 14:08:36 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Jeremy Spewock X-Patchwork-Id: 142688 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 65C57456A2; Wed, 24 Jul 2024 16:09:32 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A2A9C43445; Wed, 24 Jul 2024 16:09:26 +0200 (CEST) Received: from mail-il1-f232.google.com (mail-il1-f232.google.com [209.85.166.232]) by mails.dpdk.org (Postfix) with ESMTP id 5D09743445 for ; Wed, 24 Jul 2024 16:09:25 +0200 (CEST) Received: by mail-il1-f232.google.com with SMTP id e9e14a558f8ab-396eb81a1cfso27719915ab.2 for ; Wed, 24 Jul 2024 07:09:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1721830164; x=1722434964; 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=2jMdKCpCGz2EZQRwqvVFeYUYQgJ4MklAuyxUbMYnjew=; b=T4bBJ0e6ErsiIEz0yT9BceRLbYIRvTa6vsNTMDHYo2tRw040hQn1p9/Cl2ptLR2as0 BhtNoGzAi0Pe2RqmL9popTWWJ+Uv9AExorB8hFDINQgO01B1Susm1nYLD46qS7YBlQsG YqZWhZVtde5yV9noCdRkniMAvRkEXI9uoUMbc= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721830164; x=1722434964; 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=2jMdKCpCGz2EZQRwqvVFeYUYQgJ4MklAuyxUbMYnjew=; b=soOxTAtIg6eGICLLcFt4TCXdMTXAa5vXQ7tJMa+GGp0Hj5FHegvJCl4n3oFpb7mheu r7KK4ipti36ICK+QGpqvtnI1fN9X8KvC/I1PyZH3bFDcvifoujim3vod9ztl3K0dYZzp sgn6PQ5FgSQcHBuH8KNyzvQ18cV/hpUORvFH5ip5UZbgkU3hYb/ueWpm4LxH51KTRz0a xtjlL9THsZhna/LBtvF9EVlnt9s4npGVcfUbd/wuBKISSDibztYH4YFRP83gpkAOMXV0 wqI8pNDhZnEuQAStovikOpjL1JyYdrSghW7IfW8wD0S6EY3AvW3+KKDycGjXfrljtRHK ujoQ== X-Gm-Message-State: AOJu0YzPd2QXC8DVcJCi7vkUVi7+YsqwuiANY0G4lK3bzk+oLrQNpbwB ToOvrd0upzu1CsRc5nthjmA4JxY4sJo5fGsObcwPywJ88vK46SSoyaWN6axvYB4sDUqrC6+dsUD VIxKNiucN/cUVWBptp+buFggn1ACsFetw X-Google-Smtp-Source: AGHT+IGEGpOxLNo35ghA9IH/wHF5IkBm7/JKC8Z3DjZtQYjFA8kpzkO6AXQqIUyMKr4sN3p2CIzRxdXBZx7Z X-Received: by 2002:a05:6e02:1a81:b0:396:ba86:318f with SMTP id e9e14a558f8ab-39a194d7b69mr25516365ab.24.1721830164577; Wed, 24 Jul 2024 07:09:24 -0700 (PDT) Received: from postal.iol.unh.edu (postal.iol.unh.edu. [132.177.123.84]) by smtp-relay.gmail.com with ESMTPS id e9e14a558f8ab-39a187d9dd5sm790235ab.55.2024.07.24.07.09.24 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Wed, 24 Jul 2024 07:09:24 -0700 (PDT) X-Relaying-Domain: iol.unh.edu Received: from iol.unh.edu (unknown [IPv6:2606:4100:3880:1257::1083]) by postal.iol.unh.edu (Postfix) with ESMTP id BF6D360526E2; Wed, 24 Jul 2024 10:09:22 -0400 (EDT) From: jspewock@iol.unh.edu To: Honnappa.Nagarahalli@arm.com, npratte@iol.unh.edu, Luca.Vizzarro@arm.com, paul.szczepanek@arm.com, wathsala.vithanage@arm.com, probb@iol.unh.edu, thomas@monjalon.net, yoan.picchi@foss.arm.com, juraj.linkes@pantheon.tech Cc: dev@dpdk.org, Jeremy Spewock , Luca Vizzarro Subject: [PATCH v5 1/3] dts: Improve output gathering in interactive shells Date: Wed, 24 Jul 2024 10:08:36 -0400 Message-ID: <20240724140838.171012-2-jspewock@iol.unh.edu> X-Mailer: git-send-email 2.45.2 In-Reply-To: <20240724140838.171012-1-jspewock@iol.unh.edu> References: <20240501161623.26672-1-jspewock@iol.unh.edu> <20240724140838.171012-1-jspewock@iol.unh.edu> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org From: Jeremy Spewock The current implementation of consuming output from interactive shells relies on being able to find an expected prompt somewhere within the output buffer after sending the command. This is useful in situations where the prompt does not appear in the output itself, but in some practical cases (such as the starting of an XML-RPC server for scapy) the prompt exists in one of the commands sent to the shell and this can cause the command to exit early and creates a race condition between the server starting and the first command being sent to the server. This patch addresses this problem by searching for a line that strictly ends with the provided prompt, rather than one that simply contains it, so that the detection that a command is finished is more consistent. It also adds a catch to detect when a command times out before finding the prompt or the underlying SSH session dies so that the exception can be wrapped into a more explicit one and be more consistent with the non-interactive shells. Bugzilla ID: 1359 Fixes: 88489c0501af ("dts: add smoke tests") Signed-off-by: Jeremy Spewock Reviewed-by: Juraj Linkeš Reviewed-by: Luca Vizzarro Reviewed-by: Nicholas Pratte --- dts/framework/exception.py | 66 ++++++++++++------- .../single_active_interactive_shell.py | 49 ++++++++++---- 2 files changed, 79 insertions(+), 36 deletions(-) diff --git a/dts/framework/exception.py b/dts/framework/exception.py index 74fd2af3b6..f45f789825 100644 --- a/dts/framework/exception.py +++ b/dts/framework/exception.py @@ -51,26 +51,6 @@ class DTSError(Exception): severity: ClassVar[ErrorSeverity] = ErrorSeverity.GENERIC_ERR -class SSHTimeoutError(DTSError): - """The SSH execution of a command timed out.""" - - #: - severity: ClassVar[ErrorSeverity] = ErrorSeverity.SSH_ERR - _command: str - - def __init__(self, command: str): - """Define the meaning of the first argument. - - Args: - command: The executed command. - """ - self._command = command - - def __str__(self) -> str: - """Add some context to the string representation.""" - return f"{self._command} execution timed out." - - class SSHConnectionError(DTSError): """An unsuccessful SSH connection.""" @@ -98,8 +78,42 @@ def __str__(self) -> str: return message -class SSHSessionDeadError(DTSError): - """The SSH session is no longer alive.""" +class _SSHTimeoutError(DTSError): + """The execution of a command via SSH timed out. + + This class is private and meant to be raised as its interactive and non-interactive variants. + """ + + #: + severity: ClassVar[ErrorSeverity] = ErrorSeverity.SSH_ERR + _command: str + + def __init__(self, command: str): + """Define the meaning of the first argument. + + Args: + command: The executed command. + """ + self._command = command + + def __str__(self) -> str: + """Add some context to the string representation.""" + return f"{self._command} execution timed out." + + +class SSHTimeoutError(_SSHTimeoutError): + """The execution of a command on a non-interactive SSH session timed out.""" + + +class InteractiveSSHTimeoutError(_SSHTimeoutError): + """The execution of a command on an interactive SSH session timed out.""" + + +class _SSHSessionDeadError(DTSError): + """The SSH session is no longer alive. + + This class is private and meant to be raised as its interactive and non-interactive variants. + """ #: severity: ClassVar[ErrorSeverity] = ErrorSeverity.SSH_ERR @@ -118,6 +132,14 @@ def __str__(self) -> str: return f"SSH session with {self._host} has died." +class SSHSessionDeadError(_SSHSessionDeadError): + """Non-interactive SSH session has died.""" + + +class InteractiveSSHSessionDeadError(_SSHSessionDeadError): + """Interactive SSH session as died.""" + + class ConfigurationError(DTSError): """An invalid configuration.""" diff --git a/dts/framework/remote_session/single_active_interactive_shell.py b/dts/framework/remote_session/single_active_interactive_shell.py index 38094c0fe2..0e5a04885f 100644 --- a/dts/framework/remote_session/single_active_interactive_shell.py +++ b/dts/framework/remote_session/single_active_interactive_shell.py @@ -27,7 +27,11 @@ from paramiko import Channel, channel # type: ignore[import-untyped] from typing_extensions import Self -from framework.exception import InteractiveCommandExecutionError +from framework.exception import ( + InteractiveCommandExecutionError, + InteractiveSSHSessionDeadError, + InteractiveSSHTimeoutError, +) from framework.logger import DTSLogger from framework.params import Params from framework.settings import SETTINGS @@ -71,7 +75,10 @@ class SingleActiveInteractiveShell(ABC): #: Extra characters to add to the end of every command #: before sending them. This is often overridden by subclasses and is - #: most commonly an additional newline character. + #: most commonly an additional newline character. This additional newline + #: character is used to force the line that is currently awaiting input + #: into the stdout buffer so that it can be consumed and checked against + #: the expected prompt. _command_extra_chars: ClassVar[str] = "" #: Path to the executable to start the interactive application. @@ -175,6 +182,9 @@ def send_command( Raises: InteractiveCommandExecutionError: If attempting to send a command to a shell that is not currently running. + InteractiveSSHSessionDeadError: The session died while executing the command. + InteractiveSSHTimeoutError: If command was sent but prompt could not be found in + the output before the timeout. """ if not self.is_alive: raise InteractiveCommandExecutionError( @@ -183,19 +193,30 @@ def send_command( self._logger.info(f"Sending: '{command}'") if prompt is None: prompt = self._default_prompt - self._stdin.write(f"{command}{self._command_extra_chars}\n") - self._stdin.flush() out: str = "" - for line in self._stdout: - if skip_first_line: - skip_first_line = False - continue - if prompt in line and not line.rstrip().endswith( - command.rstrip() - ): # ignore line that sent command - break - out += line - self._logger.debug(f"Got output: {out}") + try: + self._stdin.write(f"{command}{self._command_extra_chars}\n") + self._stdin.flush() + for line in self._stdout: + if skip_first_line: + skip_first_line = False + continue + if line.rstrip().endswith(prompt): + break + out += line + except TimeoutError as e: + self._logger.exception(e) + self._logger.debug( + f"Prompt ({prompt}) was not found in output from command before timeout." + ) + raise InteractiveSSHTimeoutError(command) from e + except OSError as e: + self._logger.exception(e) + raise InteractiveSSHSessionDeadError( + self._node.main_session.interactive_session.hostname + ) from e + finally: + self._logger.debug(f"Got output: {out}") return out def _close(self) -> None: From patchwork Wed Jul 24 14:08:37 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Jeremy Spewock X-Patchwork-Id: 142689 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 20AE3456A2; Wed, 24 Jul 2024 16:09:39 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id EB6C94344E; Wed, 24 Jul 2024 16:09:31 +0200 (CEST) Received: from mail-il1-f227.google.com (mail-il1-f227.google.com [209.85.166.227]) by mails.dpdk.org (Postfix) with ESMTP id B07DD43440 for ; Wed, 24 Jul 2024 16:09:30 +0200 (CEST) Received: by mail-il1-f227.google.com with SMTP id e9e14a558f8ab-395e9f2ebc0so35324395ab.0 for ; Wed, 24 Jul 2024 07:09:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1721830170; x=1722434970; 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=ap735j3cLYE3m1ei6abxO38EK1Sj/3VyuWAOmiZB5+8=; b=P+wAvtosor9sBaRiuiksOcBVn0Y3KVRC5Af3azVaaUh0o68x7kbpDJBDLV/1am0Yca P22yg8Uy0APmD6Onmvkxj2GrJenIKnLkJbPkRYOBO4Y0tsnlghHAkU+0dUOIA6B6P8N8 nLcU/4e8oCF8E+htZYnKInSBGYFUU+x4+xbXI= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721830170; x=1722434970; 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=ap735j3cLYE3m1ei6abxO38EK1Sj/3VyuWAOmiZB5+8=; b=dw2B1ZSi6wos7u47ELr3TkRXmUnbhnR9YEsoILwSaxZ3Xehg/SfMm9Y/PaRvwi9qJH TNxM/oq3RVBVTdisl1SxhH6xSnAupgzmpKhOycrbJC4wiZWpJ/xeZ8Py9YzDniGXuC7U q4BcICExmXH/l+Eh4s+PiES7Mj6800btddYdKanhd01+3/pGJ6oz22T9b/VLN4pzKRKo FME/8xVILFpMgCFXJc+BXHSNyygwxMVuA0wwAaxn8o17H9V924Q0uyevSvsZG7sUPWCE 52C2C89bVKOWfd3PhPesc0e27X7n45T2IlTpjS9q1TYGxrNcp9gk6+wmEAPQUouTm/NQ zasQ== X-Gm-Message-State: AOJu0Yy0g8ZBnI2FPoEGxId6IuSOjBxQPkp8wPk+KTFxduqxvem8VTAb caM/iWnNtqZV298m9CWI024D1wsROW2P4nBFpYiVRr+PYSOgOGi/67AbZ59JNpOX/4ZKlU7o/Z6 wh10JW+vNDoLxkZ7KQXfhJDPwo7O9h5hJPqUmeXWRhsnSUR22 X-Google-Smtp-Source: AGHT+IFIzL4sEAIiUl3n+kf50VDj+hqDF2EpIYJg8hA6OhqdqSTpoKFoLf5JyZEbmPeJJYSCRXS4m7hEDvM6 X-Received: by 2002:a92:c544:0:b0:379:40e0:b0b8 with SMTP id e9e14a558f8ab-39a194b8a42mr25939155ab.20.1721830169797; Wed, 24 Jul 2024 07:09:29 -0700 (PDT) Received: from postal.iol.unh.edu (postal.iol.unh.edu. [2606:4100:3880:1234::84]) by smtp-relay.gmail.com with ESMTPS id e9e14a558f8ab-39a186a7f53sm788215ab.33.2024.07.24.07.09.29 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Wed, 24 Jul 2024 07:09:29 -0700 (PDT) X-Relaying-Domain: iol.unh.edu Received: from iol.unh.edu (unknown [IPv6:2606:4100:3880:1257::1083]) by postal.iol.unh.edu (Postfix) with ESMTP id 5ECF060526E2; Wed, 24 Jul 2024 10:09:28 -0400 (EDT) From: jspewock@iol.unh.edu To: Honnappa.Nagarahalli@arm.com, npratte@iol.unh.edu, Luca.Vizzarro@arm.com, paul.szczepanek@arm.com, wathsala.vithanage@arm.com, probb@iol.unh.edu, thomas@monjalon.net, yoan.picchi@foss.arm.com, juraj.linkes@pantheon.tech Cc: dev@dpdk.org, Jeremy Spewock , Luca Vizzarro Subject: [PATCH v5 2/3] dts: Add missing docstring from XML-RPC server Date: Wed, 24 Jul 2024 10:08:37 -0400 Message-ID: <20240724140838.171012-3-jspewock@iol.unh.edu> X-Mailer: git-send-email 2.45.2 In-Reply-To: <20240724140838.171012-1-jspewock@iol.unh.edu> References: <20240501161623.26672-1-jspewock@iol.unh.edu> <20240724140838.171012-1-jspewock@iol.unh.edu> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org From: Jeremy Spewock When this XML-RPC server implementation was added, the docstring had to be shortened in order to reduce the chances of this race condition being encountered. Now that this race condition issue is resolved, the full docstring can be restored. Signed-off-by: Jeremy Spewock Reviewed-by: Juraj Linkeš Reviewed-by: Luca Vizzarro Reviewed-by: Nicholas Pratte --- .../testbed_model/traffic_generator/scapy.py | 46 ++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/dts/framework/testbed_model/traffic_generator/scapy.py b/dts/framework/testbed_model/traffic_generator/scapy.py index 7f0cc2bc18..08e1f4ae7e 100644 --- a/dts/framework/testbed_model/traffic_generator/scapy.py +++ b/dts/framework/testbed_model/traffic_generator/scapy.py @@ -128,9 +128,53 @@ def scapy_send_packets(xmlrpc_packets: list[xmlrpc.client.Binary], send_iface: s class QuittableXMLRPCServer(SimpleXMLRPCServer): - """Basic XML-RPC server. + r"""Basic XML-RPC server. The server may be augmented by functions serializable by the :mod:`marshal` module. + + Example: + :: + + def hello_world(): + # to be sent to the XML-RPC server + print("Hello World!") + + # start the XML-RPC server on the remote node + # this is done by starting a Python shell on the remote node + from framework.remote_session import PythonShell + # the example assumes you're already connected to a tg_node + session = tg_node.create_interactive_shell(PythonShell, timeout=5, privileged=True) + + # then importing the modules needed to run the server + # and the modules for any functions later added to the server + session.send_command("import xmlrpc") + session.send_command("from xmlrpc.server import SimpleXMLRPCServer") + + # sending the source code of this class to the Python shell + from xmlrpc.server import SimpleXMLRPCServer + src = inspect.getsource(QuittableXMLRPCServer) + src = "\n".join([l for l in src.splitlines() if not l.isspace() and l != ""]) + spacing = "\n" * 4 + session.send_command(spacing + src + spacing) + + # then starting the server with: + command = "s = QuittableXMLRPCServer(('0.0.0.0', {listen_port}));s.serve_forever()" + session.send_command(command, "XMLRPC OK") + + # now the server is running on the remote node and we can add functions to it + # first connect to the server from the execution node + import xmlrpc.client + server_url = f"http://{tg_node.config.hostname}:8000" + rpc_server_proxy = xmlrpc.client.ServerProxy(server_url) + + # get the function bytes to send + import marshal + function_bytes = marshal.dumps(hello_world.__code__) + rpc_server_proxy.add_rpc_function(hello_world.__name__, function_bytes) + + # now we can execute the function on the server + xmlrpc_binary_recv: xmlrpc.client.Binary = rpc_server_proxy.hello_world() + print(str(xmlrpc_binary_recv)) """ def __init__(self, *args, **kwargs): From patchwork Wed Jul 24 14:08:38 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Jeremy Spewock X-Patchwork-Id: 142690 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 056D1456A2; Wed, 24 Jul 2024 16:09:47 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 0D68A43456; Wed, 24 Jul 2024 16:09:35 +0200 (CEST) Received: from mail-qk1-f225.google.com (mail-qk1-f225.google.com [209.85.222.225]) by mails.dpdk.org (Postfix) with ESMTP id E20C343440 for ; Wed, 24 Jul 2024 16:09:31 +0200 (CEST) Received: by mail-qk1-f225.google.com with SMTP id af79cd13be357-7a1d0ad7113so17870885a.2 for ; Wed, 24 Jul 2024 07:09:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1721830171; x=1722434971; 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=lKfIMOjchiDqQ35BGZ6y1D1NM8d+uqo8TPgpqpZjO/w=; b=II4ABMp5KL1s9LZDB6gI3lvx0bhKthJD746EGg+/rVjS/LGUue6Fs8r6yd0w2JM1bI rfHR/pFy7V5OlTTquHzI14Qn31FLJe8UtFaK/OWMHLjipugk32axSsFiTppo7RG6ZZy+ Rs3P7HbDcuLsBwM+E9Je60k6BvIH+IIxM1LIw= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721830171; x=1722434971; 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=lKfIMOjchiDqQ35BGZ6y1D1NM8d+uqo8TPgpqpZjO/w=; b=ZcKuR6rCoQfOy3qpwm13sx+VnG5tBk6gfdHzxaUHAgvEi4ej1pcYqbNYImdqMPKd+U B/pt+HeKRMNgHG4aKDCBrnefo437bsT+3n5Qa6+RknE9YoYIlLFRX7LtglcCk5S3sozn UtuFh4MTK4nSrxbA9BuYGg8QFjD72WMBWNLMzdz79QnybeSiaYIjeyYJ9GBvX6tJKdCQ IuJLnm7RI46V1F8y/R5MRmAhmjnEryHp9+z4Zn+KIJ6aDLy1/DzFBTf/kB/TvOaKfEpF Mtvh9V7CDZwahhpL/xhj23Vr5P4zIUjXOO+Od0AYF6G/pzjbRuNtIsrHDMjzqEk3cofr 8ztA== X-Gm-Message-State: AOJu0YyUv8Z1gxGnpNFlvnaWBaUatLc+h3Cdinhd0oHluM1A1InQ5nkF WtMCHBM/t+lKnvHj71NuWLSQ9m2sai4xP+NL0ryKpr10VEndYvZ1oW6rwNqkj5E78fRE67o87Xd CMbkXK8DsirRcxlq6nHrm+rhY9Z2I3y7o X-Google-Smtp-Source: AGHT+IG+nVsBKe/9ORi/Fn7wmSEs6ARyraDkUU+f50f/sICoIc44BvyDpG23lPgtPyf6IbCslonumEPcgYb0 X-Received: by 2002:a05:620a:2686:b0:79f:137a:e503 with SMTP id af79cd13be357-7a1cbcd2f38mr249781485a.10.1721830171231; Wed, 24 Jul 2024 07:09:31 -0700 (PDT) Received: from postal.iol.unh.edu (postal.iol.unh.edu. [132.177.123.84]) by smtp-relay.gmail.com with ESMTPS id af79cd13be357-7a1990942d1sm30722985a.6.2024.07.24.07.09.31 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Wed, 24 Jul 2024 07:09:31 -0700 (PDT) X-Relaying-Domain: iol.unh.edu Received: from iol.unh.edu (unknown [IPv6:2606:4100:3880:1257::1083]) by postal.iol.unh.edu (Postfix) with ESMTP id 1C82560526E2; Wed, 24 Jul 2024 10:09:30 -0400 (EDT) From: jspewock@iol.unh.edu To: Honnappa.Nagarahalli@arm.com, npratte@iol.unh.edu, Luca.Vizzarro@arm.com, paul.szczepanek@arm.com, wathsala.vithanage@arm.com, probb@iol.unh.edu, thomas@monjalon.net, yoan.picchi@foss.arm.com, juraj.linkes@pantheon.tech Cc: dev@dpdk.org, Jeremy Spewock , Luca Vizzarro Subject: [PATCH v5 3/3] dts: Improve logging for interactive shells Date: Wed, 24 Jul 2024 10:08:38 -0400 Message-ID: <20240724140838.171012-4-jspewock@iol.unh.edu> X-Mailer: git-send-email 2.45.2 In-Reply-To: <20240724140838.171012-1-jspewock@iol.unh.edu> References: <20240501161623.26672-1-jspewock@iol.unh.edu> <20240724140838.171012-1-jspewock@iol.unh.edu> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org From: Jeremy Spewock The messages being logged by interactive shells currently are using the same logger as the node they were created from. Because of this, when sending interactive commands, the logs make no distinction between when you are sending a command directly to the host and when you are using an interactive shell on the host. This change adds names to interactive shells so that they are able to use their own loggers with distinct names. Signed-off-by: Jeremy Spewock Reviewed-by: Juraj Linkeš Tested-by: Nicholas Pratte Reviewed-by: Nicholas Pratte Reviewed-by: Luca Vizzarro --- dts/framework/remote_session/dpdk_shell.py | 3 ++- .../remote_session/single_active_interactive_shell.py | 9 +++++++-- dts/framework/remote_session/testpmd_shell.py | 2 ++ dts/framework/testbed_model/traffic_generator/scapy.py | 4 +++- 4 files changed, 14 insertions(+), 4 deletions(-) diff --git a/dts/framework/remote_session/dpdk_shell.py b/dts/framework/remote_session/dpdk_shell.py index 950c6ca670..c5f5c2d116 100644 --- a/dts/framework/remote_session/dpdk_shell.py +++ b/dts/framework/remote_session/dpdk_shell.py @@ -82,6 +82,7 @@ def __init__( ascending_cores: bool = True, append_prefix_timestamp: bool = True, app_params: EalParams = EalParams(), + name: str | None = None, ) -> None: """Extends :meth:`~.interactive_shell.InteractiveShell.__init__`. @@ -96,7 +97,7 @@ def __init__( append_prefix_timestamp, ) - super().__init__(node, privileged, timeout, app_params) + super().__init__(node, privileged, timeout, app_params, name) def _update_real_path(self, path: PurePath) -> None: """Extends :meth:`~.interactive_shell.InteractiveShell._update_real_path`. diff --git a/dts/framework/remote_session/single_active_interactive_shell.py b/dts/framework/remote_session/single_active_interactive_shell.py index 0e5a04885f..7014444d0c 100644 --- a/dts/framework/remote_session/single_active_interactive_shell.py +++ b/dts/framework/remote_session/single_active_interactive_shell.py @@ -32,7 +32,7 @@ InteractiveSSHSessionDeadError, InteractiveSSHTimeoutError, ) -from framework.logger import DTSLogger +from framework.logger import DTSLogger, get_dts_logger from framework.params import Params from framework.settings import SETTINGS from framework.testbed_model.node import Node @@ -92,6 +92,7 @@ def __init__( privileged: bool = False, timeout: float = SETTINGS.timeout, app_params: Params = Params(), + name: str | None = None, ) -> None: """Create an SSH channel during initialization. @@ -102,9 +103,13 @@ def __init__( shell. This timeout is for collecting output, so if reading from the buffer and no output is gathered within the timeout, an exception is thrown. app_params: The command line parameters to be passed to the application on startup. + name: Name for the interactive shell to use for logging. This name will be appended to + the name of the underlying node which it is running on. """ self._node = node - self._logger = node._logger + if name is None: + name = type(self).__name__ + self._logger = get_dts_logger(f"{node.name}.{name}") self._app_params = app_params self._privileged = privileged self._timeout = timeout diff --git a/dts/framework/remote_session/testpmd_shell.py b/dts/framework/remote_session/testpmd_shell.py index eda6eb320f..43e9f56517 100644 --- a/dts/framework/remote_session/testpmd_shell.py +++ b/dts/framework/remote_session/testpmd_shell.py @@ -604,6 +604,7 @@ def __init__( lcore_filter_specifier: LogicalCoreCount | LogicalCoreList = LogicalCoreCount(), ascending_cores: bool = True, append_prefix_timestamp: bool = True, + name: str | None = None, **app_params: Unpack[TestPmdParamsDict], ) -> None: """Overrides :meth:`~.dpdk_shell.DPDKShell.__init__`. Changes app_params to kwargs.""" @@ -615,6 +616,7 @@ def __init__( ascending_cores, append_prefix_timestamp, TestPmdParams(**app_params), + name, ) def start(self, verify: bool = True) -> None: diff --git a/dts/framework/testbed_model/traffic_generator/scapy.py b/dts/framework/testbed_model/traffic_generator/scapy.py index 08e1f4ae7e..13fc1107aa 100644 --- a/dts/framework/testbed_model/traffic_generator/scapy.py +++ b/dts/framework/testbed_model/traffic_generator/scapy.py @@ -261,7 +261,9 @@ def __init__(self, tg_node: Node, config: ScapyTrafficGeneratorConfig): self._tg_node.config.os == OS.linux ), "Linux is the only supported OS for scapy traffic generation" - self.session = PythonShell(self._tg_node, timeout=5, privileged=True) + self.session = PythonShell( + self._tg_node, timeout=5, privileged=True, name="ScapyXMLRPCServer" + ) self.session.start_application()