File: TestDocRootLink.java

package info (click to toggle)
openjdk-17 17.0.17~5ea-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 764,780 kB
  • sloc: java: 5,318,220; xml: 1,291,711; cpp: 1,202,338; ansic: 428,731; asm: 404,978; objc: 20,861; sh: 14,753; javascript: 10,743; python: 6,402; makefile: 2,405; perl: 357; awk: 351; sed: 172; jsp: 24; csh: 3
file content (133 lines) | stat: -rw-r--r-- 5,233 bytes parent folder | download | duplicates (8)
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
/*
 * Copyright (c) 2011, 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 6553182 8025416 8029504
 * @summary This test verifies the -Xdocrootparent option.
 * @library ../../lib
 * @modules jdk.javadoc/jdk.javadoc.internal.tool
 * @build javadoc.tester.*
 * @run main TestDocRootLink
 */
import javadoc.tester.JavadocTester;

public class TestDocRootLink extends JavadocTester {

    public static void main(String... args) throws Exception {
        var tester = new TestDocRootLink();

        // The test files intentionally contain examples of links that should
        // or should not be affected by the -Xdocrootparent option, and the
        // results are checked explicitly; so, disable the automatic link
        // checker to prevent spurious "missing files" errors from some of
        // these links.
        tester.setAutomaticCheckLinks(false);

        tester.runTests();
    }

    @Test
    public void test1() {
        javadoc("-d", "out-1",
                "-sourcepath", testSrc,
                "pkg1", "pkg2");
        checkExit(Exit.OK);

        checkOutput("pkg1/C1.html", true,
            """
                Refer <a href="../../technotes/guides/index.html">Here</a>""",
            """
                This <a href="../pkg2/C2.html">Here</a> should not be replaced
                 with an absolute link.""",
            """
                Testing <a href="../technotes/guides/index.html">Link 1</a> and
                 <a href="../pkg2/C2.html">Link 2</a>.""");

        checkOutput("pkg1/package-summary.html", true,
            """
                <a href="../../technotes/guides/index.html">
                            Test document 1</a>""",
            """
                <a href="../pkg2/C2.html">
                            Another Test document 1</a>""",
            """
                <a href="../technotes/guides/index.html">
                            Another Test document 2.</a>""");

        // TODO: should this check *any* reference to http://download.oracle.com/
        checkOutput("pkg1/C1.html", false,
            """
                <a href="http://download.oracle.com/javase/7/docs/technotes/guides/index.html">""",
            """
                <a href="http://download.oracle.com/javase/7/docs/pkg2/C2.html">""");

        checkOutput("pkg1/package-summary.html", false,
            """
                <a href="http://download.oracle.com/javase/7/docs/technotes/guides/index.html">""",
            """
                <a href="http://download.oracle.com/javase/7/docs/pkg2/C2.html">""");
    }

    @Test
    public void test2() {
        javadoc("-d", "out-2",
                "-Xdocrootparent", "http://download.oracle.com/javase/7/docs",
                "-sourcepath", testSrc,
                "pkg1", "pkg2");
        checkExit(Exit.OK);

        checkOutput("pkg2/C2.html", true,
            """
                Refer <a href="http://download.oracle.com/javase/7/docs/technotes/guides/index.html">Here</a>""",
            """
                This <a href="../pkg1/C1.html">Here</a> should not be replaced
                 with an absolute link.""",
            """
                Testing <a href="../technotes/guides/index.html">Link 1</a> and
                 <a href="../pkg1/C1.html">Link 2</a>.""");

        checkOutput("pkg2/package-summary.html", true,
            """
                <a href="http://download.oracle.com/javase/7/docs/technotes/guides/index.html">
                            Test document 1</a>""",
            """
                <a href="../pkg1/C1.html">
                            Another Test document 1</a>""",
            """
                <a href="../technotes/guides/index.html">
                            Another Test document 2.</a>""");

        checkOutput("pkg2/C2.html", false,
            """
                <a href="../../technotes/guides/index.html">""",
            """
                <a href="http://download.oracle.com/javase/7/docs/pkg1/C1.html">""");

        checkOutput("pkg2/package-summary.html", false,
            """
                <a href="../../technotes/guides/index.html">""",
            """
                <a href="http://download.oracle.com/javase/7/docs/pkg1/C1.html">""");
    }
}