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
|
/*
* Copyright (c) 2003, 2022, 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 4460354 8014636 8043186 8195805 8182765 8196202 8262886
* @summary Test to make sure that relative paths are redirected in the
* output so that they are not broken.
* @library ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build javadoc.tester.*
* @run main TestRelativeLinks
*/
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import javadoc.tester.JavadocTester;
public class TestRelativeLinks extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestRelativeLinks();
tester.runTests();
}
@Test
public void testRelativeLinks() {
javadoc("-d", "out",
"-use",
"-sourcepath", testSrc,
"pkg", "pkg2", "pkg.sub");
checkExit(Exit.OK);
// These relative paths should stay relative because they appear
// in the right places.
checkOutput("pkg/C.html", true,
"""
<a href="relative-class-link.html">relative class link</a>""",
"""
<a href="#class-fragment">fragment class link</a>""",
"""
<a id="class-fragment">Class fragment</a>""",
"""
<a href="relative-field-link.html">relative field link</a>""",
"""
<a href="relative-method-link.html">relative method link</a>""",
"""
<a href="#method-fragment">fragment method link</a>""",
"""
<a href="relative-multi-line-link.html">relative-multi-line-link</a>""");
checkOutput("pkg/package-summary.html", true,
"""
<a href="relative-package-link.html">relative package link</a>""",
"""
<a href="#package-fragment">package fragment link</a>""",
"""
<a id="package-fragment">Package fragment</a>""",
"""
<a href="relative-class-link.html">relative class link</a>""",
"""
<a href="C.html#class-fragment">fragment class link</a>""");
// subclass in same package
checkOutput("pkg/D.html", true,
"""
<a href="relative-method-link.html">relative method link</a>""",
"""
<a href="C.html#method-fragment">fragment method link</a>""");
// These relative paths should be redirected because they are in different
// places.
// subclass in subpackage
checkOutput("pkg/sub/F.html", true,
"""
<a href="../../pkg/relative-method-link.html">relative method link</a>""",
"""
<a href="../../pkg/C.html#method-fragment">fragment method link</a>""");
// INDEX PAGE
checkOutput("index-all.html", true,
"""
<a href="./pkg/relative-class-link.html">relative class link</a>""",
"""
<a href="./pkg/C.html#class-fragment">fragment class link</a>""",
"""
<a href="./pkg/relative-field-link.html">relative field link</a>""",
"""
<a href="./pkg/relative-method-link.html">relative method link</a>""",
"""
<a href="./pkg/C.html#method-fragment">fragment method link</a>""",
"""
<a href="./pkg/relative-package-link.html">relative package link</a>""",
"""
<a href="./pkg/relative-multi-line-link.html">relative-multi-line-link</a>""");
// This is not a relative path and should not be redirected.
checkOutput("index-all.html", true,
"""
<div class="block"><a id="masters"></a>""");
checkOutput("index-all.html", false,
"""
<div class="block"><a id="./pkg/masters"></a>""");
// PACKAGE USE
checkOutput("pkg/package-use.html", true,
"""
<a href="../pkg/relative-package-link.html">relative package link</a>""",
"""
<a href="../pkg/package-summary.html#package-fragment">package fragment link</a>""",
"""
<a href="../pkg/relative-class-link.html">relative class link</a>""",
"""
<a href="../pkg/C.html#class-fragment">fragment class link</a>""");
// CLASS_USE
checkOutput("pkg/class-use/C.html", true,
"""
<a href="../../pkg/relative-field-link.html">relative field link</a>""",
"""
<a href="../../pkg/relative-method-link.html">relative method link</a>""",
"""
<a href="../../pkg/C.html#method-fragment">fragment method link</a>""",
"""
<a href="../../pkg/relative-package-link.html">relative package link</a>""",
"""
<a href="../../pkg/relative-multi-line-link.html">relative-multi-line-link</a>""");
// PACKAGE OVERVIEW
checkOutput("index.html", true,
"""
<a href="./pkg/relative-package-link.html">relative package link</a>""");
// subpackage summary
checkOutput("pkg/sub/package-summary.html", true,
// related packages
"""
<a href="../../pkg/relative-package-link.html">relative package link</a>""",
"""
<a href="../../pkg/package-summary.html#package-fragment">package fragment link</a>""");
}
@Override
public void checkLinks() {
// since the test uses explicit links to non-existent files,
// we create those files to avoid false positive errors from checkLinks
touch("pkg/relative-class-link.html");
touch("pkg/relative-field-link.html");
touch("pkg/relative-method-link.html");
touch("pkg/relative-package-link.html");
touch("pkg/relative-multi-line-link.html");
super.checkLinks();
}
private void touch(String file) {
Path f = outputDir.resolve(file);
out.println("touch " + f);
try (OutputStream fos = Files.newOutputStream(f)) {
} catch (IOException e) {
checking("Touch file");
failed("Error creating file: " + e);
}
}
}
|
