langtools/test/com/sun/javadoc/testWarnings/TestWarnings.java
author bpatel
Wed, 01 Dec 2010 11:02:38 -0800
changeset 7614 cfadc977ca75
parent 5520 86e4b9a9da40
child 7681 1f0819a3341f
permissions -rw-r--r--
6851834: Javadoc doclet needs a structured approach to generate the output HTML. Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     2
 * Copyright (c) 2004, 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      4515705 4804296 4702454 4697036
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary  Make sure that first sentence warning only appears once.
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 *           Make sure that only warnings/errors are printed when quiet is used.
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 *           Make sure that links to private/unincluded methods do not cause
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 *           a "link unresolved" warning.
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 *           Make sure error message starts with "error -".
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @author   jamieh
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * @library  ../lib/
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 * @build    JavadocTester
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 * @build    TestWarnings
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
 * @run main TestWarnings
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
public class TestWarnings extends JavadocTester {
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
    //Test information.
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
    private static final String BUG_ID = "4515705-4804296-4702454-4697036";
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
    //Javadoc arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
    private static final String[] ARGS = new String[] {
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
        "-d", BUG_ID, "-sourcepath", SRC_DIR, "pkg"
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
    private static final String[] ARGS2 = new String[] {
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
        "-d", BUG_ID, "-private", "-sourcepath", SRC_DIR, "pkg"
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
    //Input for string search tests.
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
    private static final String[][] TEST = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
        {WARNING_OUTPUT,
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
            "X.java:11: warning - Missing closing '}' character for inline tag"},
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
        {ERROR_OUTPUT,
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
            "package.html: error - Body tag missing from HTML"},
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
    private static final String[][] NEGATED_TEST = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
        {BUG_ID + FS + "pkg" + FS + "X.html", "can't find m()"},
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
        {BUG_ID + FS + "pkg" + FS + "X.html", "can't find X()"},
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
        {BUG_ID + FS + "pkg" + FS + "X.html", "can't find f"},
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
    private static final String[][] TEST2 = {
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    68
        {BUG_ID + FS + "pkg" + FS + "X.html", "<a href=\"../pkg/X.html#m()\"><code>m()</code></a><br/>"},
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    69
        {BUG_ID + FS + "pkg" + FS + "X.html", "<a href=\"../pkg/X.html#X()\"><code>X()</code></a><br/>"},
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    70
        {BUG_ID + FS + "pkg" + FS + "X.html", "<a href=\"../pkg/X.html#f\"><code>f</code></a><br/>"},
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
    private static final String[][] NEGATED_TEST2 = NO_TEST;
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
     * The entry point of the test.
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
     * @param args the array of command line arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
    public static void main(String[] args) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
        TestWarnings tester = new TestWarnings();
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
        run(tester, ARGS, TEST, NEGATED_TEST);
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
        run(tester, ARGS2, TEST2, NEGATED_TEST2);
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
        tester.printSummary();
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
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
    public String getBugId() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
        return BUG_ID;
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
    public String getBugName() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
        return getClass().getName();
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
}