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