From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id C8A76454AC; Thu, 20 Jun 2024 19:37:15 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 4D76D42E4D; Thu, 20 Jun 2024 19:37:11 +0200 (CEST) Received: from mail-pg1-f227.google.com (mail-pg1-f227.google.com [209.85.215.227]) by mails.dpdk.org (Postfix) with ESMTP id 060A8402E2 for ; Thu, 20 Jun 2024 19:37:09 +0200 (CEST) Received: by mail-pg1-f227.google.com with SMTP id 41be03b00d2f7-6c53a315c6eso842350a12.3 for ; Thu, 20 Jun 2024 10:37:08 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1718905028; x=1719509828; 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=RnWp1lKva3YnU513AxSLHWON2A+WA+PqBmnwc5K/YeU=; b=cAGIeowiEcBFb1FZg+OOUMLHJcJ7mYf/Po0Fb1/mDbNgDIg2Iu917OhIs9HU8+wzYw mQCB8OvX6eA19FiCkIJHDDXtGnTLlmCNXEEKPZPqvkOU5SJG6XVttw7dbn7TESxzmA0w CMZDFrNA89kiIs4S8jh6Mk4kaQZzkFoJs9Liw= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1718905028; x=1719509828; 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=RnWp1lKva3YnU513AxSLHWON2A+WA+PqBmnwc5K/YeU=; b=tDutXj0wjoVrtwWNR8ds1v6s0z9xNf9/PS6mLP+ymvVymZrqZSxZpqEEB2hjFTpMLe odPXzKbxh5MVsOKWpNuIJk76xHfcT8HaAVrGgYRC1fE2cVSaNHr1ukXXKLM90Xr85Wdu 6oUl6KaEM6ZtcCzDtMwfCPw4PEWPFHbEJzMnQ4vFgUa7kDUPgtn4CrA9Or5qNIRxykcY QubuAjTxHOXJlGrdbszaQcpkEZGJZRgO9N0Yxr3WNOeaNpPZFKijG33fxui0Szi5OhU/ eB+YY6HmUitiHPNqRP5cbQnj64yczssvRDbNfcZb2IrJadu6ywAc5q/53ARxvSlWnbB6 85Sg== X-Gm-Message-State: AOJu0YznAqFvJp0sAwzhrSRLF9CVlNkZ/RTuVjk0XCwMmmylmVvIvlAu w0AirizuI3TrtzSBuRMxPI+W3DhsAuLkXgiBPQZXvxg3DipbYaRRFkBdznlXxPQntUiEzdoOdg1 nqTW0NYyuX4qkTiGe6yuFUtWGLEl29TPD X-Google-Smtp-Source: AGHT+IGcz92Dzq7MA7aByy9rS/ddFnh1ATdX2+xnXF/NJVzTp8YiOIacVHeV0Sd7bEvoFaVQNikXKyvk2RP6 X-Received: by 2002:a17:90b:3d8:b0:2c7:ab00:f605 with SMTP id 98e67ed59e1d1-2c7b5cc6b21mr6336208a91.20.1718905028073; Thu, 20 Jun 2024 10:37:08 -0700 (PDT) Received: from postal.iol.unh.edu (postal.iol.unh.edu. [132.177.123.84]) by smtp-relay.gmail.com with ESMTPS id 98e67ed59e1d1-2c7e649f8e3sm146934a91.15.2024.06.20.10.37.07 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Thu, 20 Jun 2024 10:37:08 -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 DABFC605C373; Thu, 20 Jun 2024 13:37:06 -0400 (EDT) From: jspewock@iol.unh.edu To: yoan.picchi@foss.arm.com, juraj.linkes@pantheon.tech, thomas@monjalon.net, Luca.Vizzarro@arm.com, wathsala.vithanage@arm.com, Honnappa.Nagarahalli@arm.com, paul.szczepanek@arm.com, npratte@iol.unh.edu, probb@iol.unh.edu Cc: dev@dpdk.org, Jeremy Spewock Subject: [PATCH v4 1/3] dts: Improve output gathering in interactive shells Date: Thu, 20 Jun 2024 13:36:07 -0400 Message-ID: <20240620173609.15375-2-jspewock@iol.unh.edu> X-Mailer: git-send-email 2.45.2 In-Reply-To: <20240620173609.15375-1-jspewock@iol.unh.edu> References: <20240501161623.26672-1-jspewock@iol.unh.edu> <20240620173609.15375-1-jspewock@iol.unh.edu> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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 --- dts/framework/exception.py | 66 ++++++++++++------- .../remote_session/interactive_shell.py | 49 ++++++++++---- 2 files changed, 80 insertions(+), 35 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/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index 254aa29f89..6aa5281d6a 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -21,6 +21,10 @@ from paramiko import Channel, channel # type: ignore[import-untyped] +from framework.exception import ( + InteractiveSSHSessionDeadError, + InteractiveSSHTimeoutError, +) from framework.logger import DTSLogger from framework.params import Params from framework.settings import SETTINGS @@ -53,7 +57,10 @@ class InteractiveShell(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. @@ -134,23 +141,39 @@ def send_command( Returns: All output in the buffer before expected string. + + Raises: + 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. """ 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: -- 2.45.2