TestUserDoclet.java revision 3294:9adfb22ff08f 
1/*
2 * Copyright (c) 2011, 2015, 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.*;
32import com.sun.javadoc.Doclet;
33import com.sun.javadoc.RootDoc;
34
35public class TestUserDoclet extends Doclet {
36    public static void main(String... args) throws Exception {
37        new TestUserDoclet().run();
38    }
39
40    static final String docletWarning = "warning from test doclet";
41
42    /** Main doclet method. */
43    public static boolean start(RootDoc root) {
44        root.printWarning(null, docletWarning);
45        return true;
46    }
47
48    /** Main test method. */
49    void run() throws Exception {
50        File javaHome = new File(System.getProperty("java.home"));
51        File javadoc = new File(new File(javaHome, "bin"), "javadoc");
52        File testSrc = new File(System.getProperty("test.src"));
53        File testClasses = new File(System.getProperty("test.classes"));
54
55        // run javadoc in separate process to ensure doclet executed under
56        // normal user conditions w.r.t. classloader
57        String thisClassName = TestUserDoclet.class.getName();
58        Process p = new ProcessBuilder()
59            .command(javadoc.getPath(),
60                "-J-Xpatch:" + System.getProperty("jdk.launcher.patch.0", ""),
61                "-doclet", thisClassName,
62                "-docletpath", testClasses.getPath(),
63                new File(testSrc, thisClassName + ".java").getPath())
64            .redirectErrorStream(true)
65            .start();
66
67        int actualDocletWarnCount = 0;
68        int reportedDocletWarnCount = 0;
69        BufferedReader in = new BufferedReader(new InputStreamReader(p.getInputStream()));
70        try {
71            String line;
72            while ((line = in.readLine()) != null) {
73                System.err.println(line);
74                if (line.contains(docletWarning))
75                    actualDocletWarnCount++;
76                if (line.matches("[0-9]+ warning(s)?"))
77                    reportedDocletWarnCount =
78                            Integer.valueOf(line.substring(0, line.indexOf(" ")));
79            }
80        } finally {
81            in.close();
82        }
83        int rc = p.waitFor();
84        if (rc != 0)
85            System.err.println("javadoc failed, rc:" + rc);
86
87        int expectedDocletWarnCount = 1;
88        checkEqual("actual", actualDocletWarnCount, "expected", expectedDocletWarnCount);
89        checkEqual("actual", actualDocletWarnCount, "reported", reportedDocletWarnCount);
90    }
91
92    void checkEqual(String l1, int i1, String l2, int i2) throws Exception {
93        if (i1 != i2)
94            throw new Exception(l1 + " warn count, " + i1 + ", does not match "
95                        + l2 + " warn count, " + i2);
96    }
97
98}
99