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