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

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

author
aoqi
date
Wed, 27 Apr 2016 01:34:52 +0800
changeset 0
959103a6100f
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, 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 TagletPathTest
aoqi@0 30 */
aoqi@0 31
aoqi@0 32 import java.io.File;
aoqi@0 33 import java.io.PrintWriter;
aoqi@0 34 import java.io.StringWriter;
aoqi@0 35 import java.nio.charset.Charset;
aoqi@0 36 import java.nio.file.Files;
aoqi@0 37 import java.util.Arrays;
aoqi@0 38 import java.util.List;
aoqi@0 39 import javax.tools.DocumentationTool;
aoqi@0 40 import javax.tools.DocumentationTool.DocumentationTask;
aoqi@0 41 import javax.tools.JavaCompiler;
aoqi@0 42 import javax.tools.JavaFileObject;
aoqi@0 43 import javax.tools.StandardJavaFileManager;
aoqi@0 44 import javax.tools.StandardLocation;
aoqi@0 45 import javax.tools.ToolProvider;
aoqi@0 46
aoqi@0 47 /**
aoqi@0 48 * Tests for locating a doclet via the file manager's DOCLET_PATH.
aoqi@0 49 */
aoqi@0 50 public class TagletPathTest extends APITest {
aoqi@0 51 public static void main(String... args) throws Exception {
aoqi@0 52 new TagletPathTest().run();
aoqi@0 53 }
aoqi@0 54
aoqi@0 55 /**
aoqi@0 56 * Verify that a taglet can be specified, and located via
aoqi@0 57 * the file manager's TAGLET_PATH.
aoqi@0 58 */
aoqi@0 59 @Test
aoqi@0 60 public void testTagletPath() throws Exception {
aoqi@0 61 File testSrc = new File(System.getProperty("test.src"));
aoqi@0 62 File tagletSrcFile = new File(testSrc, "taglets/UnderlineTaglet.java");
aoqi@0 63 File tagletDir = getOutDir("classes");
aoqi@0 64 JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
aoqi@0 65 StandardJavaFileManager cfm = compiler.getStandardFileManager(null, null, null);
aoqi@0 66 cfm.setLocation(StandardLocation.CLASS_OUTPUT, Arrays.asList(tagletDir));
aoqi@0 67 Iterable<? extends JavaFileObject> cfiles = cfm.getJavaFileObjects(tagletSrcFile);
aoqi@0 68 if (!compiler.getTask(null, cfm, null, null, null, cfiles).call())
aoqi@0 69 throw new Exception("cannot compile taglet");
aoqi@0 70
aoqi@0 71 JavaFileObject srcFile = createSimpleJavaFileObject("pkg/C", testSrcText);
aoqi@0 72 DocumentationTool tool = ToolProvider.getSystemDocumentationTool();
aoqi@0 73 StandardJavaFileManager fm = tool.getStandardFileManager(null, null, null);
aoqi@0 74 File outDir = getOutDir("api");
aoqi@0 75 fm.setLocation(DocumentationTool.Location.DOCUMENTATION_OUTPUT, Arrays.asList(outDir));
aoqi@0 76 fm.setLocation(DocumentationTool.Location.TAGLET_PATH, Arrays.asList(tagletDir));
aoqi@0 77 Iterable<? extends JavaFileObject> files = Arrays.asList(srcFile);
aoqi@0 78 Iterable<String> options = Arrays.asList("-taglet", "UnderlineTaglet");
aoqi@0 79 StringWriter sw = new StringWriter();
aoqi@0 80 PrintWriter pw = new PrintWriter(sw);
aoqi@0 81 DocumentationTask t = tool.getTask(pw, fm, null, null, options, files);
aoqi@0 82 boolean ok = t.call();
aoqi@0 83 String out = sw.toString();
aoqi@0 84 System.err.println(">>" + out + "<<");
aoqi@0 85 if (ok) {
aoqi@0 86 File f = new File(outDir, "pkg/C.html");
aoqi@0 87 List<String> doc = Files.readAllLines(f.toPath(), Charset.defaultCharset());
aoqi@0 88 for (String line: doc) {
aoqi@0 89 if (line.contains("<u>" + TEST_STRING + "</u>")) {
aoqi@0 90 System.err.println("taglet executed as expected");
aoqi@0 91 return;
aoqi@0 92 }
aoqi@0 93 }
aoqi@0 94 error("expected text not found in output " + f);
aoqi@0 95 } else {
aoqi@0 96 error("task failed");
aoqi@0 97 }
aoqi@0 98 }
aoqi@0 99
aoqi@0 100 static final String TEST_STRING = "xyzzy";
aoqi@0 101 static final String testSrcText =
aoqi@0 102 "package pkg;\n" +
aoqi@0 103 "/** {@underline " + TEST_STRING + "} */\n" +
aoqi@0 104 "public class C { }";
aoqi@0 105 }
aoqi@0 106

mercurial