[RFA,3/4] Update tests following changes to "help" and "apropos"
Commit Message
Factorizes the testing of the help output, by having a single place
that defines the common help trailer and/or prefix messages.
---
gdb/testsuite/ChangeLog | 13 +++++++
gdb/testsuite/gdb.base/help.exp | 30 ++++++++--------
gdb/testsuite/gdb.guile/scm-cmd.exp | 4 +--
gdb/testsuite/gdb.python/py-cmd.exp | 2 +-
gdb/testsuite/gdb.trace/tracecmd.exp | 2 +-
gdb/testsuite/lib/gdb.exp | 51 +++++++++++++++++++++-------
6 files changed, 69 insertions(+), 33 deletions(-)
Comments
>>>>> "Philippe" == Philippe Waroquiers <philippe.waroquiers@skynet.be> writes:
Philippe> Factorizes the testing of the help output, by having a single place
Philippe> that defines the common help trailer and/or prefix messages.
Philippe> -test_class_help "aliases" {"Aliases of other commands\.\[\r\n\]+"}
Philippe> +test_class_help "aliases" {"Aliases of other commands\.\[\r\n\]+"} {}
Wow, test_class_help is ugly!
Or more precisely, help_test_raw is pretty bad, following the "args"
convention that is confusing:
proc help_test_raw { gdb_command expected_lines args } {
set message $gdb_command
if [llength $args]>0 then {
set message [lindex $args 0]
}
It seems like it would be way better to just have an optional argument
there.
Anyway, could the new argument to test_class_help be optional? Then
some of the changes, like the one above, would not be needed. It could
also change from using args to using an optional final param:
proc test_class_help {command_class expected_initial_lines {list_of_commands {}} {test_name {}}} {
Then at the end instead of eval it could just make a direct call:
- eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
+ help_test_raw "help ${command_class}" $l_entire_body $test_name
To make this work, the help_test_raw change would have to be made.
Philippe> +# Like test_class_help but specialised to test "help user-defined".
Philippe> +proc test_user_defined_class_help { list_of_commands args } {
Philippe> + test_class_help "user-defined" {
Philippe> + "User-defined commands\.[\r\n]+"
Philippe> + "The commands in this class are those defined by the user\.[\r\n]+"
Philippe> + "Use the \"define\" command to define a command\.[\r\n]+"
Philippe> + } $list_of_commands [list $args]
Philippe> + # Unclear why, but if [list $args] is rather $args, the above is tested
Philippe> + # but gives no PASS message (but gives a FAIL message if it fails) ???
With those changes you could make an optional name parameter here,
and then remove the [list] and the comment.
Tom
@@ -16111,3 +16111,16 @@ For older changes see ChangeLog-1993-2013.
Copyright 2014-2019 Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
are permitted provided the copyright notice and this notice are preserved.
+
+2019-05-31 Philippe Waroquiers <philippe.waroquiers@skynet.be>
+
+ * gdb.lib/gdb.exp (help_list_trailer): New regexp variable
+ factorizing the help trailer message.
+ (test_class_help): Use help_list_trailer. Add LIST_OF_COMMANDS
+ arg to allow to better factorize various tests.
+ (test_user_defined_class_help): Factorizes testing 'help user-defined'.
+ (test_prefix_command_help): Use help_list_trailer.
+ * gdb.python/py-cmd.exp: Use test_user_defined_class_help.
+ * gdb.guile/scm-cmd.exp: Likewise.
+ * gdb.trace/tracecmd.exp: Update caller of test_class_help.
+ * gdb.base/help.exp: Likewise. Use test_user_defined_class_help.
@@ -25,37 +25,35 @@ gdb_start
gdb_test_no_output "set height 0" "disable pagination"
# Test all the help classes.
-test_class_help "aliases" {"Aliases of other commands\.\[\r\n\]+"}
+test_class_help "aliases" {"Aliases of other commands\.\[\r\n\]+"} {}
test_class_help "breakpoints" {
"Making program stop at certain points\.\[\r\n\]+"
-}
-test_class_help "data" {"Examining data\.\[\r\n\]+"}
-test_class_help "files" {"Specifying and examining files\.\[\r\n\]+"}
+} {}
+test_class_help "data" {"Examining data\.\[\r\n\]+"} {}
+test_class_help "files" {"Specifying and examining files\.\[\r\n\]+"} {}
test_class_help "internals" {
"Maintenance commands\.\[\r\n\]+"
"Some gdb commands are provided just for use by gdb maintainers\.\[\r\n\]+"
"These commands are subject to frequent change, and may not be as\[\r\n\]+"
"well documented as user commands\.\[\r\n\]+"
-}
-test_class_help "obscure" {"Obscure features\.\[\r\n\]+"}
-test_class_help "running" {"Running the program\.\[\r\n\]+"}
+} {}
+test_class_help "obscure" {"Obscure features\.\[\r\n\]+"} {}
+test_class_help "running" {"Running the program\.\[\r\n\]+"} {}
test_class_help "stack" {
"Examining the stack\..*\[\r\n\]+"
"When the program being debugged stops, gdb selects the innermost frame\.\[\r\n\]+"
"The commands below can be used to select other frames by number or address\.\[\r\n\]+"
-}
+} {}
test_class_help "status" {
"Status inquiries\.\[\r\n\]+"
-}
-test_class_help "support" {"Support facilities\.\[\r\n\]+"}
+} {}
+test_class_help "support" {"Support facilities\.\[\r\n\]+"} {}
test_class_help "tracepoints" {
"Tracing of program execution without stopping the program\.\[\r\n\]+"
-}
-test_class_help "user-defined" {
- "User-defined commands\.\[\r\n\]+"
- "The commands in this class are those defined by the user\.\[\r\n\]+"
- "Use the \"define\" command to define a command\.\[\r\n\]+"
-}
+} {}
+
+# Test "help user-defined", not checking user-defined command list.
+test_user_defined_class_help {}
# Test help of an abbreviated command. "break" is picked at random.
set help_breakpoint_text "Set breakpoint at specified location\..*"
@@ -130,9 +130,7 @@ gdb_test "test-help ugh" "test-cmd output, arg = ugh" \
"call simple user-defined command"
# Make sure the command shows up in `help user-defined`.
-gdb_test "help user-defined" \
- "User-defined commands.\[\r\n\]+The commands in this class are those defined by the user.\[\r\n\]+Use the \"define\" command to define a command.\[\r\n\]+List of commands:\[\r\n\]+test-help -- Docstring\[\r\n\]+Type \"help\" followed by command name for full documentation.\[\r\n\]+Type \"apropos word\" to search for commands related to \"word\".\[\r\n\]+Command name abbreviations are allowed if unambiguous.\[\r\n\]+" \
- "see user-defined command in `help user-defined`"
+test_user_defined_class_help {"test-help -- Docstring[\r\n]"}
# Make sure the command does not show up in `show user`.
gdb_test "show user test-help" "Not a user command\." \
@@ -159,7 +159,7 @@ gdb_py_test_multiple "input simple user-defined command" \
gdb_test "test_help ugh" "test_cmd output, arg = ugh" "call simple user-defined command"
# Make sure the command shows up in `help user-defined`.
-gdb_test "help user-defined" "User-defined commands.\[\r\n\]+The commands in this class are those defined by the user.\[\r\n\]+Use the \"define\" command to define a command.\[\r\n\]+\[\r\n\]+List of commands:\[\r\n\]+\[\r\n\]+test_help -- Docstring\[\r\n\]+\[\r\n\]+Type \"help\" followed by command name for full documentation.\[\r\n\]+Type \"apropos word\" to search for commands related to \"word\".\[\r\n\]+Command name abbreviations are allowed if unambiguous.\[\r\n\]+" "see user-defined command in `help user-defined`"
+test_user_defined_class_help {"test_help -- Docstring[\r\n]"}
# Make sure the command does not show up in `show user`.
gdb_test "show user test_help" "Not a user command\." \
@@ -55,7 +55,7 @@ set testline2 [expr $baseline + 3]
set helpcnt 0
test_class_help "tracepoints" {
"Tracing of program execution without stopping the program\.[\r\n\]+"
-} "1.0: help tracepoints"
+} {} "1.0: help tracepoints"
#
# test trace command:
@@ -5561,24 +5561,52 @@ proc help_test_raw { gdb_command expected_lines args } {
gdb_test "${gdb_command}" "${expected_output}" $message
}
-# Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
+# A regexp that matches the end of help CLASS|PREFIX_COMMAND
+set help_list_trailer {
+ "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
+ "Type \"apropos -v word\" for full documentation of commands related to \"word\"\.[\r\n]+"
+ "Command name abbreviations are allowed if unambiguous\."
+}
+
+# Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
# are regular expressions that should match the beginning of output,
-# before the list of commands in that class. The presence of
-# command list and standard epilogue will be tested automatically.
+# before the list of commands in that class.
+# LIST_OF_COMMANDS are regular expressions that should match the
+# list of commands in that class. If empty, the command list will be
+# matched automatically. The presence of standard epilogue will be tested
+# automatically.
# Notice that the '[' and ']' characters don't need to be escaped for strings
# wrapped in {} braces.
-proc test_class_help { command_class expected_initial_lines args } {
+proc test_class_help { command_class expected_initial_lines list_of_commands args } {
+ global help_list_trailer
+ if {[llength $list_of_commands]>0} {
+ set l_list_of_commands {"List of commands:[\r\n]+[\r\n]+"}
+ set l_list_of_commands [concat $l_list_of_commands $list_of_commands]
+ set l_list_of_commands [concat $l_list_of_commands {"[\r\n]+[\r\n]+"}]
+ } else {
+ set l_list_of_commands {"List of commands\:.*[\r\n]+"}
+ }
set l_stock_body {
- "List of commands\:.*[\r\n]+"
"Type \"help\" followed by command name for full documentation\.[\r\n]+"
- "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
- "Command name abbreviations are allowed if unambiguous\."
}
- set l_entire_body [concat $expected_initial_lines $l_stock_body]
+ set l_entire_body [concat $expected_initial_lines $l_list_of_commands \
+ $l_stock_body $help_list_trailer]
eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
}
+# Like test_class_help but specialised to test "help user-defined".
+proc test_user_defined_class_help { list_of_commands args } {
+ test_class_help "user-defined" {
+ "User-defined commands\.[\r\n]+"
+ "The commands in this class are those defined by the user\.[\r\n]+"
+ "Use the \"define\" command to define a command\.[\r\n]+"
+ } $list_of_commands [list $args]
+ # Unclear why, but if [list $args] is rather $args, the above is tested
+ # but gives no PASS message (but gives a FAIL message if it fails) ???
+}
+
+
# COMMAND_LIST should have either one element -- command to test, or
# two elements -- abbreviated command to test, and full command the first
# element is abbreviation of.
@@ -5587,6 +5615,7 @@ proc test_class_help { command_class expected_initial_lines args } {
# before the list of subcommands. The presence of
# subcommand list and standard epilogue will be tested automatically.
proc test_prefix_command_help { command_list expected_initial_lines args } {
+ global help_list_trailer
set command [lindex $command_list 0]
if {[llength $command_list]>1} {
set full_command [lindex $command_list 1]
@@ -5597,10 +5626,8 @@ proc test_prefix_command_help { command_list expected_initial_lines args } {
# be expanded in this list.
set l_stock_body [list\
"List of $full_command subcommands\:.*\[\r\n\]+"\
- "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
- "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
- "Command name abbreviations are allowed if unambiguous\."]
- set l_entire_body [concat $expected_initial_lines $l_stock_body]
+ "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"]
+ set l_entire_body [concat $expected_initial_lines $l_stock_body $help_list_trailer]
if {[llength $args]>0} {
help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
} else {