gdb/testsuite/gdb.python/python.exp

   1 # Copyright (C) 2008-2017 Free Software Foundation, Inc.
   2
   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.
   7 #
   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.
  12 #
  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/>.
  15
  16 # This file is part of the GDB testsuite.  It tests the mechanism
  17 # exposing values to Python.
  18
  19 load_lib gdb-python.exp
  20
  21 standard_testfile python.c python-1.c
  22
  23 if {[build_executable $testfile.exp $testfile \
  24          [list $srcfile $srcfile2] debug] == -1} {
  25     return -1
  26 }
  27
  28 # Start with a fresh gdb.
  29 gdb_exit
  30 gdb_start
  31 gdb_reinitialize_dir $srcdir/$subdir
  32
  33 set remote_source2_py [gdb_remote_download host \
  34                            ${srcdir}/${subdir}/source2.py]
  35
  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"
  41
  42       # If Python is not supported, verify that sourcing a python script
  43       # causes an error.
  44       gdb_test "source $remote_source2_py" \
  45           "Error in sourced command file:.*" \
  46           "source source2.py when python disabled"
  47
  48       # Verify multi-line python commands cause an error.
  49       gdb_py_test_multiple "multi-line python command" \
  50           "python" "" \
  51           "print (23)" "" \
  52           "end" "not supported.*"
  53
  54       return -1
  55     }
  56     -re "$gdb_prompt $" {}
  57 }
  58
  59 gdb_py_test_multiple "multi-line python command" \
  60   "python" "" \
  61   "print (23)" "" \
  62   "end" "23"
  63
  64 # Spawn interactive Python help from a multi-line command, thus, after
  65 # a secondary prompt.
  66
  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> $" {
  71             pass $test
  72
  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"
  76         }
  77     }
  78 }
  79
  80 gdb_py_test_multiple "show python command" \
  81   "define zzq" "Type commands for definition of .* just \"end\"\\.*" \
  82   "python" "" \
  83   "print (23)" "" \
  84   "end" "" \
  85   "end" "" \
  86   "show user zzq" "User command \"zzq\":.*  python.*print \\(23\\).*  end"
  87
  88 gdb_py_test_multiple "indented multi-line python command" \
  89   "python" "" \
  90   "def foo ():" "" \
  91   "  print ('hello, world!')" "" \
  92   "foo ()" "" \
  93   "end" "hello, world!"
  94
  95 gdb_test "source $remote_source2_py" "yes" "source source2.py"
  96
  97 gdb_test "source -s source2.py" "yes" "source -s source2.py"
  98
  99 set remote_source2_symlink_notpy \
 100     [gdb_remote_download host ${srcdir}/${subdir}/source2.py \
 101          [standard_output_file "source2-symlink.notpy"]]
 102 set remote_source2_symlink_py [standard_output_file "source2-symlink.py"]
 103 remote_file host delete $remote_source2_symlink_py
 104 set status [remote_exec host "ln -sf $remote_source2_symlink_notpy $remote_source2_symlink_py"]
 105 set test "source -s source2-symlink.py"
 106 if {[lindex $status 0] == 0} {
 107     gdb_test "source -s $remote_source2_symlink_py" "yes" $test
 108 } else {
 109     unsupported "$test (host does not support symbolic links)"
 110 }
 111
 112 gdb_test "python print (gdb.current_objfile())" "None"
 113 gdb_test "python print (gdb.objfiles())" "\\\[\\\]"
 114
 115 # Test http://bugs.python.org/issue4434 workaround in configure.ac
 116 gdb_test "python import itertools; print ('IMPOR'+'TED')" "IMPORTED" "pythonX.Y/lib-dynload/*.so"
 117
 118 gdb_test_no_output \
 119     "python x = gdb.execute('printf \"%d\", 23', to_string = True)"
 120 gdb_test "python print (x)" "23"
 121
 122 # Test post_event.
 123 gdb_py_test_multiple "post event insertion" \
 124   "python" "" \
 125   "someVal = 0" "" \
 126   "class Foo(object):" "" \
 127   "  def __call__(self):" "" \
 128   "    global someVal" "" \
 129   "    someVal += 1" "" \
 130   "gdb.post_event(Foo())" "" \
 131   "end" ""
 132
 133 gdb_test "python print (someVal)" "1" "test post event execution"
 134 gdb_test "python gdb.post_event(str(1))" "RuntimeError: Posted event is not callable.*" "test non callable class"
 135
 136 # Test (no) pagination of the executed command.
 137 gdb_test "show height" {Number of lines gdb thinks are in a page is unlimited\.}
 138 set lines 10
 139 gdb_test_no_output "set height $lines"
 140
 141 set test "verify pagination beforehand"
 142 gdb_test_multiple "python print (\"\\n\" * $lines)" $test {
 143     -re "---Type <return>" {
 144         exp_continue
 145     }
 146     -re " to continue, or q <return>" {
 147         exp_continue
 148     }
 149     -re " to quit---$" {
 150         pass $test
 151     }
 152 }
 153 gdb_test "q" "Quit.*Error while executing Python.*" "verify pagination beforehand: q"
 154
 155 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"
 156
 157 set test "verify pagination afterwards"
 158 gdb_test_multiple "python print (\"\\n\" * $lines)" $test {
 159     -re "---Type <return>" {
 160         exp_continue
 161     }
 162     -re " to continue, or q <return>" {
 163         exp_continue
 164     }
 165     -re " to quit---$" {
 166         pass $test
 167     }
 168 }
 169 gdb_test "q" "Quit.*Error while executing Python.*" "verify pagination afterwards: q"
 170
 171 gdb_test_no_output "set height 0"
 172
 173 gdb_test_no_output "python a = gdb.execute('help', to_string=True)" "collect help from uiout"
 174
 175 gdb_test "python print (a)" ".*aliases -- Aliases of other commands.*" "verify help to uiout"
 176
 177 # Test PR 12212, using InfThread.selected_thread() when no inferior is
 178 # loaded.
 179 gdb_py_test_silent_cmd "python nothread = gdb.selected_thread()" "Attempt to aquire thread with no inferior" 1
 180 gdb_test "python print (nothread == None)" "True" "ensure that no threads are returned"
 181
 182 gdb_py_test_multiple "register atexit function" \
 183     "python" "" \
 184     "import atexit" "" \
 185     "def printit(arg):" "" \
 186     "  print (arg)" "" \
 187     "atexit.register(printit, 'good bye world')" "" \
 188     "end" ""
 189
 190 send_gdb "quit\n"
 191 gdb_expect {
 192     -re "good bye world" {
 193         pass "atexit handling"
 194     }
 195     default {
 196         fail "atexit handling"
 197     }
 198 }
 199
 200 # Start with a fresh gdb.
 201 clean_restart ${testfile}
 202
 203 # The following tests require execution.
 204
 205 if ![runto_main] then {
 206     fail "can't run to main"
 207     return 0
 208 }
 209
 210 set lineno [gdb_get_line_number "Break to end."]
 211 runto $lineno
 212
 213 # Test gdb.decode_line.
 214 gdb_test "python gdb.decode_line(\"main.c:43\")" \
 215     "gdb.error: No source file named main.c.*" "test decode_line no source named main"
 216
 217 gdb_py_test_silent_cmd "python symtab = gdb.decode_line()" "test decode_line current location" 1
 218 gdb_test "python print (len(symtab))" "2" "test decode_line current location"
 219 gdb_test "python print (symtab\[0\])" "None" "test decode_line expression parse"
 220 gdb_test "python print (len(symtab\[1\]))" "1" "test decode_line current location"
 221
 222 if { [is_remote host] } {
 223     set python_c [string_to_regexp "python.c"]
 224 } else {
 225     set python_c [string_to_regexp "gdb.python/python.c"]
 226 }
 227 gdb_test "python print (symtab\[1\]\[0\].symtab)" ".*${python_c}" "test decode_line current location filename"
 228 gdb_test "python print (symtab\[1\]\[0\].line)" "$lineno" "test decode_line current location line number"
 229
 230 gdb_py_test_silent_cmd "python symtab = gdb.decode_line(\"python.c:26 if foo\")" "test decode_line python.c:26" 1
 231 gdb_test "python print (len(symtab))" "2" "test decode_line python.c:26 length"
 232 gdb_test "python print (symtab\[0\])" "if foo" "test decode_line expression parse"
 233 gdb_test "python print (len(symtab\[1\]))" "1" "test decode_line python.c:26 length"
 234 gdb_test "python print (symtab\[1\]\[0\].symtab)" ".*${python_c}" "test decode_line python.c:26 filename"
 235 gdb_test "python print (symtab\[1\]\[0\].line)" "26" "test decode_line python.c:26 line number"
 236
 237 gdb_test "python gdb.decode_line(\"randomfunc\")" \
 238     "gdb.error: Function \"randomfunc\" not defined.*" "test decode_line randomfunc"
 239 gdb_py_test_silent_cmd "python symtab = gdb.decode_line(\"func1\")" "test decode_line func1()" 1
 240 gdb_test "python print (len(symtab))" "2" "test decode_line func1 length"
 241 gdb_test "python print (len(symtab\[1\]))" "1" "test decode_line func1 length"
 242
 243 if { [is_remote host] } {
 244     set python_1_c [string_to_regexp "python-1.c"]
 245 } else {
 246     set python_1_c [string_to_regexp "gdb.python/python-1.c"]
 247 }
 248 gdb_test "python print (symtab\[1\]\[0\].symtab)" ".*${python_1_c}" "test decode_line func1 filename"
 249 gdb_test "python print (symtab\[1\]\[0\].line)" "19" "test decode_line func1 line number"
 250 gdb_py_test_silent_cmd {python symtab = gdb.decode_line ("func1,func2")} \
 251     "test decode_line func1,func2" 1
 252 gdb_test {python print (symtab[0])} ",func2" "stop at comma in linespec"
 253
 254 gdb_py_test_silent_cmd "python symtab = gdb.decode_line(\"*0\")" "Test decode_line *0" 1
 255 gdb_test "python print (len(symtab))" "2" "test decode_line *0 result length"
 256 gdb_test "python print (symtab\[0\])" "None" "test decode_line *0 unparsed"
 257 gdb_test "python print (len(symtab\[1\]))" "1" "test decode_line *0 locations length"
 258 gdb_test "python print (symtab\[1\]\[0\].symtab)" "None" "test decode_line *0 filename"
 259 gdb_test "python print (symtab\[1\]\[0\].pc)" "0" "test decode_line *0 pc"
 260
 261 # gdb.write
 262 gdb_test "python print (sys.stderr)" ".*gdb.GdbOutputErrorFile (instance|object) at.*" "test stderr location"
 263 gdb_test "python print (sys.stdout)" ".*gdb.GdbOutputFile (instance|object) at.*" "test stdout location"
 264 gdb_test "python gdb.write(\"Foo\\n\")" "Foo" "test default write"
 265 gdb_test "python gdb.write(\"Error stream\\n\", stream=gdb.STDERR)" "Error stream" "test stderr write"
 266 gdb_test "python gdb.write(\"Normal stream\\n\", stream=gdb.STDOUT)" "Normal stream" "test stdout write"
 267 gdb_test "python gdb.write(\"Log stream\\n\", stream=gdb.STDLOG)" "Log stream" "test stdlog write"
 268
 269 # Turn on full stack printing for subsequent tests.
 270 gdb_py_test_silent_cmd "set python print-stack full" \
 271     "Set print-stack full for prompt tests" 1
 272
 273 # Test prompt substituion
 274
 275 gdb_py_test_multiple "prompt substitution" \
 276   "python" "" \
 277   "someCounter = 0" "" \
 278   "def prompt(current):" "" \
 279   "   global someCounter" "" \
 280   "   if (current == \"testfake \"):" "" \
 281   "      return None" "" \
 282   "   someCounter = someCounter + 1" "" \
 283   "   return \"py prompt \" + str (someCounter) + \" \"" "" \
 284   "end" ""
 285
 286 gdb_py_test_multiple "prompt substitution readline" \
 287   "python" "" \
 288   "pCounter = 0" "" \
 289   "def program_prompt(current):" "" \
 290   "   global pCounter" "" \
 291   "   if (current == \">\"):" "" \
 292   "      pCounter = pCounter + 1" "" \
 293   "      return \"python line \" + str (pCounter) + \": \"" "" \
 294   "   return None" "" \
 295   "end" ""
 296
 297 set newprompt "py prompt 1"
 298 set newprompt2 "py prompt 2"
 299 set testfake "testfake"
 300
 301 gdb_test_multiple "python gdb.prompt_hook = prompt" "set the hook" {
 302     -re "\[\r\n\]$newprompt $" {
 303         pass "set hook"
 304     }
 305 }
 306
 307 gdb_test_multiple "set prompt testfake " "set testfake prompt in GDB" {
 308     -re "\[\r\n\]$testfake $" {
 309         pass "set prompt testfake"
 310     }
 311 }
 312
 313 gdb_test_multiple "show prompt" "show testfake prompt" {
 314     -re "Gdb's prompt is \"$testfake \"..* $" {
 315         pass "show prompt shows guarded prompt"
 316     }
 317 }
 318
 319 gdb_test_multiple "set prompt blah " "set blah in GDB" {
 320     -re "\[\r\n\]$newprompt2 $" {
 321         pass "set prompt blah overriden"
 322     }
 323 }
 324
 325 gdb_test_multiple "python gdb.prompt_hook = None" "delete hook" {
 326     -re "\[\r\n\]$newprompt2 $" {
 327         pass "delete old hook"
 328     }
 329 }
 330
 331 gdb_test_multiple "set prompt $gdb_prompt " "set default prompt" {
 332     -re "\[\r\n\]$gdb_prompt $" {
 333         pass "set default prompt"
 334     }
 335 }
 336
 337 set working_dir ""
 338 gdb_test_multiple "pwd" "pwd" {
 339     -re "Working directory (.*)\\.\[\r\n\]+$gdb_prompt $" {
 340         set working_dir $expect_out(1,string)
 341     }
 342 }
 343
 344 gdb_test_multiple "python gdb.prompt_hook = program_prompt" "set the hook" {
 345     -re "\[\r\n\]$gdb_prompt $" {
 346         pass "set programming hook"
 347     }
 348 }
 349
 350 gdb_test_multiple "python" "test we ignore substituion for seconday prompts" {
 351     -re "\r\n>$" {
 352         pass "readline secondary are not substituted"
 353     }
 354 }
 355
 356 gdb_test_multiple "end" "end programming" {
 357     -re "\[\r\n\]$gdb_prompt $" {
 358         pass "end programming"
 359     }
 360 }
 361
 362 gdb_py_test_multiple "prompt substitution readline" \
 363   "python" "" \
 364   "import gdb.command.prompt" "" \
 365   "end" ""
 366
 367 gdb_test_multiple "set extended-prompt one two three " \
 368     "set basic extended prompt" {
 369     -re "\[\r\n\]one two three $" {
 370         pass "set basic extended prompt"
 371     }
 372 }
 373
 374 gdb_test_multiple "set extended-prompt \\w " \
 375     "set extended prompt working directory" {
 376     -re "\[\r\n\][string_to_regexp $working_dir] $" {
 377         pass "set extended prompt working directory"
 378     }
 379 }
 380
 381 gdb_test_multiple "set extended-prompt some param \\p{python print-stack} " \
 382     "set extended prompt parameter" {
 383     -re "\[\r\n\]some param full $" {
 384         pass "set extended prompt parameter"
 385     }
 386 }
 387
 388 # Start with a fresh gdb.
 389 clean_restart ${testfile}
 390
 391 # The following tests require execution.
 392
 393 if ![runto_main] then {
 394     fail "can't run to main"
 395     return 0
 396 }
 397
 398 # print-stack settings
 399 gdb_test "show python print-stack" \
 400     "The mode of Python stack printing on error is \"message\".*" \
 401     "Test print-stack show setting. Default is message."
 402 gdb_py_test_silent_cmd "set python print-stack full" \
 403     "Test print-stack set setting to full" 1
 404 gdb_test "show python print-stack" \
 405     "The mode of Python stack printing on error is \"full\".*" \
 406     "Test print-stack show setting to full"
 407 gdb_py_test_silent_cmd "set python print-stack none" \
 408     "Test print-stack set setting to none" 1
 409 gdb_test "show python print-stack" \
 410     "The mode of Python stack printing on error is \"none\".*" \
 411     "test print-stack show setting to none"
 412
 413 gdb_py_test_silent_cmd "set python print-stack message" \
 414     "Test print-stack set setting to message" 1
 415
 416 gdb_py_test_multiple "prompt substitution readline" \
 417   "python" "" \
 418   "pCounter = 0" "" \
 419   "def error_prompt(current):" "" \
 420   "   raise RuntimeError(\"Python exception called\")" "" \
 421   "end" ""
 422
 423 gdb_test_multiple "python gdb.prompt_hook = error_prompt" "set the hook" {
 424     -re "Python Exception (exceptions.RuntimeError|<(type 'exceptions.|class ')RuntimeError'>) Python exception called.*" {
 425         pass "set hook"
 426     }
 427 }
 428
 429 gdb_py_test_silent_cmd "python gdb.prompt_hook = None" \
 430     "set the hook to default" 1
 431
 432 gdb_py_test_silent_cmd "set python print-stack full" \
 433     "set print-stack full for prompt error test" 1
 434
 435 gdb_test_multiple "python gdb.prompt_hook = error_prompt" "set the hook" {
 436     -re "Traceback.*File.*line.*RuntimeError.*Python exception called.*" {
 437         pass "set hook"
 438     }
 439 }
 440
 441 gdb_py_test_silent_cmd "python gdb.prompt_hook = None" \
 442     "set the hook to default" 1
 443
 444 # Start with a fresh gdb.
 445 clean_restart ${testfile}
 446
 447 # The following tests require execution.
 448
 449 if ![runto_main] then {
 450     fail "can't run to main"
 451     return 0
 452 }
 453
 454 runto [gdb_get_line_number "Break at func2 call site."]
 455
 456 gdb_py_test_silent_cmd "python line = gdb.selected_frame().find_sal().line" "Get line number of func2 call site" 1
 457 gdb_test "python print (gdb.find_pc_line(gdb.selected_frame().pc()).line == line)" "True" "test find_pc_line at func2 call site"
 458
 459 gdb_py_test_silent_cmd "step" "Step into func2" 1
 460 gdb_py_test_silent_cmd "up" "Step out of func2" 1
 461
 462 gdb_test "python print (gdb.find_pc_line(gdb.selected_frame().pc()).line > line)" "True" "test find_pc_line with resume address"