Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/2013894/?format=api
{ "id": 2013894, "url": "http://patchwork.ozlabs.org/api/patches/2013894/?format=api", "web_url": "http://patchwork.ozlabs.org/project/qemu-devel/patch/20241121154218.1423005-16-berrange@redhat.com/", "project": { "id": 14, "url": "http://patchwork.ozlabs.org/api/projects/14/?format=api", "name": "QEMU Development", "link_name": "qemu-devel", "list_id": "qemu-devel.nongnu.org", "list_email": "qemu-devel@nongnu.org", "web_url": "", "scm_url": "", "webscm_url": "", "list_archive_url": "", "list_archive_url_format": "", "commit_url_format": "" }, "msgid": "<20241121154218.1423005-16-berrange@redhat.com>", "list_archive_url": null, "date": "2024-11-21T15:42:15", "name": "[v2,15/18] tests/functional: rewrite console handling to be bytewise", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "9c881f9ac72673f626c8318a8eb3fc5371fec156", "submitter": { "id": 2694, "url": "http://patchwork.ozlabs.org/api/people/2694/?format=api", "name": "Daniel P. Berrangé", "email": "berrange@redhat.com" }, "delegate": null, "mbox": "http://patchwork.ozlabs.org/project/qemu-devel/patch/20241121154218.1423005-16-berrange@redhat.com/mbox/", "series": [ { "id": 433720, "url": "http://patchwork.ozlabs.org/api/series/433720/?format=api", "web_url": "http://patchwork.ozlabs.org/project/qemu-devel/list/?series=433720", "date": "2024-11-21T15:42:05", "name": "test/functional: improve functional test debugging & fix tuxrun", "version": 2, "mbox": "http://patchwork.ozlabs.org/series/433720/mbox/" } ], "comments": "http://patchwork.ozlabs.org/api/patches/2013894/comments/", "check": "pending", "checks": "http://patchwork.ozlabs.org/api/patches/2013894/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>", "X-Original-To": "incoming@patchwork.ozlabs.org", "Delivered-To": "patchwork-incoming@legolas.ozlabs.org", "Authentication-Results": [ "legolas.ozlabs.org;\n\tdkim=pass (1024-bit key;\n unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256\n header.s=mimecast20190719 header.b=PGymHdRG;\n\tdkim-atps=neutral", "legolas.ozlabs.org;\n spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org\n (client-ip=209.51.188.17; helo=lists.gnu.org;\n envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org;\n receiver=patchwork.ozlabs.org)" ], "Received": [ "from lists.gnu.org (lists.gnu.org [209.51.188.17])\n\t(using TLSv1.2 with cipher ECDHE-ECDSA-AES256-GCM-SHA384 (256/256 bits))\n\t(No client certificate requested)\n\tby legolas.ozlabs.org (Postfix) with ESMTPS id 4XvMxh24zSz1yCg\n\tfor <incoming@patchwork.ozlabs.org>; Fri, 22 Nov 2024 02:45:12 +1100 (AEDT)", "from localhost ([::1] helo=lists1p.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.90_1)\n\t(envelope-from <qemu-devel-bounces@nongnu.org>)\n\tid 1tE9Lo-0001mS-Vq; Thu, 21 Nov 2024 10:44:13 -0500", "from eggs.gnu.org ([2001:470:142:3::10])\n by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)\n (Exim 4.90_1) (envelope-from <berrange@redhat.com>)\n id 1tE9Lm-0001f1-Gb\n for qemu-devel@nongnu.org; Thu, 21 Nov 2024 10:44:10 -0500", "from us-smtp-delivery-124.mimecast.com ([170.10.129.124])\n by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)\n (Exim 4.90_1) (envelope-from <berrange@redhat.com>)\n id 1tE9Lk-00014F-QC\n for qemu-devel@nongnu.org; Thu, 21 Nov 2024 10:44:10 -0500", "from mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com\n (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by\n relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3,\n cipher=TLS_AES_256_GCM_SHA384) id us-mta-663-T5rf3vgaPIiNYp2diMcpWw-1; Thu,\n 21 Nov 2024 10:44:04 -0500", "from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com\n (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15])\n (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest\n SHA256)\n (No client certificate requested)\n by mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS\n id BBED3197731D; Thu, 21 Nov 2024 15:44:03 +0000 (UTC)", "from toolbox.redhat.com (unknown [10.42.28.5])\n by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP\n id F32AB1956086; Thu, 21 Nov 2024 15:43:57 +0000 (UTC)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n s=mimecast20190719; t=1732203848;\n h=from:from:reply-to:subject:subject:date:date:message-id:message-id:\n to:to:cc:cc:mime-version:mime-version:content-type:content-type:\n content-transfer-encoding:content-transfer-encoding:\n in-reply-to:in-reply-to:references:references;\n bh=/9q1CNlKLymBgniZFYob84WFjVbexMweRa9IPrPskeE=;\n b=PGymHdRGbFBuNlHnlWSHlzyMtaFCHWXcwKe8xhTefkvqlVA42KqihSg1phnw5JNo1K6i9Q\n OlcuN9/RnFUi50b0t1k1LHp580nYHUr/TJqKP7efWyPH6PVyTY30EsT+m9rELWTgJ6pEmR\n 2Errp7QGLqfmVqESYhS14ktOi9/AkHI=", "X-MC-Unique": "T5rf3vgaPIiNYp2diMcpWw-1", "X-Mimecast-MFC-AGG-ID": "T5rf3vgaPIiNYp2diMcpWw", "From": "=?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= <berrange@redhat.com>", "To": "qemu-devel@nongnu.org", "Cc": "Thomas Huth <thuth@redhat.com>, Ani Sinha <anisinha@redhat.com>,\n\t=?utf-8?q?Alex_Benn=C3=A9e?= <alex.bennee@linaro.org>,\n Peter Maydell <peter.maydell@linaro.org>, =?utf-8?q?Philippe_Mathieu-Daud?=\n\t=?utf-8?q?=C3=A9?= <philmd@linaro.org>,\n =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= <berrange@redhat.com>, =?utf-8?q?C?=\n\t=?utf-8?q?=C3=A9dric_Le_Goater?= <clg@redhat.com>", "Subject": "[PATCH v2 15/18] tests/functional: rewrite console handling to be\n 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": "8bit", "X-Scanned-By": "MIMEDefang 3.0 on 10.30.177.15", "Received-SPF": "pass client-ip=170.10.129.124;\n envelope-from=berrange@redhat.com;\n 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,\n DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,\n RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001,\n RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001,\n 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": "<qemu-devel.nongnu.org>", "List-Unsubscribe": "<https://lists.nongnu.org/mailman/options/qemu-devel>,\n <mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>", "List-Archive": "<https://lists.nongnu.org/archive/html/qemu-devel>", "List-Post": "<mailto:qemu-devel@nongnu.org>", "List-Help": "<mailto:qemu-devel-request@nongnu.org?subject=help>", "List-Subscribe": "<https://lists.nongnu.org/mailman/listinfo/qemu-devel>,\n <mailto:qemu-devel-request@nongnu.org?subject=subscribe>", "Errors-To": "qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org", "Sender": "qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org" }, "content": "The console interaction that waits for predicted strings uses\nreadline(), and thus is only capable of waiting for strings\nthat are followed by a newline.\n\nThis is inconvenient when needing to match on some things,\nparticularly login prompts, or shell prompts, causing tests\nto use time.sleep(...) instead, which is unreliable.\n\nSwitch to reading the console 1 byte at a time, comparing\nagainst the success/failure messages until we see a match,\nregardless of whether a newline is encountered.\n\nThe success/failure comparisons are done with the python bytes\ntype, rather than strings, to avoid the problem of needing to\ndecode partially received multibyte utf8 characters.\n\nHeavily inspired by a patch proposed by Cédric, but written\nagain to work in bytes, rather than strings.\n\nCo-developed-by: Cédric Le Goater <clg@redhat.com>\nSigned-off-by: Daniel P. Berrangé <berrange@redhat.com>\n---\n tests/functional/qemu_test/cmd.py | 79 +++++++++++++++++++++++++------\n 1 file changed, 64 insertions(+), 15 deletions(-)", "diff": "diff --git a/tests/functional/qemu_test/cmd.py b/tests/functional/qemu_test/cmd.py\nindex f6c4e4dda1..11c8334a7c 100644\n--- a/tests/functional/qemu_test/cmd.py\n+++ b/tests/functional/qemu_test/cmd.py\n@@ -78,6 +78,54 @@ def run_cmd(args):\n def is_readable_executable_file(path):\n return os.path.isfile(path) and os.access(path, os.R_OK | os.X_OK)\n \n+# @test: functional test to fail if @failure is seen\n+# @vm: the VM whose console to process\n+# @success: a non-None string to look for\n+# @failure: a string to look for that triggers test failure, or None\n+#\n+# Read up to 1 line of text from @vm, looking for @success\n+# and optionally @failure.\n+#\n+# If @success or @failure are seen, immediately return True,\n+# even if end of line is not yet seen. ie remainder of the\n+# line is left unread.\n+#\n+# If end of line is seen, with neither @success or @failure\n+# return False\n+#\n+# If @failure is seen, then mark @test as failed\n+def _console_read_line_until_match(test, vm, success, failure):\n+ msg = bytes([])\n+ done = False\n+ while True:\n+ c = vm.console_socket.recv(1)\n+ if c is None:\n+ done = True\n+ test.fail(\n+ f\"EOF in console, expected '{success}'\")\n+ break\n+ msg += c\n+\n+ if success in msg:\n+ done = True\n+ break\n+ if failure and failure in msg:\n+ done = True\n+ vm.console_socket.close()\n+ test.fail(\n+ f\"'{failure}' found in console, expected '{success}'\")\n+\n+ if c == b'\\n':\n+ break\n+\n+ console_logger = logging.getLogger('console')\n+ try:\n+ console_logger.debug(msg.decode().strip())\n+ except:\n+ console_logger.debug(msg)\n+\n+ return done\n+\n def _console_interaction(test, success_message, failure_message,\n send_string, keep_sending=False, vm=None):\n assert not keep_sending or send_string\n@@ -85,11 +133,22 @@ def _console_interaction(test, success_message, failure_message,\n \n if vm is None:\n vm = test.vm\n- console = vm.console_file\n- console_logger = logging.getLogger('console')\n+\n test.log.debug(\n f\"Console interaction: success_msg='{success_message}' \" +\n f\"failure_msg='{failure_message}' send_string='{send_string}'\")\n+\n+ # We'll process console in bytes, to avoid having to\n+ # deal with unicode decode errors from receiving\n+ # partial utf8 byte sequences\n+ success_message_b = None\n+ if success_message is not None:\n+ success_message_b = success_message.encode()\n+\n+ failure_message_b = None\n+ if failure_message is not None:\n+ failure_message_b = failure_message.encode()\n+\n while True:\n if send_string:\n vm.console_socket.sendall(send_string.encode())\n@@ -102,20 +161,10 @@ def _console_interaction(test, success_message, failure_message,\n break\n continue\n \n- try:\n- msg = console.readline().decode().strip()\n- except UnicodeDecodeError:\n- msg = None\n- if not msg:\n- continue\n- console_logger.debug(msg)\n- if success_message in msg:\n+ if _console_read_line_until_match(test, vm,\n+ success_message_b,\n+ failure_message_b):\n break\n- if failure_message and failure_message in msg:\n- console.close()\n- fail = 'Failure message found in console: \"%s\". Expected: \"%s\"' % \\\n- (failure_message, success_message)\n- test.fail(fail)\n \n def interrupt_interactive_console_until_pattern(test, success_message,\n failure_message=None,\n", "prefixes": [ "v2", "15/18" ] }