test/option/debug-stacktrace.py

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