1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
// Copyright 2015 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.docgen;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import com.google.common.base.Joiner;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.docgen.testutil.TestData.TestRule;
import com.google.devtools.build.lib.analysis.ConfiguredRuleClassProvider;
import com.google.devtools.build.lib.testutil.TestRuleClassProvider;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
/**
* A test class for RuleDocumentation.
*/
@RunWith(JUnit4.class)
public class RuleDocumentationTest {
private static final ImmutableSet<String> NO_FLAGS = ImmutableSet.<String>of();
private static final ConfiguredRuleClassProvider provider =
TestRuleClassProvider.getRuleClassProvider();
private static void assertContains(String base, String value) {
assertTrue(base + " is expected to contain " + value, base.contains(value));
}
private void checkAttributeForRule(RuleDocumentation rule, RuleDocumentationAttribute attr,
boolean isCommonAttribute) {
rule.addAttribute(attr);
String signature = rule.getAttributeSignature();
StringBuilder sb = new StringBuilder();
if (isCommonAttribute) {
sb.append("<a href=\"common-definitions.html#");
} else {
sb.append("<a href=\"#");
}
sb.append(attr.getGeneratedInRule(rule.getRuleName())).append(".");
sb.append(attr.getAttributeName()).append("\">").append(attr.getAttributeName()).append("</a>");
assertContains(signature, sb.toString());
}
@Test
public void testVariableSubstitution() throws BuildEncyclopediaDocException {
RuleDocumentation ruleDoc = new RuleDocumentation(
"rule", "OTHER", "FOO", Joiner.on("\n").join(new String[] {
"x",
"${VAR}",
"z"}),
0, "", ImmutableSet.<String>of(), provider);
ruleDoc.addDocVariable("VAR", "y");
assertEquals("x\ny\nz", ruleDoc.getHtmlDocumentation());
}
@Test
public void testSignatureContainsCommonAttribute() throws Exception {
RuleDocumentationAttribute licensesAttr = RuleDocumentationAttribute.create(
"licenses", "common", "attribute doc");
checkAttributeForRule(
new RuleDocumentation(
"java_binary", "BINARY", "JAVA", "", 0, "", ImmutableSet.<String>of(), provider),
licensesAttr, true);
}
@Test
public void testInheritedAttributeGeneratesSignature() throws Exception {
RuleDocumentationAttribute runtimeDepsAttr = RuleDocumentationAttribute.create(TestRule.class,
"runtime_deps", "attribute doc", 0, "", NO_FLAGS);
checkAttributeForRule(
new RuleDocumentation(
"java_binary", "BINARY", "JAVA", "", 0, "", ImmutableSet.<String>of(), provider),
runtimeDepsAttr, false);
checkAttributeForRule(
new RuleDocumentation(
"java_library", "LIBRARY", "JAVA", "", 0, "", ImmutableSet.<String>of(), provider),
runtimeDepsAttr, false);
}
@Test
public void testRuleDocFlagSubstitution() throws BuildEncyclopediaDocException {
RuleDocumentation ruleDoc = new RuleDocumentation(
"rule", "OTHER", "FOO", "x", 0, "", ImmutableSet.<String>of("DEPRECATED"), provider);
ruleDoc.addDocVariable("VAR", "y");
assertEquals("x", ruleDoc.getHtmlDocumentation());
}
@Test
public void testCommandLineDocumentation() throws BuildEncyclopediaDocException {
RuleDocumentation ruleDoc = new RuleDocumentation(
"foo_binary", "OTHER", "FOO", Joiner.on("\n").join(new String[] {
"x",
"y",
"z",
"${VAR}"}),
0, "", ImmutableSet.<String>of(), provider);
ruleDoc.addDocVariable("VAR", "w");
RuleDocumentationAttribute attributeDoc = RuleDocumentationAttribute.create(TestRule.class,
"srcs", "attribute doc", 0, "", NO_FLAGS);
ruleDoc.addAttribute(attributeDoc);
assertEquals("\nx\ny\nz\n\n", ruleDoc.getCommandLineDocumentation());
}
@Test
public void testExtractExamples() throws BuildEncyclopediaDocException {
RuleDocumentation ruleDoc = new RuleDocumentation(
"rule", "OTHER", "FOO", Joiner.on("\n").join(new String[] {
"x",
"<!-- #BLAZE_RULE.EXAMPLE -->",
"a",
"<!-- #BLAZE_RULE.END_EXAMPLE -->",
"y",
"<!-- #BLAZE_RULE.EXAMPLE -->",
"b",
"<!-- #BLAZE_RULE.END_EXAMPLE -->",
"z"}),
0, "", ImmutableSet.<String>of(), provider);
assertEquals(ImmutableSet.<String>of("a\n", "b\n"), ruleDoc.extractExamples());
}
@Test
public void testCreateExceptions() throws BuildEncyclopediaDocException {
RuleDocumentation ruleDoc = new RuleDocumentation(
"foo_binary", "OTHER", "FOO", "", 10, "foo.txt", NO_FLAGS, provider);
BuildEncyclopediaDocException e = ruleDoc.createException("msg");
assertEquals("Error in foo.txt:10: msg", e.getMessage());
}
@Test
public void testEquals() throws BuildEncyclopediaDocException {
assertEquals(
new RuleDocumentation("rule", "OTHER", "FOO", "x", 0, "", NO_FLAGS, provider),
new RuleDocumentation("rule", "OTHER", "FOO", "y", 0, "", NO_FLAGS, provider));
}
@Test
public void testNotEquals() throws BuildEncyclopediaDocException {
assertFalse(
new RuleDocumentation("rule1", "OTHER", "FOO", "x", 0, "", NO_FLAGS, provider).equals(
new RuleDocumentation("rule2", "OTHER", "FOO", "y", 0, "", NO_FLAGS, provider)));
}
@Test
public void testCompareTo() throws BuildEncyclopediaDocException {
assertEquals(-1,
new RuleDocumentation("rule1", "OTHER", "FOO", "x", 0, "", NO_FLAGS, provider).compareTo(
new RuleDocumentation("rule2", "OTHER", "FOO", "x", 0, "", NO_FLAGS, provider)));
}
@Test
public void testHashCode() throws BuildEncyclopediaDocException {
assertEquals(
new RuleDocumentation("rule", "OTHER", "FOO", "x", 0, "", NO_FLAGS, provider).hashCode(),
new RuleDocumentation("rule", "OTHER", "FOO", "y", 0, "", NO_FLAGS, provider).hashCode());
}
}
|
