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 os
  22 import subprocess
  23 import sys
  24
  25 def srcdir():
  26     return os.path.normpath(os.getenv("SRCDIR", os.path.join(os.path.dirname(os.path.abspath(__file__)), "..")))
  27
  28 def source4dir():
  29     return os.path.normpath(os.path.join(srcdir(), "source4"))
  30
  31 def source3dir():
  32     return os.path.normpath(os.path.join(srcdir(), "source3"))
  33
  34 def bindir():
  35     return os.path.normpath(os.getenv("BINDIR", "./bin"))
  36
  37 binary_mapping = {}
  38
  39 def binpath(name):
  40     if name in binary_mapping:
  41         name = binary_mapping[name]
  42     return os.path.join(bindir(), name)
  43
  44 binary_mapping_string = os.getenv("BINARY_MAPPING", None)
  45 if binary_mapping_string is not None:
  46     for binmapping_entry in binary_mapping_string.split(','):
  47         try:
  48             (from_path, to_path) = binmapping_entry.split(':', 1)
  49         except ValueError:
  50             continue
  51         binary_mapping[from_path] = to_path
  52
  53 # Split perl variable to allow $PERL to be set to e.g. "perl -W"
  54 perl = os.getenv("PERL", "perl").split()
  55
  56 if subprocess.call(perl + ["-e", "eval require Test::More;"]) == 0:
  57     has_perl_test_more = True
  58 else:
  59     has_perl_test_more = False
  60
  61 python = os.getenv("PYTHON", "python")
  62
  63 # Set a default value, overridden if we find a working one on the system
  64 tap2subunit = "PYTHONPATH=%s/lib/subunit/python:%s/lib/testtools:%s/lib/extras:%s/lib/mimeparse %s %s/lib/subunit/filters/tap2subunit" % (srcdir(), srcdir(), srcdir(), srcdir(), python, srcdir())
  65 subunit2to1 = "PYTHONPATH=%s/lib/subunit/python:%s/lib/testtools:%s/lib/extras:%s/lib/mimeparse %s %s/lib/subunit/filters/subunit-2to1" % (srcdir(), srcdir(), srcdir(), srcdir(), python, srcdir())
  66
  67 sub = subprocess.Popen("tap2subunit", stdin=subprocess.PIPE,
  68     stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
  69 sub.communicate("")
  70
  71 if sub.returncode == 0:
  72     cmd = "echo -ne \"1..1\nok 1 # skip doesn't seem to work yet\n\" | tap2subunit | grep skip"
  73     sub = subprocess.Popen(cmd, stdout=subprocess.PIPE, stdin=subprocess.PIPE,
  74         stderr=subprocess.PIPE, shell=True)
  75     if sub.returncode == 0:
  76         tap2subunit = "tap2subunit"
  77
  78 def to_subunit1(subunit_version):
  79     if subunit_version == 1:
  80         return ""
  81     return " | " + subunit2to1
  82
  83
  84 def valgrindify(cmdline):
  85     """Run a command under valgrind, if $VALGRIND was set."""
  86     valgrind = os.getenv("VALGRIND")
  87     if valgrind is None:
  88         return cmdline
  89     return valgrind + " " + cmdline
  90
  91
  92 def plantestsuite(name, env, cmdline, subunit_version=1):
  93     """Plan a test suite.
  94
  95     :param name: Testsuite name
  96     :param env: Environment to run the testsuite in
  97     :param cmdline: Command line to run
  98     """
  99     print "-- TEST --"
 100     print name
 101     print env
 102     if isinstance(cmdline, list):
 103         cmdline = " ".join(cmdline)
 104     if "$LISTOPT" in cmdline:
 105         raise AssertionError("test %s supports --list, but not --load-list" % name)
 106     print cmdline + " 2>&1 " + to_subunit1(subunit_version) + " | " + add_prefix(name, env)
 107
 108
 109 def add_prefix(prefix, env, support_list=False):
 110     if support_list:
 111         listopt = "$LISTOPT "
 112     else:
 113         listopt = ""
 114     return "%s/selftest/filter-subunit %s--fail-on-empty --prefix=\"%s.\" --suffix=\"(%s)\"" % (srcdir(), listopt, prefix, env)
 115
 116
 117 def plantestsuite_loadlist(name, env, cmdline, subunit_version=1):
 118     print "-- TEST-LOADLIST --"
 119     if env == "none":
 120         fullname = name
 121     else:
 122         fullname = "%s(%s)" % (name, env)
 123     print fullname
 124     print env
 125     if isinstance(cmdline, list):
 126         cmdline = " ".join(cmdline)
 127     support_list = ("$LISTOPT" in cmdline)
 128     if not "$LISTOPT" in cmdline:
 129         raise AssertionError("loadlist test %s does not support not --list" % name)
 130     if not "$LOADLIST" in cmdline:
 131         raise AssertionError("loadlist test %s does not support --load-list" % name)
 132     print ("%s | %s" % (cmdline.replace("$LOADLIST", ""), add_prefix(name, env, support_list))).replace("$LISTOPT", "--list")
 133     print cmdline.replace("$LISTOPT", "") + " 2>&1 " + to_subunit1(subunit_version) + " | " + add_prefix(name, env, False)
 134
 135
 136 def skiptestsuite(name, reason):
 137     """Indicate that a testsuite was skipped.
 138
 139     :param name: Test suite name
 140     :param reason: Reason the test suite was skipped
 141     """
 142     # FIXME: Report this using subunit, but re-adjust the testsuite count somehow
 143     print >>sys.stderr, "skipping %s (%s)" % (name, reason)
 144
 145
 146 def planperltestsuite(name, path):
 147     """Run a perl test suite.
 148
 149     :param name: Name of the test suite
 150     :param path: Path to the test runner
 151     """
 152     if has_perl_test_more:
 153         plantestsuite(name, "none", "%s %s | %s" % (" ".join(perl), path, tap2subunit))
 154     else:
 155         skiptestsuite(name, "Test::More not available")
 156
 157
 158 def planpythontestsuite(env, module, name=None, extra_path=[]):
 159     if name is None:
 160         name = module
 161     pypath = list(extra_path)
 162     args = [python, "-m", "samba.subunit.run", "$LISTOPT", "$LOADLIST", module]
 163     if pypath:
 164         args.insert(0, "PYTHONPATH=%s" % ":".join(["$PYTHONPATH"] + pypath))
 165     plantestsuite_loadlist(name, env, args)
 166
 167
 168 def get_env_torture_options():
 169     ret = []
 170     if not os.getenv("SELFTEST_VERBOSE"):
 171         ret.append("--option=torture:progress=no")
 172     if os.getenv("SELFTEST_QUICK"):
 173         ret.append("--option=torture:quick=yes")
 174     return ret
 175
 176
 177 samba4srcdir = source4dir()
 178 samba3srcdir = source3dir()
 179 bbdir = os.path.join(srcdir(), "testprogs/blackbox")
 180 configuration = "--configfile=$SMB_CONF_PATH"
 181
 182 smbtorture4 = binpath("smbtorture4")
 183 smbtorture4_testsuite_list = subprocess.Popen([smbtorture4, "--list-suites"], stdout=subprocess.PIPE, stderr=subprocess.PIPE).communicate("")[0].splitlines()
 184
 185 smbtorture4_options = [
 186     configuration,
 187     "--maximum-runtime=$SELFTEST_MAXTIME",
 188     "--basedir=$SELFTEST_TMPDIR",
 189     "--format=subunit"
 190     ] + get_env_torture_options()
 191
 192
 193 def plansmbtorture4testsuite(name, env, options, target, modname=None):
 194     if modname is None:
 195         modname = "samba4.%s" % name
 196     if isinstance(options, list):
 197         options = " ".join(options)
 198     options = " ".join(smbtorture4_options + ["--target=%s" % target]) + " " + options
 199     cmdline = "%s $LISTOPT $LOADLIST %s %s" % (valgrindify(smbtorture4), options, name)
 200     plantestsuite_loadlist(modname, env, cmdline)
 201
 202
 203 def smbtorture4_testsuites(prefix):
 204     return filter(lambda x: x.startswith(prefix), smbtorture4_testsuite_list)
 205
 206
 207 smbclient3 = binpath('smbclient3')
 208 smbtorture3 = binpath('smbtorture3')
 209 ntlm_auth3 = binpath('ntlm_auth3')
 210 net = binpath('net')
 211 scriptdir = os.path.join(srcdir(), "script/tests")
 212
 213 wbinfo = binpath('wbinfo')
 214 dbwrap_tool = binpath('dbwrap_tool')
 215 vfstest = binpath('vfstest')