mb_test.py

"""
Tools for running things that you just built from SCons.
"""

import os


def _get_ld_path_key(env):
    if env.MBIsWindows():
        key = 'PATH'
    elif env.MBIsMac():
        key = 'DYLD_LIBRARY_PATH'
    else:
        key = 'LD_LIBRARY_PATH'
    return key


def mb_prepend_dl_path(env, path):
    key = _get_ld_path_key(env)
    env.PrependENVPath(key, path)


def mb_append_dl_path(env, path):
    key = _get_ld_path_key(env)
    env.AppendENVPath(key, path)


def set_test_paths(env):
    env.MBPrependDLPath(env['MB_LIB_DIR'])
    if env.MBIsMac():
        # When we are installing on mac, all libraries and binaries
        # have the framework library paths hard coded in place in the
        # obj directory, so we have no access to the developer linked
        # binaries for running unit tests.
        env.PrependENVPath('DYLD_ROOT_PATH', env.MBGetOption('install_prefix'))
    elif env.MBIsWindows():
        # I don't think that we should be relying on our builders
        # having all third party libraries on the system path.
        # TODO(chris.moore): is this still necessary?
        env.AppendENVPath('PATH', env['MB_BIN_DIR'])


def mb_add_test(env, name, action, deps=(), **kwargs):
    """
    Add a test that will always be run when the "test" target is
    selected.  You can specify targets that must be built before
    the test is run with deps, but the test will still run even
    if no dependency has changed.
    """
    target = env.Command('run_' + name, deps, action, **kwargs)
    env.Depends(env['_test_alias'], target)
    env.AlwaysBuild(target)
    env.Ignore('.', target)


def generate(env):
    env.Tool('common')
    if 'mb_install' not in env['TOOLS']:
        env.Tool('mb_install')

    env.AddMethod(mb_prepend_dl_path, 'MBPrependDLPath')
    env.AddMethod(mb_append_dl_path, 'MBAppendDLPath')

    env.AddMethod(mb_add_test, 'MBAddTest')

    env['_test_alias'] = env.Alias('test')
    env.AddMethod(mb_add_test, 'MBAddTest')

    set_test_paths(env)


def exists(env):
    return True