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