diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 17:47:29 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 17:47:29 +0000 |
commit | 4f5791ebd03eaec1c7da0865a383175b05102712 (patch) | |
tree | 8ce7b00f7a76baa386372422adebbe64510812d4 /selftest/selftesthelpers.py | |
parent | Initial commit. (diff) | |
download | samba-4f5791ebd03eaec1c7da0865a383175b05102712.tar.xz samba-4f5791ebd03eaec1c7da0865a383175b05102712.zip |
Adding upstream version 2:4.17.12+dfsg.upstream/2%4.17.12+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'selftest/selftesthelpers.py')
-rw-r--r-- | selftest/selftesthelpers.py | 229 |
1 files changed, 229 insertions, 0 deletions
diff --git a/selftest/selftesthelpers.py b/selftest/selftesthelpers.py new file mode 100644 index 0000000..1af8f5f --- /dev/null +++ b/selftest/selftesthelpers.py @@ -0,0 +1,229 @@ +#!/usr/bin/env python3 +# +# This script generates a list of testsuites that should be run as part of +# the Samba 4 test suite. + +# The output of this script is parsed by selftest.pl, which then decides +# which of the tests to actually run. It will, for example, skip all tests +# listed in selftest/skip or only run a subset during "make quicktest". + +# The idea is that this script outputs all of the tests of Samba 4, not +# just those that are known to pass, and list those that should be skipped +# or are known to fail in selftest/skip or selftest/knownfail. This makes it +# very easy to see what functionality is still missing in Samba 4 and makes +# it possible to run the testsuite against other servers, such as Samba 3 or +# Windows that have a different set of features. + +# The syntax for a testsuite is "-- TEST --" on a single line, followed +# by the name of the test, the environment it needs and the command to run, all +# three separated by newlines. All other lines in the output are considered +# comments. + +import os +import subprocess +import sys + + +def srcdir(): + alternate_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "..") + return os.path.normpath(os.getenv("SRCDIR", alternate_path)) + + +def source4dir(): + return os.path.normpath(os.path.join(srcdir(), "source4")) + + +def source3dir(): + return os.path.normpath(os.path.join(srcdir(), "source3")) + + +def bindir(): + return os.path.normpath(os.getenv("BINDIR", "./bin")) + + +def binpath(name): + return os.path.join(bindir(), name) + + +# Split perl variable to allow $PERL to be set to e.g. "perl -W" +perl = os.getenv("PERL", "perl").split() + +if subprocess.call(perl + ["-e", "eval require Test::More;"]) == 0: + has_perl_test_more = True +else: + has_perl_test_more = False + +python = os.getenv("PYTHON", "python") + +tap2subunit = python + " " + os.path.join(srcdir(), "selftest", "tap2subunit") + + +def valgrindify(cmdline): + """Run a command under valgrind, if $VALGRIND was set.""" + valgrind = os.getenv("VALGRIND") + if valgrind is None: + return cmdline + return valgrind + " " + cmdline + + +def plantestsuite(name, env, cmd, environ={}): + """Plan a test suite. + + :param name: Testsuite name + :param env: Environment to run the testsuite in + :param cmdline: Command line to run + """ + print("-- TEST --") + if env == "none": + fullname = name + else: + fullname = "%s(%s)" % (name, env) + print(fullname) + print(env) + + cmdline = "" + if environ: + environ = dict(environ) + cmdline_env = ["%s=%s" % item for item in environ.items()] + cmdline = " ".join(cmdline_env) + " " + + if isinstance(cmd, list): + cmdline += " ".join(cmd) + else: + cmdline += cmd + + if "$LISTOPT" in cmdline: + raise AssertionError("test %s supports --list, but not --load-list" % name) + print(cmdline + " 2>&1 " + " | " + add_prefix(name, env)) + + +def add_prefix(prefix, env, support_list=False): + if support_list: + listopt = "$LISTOPT " + else: + listopt = "" + return ("%s %s/selftest/filter-subunit %s--fail-on-empty --prefix=\"%s.\" --suffix=\"(%s)\"" % + (python, srcdir(), listopt, prefix, env)) + + +def plantestsuite_loadlist(name, env, cmdline): + print("-- TEST-LOADLIST --") + if env == "none": + fullname = name + else: + fullname = "%s(%s)" % (name, env) + print(fullname) + print(env) + if isinstance(cmdline, list): + cmdline = " ".join(cmdline) + support_list = ("$LISTOPT" in cmdline) + if "$LISTOPT" not in cmdline: + raise AssertionError("loadlist test %s does not support not --list" % name) + if "$LOADLIST" not in cmdline: + raise AssertionError("loadlist test %s does not support --load-list" % name) + print(("%s | %s" % + (cmdline.replace("$LOADLIST", ""), + add_prefix(name, env, support_list))).replace("$LISTOPT", "--list ")) + print(cmdline.replace("$LISTOPT", "") + " 2>&1 " + " | " + add_prefix(name, env, False)) + + +def skiptestsuite(name, reason): + """Indicate that a testsuite was skipped. + + :param name: Test suite name + :param reason: Reason the test suite was skipped + """ + # FIXME: Report this using subunit, but re-adjust the testsuite count somehow + print("skipping %s (%s)" % (name, reason), file=sys.stderr) + + +def planperltestsuite(name, path): + """Run a perl test suite. + + :param name: Name of the test suite + :param path: Path to the test runner + """ + if has_perl_test_more: + plantestsuite(name, "none", "%s %s | %s" % (" ".join(perl), path, tap2subunit)) + else: + skiptestsuite(name, "Test::More not available") + + +def planpythontestsuite(env, module, name=None, extra_path=[], environ={}, extra_args=[]): + environ = dict(environ) + py_path = list(extra_path) + if py_path is not None: + environ["PYTHONPATH"] = ":".join(["$PYTHONPATH"] + py_path) + args = ["%s=%s" % item for item in environ.items()] + args += [python, "-m", "samba.subunit.run", "$LISTOPT", "$LOADLIST", module] + args += extra_args + if name is None: + name = module + + plantestsuite_loadlist(name, env, args) + + +def get_env_torture_options(): + ret = [] + if not os.getenv("SELFTEST_VERBOSE"): + ret.append("--option=torture:progress=no") + if os.getenv("SELFTEST_QUICK"): + ret.append("--option=torture:quick=yes") + return ret + + +samba4srcdir = source4dir() +samba3srcdir = source3dir() +bbdir = os.path.join(srcdir(), "testprogs/blackbox") +configuration = "--configfile=$SMB_CONF_PATH" + +smbtorture4 = binpath("smbtorture") +smbtorture4_testsuite_list = subprocess.Popen( + [smbtorture4, "--list-suites"], + stdout=subprocess.PIPE, + stderr=subprocess.PIPE).communicate("")[0].decode('utf8').splitlines() + +smbtorture4_options = [ + configuration, + "--option=\'fss:sequence timeout=1\'", + "--maximum-runtime=$SELFTEST_MAXTIME", + "--basedir=$SELFTEST_TMPDIR", + "--format=subunit" +] + get_env_torture_options() + + +def plansmbtorture4testsuite(name, env, options, target, modname=None, environ={}): + if modname is None: + modname = "samba4.%s" % name + if isinstance(options, list): + options = " ".join(options) + options = " ".join(smbtorture4_options + ["--target=%s" % target]) + " " + options + cmdline = "" + if environ: + environ = dict(environ) + cmdline_env = ["%s=%s" % item for item in environ.items()] + cmdline += " ".join(cmdline_env) + " " + cmdline += " %s $LISTOPT $LOADLIST %s %s" % (valgrindify(smbtorture4), options, name) + plantestsuite_loadlist(modname, env, cmdline) + + +def smbtorture4_testsuites(prefix): + return list(filter(lambda x: x.startswith(prefix), smbtorture4_testsuite_list)) + + +smbclient3 = binpath('smbclient') +smbtorture3 = binpath('smbtorture3') +ntlm_auth3 = binpath('ntlm_auth') +net = binpath('net') +scriptdir = os.path.join(srcdir(), "script/tests") + +wbinfo = binpath('wbinfo') +dbwrap_tool = binpath('dbwrap_tool') +vfstest = binpath('vfstest') +smbcquotas = binpath('smbcquotas') +smbget = binpath('smbget') +rpcclient = binpath('rpcclient') +smbcacls = binpath('smbcacls') +smbcontrol = binpath('smbcontrol') +smbstatus = binpath('smbstatus') +timelimit = binpath('timelimit') |