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
172
173
|
// 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 com.google.common.truth.Truth.assertThat;
import static com.google.common.truth.Truth.assertWithMessage;
import com.google.common.base.Function;
import com.google.common.collect.Iterables;
import com.google.devtools.build.docgen.skylark.SkylarkBuiltinMethodDoc;
import com.google.devtools.build.docgen.skylark.SkylarkJavaMethodDoc;
import com.google.devtools.build.docgen.skylark.SkylarkModuleDoc;
import com.google.devtools.build.lib.rules.SkylarkRuleContext;
import com.google.devtools.build.lib.skylark.util.SkylarkTestCase;
import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
import com.google.devtools.build.lib.syntax.Environment;
import com.google.devtools.build.lib.syntax.util.EvaluationTestCase;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.TreeMap;
/**
* Tests for Skylark documentation.
*/
@RunWith(JUnit4.class)
public class SkylarkDocumentationTest extends SkylarkTestCase {
@Before
public final void createBuildFile() throws Exception {
scratch.file("foo/BUILD",
"genrule(name = 'foo',",
" cmd = 'dummy_cmd',",
" srcs = ['a.txt', 'b.img'],",
" tools = ['t.exe'],",
" outs = ['c.txt'])");
}
@Override
protected EvaluationTestCase createEvaluationTestCase() {
return new EvaluationTestCase();
}
@Test
public void testSkylarkRuleClassBuiltInItemsAreDocumented() throws Exception {
checkSkylarkTopLevelEnvItemsAreDocumented(ev.getEnvironment());
}
@Test
public void testSkylarkRuleImplementationBuiltInItemsAreDocumented() throws Exception {
// TODO(bazel-team): fix documentation for built in java objects coming from modules.
checkSkylarkTopLevelEnvItemsAreDocumented(ev.getEnvironment());
}
@SuppressWarnings("unchecked")
private void checkSkylarkTopLevelEnvItemsAreDocumented(Environment env) {
Map<String, String> docMap = new HashMap<>();
Map<String, SkylarkModuleDoc> modules = SkylarkDocumentationCollector.collectModules();
SkylarkModuleDoc topLevel =
modules.remove(SkylarkDocumentationCollector.getTopLevelModule().name());
for (Entry<String, SkylarkBuiltinMethodDoc> entry : topLevel.getBuiltinMethods().entrySet()) {
docMap.put(entry.getKey(), entry.getValue().getDocumentation());
}
for (Entry<String, SkylarkModuleDoc> entry : modules.entrySet()) {
docMap.put(entry.getKey(), entry.getValue().getDocumentation());
}
List<String> undocumentedItems = new ArrayList<>();
// All built in variables are registered in the Skylark global environment.
for (String varname : env.getVariableNames()) {
if (docMap.containsKey(varname)) {
if (docMap.get(varname).isEmpty()) {
undocumentedItems.add(varname);
}
} else {
undocumentedItems.add(varname);
}
}
assertWithMessage("Undocumented Skylark Environment items: " + undocumentedItems)
.that(undocumentedItems).isEmpty();
}
// TODO(bazel-team): come up with better Skylark specific tests.
@Test
public void testDirectJavaMethodsAreGenerated() throws Exception {
assertThat(collect(SkylarkRuleContext.class)).isNotEmpty();
}
@SkylarkModule(name = "MockClassA", doc = "")
public static class MockClassA {
@SkylarkCallable(doc = "")
public Integer get() {
return 0;
}
}
@SkylarkModule(name = "MockClassB", doc = "")
public static class MockClassB {
@SkylarkCallable(doc = "")
public MockClassA get() {
return new MockClassA();
}
}
@SkylarkModule(name = "MockClassC", doc = "")
public static class MockClassC extends MockClassA {
@SkylarkCallable(doc = "")
public Integer get2() {
return 0;
}
}
@Test
public void testSkylarkJavaInterfaceExplorerOnSimpleClass() throws Exception {
Map<String, SkylarkModuleDoc> objects = collect(MockClassA.class);
assertThat(extractMethods(Iterables.getOnlyElement(objects.values())
.getJavaMethods())).containsExactly(MockClassA.class.getMethod("get"));
}
@Test
public void testSkylarkJavaInterfaceExplorerFindsClassFromReturnValue() throws Exception {
Map<String, SkylarkModuleDoc> objects = collect(MockClassB.class);
assertThat(extractMethods(
objects.get("MockClassA").getJavaMethods())).containsExactly(
MockClassA.class.getMethod("get"));
}
@Test
public void testSkylarkJavaInterfaceExplorerFindsAllMethodsOnSubClass() throws Exception {
Map<String, SkylarkModuleDoc> objects = collect(MockClassC.class);
assertThat(extractMethods(Iterables.getOnlyElement(objects.values())
.getJavaMethods())).containsExactly(
MockClassA.class.getMethod("get"), MockClassC.class.getMethod("get2"));
}
private Iterable<Method> extractMethods(Collection<SkylarkJavaMethodDoc> methods) {
return Iterables.transform(methods, new Function<SkylarkJavaMethodDoc, Method>() {
@Override
public Method apply(SkylarkJavaMethodDoc input) {
return input.getMethod();
}
});
}
private Map<String, SkylarkModuleDoc> collect(Class<?> classObject) {
Map<String, SkylarkModuleDoc> modules = new TreeMap<>();
SkylarkDocumentationCollector.collectJavaObjects(
classObject.getAnnotation(SkylarkModule.class), classObject, modules);
return modules;
}
}
|
