Refactored boilerplate in tests into a TaskTest class

Author: calcmogul

wpiformat/test/__init__.py

@@ -0,0 +1,3 @@
+import pytest
+
+pytest.register_assert_rewrite("test.tasktest")

wpiformat/test/tasktest.py

@@ -0,0 +1,97 @@
+"""This class is for writing unit tests for tasks."""
+
+from enum import Enum
+import io
+import os
+import sys
+
+from wpiformat.config import Config
+
+
+class OutputType(Enum):
+    FILE = 1
+    STDOUT = 2
+
+
+class TaskTest:
+
+    def __init__(self, task):
+        """Constructor for Test object.
+
+        Keyword arguments:
+        task -- task on which to run tests
+        """
+        self.task = task
+        self.inputs = []
+        self.outputs = []
+
+    def reset(self):
+        """Clears input and output lists."""
+        self.inputs = []
+        self.outputs = []
+
+    def add_input(self, file_name, contents):
+        """Adds the given file and its contents to the input list.
+
+        Keyword arguments:
+        file_name -- file name string
+        contents -- file contents string
+        """
+        self.inputs.append((file_name, contents))
+
+    def add_output(self, contents, contents_modified, succeeded):
+        """Adds the given file contents, whether they were modified from the
+        corresponding input, and whether processing of the input list was
+        successful.
+
+        Keyword arguments:
+        contents -- file contents string
+        contents_modified -- whether file contents were modified from the
+                             corresponding input
+        succeeded -- whether processing of the input list was successful
+        """
+        self.outputs.append((contents, contents_modified, succeeded))
+
+    def add_latest_input_as_output(self, succeeded):
+        """Adds the latest input to the output list.
+
+        Since the output matches its corresponding input, the contents_modified
+        flag is automatically set to False.
+
+        Keyword arguments:
+        succeeded -- whether processing of the input list was successful
+        """
+        self.add_output(self.inputs[len(self.inputs) - 1][1], False, succeeded)
+
+    def run(self, output_type):
+        """Runs the task on each input list element, then compares the resulting
+        output against the corresponding output list element.
+
+        output_type == FILE: output list contains file contents
+        output_type == STDOUT: output list contains stdout contents
+
+        Keyword Arguments:
+        output_type -- the type of output stored in the output list
+        """
+        assert len(self.inputs) == len(self.outputs)
+
+        config_file = Config(os.path.abspath(os.getcwd()), ".styleguide")
+
+        for i in range(len(self.inputs)):
+            if self.task.should_process_file(config_file, self.inputs[i][0]):
+                if output_type == OutputType.FILE:
+                    output, file_changed, success = self.task.run_pipeline(
+                        config_file, self.inputs[i][0], self.inputs[i][1])
+                elif output_type == OutputType.STDOUT:
+                    saved_stdout = sys.stdout
+                    sys.stdout = io.StringIO()
+                    _output, file_changed, success = self.task.run_pipeline(
+                        config_file, self.inputs[i][0], self.inputs[i][1])
+                    sys.stdout.seek(0)
+                    output = sys.stdout.read()
+                    sys.stdout = saved_stdout
+
+                print("Running test {}...".format(i))
+                assert output == self.outputs[i][0]
+                assert file_changed == self.outputs[i][1]
+                assert success == self.outputs[i][2]

wpiformat/test/test_bracecomment.py

@@ -1,59 +1,56 @@
 import os
 
-from wpiformat.config import Config
+from test.tasktest import *
 from wpiformat.bracecomment import BraceComment
 
 
 def test_bracecomment():
-    task = BraceComment()
-
-    inputs = []
-    outputs = []
+    test = TaskTest(BraceComment())
 
     # Empty anonymous namespace
-    inputs.append(("./Test.h",
+    test.add_input("./Test.h",
         "namespace {" + os.linesep + \
-        "}// comment" + os.linesep))
-    outputs.append((
+        "}// comment" + os.linesep)
+    test.add_output(
         "namespace {" + os.linesep + \
-        "}  // namespace" + os.linesep, True, True))
+        "}  // namespace" + os.linesep, True, True)
 
     # Anonymous namespace containing comment
-    inputs.append(("./Test.h",
+    test.add_input("./Test.h",
         "namespace {" + os.linesep + \
         "  // comment" + os.linesep + \
-        "}// comment" + os.linesep))
-    outputs.append((
+        "}// comment" + os.linesep)
+    test.add_output(
         "namespace {" + os.linesep + \
         "  // comment" + os.linesep + \
-        "}  // namespace" + os.linesep, True, True))
+        "}  // namespace" + os.linesep, True, True)
 
     # namespace
-    inputs.append(("./Test.h",
+    test.add_input("./Test.h",
         "namespace hal {" + os.linesep + \
         "  // comment" + os.linesep + \
-        "}// comment" + os.linesep))
-    outputs.append((
+        "}// comment" + os.linesep)
+    test.add_output(
         "namespace hal {" + os.linesep + \
         "  // comment" + os.linesep + \
-        "}  // namespace hal" + os.linesep, True, True))
+        "}  // namespace hal" + os.linesep, True, True)
 
     # namespace with leftover input
-    inputs.append(("./Test.h",
+    test.add_input("./Test.h",
         "// comment before namespace" + os.linesep + \
         "namespace hal {" + os.linesep + \
         "  // comment" + os.linesep + \
         "}// comment" + os.linesep + \
-        "// comment after namespace" + os.linesep))
-    outputs.append((
+        "// comment after namespace" + os.linesep)
+    test.add_output(
         "// comment before namespace" + os.linesep + \
         "namespace hal {" + os.linesep + \
         "  // comment" + os.linesep + \
         "}  // namespace hal" + os.linesep + \
-        "// comment after namespace" + os.linesep, True, True))
+        "// comment after namespace" + os.linesep, True, True)
 
     # Braces within namespace
-    inputs.append(("./Test.h",
+    test.add_input("./Test.h",
         "namespace {" + os.linesep + \
         os.linesep + \
         "struct AnalogGyro {" + os.linesep + \
@@ -63,8 +60,8 @@ def test_bracecomment():
         "  int32_t center;" + os.linesep + \
         "}" + os.linesep + \
         os.linesep + \
-        "}" + os.linesep))
-    outputs.append((
+        "}" + os.linesep)
+    test.add_output(
         "namespace {" + os.linesep + \
         os.linesep + \
         "struct AnalogGyro {" + os.linesep + \
@@ -74,76 +71,68 @@ def test_bracecomment():
         "  int32_t center;" + os.linesep + \
         "}" + os.linesep + \
         os.linesep + \
-        "}  // namespace" + os.linesep, True, True))
+        "}  // namespace" + os.linesep, True, True)
 
     # extern "C"
-    inputs.append(("./Test.h",
+    test.add_input("./Test.h",
         "extern \"C\" {" + os.linesep + \
         "    // nothing" + os.linesep + \
-        "}// comment" + os.linesep))
-    outputs.append((
+        "}// comment" + os.linesep)
+    test.add_output(
         "extern \"C\" {" + os.linesep + \
         "    // nothing" + os.linesep + \
-        "}  // extern \"C\"" + os.linesep, True, True))
+        "}  // extern \"C\"" + os.linesep, True, True)
 
     # Nested brackets should be handled properly
-    inputs.append(("./Test.cpp",
+    test.add_input("./Test.cpp",
         "extern \"C\" {" + os.linesep + \
         "void func() {" + os.linesep + \
         "  if (1) {" + os.linesep + \
         "  } else if (1) {" + os.linesep + \
         "  } else {" + os.linesep + \
         "  }" + os.linesep + \
         "}" + os.linesep + \
-        "}  // extern \"C\"" + os.linesep))
-    outputs.append((inputs[len(inputs) - 1][1], False, True))
+        "}  // extern \"C\"" + os.linesep)
+    test.add_latest_input_as_output(True)
 
     # Nested brackets on same line
-    inputs.append(("./Test.cpp",
+    test.add_input("./Test.cpp",
         "namespace wpi {" + os.linesep + \
         "{{}}" + os.linesep + \
-        "}  // namespace java" + os.linesep))
-    outputs.append((
+        "}  // namespace java" + os.linesep)
+    test.add_output(
         "namespace wpi {" + os.linesep + \
         "{{}}" + os.linesep + \
-        "}  // namespace wpi" + os.linesep, True, True))
+        "}  // namespace wpi" + os.linesep, True, True)
 
     # Handle single-line statements correctly
-    inputs.append(("./Test.cpp",
-                   "namespace hal { Type typeName; }" + os.linesep))
-    outputs.append(
-        ("namespace hal { Type typeName; }  // namespace hal" + os.linesep,
-         True, True))
+    test.add_input("./Test.cpp",
+                   "namespace hal { Type typeName; }" + os.linesep)
+    test.add_output(
+        "namespace hal { Type typeName; }  // namespace hal" + os.linesep, True,
+        True)
 
     # Two incorrect comments
-    inputs.append(("./Test.h",
+    test.add_input("./Test.h",
         "namespace {" + os.linesep + \
         "    // nothing" + os.linesep + \
         "}// comment" + os.linesep + \
         "namespace Name {" + os.linesep + \
         "    // nothing" + os.linesep + \
-        "}" + os.linesep))
-    outputs.append((
+        "}" + os.linesep)
+    test.add_output(
         "namespace {" + os.linesep + \
         "    // nothing" + os.linesep + \
         "}  // namespace" + os.linesep + \
         "namespace Name {" + os.linesep + \
         "    // nothing" + os.linesep + \
-        "}  // namespace Name" + os.linesep, True, True))
+        "}  // namespace Name" + os.linesep, True, True)
 
     # Don't touch correct comment
-    inputs.append(("./Test.h",
+    test.add_input("./Test.h",
         "namespace {" + os.linesep + \
         "    // nothing" + os.linesep + \
-        "}  // namespace" + os.linesep))
-    outputs.append((inputs[len(inputs) - 1][1], False, True))
-
-    assert len(inputs) == len(outputs)
+        "}  // namespace" + os.linesep)
+    test.add_latest_input_as_output(True)
 
-    config_file = Config(os.path.abspath(os.getcwd()), ".styleguide")
-    for i in range(len(inputs)):
-        output, file_changed, success = task.run_pipeline(
-            config_file, inputs[i][0], inputs[i][1])
-        assert output == outputs[i][0]
-        assert file_changed == outputs[i][1]
-        assert success == outputs[i][2]
+    test.run(OutputType.FILE)