test/com/sun/javadoc/AuthorDD/AuthorDD.java

Sat, 01 Dec 2007 00:00:00 +0000

author
duke
date
Sat, 01 Dec 2007 00:00:00 +0000
changeset 1
9a66ca7c79fa
child 140
22c4c1143a3a
permissions
-rw-r--r--

Initial load

duke@1 1 /*
duke@1 2 * Copyright 2002-2003 Sun Microsystems, Inc. All Rights Reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
duke@1 7 * published by the Free Software Foundation.
duke@1 8 *
duke@1 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 13 * accompanied this code).
duke@1 14 *
duke@1 15 * You should have received a copy of the GNU General Public License version
duke@1 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 18 *
duke@1 19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 20 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 21 * have any questions.
duke@1 22 */
duke@1 23
duke@1 24 /*
duke@1 25 * @test
duke@1 26 * @bug 4651598
duke@1 27 * @summary Javadoc wrongly inserts </DD> tags when using multiple @author tags
duke@1 28 * @author dkramer
duke@1 29 * @run main AuthorDD
duke@1 30 */
duke@1 31
duke@1 32
duke@1 33 import com.sun.javadoc.*;
duke@1 34 import java.util.*;
duke@1 35 import java.io.*;
duke@1 36
duke@1 37
duke@1 38 /**
duke@1 39 * Runs javadoc and runs regression tests on the resulting HTML.
duke@1 40 * It reads each file, complete with newlines, into a string to easily
duke@1 41 * find strings that contain newlines.
duke@1 42 */
duke@1 43 public class AuthorDD
duke@1 44 {
duke@1 45 private static final String BUGID = "4651598";
duke@1 46 private static final String BUGNAME = "AuthorDD";
duke@1 47 private static final String FS = System.getProperty("file.separator");
duke@1 48 private static final String PS = System.getProperty("path.separator");
duke@1 49 private static final String NL = System.getProperty("line.separator");
duke@1 50
duke@1 51 // Subtest number. Needed because runResultsOnHTML is run twice, and subtestNum
duke@1 52 // should increment across subtest runs.
duke@1 53 public static int subtestNum = 0;
duke@1 54 public static int numSubtestsPassed = 0;
duke@1 55
duke@1 56 // Entry point
duke@1 57 public static void main(String[] args) {
duke@1 58
duke@1 59 // Directory that contains source files that javadoc runs on
duke@1 60 String srcdir = System.getProperty("test.src", ".");
duke@1 61
duke@1 62 // Test for all cases except the split index page
duke@1 63 runJavadoc(new String[] {"-d", BUGID,
duke@1 64 "-author",
duke@1 65 "-version",
duke@1 66 "-sourcepath", srcdir,
duke@1 67 "p1"});
duke@1 68 runTestsOnHTML(testArray);
duke@1 69
duke@1 70 printSummary();
duke@1 71 }
duke@1 72
duke@1 73 /** Run javadoc */
duke@1 74 public static void runJavadoc(String[] javadocArgs) {
duke@1 75 if (com.sun.tools.javadoc.Main.execute(javadocArgs) != 0) {
duke@1 76 throw new Error("Javadoc failed to execute");
duke@1 77 }
duke@1 78 }
duke@1 79
duke@1 80 /**
duke@1 81 * Assign value for [ stringToFind, filename ]
duke@1 82 * NOTE: The standard doclet uses the same separator "\n" for all OS's
duke@1 83 */
duke@1 84 private static final String[][] testArray = {
duke@1 85
duke@1 86 // Test single @since tag:
duke@1 87
duke@1 88 { "<DT><B>Since:</B></DT>"+NL+" <DD>JDK 1.0</DD>",
duke@1 89 BUGID + FS + "p1" + FS + "C1.html" },
duke@1 90
duke@1 91 // Test multiple @author tags:
duke@1 92
duke@1 93 { "<DT><B>Author:</B></DT>"+NL+" <DD>Doug Kramer, Jamie, Neal</DD>"+NL,
duke@1 94 BUGID + FS + "p1" + FS + "C1.html" },
duke@1 95
duke@1 96 };
duke@1 97
duke@1 98 public static void runTestsOnHTML(String[][] testArray) {
duke@1 99
duke@1 100 for (int i = 0; i < testArray.length; i++) {
duke@1 101
duke@1 102 subtestNum += 1;
duke@1 103
duke@1 104 // Read contents of file into a string
duke@1 105 String fileString = readFileToString(testArray[i][1]);
duke@1 106
duke@1 107 // Get string to find
duke@1 108 String stringToFind = testArray[i][0];
duke@1 109
duke@1 110 // Find string in file's contents
duke@1 111 if (findString(fileString, stringToFind) == -1) {
duke@1 112 System.out.println("\nSub-test " + (subtestNum)
duke@1 113 + " for bug " + BUGID + " (" + BUGNAME + ") FAILED\n"
duke@1 114 + "when searching for:\n"
duke@1 115 + stringToFind);
duke@1 116 } else {
duke@1 117 numSubtestsPassed += 1;
duke@1 118 System.out.println("\nSub-test " + (subtestNum) + " passed:\n" + stringToFind);
duke@1 119 }
duke@1 120 }
duke@1 121 }
duke@1 122
duke@1 123 public static void printSummary() {
duke@1 124 if ( numSubtestsPassed == subtestNum ) {
duke@1 125 System.out.println("\nAll " + numSubtestsPassed + " subtests passed");
duke@1 126 } else {
duke@1 127 throw new Error("\n" + (subtestNum - numSubtestsPassed) + " of " + (subtestNum)
duke@1 128 + " subtests failed for bug " + BUGID + " (" + BUGNAME + ")\n");
duke@1 129 }
duke@1 130 }
duke@1 131
duke@1 132 // Read the file into a String
duke@1 133 public static String readFileToString(String filename) {
duke@1 134 try {
duke@1 135 File file = new File(filename);
duke@1 136 if ( !file.exists() ) {
duke@1 137 System.out.println("\nFILE DOES NOT EXIST: " + filename);
duke@1 138 }
duke@1 139 BufferedReader in = new BufferedReader(new FileReader(file));
duke@1 140
duke@1 141 // Create an array of characters the size of the file
duke@1 142 char[] allChars = new char[(int)file.length()];
duke@1 143
duke@1 144 // Read the characters into the allChars array
duke@1 145 in.read(allChars, 0, (int)file.length());
duke@1 146 in.close();
duke@1 147
duke@1 148 // Convert to a string
duke@1 149 String allCharsString = new String(allChars);
duke@1 150
duke@1 151 return allCharsString;
duke@1 152
duke@1 153 } catch (FileNotFoundException e) {
duke@1 154 System.err.println(e);
duke@1 155 return "";
duke@1 156 } catch (IOException e) {
duke@1 157 System.err.println(e);
duke@1 158 return "";
duke@1 159 }
duke@1 160 }
duke@1 161
duke@1 162 public static int findString(String fileString, String stringToFind) {
duke@1 163 return fileString.indexOf(stringToFind);
duke@1 164 }
duke@1 165 }

mercurial