Add python tap runner to the tree

[babeltrace.git] / tests / utils / python / tap / main.py

diff --git a/tests/utils/python/tap/main.py b/tests/utils/python/tap/main.py
new file mode 100644 (file)
index 0000000..de2f012
--- /dev/null
+++ b/tests/utils/python/tap/main.py
@@ -0,0 +1,62 @@
+# Copyright (c) 2016, Matt Layman
+
+import argparse
+import sys
+import unittest
+
+from tap.i18n import _
+from tap.loader import Loader
+
+
+def main(argv=sys.argv, stream=sys.stderr):
+    """Entry point for ``tappy`` command."""
+    args = parse_args(argv)
+    suite = build_suite(args)
+    runner = unittest.TextTestRunner(verbosity=args.verbose, stream=stream)
+    result = runner.run(suite)
+
+    return get_status(result)
+
+
+def build_suite(args):
+    """Build a test suite by loading TAP files or a TAP stream."""
+    loader = Loader()
+    if len(args.files) == 0 or args.files[0] == '-':
+        suite = loader.load_suite_from_stdin()
+    else:
+        suite = loader.load(args.files)
+    return suite
+
+
+def parse_args(argv):
+    description = _('A TAP consumer for Python')
+    epilog = _(
+        'When no files are given or a dash (-) is used for the file name, '
+        'tappy will read a TAP stream from STDIN.')
+    parser = argparse.ArgumentParser(description=description, epilog=epilog)
+    parser.add_argument(
+        'files', metavar='FILE', nargs='*', help=_(
+            'A file containing TAP output. Any directories listed will be '
+            'scanned for files to include as TAP files.'))
+    parser.add_argument(
+        '-v', '--verbose', action='store_const', default=1, const=2,
+        help=_('use verbose messages'))
+
+    # argparse expects the executable to be removed from argv.
+    args = parser.parse_args(argv[1:])
+
+    # When no files are provided, the user wants to use a TAP stream on STDIN.
+    # But they probably didn't mean it if there is no pipe connected.
+    # In that case, print the help and exit.
+    if not args.files and sys.stdin.isatty():
+        sys.exit(parser.print_help())
+
+    return args
+
+
+def get_status(result):
+    """Get a return status from the result."""
+    if result.wasSuccessful():
+        return 0
+    else:
+        return 1