# -*- python -*-
-import sys, glob, os.path, datetime, pwd, time, fnmatch, string
-sys.path.append(Dir('#/senfscons').abspath)
-sys.path.append(Dir('#/doclib').abspath)
-import SENFSCons, senfutil
+import sys, os.path, fnmatch
+import SENFSCons, senfutil, senfconf
+
###########################################################################
# Load utilities and setup libraries and configure build
env = Environment()
+env.Decider('MD5-timestamp')
+env.EnsureSConsVersion(1,2)
+
# Load all the local SCons tools
-env.Tool('Doxygen', [ 'senfscons' ])
-env.Tool('Dia2Png', [ 'senfscons' ])
-env.Tool('PkgDraw', [ 'senfscons' ])
-env.Tool('InstallSubdir', [ 'senfscons' ])
-env.Tool('CopyToDir', [ 'senfscons' ])
-env.Tool('Boost', [ 'senfscons' ])
-env.Tool('CombinedObject', [ 'senfscons' ])
-env.Tool('PhonyTarget', [ 'senfscons' ])
+senfutil.loadTools(env)
env.Help("""
Additional top-level build targets:
-prepare Create all target files not part of the repository
-all_tests Build and run unit tests for all modules
-all_docs Build documentation for all modules
-all Build everything
-install_all Install SENF into $PREFIX
-deb Build debian source and binary package
-debsrc Build debian source package
-debbin Build debian binary package
-linklint Check links of doxygen documentation with 'linklint'
-fixlinks Fix broken links in doxygen documentation
-valgrind Run all tests under valgrind/memcheck
+prepare Create all target files not part of the repository
+default Build all default targets (like calling scons with no arguments)
+examples Build all examples
+all_tests Build and run unit tests for all modules
+test_changes Build tests only for files with local changes (queries svn or git)
+all_docs Build documentation for all modules
+all Build everything
+install_all Install SENF into $$PREFIX
+deb Build debian source and binary package
+debsrc Build debian source package
+debbin Build debian binary package
+linklint Check links of doxygen documentation with 'linklint'
+fixlinks Fix broken links in doxygen documentation
+all_valgrinds Run all tests under valgrind/memcheck
+lcov Generate test coverage output in doc/lcov and lcov.info
+
+You may execute targets on a remote host (if the directory layout is the same)
+by calling
+
+ scons <target>@[<user>@]<host>
+
+Some more elaborate unit tests may be enabled by setting appropritate variables
+in the shell (unix) environment
+
+SENF_TIMING_CRITICAL_TESTS
+ Enables unit tests which depend on timing measurements. These
+ unit tests should only be run on a single core and an otherwise
+ idle system.
+
+SENF_WLAN_TEST_INTERFACE
+ WLAN interface to use for testing. The interface should not be
+ actively in use.
+
+SENF_ETH_TEST_INTERFACE
+ Ethernet interface to use for testing. The interface should not
+ be actively in use.
+
+Some unit tests will only run when executed to 'root'.
""")
-class BuildTypeOptions:
- def __init__(self, var):
- self._var = var
-
- def __call__(self, target, source, env, for_signature):
- type = env['final'] and "final" or env['debug'] and "debug" or "normal"
- return env[self._var + "_" + type]
-
-env.Replace(
- PKGDRAW = 'doclib/pkgdraw',
-)
-
env.Append(
- ENV = { 'PATH' : os.environ.get('PATH') },
- CLEAN_PATTERNS = [ '*~', '#*#', '*.pyc', 'semantic.cache', '.sconsign*', '.sconsign' ],
-
- CPPPATH = [ '#/include' ],
- LOCALLIBDIR = '#',
+ ENV = { 'PATH' : os.environ.get('PATH'),
+ 'HOME' : os.environ.get('HOME'),
+ 'SSH_AGENT_PID': os.environ.get('SSH_AGENT_PID'),
+ 'SSH_AUTH_SOCK': os.environ.get('SSH_AUTH_SOCK') },
+ CLEAN_PATTERNS = [ '*~', '#*#', '*.pyc', 'semantic.cache', '.sconsign*',
+ '.sconf_temp' ],
+
+ BUILDDIR = '${FLAVOR and "#/build/$FLAVOR" or "#"}',
+ CPPPATH = [ '#', '$BUILDDIR',
+ '${NEED_BOOST_EXT and "#/boost_ext" or None}' ],
+ LOCALLIBDIR = '$BUILDDIR',
LIBPATH = [ '$LOCALLIBDIR' ],
- LIBS = [ '$LIBSENF$LIBADDSUFFIX', 'rt', '$BOOSTREGEXLIB',
- '$BOOSTIOSTREAMSLIB', '$BOOSTSIGNALSLIB', '$BOOSTFSLIB' ],
+ LIBS = [ '$EXTRA_LIBS' ],
+ EXTRA_LIBS = [ 'rt' ],
TEST_EXTRA_LIBS = [ ],
+ VALGRINDARGS = [ '--num-callers=50' ],
+
+ PREFIX = '#/dist',
+ LIBINSTALLDIR = '$PREFIX${syslayout and "/lib" or ""}',
+ BININSTALLDIR = '$PREFIX${syslayout and "/bin" or ""}',
+ INCLUDEINSTALLDIR = '$PREFIX${syslayout and "/include" or ""}',
+ CONFINSTALLDIR = '${syslayout and "$LIBINSTALLDIR/senf" or "$PREFIX"}',
+ OBJINSTALLDIR = '$CONFINSTALLDIR',
+ DOCINSTALLDIR = '$PREFIX${syslayout and "/share/doc/senf" or "/manual"}',
+ SCONSINSTALLDIR = '$CONFINSTALLDIR/site_scons',
- PREFIX = '/usr/local',
- LIBINSTALLDIR = '$PREFIX/lib',
- BININSTALLDIR = '$PREFIX/bin',
- INCLUDEINSTALLDIR = '$PREFIX/include',
- OBJINSTALLDIR = '$LIBINSTALLDIR',
- DOCINSTALLDIR = '$PREFIX/doc',
CPP_INCLUDE_EXTENSIONS = [ '.h', '.hh', '.ih', '.mpp', '.cci', '.ct', '.cti' ],
CPP_EXCLUDE_EXTENSIONS = [ '.test.hh' ],
INLINE_OPTS_NORMAL = [ '-finline-limit=5000' ],
INLINE_OPTS = [ '$INLINE_OPTS_NORMAL' ],
CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long', '$INLINE_OPTS',
- '$CXXFLAGS_' ],
- CXXFLAGS_ = BuildTypeOptions('CXXFLAGS'),
+ '-pipe', '$CXXFLAGS_', '-fno-strict-aliasing' ],
+ CXXFLAGS_ = senfutil.BuildTypeOptions('CXXFLAGS'),
CXXFLAGS_final = [ '-O3' ],
- CXXFLAGS_normal = [ '-O0', '-g' ],
- CXXFLAGS_debug = [ '$CXXFLAGS_normal' ],
+ CXXFLAGS_normal = [ '-O2', '-g' ],
+ CXXFLAGS_debug = [ '-O0', '-g' ],
CPPDEFINES = [ '$expandLogOption', '$CPPDEFINES_' ],
expandLogOption = senfutil.expandLogOption,
- CPPDEFINES_ = BuildTypeOptions('CPPDEFINES'),
+ CPPDEFINES_ = senfutil.BuildTypeOptions('CPPDEFINES'),
CPPDEFINES_final = [ ],
CPPDEFINES_normal = [ 'SENF_DEBUG' ],
CPPDEFINES_debug = [ '$CPPDEFINES_normal' ],
LINKFLAGS = [ '-rdynamic', '$LINKFLAGS_' ],
- LINKFLAGS_ = BuildTypeOptions('LINKFLAGS'),
+ LINKFLAGS_ = senfutil.BuildTypeOptions('LINKFLAGS'),
LINKFLAGS_final = [ ],
LINKFLAGS_normal = [ '-Wl,-S' ],
- LINKFLAGS_debug = [ ],
+ LINKFLAGS_debug = [ '-g' ],
)
+# Add all UNIX env vars starting with 'SENF' to the execution environment
+env.Append( ENV = dict(((k,v) for k,v in os.environ.iteritems() if k.startswith("SENF"))) )
+
env.SetDefault(
- LIBSENF = "senf",
- final = 0,
- debug = 0,
+ LIBSENF = "senf",
+ LCOV = "lcov",
+ GENHTML = "genhtml",
+ VALGRIND = "valgrind",
+ SCONSBIN = env.File("#/tools/scons"),
+ SCONSARGS = [ '-Q', '-j$CONCURRENCY_LEVEL', 'debug=$debug', 'final=$final' ] + \
+ [ '%s=%s' % (k,v) for k,v in ARGUMENTS.iteritems() ],
+ SCONS = "@$SCONSBIN $SCONSARGS",
+ CONCURRENCY_LEVEL = env.GetOption('num_jobs') or 1,
+ TOPDIR = env.Dir('#').abspath,
+ LIBADDSUFFIX = '${FLAVOR and "_$FLAVOR" or ""}',
+ OBJADDSUFFIX = '${LIBADDSUFFIX}',
+ FLAVOR = '',
)
# Set variables from command line
-env.Replace(**ARGUMENTS)
+senfutil.parseArguments(
+ env,
+ BoolVariable('final', 'Build final (optimized) build', False),
+ BoolVariable('debug', 'Link in debug symbols', False),
+ BoolVariable('syslayout', 'Install in to system layout directories (lib/, include/ etc)', False),
+ BoolVariable('sparse_tests', 'Link tests against object files and not the senf lib', False)
+)
-Export('env')
+if 'test_changes' in COMMAND_LINE_TARGETS and not env.has_key('only_tests'):
+ import SparseTestHack
+ env['only_tests'] = " ".join(x.abspath for x in SparseTestHack.findSCMChanges(env))
-# Create Doxyfile.local otherwise doxygen will barf on this non-existent file
-# Create it even when cleaning, to silence the doxygen builder warnings
-if not os.path.exists("Doxyfile.local"):
- Execute(Touch("Doxyfile.local"))
+if env.has_key('only_tests') : env['sparse_tests'] = True
+Export('env')
-# Create local_config.h
-if not env.GetOption('clean') and not os.path.exists("local_config.hh"):
- Execute(Touch("local_config.hh"))
+###########################################################################
+# Configure
+
+@senfconf.Test
+def CheckValgrind(context):
+ context.Message( "Checking for valgrind... " )
+ ret = context.TryAction(['$VALGRIND --version >$TARGET'])
+ context.Result( ret[1].strip() or False )
+ return ret[0]
+
+@senfconf.Test
+def CheckValgrindWildcards(context):
+ context.Message( "Checking whether valgrind supports '...' wildcards in suppressions... " )
+ ret = context.TryAction(['$VALGRIND --suppressions=$SOURCE /bin/true'],
+ "{\n test_suppression\n Memcheck:Addr4\n ...\n fun:foo\n}\n",
+ ".sup")
+ context.Result( ret[0] )
+ return ret[0]
+
+# Default configuration (boost stuff)
+senfutil.Configure(env)
+
+conf = env.Configure(clean=False, help=False, custom_tests = senfconf.Tests())
+env.Replace(
+ HAVE_VALGRIND = conf.CheckValgrind() and conf.CheckValgrindWildcards()
+)
+conf.Finish()
-if not env.GetOption('clean') and not os.path.exists(".prepare-stamp") \
- and not os.environ.get("SCONS") and COMMAND_LINE_TARGETS != [ 'prepare' ]:
- env.Execute([ "scons prepare" ])
+# Only add this here, after all configure checks have run
-# Load SConscripts. Need to load some first (they change the global environment)
-initSConscripts = [
- "debian/SConscript",
- "doclib/SConscript",
-]
+env.Append(LIBS = '$LIBSENF$LIBADDSUFFIX',
+ EXTRA_LIBS = [ '$BOOSTREGEXLIB', '$BOOSTIOSTREAMSLIB', '$BOOSTSIGNALSLIB',
+ '$BOOSTFSLIB' ])
-SConscript(initSConscripts)
+###########################################################################
-if os.path.exists('SConscript.local'):
- SConscript('SConscript.local')
+# Create Doxyfile.local otherwise doxygen will barf on this non-existent file
+# Create it even when cleaning, to silence the doxygen builder warnings
+if not os.path.exists("doclib/Doxyfile.local"):
+ Execute(Touch("doclib/Doxyfile.local"))
-SConscript(list(set(glob.glob("*/SConscript")) - set(initSConscripts)))
+if not env.GetOption('clean') and not os.path.exists(".prepare-stamp") \
+ and not os.environ.get("SCONS") and COMMAND_LINE_TARGETS != [ 'prepare' ]:
+ env.Execute([ "$SCONS prepare" ])
+
+# Load SConscripts
+
+SConscriptChdir(0)
+SConscript("debian/SConscript")
+SConscriptChdir(1)
+if os.path.exists('SConscript.local') : SConscript('SConscript.local')
+if env['sparse_tests']:
+ import SparseTestHack
+ SparseTestHack.setup(env)
+if env.subst('$BUILDDIR') == '#':
+ SConscript("SConscript")
+else:
+ SConscript("SConscript", variant_dir=env.subst('$BUILDDIR'), src_dir='#', duplicate=False)
+SConscript("Examples/SConscript")
+SConscript("HowTos/SConscript")
+SConscript("doclib/SConscript")
+if env['sparse_tests']:
+ verbose = 'test_changes' in COMMAND_LINE_TARGETS
+ SparseTestHack.build(env, verbose, verbose)
###########################################################################
# Define build targets
-#### doc
-env.Depends(SENFSCons.Doxygen(env), env.Value(env['ENV']['REVISION']))
-
-#### libsenf.a
-libsenf = env.Library(env.subst("$LIBSENF$LIBADDSUFFIX"), env['ALLOBJECTS'])
-env.Default(libsenf)
-
-env.InstallSubdir(target = '$INCLUDEINSTALLDIR', source = [ 'config.hh' ])
-env.Install('$LIBINSTALLDIR', libsenf)
-
#### install_all, default, all_tests, all
+env.Install('${SCONSINSTALLDIR}', [ 'site_scons/__init__.py',
+ 'site_scons/senfutil.py',
+ 'site_scons/senfconf.py',
+ 'site_scons/yaptu.py' ])
+env.InstallDir('${SCONSINSTALLDIR}', [ 'site_scons/site_tools', 'site_scons/lib' ],
+ FILTER_SUFFIXES=[ '','.css','.pl','.py','.sh','.sty','.xml','.xsl','.yap' ])
+env.Install('${INCLUDEINSTALLDIR}', 'boost')
+
env.Alias('install_all', env.FindInstalledFiles())
env.Alias('default', DEFAULT_TARGETS)
env.Alias('all_tests', env.FindAllBoostUnitTests())
-env.Alias('all', [ 'default', 'all_tests', 'all_docs' ])
+env.Alias('test_changes', 'all_tests')
+env.Alias('all', [ 'default', 'all_tests', 'examples', 'all_docs' ])
#### prepare
env.PhonyTarget('prepare', [], [])
#### valgrind
-env.PhonyTarget('valgrind', [ 'all_tests' ], [ """
- find -name .test.bin
- | while read test; do
- echo;
- echo "Running $$test";
- echo;
- valgrind --tool=memcheck --error-exitcode=99 --suppressions=valgrind.sup
- $$test $BOOSTTESTARGS;
- [ $$? -ne 99 ] || exit 1;
- done
-""".replace("\n"," ") ])
-
+env.Alias('all_valgrinds')
+if env['HAVE_VALGRIND']:
+ for test in env.FindAllBoostUnitTests():
+ stamp = env.Command(test[0].dir.File('.test-valgrind.stamp'),
+ [ test[0].dir.File('.test.bin'), 'tools/valgrind.sup' ],
+ [ """$VALGRIND --tool=memcheck
+ --error-exitcode=1
+ --suppressions=${SOURCES[1]}
+ $VALGRINDARGS
+ ${SOURCES[0]} --result_code=no $BOOSTTESTARGS
+ """.replace("\n"," "),
+ Touch("$TARGET") ])
+ alias = env.Command(test[0].dir.File('valgrind'), stamp, [ env.NopAction() ])
+ env.Alias('all_valgrinds', alias)
+
+### lcov
+env.PhonyTarget('lcov', [], [
+ '$SCONS debug=1 BUILDDIR="#/build/lcov" CCFLAGS+="-fprofile-arcs -ftest-coverage" LIBS+="gcov" all_tests',
+ '$LCOV --follow --directory $TOPDIR/build/lcov/senf --capture --output-file /tmp/senf_lcov.info --base-directory $TOPDIR',
+ '$LCOV --output-file lcov.info --remove /tmp/senf_lcov.info "*/include/*" "*/boost/*" "*.test.*" ',
+ '$GENHTML --output-directory doc/lcov --title all_tests lcov.info',
+ 'rm /tmp/senf_lcov.info' ])
+if env.GetOption('clean'):
+ env.Clean('lcov', [ os.path.join(path,f)
+ for path, subdirs, files in os.walk('.')
+ for pattern in ('*.gcno', '*.gcda', '*.gcov')
+ for f in fnmatch.filter(files,pattern) ] +
+ [ 'lcov.info', env.Dir('doc/lcov'), env.Dir('build/lcov') ])
+
#### clean
-env.Clean('all', '.prepare-stamp')
-env.Clean('all', libsenf)
-env.Clean('all', 'linklint')
+env.Clean('all', ('.prepare-stamp', env.Dir('dist'), env.Dir('build')))
+if env.GetOption('clean') : env.Depends('all', ('lcov', 'all_valgrinds'))
-if env.GetOption('clean'):
+if env.GetOption('clean') and 'all' in BUILD_TARGETS:
env.Clean('all', [ os.path.join(path,f)
for path, subdirs, files in os.walk('.')
for pattern in env['CLEAN_PATTERNS']
for f in fnmatch.filter(files,pattern) ])
+ # Disable writing to the deleted .sconsign file
+ import SCons.SConsign
+ SCons.SConsign.write = lambda : None
if not env.GetOption('clean') and not os.path.exists(".prepare-stamp"):
Execute(Touch(".prepare-stamp"))
+
+### execute targets on remote hosts
+for target in COMMAND_LINE_TARGETS:
+ if '@' in target:
+ realtarget, host = target.split('@',1)
+ cwd=env.GetLaunchDir()
+ home=os.environ['HOME']+'/'
+ if cwd.startswith(home) : cwd = cwd[len(home):]
+ args = [ '$SCONSARGS' ]
+ if env.GetLaunchDir() != os.getcwd():
+ args.append('-u')
+ env.PhonyTarget(target, [], [ "ssh $HOST scons $SCONSARGS -C $DIR $RTARGET" ],
+ HOST=host, RTARGET=realtarget, DIR=cwd, SCONSARGS=args)
projects / senf.git / blobdiff