diff -r 000000000000 -r 959103a6100f test/com/sun/javadoc/ValidHtml/ValidHtml.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/test/com/sun/javadoc/ValidHtml/ValidHtml.java Wed Apr 27 01:34:52 2016 +0800 @@ -0,0 +1,202 @@ +/* + * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +/* + * @test + * @bug 4275630 4749453 4625400 4753048 4415270 + * @summary Generated HTML is invalid with frameset DTD. + * Displays unnecessary horizontal scroll bars. + * Missing whitespace in DOCTYPE declaration + * not allowed outside <FRAMESET> element + * HTML table tags inserted in wrong place in pakcage use page + * @author dkramer + * @run main ValidHtml + */ + +import com.sun.javadoc.*; +import java.util.*; +import java.io.*; + +/** + * Runs javadoc and runs regression tests on the resulting HTML. + * It reads each file, complete with newlines, into a string to easily + * find strings that contain newlines. + */ +public class ValidHtml { + + private static final String BUGID = "4275630"; + private static final String BUGNAME = "ValidHtml"; + private static final String FS = System.getProperty("file.separator"); + private static final String PS = System.getProperty("path.separator"); + private static final String LS = System.getProperty("line.separator"); + private static final String TMPDEST_DIR1 = "." + FS + "docs1" + FS; + private static final String TMPDEST_DIR2 = "." + FS + "docs2" + FS; + + // Subtest number. Needed because runResultsOnHTML is run twice, + // and subtestNum should increment across subtest runs. + public static int subtestNum = 0; + public static int numSubtestsPassed = 0; + + // Entry point + public static void main(String[] args) { + + // Directory that contains source files that javadoc runs on + String srcdir = System.getProperty("test.src", "."); + + // Test for all cases except the split index page + runJavadoc(new String[]{"-d", TMPDEST_DIR1, + "-doctitle", "Document Title", + "-windowtitle", "Window Title", + "-use", + "-overview", (srcdir + FS + "overview.html"), + "-sourcepath", srcdir, + "p1", "p2" + }); + runTestsOnHTML(testArray); + + printSummary(); + } + + /** Run javadoc */ + public static void runJavadoc(String[] javadocArgs) { + if (com.sun.tools.javadoc.Main.execute(javadocArgs) != 0) { + throw new Error("Javadoc failed to execute"); + } + } + + /** + * Assign value for [ stringToFind, filename ] + * NOTE: The standard doclet uses the same separator "\n" for all OS's + */ + private static final String[][] testArray = { + // Test the proper DOCTYPE element is present: + { + "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Frameset//EN\" \"http://www.w3.org/TR/html4/frameset.dtd\">", + TMPDEST_DIR1 + "index.html" + }, + // Test the proper DOCTYPE element is present: + { + "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">", + TMPDEST_DIR1 + "overview-summary.html" + }, + // Test the proper DOCTYPE element is present: + { + "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">", + TMPDEST_DIR1 + "p1" + FS + "package-summary.html" + }, + // Test the proper DOCTYPE element is present: + { + "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">", + TMPDEST_DIR1 + "p1" + FS + "C.html" + }, + // Test the proper DOCTYPE element is present: + { + "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">", + TMPDEST_DIR1 + "overview-frame.html" + }, + // Test the proper DOCTYPE element is present: + { + "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">", + TMPDEST_DIR1 + "allclasses-frame.html" + }, + // Test the proper DOCTYPE element is present: + { + "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">", + TMPDEST_DIR1 + "p1" + FS + "package-frame.html" + }, + // Test that <NOFRAMES> is inside <FRAMESET> element: + { + "" + LS + "", + TMPDEST_DIR1 + "index.html" + }, + // Test the table elements are in the correct order: + { + "" + LS + "", + TMPDEST_DIR1 + FS + "p1" + FS + "package-use.html" + } + }; + + public static void runTestsOnHTML(String[][] testArray) { + + for (int i = 0; i < testArray.length; i++) { + + subtestNum += 1; + + // Read contents of file into a string + String fileString = readFileToString(testArray[i][1]); + + // Get string to find + String stringToFind = testArray[i][0]; + + // Find string in file's contents + if (findString(fileString, stringToFind) == -1) { + System.out.println("\nSub-test " + (subtestNum) + " for bug " + BUGID + " (" + BUGNAME + ") FAILED\n" + "when searching for:\n" + stringToFind); + } else { + numSubtestsPassed += 1; + System.out.println("\nSub-test " + (subtestNum) + " passed:\n" + stringToFind); + } + } + } + + public static void printSummary() { + if (numSubtestsPassed == subtestNum) { + System.out.println("\nAll " + numSubtestsPassed + " subtests passed"); + } else { + throw new Error("\n" + (subtestNum - numSubtestsPassed) + " of " + (subtestNum) + " subtests failed for bug " + BUGID + " (" + BUGNAME + ")\n"); + } + } + + // Read the file into a String + public static String readFileToString(String filename) { + try { + File file = new File(filename); + if (!file.exists()) { + System.out.println("\nFILE DOES NOT EXIST: " + filename); + } + BufferedReader in = new BufferedReader(new FileReader(file)); + + // Create an array of characters the size of the file + char[] allChars = new char[(int) file.length()]; + + // Read the characters into the allChars array + in.read(allChars, 0, (int) file.length()); + in.close(); + + // Convert to a string + String allCharsString = new String(allChars); + + return allCharsString; + + } catch (FileNotFoundException e) { + System.err.println(e); + return ""; + } catch (IOException e) { + System.err.println(e); + return ""; + } + } + + public static int findString(String fileString, String stringToFind) { + return fileString.indexOf(stringToFind); + } +}