test/langtools/tools/javadoc/MaxWarns.java
author erikj
Tue, 12 Sep 2017 19:03:39 +0200
changeset 47216 71c04702a3d5
parent 45742 langtools/test/tools/javadoc/MaxWarns.java@36bf0f2436ad
permissions -rw-r--r--
8187443: Forest Consolidation: Move files to unified layout Reviewed-by: darcy, ihse
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
15041
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
     1
/*
45742
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
     2
 * Copyright (c) 2013, 2017, Oracle and/or its affiliates. All rights reserved.
15041
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
     4
 *
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
     7
 * published by the Free Software Foundation.
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
     8
 *
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    13
 * accompanied this code).
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    14
 *
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    18
 *
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    21
 * questions.
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    22
 */
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    23
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    24
/*
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    25
 * @test
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    26
 * @bug 8005644
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    27
 * @summary set default max errs and max warns
30730
d3ce7619db2c 8076543: Add @modules as needed to the langtools tests
akulyakh
parents: 15354
diff changeset
    28
 * @modules jdk.javadoc/com.sun.tools.doclets.standard
15041
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    29
 */
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    30
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    31
import java.io.File;
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    32
import java.io.PrintWriter;
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    33
import java.io.StringWriter;
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    34
import java.util.regex.Matcher;
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    35
import java.util.regex.Pattern;
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    36
45742
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
    37
import com.sun.javadoc.DocErrorReporter;
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
    38
import com.sun.javadoc.RootDoc;
15041
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    39
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    40
public class MaxWarns {
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    41
    public static void main(String... args) throws Exception {
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    42
        new MaxWarns().run();
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    43
    }
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    44
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    45
    void run() throws Exception {
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    46
        final int defaultMaxWarns = 100;
45742
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
    47
        File f = new File(System.getProperty("test.src"), "MaxWarns.java");
15041
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    48
        String out = javadoc(f);
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    49
        check(out, defaultMaxWarns);
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    50
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    51
        if (errors > 0)
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    52
            throw new Exception(errors + " errors occurred");
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    53
    }
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    54
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    55
    String javadoc(File f) {
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    56
        StringWriter sw = new StringWriter();
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    57
        PrintWriter pw = new PrintWriter(sw);
45742
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
    58
        String[] args = { f.getPath() };
15041
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    59
        int rc = com.sun.tools.javadoc.Main.execute("javadoc", pw, pw, pw,
45742
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
    60
                "MaxWarns$TestDoclet",
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
    61
                getClass().getClassLoader(), args);
15041
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    62
        pw.flush();
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    63
        return sw.toString();
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    64
    }
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    65
45742
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
    66
    private static final String WARNING_TEXT = "count ";
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
    67
15041
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    68
    void check(String out, int count) {
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    69
        System.err.println(out);
45742
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
    70
        Pattern warn = Pattern.compile("warning - " + WARNING_TEXT + "[0-9]+");
15041
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    71
        Matcher m = warn.matcher(out);
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    72
        int n = 0;
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    73
        for (int start = 0; m.find(start); start = m.start() + 1) {
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    74
            n++;
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    75
        }
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    76
        if (n != count)
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    77
            error("unexpected number of warnings reported: " + n + "; expected: " + count);
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    78
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    79
        Pattern warnCount = Pattern.compile("(?ms).*^([0-9]+) warnings$.*");
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    80
        m = warnCount.matcher(out);
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    81
        if (m.matches()) {
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    82
            n = Integer.parseInt(m.group(1));
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    83
            if (n != count)
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    84
                error("unexpected number of warnings reported: " + n + "; expected: " + count);
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    85
        } else
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    86
            error("total count not found");
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    87
    }
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    88
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    89
    void error(String msg) {
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    90
        System.err.println("Error: " + msg);
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    91
        errors++;
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    92
    }
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    93
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
    94
    int errors;
45742
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
    95
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
    96
    public static class TestDoclet {
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
    97
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
    98
        public static boolean start(RootDoc root) {
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
    99
            // generate 150 warnings
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
   100
            for (int i = 1 ; i <= 150 ; i++) {
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
   101
                root.printWarning(WARNING_TEXT + i);
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
   102
            }
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
   103
            return true;
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
   104
        }
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
   105
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
   106
        public static int optionLength(String option) {
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
   107
            return 0;
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
   108
        }
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
   109
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
   110
        public static boolean validOptions(String[][] options, DocErrorReporter reporter) {
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
   111
            return true;
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
   112
        }
36bf0f2436ad 8177511: Remove the old standard doclet
ksrini
parents: 30730
diff changeset
   113
    }
15041
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
   114
}
0676d2a112ff 8005644: set default max errs and max warns
jjg
parents:
diff changeset
   115