langtools/test/com/sun/javadoc/testPackagePage/TestPackagePage.java
author jjg
Wed, 16 Apr 2014 16:17:09 -0700
changeset 23971 f5ff1f5a8dee
parent 14357 faf9cde2817b
child 24065 fc4022e50129
permissions -rw-r--r--
8031649: Clean up javadoc tests Reviewed-by: jjg Contributed-by: neil.toda@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 14357
diff changeset
     2
 * Copyright (c) 2002, 2014, 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: 1787
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1787
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1787
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
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
 * @bug 4492643 4689286
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary Test that a package page is properly generated when a .java file
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 * passed to Javadoc.  Also test that the proper package links are generated
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 * when single or multiple packages are documented.
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 * @author jamieh
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * @library ../lib/
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @build JavadocTester
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * @build TestPackagePage
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 * @run main TestPackagePage
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
public class TestPackagePage extends JavadocTester {
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
    private static final String BUG_ID = "4492643-4689286";
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
    private static final String[][] TEST1 = {
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 14357
diff changeset
    41
        {BUG_ID + "-1/com/pkg/package-summary.html",
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
            "This is a package page."
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
        //With just one package, all general pages link to the single package page.
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 14357
diff changeset
    45
        {BUG_ID + "-1/com/pkg/C.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    46
            "<a href=\"../../com/pkg/package-summary.html\">Package</a>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
        },
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 14357
diff changeset
    48
        {BUG_ID + "-1/com/pkg/package-tree.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    49
            "<li><a href=\"../../com/pkg/package-summary.html\">Package</a></li>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
        },
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 14357
diff changeset
    51
        {BUG_ID + "-1/deprecated-list.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    52
            "<li><a href=\"com/pkg/package-summary.html\">Package</a></li>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
        },
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 14357
diff changeset
    54
        {BUG_ID + "-1/index-all.html",
14357
faf9cde2817b 8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents: 7681
diff changeset
    55
            "<li><a href=\"com/pkg/package-summary.html\">Package</a></li>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
        },
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 14357
diff changeset
    57
        {BUG_ID + "-1/help-doc.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    58
            "<li><a href=\"com/pkg/package-summary.html\">Package</a></li>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
    private static final String[][] TEST2 = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
        //With multiple packages, there is no package link in general pages.
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 14357
diff changeset
    64
        {BUG_ID + "-2/deprecated-list.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    65
            "<li>Package</li>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
        },
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 14357
diff changeset
    67
        {BUG_ID + "-2/index-all.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    68
            "<li>Package</li>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
        },
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 14357
diff changeset
    70
        {BUG_ID + "-2/help-doc.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    71
            "<li>Package</li>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
    private static final String[] ARGS1 =
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
        new String[] {
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
            "-d", BUG_ID + "-1", "-sourcepath", SRC_DIR,
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 14357
diff changeset
    78
            SRC_DIR + "/com/pkg/C.java"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
        };
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
    private static final String[] ARGS2 =
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
        new String[] {
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
            "-d", BUG_ID + "-2", "-sourcepath", SRC_DIR,
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
            "com.pkg", "pkg2"
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
        };
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
     * The entry point of the test.
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
     * @param args the array of command line arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
    public static void main(String[] args) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
        TestPackagePage tester = new TestPackagePage();
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
        run(tester, ARGS1, TEST1, NO_TEST);
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
        run(tester, ARGS2, TEST2, NO_TEST);
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
        tester.printSummary();
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
    public String getBugId() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
        return BUG_ID;
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
    public String getBugName() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
        return getClass().getName();
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
}