1 # Copyright (C) 2008-2015 Free Software Foundation, Inc.
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 # This file is part of the GDB testsuite. It tests the mechanism
17 # exposing values to Python.
19 load_lib gdb-python.exp
21 standard_testfile python.c python-1.c
23 if {[build_executable $testfile.exp $testfile \
24 [list $srcfile $srcfile2] debug] == -1} {
28 # Start with a fresh gdb.
31 gdb_reinitialize_dir $srcdir/$subdir
33 set remote_source2_py [gdb_remote_download host \
34 ${srcdir}/${subdir}/source2.py]
36 # Do this instead of the skip_python_check.
37 # We want to do some tests when Python is not present.
38 gdb_test_multiple "python print (23)" "verify python support" {
39 -re "not supported.*$gdb_prompt $" {
40 unsupported "python support is disabled"
42 # If Python is not supported, verify that sourcing a python script
44 gdb_test "source $remote_source2_py" \
45 "Error in sourced command file:.*" \
46 "source source2.py when python disabled"
48 # Verify multi-line python commands cause an error.
49 gdb_py_test_multiple "multi-line python command" \
52 "end" "not supported.*"
56 -re "$gdb_prompt $" {}
59 gdb_py_test_multiple "multi-line python command" \
64 # Spawn interactive Python help from a multi-line command, thus, after
67 with_test_prefix "python interactive help" {
68 set test "python; help(); end"
69 gdb_test_multiple "python\nhelp()\nend" $test {
70 -re ".*help utility.*help> $" {
73 # The "quit" must be seen on the output. A buggy GDB
74 # would not display it.
75 gdb_test "quit" "^quit.*leaving help.*" "quit help"
80 gdb_py_test_multiple "show python command" \
81 "define zzq" "Type commands for definition of .* just \"end\"\\.*" \
86 "show user zzq" "User command \"zzq\":.* python.*print \\(23\\).* end"
88 gdb_py_test_multiple "indented multi-line python command" \
91 " print ('hello, world!')" "" \
95 gdb_test "source $remote_source2_py" "yes" "source source2.py"
97 gdb_test "source -s source2.py" "yes" "source -s source2.py"
99 gdb_test "python print (gdb.current_objfile())" "None"
100 gdb_test "python print (gdb.objfiles())" "\\\[\\\]"
102 # Test http://bugs.python.org/issue4434 workaround in configure.ac
103 gdb_test "python import itertools; print ('IMPOR'+'TED')" "IMPORTED" "pythonX.Y/lib-dynload/*.so"
106 "python x = gdb.execute('printf \"%d\", 23', to_string = True)"
107 gdb_test "python print (x)" "23"
110 gdb_py_test_multiple "post event insertion" \
113 "class Foo(object):" "" \
114 " def __call__(self):" "" \
115 " global someVal" "" \
117 "gdb.post_event(Foo())" "" \
120 gdb_test "python print (someVal)" "1" "test post event execution"
121 gdb_test "python gdb.post_event(str(1))" "RuntimeError: Posted event is not callable.*" "Test non callable class"
123 # Test (no) pagination of the executed command.
124 gdb_test "show height" {Number of lines gdb thinks are in a page is unlimited\.}
126 gdb_test_no_output "set height $lines"
128 set test "verify pagination beforehand"
129 gdb_test_multiple "python print (\"\\n\" * $lines)" $test {
130 -re "---Type <return>" {
133 -re " to continue, or q <return>" {
140 gdb_test "q" "Quit.*Error while executing Python.*" "verify pagination beforehand: q"
142 gdb_test "python if gdb.execute('python print (\"\\\\n\" * $lines)', to_string=True) == \"\\n\" * [expr $lines + 1]: print (\"yes\")" "yes" "gdb.execute does not page"
144 set test "verify pagination afterwards"
145 gdb_test_multiple "python print (\"\\n\" * $lines)" $test {
146 -re "---Type <return>" {
149 -re " to continue, or q <return>" {
156 gdb_test "q" "Quit.*Error while executing Python.*" "verify pagination afterwards: q"
158 gdb_test_no_output "set height 0"
160 gdb_test_no_output "python a = gdb.execute('help', to_string=True)" "collect help from uiout"
162 gdb_test "python print (a)" ".*aliases -- Aliases of other commands.*" "verify help to uiout"
164 # Test PR 12212, using InfThread.selected_thread() when no inferior is
166 gdb_py_test_silent_cmd "python nothread = gdb.selected_thread()" "Attempt to aquire thread with no inferior" 1
167 gdb_test "python print (nothread == None)" "True" "Ensure that no threads are returned"
169 gdb_py_test_multiple "register atexit function" \
172 "def printit(arg):" "" \
174 "atexit.register(printit, 'good bye world')" "" \
179 -re "good bye world" {
180 pass "atexit handling"
183 fail "atexit handling"
187 # Start with a fresh gdb.
188 clean_restart ${testfile}
190 # The following tests require execution.
192 if ![runto_main] then {
193 fail "Can't run to main"
197 set lineno [gdb_get_line_number "Break to end."]
200 # Test gdb.decode_line.
201 gdb_test "python gdb.decode_line(\"main.c:43\")" \
202 "gdb.error: No source file named main.c.*" "test decode_line no source named main"
204 gdb_py_test_silent_cmd "python symtab = gdb.decode_line()" "test decode_line current location" 1
205 gdb_test "python print (len(symtab))" "2" "Test decode_line current location"
206 gdb_test "python print (symtab\[0\])" "None" "Test decode_line expression parse"
207 gdb_test "python print (len(symtab\[1\]))" "1" "Test decode_line current location"
209 if { [is_remote host] } {
210 set python_c [string_to_regexp "python.c"]
212 set python_c [string_to_regexp "gdb.python/python.c"]
214 gdb_test "python print (symtab\[1\]\[0\].symtab)" ".*${python_c}" "Test decode_line current location filename"
215 gdb_test "python print (symtab\[1\]\[0\].line)" "$lineno" "Test decode_line current location line number"
217 gdb_py_test_silent_cmd "python symtab = gdb.decode_line(\"python.c:26 if foo\")" "test decode_line python.c:26" 1
218 gdb_test "python print (len(symtab))" "2" "Test decode_line python.c:26 length"
219 gdb_test "python print (symtab\[0\])" "if foo" "Test decode_line expression parse"
220 gdb_test "python print (len(symtab\[1\]))" "1" "Test decode_line python.c:26 length"
221 gdb_test "python print (symtab\[1\]\[0\].symtab)" ".*${python_c}" "Test decode_line python.c:26 filename"
222 gdb_test "python print (symtab\[1\]\[0\].line)" "26" "Test decode_line python.c:26 line number"
224 gdb_test "python gdb.decode_line(\"randomfunc\")" \
225 "gdb.error: Function \"randomfunc\" not defined.*" "test decode_line randomfunc"
226 gdb_py_test_silent_cmd "python symtab = gdb.decode_line(\"func1\")" "test decode_line func1()" 1
227 gdb_test "python print (len(symtab))" "2" "Test decode_line func1 length"
228 gdb_test "python print (len(symtab\[1\]))" "1" "Test decode_line func1 length"
230 if { [is_remote host] } {
231 set python_1_c [string_to_regexp "python-1.c"]
233 set python_1_c [string_to_regexp "gdb.python/python-1.c"]
235 gdb_test "python print (symtab\[1\]\[0\].symtab)" ".*${python_1_c}" "Test decode_line func1 filename"
236 gdb_test "python print (symtab\[1\]\[0\].line)" "19" "Test decode_line func1 line number"
237 gdb_py_test_silent_cmd {python symtab = gdb.decode_line ("func1,func2")} \
238 "test decode_line func1,func2" 1
239 gdb_test {python print (symtab[0])} ",func2" "stop at comma in linespec"
242 gdb_test "python print (sys.stderr)" ".*gdb.GdbOutputErrorFile (instance|object) at.*" "Test stderr location"
243 gdb_test "python print (sys.stdout)" ".*gdb.GdbOutputFile (instance|object) at.*" "Test stdout location"
244 gdb_test "python gdb.write(\"Foo\\n\")" "Foo" "Test default write"
245 gdb_test "python gdb.write(\"Error stream\\n\", stream=gdb.STDERR)" "Error stream" "Test stderr write"
246 gdb_test "python gdb.write(\"Normal stream\\n\", stream=gdb.STDOUT)" "Normal stream" "Test stdout write"
247 gdb_test "python gdb.write(\"Log stream\\n\", stream=gdb.STDLOG)" "Log stream" "Test stdlog write"
249 # Turn on full stack printing for subsequent tests.
250 gdb_py_test_silent_cmd "set python print-stack full" \
251 "Set print-stack full for prompt tests" 1
253 # Test prompt substituion
255 gdb_py_test_multiple "prompt substitution" \
257 "someCounter = 0" "" \
258 "def prompt(current):" "" \
259 " global someCounter" "" \
260 " if (current == \"testfake \"):" "" \
262 " someCounter = someCounter + 1" "" \
263 " return \"py prompt \" + str (someCounter) + \" \"" "" \
266 gdb_py_test_multiple "prompt substitution readline" \
269 "def program_prompt(current):" "" \
270 " global pCounter" "" \
271 " if (current == \">\"):" "" \
272 " pCounter = pCounter + 1" "" \
273 " return \"python line \" + str (pCounter) + \": \"" "" \
277 set newprompt "py prompt 1"
278 set newprompt2 "py prompt 2"
279 set testfake "testfake"
281 gdb_test_multiple "python gdb.prompt_hook = prompt" "set the hook" {
282 -re "\[\r\n\]$newprompt $" {
287 gdb_test_multiple "set prompt testfake " "set testfake prompt in GDB" {
288 -re "\[\r\n\]$testfake $" {
289 pass "set prompt testfake"
293 gdb_test_multiple "show prompt" "show testfake prompt" {
294 -re "Gdb's prompt is \"$testfake \"..* $" {
295 pass "show prompt shows guarded prompt"
299 gdb_test_multiple "set prompt blah " "set blah in GDB" {
300 -re "\[\r\n\]$newprompt2 $" {
301 pass "set prompt blah overriden"
305 gdb_test_multiple "python gdb.prompt_hook = None" "Delete hook" {
306 -re "\[\r\n\]$newprompt2 $" {
307 pass "Delete old hook"
311 gdb_test_multiple "set prompt $gdb_prompt " "set default prompt" {
312 -re "\[\r\n\]$gdb_prompt $" {
313 pass "set default prompt"
318 gdb_test_multiple "pwd" "pwd" {
319 -re "Working directory (.*)\\.\[\r\n\]+$gdb_prompt $" {
320 set working_dir $expect_out(1,string)
324 gdb_test_multiple "python gdb.prompt_hook = program_prompt" "set the hook" {
325 -re "\[\r\n\]$gdb_prompt $" {
326 pass "set programming hook"
330 gdb_test_multiple "python" "test we ignore substituion for seconday prompts" {
332 pass "readline secondary are not substituted"
336 gdb_test_multiple "end" "end programming" {
337 -re "\[\r\n\]$gdb_prompt $" {
338 pass "end programming"
342 gdb_py_test_multiple "prompt substitution readline" \
344 "import gdb.command.prompt" "" \
347 gdb_test_multiple "set extended-prompt one two three " \
348 "set basic extended prompt" {
349 -re "\[\r\n\]one two three $" {
350 pass "set basic extended prompt"
354 gdb_test_multiple "set extended-prompt \\w " \
355 "set extended prompt working directory" {
356 -re "\[\r\n\][string_to_regexp $working_dir] $" {
357 pass "set extended prompt working directory"
361 gdb_test_multiple "set extended-prompt some param \\p{python print-stack} " \
362 "set extended prompt parameter" {
363 -re "\[\r\n\]some param full $" {
364 pass "set extended prompt parameter"
368 # Start with a fresh gdb.
369 clean_restart ${testfile}
371 # The following tests require execution.
373 if ![runto_main] then {
374 fail "Can't run to main"
378 # print-stack settings
379 gdb_test "show python print-stack" \
380 "The mode of Python stack printing on error is \"message\".*" \
381 "Test print-stack show setting. Default is message."
382 gdb_py_test_silent_cmd "set python print-stack full" \
383 "Test print-stack set setting to full" 1
384 gdb_test "show python print-stack" \
385 "The mode of Python stack printing on error is \"full\".*" \
386 "Test print-stack show setting to full"
387 gdb_py_test_silent_cmd "set python print-stack none" \
388 "Test print-stack set setting to none" 1
389 gdb_test "show python print-stack" \
390 "The mode of Python stack printing on error is \"none\".*" \
391 "Test print-stack show setting to none"
393 gdb_py_test_silent_cmd "set python print-stack message" \
394 "Test print-stack set setting to message" 1
396 gdb_py_test_multiple "prompt substitution readline" \
399 "def error_prompt(current):" "" \
400 " raise RuntimeError(\"Python exception called\")" "" \
403 gdb_test_multiple "python gdb.prompt_hook = error_prompt" "set the hook" {
404 -re "Python Exception (exceptions.RuntimeError|<(type 'exceptions.|class ')RuntimeError'>) Python exception called.*" {
409 gdb_py_test_silent_cmd "python gdb.prompt_hook = None" \
410 "set the hook to default" 1
412 gdb_py_test_silent_cmd "set python print-stack full" \
413 "set print-stack full for prompt error test" 1
415 gdb_test_multiple "python gdb.prompt_hook = error_prompt" "set the hook" {
416 -re "Traceback.*File.*line.*RuntimeError.*Python exception called.*" {
421 gdb_py_test_silent_cmd "python gdb.prompt_hook = None" \
422 "set the hook to default" 1
424 # Start with a fresh gdb.
425 clean_restart ${testfile}
427 # The following tests require execution.
429 if ![runto_main] then {
430 fail "Can't run to main"
434 runto [gdb_get_line_number "Break at func2 call site."]
436 gdb_py_test_silent_cmd "python line = gdb.selected_frame().find_sal().line" "Get line number of func2 call site" 1
437 gdb_test "python print (gdb.find_pc_line(gdb.selected_frame().pc()).line == line)" "True" "Test find_pc_line at func2 call site"
439 gdb_py_test_silent_cmd "step" "Step into func2" 1
440 gdb_py_test_silent_cmd "up" "Step out of func2" 1
442 gdb_test "python print (gdb.find_pc_line(gdb.selected_frame().pc()).line > line)" "True" "Test find_pc_line with resume address"