Add python tap runner to the tree

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

diff --git a/tests/utils/python/tap/loader.py b/tests/utils/python/tap/loader.py
new file mode 100644 (file)
index 0000000..d758690
--- /dev/null
+++ b/tests/utils/python/tap/loader.py
@@ -0,0 +1,90 @@
+# Copyright (c) 2016, Matt Layman
+
+import os
+import unittest
+
+from tap.adapter import Adapter
+from tap.parser import Parser
+from tap.rules import Rules
+
+
+class Loader(object):
+    """Load TAP lines into unittest-able objects."""
+
+    ignored_lines = set(['diagnostic', 'unknown'])
+
+    def __init__(self):
+        self._parser = Parser()
+
+    def load(self, files):
+        """Load any files found into a suite.
+
+        Any directories are walked and their files are added as TAP files.
+
+        :returns: A ``unittest.TestSuite`` instance
+        """
+        suite = unittest.TestSuite()
+        for filepath in files:
+            if os.path.isdir(filepath):
+                self._find_tests_in_directory(filepath, suite)
+            else:
+                suite.addTest(self.load_suite_from_file(filepath))
+        return suite
+
+    def load_suite_from_file(self, filename):
+        """Load a test suite with test lines from the provided TAP file.
+
+        :returns: A ``unittest.TestSuite`` instance
+        """
+        suite = unittest.TestSuite()
+        rules = Rules(filename, suite)
+
+        if not os.path.exists(filename):
+            rules.handle_file_does_not_exist()
+            return suite
+
+        line_generator = self._parser.parse_file(filename)
+        return self._load_lines(filename, line_generator, suite, rules)
+
+    def load_suite_from_stdin(self):
+        """Load a test suite with test lines from the TAP stream on STDIN.
+
+        :returns: A ``unittest.TestSuite`` instance
+        """
+        suite = unittest.TestSuite()
+        rules = Rules('stream', suite)
+        line_generator = self._parser.parse_stdin()
+        return self._load_lines('stream', line_generator, suite, rules)
+
+    def _find_tests_in_directory(self, directory, suite):
+        """Find test files in the directory and add them to the suite."""
+        for dirpath, dirnames, filenames in os.walk(directory):
+            for filename in filenames:
+                filepath = os.path.join(dirpath, filename)
+                suite.addTest(self.load_suite_from_file(filepath))
+
+    def _load_lines(self, filename, line_generator, suite, rules):
+        """Load a suite with lines produced by the line generator."""
+        line_counter = 0
+        for line in line_generator:
+            line_counter += 1
+
+            if line.category in self.ignored_lines:
+                continue
+
+            if line.category == 'test':
+                suite.addTest(Adapter(filename, line))
+                rules.saw_test()
+            elif line.category == 'plan':
+                if line.skip:
+                    rules.handle_skipping_plan(line)
+                    return suite
+                rules.saw_plan(line, line_counter)
+            elif line.category == 'bail':
+                rules.handle_bail(line)
+                return suite
+            elif line.category == 'version':
+                rules.saw_version_at(line_counter)
+
+        rules.check(line_counter)
+        return suite