Merge branch 'improve-build-script'

Improvements to the scons build script:

- use separate scons environment for building the shared library.
- simplify configuration of include and library compiler paths.
- load configure script after setting compiler-related flags.
- provide only test-related scons targets when test_installed=true.

This fixes #9.

Author: pavoljuhas

.travis-sconscript.local

@@ -10,6 +10,7 @@ env.Prepend(CCFLAGS='-isystem{}/include'.format(P))
 
 # Define path to the shared libraries from Anaconda environment.
 L = P + '/lib'
+env.Append(LIBPATH=L)
 env.Append(LINKFLAGS='-Wl,-rpath,{!r}'.format(L))
 
 # vim: ft=python

SConstruct

@@ -27,8 +27,7 @@ def subdictionary(d, keyset):
 
 # copy system environment variables related to compilation
 DefaultEnvironment(ENV=subdictionary(os.environ, '''
-    PATH PYTHONPATH
-    CPATH CPLUS_INCLUDE_PATH LIBRARY_PATH LD_RUN_PATH
+    PATH CPATH CPLUS_INCLUDE_PATH LIBRARY_PATH LD_RUN_PATH
     LD_LIBRARY_PATH DYLD_LIBRARY_PATH DYLD_FALLBACK_LIBRARY_PATH
     MACOSX_DEPLOYMENT_TARGET
     '''.split())

conda-recipe/run_test.sh

@@ -1,5 +1,8 @@
 #!/bin/bash
 
+export CPATH="${PREFIX}/include:${CPATH}"
+export LIBRARY_PATH="${PREFIX}/lib:${LIBRARY_PATH}"
+
 MYNCPU=$(( (CPU_COUNT > 8) ? 8 : CPU_COUNT ))
 
 # Apply sconscript.local customizations.

src/SConscript

@@ -8,9 +8,6 @@ Import('env')
 flagnames = 'CFLAGS CXXFLAGS LDFLAGS'.split()
 env.MergeFlags([os.environ.get(n, '') for n in flagnames])
 
-# The directory of this SConscript should be searched first for any headers.
-env.PrependUnique(CPPPATH=Dir('.'))
-
 # Insert LIBRARY_PATH explicitly because some compilers
 # ignore it in the system environment.
 env.PrependUnique(LIBPATH=env['ENV'].get('LIBRARY_PATH', '').split(':'))
@@ -24,11 +21,6 @@ if env['tool'] == 'intelc':
         Exit(1)
     env.Tool('intelc', topdir=icpc[:icpc.rfind('/bin')])
 
-# Declare external libraries.
-env.ParseConfig("gsl-config --cflags --libs")
-# dladdr in runtimepath.cpp requires the dl library.
-env.AppendUnique(LIBS=['dl'])
-
 fast_linkflags = ['-s']
 
 # Platform specific intricacies.
@@ -38,15 +30,6 @@ if env['PLATFORM'] == 'darwin':
     env.AppendUnique(SHLINKFLAGS='-headerpad_max_install_names')
     fast_linkflags[:] = []
 
-# configure version specific options.
-skip_configure = (GetOption('clean') or GetOption('help') or
-        (['sdist'] == list(COMMAND_LINE_TARGETS)))
-if not skip_configure:
-    SConscript('SConscript.configure')
-elif GetOption('clean'):
-    # make sure ObjCryst files will be also cleaned
-    env['has_objcryst'] = True
-
 # Compiler specific options
 if icpc:
     # options for Intel C++ compiler on hpc dev-intel07
@@ -74,22 +57,41 @@ if env['coverage']:
     env.Append(CCFLAGS=['--coverage', '-O0'])
     env.Append(LINKFLAGS='--coverage')
 
+# configure boost and ObjCryst libraries unless non-relevant.
+skip_configure = (GetOption('clean') or GetOption('help') or
+                  (['sdist'] == list(COMMAND_LINE_TARGETS)))
+if not skip_configure:
+    SConscript('SConscript.configure')
+
+# when cleaning make sure to also purge ObjCryst files
+if GetOption('clean'):
+    env['has_objcryst'] = True
+
 # Define lists for storing library source and include files.
 env['lib_includes'] = []
 env['lib_sources'] = []
 env['lib_datafiles'] = []
 
 # Subsidiary SConscripts -----------------------------------------------------
 
-# Determine if unit tests need to be built.
-build_tests = set(('test', 'alltests')).intersection(COMMAND_LINE_TARGETS)
+# The targets that concern unit tests.
+targets_that_test = set(('test', 'alltests'))
 
 # Short circuit if we test an already installed library.  Do not define
 # any further targets as they may conflict with the installed files.
-if build_tests and env['test_installed']:
+if env['test_installed']:
     SConscript('tests/SConscript')
+    if not targets_that_test.issuperset(COMMAND_LINE_TARGETS):
+        print('Warning: only test targets are available when '
+              '"test_installed=True".')
     Return()
 
+assert not env['test_installed']
+
+# Here we do not test the installed library.  Any diffpy headers
+# should thus be looked up from our source tree.
+env.PrependUnique(CPPPATH=Dir('.'))
+
 # Load the version script first to resolve the majorminor tuple
 SConscript('diffpy/SConscript.version')
 
@@ -110,15 +112,22 @@ if 'sdist' in COMMAND_LINE_TARGETS:
 # Top Level Targets ----------------------------------------------------------
 
 # lib -- shared library object
-libdiffpy = env.SharedLibrary('diffpy', env['lib_sources'])
+
+# use new environment with extra libraries needed for libdiffpy.
+env_lib = env.Clone()
+# Setup GSL, the GNU Scientific library.
+env_lib.ParseConfig("gsl-config --cflags --libs")
+# The dladdr call in runtimepath.cpp requires the dl library.
+env_lib.AppendUnique(LIBS=['dl'])
+
+libdiffpy = env_lib.SharedLibrary('diffpy', env['lib_sources'])
 Export('libdiffpy')
 lib = Alias('lib', [libdiffpy, env['lib_includes']])
 Default(lib)
 
 # Define targets related to testing.  Do so only when testing is requested.
 # This enables library build on machines without cxxtest.
-if build_tests:
-    assert not env['test_installed']
+if targets_that_test.intersection(COMMAND_LINE_TARGETS):
     SConscript('tests/SConscript')
 
 # Installation targets.

src/tests/SConscript

@@ -9,7 +9,6 @@ env_test.Tool('cxxtest')
 
 if env['test_installed']:
     # build unit tests for the installed library
-    env_test['CPPPATH'].remove(Dir('..'))
     env_test.PrependUnique(CPPPATH=env['includedir'], delete_existing=1)
     lib_dir = env['libdir']
 else:
@@ -21,11 +20,6 @@ use_our_library = not env['test_installed']
 env_test.PrependUnique(LIBS='diffpy', LIBPATH=lib_dir, delete_existing=1)
 env_test.PrependUnique(LINKFLAGS="-Wl,-rpath,%r" % lib_dir)
 
-# Use only libraries needed for building the unit tests.
-pat = 'diffpy|boost_serialization|ObjCryst'
-keeplibs = lambda s: re.search(pat, str(s))
-env_test.Replace(LIBS=filter(keeplibs, env_test['LIBS']))
-
 # Targets --------------------------------------------------------------------
 
 def srcsupported(f):