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