• file
• revisions
• annotate
• diff
• comparison
• raw

test/tools/javadoc/doclint/DocLintTest.java@959103a6100f (annotated)

test/tools/javadoc/doclint/DocLintTest.java

Wed, 27 Apr 2016 01:34:52 +0800

author

aoqi

date

Wed, 27 Apr 2016 01:34:52 +0800

changeset 0

959103a6100f

child 2525

2eb010b6cb22

permissions

-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation.
aoqi@0	8	*
aoqi@0	9	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	12	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	13	* accompanied this code).
aoqi@0	14	*
aoqi@0	15	* You should have received a copy of the GNU General Public License version
aoqi@0	16	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	17	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	18	*
aoqi@0	19	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	20	* or visit www.oracle.com if you need additional information or have any
aoqi@0	21	* questions.
aoqi@0	22	*/
aoqi@0	23
aoqi@0	24	/*
aoqi@0	25	* @test
aoqi@0	26	* @bug 8004834 8007610
aoqi@0	27	* @summary Add doclint support into javadoc
aoqi@0	28	*/
aoqi@0	29
aoqi@0	30	import java.io.File;
aoqi@0	31	import java.io.PrintWriter;
aoqi@0	32	import java.io.StringWriter;
aoqi@0	33	import java.net.URI;
aoqi@0	34	import java.util.Arrays;
aoqi@0	35	import java.util.Collections;
aoqi@0	36	import java.util.EnumSet;
aoqi@0	37	import java.util.List;
aoqi@0	38	import java.util.Set;
aoqi@0	39	import java.util.regex.Matcher;
aoqi@0	40	import java.util.regex.Pattern;
aoqi@0	41
aoqi@0	42	import javax.tools.Diagnostic;
aoqi@0	43	import javax.tools.DocumentationTool;
aoqi@0	44	import javax.tools.DocumentationTool.DocumentationTask;
aoqi@0	45	import javax.tools.JavaFileObject;
aoqi@0	46	import javax.tools.SimpleJavaFileObject;
aoqi@0	47	import javax.tools.StandardJavaFileManager;
aoqi@0	48	import javax.tools.StandardLocation;
aoqi@0	49	import javax.tools.ToolProvider;
aoqi@0	50	import static javax.tools.Diagnostic.Kind.*;
aoqi@0	51
aoqi@0	52	import com.sun.tools.javac.main.Main;
aoqi@0	53
aoqi@0	54	public class DocLintTest {
aoqi@0	55	public static void main(String... args) throws Exception {
aoqi@0	56	new DocLintTest().run();
aoqi@0	57	}
aoqi@0	58
aoqi@0	59	DocumentationTool javadoc;
aoqi@0	60	StandardJavaFileManager fm;
aoqi@0	61	JavaFileObject file;
aoqi@0	62
aoqi@0	63	final String code =
aoqi@0	64	/* 01 */ "/** Class comment. */\n" +
aoqi@0	65	/* 02 */ "public class Test {\n" +
aoqi@0	66	/* 03 */ " /** Method comment. */\n" +
aoqi@0	67	/* 04 */ " public void method() { }\n" +
aoqi@0	68	/* 05 */ "\n" +
aoqi@0	69	/* 06 */ " /** Syntax < error. */\n" +
aoqi@0	70	/* 07 */ " private void syntaxError() { }\n" +
aoqi@0	71	/* 08 */ "\n" +
aoqi@0	72	/* 09 */ " /** @see DoesNotExist */\n" +
aoqi@0	73	/* 10 */ " protected void referenceError() { }\n" +
aoqi@0	74	/* 11 */ "\n" +
aoqi@0	75	/* 12 */ " /** @return */\n" +
aoqi@0	76	/* 13 */ " public int emptyReturn() { return 0; }\n" +
aoqi@0	77	/* 14 */ "}\n";
aoqi@0	78
aoqi@0	79	private final String rawDiags = "-XDrawDiagnostics";
aoqi@0	80
aoqi@0	81	private enum Message {
aoqi@0	82	// doclint messages
aoqi@0	83	DL_ERR6(ERROR, "Test.java:6:16: compiler.err.proc.messager: malformed HTML"),
aoqi@0	84	DL_ERR9(ERROR, "Test.java:9:14: compiler.err.proc.messager: reference not found"),
aoqi@0	85	DL_WRN12(WARNING, "Test.java:12:9: compiler.warn.proc.messager: no description for @return"),
aoqi@0	86
aoqi@0	87	// doclint messages when -XDrawDiagnostics is not in effect
aoqi@0	88	DL_ERR9A(ERROR, "Test.java:9: error: reference not found"),
aoqi@0	89	DL_WRN12A(WARNING, "Test.java:12: warning: no description for @return"),
aoqi@0	90
aoqi@0	91	// javadoc messages about bad content: these should only appear when doclint is disabled
aoqi@0	92	JD_WRN10(WARNING, "Test.java:10: warning - Tag @see: reference not found: DoesNotExist"),
aoqi@0	93	JD_WRN13(WARNING, "Test.java:13: warning - @return tag has no arguments."),
aoqi@0	94
aoqi@0	95	// javadoc messages for bad options
aoqi@0	96	OPT_BADARG(ERROR, "javadoc: error - Invalid argument for -Xdoclint option"),
aoqi@0	97	OPT_BADQUAL(ERROR, "javadoc: error - Access qualifiers not permitted for -Xdoclint arguments");
aoqi@0	98
aoqi@0	99	final Diagnostic.Kind kind;
aoqi@0	100	final String text;
aoqi@0	101
aoqi@0	102	static Message get(String text) {
aoqi@0	103	for (Message m: values()) {
aoqi@0	104	if (m.text.equals(text))
aoqi@0	105	return m;
aoqi@0	106	}
aoqi@0	107	return null;
aoqi@0	108	}
aoqi@0	109
aoqi@0	110	Message(Diagnostic.Kind kind, String text) {
aoqi@0	111	this.kind = kind;
aoqi@0	112	this.text = text;
aoqi@0	113	}
aoqi@0	114
aoqi@0	115	@Override
aoqi@0	116	public String toString() {
aoqi@0	117	return "[" + kind + ",\"" + text + "\"]";
aoqi@0	118	}
aoqi@0	119	}
aoqi@0	120
aoqi@0	121	void run() throws Exception {
aoqi@0	122	javadoc = ToolProvider.getSystemDocumentationTool();
aoqi@0	123	fm = javadoc.getStandardFileManager(null, null, null);
aoqi@0	124	fm.setLocation(StandardLocation.CLASS_OUTPUT, Arrays.asList(new File(".")));
aoqi@0	125	file = new SimpleJavaFileObject(URI.create("Test.java"), JavaFileObject.Kind.SOURCE) {
aoqi@0	126	@Override
aoqi@0	127	public CharSequence getCharContent(boolean ignoreEncoding) {
aoqi@0	128	return code;
aoqi@0	129	}
aoqi@0	130	};
aoqi@0	131
aoqi@0	132	test(Collections.<String>emptyList(),
aoqi@0	133	Main.Result.ERROR,
aoqi@0	134	EnumSet.of(Message.DL_ERR9A, Message.DL_WRN12A));
aoqi@0	135
aoqi@0	136	test(Arrays.asList(rawDiags),
aoqi@0	137	Main.Result.ERROR,
aoqi@0	138	EnumSet.of(Message.DL_ERR9, Message.DL_WRN12));
aoqi@0	139
aoqi@0	140	test(Arrays.asList("-Xdoclint:none"),
aoqi@0	141	Main.Result.OK,
aoqi@0	142	EnumSet.of(Message.JD_WRN10, Message.JD_WRN13));
aoqi@0	143
aoqi@0	144	test(Arrays.asList(rawDiags, "-Xdoclint"),
aoqi@0	145	Main.Result.ERROR,
aoqi@0	146	EnumSet.of(Message.DL_ERR9, Message.DL_WRN12));
aoqi@0	147
aoqi@0	148	test(Arrays.asList(rawDiags, "-Xdoclint:all/public"),
aoqi@0	149	Main.Result.ERROR,
aoqi@0	150	EnumSet.of(Message.OPT_BADQUAL));
aoqi@0	151
aoqi@0	152	test(Arrays.asList(rawDiags, "-Xdoclint:all", "-public"),
aoqi@0	153	Main.Result.OK,
aoqi@0	154	EnumSet.of(Message.DL_WRN12));
aoqi@0	155
aoqi@0	156	test(Arrays.asList(rawDiags, "-Xdoclint:syntax"),
aoqi@0	157	Main.Result.OK,
aoqi@0	158	EnumSet.of(Message.DL_WRN12));
aoqi@0	159
aoqi@0	160	test(Arrays.asList(rawDiags, "-private"),
aoqi@0	161	Main.Result.ERROR,
aoqi@0	162	EnumSet.of(Message.DL_ERR6, Message.DL_ERR9, Message.DL_WRN12));
aoqi@0	163
aoqi@0	164	test(Arrays.asList(rawDiags, "-Xdoclint:syntax", "-private"),
aoqi@0	165	Main.Result.ERROR,
aoqi@0	166	EnumSet.of(Message.DL_ERR6, Message.DL_WRN12));
aoqi@0	167
aoqi@0	168	test(Arrays.asList(rawDiags, "-Xdoclint:reference"),
aoqi@0	169	Main.Result.ERROR,
aoqi@0	170	EnumSet.of(Message.DL_ERR9));
aoqi@0	171
aoqi@0	172	test(Arrays.asList(rawDiags, "-Xdoclint:badarg"),
aoqi@0	173	Main.Result.ERROR,
aoqi@0	174	EnumSet.of(Message.OPT_BADARG));
aoqi@0	175
aoqi@0	176	if (errors > 0)
aoqi@0	177	throw new Exception(errors + " errors occurred");
aoqi@0	178	}
aoqi@0	179
aoqi@0	180	void test(List<String> opts, Main.Result expectResult, Set<Message> expectMessages) {
aoqi@0	181	System.err.println("test: " + opts);
aoqi@0	182	StringWriter sw = new StringWriter();
aoqi@0	183	PrintWriter pw = new PrintWriter(sw);
aoqi@0	184	List<JavaFileObject> files = Arrays.asList(file);
aoqi@0	185	try {
aoqi@0	186	DocumentationTask t = javadoc.getTask(pw, fm, null, null, opts, files);
aoqi@0	187	boolean ok = t.call();
aoqi@0	188	pw.close();
aoqi@0	189	String out = sw.toString().replaceAll("[\r\n]+", "\n");
aoqi@0	190	if (!out.isEmpty())
aoqi@0	191	System.err.println(out);
aoqi@0	192	if (ok && expectResult != Main.Result.OK) {
aoqi@0	193	error("Compilation succeeded unexpectedly");
aoqi@0	194	} else if (!ok && expectResult != Main.Result.ERROR) {
aoqi@0	195	error("Compilation failed unexpectedly");
aoqi@0	196	} else
aoqi@0	197	check(out, expectMessages);
aoqi@0	198	} catch (IllegalArgumentException e) {
aoqi@0	199	System.err.println(e);
aoqi@0	200	String expectOut = expectMessages.iterator().next().text;
aoqi@0	201	if (expectResult != Main.Result.CMDERR)
aoqi@0	202	error("unexpected exception caught");
aoqi@0	203	else if (!e.getMessage().equals(expectOut)) {
aoqi@0	204	error("unexpected exception message: "
aoqi@0	205	+ e.getMessage()
aoqi@0	206	+ " expected: " + expectOut);
aoqi@0	207	}
aoqi@0	208	}
aoqi@0	209
aoqi@0	210	// if (errors > 0)
aoqi@0	211	// throw new Error("stop");
aoqi@0	212	}
aoqi@0	213
aoqi@0	214	private void check(String out, Set<Message> expect) {
aoqi@0	215	Pattern ignore = Pattern.compile("^(Building|Constructing|Generating|Loading|Standard|Starting| ) .*");
aoqi@0	216	Pattern stats = Pattern.compile("^([1-9]+) (error|warning)(s?)");
aoqi@0	217	Set<Message> found = EnumSet.noneOf(Message.class);
aoqi@0	218	int e = 0, w = 0;
aoqi@0	219	for (String line: out.split("[\r\n]+")) {
aoqi@0	220	if (ignore.matcher(line).matches())
aoqi@0	221	continue;
aoqi@0	222
aoqi@0	223	Matcher s = stats.matcher(line);
aoqi@0	224	if (s.matches()) {
aoqi@0	225	int i = Integer.valueOf(s.group(1));
aoqi@0	226	if (s.group(2).equals("error"))
aoqi@0	227	e++;
aoqi@0	228	else
aoqi@0	229	w++;
aoqi@0	230	continue;
aoqi@0	231	}
aoqi@0	232
aoqi@0	233	Message m = Message.get(line);
aoqi@0	234	if (m == null)
aoqi@0	235	error("Unexpected line: " + line);
aoqi@0	236	else
aoqi@0	237	found.add(m);
aoqi@0	238	}
aoqi@0	239	for (Message m: expect) {
aoqi@0	240	if (!found.contains(m))
aoqi@0	241	error("expected message not found: " + m.text);
aoqi@0	242	}
aoqi@0	243	for (Message m: found) {
aoqi@0	244	if (!expect.contains(m))
aoqi@0	245	error("unexpected message found: " + m.text);
aoqi@0	246	}
aoqi@0	247	}
aoqi@0	248
aoqi@0	249	void error(String msg) {
aoqi@0	250	System.err.println("Error: " + msg);
aoqi@0	251	errors++;
aoqi@0	252	}
aoqi@0	253
aoqi@0	254	int errors;
aoqi@0	255	}