1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
| """
Test some lldb help commands.
See also CommandInterpreter::OutputFormattedHelpText().
"""
from __future__ import print_function
import os
import lldb
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
from lldbsuite.test import lldbutil
class HelpCommandTestCase(TestBase):
mydir = TestBase.compute_mydir(__file__)
@no_debug_info_test
def test_simplehelp(self):
"""A simple test of 'help' command and its output."""
self.expect("help",
startstr='Debugger commands:')
self.expect("help -a", matching=False,
substrs=['next'])
self.expect("help", matching=True,
substrs=['next'])
@no_debug_info_test
def test_help_on_help(self):
"""Testing the help on the help facility."""
self.expect("help help", matching=True,
substrs=['--hide-aliases',
'--hide-user-commands'])
@no_debug_info_test
def version_number_string(self):
"""Helper function to find the version number string of lldb."""
plist = os.path.join(
os.environ["LLDB_SRC"],
"resources",
"LLDB-Info.plist")
try:
CFBundleVersionSegFound = False
with open(plist, 'r') as f:
for line in f:
if CFBundleVersionSegFound:
version_line = line.strip()
import re
m = re.match("<string>(.*)</string>", version_line)
if m:
version = m.group(1)
return version
else:
# Unsuccessful, let's juts break out of the for
# loop.
break
if line.find("<key>CFBundleVersion</key>") != -1:
# Found our match. The next line contains our version
# string, for example:
#
# <string>38</string>
CFBundleVersionSegFound = True
except:
# Just fallthrough...
import traceback
traceback.print_exc()
# Use None to signify that we are not able to grok the version number.
return None
@no_debug_info_test
def test_help_arch(self):
"""Test 'help arch' which should list of supported architectures."""
self.expect("help arch",
substrs=['arm', 'x86_64', 'i386'])
@no_debug_info_test
def test_help_version(self):
"""Test 'help version' and 'version' commands."""
self.expect("help version",
substrs=['Show the LLDB debugger version.'])
import re
version_str = self.version_number_string()
match = re.match('[0-9]+', version_str)
search_regexp = ['lldb( version|-' + (version_str if match else '[0-9]+') + ').*\n']
self.expect("version",
patterns=search_regexp)
@no_debug_info_test
def test_help_should_not_crash_lldb(self):
"""Command 'help disasm' should not crash lldb."""
self.runCmd("help disasm", check=False)
self.runCmd("help unsigned-integer")
@no_debug_info_test
def test_help_should_not_hang_emacsshell(self):
"""Command 'settings set term-width 0' should not hang the help command."""
self.expect(
"settings set term-width 0",
COMMAND_FAILED_AS_EXPECTED,
error=True,
substrs=['error: 0 is out of range, valid values must be between'])
# self.runCmd("settings set term-width 0")
self.expect("help",
startstr='Debugger commands:')
@no_debug_info_test
def test_help_breakpoint_set(self):
"""Test that 'help breakpoint set' does not print out redundant lines of:
'breakpoint set [-s <shlib-name>] ...'."""
self.expect("help breakpoint set", matching=False,
substrs=['breakpoint set [-s <shlib-name>]'])
@no_debug_info_test
def test_help_image_dump_symtab_should_not_crash(self):
"""Command 'help image dump symtab' should not crash lldb."""
# 'image' is an alias for 'target modules'.
self.expect("help image dump symtab",
substrs=['dump symtab',
'sort-order'])
@no_debug_info_test
def test_help_image_du_sym_is_ambiguous(self):
"""Command 'help image du sym' is ambiguous and spits out the list of candidates."""
self.expect("help image du sym",
COMMAND_FAILED_AS_EXPECTED, error=True,
substrs=['error: ambiguous command image du sym',
'symfile',
'symtab'])
@no_debug_info_test
def test_help_image_du_line_should_work(self):
"""Command 'help image du line-table' is not ambiguous and should work."""
# 'image' is an alias for 'target modules'.
self.expect("help image du line", substrs=[
'Dump the line table for one or more compilation units'])
@no_debug_info_test
def test_help_target_variable_syntax(self):
"""Command 'help target variable' should display <variable-name> ..."""
self.expect("help target variable",
substrs=['<variable-name> [<variable-name> [...]]'])
@no_debug_info_test
def test_help_watchpoint_and_its_args(self):
"""Command 'help watchpoint', 'help watchpt-id', and 'help watchpt-id-list' should work."""
self.expect("help watchpoint",
substrs=['delete', 'disable', 'enable', 'list'])
self.expect("help watchpt-id",
substrs=['<watchpt-id>'])
self.expect("help watchpt-id-list",
substrs=['<watchpt-id-list>'])
@no_debug_info_test
def test_help_watchpoint_set(self):
"""Test that 'help watchpoint set' prints out 'expression' and 'variable'
as the possible subcommands."""
self.expect("help watchpoint set",
substrs=['The following subcommands are supported:'],
patterns=['expression +--',
'variable +--'])
@no_debug_info_test
def test_help_po_hides_options(self):
"""Test that 'help po' does not show all the options for expression"""
self.expect(
"help po",
substrs=[
'--show-all-children',
'--object-description'],
matching=False)
@no_debug_info_test
def test_help_run_hides_options(self):
"""Test that 'help run' does not show all the options for process launch"""
self.expect("help run",
substrs=['--arch', '--environment'], matching=False)
@no_debug_info_test
def test_help_next_shows_options(self):
"""Test that 'help next' shows all the options for thread step-over"""
self.expect("help next",
substrs=['--step-out-avoids-no-debug', '--run-mode'], matching=True)
@no_debug_info_test
def test_help_provides_alternatives(self):
"""Test that help on commands that don't exist provides information on additional help avenues"""
self.expect(
"help thisisnotadebuggercommand",
substrs=[
"'thisisnotadebuggercommand' is not a known command.",
"Try 'help' to see a current list of commands.",
"Try 'apropos thisisnotadebuggercommand' for a list of related commands.",
"Try 'type lookup thisisnotadebuggercommand' for information on types, methods, functions, modules, etc."],
error=True)
self.expect(
"help process thisisnotadebuggercommand",
substrs=[
"'process thisisnotadebuggercommand' is not a known command.",
"Try 'help' to see a current list of commands.",
"Try 'apropos thisisnotadebuggercommand' for a list of related commands.",
"Try 'type lookup thisisnotadebuggercommand' for information on types, methods, functions, modules, etc."])
@no_debug_info_test
def test_custom_help_alias(self):
"""Test that aliases pick up custom help text."""
def cleanup():
self.runCmd('command unalias afriendlyalias', check=False)
self.runCmd('command unalias averyfriendlyalias', check=False)
self.addTearDownHook(cleanup)
self.runCmd(
'command alias --help "I am a friendly alias" -- afriendlyalias help')
self.expect(
"help afriendlyalias",
matching=True,
substrs=['I am a friendly alias'])
self.runCmd(
'command alias --long-help "I am a very friendly alias" -- averyfriendlyalias help')
self.expect("help averyfriendlyalias", matching=True,
substrs=['I am a very friendly alias'])
@no_debug_info_test
def test_alias_prints_origin(self):
"""Test that 'help <unique_match_to_alias>' prints the alias origin."""
def cleanup():
self.runCmd('command unalias alongaliasname', check=False)
self.addTearDownHook(cleanup)
self.runCmd('command alias alongaliasname help')
self.expect("help alongaliasna", matching=True,
substrs=["'alongaliasna' is an abbreviation for 'help'"])
@no_debug_info_test
def test_hidden_help(self):
self.expect("help -h",
substrs=["_regexp-bt"])
@no_debug_info_test
def test_help_ambiguous(self):
self.expect("help g",
substrs=["Help requested with ambiguous command name, possible completions:",
"gdb-remote", "gui"])
@no_debug_info_test
def test_help_unknown_flag(self):
self.expect("help -z", error=True,
substrs=["unknown or ambiguous option"])
@no_debug_info_test
def test_help_format_output(self):
"""Test that help output reaches TerminalWidth."""
self.runCmd(
'settings set term-width 108')
self.expect(
"help format",
matching=True,
substrs=['<format> -- One of the format names'])
|