From nobody Sat Nov 23 17:10:46 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1732203911; cv=none; d=zohomail.com; s=zohoarc; b=mrNawDFN9h7+gk2y3nZDJsE/JZvs3UFiJ251MFFZwxf8LTJwieYMGA9+GwoqKstBA0PbcLP3FMQwC3Xs4RNCTOkQ4/NFK0MqvZ37o3vf8ywN6gPE4x9eZhOj0zYKKku+uO27P+NUTkRxIXz8w7hwpZ52dp9Dz5KdFcWiC6eYaT4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1732203911; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=/9q1CNlKLymBgniZFYob84WFjVbexMweRa9IPrPskeE=; b=Y/MaPKtqL7lWRfwj7qXIEAMShdjhyQoKfrqIc+19LDPBbY/1NMcxKyW7Zwzf6qC9lDn4O7lpAxMqe25jZwLu78blXdA3P9N2h9mPtHmSbiiJCUCosDcFiePtuMzwZ28g/Y97RWwI8VaSOF/Vb8djJsZk609TWF0CIqRs+2DdRg0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1732203911418520.148117048785; Thu, 21 Nov 2024 07:45:11 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tE9Lo-0001mS-Vq; Thu, 21 Nov 2024 10:44:13 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tE9Lm-0001f1-Gb for qemu-devel@nongnu.org; Thu, 21 Nov 2024 10:44:10 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tE9Lk-00014F-QC for qemu-devel@nongnu.org; Thu, 21 Nov 2024 10:44:10 -0500 Received: from mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-663-T5rf3vgaPIiNYp2diMcpWw-1; Thu, 21 Nov 2024 10:44:04 -0500 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id BBED3197731D; Thu, 21 Nov 2024 15:44:03 +0000 (UTC) Received: from toolbox.redhat.com (unknown [10.42.28.5]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id F32AB1956086; Thu, 21 Nov 2024 15:43:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1732203848; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=/9q1CNlKLymBgniZFYob84WFjVbexMweRa9IPrPskeE=; b=PGymHdRGbFBuNlHnlWSHlzyMtaFCHWXcwKe8xhTefkvqlVA42KqihSg1phnw5JNo1K6i9Q OlcuN9/RnFUi50b0t1k1LHp580nYHUr/TJqKP7efWyPH6PVyTY30EsT+m9rELWTgJ6pEmR 2Errp7QGLqfmVqESYhS14ktOi9/AkHI= X-MC-Unique: T5rf3vgaPIiNYp2diMcpWw-1 X-Mimecast-MFC-AGG-ID: T5rf3vgaPIiNYp2diMcpWw From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: qemu-devel@nongnu.org Cc: Thomas Huth , Ani Sinha , =?UTF-8?q?Alex=20Benn=C3=A9e?= , Peter Maydell , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , =?UTF-8?q?C=C3=A9dric=20Le=20Goater?= Subject: [PATCH v2 15/18] tests/functional: rewrite console handling to be bytewise Date: Thu, 21 Nov 2024 15:42:15 +0000 Message-ID: <20241121154218.1423005-16-berrange@redhat.com> In-Reply-To: <20241121154218.1423005-1-berrange@redhat.com> References: <20241121154218.1423005-1-berrange@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=berrange@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.14, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1732203913543116600 The console interaction that waits for predicted strings uses readline(), and thus is only capable of waiting for strings that are followed by a newline. This is inconvenient when needing to match on some things, particularly login prompts, or shell prompts, causing tests to use time.sleep(...) instead, which is unreliable. Switch to reading the console 1 byte at a time, comparing against the success/failure messages until we see a match, regardless of whether a newline is encountered. The success/failure comparisons are done with the python bytes type, rather than strings, to avoid the problem of needing to decode partially received multibyte utf8 characters. Heavily inspired by a patch proposed by C=C3=A9dric, but written again to work in bytes, rather than strings. Co-developed-by: C=C3=A9dric Le Goater Signed-off-by: Daniel P. Berrang=C3=A9 --- tests/functional/qemu_test/cmd.py | 79 +++++++++++++++++++++++++------ 1 file changed, 64 insertions(+), 15 deletions(-) diff --git a/tests/functional/qemu_test/cmd.py b/tests/functional/qemu_test= /cmd.py index f6c4e4dda1..11c8334a7c 100644 --- a/tests/functional/qemu_test/cmd.py +++ b/tests/functional/qemu_test/cmd.py @@ -78,6 +78,54 @@ def run_cmd(args): def is_readable_executable_file(path): return os.path.isfile(path) and os.access(path, os.R_OK | os.X_OK) =20 +# @test: functional test to fail if @failure is seen +# @vm: the VM whose console to process +# @success: a non-None string to look for +# @failure: a string to look for that triggers test failure, or None +# +# Read up to 1 line of text from @vm, looking for @success +# and optionally @failure. +# +# If @success or @failure are seen, immediately return True, +# even if end of line is not yet seen. ie remainder of the +# line is left unread. +# +# If end of line is seen, with neither @success or @failure +# return False +# +# If @failure is seen, then mark @test as failed +def _console_read_line_until_match(test, vm, success, failure): + msg =3D bytes([]) + done =3D False + while True: + c =3D vm.console_socket.recv(1) + if c is None: + done =3D True + test.fail( + f"EOF in console, expected '{success}'") + break + msg +=3D c + + if success in msg: + done =3D True + break + if failure and failure in msg: + done =3D True + vm.console_socket.close() + test.fail( + f"'{failure}' found in console, expected '{success}'") + + if c =3D=3D b'\n': + break + + console_logger =3D logging.getLogger('console') + try: + console_logger.debug(msg.decode().strip()) + except: + console_logger.debug(msg) + + return done + def _console_interaction(test, success_message, failure_message, send_string, keep_sending=3DFalse, vm=3DNone): assert not keep_sending or send_string @@ -85,11 +133,22 @@ def _console_interaction(test, success_message, failur= e_message, =20 if vm is None: vm =3D test.vm - console =3D vm.console_file - console_logger =3D logging.getLogger('console') + test.log.debug( f"Console interaction: success_msg=3D'{success_message}' " + f"failure_msg=3D'{failure_message}' send_string=3D'{send_string}'") + + # We'll process console in bytes, to avoid having to + # deal with unicode decode errors from receiving + # partial utf8 byte sequences + success_message_b =3D None + if success_message is not None: + success_message_b =3D success_message.encode() + + failure_message_b =3D None + if failure_message is not None: + failure_message_b =3D failure_message.encode() + while True: if send_string: vm.console_socket.sendall(send_string.encode()) @@ -102,20 +161,10 @@ def _console_interaction(test, success_message, failu= re_message, break continue =20 - try: - msg =3D console.readline().decode().strip() - except UnicodeDecodeError: - msg =3D None - if not msg: - continue - console_logger.debug(msg) - if success_message in msg: + if _console_read_line_until_match(test, vm, + success_message_b, + failure_message_b): break - if failure_message and failure_message in msg: - console.close() - fail =3D 'Failure message found in console: "%s". Expected: "%= s"' % \ - (failure_message, success_message) - test.fail(fail) =20 def interrupt_interactive_console_until_pattern(test, success_message, failure_message=3DNone, --=20 2.46.0