selftesthelpers: Fix detection of tap2subunit.
[nivanova/samba-autobuild/.git] / selftest / selftesthelpers.py
1 #!/usr/bin/python
2 # This script generates a list of testsuites that should be run as part of
3 # the Samba 4 test suite.
4
5 # The output of this script is parsed by selftest.pl, which then decides
6 # which of the tests to actually run. It will, for example, skip all tests
7 # listed in selftest/skip or only run a subset during "make quicktest".
8
9 # The idea is that this script outputs all of the tests of Samba 4, not
10 # just those that are known to pass, and list those that should be skipped
11 # or are known to fail in selftest/skip or selftest/knownfail. This makes it
12 # very easy to see what functionality is still missing in Samba 4 and makes
13 # it possible to run the testsuite against other servers, such as Samba 3 or
14 # Windows that have a different set of features.
15
16 # The syntax for a testsuite is "-- TEST --" on a single line, followed
17 # by the name of the test, the environment it needs and the command to run, all
18 # three separated by newlines. All other lines in the output are considered
19 # comments.
20
21 import errno
22 import os
23 import subprocess
24 import sys
25
26 def srcdir():
27     return os.path.normpath(os.getenv("SRCDIR", os.path.join(os.path.dirname(os.path.abspath(__file__)), "..")))
28
29 def source4dir():
30     return os.path.normpath(os.path.join(srcdir(), "source4"))
31
32 def bindir():
33     return os.path.normpath(os.getenv("BINDIR", "./bin"))
34
35 binary_mapping = {}
36
37 def binpath(name):
38     if name in binary_mapping:
39         name = binary_mapping[name]
40     return os.path.join(bindir(), name)
41
42 binary_mapping_string = os.getenv("BINARY_MAPPING", None)
43 if binary_mapping_string is not None:
44     for binmapping_entry in binary_mapping_string.split(','):
45         try:
46             (from_path, to_path) = binmapping_entry.split(':', 1)
47         except ValueError:
48             continue
49         binary_mapping[from_path] = to_path
50
51 # Split perl variable to allow $PERL to be set to e.g. "perl -W"
52 perl = os.getenv("PERL", "perl").split()
53
54 if subprocess.call(perl + ["-e", "eval require Test::More;"]) == 0:
55     has_perl_test_more = True
56 else:
57     has_perl_test_more = False
58
59 try:
60     from subunit.run import TestProgram
61 except ImportError:
62     has_system_subunit_run = False
63 else:
64     has_system_subunit_run = True
65
66 python = os.getenv("PYTHON", "python")
67
68 # Set a default value, overridden if we find a working one on the system
69 tap2subunit = "PYTHONPATH=%s/lib/subunit/python:%s/lib/testtools %s %s/lib/subunit/filters/tap2subunit" % (srcdir(), srcdir(), python, srcdir())
70
71 sub = subprocess.Popen("tap2subunit", stdin=subprocess.PIPE,
72     stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
73 sub.communicate("")
74
75 if sub.returncode == 0:
76     cmd = "echo -ne \"1..1\nok 1 # skip doesn't seem to work yet\n\" | tap2subunit | grep skip"
77     sub = subprocess.Popen(cmd, stdout=subprocess.PIPE, stdin=subprocess.PIPE,
78         stderr=subprocess.PIPE, shell=True)
79     if sub.returncode == 0:
80         tap2subunit = "tap2subunit"
81
82 def valgrindify(cmdline):
83     """Run a command under valgrind, if $VALGRIND was set."""
84     valgrind = os.getenv("VALGRIND")
85     if valgrind is None:
86         return cmdline
87     return valgrind + " " + cmdline
88
89
90 def plantestsuite(name, env, cmdline, allow_empty_output=False):
91     """Plan a test suite.
92
93     :param name: Testsuite name
94     :param env: Environment to run the testsuite in
95     :param cmdline: Command line to run
96     """
97     print "-- TEST --"
98     print name
99     print env
100     if isinstance(cmdline, list):
101         cmdline = " ".join(cmdline)
102     filter_subunit_args = []
103     if not allow_empty_output:
104         filter_subunit_args.append("--fail-on-empty")
105     if "$LISTOPT" in cmdline:
106         filter_subunit_args.append("$LISTOPT")
107     print "%s 2>&1 | %s/selftest/filter-subunit %s --prefix=\"%s.\" --suffix=\"(%s)\"" % (cmdline,
108                                                                         srcdir(),
109                                                                         " ".join(filter_subunit_args),
110                                                                         name, env)
111     if allow_empty_output:
112         print >>sys.stderr, "WARNING: allowing empty subunit output from %s" % name
113
114
115 def add_prefix(prefix, env, support_list=False):
116     if support_list:
117         listopt = "$LISTOPT "
118     else:
119         listopt = ""
120     return "%s/selftest/filter-subunit %s--fail-on-empty --prefix=\"%s.\" --suffix=\"(%s)\"" % (srcdir(), listopt, prefix, env)
121
122
123 def plantestsuite_loadlist(name, env, cmdline):
124     print "-- TEST-LOADLIST --"
125     if env == "none":
126         fullname = name
127     else:
128         fullname = "%s(%s)" % (name, env)
129     print fullname
130     print env
131     if isinstance(cmdline, list):
132         cmdline = " ".join(cmdline)
133     support_list = ("$LISTOPT" in cmdline)
134     print "%s $LOADLIST 2>&1 | %s" % (cmdline, add_prefix(name, env, support_list))
135
136
137 def plantestsuite_idlist(name, env, cmdline):
138     print "-- TEST-IDLIST --"
139     if env == "none":
140         fullname = name
141     else:
142         fullname = "%s(%s)" % (name, env)
143     print fullname
144     print env
145     if isinstance(cmdline, list):
146         cmdline = " ".join(cmdline)
147     print cmdline
148
149
150 def skiptestsuite(name, reason):
151     """Indicate that a testsuite was skipped.
152
153     :param name: Test suite name
154     :param reason: Reason the test suite was skipped
155     """
156     # FIXME: Report this using subunit, but re-adjust the testsuite count somehow
157     print >>sys.stderr, "skipping %s (%s)" % (name, reason)
158
159
160 def planperltestsuite(name, path):
161     """Run a perl test suite.
162
163     :param name: Name of the test suite
164     :param path: Path to the test runner
165     """
166     if has_perl_test_more:
167         plantestsuite(name, "none", "%s %s | %s" % (" ".join(perl), path, tap2subunit))
168     else:
169         skiptestsuite(name, "Test::More not available")
170
171
172 def planpythontestsuite(env, module, name=None, extra_path=[]):
173     if name is None:
174         name = module
175     pypath = list(extra_path)
176     if not has_system_subunit_run:
177         pypath.extend(["%s/lib/subunit/python" % srcdir(),
178             "%s/lib/testtools" % srcdir()])
179     args = [python, "-m", "subunit.run", "$LISTOPT", module]
180     if pypath:
181         args.insert(0, "PYTHONPATH=%s" % ":".join(["$PYTHONPATH"] + pypath))
182     plantestsuite_idlist(name, env, args)
183
184
185 def get_env_torture_options():
186     ret = []
187     if not os.getenv("SELFTEST_VERBOSE"):
188         ret.append("--option=torture:progress=no")
189     if os.getenv("SELFTEST_QUICK"):
190         ret.append("--option=torture:quick=yes")
191     return ret
192
193
194 samba4srcdir = source4dir()
195 bbdir = os.path.join(srcdir(), "testprogs/blackbox")
196 configuration = "--configfile=$SMB_CONF_PATH"
197
198 smbtorture4 = binpath("smbtorture4")
199 smbtorture4_testsuite_list = subprocess.Popen([smbtorture4, "--list-suites"], stdout=subprocess.PIPE, stderr=subprocess.PIPE).communicate("")[0].splitlines()
200
201 smbtorture4_options = [
202     configuration,
203     "--maximum-runtime=$SELFTEST_MAXTIME",
204     "--basedir=$SELFTEST_TMPDIR",
205     "--format=subunit"
206     ] + get_env_torture_options()
207
208
209 def print_smbtorture4_version():
210     """Print the version of Samba smbtorture4 comes from.
211
212     :return: Whether smbtorture4 was successfully run
213     """
214     try:
215         sub = subprocess.Popen([smbtorture4, "-V"], stdout=sys.stderr)
216     except OSError, e:
217         if e.errno == errno.ENOENT:
218             return False
219         raise
220     sub.communicate("")
221     return (sub.returncode == 0)
222
223
224 def plansmbtorture4testsuite(name, env, options, target, modname=None):
225     if modname is None:
226         modname = "samba4.%s" % name
227     if isinstance(options, list):
228         options = " ".join(options)
229     options = " ".join(smbtorture4_options + ["--target=%s" % target]) + " " + options
230     cmdline = "%s $LISTOPT %s %s" % (valgrindify(smbtorture4), options, name)
231     plantestsuite_loadlist(modname, env, cmdline)
232
233
234 def smbtorture4_testsuites(prefix):
235     return filter(lambda x: x.startswith(prefix), smbtorture4_testsuite_list)