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 DEFAULT_SELFTEST_PREFIX="./st"
  12
  13 def set_options(opt):
  14
  15     opt.add_option('--enable-selftest',
  16                    help=("enable options necessary for selftest (default=no)"),
  17                    action="store_true", dest='enable_selftest', default=False)
  18     opt.add_option('--enable-coverage',
  19                    help=("enable options necessary for code coverage "
  20                          "reporting on selftest (default=no)"),
  21                    action="store_true", dest='enable_coverage', default=False)
  22     opt.add_option('--with-selftest-prefix',
  23                    help=("specify location of selftest directory "
  24                          "(default=%s)" % DEFAULT_SELFTEST_PREFIX),
  25                    action="store", dest='SELFTEST_PREFIX', default=DEFAULT_SELFTEST_PREFIX)
  26
  27     opt.ADD_COMMAND('test', cmd_test)
  28     opt.ADD_COMMAND('testonly', cmd_testonly)
  29
  30     gr = opt.add_option_group('test options')
  31
  32     gr.add_option('--load-list',
  33                   help=("Load a test id list from a text file"),
  34                   action="store", dest='LOAD_LIST', default=None)
  35     gr.add_option('--list',
  36                   help=("List available tests"),
  37                   action="store_true", dest='LIST', default=False)
  38     gr.add_option('--tests',
  39                   help=("wildcard pattern of tests to run"),
  40                   action="store", dest='TESTS', default='')
  41     gr.add_option('--filtered-subunit',
  42                   help=("output (xfail) filtered subunit"),
  43                   action="store_true", dest='FILTERED_SUBUNIT', default=False)
  44     gr.add_option('--quick',
  45                   help=("enable only quick tests"),
  46                   action="store_true", dest='QUICKTEST', default=False)
  47     gr.add_option('--slow',
  48                   help=("enable the really slow tests"),
  49                   action="store_true", dest='SLOWTEST', default=False)
  50     gr.add_option('--nb-slowest',
  51                   help=("Show the n slowest tests (default=10)"),
  52                   type=int, default=10, dest='NB_SLOWEST')
  53     gr.add_option('--testenv',
  54                   help=("start a terminal with the test environment setup"),
  55                   action="store_true", dest='TESTENV', default=False)
  56     gr.add_option('--valgrind',
  57                   help=("use valgrind on client programs in the tests"),
  58                   action="store_true", dest='VALGRIND', default=False)
  59     gr.add_option('--valgrind-log',
  60                   help=("where to put the valgrind log"),
  61                   action="store", dest='VALGRINDLOG', default=None)
  62     gr.add_option('--valgrind-server',
  63                   help=("use valgrind on the server in the tests (opens an xterm)"),
  64                   action="store_true", dest='VALGRIND_SERVER', default=False)
  65     gr.add_option('--screen',
  66                   help=("run the samba servers in screen sessions"),
  67                   action="store_true", dest='SCREEN', default=False)
  68     gr.add_option('--gdbtest',
  69                   help=("run the servers within a gdb window"),
  70                   action="store_true", dest='GDBTEST', default=False)
  71     gr.add_option('--fail-immediately',
  72                   help=("stop tests on first failure"),
  73                   action="store_true", dest='FAIL_IMMEDIATELY', default=False)
  74     gr.add_option('--socket-wrapper-pcap',
  75                   help=("create a pcap file for each failing test"),
  76                   action="store_true", dest='SOCKET_WRAPPER_PCAP', default=False)
  77     gr.add_option('--socket-wrapper-keep-pcap',
  78                   help=("create a pcap file for all individual test"),
  79                   action="store_true", dest='SOCKET_WRAPPER_KEEP_PCAP', default=False)
  80     gr.add_option('--random-order', dest='RANDOM_ORDER', default=False,
  81                   action="store_true", help="Run testsuites in random order")
  82     gr.add_option('--perf-test', dest='PERF_TEST', default=False,
  83                   action="store_true", help="run performance tests only")
  84     gr.add_option('--test-list', dest='TEST_LIST', default='',
  85                   help=("use tests listed here, not defaults "
  86                         "(--test-list='FOO|' will execute FOO; "
  87                         "--test-list='FOO' will read it)"))
  88
  89 def configure(conf):
  90     conf.env.SELFTEST_PREFIX = Options.options.SELFTEST_PREFIX
  91     conf.env.enable_coverage = Options.options.enable_coverage
  92     if conf.env.enable_coverage:
  93         conf.ADD_LDFLAGS('-lgcov', testflags=True)
  94         conf.ADD_CFLAGS('--coverage')
  95
  96     if Options.options.enable_selftest or Options.options.developer:
  97         conf.DEFINE('ENABLE_SELFTEST', 1)
  98
  99
 100 def cmd_testonly(opt):
 101     '''run tests without doing a build first'''
 102     env = LOAD_ENVIRONMENT()
 103     opt.env = env
 104
 105     if Options.options.SELFTEST_PREFIX != DEFAULT_SELFTEST_PREFIX:
 106         env.SELFTEST_PREFIX = Options.options.SELFTEST_PREFIX
 107
 108     if (not CONFIG_SET(opt, 'NSS_WRAPPER') or
 109         not CONFIG_SET(opt, 'UID_WRAPPER') or
 110         not CONFIG_SET(opt, 'SOCKET_WRAPPER')):
 111         print("ERROR: You must use --enable-selftest to enable selftest")
 112         sys.exit(1)
 113
 114     os.environ['SAMBA_SELFTEST'] = '1'
 115
 116     env.TESTS  = Options.options.TESTS
 117
 118     env.SUBUNIT_FORMATTER = os.getenv('SUBUNIT_FORMATTER')
 119     if not env.SUBUNIT_FORMATTER:
 120         if Options.options.PERF_TEST:
 121             env.SUBUNIT_FORMATTER = '${PYTHON} -u ${srcdir}/selftest/format-subunit-json --prefix=${SELFTEST_PREFIX}'
 122         else:
 123             env.SUBUNIT_FORMATTER = '${PYTHON} -u ${srcdir}/selftest/format-subunit --prefix=${SELFTEST_PREFIX} --immediate'
 124     env.FILTER_XFAIL = ('${PYTHON} -u ${srcdir}/selftest/filter-subunit '
 125                         '--expected-failures=${srcdir}/selftest/knownfail '
 126                         '--expected-failures=${srcdir}/selftest/knownfail.d '
 127                         '--flapping=${srcdir}/selftest/flapping '
 128                         '--flapping=${srcdir}/selftest/flapping.d')
 129
 130     if Options.options.FAIL_IMMEDIATELY:
 131         env.FILTER_XFAIL += ' --fail-immediately'
 132
 133     env.FORMAT_TEST_OUTPUT = '${SUBUNIT_FORMATTER}'
 134
 135     # clean any previous temporary files
 136     os.system("rm -rf %s/tmp" % env.SELFTEST_PREFIX);
 137
 138     # put all command line options in the environment as TESTENV_*=*
 139     for o in dir(Options.options):
 140         if o[0:1] != '_':
 141             val = getattr(Options.options, o, '')
 142             if not issubclass(type(val), types.FunctionType) \
 143                     and not issubclass(type(val), types.MethodType):
 144                 os.environ['TESTENV_%s' % o.upper()] = str(getattr(Options.options, o, ''))
 145
 146     env.OPTIONS = ''
 147     if not Options.options.SLOWTEST:
 148         env.OPTIONS += ' --exclude=${srcdir}/selftest/slow'
 149     if Options.options.QUICKTEST:
 150         env.OPTIONS += ' --quick --include=${srcdir}/selftest/quick'
 151     if Options.options.LOAD_LIST:
 152         env.OPTIONS += ' --load-list=%s' % Options.options.LOAD_LIST
 153     if Options.options.TESTENV:
 154         env.OPTIONS += ' --testenv'
 155     if Options.options.SOCKET_WRAPPER_PCAP:
 156         env.OPTIONS += ' --socket-wrapper-pcap'
 157     if Options.options.SOCKET_WRAPPER_KEEP_PCAP:
 158         env.OPTIONS += ' --socket-wrapper-keep-pcap'
 159     if Options.options.RANDOM_ORDER:
 160         env.OPTIONS += ' --random-order'
 161     if Options.options.PERF_TEST:
 162         env.FILTER_OPTIONS = ('${PYTHON} -u ${srcdir}/selftest/filter-subunit '
 163                               '--perf-test-output')
 164     elif os.environ.get('RUN_FROM_BUILD_FARM') is not None:
 165         env.FILTER_OPTIONS = '${FILTER_XFAIL} --strip-passed-output'
 166     else:
 167         env.FILTER_OPTIONS = '${FILTER_XFAIL}'
 168
 169     if Options.options.VALGRIND:
 170         os.environ['VALGRIND'] = 'valgrind -q --num-callers=30'
 171         if Options.options.VALGRINDLOG is not None:
 172             os.environ['VALGRIND'] += ' --log-file=%s' % Options.options.VALGRINDLOG
 173
 174     server_wrapper=''
 175
 176     if Options.options.VALGRIND_SERVER:
 177         server_wrapper = '${srcdir}/selftest/valgrind_run _DUMMY=X'
 178     elif Options.options.GDBTEST:
 179         server_wrapper = '${srcdir}/selftest/gdb_run _DUMMY=X'
 180
 181     if Options.options.SCREEN:
 182         server_wrapper = '${srcdir}/selftest/in_screen %s' % server_wrapper
 183         os.environ['TERMINAL'] = EXPAND_VARIABLES(opt, '${srcdir}/selftest/in_screen')
 184     elif server_wrapper != '':
 185         server_wrapper = 'xterm -n server -l -e %s' % server_wrapper
 186
 187     if server_wrapper != '':
 188         os.environ['SAMBA_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
 189         os.environ['NMBD_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
 190         os.environ['WINBINDD_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
 191         os.environ['SMBD_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
 192
 193     # this is needed for systems without rpath, or with rpath disabled
 194     ADD_LD_LIBRARY_PATH('bin/shared')
 195     ADD_LD_LIBRARY_PATH('bin/shared/private')
 196
 197     # if we are using a system version of ldb then we need to tell it to
 198     # load modules from our modules path
 199     if env.USING_SYSTEM_LDB:
 200         os.environ['LDB_MODULES_PATH'] = os.path.abspath(os.path.join(env.cwd, 'bin/modules/ldb'))
 201
 202     # tell build system where to find config.h
 203     os.environ['CONFIG_H'] = 'bin/default/include/config.h'
 204
 205     # tell the test system where perl is
 206     os.environ['PERL'] = env.PERL
 207
 208     st_done = os.path.join(env.SELFTEST_PREFIX, 'st_done')
 209     if os.path.exists(st_done):
 210         os.unlink(st_done)
 211
 212     if not os.path.isdir(env.SELFTEST_PREFIX):
 213         os.makedirs(env.SELFTEST_PREFIX, int('755', 8))
 214
 215     if Options.options.TEST_LIST:
 216         env.TESTLISTS = '--testlist=%r' % Options.options.TEST_LIST
 217     elif Options.options.PERF_TEST:
 218         env.TESTLISTS = '--testlist="${PYTHON} ${srcdir}/selftest/perf_tests.py|" '
 219     elif CONFIG_SET(opt, 'EXTRA_PYTHON'):
 220         env.TESTLISTS = ('--testlist="EXTRA_PYTHON=${EXTRA_PYTHON} ${PYTHON} ${srcdir}/selftest/tests.py|" ' +
 221                          '--testlist="EXTRA_PYTHON=${EXTRA_PYTHON} ${PYTHON} ${srcdir}/source3/selftest/tests.py|" ' +
 222                          '--testlist="EXTRA_PYTHON=${EXTRA_PYTHON} ${PYTHON} ${srcdir}/source4/selftest/tests.py|"')
 223     else:
 224         env.TESTLISTS = ('--testlist="${PYTHON} ${srcdir}/selftest/tests.py|" ' +
 225                          '--testlist="${PYTHON} ${srcdir}/source3/selftest/tests.py|" ' +
 226                          '--testlist="${PYTHON} ${srcdir}/source4/selftest/tests.py|"')
 227
 228     if CONFIG_SET(opt, 'AD_DC_BUILD_IS_ENABLED'):
 229         env.SELFTEST_TARGET = "samba"
 230     else:
 231         env.SELFTEST_TARGET = "samba3"
 232
 233     env.OPTIONS += " --nss_wrapper_so_path=" + CONFIG_GET(opt, 'LIBNSS_WRAPPER_SO_PATH')
 234     env.OPTIONS += " --resolv_wrapper_so_path=" + CONFIG_GET(opt, 'LIBRESOLV_WRAPPER_SO_PATH')
 235     env.OPTIONS += " --socket_wrapper_so_path=" + CONFIG_GET(opt, 'LIBSOCKET_WRAPPER_SO_PATH')
 236     env.OPTIONS += " --uid_wrapper_so_path=" + CONFIG_GET(opt, 'LIBUID_WRAPPER_SO_PATH')
 237
 238     #if unversioned_sys_platform in ('freebsd', 'netbsd', 'openbsd', 'sunos'):
 239     #    env.OPTIONS += " --use-dns-faking"
 240
 241     # FIXME REMOVE ME!
 242     env.OPTIONS += " --use-dns-faking"
 243
 244     if CONFIG_GET(opt, 'USING_SYSTEM_KRB5') and CONFIG_GET(opt, 'MIT_KDC_PATH'):
 245         env.OPTIONS += " --mitkrb5 --exclude=${srcdir}/selftest/skip_mit_kdc"
 246
 247     if not CONFIG_GET(opt, 'HAVE_GSS_KRB5_CRED_NO_CI_FLAGS_X'):
 248         # older MIT krb5 libraries (< 1.14) don't have
 249         # GSS_KRB5_CRED_NO_CI_FLAGS_X
 250         env.OPTIONS += " --exclude=${srcdir}/selftest/skip.no-GSS_KRB5_CRED_NO_CI_FLAGS_X"
 251
 252     if env.ADDRESS_SANITIZER:
 253         # We try to find the correct libasan automatically
 254         libasan = Utils.cmd_output('ldd bin/texpect | grep libasan| cut -f 3 -d \ ',
 255                                    silent=True).strip()
 256
 257         # Have the selftest.pl LD_PRELOAD libasan in the right spot
 258         env.OPTIONS += " --asan_so_path=" + libasan
 259
 260     subunit_cache = None
 261     # We use the full path rather than relative path to avoid problems on some platforms (ie. solaris 8).
 262     env.CORE_COMMAND = '${PERL} ${srcdir}/selftest/selftest.pl --target=${SELFTEST_TARGET} --prefix=${SELFTEST_PREFIX} --srcdir=${srcdir} --exclude=${srcdir}/selftest/skip ${TESTLISTS} ${OPTIONS} ${TESTS}'
 263
 264     if env.ADDRESS_SANITIZER:
 265         # For now we cannot run with leak detection
 266         no_leak_check = "ASAN_OPTIONS=detect_leaks=0"
 267         env.CORE_COMMAND = no_leak_check + " " + env.CORE_COMMAND
 268
 269         # We need to have the subunit filter and formatter preload
 270         # libasan otherwise the tests fail at startup.
 271         #
 272         # Also, we do not care about leaks in python
 273
 274         asan_envs = no_leak_check + " LD_PRELOAD=" + libasan + ' '
 275         env.FILTER_OPTIONS = asan_envs + env.FILTER_OPTIONS
 276         env.SUBUNIT_FORMATTER = asan_envs + env.SUBUNIT_FORMATTER
 277
 278     if Options.options.LIST:
 279         cmd = '${CORE_COMMAND} --list'
 280     else:
 281         env.OPTIONS += ' --socket-wrapper'
 282         cmd = '(${CORE_COMMAND} && touch ${SELFTEST_PREFIX}/st_done) | ${FILTER_OPTIONS}'
 283         if (os.environ.get('RUN_FROM_BUILD_FARM') is None and
 284             not Options.options.FILTERED_SUBUNIT):
 285             subunit_cache = os.path.join(env.SELFTEST_PREFIX, "subunit")
 286             cmd += ' | tee %s | ${FORMAT_TEST_OUTPUT}' % subunit_cache
 287         else:
 288             cmd += ' | ${FILTER_OPTIONS}'
 289
 290     runcmd = EXPAND_VARIABLES(opt, cmd)
 291
 292     print("test: running %s" % runcmd)
 293     ret = RUN_COMMAND(cmd, env=env)
 294
 295     if (os.path.exists(".testrepository") and
 296         not Options.options.LIST and
 297         not Options.options.LOAD_LIST and
 298         subunit_cache is not None):
 299         testrcmd = 'testr load -q < %s > /dev/null' % subunit_cache
 300         runcmd = EXPAND_VARIABLES(opt, testrcmd)
 301         RUN_COMMAND(runcmd, env=env)
 302
 303     if subunit_cache is not None:
 304         nb = Options.options.NB_SLOWEST
 305         cmd = "./script/show_testsuite_time %s %d" % (subunit_cache, nb)
 306         runcmd = EXPAND_VARIABLES(opt, cmd)
 307         RUN_COMMAND(runcmd, env=env)
 308
 309     if ret != 0:
 310         print("ERROR: test failed with exit code %d" % ret)
 311         sys.exit(ret)
 312
 313     if not Options.options.LIST and not os.path.exists(st_done):
 314         print("ERROR: test command failed to complete")
 315         sys.exit(1)
 316
 317
 318 ########################################################################
 319 # main test entry point
 320 def cmd_test(opt):
 321     '''Run the test suite (see test options below)'''
 322
 323     # if running all tests, then force a symbol check
 324     env = LOAD_ENVIRONMENT()
 325     CHECK_MAKEFLAGS(env)
 326     Scripting.commands.append('build')
 327     Scripting.commands.append('testonly')