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
|
/*
* Copyright (c) 2016, 2024, 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 8157349 8185985 8194953 8214738
* @summary test copy of doc-files, and its contents for HTML meta content.
* @library ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build javadoc.tester.*
* @run main TestCopyFiles
*/
import javadoc.tester.JavadocTester;
public class TestCopyFiles extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestCopyFiles();
tester.runTests();
}
@Test
public void testDocFilesInModulePackages() {
javadoc("-d", "modules-out",
"-top", "phi-TOP-phi",
"-bottom", "phi-BOTTOM-phi",
"-header", "phi-HEADER-phi",
"-footer", "phi-FOOTER-phi",
"-windowtitle", "phi-WINDOW-TITLE-phi",
"--module-source-path", testSrc("modules"),
"--module", "acme.mdle");
checkExit(Exit.OK);
checkOrder("acme.mdle/p/doc-files/inpackage.html",
"""
"Hello World" (phi-WINDOW-TITLE-phi)""",
"phi-TOP-phi",
// check top navbar
"""
<a href="../package-tree.html">Tree</a>""",
"""
<a href="../../../deprecated-list.html">Deprecated</a>""",
"""
<a href="../../../index-all.html">Index</a>""",
"phi-HEADER-phi",
"""
<a href="../../module-summary.html">acme.mdle</a>""",
"""
<a href="../package-summary.html" class="current-selection">p</a>""",
"""
In a named module acme.module and named package <a href="../package-summary.html"><code>p</code></a>.""",
"<dt>Since:</",
"forever",
// check footer
"phi-BOTTOM-phi"
);
}
@Test
public void testDocFilesInMultiModulePackagesWithRecursiveCopy() {
javadoc("-d", "multi-modules-out-recursive",
"-docfilessubdirs",
"-top", "phi-TOP-phi",
"-bottom", "phi-BOTTOM-phi",
"-header", "phi-HEADER-phi",
"-footer", "phi-FOOTER-phi",
"-windowtitle", "phi-WINDOW-TITLE-phi",
"--module-source-path", testSrc("modules"),
"--module", "acme.mdle,acme2.mdle");
checkExit(Exit.OK);
checkOrder("acme.mdle/p/doc-files/inpackage.html",
"""
"Hello World" (phi-WINDOW-TITLE-phi)""",
"phi-TOP-phi",
// check top navbar
"""
<a href="../package-tree.html">Tree</a>""",
"""
<a href="../../../deprecated-list.html">Deprecated</a>""",
"""
<a href="../../../index-all.html">Index</a>""",
"phi-HEADER-phi",
"""
<a href="../../module-summary.html">acme.mdle</a>""",
"""
<a href="../package-summary.html" class="current-selection">p</a>""",
"""
In a named module acme.module and named package <a href="../package-summary.html"><code>p</code></a>.""",
"<dt>Since:</",
"forever",
// check footer
"phi-BOTTOM-phi"
);
// check the bottom most doc file
checkOrder("acme2.mdle/p2/doc-files/sub-dir/sub-dir-1/SubSubReadme.html",
"SubSubReadme (phi-WINDOW-TITLE-phi)",
"phi-TOP-phi",
// check top navbar
"""
<a href="../../../package-tree.html">Tree</a>""",
"""
<a href="../../../../../deprecated-list.html">Deprecated</a>""",
"""
<a href="../../../../../index-all.html">Index</a>""",
"phi-HEADER-phi",
"""
<a href="../../../../module-summary.html">acme2.mdle</a>""",
"""
<a href="../../../package-summary.html" class="current-selection">p2</a>""",
"SubSubReadme.html at third level of doc-file directory.",
// check footer
"phi-BOTTOM-phi"
);
}
@Test
public void testDocFilesInModulePackagesWithRecursiveCopy() {
javadoc("-d", "modules-out-recursive",
"-docfilessubdirs",
"--module-source-path", testSrc("modules"),
"--module", "acme.mdle");
checkExit(Exit.OK);
checkOutput("acme.mdle/p/doc-files/inpackage.html", true,
"""
In a named module acme.module and named package <a href="../package-summary.html"><code>p</code></a>."""
);
}
@Test
public void testDocFilesInModulePackagesWithRecursiveCopyWithExclusion() {
javadoc("-d", "modules-out-recursive-with-exclusion",
"-docfilessubdirs",
"-excludedocfilessubdir", "sub-dir",
"--module-source-path", testSrc("modules"),
"--module", "acme.mdle");
checkExit(Exit.OK);
checkOutput("acme.mdle/p/doc-files/inpackage.html", true,
"""
In a named module acme.module and named package <a href="../package-summary.html"><code>p</code></a>."""
);
}
@Test
public void testDocFilesInPackages() {
javadoc("-d", "packages-out",
"-sourcepath", testSrc("packages"),
"p1");
checkExit(Exit.OK);
checkOutput("p1/doc-files/inpackage.html", true,
"A named package in an unnamed module"
);
}
@Test
public void testDocFilesInPackagesWithRecursiveCopy() {
javadoc("-d", "packages-out-recursive",
"-docfilessubdirs",
"-sourcepath", testSrc("packages"),
"p1");
checkExit(Exit.OK);
checkOutput("p1/doc-files/inpackage.html", true,
"A named package in an unnamed module"
);
checkOutput("p1/doc-files/sub-dir/SubReadme.html", true,
"<title>SubReadme</title>",
"SubReadme.html at second level of doc-file directory."
);
}
@Test
public void testDocFilesInPackagesWithRecursiveCopyWithExclusion() {
javadoc("-d", "packages-out-recursive-with-exclusion",
"-docfilessubdirs",
"-excludedocfilessubdir", "sub-dir",
"-sourcepath", testSrc("packages"),
"p1");
checkExit(Exit.OK);
checkOutput("p1/doc-files/inpackage.html", true,
"A named package in an unnamed module"
);
}
@Test
public void testDocFilesInUnnamedPackages() {
javadoc("-d", "unnamed-out",
"-windowtitle", "phi-WINDOW-TITLE-phi",
"-sourcepath", testSrc("unnamed"),
testSrc("unnamed/Foo.java")
);
checkExit(Exit.OK);
checkOutput("doc-files/inpackage.html", true,
"""
<title>(phi-WINDOW-TITLE-phi)</title>
""",
"In an unnamed package"
);
}
@Test
public void testDocFilesInUnnamedPackagesWithRecursiveCopy() {
javadoc("-d", "unnamed-out-recursive",
"-docfilessubdirs",
"-windowtitle", "phi-WINDOW-TITLE-phi",
"-sourcepath", testSrc("unnamed"),
testSrc("unnamed/Foo.java")
);
checkExit(Exit.OK);
checkOutput("doc-files/inpackage.html", true,
"""
<title>(phi-WINDOW-TITLE-phi)</title>
""",
"In an unnamed package"
);
checkOutput("doc-files/doc-file/SubReadme.html", true,
"""
<title>Beep Beep (phi-WINDOW-TITLE-phi)</title>
""",
"SubReadme.html at second level of doc-file directory for unnamed package."
);
}
@Test
public void testCopyThrough() {
javadoc("-d", "copy",
"-sourcepath", testSrc("packages"),
"p2");
checkExit(Exit.OK);
checkOutput("p2/doc-files/case2.html", true,
"<!-- Generated by javadoc",
"""
<style type="text/css">
body {
font-family: Helvetica, Arial, sans-serif;
font-size: 14px;
}
</style>""");
checkOutput("p2/doc-files/case3.html", true,
"<!-- Generated by javadoc",
"""
<style>
h1 {color:red;}
p {color:blue;}
</style>""");
checkOutput("p2/doc-files/case4.html", true,
"<!-- Generated by javadoc",
"""
<link rel="stylesheet" type="text/css" href="theme.css">""");
}
}
|
