1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/test/com/sun/javadoc/VersionNumber/VersionNumber.java Sat Dec 01 00:00:00 2007 +0000 1.3 @@ -0,0 +1,159 @@ 1.4 +/* 1.5 + * Copyright 2002 Sun Microsystems, Inc. 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 1.23 + * CA 95054 USA or visit www.sun.com if you need additional information or 1.24 + * have any questions. 1.25 + */ 1.26 + 1.27 +/* 1.28 + * @test 1.29 + * @bug 4720849 1.30 + * @summary com.sun.tools.doclets.standard.Standard contains hard-coded version number 1.31 + * @author dkramer 1.32 + * @run main VersionNumber 1.33 + */ 1.34 + 1.35 + 1.36 +import com.sun.javadoc.*; 1.37 +import java.util.*; 1.38 +import java.io.*; 1.39 + 1.40 + 1.41 +/** 1.42 + * Runs javadoc and runs regression tests on the resulting HTML. 1.43 + * It reads each file, complete with newlines, into a string to easily 1.44 + * find strings that contain newlines. 1.45 + */ 1.46 +public class VersionNumber { 1.47 + 1.48 + private static final String BUGID = "4720849"; 1.49 + private static final String BUGNAME = "VersionNumber"; 1.50 + private static final String FS = System.getProperty("file.separator"); 1.51 + private static final String PS = System.getProperty("path.separator"); 1.52 + private static final String LS = System.getProperty("line.separator"); 1.53 + private static final String TMPDEST_DIR1 = "." + FS + "docs1" + FS; 1.54 + private static final String TMPDEST_DIR2 = "." + FS + "docs2" + FS; 1.55 + 1.56 + // Subtest number. Needed because runResultsOnHTML is run twice, 1.57 + // and subtestNum should increment across subtest runs. 1.58 + public static int subtestNum = 0; 1.59 + public static int numSubtestsPassed = 0; 1.60 + 1.61 + // Entry point 1.62 + public static void main(String[] args) { 1.63 + 1.64 + // Directory that contains source files that javadoc runs on 1.65 + String srcdir = System.getProperty("test.src", "."); 1.66 + 1.67 + // Test for all cases except the split index page 1.68 + runJavadoc(new String[] {"-d", TMPDEST_DIR1, 1.69 + "p1"}); 1.70 + runTestsOnHTML(testArray); 1.71 + 1.72 + printSummary(); 1.73 + } 1.74 + 1.75 + /** Run javadoc */ 1.76 + public static void runJavadoc(String[] javadocArgs) { 1.77 + if (com.sun.tools.javadoc.Main.execute(javadocArgs) != 0) { 1.78 + throw new Error("Javadoc failed to execute"); 1.79 + } 1.80 + } 1.81 + 1.82 + /** 1.83 + * Assign value for [ stringToFind, filename ] 1.84 + * NOTE: The standard doclet uses the same separator "\n" for all OS's 1.85 + */ 1.86 + private static final String[][] testArray = { 1.87 + 1.88 + // Test the proper DOCTYPE element is present: 1.89 + { 1.90 + "<!-- Generated by javadoc (build", 1.91 + TMPDEST_DIR1 + "p1" + FS + "C.html" }, 1.92 + 1.93 + }; 1.94 + 1.95 + public static void runTestsOnHTML(String[][] testArray) { 1.96 + 1.97 + for (int i = 0; i < testArray.length; i++) { 1.98 + 1.99 + subtestNum += 1; 1.100 + 1.101 + // Read contents of file into a string 1.102 + String fileString = readFileToString(testArray[i][1]); 1.103 + 1.104 + // Get string to find 1.105 + String stringToFind = testArray[i][0]; 1.106 + 1.107 + // Find string in file's contents 1.108 + if (findString(fileString, stringToFind) == -1) { 1.109 + System.out.println("\nSub-test " + (subtestNum) 1.110 + + " for bug " + BUGID + " (" + BUGNAME + ") FAILED\n" 1.111 + + "when searching for:\n" 1.112 + + stringToFind); 1.113 + } else { 1.114 + numSubtestsPassed += 1; 1.115 + System.out.println("\nSub-test " + (subtestNum) + " passed:\n" + stringToFind); 1.116 + } 1.117 + } 1.118 + } 1.119 + 1.120 + public static void printSummary() { 1.121 + if ( numSubtestsPassed == subtestNum ) { 1.122 + System.out.println("\nAll " + numSubtestsPassed + " subtests passed"); 1.123 + } else { 1.124 + throw new Error("\n" + (subtestNum - numSubtestsPassed) + " of " + (subtestNum) 1.125 + + " subtests failed for bug " + BUGID + " (" + BUGNAME + ")\n"); 1.126 + } 1.127 + } 1.128 + 1.129 + // Read the file into a String 1.130 + public static String readFileToString(String filename) { 1.131 + try { 1.132 + File file = new File(filename); 1.133 + if ( !file.exists() ) { 1.134 + System.out.println("\nFILE DOES NOT EXIST: " + filename); 1.135 + } 1.136 + BufferedReader in = new BufferedReader(new FileReader(file)); 1.137 + 1.138 + // Create an array of characters the size of the file 1.139 + char[] allChars = new char[(int)file.length()]; 1.140 + 1.141 + // Read the characters into the allChars array 1.142 + in.read(allChars, 0, (int)file.length()); 1.143 + in.close(); 1.144 + 1.145 + // Convert to a string 1.146 + String allCharsString = new String(allChars); 1.147 + 1.148 + return allCharsString; 1.149 + 1.150 + } catch (FileNotFoundException e) { 1.151 + System.err.println(e); 1.152 + return ""; 1.153 + } catch (IOException e) { 1.154 + System.err.println(e); 1.155 + return ""; 1.156 + } 1.157 + } 1.158 + 1.159 + public static int findString(String fileString, String stringToFind) { 1.160 + return fileString.indexOf(stringToFind); 1.161 + } 1.162 +}