selftest/wscript

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