Add flags to Stardoc to allow templates as inputs
PiperOrigin-RevId: 258972534
diff --git a/src/main/java/com/google/devtools/build/skydoc/SkydocMain.java b/src/main/java/com/google/devtools/build/skydoc/SkydocMain.java
index b5e1df1..2c3cc61 100644
--- a/src/main/java/com/google/devtools/build/skydoc/SkydocMain.java
+++ b/src/main/java/com/google/devtools/build/skydoc/SkydocMain.java
@@ -163,6 +163,14 @@
private final SkylarkFileAccessor fileAccessor;
private final List<String> depRoots;
private final String workspaceName;
+ private static final String HEADER_TEMPLATE_PATH =
+ "com/google/devtools/build/skydoc/rendering/templates/header.vm";
+ private static final String RULE_TEMPLATE_PATH =
+ "com/google/devtools/build/skydoc/rendering/templates/rule.vm";
+ private static final String PROVIDER_TEMPLATE_PATH =
+ "com/google/devtools/build/skydoc/rendering/templates/provider.vm";
+ private static final String FUNCTION_TEMPLATE_PATH =
+ "com/google/devtools/build/skydoc/rendering/templates/func.vm";
public SkydocMain(SkylarkFileAccessor fileAccessor, String workspaceName, List<String> depRoots) {
this.fileAccessor = fileAccessor;
@@ -246,7 +254,12 @@
.writeModuleInfo(out);
}
} else if (skydocOptions.outputFormat == OutputFormat.MARKDOWN) {
- MarkdownRenderer renderer = new MarkdownRenderer();
+ MarkdownRenderer renderer =
+ new MarkdownRenderer(
+ HEADER_TEMPLATE_PATH,
+ RULE_TEMPLATE_PATH,
+ PROVIDER_TEMPLATE_PATH,
+ FUNCTION_TEMPLATE_PATH);
try (PrintWriter printWriter = new PrintWriter(outputPath, "UTF-8")) {
printWriter.println(renderer.renderMarkdownHeader());
printRuleInfos(printWriter, renderer, filteredRuleInfos);
diff --git a/src/main/java/com/google/devtools/build/skydoc/renderer/RendererMain.java b/src/main/java/com/google/devtools/build/skydoc/renderer/RendererMain.java
index 6055cb2..ce17b66 100644
--- a/src/main/java/com/google/devtools/build/skydoc/renderer/RendererMain.java
+++ b/src/main/java/com/google/devtools/build/skydoc/renderer/RendererMain.java
@@ -46,7 +46,14 @@
String inputPath = rendererOptions.inputPath;
String outputPath = rendererOptions.outputFilePath;
- MarkdownRenderer renderer = new MarkdownRenderer();
+ String headerTemplatePath = rendererOptions.headerTemplateFilePath;
+ String ruleTemplatePath = rendererOptions.ruleTemplateFilePath;
+ String providerTemplatePath = rendererOptions.providerTemplateFilePath;
+ String funcTemplatePath = rendererOptions.funcTemplateFilePath;
+
+ MarkdownRenderer renderer =
+ new MarkdownRenderer(
+ headerTemplatePath, ruleTemplatePath, providerTemplatePath, funcTemplatePath);
try (PrintWriter printWriter = new PrintWriter(outputPath, "UTF-8")) {
ModuleInfo moduleInfo = ModuleInfo.parseFrom(new FileInputStream(inputPath));
printWriter.println(renderer.renderMarkdownHeader());
diff --git a/src/main/java/com/google/devtools/build/skydoc/renderer/RendererOptions.java b/src/main/java/com/google/devtools/build/skydoc/renderer/RendererOptions.java
index a83ccc7..b4f3a6b 100644
--- a/src/main/java/com/google/devtools/build/skydoc/renderer/RendererOptions.java
+++ b/src/main/java/com/google/devtools/build/skydoc/renderer/RendererOptions.java
@@ -37,4 +37,44 @@
effectTags = OptionEffectTag.UNKNOWN,
help = "The path of the file to output documentation into")
public String outputFilePath;
+
+ @Option(
+ name = "header_template",
+ defaultValue = "com/google/devtools/build/skydoc/rendering/templates/header.vm",
+ documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
+ effectTags = OptionEffectTag.UNKNOWN,
+ help =
+ "The template for the header string. If the option is unspecified,"
+ + " a default markdown output template will be used.")
+ public String headerTemplateFilePath;
+
+ @Option(
+ name = "rule_template",
+ defaultValue = "com/google/devtools/build/skydoc/rendering/templates/rule.vm",
+ documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
+ effectTags = OptionEffectTag.UNKNOWN,
+ help =
+ "The template for the documentation of a rule. If the option is unspecified, a"
+ + " default markdown output template will be used.")
+ public String ruleTemplateFilePath;
+
+ @Option(
+ name = "provider_template",
+ defaultValue = "com/google/devtools/build/skydoc/rendering/templates/provider.vm",
+ documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
+ effectTags = OptionEffectTag.UNKNOWN,
+ help =
+ "The template for the documentation of a provider. If the option is"
+ + " unspecified, a default markdown output template will be used.")
+ public String providerTemplateFilePath;
+
+ @Option(
+ name = "func_template",
+ defaultValue = "com/google/devtools/build/skydoc/rendering/templates/func.vm",
+ documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
+ effectTags = OptionEffectTag.UNKNOWN,
+ help =
+ "The template for the documentation of a function. If the option is"
+ + " unspecified, a default markdown output template will be used.")
+ public String funcTemplateFilePath;
}
diff --git a/src/main/java/com/google/devtools/build/skydoc/rendering/MarkdownRenderer.java b/src/main/java/com/google/devtools/build/skydoc/rendering/MarkdownRenderer.java
index c6f8f2a..1bbbe5c 100644
--- a/src/main/java/com/google/devtools/build/skydoc/rendering/MarkdownRenderer.java
+++ b/src/main/java/com/google/devtools/build/skydoc/rendering/MarkdownRenderer.java
@@ -32,18 +32,23 @@
*/
public class MarkdownRenderer {
- private static final String HEADER_TEMPLATE_FILENAME =
- "com/google/devtools/build/skydoc/rendering/templates/header.vm";
- private static final String RULE_TEMPLATE_FILENAME =
- "com/google/devtools/build/skydoc/rendering/templates/rule.vm";
- private static final String PROVIDER_TEMPLATE_FILENAME =
- "com/google/devtools/build/skydoc/rendering/templates/provider.vm";
- private static final String FUNCTION_TEMPLATE_FILENAME =
- "com/google/devtools/build/skydoc/rendering/templates/func.vm";
+ private final String headerTemplateFilename;
+ private final String ruleTemplateFilename;
+ private final String providerTemplateFilename;
+ private final String functionTemplateFilename;
private final VelocityEngine velocityEngine;
- public MarkdownRenderer() {
+ public MarkdownRenderer(
+ String headerTemplate,
+ String ruleTemplate,
+ String providerTemplate,
+ String functionTemplate) {
+ this.headerTemplateFilename = headerTemplate;
+ this.ruleTemplateFilename = ruleTemplate;
+ this.providerTemplateFilename = providerTemplate;
+ this.functionTemplateFilename = functionTemplate;
+
this.velocityEngine = new VelocityEngine();
velocityEngine.setProperty("resource.loader", "classpath, jar");
velocityEngine.setProperty("classpath.resource.loader.class",
@@ -62,7 +67,7 @@
StringWriter stringWriter = new StringWriter();
try {
velocityEngine.mergeTemplate(
- HEADER_TEMPLATE_FILENAME, "UTF-8", new VelocityContext(), stringWriter);
+ headerTemplateFilename, "UTF-8", new VelocityContext(), stringWriter);
} catch (ResourceNotFoundException | ParseErrorException | MethodInvocationException e) {
throw new IOException(e);
}
@@ -81,7 +86,7 @@
StringWriter stringWriter = new StringWriter();
try {
- velocityEngine.mergeTemplate(RULE_TEMPLATE_FILENAME, "UTF-8", context, stringWriter);
+ velocityEngine.mergeTemplate(ruleTemplateFilename, "UTF-8", context, stringWriter);
} catch (ResourceNotFoundException | ParseErrorException | MethodInvocationException e) {
throw new IOException(e);
}
@@ -100,7 +105,7 @@
StringWriter stringWriter = new StringWriter();
try {
- velocityEngine.mergeTemplate(PROVIDER_TEMPLATE_FILENAME, "UTF-8", context, stringWriter);
+ velocityEngine.mergeTemplate(providerTemplateFilename, "UTF-8", context, stringWriter);
} catch (ResourceNotFoundException | ParseErrorException | MethodInvocationException e) {
throw new IOException(e);
}
@@ -118,7 +123,7 @@
StringWriter stringWriter = new StringWriter();
try {
- velocityEngine.mergeTemplate(FUNCTION_TEMPLATE_FILENAME, "UTF-8", context, stringWriter);
+ velocityEngine.mergeTemplate(functionTemplateFilename, "UTF-8", context, stringWriter);
} catch (ResourceNotFoundException | ParseErrorException | MethodInvocationException e) {
throw new IOException(e);
}
diff --git a/src/test/java/com/google/devtools/build/skydoc/BUILD b/src/test/java/com/google/devtools/build/skydoc/BUILD
index 050190d..26897ba 100644
--- a/src/test/java/com/google/devtools/build/skydoc/BUILD
+++ b/src/test/java/com/google/devtools/build/skydoc/BUILD
@@ -14,11 +14,21 @@
visibility = ["//src:__pkg__"],
)
+filegroup(
+ name = "test_template_files",
+ srcs = [
+ "//src/test/java/com/google/devtools/build/skydoc:test_templates/func.vm",
+ "//src/test/java/com/google/devtools/build/skydoc:test_templates/header.vm",
+ "//src/test/java/com/google/devtools/build/skydoc:test_templates/provider.vm",
+ "//src/test/java/com/google/devtools/build/skydoc:test_templates/rule.vm",
+ ],
+ tags = ["bazel"],
+)
+
java_test(
name = "SkydocTest",
size = "medium",
srcs = ["SkydocTest.java"],
- shard_count = 1,
visibility = ["//devtools/blaze/main:__pkg__"],
deps = [
"//src/main/java/com/google/devtools/build/lib:skylark_semantics",
@@ -37,6 +47,23 @@
],
)
+java_test(
+ name = "MarkdownRendererTest",
+ srcs = ["MarkdownRendererTest.java"],
+ resources = [
+ ":test_template_files",
+ ],
+ visibility = ["//devtools/blaze/main:__pkg__"],
+ deps = [
+ "//src/main/java/com/google/devtools/build/skydoc/rendering",
+ "//src/main/java/com/google/devtools/build/skydoc/rendering/proto:stardoc_output_java_proto",
+ "//src/test/java/com/google/devtools/build/lib:testutil",
+ "//src/test/java/com/google/devtools/build/lib/skylark:testutil",
+ "//third_party:junit4",
+ "//third_party:truth",
+ ],
+)
+
skydoc_test(
name = "proto_format_test",
format = "proto",
diff --git a/src/test/java/com/google/devtools/build/skydoc/MarkdownRendererTest.java b/src/test/java/com/google/devtools/build/skydoc/MarkdownRendererTest.java
new file mode 100644
index 0000000..2bf849a
--- /dev/null
+++ b/src/test/java/com/google/devtools/build/skydoc/MarkdownRendererTest.java
@@ -0,0 +1,153 @@
+// Copyright 2019 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.
+
+package com.google.devtools.build.skydoc;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import com.google.devtools.build.skydoc.rendering.MarkdownRenderer;
+import com.google.devtools.build.skydoc.rendering.proto.StardocOutputProtos.AttributeInfo;
+import com.google.devtools.build.skydoc.rendering.proto.StardocOutputProtos.AttributeType;
+import com.google.devtools.build.skydoc.rendering.proto.StardocOutputProtos.FunctionParamInfo;
+import com.google.devtools.build.skydoc.rendering.proto.StardocOutputProtos.ProviderFieldInfo;
+import com.google.devtools.build.skydoc.rendering.proto.StardocOutputProtos.ProviderInfo;
+import com.google.devtools.build.skydoc.rendering.proto.StardocOutputProtos.RuleInfo;
+import com.google.devtools.build.skydoc.rendering.proto.StardocOutputProtos.UserDefinedFunctionInfo;
+import java.io.IOException;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+/** Java tests for MarkdownRenderer */
+@RunWith(JUnit4.class)
+public final class MarkdownRendererTest {
+
+ private final String headerTemplatePath =
+ "com/google/devtools/build/skydoc/test_templates/header.vm";
+ private final String ruleTemplatePath = "com/google/devtools/build/skydoc/test_templates/rule.vm";
+ private final String providerTemplatePath =
+ "com/google/devtools/build/skydoc/test_templates/provider.vm";
+ private final String funcTemplatePath = "com/google/devtools/build/skydoc/test_templates/func.vm";
+ private final MarkdownRenderer renderer =
+ new MarkdownRenderer(
+ headerTemplatePath, ruleTemplatePath, providerTemplatePath, funcTemplatePath);
+
+ @Test
+ public void testHeaderStrings() throws IOException {
+ assertThat(renderer.renderMarkdownHeader())
+ .isEqualTo("<!-- Generated with Stardoc: http://skydoc.bazel.build -->\n");
+ }
+
+ @Test
+ public void testRuleStrings() throws IOException {
+ AttributeInfo attrInfo =
+ AttributeInfo.newBuilder()
+ .setName("first")
+ .setDocString("the first attribute")
+ .setTypeValue(AttributeType.STRING.getNumber())
+ .build();
+ RuleInfo ruleInfo =
+ RuleInfo.newBuilder()
+ .setRuleName("my_rule")
+ .setDocString("This rule does things.")
+ .addAttribute(attrInfo)
+ .build();
+
+ assertThat(renderer.render(ruleInfo.getRuleName(), ruleInfo))
+ .isEqualTo(
+ "<a name=\"#my_rule\"></a>\n"
+ + "\n"
+ + "## my_rule\n"
+ + "\n"
+ + "<pre>\n"
+ + "my_rule(<a href=\"#my_rule-first\">first</a>)\n"
+ + "</pre>\n"
+ + "\n"
+ + "This rule does things.\n"
+ + "\n"
+ + "### Attributes\n"
+ + "\n"
+ + " <code>first</code>\n"
+ + " String; optional\n"
+ + " <p>\n"
+ + " the first attribute\n"
+ + " </p>\n");
+ }
+
+ @Test
+ public void testProviderStrings() throws IOException {
+ ProviderFieldInfo fieldInfo =
+ ProviderFieldInfo.newBuilder().setName("one").setDocString("the first field").build();
+ ProviderInfo providerInfo =
+ ProviderInfo.newBuilder()
+ .setProviderName("my_provider")
+ .setDocString("This provider does things.")
+ .addFieldInfo(fieldInfo)
+ .build();
+
+ assertThat(renderer.render(providerInfo.getProviderName(), providerInfo))
+ .isEqualTo(
+ "<a name=\"#my_provider\"></a>\n"
+ + "\n"
+ + "## my_provider\n"
+ + "\n"
+ + "<pre>\n"
+ + "my_provider(<a href=\"#my_provider-one\">one</a>)\n"
+ + "</pre>\n"
+ + "\n"
+ + "This provider does things.\n"
+ + "\n"
+ + "### Fields\n"
+ + "\n"
+ + "<code>one</code><\n"
+ + "<p>the first field</p>\n"
+ + "\n");
+ }
+
+ @Test
+ public void testFunctionStrings() throws IOException {
+ FunctionParamInfo paramInfo =
+ FunctionParamInfo.newBuilder()
+ .setName("param1")
+ .setDocString("the first parameter")
+ .setDefaultValue("32")
+ .build();
+ UserDefinedFunctionInfo funcInfo =
+ UserDefinedFunctionInfo.newBuilder()
+ .setFunctionName("my_function")
+ .setDocString("This function does something.")
+ .addParameter(paramInfo)
+ .build();
+
+ assertThat(renderer.render(funcInfo))
+ .isEqualTo(
+ "<a name=\"#my_function\"></a>\n"
+ + "\n"
+ + "## my_function\n"
+ + "\n"
+ + "<pre>\n"
+ + "my_function(<a href=\"#my_function-param1\">param1</a>)\n"
+ + "</pre>\n"
+ + "\n"
+ + "This function does something.\n"
+ + "\n"
+ + "### Parameters\n"
+ + "\n"
+ + " <code>param1</code>\n"
+ + " optional. default is <code>32</code>\n"
+ + " <p>\n"
+ + " the first parameter\n"
+ + " </p>\n");
+ }
+}
diff --git a/src/test/java/com/google/devtools/build/skydoc/test_templates/func.vm b/src/test/java/com/google/devtools/build/skydoc/test_templates/func.vm
new file mode 100644
index 0000000..e1db0a9
--- /dev/null
+++ b/src/test/java/com/google/devtools/build/skydoc/test_templates/func.vm
@@ -0,0 +1,24 @@
+<a name="#${funcInfo.functionName}"></a>
+
+#[[##]]# ${funcInfo.functionName}
+
+<pre>
+${util.funcSummary($funcInfo)}
+</pre>
+
+${funcInfo.docString}
+
+#if (!$funcInfo.getParameterList().isEmpty())
+#[[###]]# Parameters
+
+#foreach ($param in $funcInfo.getParameterList())
+ <code>${param.name}</code>
+ ${util.mandatoryString($param)}.#if(!$param.getDefaultValue().isEmpty()) default is <code>$param.getDefaultValue()</code>#end
+
+#if (!$param.docString.isEmpty())
+ <p>
+ ${param.docString.trim()}
+ </p>
+#end
+#end
+#end
diff --git a/src/test/java/com/google/devtools/build/skydoc/test_templates/header.vm b/src/test/java/com/google/devtools/build/skydoc/test_templates/header.vm
new file mode 100644
index 0000000..187680d
--- /dev/null
+++ b/src/test/java/com/google/devtools/build/skydoc/test_templates/header.vm
@@ -0,0 +1 @@
+<!-- Generated with Stardoc: http://skydoc.bazel.build -->
diff --git a/src/test/java/com/google/devtools/build/skydoc/test_templates/provider.vm b/src/test/java/com/google/devtools/build/skydoc/test_templates/provider.vm
new file mode 100644
index 0000000..5f62b73
--- /dev/null
+++ b/src/test/java/com/google/devtools/build/skydoc/test_templates/provider.vm
@@ -0,0 +1,19 @@
+<a name="#${providerName}"></a>
+
+#[[##]]# ${providerName}
+
+<pre>
+${util.providerSummary($providerName, $providerInfo)}
+</pre>
+
+${providerInfo.docString}
+
+#if (!$providerInfo.fieldInfoList.isEmpty())
+#[[###]]# Fields
+
+#foreach ($field in $providerInfo.fieldInfoList)
+<code>${field.name}</code><
+<p>${field.docString}</p>
+
+#end
+#end
diff --git a/src/test/java/com/google/devtools/build/skydoc/test_templates/rule.vm b/src/test/java/com/google/devtools/build/skydoc/test_templates/rule.vm
new file mode 100644
index 0000000..241cf55
--- /dev/null
+++ b/src/test/java/com/google/devtools/build/skydoc/test_templates/rule.vm
@@ -0,0 +1,23 @@
+<a name="#${ruleName}"></a>
+
+#[[##]]# ${ruleName}
+
+<pre>
+${util.ruleSummary($ruleName, $ruleInfo)}
+</pre>
+
+${ruleInfo.docString}
+
+#[[###]]# Attributes
+
+#if (!$ruleInfo.getAttributeList().isEmpty())
+#foreach ($attribute in $ruleInfo.getAttributeList())
+ <code>${attribute.name}</code>
+ ${util.attributeTypeString($attribute)}; ${util.mandatoryString($attribute)}
+#if (!$attribute.docString.isEmpty())
+ <p>
+ ${attribute.docString.trim()}
+ </p>
+#end
+#end
+#end
\ No newline at end of file
