TestUserDoclet.java revision 3573:c4a18ee691c4 
1/*
2 * Copyright (c) 2011, 2016, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23
24/*
25 * @test
26 * @bug 6964914
27 * @summary javadoc does not output number of warnings using user written doclet
28 * @modules jdk.javadoc
29 */
30
31import java.io.*;
32
33import java.util.ArrayList;
34import java.util.Arrays;
35import java.util.Collections;
36import java.util.List;
37import java.util.Locale;
38import java.util.Set;
39
40import javax.lang.model.SourceVersion;
41
42import jdk.javadoc.doclet.Doclet;
43import jdk.javadoc.doclet.Reporter;
44import jdk.javadoc.doclet.DocletEnvironment;
45
46public class TestUserDoclet implements Doclet {
47    public static void main(String... args) throws Exception {
48        new TestUserDoclet().run();
49    }
50
51    static final String docletWarning = "warning from test doclet";
52
53    /** Main doclet method. */
54    public boolean run(DocletEnvironment root) {
55        reporter.print(javax.tools.Diagnostic.Kind.WARNING, docletWarning);
56        return true;
57    }
58
59    /** Main test method. */
60    void run() throws Exception {
61        File javaHome = new File(System.getProperty("java.home"));
62        File javadoc = new File(new File(javaHome, "bin"), "javadoc");
63        File testSrc = new File(System.getProperty("test.src"));
64        File testClasses = new File(System.getProperty("test.classes"));
65
66        // run javadoc in separate process to ensure doclet executed under
67        // normal user conditions w.r.t. classloader
68        String thisClassName = TestUserDoclet.class.getName();
69        List<String> cmdArgs = new ArrayList<>();
70        cmdArgs.add(javadoc.getPath());
71        cmdArgs.addAll(Arrays.asList(
72                "-doclet", thisClassName,
73                "-docletpath", testClasses.getPath(),
74                new File(testSrc, thisClassName + ".java").getPath()
75        ));
76        Process p = new ProcessBuilder()
77            .command(cmdArgs)
78            .redirectErrorStream(true)
79            .start();
80
81        int actualDocletWarnCount = 0;
82        int reportedDocletWarnCount = 0;
83        BufferedReader in = new BufferedReader(new InputStreamReader(p.getInputStream()));
84        try {
85            String line;
86            while ((line = in.readLine()) != null) {
87                System.err.println(line);
88                if (line.contains(docletWarning))
89                    actualDocletWarnCount++;
90                if (line.matches("[0-9]+ warning(s)?"))
91                    reportedDocletWarnCount =
92                            Integer.valueOf(line.substring(0, line.indexOf(" ")));
93            }
94        } finally {
95            in.close();
96        }
97        int rc = p.waitFor();
98        if (rc != 0)
99            System.err.println("javadoc failed, rc:" + rc);
100
101        int expectedDocletWarnCount = 1;
102        checkEqual("actual", actualDocletWarnCount, "expected", expectedDocletWarnCount);
103        checkEqual("actual", actualDocletWarnCount, "reported", reportedDocletWarnCount);
104    }
105
106    void checkEqual(String l1, int i1, String l2, int i2) throws Exception {
107        if (i1 != i2)
108            throw new Exception(l1 + " warn count, " + i1 + ", does not match "
109                        + l2 + " warn count, " + i2);
110    }
111
112    @Override
113    public String getName() {
114        return "Test";
115    }
116
117    @Override
118    public Set<Option> getSupportedOptions() {
119        return Collections.emptySet();
120    }
121
122    @Override
123    public SourceVersion getSupportedSourceVersion() {
124        return SourceVersion.latest();
125    }
126
127    Reporter reporter;
128    Locale locale;
129    public void init(Locale locale, Reporter reporter) {
130        this.locale = locale;
131        this.reporter = reporter;
132    }
133}
134