TDB2: make SAMBA use tdb1 again for the moment.
[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
10 def set_options(opt):
11
12     opt.add_option('--enable-selftest',
13                    help=("enable options necessary for selftest (default=no)"),
14                    action="store_true", dest='enable_selftest', default=False)
15     opt.add_option('--enable-coverage',
16                    help=("enable options necessary for code coverage reporting on selftest (default=no)"),
17                    action="store_true", dest='enable_coverage', default=False)
18     opt.add_option('--with-selftest-prefix',
19                    help=("specify location of selftest directory (default=./st)"),
20                    action="store", dest='SELFTEST_PREFIX', default='./st')
21
22     opt.ADD_COMMAND('test', cmd_test)
23     opt.ADD_COMMAND('testonly', cmd_testonly)
24
25     gr = opt.add_option_group('test options')
26
27     gr.add_option('--load-list', 
28                   help=("Load a test id list from a text file"),
29                   action="store", dest='LOAD_LIST', default=None)
30     gr.add_option('--list', 
31                   help=("List available tests"),
32                   action="store_true", dest='LIST', default=False)
33     gr.add_option('--tests',
34                   help=("wildcard pattern of tests to run"),
35                   action="store", dest='TESTS', default='')
36     gr.add_option('--filtered-subunit',
37                   help=("output (xfail) filtered subunit"),
38                   action="store_true", dest='FILTERED_SUBUNIT', default=False)
39     gr.add_option('--quick',
40                   help=("enable only quick tests"),
41                   action="store_true", dest='QUICKTEST', default=False)
42     gr.add_option('--slow',
43                   help=("enable the really slow tests"),
44                   action="store_true", dest='SLOWTEST', default=False)
45     gr.add_option('--testenv',
46                   help=("start a terminal with the test environment setup"),
47                   action="store_true", dest='TESTENV', default=False)
48     gr.add_option('--valgrind',
49                   help=("use valgrind on client programs in the tests"),
50                   action="store_true", dest='VALGRIND', default=False)
51     gr.add_option('--valgrind-log',
52                   help=("where to put the valgrind log"),
53                   action="store", dest='VALGRINDLOG', default=None)
54     gr.add_option('--valgrind-server',
55                   help=("use valgrind on the server in the tests (opens an xterm)"),
56                   action="store_true", dest='VALGRIND_SERVER', default=False)
57     gr.add_option('--screen',
58                   help=("run the samba servers in screen sessions"),
59                   action="store_true", dest='SCREEN', default=False)
60     gr.add_option('--gdbtest',
61                   help=("run the servers within a gdb window"),
62                   action="store_true", dest='GDBTEST', default=False)
63     gr.add_option('--fail-immediately',
64                   help=("stop tests on first failure"),
65                   action="store_true", dest='FAIL_IMMEDIATELY', default=False)
66     gr.add_option('--socket-wrapper-pcap',
67                   help=("create a pcap file for each failing test"),
68                   action="store_true", dest='SOCKET_WRAPPER_PCAP', default=False)
69     gr.add_option('--socket-wrapper-keep-pcap',
70                   help=("create a pcap file for all individual test"),
71                   action="store_true", dest='SOCKET_WRAPPER_KEEP_PCAP', default=False)
72
73 def configure(conf):
74     conf.env.SELFTEST_PREFIX = Options.options.SELFTEST_PREFIX
75     conf.env.enable_coverage = Options.options.enable_coverage
76     if conf.env.enable_coverage:
77         conf.ADD_LDFLAGS('-lgcov', testflags=True)
78         conf.ADD_CFLAGS('--coverage')
79
80 def cmd_testonly(opt):
81     '''run tests without doing a build first'''
82     env = LOAD_ENVIRONMENT()
83     opt.env = env
84
85     if (not CONFIG_SET(opt, 'NSS_WRAPPER') or
86         not CONFIG_SET(opt, 'UID_WRAPPER') or
87         not CONFIG_SET(opt, 'SOCKET_WRAPPER')):
88         print("ERROR: You must use --enable-selftest to enable selftest")
89         sys.exit(1)
90
91     os.environ['SAMBA_SELFTEST'] = '1'
92
93     env.TESTS  = Options.options.TESTS
94
95     env.SUBUNIT_FORMATTER = os.getenv('SUBUNIT_FORMATTER')
96     if not env.SUBUNIT_FORMATTER:
97         env.SUBUNIT_FORMATTER = '${PYTHON} -u ${srcdir}/selftest/format-subunit --prefix=${SELFTEST_PREFIX} --immediate'
98     env.FILTER_XFAIL = '${PYTHON} -u ${srcdir}/selftest/filter-subunit --expected-failures=${srcdir}/selftest/knownfail --flapping=${srcdir}/selftest/flapping'
99
100     if Options.options.FAIL_IMMEDIATELY:
101         env.FILTER_XFAIL += ' --fail-immediately'
102
103     env.FORMAT_TEST_OUTPUT = '${SUBUNIT_FORMATTER}'
104
105     # clean any previous temporary files
106     os.system("rm -rf %s/tmp" % env.SELFTEST_PREFIX);
107
108     # put all command line options in the environment as TESTENV_*=*
109     for o in dir(Options.options):
110         if o[0:1] != '_':
111             os.environ['TESTENV_%s' % o.upper()] = str(getattr(Options.options, o, ''))
112
113     binary_mapping = ('nmblookup3:nmblookup,' +
114                       'nmblookup4:nmblookup4,' +
115                       'smbclient3:smbclient,' +
116                       'smbclient4:smbclient4,' +
117                       'smbtorture4:smbtorture,' + 
118                       'ntlm_auth3:ntlm_auth3')
119
120     env.OPTIONS = '--binary-mapping=%s' % binary_mapping 
121     if not Options.options.SLOWTEST:
122         env.OPTIONS += ' --exclude=${srcdir}/selftest/slow'
123     if Options.options.QUICKTEST:
124         env.OPTIONS += ' --quick --include=${srcdir}/selftest/quick'
125     if Options.options.LOAD_LIST:
126         env.OPTIONS += ' --load-list=%s' % Options.options.LOAD_LIST
127     if Options.options.TESTENV:
128         env.OPTIONS += ' --testenv'
129     if Options.options.SOCKET_WRAPPER_PCAP:
130         env.OPTIONS += ' --socket-wrapper-pcap'
131     if Options.options.SOCKET_WRAPPER_KEEP_PCAP:
132         env.OPTIONS += ' --socket-wrapper-keep-pcap'
133     if os.environ.get('RUN_FROM_BUILD_FARM') is not None:
134         env.FILTER_OPTIONS = '${FILTER_XFAIL} --strip-passed-output'
135     else:
136         env.FILTER_OPTIONS = '${FILTER_XFAIL}'
137
138     if Options.options.VALGRIND:
139         os.environ['VALGRIND'] = 'valgrind -q --num-callers=30'
140         if Options.options.VALGRINDLOG is not None:
141             os.environ['VALGRIND'] += ' --log-file=%s' % Options.options.VALGRINDLOG
142
143     server_wrapper=''
144
145     if Options.options.VALGRIND_SERVER:
146         server_wrapper = '${srcdir}/selftest/valgrind_run _DUMMY=X'
147     elif Options.options.GDBTEST:
148         server_wrapper = '${srcdir}/selftest/gdb_run _DUMMY=X'
149
150     if Options.options.SCREEN:
151         server_wrapper = '${srcdir}/selftest/in_screen %s' % server_wrapper
152         os.environ['TERMINAL'] = EXPAND_VARIABLES(opt, '${srcdir}/selftest/in_screen')
153     elif server_wrapper != '':
154         server_wrapper = 'xterm -n server -l -e %s' % server_wrapper
155
156     if server_wrapper != '':
157         os.environ['SAMBA_VALGRIND'] = EXPAND_VARIABLES(opt, server_wrapper)
158
159     # this is needed for systems without rpath, or with rpath disabled
160     ADD_LD_LIBRARY_PATH('bin/shared')
161     ADD_LD_LIBRARY_PATH('bin/shared/private')
162
163     # if we are using a system version of ldb then we need to tell it to
164     # load modules from our modules path
165     if env.USING_SYSTEM_LDB:
166         os.environ['LDB_MODULES_PATH'] = 'bin/modules/ldb'
167
168     # tell build system where to find config.h
169     os.environ['VFSLIBDIR'] = os.path.abspath('bin/modules/vfs')
170     os.environ['CONFIG_H'] = 'bin/default/include/config.h'
171
172     st_done = os.path.join(env.SELFTEST_PREFIX, 'st_done')
173     if os.path.exists(st_done):
174         os.unlink(st_done)
175
176     if not os.path.isdir(env.SELFTEST_PREFIX):
177         os.makedirs(env.SELFTEST_PREFIX, int('755', 8))
178
179     env.TESTLISTS = ('--testlist="${PYTHON} ${srcdir}/source3/selftest/tests.py|" ' +
180                      '--testlist="${PYTHON} ${srcdir}/source4/selftest/tests.py|"')
181
182     if CONFIG_SET(opt, 'AD_DC_BUILD_IS_ENABLED'):
183         env.SELFTEST_TARGET="samba"
184     else:
185         env.SELFTEST_TARGET="samba3"
186
187     # We use the full path rather than relative path because it cause problems on some plateforms (ie. solaris 8).
188     env.CORE_COMMAND = '${PERL} ${srcdir}/selftest/selftest.pl --target=${SELFTEST_TARGET} --prefix=${SELFTEST_PREFIX} --srcdir=${srcdir} --exclude=${srcdir}/selftest/skip ${TESTLISTS} ${OPTIONS} ${TESTS}'
189     if Options.options.LIST:
190         cmd = '${CORE_COMMAND} --list'
191     else:
192         env.OPTIONS += ' --socket-wrapper'
193         cmd = '(${CORE_COMMAND} && touch ${SELFTEST_PREFIX}/st_done) | ${FILTER_OPTIONS}'
194         if (os.environ.get('RUN_FROM_BUILD_FARM') is None and
195             not Options.options.FILTERED_SUBUNIT):
196             cmd += ' | tee ${SELFTEST_PREFIX}/subunit | ${FORMAT_TEST_OUTPUT}'
197         else:
198             cmd += ' | ${FILTER_OPTIONS}'
199     runcmd = EXPAND_VARIABLES(opt, cmd)
200
201     print("test: running %s" % runcmd)
202     ret = RUN_COMMAND(cmd, env=env)
203
204     if os.path.exists(".testrepository") and not Options.options.LIST:
205         testrcmd = 'testr load -q < ${SELFTEST_PREFIX}/subunit > /dev/null'
206         runcmd = EXPAND_VARIABLES(opt, testrcmd)
207         RUN_COMMAND(runcmd, env=env)
208
209     if ret != 0:
210         print("ERROR: test failed with exit code %d" % ret)
211         sys.exit(ret)
212
213     if not Options.options.LIST and not os.path.exists(st_done):
214         print("ERROR: test command failed to complete")
215         sys.exit(1)
216
217
218 ########################################################################
219 # main test entry point
220 def cmd_test(opt):
221     '''Run the test suite (see test options below)'''
222
223     # if running all tests, then force a symbol check
224     env = LOAD_ENVIRONMENT()
225     CHECK_MAKEFLAGS(env)
226     if not Options.options.TESTS and not Options.options.TESTENV:
227         Options.options.DUP_SYMBOLCHECK = True
228
229     Scripting.commands.append('build')
230     Scripting.commands.append('testonly')