[PATCH][gdb/testsuite] Reimplement complaints selftest as unittest

Tom de Vries via Gdb-patches
2021-09-02T13:43:27Z

Hi,

When building gdb with "-Wall -O2 -g -flto=auto", I run into:
...
(gdb) call clear_complaints()^M
No symbol "clear_complaints" in current context.^M
(gdb) FAIL: gdb.gdb/complaints.exp: clear complaints
...

The problem is that lto has optimized away the clear_complaints function
and consequently the selftest doesn't work.

Fix this by reimplementing the selftest as a unit test.

Something specific to the new unittest is that we check the output as well.
To this end, we add SELFTEST_OUTPUT and SELFTEST_EXPECTED_OUTPUT markers:
...
$ gdb -q -batch -ex "maint selftest complaints"
Running selftest complaints.
SELFTEST_OUTPUT: <<<
During symbol reading: maintenance complaint 0
SELFTEST_OUTPUT: >>>
EXPECTED_OUTPUT: <<<
During symbol reading: maintenance complaint 0
EXPECTED_OUTPUT: >>>
SELFTEST_OUTPUT: <<<
During symbol reading: maintenance complaint 0
SELFTEST_OUTPUT: >>>
EXPECTED_OUTPUT: <<<
During symbol reading: maintenance complaint 0
EXPECTED_OUTPUT: >>>
SELFTEST_OUTPUT: <<<
SELFTEST_OUTPUT: >>>
EXPECTED_OUTPUT: <<<
EXPECTED_OUTPUT: >>>
SELFTEST_OUTPUT: <<<
During symbol reading: maintenance complaint 1
SELFTEST_OUTPUT: >>>
EXPECTED_OUTPUT: <<<
During symbol reading: maintenance complaint 1
EXPECTED_OUTPUT: >>>
SELFTEST_OUTPUT: <<<
During symbol reading: maintenance complaint 0
SELFTEST_OUTPUT: >>>
EXPECTED_OUTPUT: <<<
During symbol reading: maintenance complaint 0
EXPECTED_OUTPUT: >>>
Ran 1 unit tests, 0 failed
$
...
and added support for checking this in gdb.gdb/unittests.exp, such that we
get:
...
PASS: gdb.gdb/unittest.exp: no executable loaded: complaints: output check: 0
PASS: gdb.gdb/unittest.exp: no executable loaded: complaints: output check: 1
PASS: gdb.gdb/unittest.exp: no executable loaded: complaints: output check: 2
PASS: gdb.gdb/unittest.exp: no executable loaded: complaints: output check: 3
PASS: gdb.gdb/unittest.exp: no executable loaded: complaints: output check: 4
...

Tested on x86_64-linux.

Any comments?

Thanks,
- Tom

[gdb/testsuite] Reimplement complaints selftest as unittest

---
gdb/complaints.c | 61 ++++++++++++++++++
gdb/testsuite/gdb.gdb/complaints.exp | 117 -----------------------------------
gdb/testsuite/gdb.gdb/unittest.exp | 51 ++++++++++++++-
3 files changed, 109 insertions(+), 120 deletions(-)

diff --git a/gdb/complaints.c b/gdb/complaints.c
index fecbcd74ce5..e8cd85b39fe 100644
--- a/gdb/complaints.c
+++ b/gdb/complaints.c
@@ -21,6 +21,7 @@
#include "complaints.h"
#include "command.h"
#include "gdbcmd.h"
+#include "gdbsupport/selftest.h"
#include <unordered_map>

/* Map format strings to counters. */
@@ -74,6 +75,62 @@ complaints_show_value (struct ui_file *file, int from_tty,
value);
}

+#if GDB_SELF_TEST
+namespace selftests {
+
+#define CHECK_OUTPUT(CMD, SILENT_P, ...) \
+ do \
+ { \
+ fprintf_filtered (gdb_stderr, "SELFTEST_OUTPUT: <<<\n"); \
+ CMD; \
+ fprintf_filtered (gdb_stderr, "SELFTEST_OUTPUT: >>>\n"); \
+ fprintf_filtered (gdb_stderr, "EXPECTED_OUTPUT: <<<\n"); \
+ if (!(SILENT_P)) \
+ fprintf_filtered (gdb_stderr, __VA_ARGS__); \
+ fprintf_filtered (gdb_stderr, "EXPECTED_OUTPUT: >>>\n"); \
+ } while (0)
+
+#define CHECK_COMPLAINT(STR, CNT) \
+ do \
+ { \
+ CHECK_OUTPUT (complaint (STR), 0, \
+ "%s%s\n", _("During symbol reading: "), \
+ STR); \
+ SELF_CHECK (counters[STR] == CNT); \
+ } while (0)
+
+/* Use "dummy" to avoid a Werror=format-zero-length. */
+#define CHECK_COMPLAINT_SILENT(STR, CNT) \
+ do \
+ { \
+ CHECK_OUTPUT (complaint (STR), 1, "dummy"); \
+ SELF_CHECK (counters[STR] == CNT); \
+ } while (0)
+
+/* Entry point for complaints unit tests. */
+
+static void
+test_complaints ()
+{
+ std::unordered_map<const char *, int> tmp;
+ scoped_restore reset_counters = make_scoped_restore (&counters, tmp);
+ scoped_restore reset_stop_whining = make_scoped_restore (&stop_whining, 2);
+
+ CHECK_COMPLAINT ("maintenance complaint 0", 1);
+ CHECK_COMPLAINT ("maintenance complaint 0", 2);
+ CHECK_COMPLAINT_SILENT ("maintenance complaint 0", 3);
+ CHECK_COMPLAINT ("maintenance complaint 1", 1);
+ clear_complaints ();
+ CHECK_COMPLAINT ("maintenance complaint 0", 1);
+}
+
+#undef CHECK_OUTPUT
+#undef CHECK_COMPLAINT
+#undef CHECK_COMPLAINT_SILENT
+
+} // namespace selftests
+#endif /* GDB_SELF_TEST */
+
void _initialize_complaints ();
void
_initialize_complaints ()
@@ -84,4 +141,8 @@ Set max number of complaints about incorrect symbols."), _("\
Show max number of complaints about incorrect symbols."), NULL,
NULL, complaints_show_value,
&setlist, &showlist);
+
+#if GDB_SELF_TEST
+ selftests::register_test ("complaints", selftests::test_complaints);
+#endif /* GDB_SELF_TEST */
}
diff --git a/gdb/testsuite/gdb.gdb/complaints.exp b/gdb/testsuite/gdb.gdb/complaints.exp
deleted file mode 100644
index c70825b6623..00000000000
--- a/gdb/testsuite/gdb.gdb/complaints.exp
+++ /dev/null
@@ -1,117 +0,0 @@
-# Copyright 2002-2021 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 <http://www.gnu.org/licenses/>.
-
-# This file was written by Andrew Cagney (cagney at redhat dot com),
-# derived from xfullpath.exp (written by Joel Brobecker), derived from
-# selftest.exp (written by Rob Savoye).
-
-load_lib selftest-support.exp
-
-if [target_info exists gdb,noinferiorio] {
- verbose "Skipping because of no inferiorio capabilities."
- return
-}
-
-# Similar to gdb_test_stdio, except no \r\n is expected before
-# $gdb_prompt in the $gdb_spawn_id.
-
-proc test_complaint {test inferior_io_re msg} {
- global inferior_spawn_id gdb_spawn_id
- global gdb_prompt
-
- set inferior_matched 0
- set gdb_matched 0
-
- gdb_test_multiple $test $msg {
- -i $inferior_spawn_id -re "$inferior_io_re" {
- set inferior_matched 1
- if {!$gdb_matched} {
- exp_continue
- }
- }
- -i $gdb_spawn_id -re "$gdb_prompt $" {
- set gdb_matched 1
- if {!$inferior_matched} {
- exp_continue
- }
- }
- }
-
- verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
- gdb_assert {$inferior_matched && $gdb_matched} $msg
-}
-
-proc test_initial_complaints { } {
- # Unsupress complaints
- gdb_test "set stop_whining = 2"
-
- gdb_test_no_output "set var \$cstr = \"Register a complaint\""
-
- # Prime the system
- gdb_test_stdio \
- "call complaint_internal (\$cstr)" \
- "During symbol reading: Register a complaint"
-
- # Re-issue the first message #1
- with_test_prefix "re-issue" {
- gdb_test_stdio \
- "call complaint_internal (\$cstr)" \
- "During symbol reading: Register a complaint"
- }
-
- # Add a second complaint, expect it
- gdb_test_stdio \
- "call complaint_internal (\"Testing! Testing! Testing!\")" \
- "During symbol reading: Testing. Testing. Testing."
-
- return 0
-}
-
-# Check that nothing comes out when there haven't been any real
-# complaints. Note that each test is really checking the previous
-# command.
-
-proc test_empty_complaint { cmd msg } {
- global gdb_prompt
- global inferior_spawn_id gdb_spawn_id
-
- if {$gdb_spawn_id == $inferior_spawn_id} {
- gdb_test_no_output $cmd $msg
- } else {
- set seen_output 0
- gdb_test_multiple $cmd $msg {
- -i $inferior_spawn_id -re "." {
- set seen_output 1
- exp_continue
- }
- -i $gdb_spawn_id "$gdb_prompt $" {
- gdb_assert !$seen_output $msg
- }
- }
- }
-}
-
-proc test_empty_complaints { } {
-
- test_empty_complaint "call clear_complaints()" \
- "clear complaints"
-
- return 0
-}
-
-do_self_tests captured_command_loop {
- test_initial_complaints
- test_empty_complaints
-}
diff --git a/gdb/testsuite/gdb.gdb/unittest.exp b/gdb/testsuite/gdb.gdb/unittest.exp
index 61a6c0efb4b..2be2306ff99 100644
--- a/gdb/testsuite/gdb.gdb/unittest.exp
+++ b/gdb/testsuite/gdb.gdb/unittest.exp
@@ -39,15 +39,47 @@ proc run_selftests { binfile } {
}

set test "maintenance selftest"
+ set selftest ""
+ set output ""
+ set reading_output 0
+ set expected_output ""
+ set reading_expected_output 0
+ set output_check_counter 0
gdb_test_multiple $test $test {
- -re ".*Running selftest \[^\n\r\]+\." {
+ -re "^$test" {
+ exp_continue
+ }
+ -re "^\r\nSELFTEST_OUTPUT: <<<" {
+ set reading_output 1
+ exp_continue
+ }
+ -re "^\r\nSELFTEST_OUTPUT: >>>" {
+ set reading_output 0
+ exp_continue
+ }
+ -re "^\r\nEXPECTED_OUTPUT: <<<" {
+ set reading_expected_output 1
+ exp_continue
+ }
+ -re "^\r\nEXPECTED_OUTPUT: >>>" {
+ set reading_expected_output 0
+ gdb_assert { [string equal $output $expected_output] } \
+ "$selftest: output check: $output_check_counter"
+ incr output_check_counter
+ #puts "OUTPUT: '$output'"
+ set output ""
+ set expected_output ""
+ exp_continue
+ }
+ -re "^\r\nRunning selftest (\[^\n\r\]+)\\." {
# The selftests can take some time to complete. To prevent
# timeout spot the 'Running ...' lines going past, so long as
# these are produced quickly enough then the overall test will
# not timeout.
+ set selftest $expect_out(1,string)
exp_continue
}
- -re "Ran ($decimal) unit tests, ($decimal) failed\r\n$gdb_prompt $" {
+ -re "^\r\nRan ($decimal) unit tests, ($decimal) failed" {
set num_ran $expect_out(1,string)
set num_failed $expect_out(2,string)
gdb_assert "$num_ran > 0" "$test, ran some tests"
@@ -59,10 +91,23 @@ proc run_selftests { binfile } {
setup_kfail "gdb/27891" "*-*-*"
}
gdb_assert "$num_failed == 0" "$test, failed none"
+ gdb_test "" "Consume prompt"
}
- -re "Selftests have been disabled for this build.\r\n$gdb_prompt $" {
+ -re "^\r\nSelftests have been disabled for this build\\." {
+ gdb_test "" "Consume prompt"
unsupported $test
}
+ -re "^\r\n(\[^\r\n\]*)(?=\r\n)" {
+ set line $expect_out(1,string)
+ if { $reading_output } {
+ append output "$line\n"
+ } elseif { $reading_expected_output } {
+ append expected_output "$line\n"
+ } else {
+ verbose -log "Skipping line: '$line'"
+ }
+ exp_continue
+ }
}
}