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 from waflib import Options, Utils
   9
  10 from samba_utils import (
  11     ADD_LD_LIBRARY_PATH,
  12     CHECK_MAKEFLAGS,
  13     EXPAND_VARIABLES,
  14     LOAD_ENVIRONMENT,
  15     RUN_COMMAND,
  16 )
  17 from samba_autoconf import CONFIG_GET, CONFIG_SET
  18 import types
  19
  20 DEFAULT_SELFTEST_PREFIX="./st"
  21
  22 def options(opt):
  23
  24     opt.add_option('--enable-selftest',
  25                    help=("enable options necessary for selftest (default=no)"),
  26                    action="store_true", dest='enable_selftest', 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     gr.add_option('--no-subunit-filter',
  94                   help=("no (xfail) subunit filtering"),
  95                   action="store_true", dest='NO_SUBUNIT_FILTER', default=False)
  96
  97
  98 def configure(conf):
  99     conf.env.SELFTEST_PREFIX = Options.options.SELFTEST_PREFIX
 100     if Options.options.enable_selftest or Options.options.developer:
 101         conf.DEFINE('ENABLE_SELFTEST', 1)
 102
 103
 104 def cmd_testonly(opt):
 105     '''run tests without doing a build first'''
 106     env = LOAD_ENVIRONMENT()
 107     opt.env = env
 108
 109     if Options.options.SELFTEST_PREFIX != DEFAULT_SELFTEST_PREFIX:
 110         env.SELFTEST_PREFIX = Options.options.SELFTEST_PREFIX
 111
 112     if (not CONFIG_SET(opt, 'NSS_WRAPPER') or
 113         not CONFIG_SET(opt, 'UID_WRAPPER') or
 114         not CONFIG_SET(opt, 'SOCKET_WRAPPER')):
 115         print("ERROR: You must use --enable-selftest to enable selftest")
 116         sys.exit(1)
 117
 118     os.environ['SAMBA_SELFTEST'] = '1'
 119
 120     env.TESTS  = Options.options.TESTS
 121
 122     env.SUBUNIT_FORMATTER = os.getenv('SUBUNIT_FORMATTER')
 123
 124     # Lots of test scripts need to run with the correct version
 125     # of python. With the correct shebang the script should run with the
 126     # correct version, the problem is that not all scripts are part
 127     # of the installation, some scripts are part of the source code,
 128     # and the shebang is not dynamically generated as yet.
 129     # It is safer if we are somewhat version neutral at the moment and
 130     # ignore the shebang and always run scripts from the test environment
 131     # with the python version (determined by PYTHON env variable) If this
 132     # env variable isn't set then set it according to the python version
 133     # that is running the tests
 134     if not os.getenv('PYTHON', None):
 135         from sys import executable as exe
 136         os.environ['PYTHON'] = os.path.basename(exe)
 137
 138     if not env.SUBUNIT_FORMATTER:
 139         if Options.options.PERF_TEST:
 140             env.SUBUNIT_FORMATTER = '${PYTHON} -u ${srcdir}/selftest/format-subunit-json --prefix=${SELFTEST_PREFIX}'
 141         else:
 142             env.SUBUNIT_FORMATTER = '${PYTHON} -u ${srcdir}/selftest/format-subunit --prefix=${SELFTEST_PREFIX} --immediate'
 143     env.FILTER_XFAIL = ('${PYTHON} -u ${srcdir}/selftest/filter-subunit '
 144                         '--expected-failures=${srcdir}/selftest/knownfail '
 145                         '--expected-failures=${srcdir}/selftest/knownfail.d '
 146                         '--flapping=${srcdir}/selftest/flapping '
 147                         '--flapping=${srcdir}/selftest/flapping.d')
 148
 149     if Options.options.FAIL_IMMEDIATELY:
 150         env.FILTER_XFAIL += ' --fail-immediately'
 151
 152     env.FORMAT_TEST_OUTPUT = '${SUBUNIT_FORMATTER}'
 153
 154     # clean any previous temporary files
 155     os.system("rm -rf %s/tmp" % env.SELFTEST_PREFIX);
 156
 157     # put all command line options in the environment as TESTENV_*=*
 158     for o in dir(Options.options):
 159         if o[0:1] != '_':
 160             val = getattr(Options.options, o, '')
 161             if not issubclass(type(val), types.FunctionType) \
 162                     and not issubclass(type(val), types.MethodType):
 163                 os.environ['TESTENV_%s' % o.upper()] = str(getattr(Options.options, o, ''))
 164
 165     env.OPTIONS = ''
 166     if not Options.options.SLOWTEST:
 167         env.OPTIONS += ' --exclude=${srcdir}/selftest/slow'
 168     if Options.options.QUICKTEST:
 169         env.OPTIONS += ' --quick --include=${srcdir}/selftest/quick'
 170     if Options.options.LOAD_LIST:
 171         env.OPTIONS += ' --load-list=%s' % Options.options.LOAD_LIST
 172     if Options.options.TESTENV:
 173         env.OPTIONS += ' --testenv'
 174     if Options.options.SOCKET_WRAPPER_PCAP:
 175         env.OPTIONS += ' --socket-wrapper-pcap'
 176     if Options.options.SOCKET_WRAPPER_KEEP_PCAP:
 177         env.OPTIONS += ' --socket-wrapper-keep-pcap'
 178     if Options.options.RANDOM_ORDER:
 179         env.OPTIONS += ' --random-order'
 180     if Options.options.PERF_TEST:
 181         env.FILTER_OPTIONS = ('${PYTHON} -u ${srcdir}/selftest/filter-subunit '
 182                               '--perf-test-output')
 183     else:
 184         env.FILTER_OPTIONS = '${FILTER_XFAIL}'
 185
 186     if Options.options.VALGRIND:
 187         os.environ['VALGRIND'] = 'valgrind -q --num-callers=30'
 188         if Options.options.VALGRINDLOG is not None:
 189             os.environ['VALGRIND'] += ' --log-file=%s' % Options.options.VALGRINDLOG
 190
 191     server_wrapper=''
 192
 193     if Options.options.VALGRIND_SERVER:
 194         server_wrapper = '${srcdir}/selftest/valgrind_run _DUMMY=X'
 195     elif Options.options.GDBTEST:
 196         server_wrapper = '${srcdir}/selftest/gdb_run _DUMMY=X'
 197
 198     if Options.options.SCREEN:
 199         server_wrapper = '${srcdir}/selftest/in_screen %s' % server_wrapper
 200         os.environ['TERMINAL'] = EXPAND_VARIABLES(opt, '${srcdir}/selftest/in_screen')
 201     elif server_wrapper != '':
 202         server_wrapper = 'xterm -n server -l -e %s' % server_wrapper
 203
 204     if server_wrapper != '':
 205         os.environ['SAMBA_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
 206         os.environ['NMBD_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
 207         os.environ['WINBINDD_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
 208         os.environ['SMBD_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
 209         os.environ['SAMBA_DCERPCD_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
 210
 211     # this is needed for systems without rpath, or with rpath disabled
 212     ADD_LD_LIBRARY_PATH('bin/shared')
 213     ADD_LD_LIBRARY_PATH('bin/shared/private')
 214
 215     # if we are using a system version of ldb then we need to tell it to
 216     # load modules from our modules path
 217     if env.USING_SYSTEM_LDB:
 218         os.environ['LDB_MODULES_PATH'] = os.path.abspath(
 219                 os.path.join(*(env.cwd + ['bin/modules/ldb'])))
 220
 221     # tell build system where to find config.h
 222     os.environ['CONFIG_H'] = 'bin/default/include/config.h'
 223
 224     # tell the test system where perl is
 225     if isinstance(env.PERL, list):
 226         perl = ' '.join(env.PERL)
 227     else:
 228         perl = env.PERL
 229     os.environ['PERL'] = perl
 230
 231     st_done = os.path.join(env.SELFTEST_PREFIX, 'st_done')
 232     if os.path.exists(st_done):
 233         os.unlink(st_done)
 234
 235     if not os.path.isdir(env.SELFTEST_PREFIX):
 236         os.makedirs(env.SELFTEST_PREFIX, int('755', 8))
 237
 238     if Options.options.TEST_LIST:
 239         env.TESTLISTS = '--testlist=%r' % Options.options.TEST_LIST
 240     elif Options.options.PERF_TEST:
 241         env.TESTLISTS = '--testlist="${PYTHON} ${srcdir}/selftest/perf_tests.py|" '
 242     else:
 243         env.TESTLISTS = ('--testlist="${PYTHON} ${srcdir}/selftest/tests.py|" ' +
 244                          '--testlist="${PYTHON} ${srcdir}/source3/selftest/tests.py|" ' +
 245                          '--testlist="${PYTHON} ${srcdir}/source4/selftest/tests.py|"')
 246
 247     if CONFIG_SET(opt, 'AD_DC_BUILD_IS_ENABLED'):
 248         env.SELFTEST_TARGET = "samba"
 249     else:
 250         env.SELFTEST_TARGET = "samba3"
 251
 252     env.OPTIONS += " --nss_wrapper_so_path=" + CONFIG_GET(opt, 'LIBNSS_WRAPPER_SO_PATH')
 253     env.OPTIONS += " --resolv_wrapper_so_path=" + CONFIG_GET(opt, 'LIBRESOLV_WRAPPER_SO_PATH')
 254     env.OPTIONS += " --uid_wrapper_so_path=" + CONFIG_GET(opt, 'LIBUID_WRAPPER_SO_PATH')
 255
 256     # selftest can optionally use kernel namespaces instead of socket-wrapper
 257     if os.environ.get('USE_NAMESPACES') is None:
 258         env.OPTIONS += " --socket_wrapper_so_path=" + CONFIG_GET(opt, 'LIBSOCKET_WRAPPER_SO_PATH')
 259
 260     if not CONFIG_SET(opt, 'HAVE_RESOLV_CONF_SUPPORT'):
 261         env.OPTIONS += " --use-dns-faking"
 262
 263     if CONFIG_GET(opt, 'USING_SYSTEM_KRB5'):
 264         env.OPTIONS += " --mitkrb5"
 265
 266     if CONFIG_GET(opt, 'USING_SYSTEM_KRB5') and CONFIG_GET(opt, 'MIT_KDC_PATH'):
 267         env.OPTIONS += " --exclude=${srcdir}/selftest/skip_mit_kdc"
 268         env.FILTER_XFAIL += " --expected-failures=${srcdir}/selftest/"\
 269                             "knownfail_mit_kdc"
 270
 271         env.FILTER_XFAIL += ' --expected-failures=${srcdir}/selftest/knownfail_mit_kdc_1_20'
 272     else:
 273         env.FILTER_XFAIL += " --expected-failures=${srcdir}/selftest/"\
 274                             "knownfail_heimdal_kdc"
 275
 276     if CONFIG_GET(opt, 'SIZEOF_VOID_P') == 4:
 277         env.FILTER_XFAIL += " --expected-failures=${srcdir}/selftest/knownfail-32bit"
 278         env.OPTIONS += " --default-ldb-backend=tdb --exclude=${srcdir}/selftest/skip-32bit"
 279
 280     if not CONFIG_GET(opt, 'HAVE_GSS_KRB5_CRED_NO_CI_FLAGS_X'):
 281         # older MIT krb5 libraries (< 1.14) don't have
 282         # GSS_KRB5_CRED_NO_CI_FLAGS_X
 283         env.OPTIONS += " --exclude=${srcdir}/selftest/skip.no-GSS_KRB5_CRED_NO_CI_FLAGS_X"
 284
 285     if os.environ.get('DISABLE_OPATH'):
 286         env.OPTIONS += " --exclude=${srcdir}/selftest/skip.opath-required"
 287
 288     libasan = None
 289     if env.ADDRESS_SANITIZER:
 290         # We try to find the correct libasan automatically
 291         libasan = Utils.cmd_output(
 292             r'ldd bin/texpect | grep libasan| cut -f 3 -d \ ',
 293             silent=True).strip()
 294         libasan = libasan.decode('utf8')
 295
 296         # Have the selftest.pl LD_PRELOAD libasan in the right spot
 297         env.OPTIONS += " --asan_so_path=" + libasan
 298
 299         if CONFIG_SET(opt, 'HAVE_CRYPT_R'):
 300             # We try to find the correct libcrypt automatically
 301             libcrypt = Utils.cmd_output(
 302                 'ldd bin/modules/ldb/password_hash.so | awk \'/libcrypt.so/ { print $3 }\'',
 303                 silent=True).strip()
 304             libcrypt = libcrypt.decode('utf8')
 305             env.OPTIONS += " --crypt_so_path=" + libcrypt
 306
 307     subunit_cache = None
 308     # We use the full path rather than relative path to avoid problems on some platforms (ie. solaris 8).
 309     env.CORE_COMMAND = '${PERL} ${srcdir}/selftest/selftest.pl --target=${SELFTEST_TARGET} --prefix=${SELFTEST_PREFIX} --srcdir=${srcdir} --exclude=${srcdir}/selftest/skip ${TESTLISTS} ${OPTIONS} ${TESTS}'
 310
 311     # If using namespaces (rather than socket-wrapper), run the selftest script
 312     # in its own network namespace (by doing an 'unshare'). (To create a new
 313     # namespace as a non-root user, we have to also unshare the current user
 314     # namespace, and remap ourself as root in the namespace created)
 315     if os.environ.get('USE_NAMESPACES') is not None:
 316         env.CORE_COMMAND = 'unshare --net --user --map-root-user ' + env.CORE_COMMAND
 317
 318     if env.ADDRESS_SANITIZER and libasan:
 319         # For now we cannot run with leak and odr detection
 320         asan_options = "ASAN_OPTIONS=detect_leaks=0"
 321         asan_options += ":detect_odr_violation=0"
 322         # uncomment if you need asan logs
 323         # asan_options += ":verbosity=111"
 324         asan_options += ":suppressions=${srcdir}/selftest/sanitizer/asan.supp"
 325         asan_options += " "
 326
 327         # And we need to disable RTLD_DEEPBIND in ldb and socket wrapper
 328         no_leak_check = "LDB_MODULES_DISABLE_DEEPBIND=1 "
 329         no_leak_check += "SOCKET_WRAPPER_DISABLE_DEEP_BIND=1"
 330         no_leak_check += " "
 331         env.CORE_COMMAND = asan_options + no_leak_check + env.CORE_COMMAND
 332
 333         # We need to have the subunit filter and formatter preload
 334         # libasan otherwise the tests fail at startup.
 335         #
 336         # Also, we do not care about leaks in python
 337
 338         asan_envs = (asan_options + no_leak_check + "LD_PRELOAD=" + libasan
 339                      + ' ')
 340         env.FILTER_OPTIONS = asan_envs + env.FILTER_OPTIONS
 341         env.SUBUNIT_FORMATTER = asan_envs + env.SUBUNIT_FORMATTER
 342
 343     if env.UNDEFINED_SANITIZER:
 344         # print a stack trace with the error.
 345         print_stack_trace = "UBSAN_OPTIONS=print_stacktrace=1"
 346         print_stack_trace += ",suppressions=${srcdir}/selftest/ubsan.supp"
 347         env.CORE_COMMAND = print_stack_trace + " " + env.CORE_COMMAND
 348
 349     if Options.options.LIST:
 350         cmd = '${CORE_COMMAND} --list'
 351     else:
 352         env.OPTIONS += ' --socket-wrapper'
 353         cmd = '(${CORE_COMMAND} && touch ${SELFTEST_PREFIX}/st_done) | ${FILTER_OPTIONS}'
 354
 355         if Options.options.NO_SUBUNIT_FILTER:
 356             # Skip subunit filtering (i.e. because python is disabled).
 357             # Use --one to bail out upon any failure
 358             cmd = '(${CORE_COMMAND} --one && touch ${SELFTEST_PREFIX}/st_done)'
 359         elif not Options.options.FILTERED_SUBUNIT:
 360             subunit_cache = os.path.join(env.SELFTEST_PREFIX, "subunit")
 361             cmd += ' | tee %s | ${FORMAT_TEST_OUTPUT}' % subunit_cache
 362         else:
 363             cmd += ' | ${FILTER_OPTIONS}'
 364
 365     runcmd = EXPAND_VARIABLES(opt, cmd)
 366
 367     print("test: running %s" % runcmd)
 368     ret = RUN_COMMAND(cmd, env=env)
 369
 370     if (os.path.exists(".testrepository") and
 371         not Options.options.LIST and
 372         not Options.options.LOAD_LIST and
 373         subunit_cache is not None):
 374         testrcmd = 'testr load -q < %s > /dev/null' % subunit_cache
 375         runcmd = EXPAND_VARIABLES(opt, testrcmd)
 376         RUN_COMMAND(runcmd, env=env)
 377
 378     if subunit_cache is not None:
 379         nb = Options.options.NB_SLOWEST
 380         cmd = "./script/show_testsuite_time %s %d" % (subunit_cache, nb)
 381         runcmd = EXPAND_VARIABLES(opt, cmd)
 382         RUN_COMMAND(runcmd, env=env)
 383
 384     if ret != 0:
 385         print("ERROR: test failed with exit code %d" % ret)
 386         sys.exit(ret)
 387
 388     if not Options.options.LIST and not os.path.exists(st_done):
 389         print("ERROR: test command failed to complete")
 390         sys.exit(1)
 391
 392
 393 ########################################################################
 394 # main test entry point
 395 def cmd_test(opt):
 396     '''Run the test suite (see test options below)'''
 397
 398     # if running all tests, then force a symbol check
 399     env = LOAD_ENVIRONMENT()
 400     CHECK_MAKEFLAGS(env)
 401     Options.commands.append('build')
 402     Options.commands.append('testonly')