test/option/debug-stacktrace.py

   1 #!/usr/bin/env python
   2 #
   3 # __COPYRIGHT__
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining
   6 # a copy of this software and associated documentation files (the
   7 # "Software"), to deal in the Software without restriction, including
   8 # without limitation the rights to use, copy, modify, merge, publish,
   9 # distribute, sublicense, and/or sell copies of the Software, and to
  10 # permit persons to whom the Software is furnished to do so, subject to
  11 # the following conditions:
  12 #
  13 # The above copyright notice and this permission notice shall be included
  14 # in all copies or substantial portions of the Software.
  15 #
  16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  17 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  18 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23 #
  24
  25 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
  26
  27 """
  28 Test the --debug=stacktrace option.
  29 """
  30
  31 import TestSCons
  32
  33 test = TestSCons.TestSCons()
  34
  35 test.write('SConstruct', """\
  36 def kfile_scan(node, env, target):
  37     raise Exception, "kfile_scan error"
  38
  39 kscan = Scanner(name = 'kfile',
  40                 function = kfile_scan,
  41                 skeys = ['.k'])
  42
  43 env = Environment()
  44 env.Append(SCANNERS = [kscan])
  45
  46 env.Command('foo', 'foo.k', Copy('$TARGET', '$SOURCE'))
  47 """)
  48
  49 test.write('foo.k', "foo.k\n")
  50
  51 test.run(status = 2, stderr = "scons: *** [foo] Exception : kfile_scan error\n")
  52
  53 test.run(arguments = "--debug=stacktrace",
  54          status = 2,
  55          stderr = None)
  56
  57 lines = [
  58     "scons: *** [foo] Exception : kfile_scan error",
  59     "scons: internal stack trace:",
  60     'raise Exception, "kfile_scan error"',
  61 ]
  62
  63 test.must_contain_all_lines(test.stderr(), lines)
  64
  65
  66
  67 # Test that --debug=stacktrace works for UserError exceptions,
  68 # which are handled by different code than other exceptions.
  69
  70 test.write('SConstruct', """\
  71 import SCons.Errors
  72 raise SCons.Errors.UserError, "explicit UserError!"
  73 """)
  74
  75 test.run(arguments = '--debug=stacktrace',
  76          status = 2,
  77          stderr = None)
  78
  79 user_error_lines = [
  80     'UserError: explicit UserError!',
  81     'scons: *** explicit UserError!',
  82 ]
  83
  84 # The "(most recent call last)" message is used by more recent Python
  85 # versions than the "(innermost last)" message, so that's the one
  86 # we report if neither matches.
  87 traceback_lines = [
  88     "Traceback (most recent call last)",
  89     "Traceback (innermost last)",
  90 ]
  91
  92 test.must_contain_all_lines(test.stderr(), user_error_lines)
  93 test.must_contain_any_line(test.stderr(), traceback_lines)
  94
  95 # Test that full path names to SConscript files show up in stack traces.
  96
  97 test.write('SConstruct', """\
  98 1/0
  99 """)
 100
 101 test.run(arguments = '--debug=stacktrace',
 102          status = 2,
 103          stderr = None)
 104
 105 lines = [
 106     '  File "%s", line 1:' % test.workpath('SConstruct'),
 107 ]
 108
 109 test.must_contain_all_lines(test.stderr(), lines)
 110
 111
 112
 113 test.pass_test()
 114
 115 # Local Variables:
 116 # tab-width:4
 117 # indent-tabs-mode:nil
 118 # End:
 119 # vim: set expandtab tabstop=4 shiftwidth=4: