s3-selftest: re-sync with s4-selftest wscript.
[amitay/samba.git] / source3 / 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 cmd_testonly(opt):
74     '''run tests without doing a build first'''
75     env = LOAD_ENVIRONMENT()
76     opt.env = env
77
78     if (not CONFIG_SET(opt, 'NSS_WRAPPER') or
79 #        not CONFIG_SET(opt, 'UID_WRAPPER') or
80         not CONFIG_SET(opt, 'SOCKET_WRAPPER')):
81         print("ERROR: You must use --enable-selftest to enable selftest")
82         sys.exit(1)
83
84     os.environ['SAMBA_SELFTEST'] = '1'
85
86     env.TESTS  = Options.options.TESTS
87
88     env.SUBUNIT_FORMATTER = '${PYTHON} -u ../selftest/format-subunit --prefix=${SELFTEST_PREFIX} --immediate'
89     env.FILTER_XFAIL = '${PYTHON} -u ../selftest/filter-subunit --expected-failures=./selftest/knownfail'
90
91     if Options.options.FAIL_IMMEDIATELY:
92         env.FILTER_XFAIL += ' --fail-immediately'
93
94     env.FORMAT_TEST_OUTPUT = '${SUBUNIT_FORMATTER}'
95
96     # clean any previous temporary files
97     os.system("rm -rf %s/tmp" % env.SELFTEST_PREFIX);
98
99     # put all command line options in the environment as TESTENV_*=*
100     for o in dir(Options.options):
101         if o[0:1] != '_':
102             os.environ['TESTENV_%s' % o.upper()] = str(getattr(Options.options, o, ''))
103
104     env.OPTIONS = ''
105     if not Options.options.SLOWTEST:
106         env.OPTIONS += ' --exclude=./selftest/slow'
107     if Options.options.QUICKTEST:
108         env.OPTIONS += ' --quick --include=./selftest/quick'
109     if Options.options.LOAD_LIST:
110         env.OPTIONS += ' --load-list=%s' % Options.options.LOAD_LIST
111     if Options.options.TESTENV:
112         env.OPTIONS += ' --testenv'
113     if Options.options.SOCKET_WRAPPER_PCAP:
114         env.OPTIONS += ' --socket-wrapper-pcap'
115     if Options.options.SOCKET_WRAPPER_KEEP_PCAP:
116         env.OPTIONS += ' --socket-wrapper-keep-pcap'
117     if Options.options.LIST:
118         env.OPTIONS += ' --list'
119     if os.environ.get('RUN_FROM_BUILD_FARM') is not None:
120         env.FILTER_OPTIONS = '${FILTER_XFAIL} --strip-passed-output'
121     else:
122         env.FILTER_OPTIONS = '${FILTER_XFAIL}'
123
124     if Options.options.VALGRIND:
125         os.environ['VALGRIND'] = 'valgrind -q --num-callers=30'
126         if Options.options.VALGRINDLOG is not None:
127             os.environ['VALGRIND'] += ' --log-file=%s' % Options.options.VALGRINDLOG
128
129     server_wrapper=''
130
131     if Options.options.VALGRIND_SERVER:
132         server_wrapper = '../selftest/valgrind_run _DUMMY=X'
133     elif Options.options.GDBTEST:
134         server_wrapper = '../selftest/gdb_run _DUMMY=X'
135
136     if Options.options.SCREEN:
137         server_wrapper = '%s/../selftest/in_screen %s' % (os.getcwd(), server_wrapper)
138         os.environ['TERMINAL'] = '%s/../selftest/in_screen' % os.getcwd()
139     elif server_wrapper != '':
140         server_wrapper = 'xterm -n server -l -e %s' % server_wrapper
141
142     if server_wrapper != '':
143         os.environ['SAMBA_VALGRIND'] = server_wrapper
144
145     # this is needed for systems without rpath, or with rpath disabled
146     ADD_LD_LIBRARY_PATH('bin/shared')
147     ADD_LD_LIBRARY_PATH('bin/shared/private')
148
149     # if we are using a system version of ldb then we need to tell it to
150     # load modules from our modules path
151     if env.USING_SYSTEM_LDB:
152         os.environ['LDB_MODULES_PATH'] = 'bin/modules/ldb'
153
154     # tell build system where to find config.h
155     os.environ['CONFIG_H'] = 'bin/default/source3/include/config.h'
156     os.environ['VFSLIBDIR'] = os.path.abspath('bin/modules/vfs')
157
158     st_done = os.path.join(env.SELFTEST_PREFIX, 'st_done')
159     if os.path.exists(st_done):
160         os.unlink(st_done)
161
162     if not os.path.isdir(env.SELFTEST_PREFIX):
163         os.makedirs(env.SELFTEST_PREFIX, int('755', 8))
164
165     # We use the full path rather than relative path because it cause problems on some plateforms (ie. solaris 8).
166     cmd = '(${PERL} %s/../selftest/selftest.pl --target=samba3 --prefix=${SELFTEST_PREFIX} --builddir=. --srcdir=. --exclude=./selftest/skip --testlist="./selftest/tests.sh|" ${OPTIONS} --socket-wrapper ${TESTS} && touch ${SELFTEST_PREFIX}/st_done) | ${FILTER_OPTIONS} | tee ${SELFTEST_PREFIX}/subunit' % (os.getcwd())
167     if os.environ.get('RUN_FROM_BUILD_FARM') is None and not Options.options.FILTERED_SUBUNIT:
168         cmd += ' | ${FORMAT_TEST_OUTPUT}'
169     else:
170         cmd += ' | ${PYTHON} -u ../selftest/filter-subunit'
171     cmd = EXPAND_VARIABLES(opt, cmd)
172
173     print("test: running %s" % cmd)
174     ret = RUN_COMMAND(cmd, env=env)
175     if os.path.exists(".testrepository"):
176         # "testr load -q" isn't
177         cmd = 'testr load -q < ${SELFTEST_PREFIX}/subunit > /dev/null'
178         cmd = EXPAND_VARIABLES(opt, cmd)
179         RUN_COMMAND(cmd, env=env)
180
181     if ret != 0:
182         print("ERROR: test failed with exit code %d" % ret)
183         sys.exit(ret)
184
185     if not os.path.exists(st_done):
186         print("ERROR: test command failed to complete")
187         sys.exit(1)
188
189
190 ########################################################################
191 # main test entry point
192 def cmd_test(opt):
193     '''Run the test suite (see test options below)'''
194     Scripting.commands.append('build')
195     Scripting.commands.append('testonly')