subunitrun: give more useful help
[rusty/samba.git] / source4 / scripting / bin / subunitrun
1 #!/usr/bin/env python
2
3 # Simple subunit testrunner for python
4 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007
5 #   
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
10 #   
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15 #   
16 # You should have received a copy of the GNU General Public License
17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 #
19
20 import sys
21
22 # Find right directory when running from source tree
23 sys.path.insert(0, "bin/python")
24
25 import optparse
26 import samba
27 samba.ensure_external_module("testtools", "testtools")
28 samba.ensure_external_module("subunit", "subunit/python")
29 from subunit.run import SubunitTestRunner
30 import samba.getopt as options
31 import samba.tests
32
33
34 usage = 'subunitrun [options] <tests>'
35 description = '''
36 This runs a Samba python test suite. The tests are typically located in
37 source4/scripting/python/samba/tests/*.py
38
39 To run the tests from one of those modules, specify the test as
40 samba.tests.MODULE. For example, to run the tests in common.py:
41
42    subunitrun samba.tests.common
43
44 To list the tests in that module, use:
45
46    subunitrun -l samba.tests.common
47 '''
48
49 def format_description(formatter):
50     '''hack to prevent textwrap of the description'''
51     return description
52
53 parser = optparse.OptionParser(usage=usage, description=description)
54 parser.format_description = format_description
55 credopts = options.CredentialsOptions(parser)
56 sambaopts = options.SambaOptions(parser)
57 parser.add_option_group(credopts)
58 parser.add_option_group(sambaopts)
59 try:
60     from subunit.run import TestProgram
61 except ImportError:
62     from unittest import TestProgram
63 else:
64     parser.add_option('-l', '--list', dest='listtests', default=False,
65                       help='List tests rather than running them.',
66                       action="store_true")
67
68 opts, args = parser.parse_args()
69
70 lp = sambaopts.get_loadparm()
71 samba.tests.cmdline_credentials = credopts.get_credentials(lp)
72 if getattr(opts, "listtests", False):
73     args.insert(0, "--list")
74
75 runner = SubunitTestRunner()
76 program = TestProgram(module=None, argv=[sys.argv[0]] + args, testRunner=runner)