test/tools/javadoc/6227454/Test.java

Fri, 04 Mar 2011 19:56:02 -0800

author
jjg
date
Fri, 04 Mar 2011 19:56:02 -0800
changeset 911
4ee7de0684f5
parent 0
959103a6100f
permissions
-rw-r--r--

6227454: package.html and overview.html may not be read fully
Reviewed-by: bpatel

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 2011, 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 6227454
aoqi@0 27 * @summary package.html and overview.html may not be read fully
aoqi@0 28 */
aoqi@0 29
aoqi@0 30 import java.io.*;
aoqi@0 31
aoqi@0 32 import com.sun.javadoc.Doclet;
aoqi@0 33 import com.sun.javadoc.RootDoc;
aoqi@0 34
aoqi@0 35 public class Test extends Doclet {
aoqi@0 36 public static void main(String... args) throws Exception {
aoqi@0 37 new Test().run();
aoqi@0 38 }
aoqi@0 39
aoqi@0 40 void run() throws Exception {
aoqi@0 41 test("<html><body>ABC XYZ</body></html>");
aoqi@0 42 test("<html><body>ABC XYZ</BODY></html>");
aoqi@0 43 test("<html><BODY>ABC XYZ</body></html>");
aoqi@0 44 test("<html><BODY>ABC XYZ</BODY></html>");
aoqi@0 45 test("<html><BoDy>ABC XYZ</bOdY></html>");
aoqi@0 46 test("<html> ABC XYZ</bOdY></html>", "Body tag missing from HTML");
aoqi@0 47 test("<html><body>ABC XYZ </html>", "Close body tag missing from HTML");
aoqi@0 48 test("<html> ABC XYZ </html>", "Body tag missing from HTML");
aoqi@0 49 test("<html><body>ABC" + bigText(8192, 40) + "XYZ</body></html>");
aoqi@0 50
aoqi@0 51 if (errors > 0)
aoqi@0 52 throw new Exception(errors + " errors occurred");
aoqi@0 53 }
aoqi@0 54
aoqi@0 55 void test(String text) throws IOException {
aoqi@0 56 test(text, null);
aoqi@0 57 }
aoqi@0 58
aoqi@0 59 void test(String text, String expectError) throws IOException {
aoqi@0 60 testNum++;
aoqi@0 61 System.err.println("test " + testNum);
aoqi@0 62 File file = writeFile("overview" + testNum + ".html", text);
aoqi@0 63 String thisClassName = Test.class.getName();
aoqi@0 64 File testSrc = new File(System.getProperty("test.src"));
aoqi@0 65 String[] args = {
aoqi@0 66 "-bootclasspath",
aoqi@0 67 System.getProperty("java.class.path")
aoqi@0 68 + File.pathSeparator
aoqi@0 69 + System.getProperty("sun.boot.class.path"),
aoqi@0 70 "-classpath", ".",
aoqi@0 71 "-package",
aoqi@0 72 "-overview", file.getPath(),
aoqi@0 73 new File(testSrc, thisClassName + ".java").getPath()
aoqi@0 74 };
aoqi@0 75
aoqi@0 76 StringWriter sw = new StringWriter();
aoqi@0 77 PrintWriter pw = new PrintWriter(sw);
aoqi@0 78 int rc = com.sun.tools.javadoc.Main.execute(
aoqi@0 79 "javadoc",
aoqi@0 80 pw, pw, pw,
aoqi@0 81 thisClassName,
aoqi@0 82 args);
aoqi@0 83 pw.close();
aoqi@0 84 String out = sw.toString();
aoqi@0 85 if (!out.isEmpty())
aoqi@0 86 System.err.println(out);
aoqi@0 87 System.err.println("javadoc exit: rc=" + rc);
aoqi@0 88
aoqi@0 89 if (expectError == null) {
aoqi@0 90 if (rc != 0)
aoqi@0 91 error("unexpected exit from javadoc; rc:" + rc);
aoqi@0 92 } else {
aoqi@0 93 if (!out.contains(expectError))
aoqi@0 94 error("expected error text not found: " + expectError);
aoqi@0 95 }
aoqi@0 96 }
aoqi@0 97
aoqi@0 98 String bigText(int lines, int lineLength) {
aoqi@0 99 StringBuilder sb = new StringBuilder();
aoqi@0 100 for (int i = 0; i < lineLength; i++)
aoqi@0 101 sb.append(String.valueOf(i % 10));
aoqi@0 102 sb.append("\n");
aoqi@0 103 String line = sb.toString();
aoqi@0 104 sb.setLength(0);
aoqi@0 105 for (int i = 0; i < lines; i++)
aoqi@0 106 sb.append(line);
aoqi@0 107 return sb.toString();
aoqi@0 108 }
aoqi@0 109
aoqi@0 110 File writeFile(String path, String body) throws IOException {
aoqi@0 111 File f = new File(path);
aoqi@0 112 FileWriter out = new FileWriter(f);
aoqi@0 113 try {
aoqi@0 114 out.write(body);
aoqi@0 115 } finally {
aoqi@0 116 out.close();
aoqi@0 117 }
aoqi@0 118 return f;
aoqi@0 119 }
aoqi@0 120
aoqi@0 121 void error(String msg) {
aoqi@0 122 System.err.println("Error: " + msg);
aoqi@0 123 errors++;
aoqi@0 124 }
aoqi@0 125
aoqi@0 126 int testNum;
aoqi@0 127 int errors;
aoqi@0 128
aoqi@0 129 public static boolean start(RootDoc root) {
aoqi@0 130 String text = root.commentText();
aoqi@0 131 if (text.length() < 64)
aoqi@0 132 System.err.println("text: '" + text + "'");
aoqi@0 133 else
aoqi@0 134 System.err.println("text: '"
aoqi@0 135 + text.substring(0, 20)
aoqi@0 136 + "..."
aoqi@0 137 + text.substring(text.length() - 20)
aoqi@0 138 + "'");
aoqi@0 139 return text.startsWith("ABC") && text.endsWith("XYZ");
aoqi@0 140 }
aoqi@0 141 }

mercurial