1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/test/com/sun/javadoc/testLinkOption/TestLinkOption.java Wed Apr 27 01:34:52 2016 +0800
1.3 @@ -0,0 +1,146 @@
1.4 +/*
1.5 + * Copyright (c) 2002, 2013, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation.
1.11 + *
1.12 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.13 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.14 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.15 + * version 2 for more details (a copy is included in the LICENSE file that
1.16 + * accompanied this code).
1.17 + *
1.18 + * You should have received a copy of the GNU General Public License version
1.19 + * 2 along with this work; if not, write to the Free Software Foundation,
1.20 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.21 + *
1.22 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.23 + * or visit www.oracle.com if you need additional information or have any
1.24 + * questions.
1.25 + */
1.26 +
1.27 +/*
1.28 + * @test
1.29 + * @bug 4720957 5020118 8026567 8038976
1.30 + * @summary Test to make sure that -link and -linkoffline link to
1.31 + * right files, and URLs with and without trailing slash are accepted.
1.32 + * @author jamieh
1.33 + * @library ../lib/
1.34 + * @build JavadocTester TestLinkOption
1.35 + * @run main TestLinkOption
1.36 + */
1.37 +
1.38 +import java.io.File;
1.39 +
1.40 +public class TestLinkOption extends JavadocTester {
1.41 +
1.42 + private static final String BUG_ID = "4720957-5020118-8038976";
1.43 +
1.44 + //Generate the documentation using -linkoffline and a URL as the first parameter.
1.45 + private static final String[] ARGS1 = new String[] {
1.46 + "-d", BUG_ID + "-1", "-sourcepath", SRC_DIR,
1.47 + "-linkoffline", "http://java.sun.com/j2se/1.4/docs/api/",
1.48 + SRC_DIR, "-package", "pkg", "java.lang"
1.49 + };
1.50 +
1.51 + private static final String[][] TEST1 = {
1.52 + {BUG_ID + "-1" + FS + "pkg" + FS + "C.html",
1.53 + "<a href=\"http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html?is-external=true\" " +
1.54 + "title=\"class or interface in java.lang\"><code>Link to String Class</code></a>"
1.55 + },
1.56 + //Make sure the parameters are indented properly when the -link option is used.
1.57 + {BUG_ID + "-1" + FS + "pkg" + FS + "C.html",
1.58 + "(int p1," + NL +
1.59 + " int p2," + NL +
1.60 + " int p3)"
1.61 + },
1.62 + {BUG_ID + "-1" + FS + "pkg" + FS + "C.html",
1.63 + "(int p1," + NL +
1.64 + " int p2," + NL +
1.65 + " <a href=\"http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true\" title=\"class or interface in java.lang\">" +
1.66 + "Object</a> p3)"
1.67 + },
1.68 + {BUG_ID + "-1" + FS + "java" + FS + "lang" + FS + "StringBuilderChild.html",
1.69 + "<pre>public abstract class <span class=\"typeNameLabel\">StringBuilderChild</span>" + NL +
1.70 + "extends <a href=\"http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true\" " +
1.71 + "title=\"class or interface in java.lang\">Object</a></pre>"
1.72 + },
1.73 +
1.74 + };
1.75 + private static final String[][] NEGATED_TEST1 = NO_TEST;
1.76 +
1.77 + //Generate the documentation using -linkoffline and a relative path as the first parameter.
1.78 + //We will try linking to the docs generated in test 1 with a relative path.
1.79 + private static final String[] ARGS2 = new String[] {
1.80 + "-d", BUG_ID + "-2", "-sourcepath", SRC_DIR,
1.81 + "-linkoffline", "../" + BUG_ID + "-1", BUG_ID + "-1", "-package", "pkg2"
1.82 + };
1.83 +
1.84 + private static final String[][] TEST2 = {
1.85 + {BUG_ID + "-2" + FS + "pkg2" + FS + "C2.html",
1.86 + "This is a link to <a href=\"../../" + BUG_ID + "-1/pkg/C.html?is-external=true\" " +
1.87 + "title=\"class or interface in pkg\"><code>Class C</code></a>."
1.88 + }
1.89 + };
1.90 + private static final String[][] NEGATED_TEST2 = NO_TEST;
1.91 + /*
1.92 + * Create the documentation using the -link option, vary the behavior with
1.93 + * both trailing and no trailing slash. We are only interested in ensuring
1.94 + * that the command executes with no errors or related warnings.
1.95 + */
1.96 + static String[] createArguments(boolean withTrailingSlash) {
1.97 + String packagePath = new File(BUG_ID + "-1").getAbsolutePath();
1.98 + String outputDirName = BUG_ID;
1.99 + if (withTrailingSlash) {
1.100 + // add the trailing slash, if it is not present!
1.101 + if (!packagePath.endsWith(FS)) {
1.102 + packagePath = packagePath + FS;
1.103 + }
1.104 + outputDirName = outputDirName + "-3";
1.105 + } else {
1.106 + // remove the trailing slash, if it is present!
1.107 + if (packagePath.endsWith(FS)) {
1.108 + packagePath = packagePath.substring(0, packagePath.length() - 1);
1.109 + }
1.110 + outputDirName = outputDirName + "-4";
1.111 + }
1.112 + String args[] = {
1.113 + "-d", outputDirName, "-sourcepath", SRC_DIR,
1.114 + "-link", "file:///" + packagePath, "-package", "pkg2"
1.115 + };
1.116 + System.out.println("packagePath: " + packagePath);
1.117 + return args;
1.118 + }
1.119 + /**
1.120 + * The entry point of the test.
1.121 + * @param args the array of command line arguments.
1.122 + */
1.123 + public static void main(String[] args) {
1.124 + TestLinkOption tester = new TestLinkOption();
1.125 + run(tester, ARGS1, TEST1, NEGATED_TEST1);
1.126 + run(tester, ARGS2, TEST2, NEGATED_TEST2);
1.127 + tester.runJavadoc(createArguments(true)); // with trailing slash
1.128 + tester.runJavadoc(createArguments(false)); // without trailing slash
1.129 + tester.printSummary();
1.130 + if (tester.getWarningOutput().contains("warning - Error fetching URL")) {
1.131 + throw new Error("URL rejected ?");
1.132 + }
1.133 + tester.printSummary();
1.134 + }
1.135 +
1.136 + /**
1.137 + * {@inheritDoc}
1.138 + */
1.139 + public String getBugId() {
1.140 + return BUG_ID;
1.141 + }
1.142 +
1.143 + /**
1.144 + * {@inheritDoc}
1.145 + */
1.146 + public String getBugName() {
1.147 + return getClass().getName();
1.148 + }
1.149 +}
