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

test/tools/javadoc/api/basic/GetTask_DocletClassTest.java@64328fe5e4a6 (annotated)

test/tools/javadoc/api/basic/GetTask_DocletClassTest.java

Fri, 06 Sep 2013 15:31:59 -0700

author

jjg

date

Fri, 06 Sep 2013 15:31:59 -0700

changeset 2010

64328fe5e4a6

parent 0

959103a6100f

child 3834

45746e46893b

permissions

-rw-r--r--

8024434: problem running javadoc tests in samevm mode on Windows
Reviewed-by: darcy

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2012, 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 6493690
aoqi@0	27	* @summary javadoc should have a javax.tools.Tool service provider
aoqi@0	28	* @build APITest
aoqi@0	29	* @run main GetTask_DocletClassTest
aoqi@0	30	*/
aoqi@0	31
aoqi@0	32	import com.sun.javadoc.DocErrorReporter;
aoqi@0	33	import com.sun.javadoc.LanguageVersion;
aoqi@0	34	import com.sun.javadoc.RootDoc;
aoqi@0	35	import java.io.File;
aoqi@0	36	import java.util.Arrays;
aoqi@0	37	import java.util.Collections;
aoqi@0	38	import java.util.Random;
aoqi@0	39	import javax.tools.DocumentationTool;
aoqi@0	40	import javax.tools.DocumentationTool.DocumentationTask;
aoqi@0	41	import javax.tools.JavaFileObject;
aoqi@0	42	import javax.tools.StandardJavaFileManager;
aoqi@0	43	import javax.tools.ToolProvider;
aoqi@0	44
aoqi@0	45	/**
aoqi@0	46	* Tests for DocumentationTool.getTask docletClass parameter.
aoqi@0	47	*/
aoqi@0	48	public class GetTask_DocletClassTest extends APITest {
aoqi@0	49	public static void main(String... args) throws Exception {
aoqi@0	50	new GetTask_DocletClassTest().run();
aoqi@0	51	}
aoqi@0	52
aoqi@0	53	/**
aoqi@0	54	* Verify that an alternate doclet can be specified.
aoqi@0	55	*
aoqi@0	56	* There is no standard interface or superclass for a doclet;
aoqi@0	57	* the only requirement is that it provides static methods that
aoqi@0	58	* can be invoked via reflection. So, for now, the doclet is
aoqi@0	59	* specified as a class.
aoqi@0	60	* Because we cannot create and use a unique instance of the class,
aoqi@0	61	* we verify that the doclet has been called by having it record
aoqi@0	62	* (in a static field!) the comment from the last time it was invoked,
aoqi@0	63	* which is randomly generated each time the test is run.
aoqi@0	64	*/
aoqi@0	65	@Test
aoqi@0	66	public void testDoclet() throws Exception {
aoqi@0	67	Random r = new Random();
aoqi@0	68	int key = r.nextInt();
aoqi@0	69	JavaFileObject srcFile = createSimpleJavaFileObject(
aoqi@0	70	"pkg/C",
aoqi@0	71	"package pkg; /** " + key + "*/ public class C { }");
aoqi@0	72	DocumentationTool tool = ToolProvider.getSystemDocumentationTool();
aoqi@0	73	StandardJavaFileManager fm = tool.getStandardFileManager(null, null, null);
aoqi@0	74	File outDir = getOutDir();
aoqi@0	75	fm.setLocation(DocumentationTool.Location.DOCUMENTATION_OUTPUT, Arrays.asList(outDir));
aoqi@0	76	Iterable<? extends JavaFileObject> files = Arrays.asList(srcFile);
aoqi@0	77	DocumentationTask t = tool.getTask(null, fm, null, TestDoclet.class, null, files);
aoqi@0	78	if (t.call()) {
aoqi@0	79	System.err.println("task succeeded");
aoqi@0	80	if (TestDoclet.lastCaller.equals(String.valueOf(key)))
aoqi@0	81	System.err.println("found expected key: " + key);
aoqi@0	82	else
aoqi@0	83	error("Expected key not found");
aoqi@0	84	checkFiles(outDir, Collections.<String>emptySet());
aoqi@0	85	} else {
aoqi@0	86	throw new Exception("task failed");
aoqi@0	87	}
aoqi@0	88	}
aoqi@0	89
aoqi@0	90	public static class TestDoclet {
aoqi@0	91	static String lastCaller;
aoqi@0	92	public static boolean start(RootDoc root) {
aoqi@0	93	lastCaller = root.classNamed("pkg.C").commentText().trim();
aoqi@0	94	return true;
aoqi@0	95	}
aoqi@0	96
aoqi@0	97	public static int optionLength(String option) {
aoqi@0	98	return 0; // default is option unknown
aoqi@0	99	}
aoqi@0	100
aoqi@0	101	public static boolean validOptions(String options[][],
aoqi@0	102	DocErrorReporter reporter) {
aoqi@0	103	return true; // default is options are valid
aoqi@0	104	}
aoqi@0	105
aoqi@0	106	public static LanguageVersion languageVersion() {
aoqi@0	107	return LanguageVersion.JAVA_1_1;
aoqi@0	108	}
aoqi@0	109	}
aoqi@0	110
aoqi@0	111	/**
aoqi@0	112	* Verify that exceptions from a doclet are thrown as expected.
aoqi@0	113	*/
aoqi@0	114	@Test
aoqi@0	115	public void testBadDoclet() throws Exception {
aoqi@0	116	JavaFileObject srcFile = createSimpleJavaFileObject();
aoqi@0	117	DocumentationTool tool = ToolProvider.getSystemDocumentationTool();
aoqi@0	118	StandardJavaFileManager fm = tool.getStandardFileManager(null, null, null);
aoqi@0	119	File outDir = getOutDir();
aoqi@0	120	fm.setLocation(DocumentationTool.Location.DOCUMENTATION_OUTPUT, Arrays.asList(outDir));
aoqi@0	121	Iterable<? extends JavaFileObject> files = Arrays.asList(srcFile);
aoqi@0	122	DocumentationTask t = tool.getTask(null, fm, null, BadDoclet.class, null, files);
aoqi@0	123	try {
aoqi@0	124	t.call();
aoqi@0	125	error("call completed without exception");
aoqi@0	126	} catch (RuntimeException e) {
aoqi@0	127	Throwable c = e.getCause();
aoqi@0	128	if (c.getClass() == UnexpectedError.class)
aoqi@0	129	System.err.println("exception caught as expected: " + c);
aoqi@0	130	else
aoqi@0	131	throw e;
aoqi@0	132	}
aoqi@0	133	}
aoqi@0	134
aoqi@0	135	public static class UnexpectedError extends Error { }
aoqi@0	136
aoqi@0	137	public static class BadDoclet {
aoqi@0	138	public static boolean start(RootDoc root) {
aoqi@0	139	throw new UnexpectedError();
aoqi@0	140	}
aoqi@0	141
aoqi@0	142	public static int optionLength(String option) {
aoqi@0	143	return 0; // default is option unknown
aoqi@0	144	}
aoqi@0	145
aoqi@0	146	public static boolean validOptions(String options[][],
aoqi@0	147	DocErrorReporter reporter) {
aoqi@0	148	return true; // default is options are valid
aoqi@0	149	}
aoqi@0	150
aoqi@0	151	public static LanguageVersion languageVersion() {
aoqi@0	152	return LanguageVersion.JAVA_1_1;
aoqi@0	153	}
aoqi@0	154	}
aoqi@0	155
aoqi@0	156	}
aoqi@0	157