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