From patchwork Mon Jul 29 09:33:01 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tom de Vries X-Patchwork-Id: 33838 Received: (qmail 124491 invoked by alias); 29 Jul 2019 09:33:13 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Delivered-To: mailing list gdb-patches@sourceware.org Received: (qmail 124312 invoked by uid 89); 29 Jul 2019 09:33:13 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-26.3 required=5.0 tests=AWL, BAYES_00, GIT_PATCH_0, GIT_PATCH_1, GIT_PATCH_2, GIT_PATCH_3, SPF_PASS autolearn=ham version=3.3.1 spammy=worry, 1000000, 83, expect_out X-HELO: mx1.suse.de Received: from mx2.suse.de (HELO mx1.suse.de) (195.135.220.15) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Mon, 29 Jul 2019 09:33:11 +0000 Received: from relay2.suse.de (unknown [195.135.220.254]) by mx1.suse.de (Postfix) with ESMTP id CC3F7B609; Mon, 29 Jul 2019 09:33:08 +0000 (UTC) Subject: Re: [PATCH][gdb/testsuite] Don't expect gdb_prompt in mi_skip_python_test To: Simon Marchi , gdb-patches@sourceware.org References: <20190727175221.GA9077@delia> <0389a280-4dc8-5e4c-fb4c-bc7c41f52afc@simark.ca> From: Tom de Vries Openpgp: preference=signencrypt Message-ID: Date: Mon, 29 Jul 2019 11:33:01 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.6.1 MIME-Version: 1.0 In-Reply-To: <0389a280-4dc8-5e4c-fb4c-bc7c41f52afc@simark.ca> X-IsSubscribed: yes On 28-07-19 05:18, Simon Marchi wrote: > On 2019-07-27 1:52 p.m., Tom de Vries wrote: >> Hi, >> >> During an openSUSE package build using 8.3 sources, I ran into this error >> with gdb.python/py-mi-events.exp: >> ... >> python print ('test')^M >> &"python print ('test')\n"^M >> ~"test\n"^M >> ^done^M >> (gdb) ^M >> python print (sys.version_info[0])^M >> &"python print (sys.version_info[0])\n"^M >> ~"3\n"^M >> ^done^M >> (gdb) FAIL: gdb.python/py-mi-events.exp: check if python 3 >> ERROR: tcl error sourcing gdb-8.3/gdb/testsuite/gdb.python/py-mi-events.exp. >> ERROR: can't read "gdb_py_is_py3k": no such variable >> while executing >> "if { $gdb_py_is_py3k == 0 } { >> gdb_test_multiple "python print (sys.version_info\[1\])" \ >> "check if python 2.4" { >> -re "\[45\].*$prompt_regex..." >> (procedure "skip_python_tests_prompt" line 22) >> invoked from within >> "skip_python_tests_prompt "$mi_gdb_prompt$"" >> (procedure "mi_skip_python_tests" line 3) >> invoked from within >> ... >> >> I managed to reproduce the error on 8.3 using a trigger patch: >> ... >> diff --git a/gdb/mi/mi-interp.c b/gdb/mi/mi-interp.c >> index 3e9f36897a..7be00ef9e8 100644 >> --- a/gdb/mi/mi-interp.c >> +++ b/gdb/mi/mi-interp.c >> @@ -38,6 +38,7 @@ >> #include "cli-out.h" >> #include "thread-fsm.h" >> #include "cli/cli-interp.h" >> +#include "gdb_usleep.h" >> >> /* These are the interpreter setup, etc. functions for the MI >> interpreter. */ >> @@ -96,7 +97,10 @@ display_mi_prompt (struct mi_interp *mi) >> { >> struct ui *ui = current_ui; >> >> - fputs_unfiltered ("(gdb) \n", mi->raw_stdout); >> + fputs_unfiltered ("(gdb) ", mi->raw_stdout); >> + gdb_flush (mi->raw_stdout); >> + gdb_usleep (1000000); >> + fputs_unfiltered ("\n", mi->raw_stdout); >> gdb_flush (mi->raw_stdout); >> ui->prompt_state = PROMPTED; >> } >> ... >> >> The error happens as follows. >> >> On one hand, skip_python_tests_prompt uses the prompt_regexp parameter for the >> user_code argument of gdb_test_multiple: >> ... >> proc skip_python_tests_prompt { prompt_regexp } { >> global gdb_py_is_py3k >> >> ... >> >> gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" { >> -re "3.*$prompt_regexp" { >> set gdb_py_is_py3k 1 >> } >> -re ".*$prompt_regexp" { >> set gdb_py_is_py3k 0 >> } >> } >> ... >> >> On the otherhand, gdb_test_multiple itself uses $gdb_prompt: >> ... >> -re "\r\n$gdb_prompt $" { >> if ![string match "" $message] then { >> fail "$message" >> } >> set result 1 >> } >> ... >> >> So when mi_skip_python_test calls skip_python_tests_prompt with prompt_regexp >> set to $mi_gdb_prompt: >> ... >> proc mi_skip_python_tests {} { >> global mi_gdb_prompt >> return [skip_python_tests_prompt "$mi_gdb_prompt$"] >> } >> ... >> and expect reads "(gdb) " (due to the trigger patch) and tries to match it, >> the user_code regexps using $prompt_regexp (set to $mi_gdb_prompt) don't match, >> but the $gdb_prompt regexp in gdb_test_multiple does match. >> >> Fix this by adding a prompt_regexp parameter to gdb_test_multiple, and using the >> parameter in skip_python_tests_prompt. >> >> Tested gdb.python/py-mi-events.exp in combination with trigger patch on >> x86_64-linux. >> >> Tested on x86_64-linux. >> >> OK for trunk? >> >> [ >> - There may be mi test-cases that use gdb_test_multiple that also need >> fixing, but I'd rather get agreement on the fix first. >> - I initially tried to fix this by adding a gdb_test_multiple_prompt but I >> didn't get that working. I can post a follow-up patch doing the refactoring >> for that if required, but I rather handle that in a separate patch, since >> this seems to be non-trivial. ] > > Hi Tom, > > It seems like this failure is reproducible using "make check-read1". It is indeed. > If you haven't > seen that before, check it out in gdb/testsuite/README, Thanks for the pointer. I've rewritten the rationale to use this concept rather than the trigger patch to reproduce the failure. > I'm sure you'll find dozens > of other testsuite bugs with it :). I did a testrun overnight, and yes, that's indeed the case :) > As for the issue itself, I guess the root problem is that we're using gdb_test_multiple, which > was meant for the CLI, in an MI setting. I was afraid that the regexp made to match the various > errors, such as: > > -re "Undefined\[a-z\]* command:.*$gdb_prompt $" > > wouldn't work in MI, but the way they are written, they should match this, for example: > > hello > &"hello\n" > &"Undefined command: \"hello\". Try \"help\".\n" > ^error,msg="Undefined command: \"hello\". Try \"help\"." > (gdb) > > So the fix looks reasonable to me too (at least, I can't think of anything better at the moment). > Committed as below. Thanks, - Tom [gdb/testsuite] Don't expect gdb_prompt in mi_skip_python_test When running gdb.python/py-mi-events.exp with make check-read1, we get: ... (gdb) ^M python print ('test')^M &"python print ('test')\n"^M ~"test\n"^M ^done^M (gdb) FAIL: gdb.python/py-mi-events.exp: verify python support ^M python print (sys.version_info[0])^M &"python print (sys.version_info[0])\n"^M ~"2\n"^M ^done^M (gdb) FAIL: gdb.python/py-mi-events.exp: check if python 3 ^M ... The FAILs happen as follows. On one hand, skip_python_tests_prompt uses the prompt_regexp parameter for the user_code argument of gdb_test_multiple: ... proc skip_python_tests_prompt { prompt_regexp } { global gdb_py_is_py3k gdb_test_multiple "python print ('test')" "verify python support" { -re "not supported.*$prompt_regexp" { unsupported "Python support is disabled." return 1 } -re "$prompt_regexp" {} } gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" { -re "3.*$prompt_regexp" { set gdb_py_is_py3k 1 } -re ".*$prompt_regexp" { set gdb_py_is_py3k 0 } } ... On the other hand, gdb_test_multiple itself uses $gdb_prompt: ... -re "\r\n$gdb_prompt $" { if ![string match "" $message] then { fail "$message" } set result 1 } ... So when mi_skip_python_test calls skip_python_tests_prompt with prompt_regexp set to $mi_gdb_prompt: ... proc mi_skip_python_tests {} { global mi_gdb_prompt return [skip_python_tests_prompt "$mi_gdb_prompt$"] } ... and expect reads "(gdb) " and tries to match it (due to the READ1=1 setting), the user_code regexps using $prompt_regexp (set to $mi_gdb_prompt) don't match, but the $gdb_prompt regexp in gdb_test_multiple does match. Fix this by adding a prompt_regexp parameter to gdb_test_multiple, and using the parameter in skip_python_tests_prompt. Tested gdb.python/py-mi-events.exp with make check READ1=1 x86_64-linux. Tested on x86_64-linux. gdb/testsuite/ChangeLog: 2019-07-27 Tom de Vries PR gdb/24855 * lib/gdb.exp (gdb_test_multiple): Add prompt_regexp parameter. (skip_python_tests_prompt): Add prompt_regexp argument to gdb_test_multiple calls. --- gdb/testsuite/lib/gdb.exp | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/gdb/testsuite/lib/gdb.exp b/gdb/testsuite/lib/gdb.exp index 54cee2ec41..4c7d3b5546 100644 --- a/gdb/testsuite/lib/gdb.exp +++ b/gdb/testsuite/lib/gdb.exp @@ -695,7 +695,7 @@ proc gdb_internal_error_resync {} { } -# gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS +# gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS PROMPT_REGEXP # Send a command to gdb; test the result. # # COMMAND is the command to execute, send to GDB with send_gdb. If @@ -707,6 +707,8 @@ proc gdb_internal_error_resync {} { # context; action elements will be executed in the caller's context. # Unlike patterns for gdb_test, these patterns should generally include # the final newline and prompt. +# PROMPT_REGEXP is a regexp matching the expected prompt after the command +# output. If empty, defaults to "$gdb_prompt $" # # Returns: # 1 if the test failed, according to a built-in failure pattern @@ -744,7 +746,7 @@ proc gdb_internal_error_resync {} { # expected from $gdb_spawn_id. IOW, callers do not need to worry # about resetting "-i" back to $gdb_spawn_id explicitly. # -proc gdb_test_multiple { command message user_code } { +proc gdb_test_multiple { command message user_code { prompt_regexp "" } } { global verbose use_gdb_stub global gdb_prompt pagination_prompt global GDB @@ -754,6 +756,10 @@ proc gdb_test_multiple { command message user_code } { upvar expect_out expect_out global any_spawn_id + if { "$prompt_regexp" == "" } { + set prompt_regexp "$gdb_prompt $" + } + if { $message == "" } { set message $command } @@ -913,7 +919,7 @@ proc gdb_test_multiple { command message user_code } { } append code { - -re "Ending remote debugging.*$gdb_prompt $" { + -re "Ending remote debugging.*$prompt_regexp" { if ![isnative] then { warning "Can`t communicate to remote target." } @@ -921,17 +927,17 @@ proc gdb_test_multiple { command message user_code } { gdb_start set result -1 } - -re "Undefined\[a-z\]* command:.*$gdb_prompt $" { + -re "Undefined\[a-z\]* command:.*$prompt_regexp" { perror "Undefined command \"$command\"." fail "$message" set result 1 } - -re "Ambiguous command.*$gdb_prompt $" { + -re "Ambiguous command.*$prompt_regexp" { perror "\"$command\" is not a unique command name." fail "$message" set result 1 } - -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" { + -re "$inferior_exited_re with code \[0-9\]+.*$prompt_regexp" { if ![string match "" $message] then { set errmsg "$message (the program exited)" } else { @@ -940,7 +946,7 @@ proc gdb_test_multiple { command message user_code } { fail "$errmsg" set result -1 } - -re "$inferior_exited_re normally.*$gdb_prompt $" { + -re "$inferior_exited_re normally.*$prompt_regexp" { if ![string match "" $message] then { set errmsg "$message (the program exited)" } else { @@ -949,7 +955,7 @@ proc gdb_test_multiple { command message user_code } { fail "$errmsg" set result -1 } - -re "The program is not being run.*$gdb_prompt $" { + -re "The program is not being run.*$prompt_regexp" { if ![string match "" $message] then { set errmsg "$message (the program is no longer running)" } else { @@ -958,7 +964,7 @@ proc gdb_test_multiple { command message user_code } { fail "$errmsg" set result -1 } - -re "\r\n$gdb_prompt $" { + -re "\r\n$prompt_regexp" { if ![string match "" $message] then { fail "$message" } @@ -972,13 +978,13 @@ proc gdb_test_multiple { command message user_code } { } -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " { send_gdb "n\n" answer - gdb_expect -re "$gdb_prompt $" + gdb_expect -re "$prompt_regexp" fail "$message (got interactive prompt)" set result -1 } -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" { send_gdb "0\n" - gdb_expect -re "$gdb_prompt $" + gdb_expect -re "$prompt_regexp" fail "$message (got breakpoint menu)" set result -1 } @@ -1869,7 +1875,7 @@ proc skip_python_tests_prompt { prompt_regexp } { return 1 } -re "$prompt_regexp" {} - } + } "$prompt_regexp" gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" { -re "3.*$prompt_regexp" { @@ -1878,7 +1884,7 @@ proc skip_python_tests_prompt { prompt_regexp } { -re ".*$prompt_regexp" { set gdb_py_is_py3k 0 } - } + } "$prompt_regexp" return 0 }