test/langtools/jdk/javadoc/doclet/testModules/TestModuleServicesLink.java
author jjg
Wed, 07 Feb 2018 11:28:23 -0800
changeset 48759 ffa68af7da87
parent 47216 71c04702a3d5
child 49551 0d4786e42471
permissions -rw-r--r--
8195795: Organize output files by module/package, not just package Reviewed-by: ksrini, mchung, erikj
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
46082
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
     1
/*
48759
ffa68af7da87 8195795: Organize output files by module/package, not just package
jjg
parents: 47216
diff changeset
     2
 * Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
46082
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
     4
 *
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
     7
 * published by the Free Software Foundation.
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
     8
 *
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    13
 * accompanied this code).
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    14
 *
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    18
 *
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    21
 * questions.
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    22
 */
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    23
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    24
/*
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    25
 * @test
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    26
 * @bug 8185151
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    27
 * @summary test that navigation summary links are not linked when there are no dependencies
46107
d2346d1007f5 8185788: langtools test jdk/javadoc/doclet/testModules/TestModuleServicesLink.java fails with compilation error
mli
parents: 46082
diff changeset
    28
 * @modules jdk.compiler/com.sun.tools.javac.api
d2346d1007f5 8185788: langtools test jdk/javadoc/doclet/testModules/TestModuleServicesLink.java fails with compilation error
mli
parents: 46082
diff changeset
    29
 *          jdk.compiler/com.sun.tools.javac.main
d2346d1007f5 8185788: langtools test jdk/javadoc/doclet/testModules/TestModuleServicesLink.java fails with compilation error
mli
parents: 46082
diff changeset
    30
 *          jdk.javadoc/jdk.javadoc.internal.api
46082
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    31
 *          jdk.javadoc/jdk.javadoc.internal.tool
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    32
 * @library ../lib /tools/lib
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    33
 * @build toolbox.ToolBox toolbox.ModuleBuilder JavadocTester
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    34
 * @run main TestModuleServicesLink
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    35
 */
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    36
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    37
import java.nio.file.Path;
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    38
import java.nio.file.Paths;
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    39
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    40
import toolbox.*;
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    41
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    42
public class TestModuleServicesLink extends JavadocTester {
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    43
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    44
    public final ToolBox tb;
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    45
    public static void main(String... args) throws Exception {
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    46
        TestModuleServicesLink  tester = new TestModuleServicesLink ();
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    47
        tester.runTests(m -> new Object[] { Paths.get(m.getName()) });
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    48
    }
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    49
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    50
    public TestModuleServicesLink () {
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    51
        tb = new ToolBox();
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    52
    }
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    53
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    54
    @Test
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    55
    public void checkNavbarWithServices1(Path base) throws Exception {
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    56
        ModuleBuilder mb = new ModuleBuilder(tb, "m")
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    57
                .comment("module m.\n@uses p1.A")
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    58
                .uses("p1.A")
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    59
                .uses("p1.B")
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    60
                .exports("p1")
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    61
                .classes("package p1; public class A {}")
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    62
                .classes("package p1; public class B {}");
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    63
        mb.write(base);
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    64
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    65
        javadoc("-d", base.toString() + "/out",
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    66
                "-quiet",
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    67
                "--module-source-path", base.toString(),
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    68
                "--module", "m");
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    69
        checkExit(Exit.OK);
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    70
48759
ffa68af7da87 8195795: Organize output files by module/package, not just package
jjg
parents: 47216
diff changeset
    71
        checkOutput("m/module-summary.html", true,
46082
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    72
                "<a href=\"#module.description\">Description</a>&nbsp;|"
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    73
                + "&nbsp;Modules&nbsp;|"
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    74
                + "&nbsp;<a href=\"#packages.summary\">Packages</a>&nbsp;|"
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    75
                + "&nbsp;<a href=\"#services.summary\">Services</a>");
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    76
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    77
    }
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    78
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    79
    @Test
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    80
    public void checkNavbarWithServices2(Path base) throws Exception {
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    81
        ModuleBuilder mb = new ModuleBuilder(tb, "m")
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    82
                        .comment("module m.\n@provides p1.A")
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    83
                        .provides("p1.A", "p1.B")
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    84
                        .exports("p1")
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    85
                        .classes("package p1; public interface A {}")
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    86
                        .classes("package p1; public class B implements A {}");
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    87
        mb.write(base);
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    88
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    89
        javadoc("-d", base.toString() + "/out",
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    90
                "-quiet",
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    91
                "--module-source-path", base.toString(),
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    92
                "--module", "m");
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    93
        checkExit(Exit.OK);
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    94
48759
ffa68af7da87 8195795: Organize output files by module/package, not just package
jjg
parents: 47216
diff changeset
    95
        checkOutput("m/module-summary.html", true,
46082
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    96
                "<a href=\"#module.description\">Description</a>&nbsp;|"
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    97
                + "&nbsp;Modules&nbsp;|"
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    98
                + "&nbsp;<a href=\"#packages.summary\">Packages</a>&nbsp;|"
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
    99
                + "&nbsp;<a href=\"#services.summary\">Services</a>");
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   100
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   101
    }
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   102
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   103
    @Test
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   104
    public void checkNavbarWithoutServices(Path base) throws Exception {
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   105
        ModuleBuilder mb = new ModuleBuilder(tb, "m")
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   106
                .exports("p1")
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   107
                .classes("package p1; public class A {}")
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   108
                .classes("package p1; public class B {}");
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   109
        mb.write(base);
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   110
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   111
        javadoc("-d", base.toString() + "/out",
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   112
                "-quiet",
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   113
                "--module-source-path", base.toString(),
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   114
                "--module", "m");
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   115
        checkExit(Exit.OK);
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   116
48759
ffa68af7da87 8195795: Organize output files by module/package, not just package
jjg
parents: 47216
diff changeset
   117
        checkOutput("m/module-summary.html", true,
46082
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   118
                "Description&nbsp;|&nbsp;Modules&nbsp;|"
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   119
                + "&nbsp;<a href=\"#packages.summary\">Packages</a>&nbsp;|"
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   120
                + "&nbsp;Services");
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   121
    }
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   122
c65be9fae87b 8185151: doclet may create a link to a missing anchor/id
pmuthuswamy
parents:
diff changeset
   123
}