|
1 /* |
|
2 * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved. |
|
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
4 * |
|
5 * This code is free software; you can redistribute it and/or modify it |
|
6 * under the terms of the GNU General Public License version 2 only, as |
|
7 * published by the Free Software Foundation. |
|
8 * |
|
9 * This code is distributed in the hope that it will be useful, but WITHOUT |
|
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
12 * version 2 for more details (a copy is included in the LICENSE file that |
|
13 * accompanied this code). |
|
14 * |
|
15 * You should have received a copy of the GNU General Public License version |
|
16 * 2 along with this work; if not, write to the Free Software Foundation, |
|
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
18 * |
|
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
20 * or visit www.oracle.com if you need additional information or have any |
|
21 * questions. |
|
22 */ |
|
23 |
|
24 /* |
|
25 * @test |
|
26 * @bug 8178982 8220497 8210683 |
|
27 * @summary Test the search feature of javadoc. |
|
28 * @library ../../lib |
|
29 * @modules jdk.javadoc/jdk.javadoc.internal.tool |
|
30 * @build javadoc.tester.* |
|
31 * @run main TestSearchScript |
|
32 */ |
|
33 |
|
34 import javadoc.tester.JavadocTester; |
|
35 |
|
36 import javax.script.Invocable; |
|
37 import javax.script.ScriptEngine; |
|
38 import javax.script.ScriptEngineManager; |
|
39 import javax.script.ScriptException; |
|
40 import java.io.BufferedReader; |
|
41 import java.io.File; |
|
42 import java.io.FileReader; |
|
43 import java.io.IOException; |
|
44 import java.util.List; |
|
45 |
|
46 /* |
|
47 * Tests for the search feature using Nashorn JavaScript engine. |
|
48 */ |
|
49 public class TestSearchScript extends JavadocTester { |
|
50 |
|
51 public static void main(String... args) throws Exception { |
|
52 TestSearchScript tester = new TestSearchScript(); |
|
53 tester.runTests(); |
|
54 } |
|
55 |
|
56 private Invocable getEngine() throws ScriptException, IOException, NoSuchMethodException { |
|
57 ScriptEngineManager engineManager = new ScriptEngineManager(); |
|
58 ScriptEngine engine = engineManager.getEngineByName("nashorn"); |
|
59 engine.eval(new BufferedReader(new FileReader(new File(testSrc, "javadoc-search.js")))); |
|
60 Invocable inv = (Invocable) engine; |
|
61 inv.invokeFunction("loadIndexFiles", outputDir.getAbsolutePath()); |
|
62 return inv; |
|
63 } |
|
64 |
|
65 @Test |
|
66 public void testModuleSearch() throws ScriptException, IOException, NoSuchMethodException { |
|
67 javadoc("-d", "out-full", |
|
68 "-Xdoclint:none", |
|
69 "-use", |
|
70 "--module-source-path", testSrc, |
|
71 "--module", "mapmodule", |
|
72 "mappkg", "mappkg.impl"); |
|
73 checkExit(Exit.OK); |
|
74 |
|
75 Invocable inv = getEngine(); |
|
76 |
|
77 // exact match, case sensitivity |
|
78 checkSearch(inv, "mapmodule", List.of("mapmodule")); |
|
79 checkSearch(inv, "mappkg", List.of("mapmodule/mappkg", "mapmodule/mappkg.impl", "mappkg.system.property")); |
|
80 checkSearch(inv, "Mapmodule", List.of()); |
|
81 checkSearch(inv, "Mappkg", List.of()); |
|
82 checkSearch(inv, "mymap", List.of("mappkg.impl.MyMap", "mappkg.impl.MyMap.MyMap()", "mappkg.impl.MyMap.MyMap(Map)")); |
|
83 checkSearch(inv, "MyMap", List.of("mappkg.impl.MyMap", "mappkg.impl.MyMap.MyMap()", "mappkg.impl.MyMap.MyMap(Map)")); |
|
84 checkSearch(inv, "mymap(", List.of("mappkg.impl.MyMap.MyMap()", "mappkg.impl.MyMap.MyMap(Map)")); |
|
85 checkSearch(inv, "MyMap(", List.of("mappkg.impl.MyMap.MyMap()", "mappkg.impl.MyMap.MyMap(Map)")); |
|
86 checkSearch(inv, "mymap()", List.of("mappkg.impl.MyMap.MyMap()")); |
|
87 checkSearch(inv, "MyMap()", List.of("mappkg.impl.MyMap.MyMap()")); |
|
88 checkSearch(inv, "Mymap", List.of()); |
|
89 checkSearch(inv, "Mymap()", List.of()); |
|
90 |
|
91 // left boundaries, ranking |
|
92 checkSearch(inv, "map", List.of("mapmodule", "mapmodule/mappkg", "mapmodule/mappkg.impl", "mappkg.Map", "mappkg.impl.MyMap", |
|
93 "mappkg.impl.MyMap.MyMap()", "mappkg.impl.MyMap.MyMap(Map)", "mappkg.system.property")); |
|
94 checkSearch(inv, "Map", List.of("mappkg.Map", "mappkg.impl.MyMap", "mappkg.impl.MyMap.MyMap()", |
|
95 "mappkg.impl.MyMap.MyMap(Map)")); |
|
96 checkSearch(inv, "MAP", List.of()); |
|
97 checkSearch(inv, "value", List.of("mappkg.impl.MyMap.OTHER_VALUE", "mappkg.impl.MyMap.some_value")); |
|
98 checkSearch(inv, "VALUE", List.of("mappkg.impl.MyMap.OTHER_VALUE")); |
|
99 checkSearch(inv, "map.other", List.of("mappkg.impl.MyMap.OTHER_VALUE")); |
|
100 checkSearch(inv, "Map.some_", List.of("mappkg.impl.MyMap.some_value")); |
|
101 |
|
102 checkSearch(inv, "Mm", List.of()); |
|
103 checkSearch(inv, "mym", List.of("mappkg.impl.MyMap", "mappkg.impl.MyMap.MyMap()", "mappkg.impl.MyMap.MyMap(Map)")); |
|
104 checkSearch(inv, "imp.mym.mym(", List.of("mappkg.impl.MyMap.MyMap()", "mappkg.impl.MyMap.MyMap(Map)")); |
|
105 checkSearch(inv, "imp.mym.mym(m", List.of("mappkg.impl.MyMap.MyMap(Map)")); |
|
106 |
|
107 // camel case |
|
108 checkSearch(inv, "MM", List.of("mappkg.impl.MyMap", "mappkg.impl.MyMap.MyMap()", "mappkg.impl.MyMap.MyMap(Map)")); |
|
109 checkSearch(inv, "MyM", List.of("mappkg.impl.MyMap", "mappkg.impl.MyMap.MyMap()", "mappkg.impl.MyMap.MyMap(Map)")); |
|
110 checkSearch(inv, "Mym", List.of()); |
|
111 checkSearch(inv, "i.MyM.MyM(", List.of("mappkg.impl.MyMap.MyMap()", "mappkg.impl.MyMap.MyMap(Map)")); |
|
112 checkSearch(inv, "i.MMa.MMa(", List.of("mappkg.impl.MyMap.MyMap()", "mappkg.impl.MyMap.MyMap(Map)")); |
|
113 checkSearch(inv, "i.MyM.MyM(Ma", List.of("mappkg.impl.MyMap.MyMap(Map)")); |
|
114 checkSearch(inv, "i.MMa.MMa(M", List.of("mappkg.impl.MyMap.MyMap(Map)")); |
|
115 checkSearch(inv, "i.Mym.MyM(", List.of()); |
|
116 checkSearch(inv, "i.Mym.Ma(", List.of()); |
|
117 |
|
118 checkSearch(inv, "mapm", List.of("mapmodule")); |
|
119 |
|
120 // child entity listing |
|
121 checkSearch(inv, "mapmodule/", List.of("mapmodule/mappkg", "mapmodule/mappkg.impl")); |
|
122 checkSearch(inv, "mapmod/", List.of("mapmodule/mappkg", "mapmodule/mappkg.impl")); |
|
123 checkSearch(inv, "module/", List.of()); |
|
124 checkSearch(inv, "le/", List.of()); |
|
125 checkSearch(inv, "mapmodule.", List.of()); |
|
126 checkSearch(inv, "mapmod.", List.of()); |
|
127 checkSearch(inv, "mappkg.", List.of("mapmodule/mappkg.impl", "mappkg.Map", "mappkg.system.property")); |
|
128 checkSearch(inv, "mappkg.", List.of("mapmodule/mappkg.impl", "mappkg.Map", "mappkg.system.property")); |
|
129 checkSearch(inv, "Map.", List.of("mappkg.Map.contains(Object)", "mappkg.Map.get(Object)", "mappkg.Map.iterate()", |
|
130 "mappkg.Map.put(Object, Object)", "mappkg.Map.remove(Object)", |
|
131 "mappkg.impl.MyMap.contains(Object)", "mappkg.impl.MyMap.get(Object)", |
|
132 "mappkg.impl.MyMap.iterate()", "mappkg.impl.MyMap.MyMap()", |
|
133 "mappkg.impl.MyMap.MyMap(Map)", "mappkg.impl.MyMap.OTHER_VALUE", |
|
134 "mappkg.impl.MyMap.put(Object, Object)", "mappkg.impl.MyMap.remove(Object)", |
|
135 "mappkg.impl.MyMap.some_value")); |
|
136 checkSearch(inv, "mym.", List.of("mappkg.impl.MyMap.contains(Object)", "mappkg.impl.MyMap.get(Object)", |
|
137 "mappkg.impl.MyMap.iterate()", "mappkg.impl.MyMap.MyMap()", |
|
138 "mappkg.impl.MyMap.MyMap(Map)", "mappkg.impl.MyMap.OTHER_VALUE", |
|
139 "mappkg.impl.MyMap.put(Object, Object)", "mappkg.impl.MyMap.remove(Object)", |
|
140 "mappkg.impl.MyMap.some_value")); |
|
141 checkSearch(inv, "MyMap.i", List.of("mappkg.impl.MyMap.iterate()")); |
|
142 |
|
143 // system properties |
|
144 checkSearch(inv, "mappkg.system.property", List.of("mappkg.system.property")); |
|
145 checkSearch(inv, "system.property", List.of("mappkg.system.property")); |
|
146 checkSearch(inv, "property", List.of("mappkg.system.property")); |
|
147 checkSearch(inv, "sys.prop", List.of("mappkg.system.property")); |
|
148 checkSearch(inv, "m.s.p", List.of("mappkg.system.property")); |
|
149 checkSearch(inv, "operty", List.of()); |
|
150 |
|
151 // search tag |
|
152 checkSearch(inv, "search tag", List.of("search tag")); |
|
153 checkSearch(inv, "search tag", List.of("search tag")); |
|
154 checkSearch(inv, "search ", List.of("search tag")); |
|
155 checkSearch(inv, "tag", List.of("search tag")); |
|
156 checkSearch(inv, "sea", List.of("search tag")); |
|
157 checkSearch(inv, "ear", List.of()); |
|
158 } |
|
159 |
|
160 |
|
161 @Test |
|
162 public void testPackageSource() throws ScriptException, IOException, NoSuchMethodException { |
|
163 javadoc("-d", "out-overload", |
|
164 "-Xdoclint:none", |
|
165 "-use", |
|
166 "-sourcepath", testSrc, |
|
167 "listpkg"); |
|
168 checkExit(Exit.OK); |
|
169 |
|
170 Invocable inv = getEngine(); |
|
171 |
|
172 // exact match, case sensitvity, left boundaries |
|
173 checkSearch(inv, "list", List.of("listpkg", "listpkg.List", "listpkg.ListProvider", "listpkg.MyList", |
|
174 "listpkg.MyListFactory", "listpkg.ListProvider.ListProvider()", |
|
175 "listpkg.MyListFactory.createList(ListProvider, MyListFactory)", |
|
176 "listpkg.ListProvider.makeNewList()", |
|
177 "listpkg.MyList.MyList()", "listpkg.MyListFactory.MyListFactory()")); |
|
178 checkSearch(inv, "List", List.of("listpkg.List", "listpkg.ListProvider", "listpkg.MyList", |
|
179 "listpkg.MyListFactory", "listpkg.ListProvider.ListProvider()", |
|
180 "listpkg.MyListFactory.createList(ListProvider, MyListFactory)", |
|
181 "listpkg.ListProvider.makeNewList()", |
|
182 "listpkg.MyList.MyList()", "listpkg.MyListFactory.MyListFactory()")); |
|
183 |
|
184 // partial match |
|
185 checkSearch(inv, "fact", List.of("listpkg.MyListFactory", "listpkg.MyListFactory.MyListFactory()")); |
|
186 checkSearch(inv, "pro", List.of("listpkg.ListProvider", "listpkg.ListProvider.ListProvider()")); |
|
187 checkSearch(inv, "listpro", List.of("listpkg.ListProvider", "listpkg.ListProvider.ListProvider()")); |
|
188 |
|
189 // camel case |
|
190 checkSearch(inv, "l.MLF.cL(LP, MLF)", List.of("listpkg.MyListFactory.createList(ListProvider, MyListFactory)")); |
|
191 checkSearch(inv, "Fact.creaLi(LiPro,MLiFact)", List.of("listpkg.MyListFactory.createList(ListProvider, MyListFactory)")); |
|
192 checkSearch(inv, "(LP,ML", List.of("listpkg.MyListFactory.createList(ListProvider, MyListFactory)")); |
|
193 |
|
194 // ranking of overloaded methods JDK-8210683 |
|
195 checkSearch(inv, "list.of", |
|
196 List.of("listpkg.List.of()", "listpkg.List.of(E)", "listpkg.List.of(E, E)", |
|
197 "listpkg.List.of(E, E, E)", "listpkg.List.of(E, E, E, E)", |
|
198 "listpkg.List.of(E, E, E, E, E)", "listpkg.List.of(E...)")); |
|
199 checkSearch(inv, "Li.of", |
|
200 List.of("listpkg.List.of()", "listpkg.List.of(E)", "listpkg.List.of(E, E)", |
|
201 "listpkg.List.of(E, E, E)", "listpkg.List.of(E, E, E, E)", |
|
202 "listpkg.List.of(E, E, E, E, E)", "listpkg.List.of(E...)")); |
|
203 checkSearch(inv, "li.Li.o", |
|
204 List.of("listpkg.List.of()", "listpkg.List.of(E)", "listpkg.List.of(E, E)", |
|
205 "listpkg.List.of(E, E, E)", "listpkg.List.of(E, E, E, E)", |
|
206 "listpkg.List.of(E, E, E, E, E)", "listpkg.List.of(E...)")); |
|
207 checkSearch(inv, "l.l.o", |
|
208 List.of("listpkg.List.of()", "listpkg.List.of(E)", "listpkg.List.of(E, E)", |
|
209 "listpkg.List.of(E, E, E)", "listpkg.List.of(E, E, E, E)", |
|
210 "listpkg.List.of(E, E, E, E, E)", "listpkg.List.of(E...)")); |
|
211 checkSearch(inv, "L.l.o", List.of()); |
|
212 |
|
213 // whitespace |
|
214 checkSearch(inv, "(e,e,e", |
|
215 List.of("listpkg.List.of(E, E, E)", "listpkg.List.of(E, E, E, E)", |
|
216 "listpkg.List.of(E, E, E, E, E)")); |
|
217 checkSearch(inv, "(e, e,e", |
|
218 List.of("listpkg.List.of(E, E, E)", "listpkg.List.of(E, E, E, E)", |
|
219 "listpkg.List.of(E, E, E, E, E)")); |
|
220 checkSearch(inv, "(e, e, e", |
|
221 List.of("listpkg.List.of(E, E, E)", "listpkg.List.of(E, E, E, E)", |
|
222 "listpkg.List.of(E, E, E, E, E)")); |
|
223 checkSearch(inv, "(e, e, e", |
|
224 List.of("listpkg.List.of(E, E, E)", "listpkg.List.of(E, E, E, E)", |
|
225 "listpkg.List.of(E, E, E, E, E)")); |
|
226 checkSearch(inv, "(e, e, e ,", |
|
227 List.of("listpkg.List.of(E, E, E, E)", "listpkg.List.of(E, E, E, E, E)")); |
|
228 checkSearch(inv, "(e , e, e,", |
|
229 List.of("listpkg.List.of(E, E, E, E)", "listpkg.List.of(E, E, E, E, E)")); |
|
230 checkSearch(inv, " listpkg .list .of ", |
|
231 List.of("listpkg.List.of()", "listpkg.List.of(E)", "listpkg.List.of(E, E)", |
|
232 "listpkg.List.of(E, E, E)", "listpkg.List.of(E, E, E, E)", |
|
233 "listpkg.List.of(E, E, E, E, E)", "listpkg.List.of(E...)")); |
|
234 checkSearch(inv, " l. l. o", |
|
235 List.of("listpkg.List.of()", "listpkg.List.of(E)", "listpkg.List.of(E, E)", |
|
236 "listpkg.List.of(E, E, E)", "listpkg.List.of(E, E, E, E)", |
|
237 "listpkg.List.of(E, E, E, E, E)", "listpkg.List.of(E...)")); |
|
238 checkSearch(inv, "list . of", |
|
239 List.of("listpkg.List.of()", "listpkg.List.of(E)", "listpkg.List.of(E, E)", |
|
240 "listpkg.List.of(E, E, E)", "listpkg.List.of(E, E, E, E)", |
|
241 "listpkg.List.of(E, E, E, E, E)", "listpkg.List.of(E...)")); |
|
242 checkSearch(inv, "lis t.of", List.of()); |
|
243 checkSearch(inv, "list . of(e,e,e,", |
|
244 List.of("listpkg.List.of(E, E, E, E)", "listpkg.List.of(E, E, E, E, E)")); |
|
245 checkSearch(inv, "l . o (e,e,e,", |
|
246 List.of("listpkg.List.of(E, E, E, E)", "listpkg.List.of(E, E, E, E, E)")); |
|
247 checkSearch(inv, "search \tt", List.of("search tag")); |
|
248 checkSearch(inv, "sear ch", List.of()); |
|
249 checkSearch(inv, "( e ..", List.of("listpkg.List.of(E...)")); |
|
250 checkSearch(inv, "( i [ ]", List.of("listpkg.Nolist.withArrayArg(int[])")); |
|
251 |
|
252 // empty/white space search should not trigger results |
|
253 checkNullSearch(inv, ""); |
|
254 checkNullSearch(inv, " "); |
|
255 checkNullSearch(inv, " "); |
|
256 checkNullSearch(inv, " \t\t "); |
|
257 |
|
258 |
|
259 // _ word boundaries and case sensitivity |
|
260 checkSearch(inv, "some", List.of("listpkg.Nolist.SOME_INT_CONSTANT")); |
|
261 checkSearch(inv, "SOME", List.of("listpkg.Nolist.SOME_INT_CONSTANT")); |
|
262 checkSearch(inv, "Some", List.of()); |
|
263 checkSearch(inv, "int", List.of("listpkg.Nolist.SOME_INT_CONSTANT")); |
|
264 checkSearch(inv, "INT", List.of("listpkg.Nolist.SOME_INT_CONSTANT")); |
|
265 checkSearch(inv, "Int", List.of()); |
|
266 checkSearch(inv, "int_con", List.of("listpkg.Nolist.SOME_INT_CONSTANT")); |
|
267 checkSearch(inv, "INT_CON", List.of("listpkg.Nolist.SOME_INT_CONSTANT")); |
|
268 checkSearch(inv, "NT", List.of()); |
|
269 checkSearch(inv, "NT_", List.of()); |
|
270 checkSearch(inv, "_const", List.of("listpkg.Nolist.SOME_INT_CONSTANT")); |
|
271 checkSearch(inv, "_CONST", List.of("listpkg.Nolist.SOME_INT_CONSTANT")); |
|
272 |
|
273 // Test for all packages, all classes links |
|
274 checkSearch(inv, "all", List.of("All Packages", "All Classes")); |
|
275 checkSearch(inv, "All", List.of("All Packages", "All Classes")); |
|
276 checkSearch(inv, "ALL", List.of()); |
|
277 |
|
278 // test for generic types, var-arg and array args |
|
279 checkSearch(inv, "(map<string, ? ext collection>)", |
|
280 List.of("listpkg.Nolist.withTypeParams(Map<String, ? extends Collection>)")); |
|
281 checkSearch(inv, "(m<str,? ext coll>", |
|
282 List.of("listpkg.Nolist.withTypeParams(Map<String, ? extends Collection>)")); |
|
283 checkSearch(inv, "(object...", List.of("listpkg.Nolist.withVarArgs(Object...)")); |
|
284 checkSearch(inv, "(obj...", List.of("listpkg.Nolist.withVarArgs(Object...)")); |
|
285 checkSearch(inv, "(e..", List.of("listpkg.List.of(E...)")); |
|
286 checkSearch(inv, "(int[]", List.of("listpkg.Nolist.withArrayArg(int[])")); |
|
287 checkSearch(inv, "(i[]", List.of("listpkg.Nolist.withArrayArg(int[])")); |
|
288 } |
|
289 |
|
290 void checkSearch(Invocable inv, String query, List<String> results) throws ScriptException, NoSuchMethodException { |
|
291 checkList((List) inv.invokeFunction("search", query), results); |
|
292 } |
|
293 |
|
294 void checkList(List<?> result, List<?> expected) { |
|
295 checking("Checking list: " + result); |
|
296 if (!expected.equals(result)) { |
|
297 failed("Expected: " + expected + ", got: " + result); |
|
298 } else { |
|
299 passed("List matches expected result"); |
|
300 } |
|
301 } |
|
302 |
|
303 void checkNullSearch(Invocable inv, String query) throws ScriptException, NoSuchMethodException { |
|
304 Object result = inv.invokeFunction("search", query); |
|
305 checking("Checking null result"); |
|
306 if (result == null) { |
|
307 passed("Result is null as expected"); |
|
308 } else { |
|
309 failed("Expected: null, got: " + result); |
|
310 } |
|
311 } |
|
312 } |