langtools/test/com/sun/javadoc/PackagesHeader/PackagesHeader.java
author jjg
Tue, 22 Apr 2014 17:41:11 -0700
changeset 24071 b0845717434e
parent 24065 fc4022e50129
child 24072 e7549dcbc4af
permissions -rw-r--r--
8041253: Avoid redundant synonyms of NO_TEST Reviewed-by: ksrini
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: 5520
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: 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
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
 * @bug      4766385
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary  Test that the header option for upper left frame
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 *           is present for three sets of options: (1) -header,
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 *           (2) -packagesheader, and (3) -header -packagesheader
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 * @author   dkramer
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    PackagesHeader
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 * @run main PackagesHeader
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 PackagesHeader extends JavadocTester {
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
    //Test information.
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
    private static final String BUG_ID = "4766385";
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
    private static final String OUTPUT_DIR = "docs-" + BUG_ID;
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 5520
diff changeset
    43
    private static final String OUTPUT_DIR1 = "docs1-" + BUG_ID + "/";
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 5520
diff changeset
    44
    private static final String OUTPUT_DIR2 = "docs2-" + BUG_ID + "/";
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 5520
diff changeset
    45
    private static final String OUTPUT_DIR3 = "docs3-" + BUG_ID + "/";
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
     * Assign value for [ fileToSearch, stringToFind ]
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
    private static final String[][] TESTARRAY1 = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
        // Test that the -header shows up in the packages frame
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
        { OUTPUT_DIR1 + "overview-frame.html",
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
                 "Main Frame Header" }
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
    private static final String[][] TESTARRAY2 = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
        // Test that the -packagesheader string shows
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
        // up in the packages frame
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
        {  OUTPUT_DIR2 + "overview-frame.html",
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
                 "Packages Frame Header" }
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
    private static final String[][] TESTARRAY3 = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
        // Test that the both headers show up and are different
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
        { OUTPUT_DIR3 + "overview-frame.html",
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
                 "Packages Frame Header" },
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
        { OUTPUT_DIR3 + "overview-summary.html",
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
                 "Main Frame Header" }
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
    // First test with -header only
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
    private static final String[] JAVADOC_ARGS1 = new String[] {
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
            "-d", OUTPUT_DIR1,
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
            "-header", "Main Frame Header",
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
            "-sourcepath", SRC_DIR,
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
            "p1", "p2"};
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
    // Second test with -packagesheader only
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
    private static final String[] JAVADOC_ARGS2 = new String[] {
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
            "-d", OUTPUT_DIR2,
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
            "-packagesheader", "Packages Frame Header",
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
            "-sourcepath", SRC_DIR,
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
            "p1", "p2"};
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
    // Third test with both -packagesheader and -header
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
    private static final String[] JAVADOC_ARGS3 = new String[] {
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
            "-d", OUTPUT_DIR3,
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
            "-packagesheader", "Packages Frame Header",
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
            "-header", "Main Frame Header",
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
            "-sourcepath", SRC_DIR,
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
            "p1", "p2"};
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
     * The entry point of the test.
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
     * @param args the array of command line arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
    public static void main(String[] args) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
        JavadocTester tester = new PackagesHeader();
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
24071
b0845717434e 8041253: Avoid redundant synonyms of NO_TEST
jjg
parents: 24065
diff changeset
   107
        tester.run(JAVADOC_ARGS1, TESTARRAY1, NO_TEST);
b0845717434e 8041253: Avoid redundant synonyms of NO_TEST
jjg
parents: 24065
diff changeset
   108
        tester.run(JAVADOC_ARGS2, TESTARRAY2, NO_TEST);
b0845717434e 8041253: Avoid redundant synonyms of NO_TEST
jjg
parents: 24065
diff changeset
   109
        tester.run(JAVADOC_ARGS3, TESTARRAY3, NO_TEST);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
        tester.printSummary();
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   113
06bc494ca11e Initial load
duke
parents:
diff changeset
   114
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   115
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   116
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   117
    public String getBugId() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   118
        return BUG_ID;
06bc494ca11e Initial load
duke
parents:
diff changeset
   119
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   120
06bc494ca11e Initial load
duke
parents:
diff changeset
   121
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   122
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   123
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   124
    public String getBugName() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   125
        return getClass().getName();
06bc494ca11e Initial load
duke
parents:
diff changeset
   126
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   127
}