2 # vim: expandtab ft=python
6 import Scripting, os, Options, Utils, Environment, optparse, sys
7 from samba_utils import *
8 from samba_autoconf import *
11 DEFAULT_SELFTEST_PREFIX="./st"
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)
27 opt.ADD_COMMAND('test', cmd_test)
28 opt.ADD_COMMAND('testonly', cmd_testonly)
30 gr = opt.add_option_group('test options')
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='',
86 help=("use tests listed here, not defaults "
87 "(--test-list='FOO|' will execute FOO; "
88 "--test-list='FOO' will read it)"))
91 conf.env.SELFTEST_PREFIX = Options.options.SELFTEST_PREFIX
92 conf.env.enable_coverage = Options.options.enable_coverage
93 if conf.env.enable_coverage:
94 conf.ADD_LDFLAGS('-lgcov', testflags=True)
95 conf.ADD_CFLAGS('--coverage')
97 if Options.options.enable_selftest or Options.options.developer:
98 conf.DEFINE('ENABLE_SELFTEST', 1)
101 def cmd_testonly(opt):
102 '''run tests without doing a build first'''
103 env = LOAD_ENVIRONMENT()
106 if Options.options.SELFTEST_PREFIX != DEFAULT_SELFTEST_PREFIX:
107 env.SELFTEST_PREFIX = Options.options.SELFTEST_PREFIX
109 if (not CONFIG_SET(opt, 'NSS_WRAPPER') or
110 not CONFIG_SET(opt, 'UID_WRAPPER') or
111 not CONFIG_SET(opt, 'SOCKET_WRAPPER')):
112 print("ERROR: You must use --enable-selftest to enable selftest")
115 os.environ['SAMBA_SELFTEST'] = '1'
117 env.TESTS = Options.options.TESTS
119 env.SUBUNIT_FORMATTER = os.getenv('SUBUNIT_FORMATTER')
120 if not env.SUBUNIT_FORMATTER:
121 env.SUBUNIT_FORMATTER = '${PYTHON} -u ${srcdir}/selftest/format-subunit --prefix=${SELFTEST_PREFIX} --immediate'
122 env.FILTER_XFAIL = '${PYTHON} -u ${srcdir}/selftest/filter-subunit --expected-failures=${srcdir}/selftest/knownfail --flapping=${srcdir}/selftest/flapping'
124 if Options.options.FAIL_IMMEDIATELY:
125 env.FILTER_XFAIL += ' --fail-immediately'
127 env.FORMAT_TEST_OUTPUT = '${SUBUNIT_FORMATTER}'
129 # clean any previous temporary files
130 os.system("rm -rf %s/tmp" % env.SELFTEST_PREFIX);
132 # put all command line options in the environment as TESTENV_*=*
133 for o in dir(Options.options):
135 val = getattr(Options.options, o, '')
136 if not issubclass(type(val), types.FunctionType) \
137 and not issubclass(type(val), types.MethodType):
138 os.environ['TESTENV_%s' % o.upper()] = str(getattr(Options.options, o, ''))
141 if not Options.options.SLOWTEST:
142 env.OPTIONS += ' --exclude=${srcdir}/selftest/slow'
143 if Options.options.QUICKTEST:
144 env.OPTIONS += ' --quick --include=${srcdir}/selftest/quick'
145 if Options.options.LOAD_LIST:
146 env.OPTIONS += ' --load-list=%s' % Options.options.LOAD_LIST
147 if Options.options.TESTENV:
148 env.OPTIONS += ' --testenv'
149 if Options.options.SOCKET_WRAPPER_PCAP:
150 env.OPTIONS += ' --socket-wrapper-pcap'
151 if Options.options.SOCKET_WRAPPER_KEEP_PCAP:
152 env.OPTIONS += ' --socket-wrapper-keep-pcap'
153 if Options.options.RANDOM_ORDER:
154 env.OPTIONS += ' --random-order'
155 if Options.options.PERF_TEST:
156 env.FILTER_OPTIONS = ('${PYTHON} -u ${srcdir}/selftest/filter-subunit '
157 '--perf-test-output')
158 elif os.environ.get('RUN_FROM_BUILD_FARM') is not None:
159 env.FILTER_OPTIONS = '${FILTER_XFAIL} --strip-passed-output'
161 env.FILTER_OPTIONS = '${FILTER_XFAIL}'
163 if Options.options.VALGRIND:
164 os.environ['VALGRIND'] = 'valgrind -q --num-callers=30'
165 if Options.options.VALGRINDLOG is not None:
166 os.environ['VALGRIND'] += ' --log-file=%s' % Options.options.VALGRINDLOG
170 if Options.options.VALGRIND_SERVER:
171 server_wrapper = '${srcdir}/selftest/valgrind_run _DUMMY=X'
172 elif Options.options.GDBTEST:
173 server_wrapper = '${srcdir}/selftest/gdb_run _DUMMY=X'
175 if Options.options.SCREEN:
176 server_wrapper = '${srcdir}/selftest/in_screen %s' % server_wrapper
177 os.environ['TERMINAL'] = EXPAND_VARIABLES(opt, '${srcdir}/selftest/in_screen')
178 elif server_wrapper != '':
179 server_wrapper = 'xterm -n server -l -e %s' % server_wrapper
181 if server_wrapper != '':
182 os.environ['SAMBA_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
183 os.environ['NMBD_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
184 os.environ['WINBINDD_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
185 os.environ['SMBD_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
187 # this is needed for systems without rpath, or with rpath disabled
188 ADD_LD_LIBRARY_PATH('bin/shared')
189 ADD_LD_LIBRARY_PATH('bin/shared/private')
191 # if we are using a system version of ldb then we need to tell it to
192 # load modules from our modules path
193 if env.USING_SYSTEM_LDB:
194 os.environ['LDB_MODULES_PATH'] = os.path.abspath(os.path.join(env.cwd, 'bin/modules/ldb'))
196 # tell build system where to find config.h
197 os.environ['CONFIG_H'] = 'bin/default/include/config.h'
199 st_done = os.path.join(env.SELFTEST_PREFIX, 'st_done')
200 if os.path.exists(st_done):
203 if not os.path.isdir(env.SELFTEST_PREFIX):
204 os.makedirs(env.SELFTEST_PREFIX, int('755', 8))
206 if Options.options.TEST_LIST:
207 env.TESTLISTS = '--testlist=%r' % Options.options.TEST_LIST
208 elif Options.options.PERF_TEST:
209 env.TESTLISTS = '--testlist="${PYTHON} ${srcdir}/selftest/perf_tests.py|" '
211 env.TESTLISTS = ('--testlist="${PYTHON} ${srcdir}/selftest/tests.py|" ' +
212 '--testlist="${PYTHON} ${srcdir}/source3/selftest/tests.py|" ' +
213 '--testlist="${PYTHON} ${srcdir}/source4/selftest/tests.py|"')
215 if CONFIG_SET(opt, 'AD_DC_BUILD_IS_ENABLED'):
216 env.SELFTEST_TARGET = "samba"
218 env.SELFTEST_TARGET = "samba3"
220 env.OPTIONS += " --nss_wrapper_so_path=" + CONFIG_GET(opt, 'LIBNSS_WRAPPER_SO_PATH')
221 env.OPTIONS += " --resolv_wrapper_so_path=" + CONFIG_GET(opt, 'LIBRESOLV_WRAPPER_SO_PATH')
222 env.OPTIONS += " --socket_wrapper_so_path=" + CONFIG_GET(opt, 'LIBSOCKET_WRAPPER_SO_PATH')
223 env.OPTIONS += " --uid_wrapper_so_path=" + CONFIG_GET(opt, 'LIBUID_WRAPPER_SO_PATH')
225 #if unversioned_sys_platform in ('freebsd', 'netbsd', 'openbsd', 'sunos'):
226 # env.OPTIONS += " --use-dns-faking"
229 env.OPTIONS += " --use-dns-faking"
233 # We use the full path rather than relative path to avoid problems on some platforms (ie. solaris 8).
234 env.CORE_COMMAND = '${PERL} ${srcdir}/selftest/selftest.pl --target=${SELFTEST_TARGET} --prefix=${SELFTEST_PREFIX} --srcdir=${srcdir} --exclude=${srcdir}/selftest/skip ${TESTLISTS} ${OPTIONS} ${TESTS}'
235 if Options.options.LIST:
236 cmd = '${CORE_COMMAND} --list'
238 env.OPTIONS += ' --socket-wrapper'
239 cmd = '(${CORE_COMMAND} && touch ${SELFTEST_PREFIX}/st_done) | ${FILTER_OPTIONS}'
240 if (os.environ.get('RUN_FROM_BUILD_FARM') is None and
241 not Options.options.FILTERED_SUBUNIT):
242 subunit_cache = os.path.join(env.SELFTEST_PREFIX, "subunit")
243 cmd += ' | tee %s | ${FORMAT_TEST_OUTPUT}' % subunit_cache
245 cmd += ' | ${FILTER_OPTIONS}'
246 runcmd = EXPAND_VARIABLES(opt, cmd)
248 print("test: running %s" % runcmd)
249 ret = RUN_COMMAND(cmd, env=env)
251 if (os.path.exists(".testrepository") and
252 not Options.options.LIST and
253 not Options.options.LOAD_LIST and
254 subunit_cache is not None):
255 testrcmd = 'testr load -q < %s > /dev/null' % subunit_cache
256 runcmd = EXPAND_VARIABLES(opt, testrcmd)
257 RUN_COMMAND(runcmd, env=env)
259 if subunit_cache is not None:
260 nb = Options.options.NB_SLOWEST
261 cmd = "./script/show_testsuite_time %s %d" % (subunit_cache, nb)
262 runcmd = EXPAND_VARIABLES(opt, cmd)
263 RUN_COMMAND(runcmd, env=env)
266 print("ERROR: test failed with exit code %d" % ret)
269 if not Options.options.LIST and not os.path.exists(st_done):
270 print("ERROR: test command failed to complete")
274 ########################################################################
275 # main test entry point
277 '''Run the test suite (see test options below)'''
279 # if running all tests, then force a symbol check
280 env = LOAD_ENVIRONMENT()
282 Scripting.commands.append('build')
283 Scripting.commands.append('testonly')