2 # vim: expandtab ft=python
9 from waflib
import Scripting
, Options
, Utils
10 from waflib
.ConfigSet
import ConfigSet
as Environment
12 from samba_utils
import *
13 from samba_autoconf
import *
16 DEFAULT_SELFTEST_PREFIX
="./st"
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
)
32 opt
.ADD_COMMAND('test', cmd_test
)
33 opt
.ADD_COMMAND('testonly', cmd_testonly
)
35 gr
= opt
.add_option_group('test options')
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)
99 conf
.env
.SELFTEST_PREFIX
= Options
.options
.SELFTEST_PREFIX
100 conf
.env
.enable_coverage
= Options
.options
.enable_coverage
101 if conf
.env
.enable_coverage
:
102 conf
.ADD_LDFLAGS('-lgcov', testflags
=True)
103 conf
.ADD_CFLAGS('--coverage')
105 if Options
.options
.enable_selftest
or Options
.options
.developer
:
106 conf
.DEFINE('ENABLE_SELFTEST', 1)
109 def cmd_testonly(opt
):
110 '''run tests without doing a build first'''
111 env
= LOAD_ENVIRONMENT()
114 if Options
.options
.SELFTEST_PREFIX
!= DEFAULT_SELFTEST_PREFIX
:
115 env
.SELFTEST_PREFIX
= Options
.options
.SELFTEST_PREFIX
117 if (not CONFIG_SET(opt
, 'NSS_WRAPPER') or
118 not CONFIG_SET(opt
, 'UID_WRAPPER') or
119 not CONFIG_SET(opt
, 'SOCKET_WRAPPER')):
120 print("ERROR: You must use --enable-selftest to enable selftest")
123 os
.environ
['SAMBA_SELFTEST'] = '1'
125 env
.TESTS
= Options
.options
.TESTS
127 env
.SUBUNIT_FORMATTER
= os
.getenv('SUBUNIT_FORMATTER')
129 # Lots of test scripts need to run with the correct version
130 # of python. With the correct shebang the script should run with the
131 # correct version, the problem is that not all scripts are part
132 # of the installation, some scripts are part of the source code,
133 # and the shebang is not dynamically generated as yet.
134 # It is safer if we are somewhat version neutral at the moment and
135 # ignore the shebang and always run scripts from the test environment
136 # with the python version (determined by PYTHON env variable) If this
137 # env variable isn't set then set it according to the python version
138 # that is running the tests
139 if not os
.getenv('PYTHON', None):
140 from sys
import executable
as exe
141 os
.environ
['PYTHON'] = os
.path
.basename(exe
)
143 if not env
.SUBUNIT_FORMATTER
:
144 if Options
.options
.PERF_TEST
:
145 env
.SUBUNIT_FORMATTER
= '${PYTHON} -u ${srcdir}/selftest/format-subunit-json --prefix=${SELFTEST_PREFIX}'
147 env
.SUBUNIT_FORMATTER
= '${PYTHON} -u ${srcdir}/selftest/format-subunit --prefix=${SELFTEST_PREFIX} --immediate'
148 env
.FILTER_XFAIL
= ('${PYTHON} -u ${srcdir}/selftest/filter-subunit '
149 '--expected-failures=${srcdir}/selftest/knownfail '
150 '--expected-failures=${srcdir}/selftest/knownfail.d '
151 '--flapping=${srcdir}/selftest/flapping '
152 '--flapping=${srcdir}/selftest/flapping.d')
154 if Options
.options
.FAIL_IMMEDIATELY
:
155 env
.FILTER_XFAIL
+= ' --fail-immediately'
157 env
.FORMAT_TEST_OUTPUT
= '${SUBUNIT_FORMATTER}'
159 # clean any previous temporary files
160 os
.system("rm -rf %s/tmp" % env
.SELFTEST_PREFIX
);
162 # put all command line options in the environment as TESTENV_*=*
163 for o
in dir(Options
.options
):
165 val
= getattr(Options
.options
, o
, '')
166 if not issubclass(type(val
), types
.FunctionType
) \
167 and not issubclass(type(val
), types
.MethodType
):
168 os
.environ
['TESTENV_%s' % o
.upper()] = str(getattr(Options
.options
, o
, ''))
171 if not Options
.options
.SLOWTEST
:
172 env
.OPTIONS
+= ' --exclude=${srcdir}/selftest/slow'
173 if Options
.options
.QUICKTEST
:
174 env
.OPTIONS
+= ' --quick --include=${srcdir}/selftest/quick'
175 if Options
.options
.LOAD_LIST
:
176 env
.OPTIONS
+= ' --load-list=%s' % Options
.options
.LOAD_LIST
177 if Options
.options
.TESTENV
:
178 env
.OPTIONS
+= ' --testenv'
179 if Options
.options
.SOCKET_WRAPPER_PCAP
:
180 env
.OPTIONS
+= ' --socket-wrapper-pcap'
181 if Options
.options
.SOCKET_WRAPPER_KEEP_PCAP
:
182 env
.OPTIONS
+= ' --socket-wrapper-keep-pcap'
183 if Options
.options
.RANDOM_ORDER
:
184 env
.OPTIONS
+= ' --random-order'
185 if Options
.options
.PERF_TEST
:
186 env
.FILTER_OPTIONS
= ('${PYTHON} -u ${srcdir}/selftest/filter-subunit '
187 '--perf-test-output')
189 env
.FILTER_OPTIONS
= '${FILTER_XFAIL}'
191 if Options
.options
.VALGRIND
:
192 os
.environ
['VALGRIND'] = 'valgrind -q --num-callers=30'
193 if Options
.options
.VALGRINDLOG
is not None:
194 os
.environ
['VALGRIND'] += ' --log-file=%s' % Options
.options
.VALGRINDLOG
198 if Options
.options
.VALGRIND_SERVER
:
199 server_wrapper
= '${srcdir}/selftest/valgrind_run _DUMMY=X'
200 elif Options
.options
.GDBTEST
:
201 server_wrapper
= '${srcdir}/selftest/gdb_run _DUMMY=X'
203 if Options
.options
.SCREEN
:
204 server_wrapper
= '${srcdir}/selftest/in_screen %s' % server_wrapper
205 os
.environ
['TERMINAL'] = EXPAND_VARIABLES(opt
, '${srcdir}/selftest/in_screen')
206 elif server_wrapper
!= '':
207 server_wrapper
= 'xterm -n server -l -e %s' % server_wrapper
209 if server_wrapper
!= '':
210 os
.environ
['SAMBA_VALGRIND'] = EXPAND_VARIABLES(opt
, server_wrapper
)
211 os
.environ
['NMBD_VALGRIND'] = EXPAND_VARIABLES(opt
, server_wrapper
)
212 os
.environ
['WINBINDD_VALGRIND'] = EXPAND_VARIABLES(opt
, server_wrapper
)
213 os
.environ
['SMBD_VALGRIND'] = EXPAND_VARIABLES(opt
, server_wrapper
)
215 # this is needed for systems without rpath, or with rpath disabled
216 ADD_LD_LIBRARY_PATH('bin/shared')
217 ADD_LD_LIBRARY_PATH('bin/shared/private')
219 # if we are using a system version of ldb then we need to tell it to
220 # load modules from our modules path
221 if env
.USING_SYSTEM_LDB
:
222 os
.environ
['LDB_MODULES_PATH'] = os
.path
.abspath(
223 os
.path
.join(*(env
.cwd
+ ['bin/modules/ldb'])))
225 # tell build system where to find config.h
226 os
.environ
['CONFIG_H'] = 'bin/default/include/config.h'
228 # tell the test system where perl is
229 if isinstance(env
.PERL
, list):
230 perl
= ' '.join(env
.PERL
)
233 os
.environ
['PERL'] = perl
235 st_done
= os
.path
.join(env
.SELFTEST_PREFIX
, 'st_done')
236 if os
.path
.exists(st_done
):
239 if not os
.path
.isdir(env
.SELFTEST_PREFIX
):
240 os
.makedirs(env
.SELFTEST_PREFIX
, int('755', 8))
242 if Options
.options
.TEST_LIST
:
243 env
.TESTLISTS
= '--testlist=%r' % Options
.options
.TEST_LIST
244 elif Options
.options
.PERF_TEST
:
245 env
.TESTLISTS
= '--testlist="${PYTHON} ${srcdir}/selftest/perf_tests.py|" '
246 elif CONFIG_SET(opt
, 'EXTRA_PYTHON'):
247 env
.TESTLISTS
= ('--testlist="EXTRA_PYTHON=${EXTRA_PYTHON} ${PYTHON} ${srcdir}/selftest/tests.py|" ' +
248 '--testlist="EXTRA_PYTHON=${EXTRA_PYTHON} ${PYTHON} ${srcdir}/source3/selftest/tests.py|" ' +
249 '--testlist="EXTRA_PYTHON=${EXTRA_PYTHON} ${PYTHON} ${srcdir}/source4/selftest/tests.py|"')
251 env
.TESTLISTS
= ('--testlist="${PYTHON} ${srcdir}/selftest/tests.py|" ' +
252 '--testlist="${PYTHON} ${srcdir}/source3/selftest/tests.py|" ' +
253 '--testlist="${PYTHON} ${srcdir}/source4/selftest/tests.py|"')
255 if CONFIG_SET(opt
, 'AD_DC_BUILD_IS_ENABLED'):
256 env
.SELFTEST_TARGET
= "samba"
258 env
.SELFTEST_TARGET
= "samba3"
260 env
.OPTIONS
+= " --nss_wrapper_so_path=" + CONFIG_GET(opt
, 'LIBNSS_WRAPPER_SO_PATH')
261 env
.OPTIONS
+= " --resolv_wrapper_so_path=" + CONFIG_GET(opt
, 'LIBRESOLV_WRAPPER_SO_PATH')
262 env
.OPTIONS
+= " --socket_wrapper_so_path=" + CONFIG_GET(opt
, 'LIBSOCKET_WRAPPER_SO_PATH')
263 env
.OPTIONS
+= " --uid_wrapper_so_path=" + CONFIG_GET(opt
, 'LIBUID_WRAPPER_SO_PATH')
265 #if unversioned_sys_platform in ('freebsd', 'netbsd', 'openbsd', 'sunos'):
266 # env.OPTIONS += " --use-dns-faking"
269 env
.OPTIONS
+= " --use-dns-faking"
271 if CONFIG_GET(opt
, 'USING_SYSTEM_KRB5') and CONFIG_GET(opt
, 'MIT_KDC_PATH'):
272 env
.OPTIONS
+= " --mitkrb5 --exclude=${srcdir}/selftest/skip_mit_kdc"
274 if not CONFIG_GET(opt
, 'HAVE_GSS_KRB5_CRED_NO_CI_FLAGS_X'):
275 # older MIT krb5 libraries (< 1.14) don't have
276 # GSS_KRB5_CRED_NO_CI_FLAGS_X
277 env
.OPTIONS
+= " --exclude=${srcdir}/selftest/skip.no-GSS_KRB5_CRED_NO_CI_FLAGS_X"
279 if env
.ADDRESS_SANITIZER
:
280 # We try to find the correct libasan automatically
281 libasan
= Utils
.cmd_output('ldd bin/texpect | grep libasan| cut -f 3 -d \ ',
284 # Have the selftest.pl LD_PRELOAD libasan in the right spot
285 env
.OPTIONS
+= " --asan_so_path=" + libasan
288 # We use the full path rather than relative path to avoid problems on some platforms (ie. solaris 8).
289 env
.CORE_COMMAND
= '${PERL} ${srcdir}/selftest/selftest.pl --target=${SELFTEST_TARGET} --prefix=${SELFTEST_PREFIX} --srcdir=${srcdir} --exclude=${srcdir}/selftest/skip ${TESTLISTS} ${OPTIONS} ${TESTS}'
291 if env
.ADDRESS_SANITIZER
:
292 # For now we cannot run with leak detection
293 no_leak_check
= "ASAN_OPTIONS=detect_leaks=0"
294 env
.CORE_COMMAND
= no_leak_check
+ " " + env
.CORE_COMMAND
296 # We need to have the subunit filter and formatter preload
297 # libasan otherwise the tests fail at startup.
299 # Also, we do not care about leaks in python
301 asan_envs
= no_leak_check
+ " LD_PRELOAD=" + libasan
+ ' '
302 env
.FILTER_OPTIONS
= asan_envs
+ env
.FILTER_OPTIONS
303 env
.SUBUNIT_FORMATTER
= asan_envs
+ env
.SUBUNIT_FORMATTER
305 if Options
.options
.LIST
:
306 cmd
= '${CORE_COMMAND} --list'
308 env
.OPTIONS
+= ' --socket-wrapper'
309 cmd
= '(${CORE_COMMAND} && touch ${SELFTEST_PREFIX}/st_done) | ${FILTER_OPTIONS}'
311 if Options
.options
.NO_SUBUNIT_FILTER
:
312 # Skip subunit filtering (i.e. because python is disabled).
313 # Use --one to bail out upon any failure
314 cmd
= '(${CORE_COMMAND} --one && touch ${SELFTEST_PREFIX}/st_done)'
315 elif not Options
.options
.FILTERED_SUBUNIT
:
316 subunit_cache
= os
.path
.join(env
.SELFTEST_PREFIX
, "subunit")
317 cmd
+= ' | tee %s | ${FORMAT_TEST_OUTPUT}' % subunit_cache
319 cmd
+= ' | ${FILTER_OPTIONS}'
321 runcmd
= EXPAND_VARIABLES(opt
, cmd
)
323 print("test: running %s" % runcmd
)
324 ret
= RUN_COMMAND(cmd
, env
=env
)
326 if (os
.path
.exists(".testrepository") and
327 not Options
.options
.LIST
and
328 not Options
.options
.LOAD_LIST
and
329 subunit_cache
is not None):
330 testrcmd
= 'testr load -q < %s > /dev/null' % subunit_cache
331 runcmd
= EXPAND_VARIABLES(opt
, testrcmd
)
332 RUN_COMMAND(runcmd
, env
=env
)
334 if subunit_cache
is not None:
335 nb
= Options
.options
.NB_SLOWEST
336 cmd
= "./script/show_testsuite_time %s %d" % (subunit_cache
, nb
)
337 runcmd
= EXPAND_VARIABLES(opt
, cmd
)
338 RUN_COMMAND(runcmd
, env
=env
)
341 print("ERROR: test failed with exit code %d" % ret
)
344 if not Options
.options
.LIST
and not os
.path
.exists(st_done
):
345 print("ERROR: test command failed to complete")
349 ########################################################################
350 # main test entry point
352 '''Run the test suite (see test options below)'''
354 # if running all tests, then force a symbol check
355 env
= LOAD_ENVIRONMENT()
357 Options
.commands
.append('build')
358 Options
.commands
.append('testonly')