test/langtools/jdk/javadoc/doclet/ValidHtml/ValidHtml.java
author jjg
Tue, 29 May 2018 11:20:04 -0700
changeset 50293 edfb87b2520e
parent 49139 771616d26ca1
child 53097 2e82ca64b25d
permissions -rw-r--r--
8196202: Javadoc should not generate frames by default Reviewed-by: ksrini
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
49139
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
     2
 * Copyright (c) 2002, 2018, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
06bc494ca11e Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    21
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    22
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    23
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
/*
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
 * @test
50293
edfb87b2520e 8196202: Javadoc should not generate frames by default
jjg
parents: 49139
diff changeset
    26
 * @bug 4275630 4749453 4625400 4753048 4415270 8074521 8182765 8196202
29429
964498d4dcec 8074521: Generate iframe instead of frame and frameset for index.html page
bpatel
parents: 24399
diff changeset
    27
 * @summary  Generated HTML is invalid with frames.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 *           Displays unnecessary horizontal scroll bars.
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 *           Missing whitespace in DOCTYPE declaration
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 *           HTML table tags inserted in wrong place in pakcage use page
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * @author dkramer
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    32
 * @library ../lib
36526
3b41f1c69604 8142968: Module System implementation
alanb
parents: 35426
diff changeset
    33
 * @modules jdk.javadoc/jdk.javadoc.internal.tool
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    34
 * @build JavadocTester
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 * @run main ValidHtml
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    38
public class ValidHtml extends JavadocTester {
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 7681
diff changeset
    39
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    40
    public static void main(String... args) throws Exception {
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    41
        ValidHtml tester = new ValidHtml();
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    42
        tester.runTests();
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    43
    }
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    45
    @Test
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    46
    void test() {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
        // Test for all cases except the split index page
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    48
        javadoc("-d", "out",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    49
                    "-doctitle", "Document Title",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    50
                    "-windowtitle", "Window Title",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    51
                    "-use",
50293
edfb87b2520e 8196202: Javadoc should not generate frames by default
jjg
parents: 49139
diff changeset
    52
                    "--frames",
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    53
                    "-overview", testSrc("overview.html"),
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    54
                    "-sourcepath", testSrc,
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    55
                    "p1", "p2");
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    56
        checkExit(Exit.OK);
29429
964498d4dcec 8074521: Generate iframe instead of frame and frameset for index.html page
bpatel
parents: 24399
diff changeset
    57
        // Test for IFRAME element:
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    58
        checkOutput("index.html", true,
29429
964498d4dcec 8074521: Generate iframe instead of frame and frameset for index.html page
bpatel
parents: 24399
diff changeset
    59
                "<iframe");
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    60
        // Test the table elements are in the correct order:
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    61
        checkOutput("p1/package-use.html", true,
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    62
                "</td>\n"
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 23971
diff changeset
    63
                + "</tr>");
49139
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    64
        String HTML5 = "<!DOCTYPE HTML>";
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    65
        checkValidHTML(HTML5);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
49139
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    68
    @Test
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    69
    void test_html4() {
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    70
        // Test for all cases except the split index page
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    71
        javadoc("-d", "out-html4",
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    72
                "-html4",
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    73
                "-doctitle", "Document Title",
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    74
                "-windowtitle", "Window Title",
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    75
                "-use",
50293
edfb87b2520e 8196202: Javadoc should not generate frames by default
jjg
parents: 49139
diff changeset
    76
                "--frames",
49139
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    77
                "-overview", testSrc("overview.html"),
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    78
                "-sourcepath", testSrc,
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    79
                "p1", "p2");
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    80
        checkExit(Exit.OK);
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    81
        String HTML4 = "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">";
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    82
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    83
        checkValidHTML(HTML4);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
}
49139
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    85
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    86
    void checkValidHTML(String doctype) {
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    87
        // Test the proper DOCTYPE element are present:
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    88
        checkOutput("index.html", true, doctype);
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    89
        checkOutput("overview-summary.html", true, doctype);
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    90
        checkOutput("p1/package-summary.html", true, doctype);
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    91
        checkOutput("p1/C.html", true, doctype);
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    92
        checkOutput("overview-frame.html", true, doctype);
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    93
        checkOutput("allclasses-frame.html", true, doctype);
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    94
        checkOutput("p1/package-frame.html", true, doctype);
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    95
    }
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 47216
diff changeset
    96
}