test/langtools/jdk/javadoc/tool/6958836/Test.java
author bpatel
Tue, 06 Mar 2018 10:45:47 -0800
changeset 49139 771616d26ca1
parent 48521 30243cf1503e
permissions -rw-r--r--
8182765: HTML5 must be the default javadoc codegen mode in the near future Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5850
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
     1
/*
48521
30243cf1503e 8194955: Warn when default HTML version is used
jjg
parents: 47216
diff changeset
     2
 * Copyright (c) 2010, 2018, Oracle and/or its affiliates. All rights reserved.
5850
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
     4
 *
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
     7
 * published by the Free Software Foundation.
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
     8
 *
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    13
 * accompanied this code).
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    14
 *
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    18
 *
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    21
 * questions.
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    22
 */
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    23
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    24
/*
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    25
 * @test
49139
771616d26ca1 8182765: HTML5 must be the default javadoc codegen mode in the near future
bpatel
parents: 48521
diff changeset
    26
 * @bug 6958836 8002168 8182765
5850
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    27
 * @summary javadoc should support -Xmaxerrs and -Xmaxwarns
36526
3b41f1c69604 8142968: Module System implementation
alanb
parents: 35426
diff changeset
    28
 * @modules jdk.javadoc/jdk.javadoc.internal.tool
5850
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    29
 */
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    30
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    31
import java.io.*;
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    32
import java.util.*;
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    33
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    34
public class Test {
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    35
    public static void main(String... args) throws Exception {
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    36
        new Test().run();
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    37
    }
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    38
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    39
    void run() throws Exception {
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    40
        javadoc("errs",  list(),                   10,  0);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    41
        javadoc("errs",  list("-Xmaxerrs",   "0"), 10,  0);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    42
        javadoc("errs",  list("-Xmaxerrs",   "2"),  2,  0);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    43
        javadoc("errs",  list("-Xmaxerrs",   "4"),  4,  0);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    44
        javadoc("errs",  list("-Xmaxerrs",  "20"), 10,  0);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    45
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    46
        javadoc("warns", list(),                    0, 10);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    47
        javadoc("warns", list("-Xmaxwarns",  "0"),  0, 10);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    48
        javadoc("warns", list("-Xmaxwarns",  "2"),  0,  2);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    49
        javadoc("warns", list("-Xmaxwarns",  "4"),  0,  4);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    50
        javadoc("warns", list("-Xmaxwarns", "20"),  0, 10);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    51
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    52
        if (errors > 0)
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    53
            throw new Exception(errors + " errors occurred.");
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    54
    }
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    55
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    56
    void javadoc(String pkg, List<String> testOpts,
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    57
                int expectErrs, int expectWarns) {
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    58
        System.err.println("Test " + (++count) + ": " + pkg + " " + testOpts);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    59
        File testOutDir = new File("test" + count);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    60
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    61
        List<String> opts = new ArrayList<String>();
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    62
        // Force en_US locale in lieu of something like -XDrawDiagnostics.
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    63
        // For some reason, this must be the first option when used.
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    64
        opts.addAll(list("-locale", "en_US"));
15354
52a04c670c05 8004834: Add doclint support into javadoc
jjg
parents: 14442
diff changeset
    65
        opts.add("-Xdoclint:none");
5850
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    66
        opts.addAll(list("-classpath", System.getProperty("test.src")));
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    67
        opts.addAll(list("-d", testOutDir.getPath()));
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    68
        opts.addAll(testOpts);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    69
        opts.add(pkg);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    70
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    71
        StringWriter errSW = new StringWriter();
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    72
        PrintWriter errPW = new PrintWriter(errSW);
35426
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 30730
diff changeset
    73
        int rc = jdk.javadoc.internal.tool.Main.execute(
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 30730
diff changeset
    74
                opts.toArray(new String[opts.size()]),
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 30730
diff changeset
    75
                errPW);
5850
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    76
        System.err.println("rc: " + rc);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    77
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    78
        errPW.close();
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    79
        String errOut = errSW.toString();
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    80
        System.err.println("Errors:\n" + errOut);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    81
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    82
        check(errOut, "Errors.java", expectErrs);
35426
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 30730
diff changeset
    83
        check(errOut, " warning ", expectWarns); // requires -locale en_US
5850
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    84
    }
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    85
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    86
    void check(String text, String expectText, int expectCount) {
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    87
        int foundCount = 0;
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    88
        for (String line: text.split("[\r\n]+")) {
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    89
            if (line.contains(expectText))
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    90
                foundCount++;
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    91
        }
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    92
        if (foundCount != expectCount) {
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    93
            error("incorrect number of matches found: " + foundCount
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    94
                  + ", expected: " + expectCount);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    95
        }
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    96
    }
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    97
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    98
    private List<String> list(String... args) {
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
    99
        return Arrays.asList(args);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
   100
    }
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
   101
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
   102
    void error(String msg) {
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
   103
        System.err.println(msg);
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
   104
        errors++;
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
   105
    }
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
   106
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
   107
    int count;
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
   108
    int errors;
6f095ff5b469 6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
diff changeset
   109
}