test/GetBuildFailures/parallel.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 """
  26 Verify that a failed build action with -j works as expected.
  27 """
  28
  29 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
  30
  31 import TestSCons
  32
  33 _python_ = TestSCons._python_
  34
  35 try:
  36     import threading
  37 except ImportError:
  38     # if threads are not supported, then
  39     # there is nothing to test
  40     TestCmd.no_result()
  41     sys.exit()
  42
  43
  44 test = TestSCons.TestSCons()
  45
  46 # We want to verify that -j 4 starts all four jobs, the first and last of
  47 # which fail and the second and third of which succeed, and then stops
  48 # processing due to the build failures.  To try to control the timing,
  49 # the created build scripts use marker directories to avoid doing their
  50 # processing until the previous script has finished.
  51
  52 contents = r"""\
  53 import os.path
  54 import sys
  55 import time
  56 wait_marker = sys.argv[1] + '.marker'
  57 write_marker = sys.argv[2] + '.marker'
  58 if wait_marker != '-.marker':
  59     while not os.path.exists(wait_marker):
  60         time.sleep(1)
  61 if sys.argv[0] == 'mypass.py':
  62     open(sys.argv[3], 'wb').write(open(sys.argv[4], 'rb').read())
  63     exit_value = 0
  64 elif sys.argv[0] == 'myfail.py':
  65     exit_value = 1
  66 if write_marker != '-.marker':
  67     os.mkdir(write_marker)
  68 sys.exit(exit_value)
  69 """
  70
  71 test.write('mypass.py', contents)
  72 test.write('myfail.py', contents)
  73
  74 test.write('SConstruct', """\
  75 Command('f3', 'f3.in', r'@%(_python_)s mypass.py -  f3 $TARGET $SOURCE')
  76 Command('f4', 'f4.in', r'@%(_python_)s myfail.py f3 f4 $TARGET $SOURCE')
  77 Command('f5', 'f5.in', r'@%(_python_)s myfail.py f4 f5 $TARGET $SOURCE')
  78 Command('f6', 'f6.in', r'@%(_python_)s mypass.py f5 -  $TARGET $SOURCE')
  79
  80 def print_build_failures():
  81     from SCons.Script import GetBuildFailures
  82     for bf in sorted(GetBuildFailures(), key=lambda t: t.filename):
  83         print "%%s failed:  %%s" %% (bf.node, bf.errstr)
  84
  85 try:
  86     import atexit
  87 except ImportError:
  88     import sys
  89     sys.exitfunc = print_build_failures
  90 else:
  91     atexit.register(print_build_failures)
  92 """ % locals())
  93
  94 test.write('f3.in', "f3.in\n")
  95 test.write('f4.in', "f4.in\n")
  96 test.write('f5.in', "f5.in\n")
  97 test.write('f6.in', "f6.in\n")
  98
  99 test.run(arguments = '-Q -j 4 .',
 100          status = 2,
 101          stderr = None)
 102
 103 f4_error = "scons: *** [f4] Error 1\n"
 104 f5_error = "scons: *** [f5] Error 1\n"
 105
 106 error_45 = f4_error + f5_error
 107 error_54 = f5_error + f4_error
 108
 109 if test.stderr() not in [error_45, error_54]:
 110     print "Did not find the following output in list of expected strings:"
 111     print test.stderr(),
 112     test.fail_test()
 113
 114 # We jump through hoops above to try to make sure that the individual
 115 # commands execute and exit in the order we want, but we still can't be
 116 # 100% sure that SCons will actually detect and record the failures in
 117 # that order; the thread for f5 may detect its command's failure before
 118 # the thread for f4.  Just sidestep the issue by allowing the failure
 119 # strings in the output to come in either order.  If there's a genuine
 120 # problem in the way things get ordered, it'll show up in stderr.
 121
 122 f4_failed = "f4 failed:  Error 1\n"
 123 f5_failed = "f5 failed:  Error 1\n"
 124
 125 failed_45 = f4_failed + f5_failed
 126 failed_54 = f5_failed + f4_failed
 127
 128 if test.stdout() not in [failed_45, failed_54]:
 129     print "Did not find the following output in list of expected strings:"
 130     print test.stdout(),
 131     test.fail_test()
 132
 133 test.must_match(test.workpath('f3'), 'f3.in\n')
 134 test.must_not_exist(test.workpath('f4'))
 135 test.must_not_exist(test.workpath('f5'))
 136 test.must_match(test.workpath('f6'), 'f6.in\n')
 137
 138
 139
 140 test.pass_test()
 141
 142 # Local Variables:
 143 # tab-width:4
 144 # indent-tabs-mode:nil
 145 # End:
 146 # vim: set expandtab tabstop=4 shiftwidth=4: