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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
|
/*
* Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* @test
* @bug 8131019
* @summary Test JavadocHelper
* @library /tools/lib
* @modules jdk.compiler/com.sun.tools.javac.api
* jdk.compiler/com.sun.tools.javac.main
* jdk.compiler/jdk.internal.shellsupport.doc
* @build toolbox.ToolBox toolbox.JarTask toolbox.JavacTask
* @run testng JavadocHelperTest
*/
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.function.Function;
import java.util.jar.JarEntry;
import java.util.jar.JarOutputStream;
import javax.lang.model.element.Element;
import javax.lang.model.util.ElementFilter;
import javax.tools.Diagnostic.Kind;
import javax.tools.DiagnosticListener;
import javax.tools.JavaCompiler;
import javax.tools.JavaFileObject;
import javax.tools.SimpleJavaFileObject;
import javax.tools.StandardJavaFileManager;
import javax.tools.StandardLocation;
import javax.tools.ToolProvider;
import com.sun.source.util.JavacTask;
import jdk.internal.shellsupport.doc.JavadocHelper;
import org.testng.annotations.Test;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertTrue;
@Test
public class JavadocHelperTest {
public void testJavadoc() throws Exception {
doTestJavadoc("",
t -> t.getElements().getTypeElement("test.Super"),
"Top level. ");
doTestJavadoc("",
t -> getFirstMethod(t, "test.Super"),
" javadoc1A\n" +
"\n" +
" @param p1 param1A\n" +
" @param p2 param2A\n" +
" @param p3 param3A\n" +
" @throws IllegalStateException exc1A\n" +
" @throws IllegalArgumentException exc2A\n" +
" @throws IllegalAccessException exc3A\n" +
" @return valueA\n");
}
private Element getFirstMethod(JavacTask task, String typeName) {
return ElementFilter.methodsIn(task.getElements().getTypeElement(typeName).getEnclosedElements()).get(0);
}
private Function<JavacTask, Element> getSubTest = t -> getFirstMethod(t, "test.Sub");
public void testInheritNoJavadoc() throws Exception {
doTestJavadoc("",
getSubTest,
" javadoc1A\n" +
"\n" +
" @param p1 param1A\n" +
" @param p2 param2A\n" +
" @param p3 param3A\n" +
" @throws IllegalStateException exc1A\n" +
" @throws IllegalArgumentException exc2A\n" +
" @throws IllegalAccessException exc3A\n" +
" @return valueA\n");
}
public void testInheritFull() throws Exception {
doTestJavadoc(" /**\n" +
" * Prefix {@inheritDoc} suffix.\n" +
" *\n" +
" * @param p1 prefix {@inheritDoc} suffix\n" +
" * @param p2 prefix {@inheritDoc} suffix\n" +
" * @param p3 prefix {@inheritDoc} suffix\n" +
" * @throws IllegalStateException prefix {@inheritDoc} suffix\n" +
" * @throws IllegalArgumentException prefix {@inheritDoc} suffix\n" +
" * @throws IllegalAccessException prefix {@inheritDoc} suffix\n" +
" * @return prefix {@inheritDoc} suffix\n" +
" */\n",
getSubTest,
" Prefix javadoc1 suffix.\n" +
"\n" +
" @param p1 prefix param1 suffix\n" +
" @param p2 prefix param2 suffix\n" +
" @param p3 prefix param3 suffix\n" +
" @throws IllegalStateException prefix exc1 suffix\n" +
" @throws IllegalArgumentException prefix exc2 suffix\n" +
" @throws IllegalAccessException prefix exc3 suffix\n" +
" @return prefix value suffix\n");
}
public void testInheritMissingParam() throws Exception {
doTestJavadoc(" /**\n" +
" * Prefix {@inheritDoc} suffix.\n" +
" *\n" +
" * @param p1 prefix {@inheritDoc} suffix\n" +
" * @param p3 prefix {@inheritDoc} suffix\n" +
" * @throws IllegalStateException prefix {@inheritDoc} suffix\n" +
" * @throws IllegalArgumentException prefix {@inheritDoc} suffix\n" +
" * @throws IllegalAccessException prefix {@inheritDoc} suffix\n" +
" * @return prefix {@inheritDoc} suffix\n" +
" */\n",
getSubTest,
" Prefix javadoc1 suffix.\n" +
"\n" +
" @param p1 prefix param1 suffix\n" +
"@param p2 param2\n" +
" @param p3 prefix param3 suffix\n" +
" @throws IllegalStateException prefix exc1 suffix\n" +
" @throws IllegalArgumentException prefix exc2 suffix\n" +
" @throws IllegalAccessException prefix exc3 suffix\n" +
" @return prefix value suffix\n");
}
public void testInheritMissingFirstParam() throws Exception {
doTestJavadoc(" /**\n" +
" * Prefix {@inheritDoc} suffix.\n" +
" *\n" +
" * @param p2 prefix {@inheritDoc} suffix\n" +
" * @param p3 prefix {@inheritDoc} suffix\n" +
" * @throws IllegalStateException prefix {@inheritDoc} suffix\n" +
" * @throws IllegalArgumentException prefix {@inheritDoc} suffix\n" +
" * @throws IllegalAccessException prefix {@inheritDoc} suffix\n" +
" * @return prefix {@inheritDoc} suffix\n" +
" */\n",
getSubTest,
" Prefix javadoc1 suffix.\n" +
"@param p1 param1\n" +
"\n" +
" @param p2 prefix param2 suffix\n" +
" @param p3 prefix param3 suffix\n" +
" @throws IllegalStateException prefix exc1 suffix\n" +
" @throws IllegalArgumentException prefix exc2 suffix\n" +
" @throws IllegalAccessException prefix exc3 suffix\n" +
" @return prefix value suffix\n");
}
public void testInheritMissingThrows() throws Exception {
doTestJavadoc(" /**\n" +
" * Prefix {@inheritDoc} suffix.\n" +
" *\n" +
" * @param p1 prefix {@inheritDoc} suffix\n" +
" * @param p2 prefix {@inheritDoc} suffix\n" +
" * @param p3 prefix {@inheritDoc} suffix\n" +
" * @throws IllegalStateException prefix {@inheritDoc} suffix\n" +
" * @throws IllegalAccessException prefix {@inheritDoc} suffix\n" +
" * @return prefix {@inheritDoc} suffix\n" +
" */\n",
getSubTest,
" Prefix javadoc1 suffix.\n" +
"\n" +
" @param p1 prefix param1 suffix\n" +
" @param p2 prefix param2 suffix\n" +
" @param p3 prefix param3 suffix\n" +
" @throws IllegalStateException prefix exc1 suffix\n" +
"@throws java.lang.IllegalArgumentException exc2\n" +
" @throws IllegalAccessException prefix exc3 suffix\n" +
" @return prefix value suffix\n");
}
public void testInheritMissingReturn() throws Exception {
doTestJavadoc(" /**\n" +
" * Prefix {@inheritDoc} suffix.\n" +
" *\n" +
" * @param p1 prefix {@inheritDoc} suffix\n" +
" * @param p2 prefix {@inheritDoc} suffix\n" +
" * @param p3 prefix {@inheritDoc} suffix\n" +
" * @throws IllegalStateException prefix {@inheritDoc} suffix\n" +
" * @throws IllegalArgumentException prefix {@inheritDoc} suffix\n" +
" * @throws IllegalAccessException prefix {@inheritDoc} suffix\n" +
" */\n",
getSubTest,
" Prefix javadoc1 suffix.\n" +
"\n" +
" @param p1 prefix param1 suffix\n" +
" @param p2 prefix param2 suffix\n" +
" @param p3 prefix param3 suffix\n" +
" @throws IllegalStateException prefix exc1 suffix\n" +
" @throws IllegalArgumentException prefix exc2 suffix\n" +
" @throws IllegalAccessException prefix exc3 suffix\n" +
"@return value\n");
}
private void doTestJavadoc(String origJavadoc, Function<JavacTask, Element> getElement, String expectedJavadoc) throws Exception {
JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
String subClass =
"package test;\n" +
"public class Sub extends Super {\n" +
origJavadoc +
" public String test(int p1, int p2, int p3) throws IllegalStateException, IllegalArgumentException, IllegalAccessException { return null;} \n" +
"}\n";
String superClass =
"package test;\n" +
"/**Top level." +
" */\n" +
"public class Super {\n" +
" /**\n" +
" * javadoc1A\n" +
" *\n" +
" * @param p1 param1A\n" +
" * @param p2 param2A\n" +
" * @param p3 param3A\n" +
" * @throws IllegalStateException exc1A\n" +
" * @throws IllegalArgumentException exc2A\n" +
" * @throws IllegalAccessException exc3A\n" +
" * @return valueA\n" +
" */\n" +
" public String test(int p1, int p2, int p3) throws IllegalStateException, IllegalArgumentException, IllegalAccessException { return null;} \n" +
"}\n";
Path srcZip = Paths.get("src.zip");
try (JarOutputStream out = new JarOutputStream(Files.newOutputStream(srcZip))) {
out.putNextEntry(new JarEntry("test/Sub.java"));
out.write(subClass.getBytes());
out.putNextEntry(new JarEntry("test/Super.java"));
out.write(superClass.getBytes());
} catch (IOException ex) {
throw new IllegalStateException(ex);
}
DiagnosticListener<? super JavaFileObject> noErrors = d -> {
if (d.getKind() == Kind.ERROR) {
throw new AssertionError(d.getMessage(null));
}
};
assertTrue(compiler.getTask(null, null, noErrors, Arrays.asList("-d", "."), null, Arrays.asList(new JFOImpl("Super", superClass), new JFOImpl("Sub", subClass))).call());
try (StandardJavaFileManager fm = compiler.getStandardFileManager(null, null, null)) {
fm.setLocationFromPaths(StandardLocation.CLASS_PATH, Arrays.asList(Paths.get(".").toAbsolutePath()));
JavacTask task = (JavacTask) compiler.getTask(null, fm, noErrors, null, null, null);
Element el = getElement.apply(task);
try (JavadocHelper helper = JavadocHelper.create(task, Arrays.asList(srcZip))) {
String javadoc = helper.getResolvedDocComment(el);
assertEquals(javadoc, expectedJavadoc);
}
}
}
private static final class JFOImpl extends SimpleJavaFileObject {
private final String code;
public JFOImpl(String name, String code) throws URISyntaxException {
super(new URI("mem:///" + name + ".java"), Kind.SOURCE);
this.code = code;
}
@Override
public CharSequence getCharContent(boolean ignoreEncodingErrors) throws IOException {
return code;
}
}
}
|
