[PATCHv2] gdb/testsuite: modernize gdb.base/maint.exp

[Bruno Larsen <blarsen@redhat.com>]

Sorry, forgot to update the title to v2, but it is the correct patch.

Cheers!
Bruno Larsen

On 6/21/22 16:45, Bruno Larsen wrote:
> gdb.base/maint.exp was using several gdb_expect statements, probably
> because this test case predates the existance of gdb_test_multiple. This
> commit updates the test case to use gdb_test_multiple, making it more
> resilient to internal errors and such.
> 
> The only gdb_expect left in the testcase is one that specifically looks
> for an internal error being triggered as a PASS.
> ---
> 
> Changes for v2:
>   - Addressed Andrew's comments
>   - rebased on current master.
> 
> ---
> 
>   gdb/testsuite/gdb.base/maint.exp | 130 +++++++++++--------------------
>   1 file changed, 46 insertions(+), 84 deletions(-)
> 
> diff --git a/gdb/testsuite/gdb.base/maint.exp b/gdb/testsuite/gdb.base/maint.exp
> index 2817c6eafb9..31b999073f9 100644
> --- a/gdb/testsuite/gdb.base/maint.exp
> +++ b/gdb/testsuite/gdb.base/maint.exp
> @@ -151,22 +151,28 @@ set have_psyms [expr ! ( $have_gdb_index || $readnow_p )]
>   # unless there is some problem with the symtabs and psymtabs
>   # so that branch will really never be covered in this tests here!!
>   #
> +# When there is a problem, there may be loads of output, which can
> +# overwhelm the expect buffer. Splitting it seems to fix those
> +# issues.
> +
> +set seen_command 0
> +gdb_test_multiple "maint check-psymtabs" "" {
> +    -re "^maint check-psymtabs\r\n" {
> +	set seen_command 1
> +	exp_continue
> +    }
>   
> -# guo: on linux this command output is huge.  for some reason splitting up
> -# the regexp checks works.
> -#
> -send_gdb "maint check-psymtabs\n"
> -gdb_expect  {
> -    -re "^maint check-psymtabs" {
> -	gdb_expect {
> -	    -re "$gdb_prompt $" {
> -		pass "maint check-psymtabs"
> -	    }
> -	    timeout { fail "(timeout) maint check-psymtabs" }
> +    -re "^$gdb_prompt $" {
> +	if { $seen_command == 1 } {
> +	    pass "maint check-psymtabs"
> +	} else {
> +	    fail $gdb_test_name
>   	}
>       }
> -    -re ".*$gdb_prompt $"     { fail "maint check-psymtabs" }
> -    timeout         { fail "(timeout) maint check-psymtabs" }
> +
> +    -re "^\[^\r\n\]+\r\n" {
> +	exp_continue
> +    }
>   }
>   
>   # This command does not produce any output unless there is some problem
> @@ -272,62 +278,37 @@ if { $have_psyms } {
>   		       "maint print psymbols -pc" \
>   		       "maint print psymbols -pc main $psymbols_output"]
>       foreach { test_name command } $test_list {
> -	send_gdb "$command\n"
> -	    gdb_expect  {
> -		-re "^maint print psymbols \[^\n\]*\r\n$gdb_prompt $" {
> -		    send_gdb "shell ls $psymbols_output\n"
> -		    gdb_expect {
> -			-re "$psymbols_output_re\r\n$gdb_prompt $" {
> -			    # We want this grep to be as specific as possible,
> -			    # so it's less likely to match symbol file names in
> -			    # psymbols_output.  Yes, this actually happened;
> -			    # poor expect got tons of output, and timed out
> -			    # trying to match it.   --- Jim Blandy <jimb@cygnus.com>
> -			    send_gdb "shell grep 'main.*function' $psymbols_output\n"
> -			    gdb_expect {
> -				-re ".main., function, $hex.*$gdb_prompt $" {
> -				    pass "$test_name 1"
> -				}
> -				-re ".*main.  .., function, $hex.*$gdb_prompt $" {
> -				    pass "$test_name 2"
> -				}
> -				-re ".*$gdb_prompt $" { fail "$test_name" }
> -				timeout { fail "$test_name (timeout)" }
> -			    }
> -			    gdb_test "shell rm -f $psymbols_output" ".*" \
> -				"${test_name}: shell rm -f psymbols_output"
> +	gdb_test_multiple "$command" "$test_name" {
> +	    -re  -wrap "^maint print psymbols \[^\n\]*" {
> +		gdb_test_multiple "shell grep 'main.*function' $psymbols_output" \
> +		    "$test_name internal" {
> +			-re -wrap ".main., function, $hex.*" {
> +			    pass "$test_name, pattern 1"
> +			}
> +			-re -wrap ".*main.  .., function, $hex.*" {
> +			    pass "$test_name, pattern 2"
>   			}
> -			-re ".*$gdb_prompt $" { fail "$test_name" }
> -			timeout { fail "$test_name (timeout)" }
> -		    }
>   		}
> -		-re ".*$gdb_prompt $" { fail "$test_name" }
> -		timeout { fail "$test_name (timeout)" }
>   	    }
> +	}
> +	gdb_test "shell rm -f $psymbols_output" ".*" \
> +	    "${test_name}: shell rm -f psymbols_output"
>       }
>   }
>   
>   
>   set msymbols_output [standard_output_file msymbols_output]
>   set msymbols_output_re [string_to_regexp $msymbols_output]
> -send_gdb "maint print msymbols -objfile ${binfile} $msymbols_output\n"
> -gdb_expect  {
> -    -re "^maint print msymbols \[^\n\]*\r\n$gdb_prompt $" {
> -	send_gdb "shell ls $msymbols_output\n"
> -	gdb_expect {
> -	    -re "$msymbols_output_re\r\n$gdb_prompt $" {
> -		gdb_test "shell grep factorial $msymbols_output" \
> -		    "\\\[ *$decimal\\\] \[tT\]\[ \t\]+$hex \\.?factorial.*" \
> -		    "maint print msymbols, absolute pathname"
> -		gdb_test "shell rm -f $msymbols_output" ".*" \
> -		    "shell rm -f msymbols_output"
> -	    }
> -	    -re ".*$gdb_prompt $" { fail "maint print msymbols" }
> -	    timeout { fail "maint print msymbols (timeout)" }
> -	}
> +gdb_test_multiple "maint print msymbols -objfile ${binfile} $msymbols_output" \
> +		    "printing msymbols" {
> +
> +    -re -wrap "^maint print msymbols \[^\n\]*" {
> +	gdb_test "shell grep factorial $msymbols_output" \
> +	    "\\\[ *$decimal\\\] \[tT\]\[ \t\]+$hex \\.?factorial.*" \
> +	    "maint print msymbols, absolute pathname"
> +	gdb_test "shell rm -f $msymbols_output" ".*" \
> +	    "shell rm -f msymbols_output"
>       }
> -    -re ".*$gdb_prompt $" { fail "maint print msymbols" }
> -    timeout { fail "maint print msymbols (timeout)" }
>   }
>   
>   # Check that maint print msymbols allows relative pathnames
> @@ -365,31 +346,12 @@ set test_list [list \
>   		   "maint print symbols -pc" \
>   		   "maint print symbols -pc main $symbols_output"]
>   foreach { test_name command } $test_list {
> -    send_gdb "$command\n"
> -    gdb_expect {
> -	-re "^maint print symbols \[^\n\]*\r\n$gdb_prompt $" {
> -	    send_gdb "shell ls $symbols_output\n"
> -	    gdb_expect {
> -		-re "$symbols_output_re\r\n$gdb_prompt $" {
> -		    # See comments for `maint print psymbols'.
> -		    send_gdb "shell grep 'main(.*block' $symbols_output\n"
> -		    gdb_expect {
> -			-re "int main\\(int, char \\*\\*, char \\*\\*\\); block.*$gdb_prompt $" {
> -			    pass "$test_name"
> -			}
> -			-re ".*$gdb_prompt $" { fail "$test_name" }
> -			timeout { fail "$test_name (timeout)" }
> -		    }
> -		    gdb_test "shell rm -f $symbols_output" ".*" \
> -			"$test_name: shell rm -f symbols_output"
> -		}
> -		-re ".*$gdb_prompt $" { fail "$test_name" }
> -		timeout { fail "$test_name (timeout)" }
> -	    }
> -	}
> -	-re ".*$gdb_prompt $" { fail "$test_name" }
> -	timeout { fail "$test_name (timeout)" }
> -    }
> +    gdb_test_no_output "$command" "$test_name generate"
> +    gdb_test "shell grep 'main(.*block' $symbols_output"\
> +	"int main\\(int, char \\*\\*, char \\*\\*\\); block.*"\
> +	"$test_name read"
> +    gdb_test "shell rm -f $symbols_output" ".*" \
> +	"$test_name: shell rm -f symbols_output"
>   }
>   
>   set msg "maint print type"