lib/subunit/python/subunit/run.py

   1 #!/usr/bin/python
   2 #
   3 # Simple subunit testrunner for python
   4 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007
   5 #
   6 #  Licensed under either the Apache License, Version 2.0 or the BSD 3-clause
   7 #  license at the users choice. A copy of both licenses are available in the
   8 #  project source as Apache-2.0 and BSD. You may not use this file except in
   9 #  compliance with one of these two licences.
  10 #
  11 #  Unless required by applicable law or agreed to in writing, software
  12 #  distributed under these licenses is distributed on an "AS IS" BASIS, WITHOUT
  13 #  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
  14 #  license you chose for the specific language governing permissions and
  15 #  limitations under that license.
  16 #
  17
  18 """Run a unittest testcase reporting results as Subunit.
  19
  20   $ python -m subunit.run mylib.tests.test_suite
  21 """
  22
  23 import sys
  24
  25 from subunit import TestProtocolClient, get_default_formatter
  26 from subunit.test_results import AutoTimingTestResultDecorator
  27 from testtools.run import (
  28     BUFFEROUTPUT,
  29     CATCHBREAK,
  30     FAILFAST,
  31     TestProgram,
  32     USAGE_AS_MAIN,
  33     )
  34
  35
  36 class SubunitTestRunner(object):
  37     def __init__(self, stream=sys.stdout):
  38         self.stream = stream
  39
  40     def run(self, test):
  41         "Run the given test case or test suite."
  42         result = TestProtocolClient(self.stream)
  43         result = AutoTimingTestResultDecorator(result)
  44         test(result)
  45         return result
  46
  47
  48 class SubunitTestProgram(TestProgram):
  49
  50     USAGE = USAGE_AS_MAIN
  51
  52     def usageExit(self, msg=None):
  53         if msg:
  54             print (msg)
  55         usage = {'progName': self.progName, 'catchbreak': '', 'failfast': '',
  56                  'buffer': ''}
  57         if self.failfast != False:
  58             usage['failfast'] = FAILFAST
  59         if self.catchbreak != False:
  60             usage['catchbreak'] = CATCHBREAK
  61         if self.buffer != False:
  62             usage['buffer'] = BUFFEROUTPUT
  63         usage_text = self.USAGE % usage
  64         usage_lines = usage_text.split('\n')
  65         usage_lines.insert(2, "Run a test suite with a subunit reporter.")
  66         usage_lines.insert(3, "")
  67         print('\n'.join(usage_lines))
  68         sys.exit(2)
  69
  70
  71 if __name__ == '__main__':
  72     stream = get_default_formatter()
  73     runner = SubunitTestRunner(stream)
  74     SubunitTestProgram(module=None, argv=sys.argv, testRunner=runner,
  75         stdout=sys.stdout)