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