selftest/wscript

   1 #!/usr/bin/env python
   2 # vim: expandtab ft=python
   3
   4 # selftest main code.
   5
   6 import Scripting, os, Options, Utils, Environment, optparse, sys
   7 from samba_utils import *
   8 from samba_autoconf import *
   9 import types
  10
  11 def set_options(opt):
  12
  13     opt.add_option('--enable-selftest',
  14                    help=("enable options necessary for selftest (default=no)"),
  15                    action="store_true", dest='enable_selftest', default=False)
  16     opt.add_option('--enable-coverage',
  17                    help=("enable options necessary for code coverage "
  18                          "reporting on selftest (default=no)"),
  19                    action="store_true", dest='enable_coverage', default=False)
  20     opt.add_option('--with-selftest-prefix',
  21                    help=("specify location of selftest directory "
  22                          "(default=./st)"),
  23                    action="store", dest='SELFTEST_PREFIX', default='./st')
  24
  25     opt.ADD_COMMAND('test', cmd_test)
  26     opt.ADD_COMMAND('testonly', cmd_testonly)
  27
  28     gr = opt.add_option_group('test options')
  29
  30     gr.add_option('--load-list',
  31                   help=("Load a test id list from a text file"),
  32                   action="store", dest='LOAD_LIST', default=None)
  33     gr.add_option('--list',
  34                   help=("List available tests"),
  35                   action="store_true", dest='LIST', default=False)
  36     gr.add_option('--tests',
  37                   help=("wildcard pattern of tests to run"),
  38                   action="store", dest='TESTS', default='')
  39     gr.add_option('--filtered-subunit',
  40                   help=("output (xfail) filtered subunit"),
  41                   action="store_true", dest='FILTERED_SUBUNIT', default=False)
  42     gr.add_option('--quick',
  43                   help=("enable only quick tests"),
  44                   action="store_true", dest='QUICKTEST', default=False)
  45     gr.add_option('--slow',
  46                   help=("enable the really slow tests"),
  47                   action="store_true", dest='SLOWTEST', default=False)
  48     gr.add_option('--testenv',
  49                   help=("start a terminal with the test environment setup"),
  50                   action="store_true", dest='TESTENV', default=False)
  51     gr.add_option('--valgrind',
  52                   help=("use valgrind on client programs in the tests"),
  53                   action="store_true", dest='VALGRIND', default=False)
  54     gr.add_option('--valgrind-log',
  55                   help=("where to put the valgrind log"),
  56                   action="store", dest='VALGRINDLOG', default=None)
  57     gr.add_option('--valgrind-server',
  58                   help=("use valgrind on the server in the tests (opens an xterm)"),
  59                   action="store_true", dest='VALGRIND_SERVER', default=False)
  60     gr.add_option('--screen',
  61                   help=("run the samba servers in screen sessions"),
  62                   action="store_true", dest='SCREEN', default=False)
  63     gr.add_option('--gdbtest',
  64                   help=("run the servers within a gdb window"),
  65                   action="store_true", dest='GDBTEST', default=False)
  66     gr.add_option('--fail-immediately',
  67                   help=("stop tests on first failure"),
  68                   action="store_true", dest='FAIL_IMMEDIATELY', default=False)
  69     gr.add_option('--socket-wrapper-pcap',
  70                   help=("create a pcap file for each failing test"),
  71                   action="store_true", dest='SOCKET_WRAPPER_PCAP', default=False)
  72     gr.add_option('--socket-wrapper-keep-pcap',
  73                   help=("create a pcap file for all individual test"),
  74                   action="store_true", dest='SOCKET_WRAPPER_KEEP_PCAP', default=False)
  75     gr.add_option('--random-order', dest='RANDOM_ORDER', default=False,
  76                   action="store_true", help="Run testsuites in random order")
  77
  78 def configure(conf):
  79     conf.env.SELFTEST_PREFIX = Options.options.SELFTEST_PREFIX
  80     conf.env.enable_coverage = Options.options.enable_coverage
  81     if conf.env.enable_coverage:
  82         conf.ADD_LDFLAGS('-lgcov', testflags=True)
  83         conf.ADD_CFLAGS('--coverage')
  84
  85     if Options.options.enable_selftest or Options.options.developer:
  86         conf.DEFINE('ENABLE_SELFTEST', 1)
  87
  88
  89 def cmd_testonly(opt):
  90     '''run tests without doing a build first'''
  91     env = LOAD_ENVIRONMENT()
  92     opt.env = env
  93
  94     env.SELFTEST_PREFIX = Options.options.SELFTEST_PREFIX
  95
  96     if (not CONFIG_SET(opt, 'NSS_WRAPPER') or
  97         not CONFIG_SET(opt, 'UID_WRAPPER') or
  98         not CONFIG_SET(opt, 'SOCKET_WRAPPER')):
  99         print("ERROR: You must use --enable-selftest to enable selftest")
 100         sys.exit(1)
 101
 102     os.environ['SAMBA_SELFTEST'] = '1'
 103
 104     env.TESTS  = Options.options.TESTS
 105
 106     env.SUBUNIT_FORMATTER = os.getenv('SUBUNIT_FORMATTER')
 107     if not env.SUBUNIT_FORMATTER:
 108         env.SUBUNIT_FORMATTER = '${PYTHON} -u ${srcdir}/selftest/format-subunit --prefix=${SELFTEST_PREFIX} --immediate'
 109     env.FILTER_XFAIL = '${PYTHON} -u ${srcdir}/selftest/filter-subunit --expected-failures=${srcdir}/selftest/knownfail --flapping=${srcdir}/selftest/flapping'
 110
 111     if Options.options.FAIL_IMMEDIATELY:
 112         env.FILTER_XFAIL += ' --fail-immediately'
 113
 114     env.FORMAT_TEST_OUTPUT = '${SUBUNIT_FORMATTER}'
 115
 116     # clean any previous temporary files
 117     os.system("rm -rf %s/tmp" % env.SELFTEST_PREFIX);
 118
 119     # put all command line options in the environment as TESTENV_*=*
 120     for o in dir(Options.options):
 121         if o[0:1] != '_':
 122             val = getattr(Options.options, o, '')
 123             if not issubclass(type(val), types.FunctionType) \
 124                     and not issubclass(type(val), types.MethodType):
 125                 os.environ['TESTENV_%s' % o.upper()] = str(getattr(Options.options, o, ''))
 126
 127
 128     binary_mapping = ('nmblookup3:nmblookup,' +
 129                       'nmblookup4:nmblookup4,' +
 130                       'smbclient3:smbclient,' +
 131                       'smbclient4:smbclient4,' +
 132                       'smbtorture4:smbtorture,' +
 133                       'ntlm_auth3:ntlm_auth')
 134
 135     env.OPTIONS = '--binary-mapping=%s' % binary_mapping
 136     if not Options.options.SLOWTEST:
 137         env.OPTIONS += ' --exclude=${srcdir}/selftest/slow'
 138     if Options.options.QUICKTEST:
 139         env.OPTIONS += ' --quick --include=${srcdir}/selftest/quick'
 140     if Options.options.LOAD_LIST:
 141         env.OPTIONS += ' --load-list=%s' % Options.options.LOAD_LIST
 142     if Options.options.TESTENV:
 143         env.OPTIONS += ' --testenv'
 144     if Options.options.SOCKET_WRAPPER_PCAP:
 145         env.OPTIONS += ' --socket-wrapper-pcap'
 146     if Options.options.SOCKET_WRAPPER_KEEP_PCAP:
 147         env.OPTIONS += ' --socket-wrapper-keep-pcap'
 148     if Options.options.RANDOM_ORDER:
 149         env.OPTIONS += ' --random-order'
 150     if os.environ.get('RUN_FROM_BUILD_FARM') is not None:
 151         env.FILTER_OPTIONS = '${FILTER_XFAIL} --strip-passed-output'
 152     else:
 153         env.FILTER_OPTIONS = '${FILTER_XFAIL}'
 154
 155     if Options.options.VALGRIND:
 156         os.environ['VALGRIND'] = 'valgrind -q --num-callers=30'
 157         if Options.options.VALGRINDLOG is not None:
 158             os.environ['VALGRIND'] += ' --log-file=%s' % Options.options.VALGRINDLOG
 159
 160     server_wrapper=''
 161
 162     if Options.options.VALGRIND_SERVER:
 163         server_wrapper = '${srcdir}/selftest/valgrind_run _DUMMY=X'
 164     elif Options.options.GDBTEST:
 165         server_wrapper = '${srcdir}/selftest/gdb_run _DUMMY=X'
 166
 167     if Options.options.SCREEN:
 168         server_wrapper = '${srcdir}/selftest/in_screen %s' % server_wrapper
 169         os.environ['TERMINAL'] = EXPAND_VARIABLES(opt, '${srcdir}/selftest/in_screen')
 170     elif server_wrapper != '':
 171         server_wrapper = 'xterm -n server -l -e %s' % server_wrapper
 172
 173     if server_wrapper != '':
 174         os.environ['SAMBA_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
 175         os.environ['NMBD_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
 176         os.environ['WINBINDD_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
 177         os.environ['SMBD_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
 178
 179     # this is needed for systems without rpath, or with rpath disabled
 180     ADD_LD_LIBRARY_PATH('bin/shared')
 181     ADD_LD_LIBRARY_PATH('bin/shared/private')
 182
 183     # if we are using a system version of ldb then we need to tell it to
 184     # load modules from our modules path
 185     if env.USING_SYSTEM_LDB:
 186         os.environ['LDB_MODULES_PATH'] = os.path.abspath(os.path.join(env.cwd, 'bin/modules/ldb'))
 187
 188     # tell build system where to find config.h
 189     os.environ['CONFIG_H'] = 'bin/default/include/config.h'
 190
 191     st_done = os.path.join(env.SELFTEST_PREFIX, 'st_done')
 192     if os.path.exists(st_done):
 193         os.unlink(st_done)
 194
 195     if not os.path.isdir(env.SELFTEST_PREFIX):
 196         os.makedirs(env.SELFTEST_PREFIX, int('755', 8))
 197
 198     env.TESTLISTS = ('--testlist="${PYTHON} ${srcdir}/selftest/tests.py|" ' +
 199                      '--testlist="${PYTHON} ${srcdir}/source3/selftest/tests.py|" ' +
 200                      '--testlist="${PYTHON} ${srcdir}/source4/selftest/tests.py|"')
 201
 202     if CONFIG_SET(opt, 'AD_DC_BUILD_IS_ENABLED'):
 203         env.SELFTEST_TARGET = "samba"
 204     else:
 205         env.SELFTEST_TARGET = "samba3"
 206
 207     env.OPTIONS += " --nss_wrapper_so_path=" + CONFIG_GET(opt, 'LIBNSS_WRAPPER_SO_PATH')
 208     env.OPTIONS += " --socket_wrapper_so_path=" + CONFIG_GET(opt, 'LIBSOCKET_WRAPPER_SO_PATH')
 209     env.OPTIONS += " --uid_wrapper_so_path=" + CONFIG_GET(opt, 'LIBUID_WRAPPER_SO_PATH')
 210
 211     # We use the full path rather than relative path to avoid problems on some platforms (ie. solaris 8).
 212     env.CORE_COMMAND = '${PERL} ${srcdir}/selftest/selftest.pl --target=${SELFTEST_TARGET} --prefix=${SELFTEST_PREFIX} --srcdir=${srcdir} --exclude=${srcdir}/selftest/skip ${TESTLISTS} ${OPTIONS} ${TESTS}'
 213     if Options.options.LIST:
 214         cmd = '${CORE_COMMAND} --list'
 215     else:
 216         env.OPTIONS += ' --socket-wrapper'
 217         cmd = '(${CORE_COMMAND} && touch ${SELFTEST_PREFIX}/st_done) | ${FILTER_OPTIONS}'
 218         if (os.environ.get('RUN_FROM_BUILD_FARM') is None and
 219             not Options.options.FILTERED_SUBUNIT):
 220             cmd += ' | tee ${SELFTEST_PREFIX}/subunit | ${FORMAT_TEST_OUTPUT}'
 221         else:
 222             cmd += ' | ${FILTER_OPTIONS}'
 223     runcmd = EXPAND_VARIABLES(opt, cmd)
 224
 225     print("test: running %s" % runcmd)
 226     ret = RUN_COMMAND(cmd, env=env)
 227
 228     if (os.path.exists(".testrepository") and
 229         not Options.options.LIST and
 230         not Options.options.LOAD_LIST):
 231         testrcmd = 'testr load -q < ${SELFTEST_PREFIX}/subunit > /dev/null'
 232         runcmd = EXPAND_VARIABLES(opt, testrcmd)
 233         RUN_COMMAND(runcmd, env=env)
 234
 235     if ret != 0:
 236         print("ERROR: test failed with exit code %d" % ret)
 237         sys.exit(ret)
 238
 239     if not Options.options.LIST and not os.path.exists(st_done):
 240         print("ERROR: test command failed to complete")
 241         sys.exit(1)
 242
 243
 244 ########################################################################
 245 # main test entry point
 246 def cmd_test(opt):
 247     '''Run the test suite (see test options below)'''
 248
 249     # if running all tests, then force a symbol check
 250     env = LOAD_ENVIRONMENT()
 251     CHECK_MAKEFLAGS(env)
 252     Scripting.commands.append('build')
 253     Scripting.commands.append('testonly')