senfscons/BoostUnitTests.py

   1 ## \file
   2 # \brief BoostUnitTests build
   3
   4 ## \package senfscons.BoostUnitTests
   5 # \brief Builder utilizing the <a href="http://www.boost.org/libs/test/doc/index.html">Boost.Test</a> unit-test framework
   6 #
   7 # The BoostUnitTests builder will build a unit-test executable using
   8 # the <a
   9 # href="http://www.boost.org/libs/test/doc/index.html">Boost.Test</a>
  10 # library. After building, the unit-test will be executed.
  11 #
  12 # This builder is used by the SENFSCons.Object() helper to build the
  13 # unit test.
  14 #
  15 # \par Construction Envrionment Variables:
  16 # <table class="senf">
  17 # <tr><td>\c BOOSTTESTLIB</td><td>Name of the library to use, defaults to \c boost_unit_test_framework</td></tr>
  18 # <tr><td>\c BOOSTTESTARGS</td><td>Command line arguments of the test, defaults to <tt>--build_info=yes --log_level=test_suite</tt></td></tr>
  19 # </table>
  20 #
  21 # \todo This is not really a builder. This should be rewritten as one
  22 # \ingroup builder
  23
  24 import SCons.Script.SConscript
  25 import SCons.Defaults
  26 import os.path
  27 import os
  28
  29 def BoostUnitTests(env, target, source, test_source=None, LIBS = [], DEPENDS = [], **kw):
  30     path, name = os.path.split(target)
  31     if test_source:
  32         if type(test_source) is not type([]):
  33             test_source = [ test_source ]
  34     else:
  35         test_source = []
  36     testEnv = env.Copy(**kw)
  37     testEnv.Prepend(LIBS = '$BOOSTTESTLIB')
  38     testEnv.Prepend(LIBS = LIBS)
  39     sources = []
  40     if source:
  41         sources = sources + env.Object(source)
  42     sources = sources + test_source
  43     binName = os.path.join(path,'.' + name +'.bin')
  44     testRunner = testEnv.Program(binName, sources)
  45     stamp = os.path.join(path,'.' + os.path.splitext(name)[0]+'.stamp')
  46     if DEPENDS:
  47         env.Depends(testRunner, DEPENDS)
  48     return env.Command([ stamp ], testRunner,
  49                        [ '$SOURCE $BOOSTTESTARGS',
  50                          'touch $TARGET' ])
  51
  52 def dispatcher(*arg,**kw):
  53     return BoostUnitTests(*arg,**kw)
  54
  55 def generate(env):
  56     env['BOOSTTESTLIB'] = 'boost_unit_test_framework'
  57     env['BOOSTTESTARGS'] = [ '--build_info=yes', '--log_level=test_suite' ]
  58     env.__class__.BoostUnitTests = dispatcher
  59
  60 def exists(env):
  61     return 1