Mon, 19 Sep 2016 09:50:03 -0700
Merge
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 DocletPathTest |
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.util.Arrays; |
aoqi@0 | 36 | import javax.tools.DocumentationTool; |
aoqi@0 | 37 | import javax.tools.DocumentationTool.DocumentationTask; |
aoqi@0 | 38 | import javax.tools.JavaCompiler; |
aoqi@0 | 39 | import javax.tools.JavaFileObject; |
aoqi@0 | 40 | import javax.tools.StandardJavaFileManager; |
aoqi@0 | 41 | import javax.tools.StandardLocation; |
aoqi@0 | 42 | import javax.tools.ToolProvider; |
aoqi@0 | 43 | |
aoqi@0 | 44 | /** |
aoqi@0 | 45 | * Tests for locating a doclet via the file manager's DOCLET_PATH. |
aoqi@0 | 46 | */ |
aoqi@0 | 47 | public class DocletPathTest extends APITest { |
aoqi@0 | 48 | public static void main(String... args) throws Exception { |
aoqi@0 | 49 | new DocletPathTest().run(); |
aoqi@0 | 50 | } |
aoqi@0 | 51 | |
aoqi@0 | 52 | /** |
aoqi@0 | 53 | * Verify that an alternate doclet can be specified, and located via |
aoqi@0 | 54 | * the file manager's DOCLET_PATH. |
aoqi@0 | 55 | */ |
aoqi@0 | 56 | @Test |
aoqi@0 | 57 | public void testDocletPath() throws Exception { |
aoqi@0 | 58 | JavaFileObject docletSrc = |
aoqi@0 | 59 | createSimpleJavaFileObject("DocletOnDocletPath", docletSrcText); |
aoqi@0 | 60 | File docletDir = getOutDir("classes"); |
aoqi@0 | 61 | JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); |
aoqi@0 | 62 | StandardJavaFileManager cfm = compiler.getStandardFileManager(null, null, null); |
aoqi@0 | 63 | cfm.setLocation(StandardLocation.CLASS_OUTPUT, Arrays.asList(docletDir)); |
aoqi@0 | 64 | Iterable<? extends JavaFileObject> cfiles = Arrays.asList(docletSrc); |
aoqi@0 | 65 | if (!compiler.getTask(null, cfm, null, null, null, cfiles).call()) |
aoqi@0 | 66 | throw new Exception("cannot compile doclet"); |
aoqi@0 | 67 | |
aoqi@0 | 68 | JavaFileObject srcFile = createSimpleJavaFileObject(); |
aoqi@0 | 69 | DocumentationTool tool = ToolProvider.getSystemDocumentationTool(); |
aoqi@0 | 70 | StandardJavaFileManager fm = tool.getStandardFileManager(null, null, null); |
aoqi@0 | 71 | File outDir = getOutDir("api"); |
aoqi@0 | 72 | fm.setLocation(DocumentationTool.Location.DOCUMENTATION_OUTPUT, Arrays.asList(outDir)); |
aoqi@0 | 73 | fm.setLocation(DocumentationTool.Location.DOCLET_PATH, Arrays.asList(docletDir)); |
aoqi@0 | 74 | Iterable<? extends JavaFileObject> files = Arrays.asList(srcFile); |
aoqi@0 | 75 | Iterable<String> options = Arrays.asList("-doclet", "DocletOnDocletPath"); |
aoqi@0 | 76 | StringWriter sw = new StringWriter(); |
aoqi@0 | 77 | PrintWriter pw = new PrintWriter(sw); |
aoqi@0 | 78 | DocumentationTask t = tool.getTask(pw, fm, null, null, options, files); |
aoqi@0 | 79 | boolean ok = t.call(); |
aoqi@0 | 80 | String out = sw.toString(); |
aoqi@0 | 81 | System.err.println(">>" + out + "<<"); |
aoqi@0 | 82 | if (ok) { |
aoqi@0 | 83 | if (out.contains(TEST_STRING)) { |
aoqi@0 | 84 | System.err.println("doclet executed as expected"); |
aoqi@0 | 85 | } else { |
aoqi@0 | 86 | error("test string not found in doclet output"); |
aoqi@0 | 87 | } |
aoqi@0 | 88 | } else { |
aoqi@0 | 89 | error("task failed"); |
aoqi@0 | 90 | } |
aoqi@0 | 91 | } |
aoqi@0 | 92 | |
aoqi@0 | 93 | private static final String TEST_STRING = "DocletOnDocletPath found and running"; |
aoqi@0 | 94 | |
aoqi@0 | 95 | private static final String docletSrcText = |
aoqi@0 | 96 | "import com.sun.javadoc.*;\n" + |
aoqi@0 | 97 | "public class DocletOnDocletPath {\n" + |
aoqi@0 | 98 | " public static boolean start(RootDoc doc) {\n" + |
aoqi@0 | 99 | " doc.printNotice(\"" + TEST_STRING + "\");\n" + |
aoqi@0 | 100 | " return true;\n" + |
aoqi@0 | 101 | " }\n" + |
aoqi@0 | 102 | " public static int optionLength(String option) { return 0; }\n" + |
aoqi@0 | 103 | " public static boolean validOptions(String options[][],\n" + |
aoqi@0 | 104 | " DocErrorReporter reporter) { return true; }\n" + |
aoqi@0 | 105 | " public static LanguageVersion languageVersion() {\n" + |
aoqi@0 | 106 | " return LanguageVersion.JAVA_1_1;\n" + |
aoqi@0 | 107 | " }\n" + |
aoqi@0 | 108 | "}\n"; |
aoqi@0 | 109 | } |
aoqi@0 | 110 |