archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-09-18 01:54:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

6964914: javadoc does not output number of warnings using user written doclet

Browse source 
Reviewed-by: bpatel
This commit is contained in:
Jonathan Gibbons 2011-03-04 19:59:04 -08:00
parent 75c64565c4
commit 9365637c4a
11 changed files with 425 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

99
langtools/test/tools/javadoc/6964914/TestUserDoclet.java Normal file
View file

@ -0,0 +1,99 @@
/*
* Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* @test
* @bug 6964914
* @summary javadoc does not output number of warnings using user written doclet
*/
import java.io.*;
import com.sun.javadoc.Doclet;
import com.sun.javadoc.RootDoc;
public class TestUserDoclet extends Doclet {
public static void main(String... args) throws Exception {
new TestUserDoclet().run();
}
static final String docletWarning = "warning from test doclet";
/** Main doclet method. */
public static boolean start(RootDoc root) {
root.printWarning(null, docletWarning);
return true;
}
/** Main test method. */
void run() throws Exception {
File javaHome = new File(System.getProperty("java.home"));
if (javaHome.getName().equals("jre"))
javaHome = javaHome.getParentFile();
File javadoc = new File(new File(javaHome, "bin"), "javadoc");
File testSrc = new File(System.getProperty("test.src"));
File testClasses = new File(System.getProperty("test.classes"));
// run javadoc in separate process to ensure doclet executed under
// normal user conditions w.r.t. classloader
String thisClassName = TestUserDoclet.class.getName();
Process p = new ProcessBuilder()
.command(javadoc.getPath(),
"-J-Xbootclasspath:" + System.getProperty("sun.boot.class.path"),
"-doclet", thisClassName,
"-docletpath", testClasses.getPath(),
new File(testSrc, thisClassName + ".java").getPath())
.redirectErrorStream(true)
.start();
int actualDocletWarnCount = 0;
int reportedDocletWarnCount = 0;
BufferedReader in = new BufferedReader(new InputStreamReader(p.getInputStream()));
try {
String line;
while ((line = in.readLine()) != null) {
System.err.println(line);
if (line.contains(docletWarning))
actualDocletWarnCount++;
if (line.matches("[0-9]+ warning(s)?"))
reportedDocletWarnCount =
Integer.valueOf(line.substring(0, line.indexOf(" ")));
}
} finally {
in.close();
}
int rc = p.waitFor();
if (rc != 0)
System.err.println("javadoc failed, rc:" + rc);
int expectedDocletWarnCount = 1;
checkEqual("actual", actualDocletWarnCount, "expected", expectedDocletWarnCount);
checkEqual("actual", actualDocletWarnCount, "reported", reportedDocletWarnCount);
}
void checkEqual(String l1, int i1, String l2, int i2) throws Exception {
if (i1 != i2)
throw new Exception(l1 + " warn count, " + i1 + ", does not match "
+ l2 + " warn count, " + i2);
}
}