KCC: move get_spanning_tree_edges out of KCC object
[sfrench/samba-autobuild/.git] / source4 / scripting / bin / subunitrun
index 6f1086ad376c653087cb703a78dd61dd2e351c35..c0b6e0d932f21bd83f209cd00fa6c80fa441011b 100755 (executable)
@@ -1,48 +1,87 @@
-#!/usr/bin/python
+#!/usr/bin/env python
 
 # Simple subunit testrunner for python
-# Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007
-#   
+
+# NOTE: This is deprecated - Using the standard subunit runner is
+# preferred - e.g. "python -m samba.subunit.run YOURMODULE".
+#
+# This wrapper will be removed once all tests can be run
+# without it. At the moment there are various tests which still
+# get e.g. credentials passed via command-line options to this
+# script.
+
+# Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2014
+#
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation; either version 3 of the License, or
 # (at your option) any later version.
-#   
+#
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
-#   
+#
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import sys
 
+# make sure the script dies immediately when hitting control-C,
+# rather than raising KeyboardInterrupt. As we do all database
+# operations using transactions, this is safe.
+import signal
+signal.signal(signal.SIGINT, signal.SIG_DFL)
+
 # Find right directory when running from source tree
 sys.path.insert(0, "bin/python")
 
-from subunit import SubunitTestRunner
-from unittest import TestProgram
 import optparse
-import os
-from samba import param
+import samba
+from samba.tests.subunitrun import TestProgram, SubunitOptions
+
 import samba.getopt as options
 import samba.tests
 
-parser = optparse.OptionParser("subunitrun [options] <tests>")
+
+usage = 'subunitrun [options] <tests>'
+description = '''
+This runs a Samba python test suite. The tests are typically located in
+python/samba/tests/*.py
+
+To run the tests from one of those modules, specify the test as
+samba.tests.MODULE. For example, to run the tests in common.py:
+
+   subunitrun samba.tests.common
+
+To list the tests in that module, use:
+
+   subunitrun -l samba.tests.common
+
+NOTE: This script is deprecated in favor of "python -m subunit.run". Don't use
+it unless it can be avoided.
+'''
+
+def format_description(formatter):
+    '''hack to prevent textwrap of the description'''
+    return description
+
+parser = optparse.OptionParser(usage=usage, description=description)
+parser.format_description = format_description
 credopts = options.CredentialsOptions(parser)
-parser.add_option_group(credopts)
 sambaopts = options.SambaOptions(parser)
+subunitopts = SubunitOptions(parser)
+parser.add_option_group(credopts)
 parser.add_option_group(sambaopts)
-parser.add_option_group(options.VersionOptions(parser))
-
-args = parser.parse_args()[1]
+parser.add_option_group(subunitopts)
 
-samba.tests.cmdline_loadparm = sambaopts.get_loadparm()
-samba.tests.cmdline_credentials = credopts.get_credentials(samba.tests.cmdline_loadparm)
+opts, args = parser.parse_args()
 
-param.cvar.default_config = samba.tests.cmdline_loadparm
+if not getattr(opts, "listtests", False):
+    lp = sambaopts.get_loadparm()
+    samba.tests.cmdline_credentials = credopts.get_credentials(lp)
+if getattr(opts, 'load_list', None):
+    args.insert(0, "--load-list=%s" % opts.load_list)
 
-runner = SubunitTestRunner()
-program = TestProgram(module=None, argv=[sys.argv[0]] + args, testRunner=runner)
+TestProgram(module=None, args=args, opts=subunitopts)