From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from simark.ca by simark.ca with LMTP id vtzTLi8mRWMlrQkAWB0awg (envelope-from ) for ; Tue, 11 Oct 2022 04:15:43 -0400 Received: by simark.ca (Postfix, from userid 112) id A56AF1E112; Tue, 11 Oct 2022 04:15:43 -0400 (EDT) Authentication-Results: simark.ca; dkim=pass (1024-bit key; secure) header.d=sourceware.org header.i=@sourceware.org header.a=rsa-sha256 header.s=default header.b=lNpXbea+; dkim-atps=neutral X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on simark.ca X-Spam-Level: X-Spam-Status: No, score=-3.0 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 Received: from sourceware.org (server2.sourceware.org [8.43.85.97]) (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 simark.ca (Postfix) with ESMTPS id 9E3641E0D3 for ; Tue, 11 Oct 2022 04:15:42 -0400 (EDT) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 6AEA93857011 for ; Tue, 11 Oct 2022 08:15:41 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 6AEA93857011 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1665476141; bh=bviLSLKIqZ4SEt+dVVOAhrFYmGQSE6Uwz4CoHVT7S+I=; h=Date:To:Subject:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:From; b=lNpXbea+a44h4sNXWpHqYKQ0LC0p7wEe11T7l1Bthg3Cy7R7ZGsPPXpOe0dnr1QcP beBzvfhQAHqWT4qhyp6yZJE+VAWOAmE0n6z1s+z4nVZQk1nuB8oQpTRI4eq7eDvSeL ZJ/KCrIA6GFeLLAXSkdzU4oGNInwiCjf9z+HrTv0= Received: from smtp-out1.suse.de (smtp-out1.suse.de [195.135.220.28]) by sourceware.org (Postfix) with ESMTPS id 000AE3857B99 for ; Tue, 11 Oct 2022 08:15:13 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 000AE3857B99 Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by smtp-out1.suse.de (Postfix) with ESMTPS id 3856221F91; Tue, 11 Oct 2022 08:15:13 +0000 (UTC) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by imap2.suse-dmz.suse.de (Postfix) with ESMTPS id F24F713AAC; Tue, 11 Oct 2022 08:15:12 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id QASTORAmRWPeHwAAMHmgww (envelope-from ); Tue, 11 Oct 2022 08:15:12 +0000 Date: Tue, 11 Oct 2022 10:15:11 +0200 To: gdb-patches@sourceware.org Subject: [committed][gdb/testsuite] Fix prompt parsing in capture_command_output Message-ID: <20221011081509.GA23275@delia.home> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.10.1 (2018-07-13) X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , From: Tom de Vries via Gdb-patches Reply-To: Tom de Vries Errors-To: gdb-patches-bounces+public-inbox=simark.ca@sourceware.org Sender: "Gdb-patches" Hi, I noticed in capture_command_output that the output of a single command is matched using two gdb_test_multiples: - the first one matching the echoed command and skipping an optional prefix, - the second one matching the output and the prompt. This is error-prone, because the first gdb_test_multiple has implicit clauses which may consume the prompt. The problem is easy to spot with an example. First consider: ... set output [capture_command_output "print 1" "\\\$1 = "] gdb_assert { [string equal $output "1"] } ... for which we get: ... PASS: [string equal $output "1"] ... If we change the prefix string to a no-match, say "1 = ", and update the output string match accordingly, we get instead: ... FAIL: capture_command_output for print 1 FAIL: [string equal $output "\$1 = 1"] ... The first FAIL is produced by the first gdb_test_multiple, consuming the prompt. The second gdb_test_multiple then silently times out waiting for another prompt, after which the second FAIL is produced. Note that the timeout is silent because the gdb_test_multiple is called with an empty message argument. The second FAIL is because capture_command_output returns "", given that all the command output was consumed by the first gdb_test_multiple. Fix this by rewriting capture_command_output to use only a single gdb_test_multiple. Tested on x86_64-linux. Committed to trunk. Thanks, - Tom [gdb/testsuite] Fix prompt parsing in capture_command_output --- .../gdb.testsuite/capture-command-output.exp | 38 ++++++++++++++++++++++ gdb/testsuite/lib/gdb.exp | 32 ++++++++---------- 2 files changed, 51 insertions(+), 19 deletions(-) diff --git a/gdb/testsuite/gdb.testsuite/capture-command-output.exp b/gdb/testsuite/gdb.testsuite/capture-command-output.exp new file mode 100644 index 00000000000..a48ceb0d65c --- /dev/null +++ b/gdb/testsuite/gdb.testsuite/capture-command-output.exp @@ -0,0 +1,38 @@ +# Copyright 2022 Free Software Foundation, Inc. +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# The purpose of this test-case is to test the capture_command_output proc. + +clean_restart + +# Check output with no prefix. + +with_test_prefix no-prefix { + set output [capture_command_output "print 1" ""] + gdb_assert { [string equal $output "\$1 = 1"] } +} + +# Check output with matching prefix. + +with_test_prefix matching-prefix { + set output [capture_command_output "print 1" "\\\$2 = "] + gdb_assert { [string equal $output "1"] } +} + +# Check output with non-matching prefix. + +with_test_prefix non-matching-prefix { + set output [capture_command_output "print 1" "3 = "] + gdb_assert { [string equal $output "\$3 = 1"] } +} diff --git a/gdb/testsuite/lib/gdb.exp b/gdb/testsuite/lib/gdb.exp index f53d90edd00..61bc060b2f7 100644 --- a/gdb/testsuite/lib/gdb.exp +++ b/gdb/testsuite/lib/gdb.exp @@ -7888,27 +7888,10 @@ proc capture_command_output { command prefix } { global gdb_prompt global expect_out - set code { - -re "^[string_to_regexp ${command}]\r\n" { - if { $prefix != "" } { - exp_continue - } - } - } - - if { $prefix != "" } { - append code { - -re "^${prefix}" { - # Nothing, we just move onto the next gdb_test_multiple - # call, which actually collects the command output. - } - } - } - - gdb_test_multiple "$command" "capture_command_output for $command" $code + set test "capture_command_output for $command" set output_string "" - gdb_test_multiple "" "" { + gdb_test_multiple $command $test { -re "^(\[^\r\n\]+\r\n)" { if { ![string equal $output_string ""] } { set output_string [join [list $output_string $expect_out(1,string)] ""] @@ -7922,7 +7905,18 @@ proc capture_command_output { command prefix } { } } + # Strip the command. + set command_re [string_to_regexp ${command}] + set output_string [regsub ^$command_re\r\n $output_string ""] + + # Strip the prefix. + if { $prefix != "" } { + set output_string [regsub ^$prefix $output_string ""] + } + + # Strip a trailing newline. set output_string [regsub "\r\n$" $output_string ""] + return $output_string }