1 files changed, 59 insertions, 0 deletions
diff --git a/src/test/java/com/google/devtools/build/skydoc/skydoc_test.bzl b/src/test/java/com/google/devtools/build/skydoc/skydoc_test.bzl
new file mode 100644
index 0000000000..f36e87744f
--- /dev/null
+++ b/src/test/java/com/google/devtools/build/skydoc/skydoc_test.bzl
@@ -0,0 +1,59 @@
+# Copyright 2018 The Bazel Authors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Convenience macro for skydoc tests. Each target represents two targets:
+# a shell test verifying the contents of the golden file, and a genrule
+# which will regenerate the golden file.
+"""Convenience macro for skydoc tests."""
+
+def skydoc_test(name, input_file, golden_file, skydoc):
+    """Creates a test target and golden-file regeneration target for skydoc testing.
+
+    The test target is named "{name}_e2e_test".
+    The golden-file regeneration target is named "regenerate_{name}_golden".
+
+    Args:
+      name: A unique name to qualify the created targets.
+      input_file: The label string of the skylark input file for which documentation is generated
+          in this test.
+      golden_file: The label string of the golden file containing the documentation when skydoc
+          is run on the input file.
+      skydoc: The label string of the skydoc binary.
+    """
+    output_golden_file = "%s_output.txt" % name
+    native.sh_test(
+        name = "%s_e2e_test" % name,
+        srcs = ["skydoc_e2e_test_runner.sh"],
+        args = [
+            "$(location %s)" % skydoc,
+            "$(location %s)" % input_file,
+            "$(location %s)" % golden_file,
+        ],
+        data = [
+            input_file,
+            golden_file,
+            skydoc,
+        ],
+    )
+
+    native.genrule(
+        name = "regenerate_%s_golden" % name,
+        srcs = [
+            input_file,
+        ],
+        outs = [output_golden_file],
+        cmd = "$(location %s) " % skydoc +
+              "$(location %s) $(location %s)" % (input_file, output_golden_file),
+        tools = [skydoc],
+    )