test/langtools/jdk/javadoc/doclet/testDocFiles/TestDocFiles.java
author jjg
Thu, 21 Nov 2019 13:41:24 -0800
changeset 59210 78184b74af6e
parent 53097 2e82ca64b25d
permissions -rw-r--r--
8234051: doclet crashes if HTML files in module doc-files directories Reviewed-by: hannesw
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
16324
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
     1
/*
53097
2e82ca64b25d 8215516: Move JavadocTester to a named package
jjg
parents: 47216
diff changeset
     2
 * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved.
16324
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
     4
 *
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
     7
 * published by the Free Software Foundation.
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
     8
 *
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    13
 * accompanied this code).
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    14
 *
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    18
 *
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    21
 * questions.
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    22
 */
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    23
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    24
/*
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    25
 * @test
59210
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    26
 * @bug 8008949 8234051
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    27
 * @summary doclet crashes if HTML files in module doc-files directories
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    28
 * @library /tools/lib ../../lib
36526
3b41f1c69604 8142968: Module System implementation
alanb
parents: 35426
diff changeset
    29
 * @modules jdk.javadoc/jdk.javadoc.internal.tool
59210
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    30
 * @build toolbox.ToolBox javadoc.tester.*
16324
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    31
 * @run main TestDocFiles
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    32
 */
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    33
59210
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    34
import java.io.IOException;
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    35
import java.nio.file.Path;
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    36
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    37
import toolbox.ToolBox;
53097
2e82ca64b25d 8215516: Move JavadocTester to a named package
jjg
parents: 47216
diff changeset
    38
import javadoc.tester.JavadocTester;
2e82ca64b25d 8215516: Move JavadocTester to a named package
jjg
parents: 47216
diff changeset
    39
16324
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    40
public class TestDocFiles extends JavadocTester {
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    41
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    42
    public static void main(String... args) throws Exception {
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    43
        TestDocFiles tester = new TestDocFiles();
59210
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    44
        tester.runTests(m -> new Object[] { Path.of(m.getName()) });
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    45
    }
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    46
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    47
    ToolBox tb = new ToolBox();
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    48
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    49
    /**
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    50
     * Check doc-files support for a package that is not in a module.
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    51
     * @param base the base directory for scratch files
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    52
     * @throws IOException if an exception occurs
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    53
     */
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    54
    @Test
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    55
    public void testPackage(Path base) throws IOException {
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    56
        Path src = base.resolve("src");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    57
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    58
        // write the skeletal Java files
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    59
        tb.writeJavaFiles(src,
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    60
                "package p; public class C { }\n");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    61
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    62
        // write the doc files for the package
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    63
        Path pkgDocFiles = src.resolve("p").resolve("doc-files");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    64
        tb.writeFile(pkgDocFiles.resolve("pkg-file.txt"),
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    65
                "package text file\n");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    66
        tb.writeFile(pkgDocFiles.resolve("pkg-file.html"),
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    67
                "<html>\n"
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    68
                + "<head><title>Package HTML file</title></head>\n"
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    69
                + "<body><h1>Package HTML file</h1>File content</body>\n"
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    70
                + "</html>\n");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    71
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    72
        javadoc("-d", base.resolve("out").toString(),
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    73
                "--source-path", src.toString(),
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    74
                "p");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    75
        checkExit(Exit.OK);
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    76
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    77
        checkOutput("p/doc-files/pkg-file.txt", true,
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    78
                "package text file");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    79
        checkOutput("p/doc-files/pkg-file.html", true,
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    80
                "Package HTML file");
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    81
    }
16324
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
    82
59210
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    83
    /**
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    84
     * Check doc-files support for a module and a package that is in a module.
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    85
     * @param base the base directory for scratch files
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    86
     * @throws IOException if an exception occurs
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    87
     */
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
    88
    @Test
59210
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    89
    public void testModules(Path base) throws IOException {
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    90
        Path src = base.resolve("src");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    91
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    92
        // write the skeletal Java files
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    93
        tb.writeJavaFiles(src,
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    94
                "module m { exports p; }\n",
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    95
                "package p; public class C { }\n");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    96
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    97
        // write the doc files for the module
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    98
        Path mdlDocFiles = src.resolve("doc-files");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
    99
        tb.writeFile(mdlDocFiles.resolve("mdl-file.txt"),
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   100
                "module text file\n");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   101
        tb.writeFile(mdlDocFiles.resolve("mdl-file.html"),
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   102
                "<html>\n"
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   103
                + "<head><title>Module HTML file</title></head>\n"
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   104
                + "<body><h1>Module HTML file</h1>File content</body>\n"
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   105
                + "</html>\n");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   106
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   107
        // write the doc files for a package in the module
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   108
        Path pkgDocFiles = src.resolve("p").resolve("doc-files");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   109
        tb.writeFile(pkgDocFiles.resolve("pkg-file.txt"),
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   110
                "package text file\n");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   111
        tb.writeFile(pkgDocFiles.resolve("pkg-file.html"),
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   112
                "<html>\n"
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   113
                + "<head><title>Package HTML file</title></head>\n"
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   114
                + "<body><h1>Package HTML file</h1>File content</body>\n"
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   115
                + "</html>\n");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   116
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   117
        javadoc("-d", base.resolve("out").toString(),
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   118
                "--source-path", src.toString(),
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   119
                "--module", "m");
24399
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
   120
        checkExit(Exit.OK);
af1a0220d0fa 8038730: Clean up the way JavadocTester is invoked, and checks for errors.
jjg
parents: 24072
diff changeset
   121
59210
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   122
        checkOutput("m/doc-files/mdl-file.txt", true,
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   123
                "module text file");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   124
        checkOutput("m/doc-files/mdl-file.html", true,
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   125
                "Module HTML file");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   126
        checkOutput("m/p/doc-files/pkg-file.txt", true,
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   127
                "package text file");
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   128
        checkOutput("m/p/doc-files/pkg-file.html", true,
78184b74af6e 8234051: doclet crashes if HTML files in module doc-files directories
jjg
parents: 53097
diff changeset
   129
                "Package HTML file");
16324
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
   130
    }
332d7f5fdf62 8008949: javadoc stopped copying doc-files
jjg
parents:
diff changeset
   131
}