jdk-sandbox: langtools/test/com/sun/javadoc/ValidHtml/ValidHtml.java@900a9e8d6c4e (annotated)

10 06bc494ca11e Initial load duke parents: diff changeset	1	/*
7681 1f0819a3341f 6962318: Update copyright year ohair parents: 7614 diff changeset	2	* Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
10 06bc494ca11e Initial load duke parents: diff changeset	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load duke parents: diff changeset	4	*
06bc494ca11e Initial load duke parents: diff changeset	5	* This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load duke parents: diff changeset	6	* under the terms of the GNU General Public License version 2 only, as
06bc494ca11e Initial load duke parents: diff changeset	7	* published by the Free Software Foundation.
06bc494ca11e Initial load duke parents: diff changeset	8	*
06bc494ca11e Initial load duke parents: diff changeset	9	* This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load duke parents: diff changeset	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load duke parents: diff changeset	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
06bc494ca11e Initial load duke parents: diff changeset	12	* version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load duke parents: diff changeset	13	* accompanied this code).
06bc494ca11e Initial load duke parents: diff changeset	14	*
06bc494ca11e Initial load duke parents: diff changeset	15	* You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load duke parents: diff changeset	16	* 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load duke parents: diff changeset	17	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load duke parents: diff changeset	18	*
5520 86e4b9a9da40 6943119: Rebrand source copyright notices ohair parents: 10 diff changeset	19	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices ohair parents: 10 diff changeset	20	* or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices ohair parents: 10 diff changeset	21	* questions.
10 06bc494ca11e Initial load duke parents: diff changeset	22	*/
06bc494ca11e Initial load duke parents: diff changeset	23
06bc494ca11e Initial load duke parents: diff changeset	24	/*
06bc494ca11e Initial load duke parents: diff changeset	25	* @test
06bc494ca11e Initial load duke parents: diff changeset	26	* @bug 4275630 4749453 4625400 4753048 4415270
06bc494ca11e Initial load duke parents: diff changeset	27	* @summary Generated HTML is invalid with frameset DTD.
06bc494ca11e Initial load duke parents: diff changeset	28	* Displays unnecessary horizontal scroll bars.
06bc494ca11e Initial load duke parents: diff changeset	29	* Missing whitespace in DOCTYPE declaration
06bc494ca11e Initial load duke parents: diff changeset	30	* <NOFRAMES> not allowed outside <FRAMESET> element
06bc494ca11e Initial load duke parents: diff changeset	31	* HTML table tags inserted in wrong place in pakcage use page
06bc494ca11e Initial load duke parents: diff changeset	32	* @author dkramer
06bc494ca11e Initial load duke parents: diff changeset	33	* @run main ValidHtml
06bc494ca11e Initial load duke parents: diff changeset	34	*/
06bc494ca11e Initial load duke parents: diff changeset	35
06bc494ca11e Initial load duke parents: diff changeset	36	import com.sun.javadoc.*;
06bc494ca11e Initial load duke parents: diff changeset	37	import java.util.*;
06bc494ca11e Initial load duke parents: diff changeset	38	import java.io.*;
06bc494ca11e Initial load duke parents: diff changeset	39
06bc494ca11e Initial load duke parents: diff changeset	40	/**
06bc494ca11e Initial load duke parents: diff changeset	41	* Runs javadoc and runs regression tests on the resulting HTML.
06bc494ca11e Initial load duke parents: diff changeset	42	* It reads each file, complete with newlines, into a string to easily
06bc494ca11e Initial load duke parents: diff changeset	43	* find strings that contain newlines.
06bc494ca11e Initial load duke parents: diff changeset	44	*/
06bc494ca11e Initial load duke parents: diff changeset	45	public class ValidHtml {
06bc494ca11e Initial load duke parents: diff changeset	46
06bc494ca11e Initial load duke parents: diff changeset	47	private static final String BUGID = "4275630";
06bc494ca11e Initial load duke parents: diff changeset	48	private static final String BUGNAME = "ValidHtml";
06bc494ca11e Initial load duke parents: diff changeset	49	private static final String FS = System.getProperty("file.separator");
06bc494ca11e Initial load duke parents: diff changeset	50	private static final String PS = System.getProperty("path.separator");
06bc494ca11e Initial load duke parents: diff changeset	51	private static final String LS = System.getProperty("line.separator");
06bc494ca11e Initial load duke parents: diff changeset	52	private static final String TMPDEST_DIR1 = "." + FS + "docs1" + FS;
06bc494ca11e Initial load duke parents: diff changeset	53	private static final String TMPDEST_DIR2 = "." + FS + "docs2" + FS;
06bc494ca11e Initial load duke parents: diff changeset	54
06bc494ca11e Initial load duke parents: diff changeset	55	// Subtest number. Needed because runResultsOnHTML is run twice,
06bc494ca11e Initial load duke parents: diff changeset	56	// and subtestNum should increment across subtest runs.
06bc494ca11e Initial load duke parents: diff changeset	57	public static int subtestNum = 0;
06bc494ca11e Initial load duke parents: diff changeset	58	public static int numSubtestsPassed = 0;
06bc494ca11e Initial load duke parents: diff changeset	59
06bc494ca11e Initial load duke parents: diff changeset	60	// Entry point
06bc494ca11e Initial load duke parents: diff changeset	61	public static void main(String[] args) {
06bc494ca11e Initial load duke parents: diff changeset	62
06bc494ca11e Initial load duke parents: diff changeset	63	// Directory that contains source files that javadoc runs on
06bc494ca11e Initial load duke parents: diff changeset	64	String srcdir = System.getProperty("test.src", ".");
06bc494ca11e Initial load duke parents: diff changeset	65
06bc494ca11e Initial load duke parents: diff changeset	66	// Test for all cases except the split index page
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	67	runJavadoc(new String[]{"-d", TMPDEST_DIR1,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	68	"-doctitle", "Document Title",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	69	"-windowtitle", "Window Title",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	70	"-use",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	71	"-overview", (srcdir + FS + "overview.html"),
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	72	"-sourcepath", srcdir,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	73	"p1", "p2"
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	74	});
10 06bc494ca11e Initial load duke parents: diff changeset	75	runTestsOnHTML(testArray);
06bc494ca11e Initial load duke parents: diff changeset	76
06bc494ca11e Initial load duke parents: diff changeset	77	printSummary();
06bc494ca11e Initial load duke parents: diff changeset	78	}
06bc494ca11e Initial load duke parents: diff changeset	79
06bc494ca11e Initial load duke parents: diff changeset	80	/** Run javadoc */
06bc494ca11e Initial load duke parents: diff changeset	81	public static void runJavadoc(String[] javadocArgs) {
06bc494ca11e Initial load duke parents: diff changeset	82	if (com.sun.tools.javadoc.Main.execute(javadocArgs) != 0) {
06bc494ca11e Initial load duke parents: diff changeset	83	throw new Error("Javadoc failed to execute");
06bc494ca11e Initial load duke parents: diff changeset	84	}
06bc494ca11e Initial load duke parents: diff changeset	85	}
06bc494ca11e Initial load duke parents: diff changeset	86
06bc494ca11e Initial load duke parents: diff changeset	87	/**
06bc494ca11e Initial load duke parents: diff changeset	88	* Assign value for [ stringToFind, filename ]
06bc494ca11e Initial load duke parents: diff changeset	89	* NOTE: The standard doclet uses the same separator "\n" for all OS's
06bc494ca11e Initial load duke parents: diff changeset	90	*/
06bc494ca11e Initial load duke parents: diff changeset	91	private static final String[][] testArray = {
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	92	// Test the proper DOCTYPE element is present:
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	93	{
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	94	"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Frameset//EN\" \"http://www.w3.org/TR/html4/frameset.dtd\">",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	95	TMPDEST_DIR1 + "index.html"
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	96	},
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	97	// Test the proper DOCTYPE element is present:
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	98	{
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	99	"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	100	TMPDEST_DIR1 + "overview-summary.html"
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	101	},
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	102	// Test the proper DOCTYPE element is present:
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	103	{
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	104	"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	105	TMPDEST_DIR1 + "p1" + FS + "package-summary.html"
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	106	},
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	107	// Test the proper DOCTYPE element is present:
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	108	{
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	109	"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	110	TMPDEST_DIR1 + "p1" + FS + "C.html"
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	111	},
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	112	// Test the proper DOCTYPE element is present:
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	113	{
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	114	"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	115	TMPDEST_DIR1 + "overview-frame.html"
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	116	},
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	117	// Test the proper DOCTYPE element is present:
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	118	{
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	119	"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	120	TMPDEST_DIR1 + "allclasses-frame.html"
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	121	},
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	122	// Test the proper DOCTYPE element is present:
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	123	{
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	124	"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	125	TMPDEST_DIR1 + "p1" + FS + "package-frame.html"
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	126	},
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	127	// Test that <NOFRAMES> is inside <FRAMESET> element:
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	128	{
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	129	"</noframes>" + LS + "</frameset>",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	130	TMPDEST_DIR1 + "index.html"
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	131	},
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	132	// Test the table elements are in the correct order:
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	133	{
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	134	"</td>" + LS + "</tr>",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	135	TMPDEST_DIR1 + FS + "p1" + FS + "package-use.html"
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	136	}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	137	};
10 06bc494ca11e Initial load duke parents: diff changeset	138
06bc494ca11e Initial load duke parents: diff changeset	139	public static void runTestsOnHTML(String[][] testArray) {
06bc494ca11e Initial load duke parents: diff changeset	140
06bc494ca11e Initial load duke parents: diff changeset	141	for (int i = 0; i < testArray.length; i++) {
06bc494ca11e Initial load duke parents: diff changeset	142
06bc494ca11e Initial load duke parents: diff changeset	143	subtestNum += 1;
06bc494ca11e Initial load duke parents: diff changeset	144
06bc494ca11e Initial load duke parents: diff changeset	145	// Read contents of file into a string
06bc494ca11e Initial load duke parents: diff changeset	146	String fileString = readFileToString(testArray[i][1]);
06bc494ca11e Initial load duke parents: diff changeset	147
06bc494ca11e Initial load duke parents: diff changeset	148	// Get string to find
06bc494ca11e Initial load duke parents: diff changeset	149	String stringToFind = testArray[i][0];
06bc494ca11e Initial load duke parents: diff changeset	150
06bc494ca11e Initial load duke parents: diff changeset	151	// Find string in file's contents
06bc494ca11e Initial load duke parents: diff changeset	152	if (findString(fileString, stringToFind) == -1) {
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	153	System.out.println("\nSub-test " + (subtestNum) + " for bug " + BUGID + " (" + BUGNAME + ") FAILED\n" + "when searching for:\n" + stringToFind);
10 06bc494ca11e Initial load duke parents: diff changeset	154	} else {
06bc494ca11e Initial load duke parents: diff changeset	155	numSubtestsPassed += 1;
06bc494ca11e Initial load duke parents: diff changeset	156	System.out.println("\nSub-test " + (subtestNum) + " passed:\n" + stringToFind);
06bc494ca11e Initial load duke parents: diff changeset	157	}
06bc494ca11e Initial load duke parents: diff changeset	158	}
06bc494ca11e Initial load duke parents: diff changeset	159	}
06bc494ca11e Initial load duke parents: diff changeset	160
06bc494ca11e Initial load duke parents: diff changeset	161	public static void printSummary() {
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	162	if (numSubtestsPassed == subtestNum) {
10 06bc494ca11e Initial load duke parents: diff changeset	163	System.out.println("\nAll " + numSubtestsPassed + " subtests passed");
06bc494ca11e Initial load duke parents: diff changeset	164	} else {
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	165	throw new Error("\n" + (subtestNum - numSubtestsPassed) + " of " + (subtestNum) + " subtests failed for bug " + BUGID + " (" + BUGNAME + ")\n");
10 06bc494ca11e Initial load duke parents: diff changeset	166	}
06bc494ca11e Initial load duke parents: diff changeset	167	}
06bc494ca11e Initial load duke parents: diff changeset	168
06bc494ca11e Initial load duke parents: diff changeset	169	// Read the file into a String
06bc494ca11e Initial load duke parents: diff changeset	170	public static String readFileToString(String filename) {
06bc494ca11e Initial load duke parents: diff changeset	171	try {
06bc494ca11e Initial load duke parents: diff changeset	172	File file = new File(filename);
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	173	if (!file.exists()) {
10 06bc494ca11e Initial load duke parents: diff changeset	174	System.out.println("\nFILE DOES NOT EXIST: " + filename);
06bc494ca11e Initial load duke parents: diff changeset	175	}
06bc494ca11e Initial load duke parents: diff changeset	176	BufferedReader in = new BufferedReader(new FileReader(file));
06bc494ca11e Initial load duke parents: diff changeset	177
06bc494ca11e Initial load duke parents: diff changeset	178	// Create an array of characters the size of the file
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	179	char[] allChars = new char[(int) file.length()];
10 06bc494ca11e Initial load duke parents: diff changeset	180
06bc494ca11e Initial load duke parents: diff changeset	181	// Read the characters into the allChars array
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	182	in.read(allChars, 0, (int) file.length());
10 06bc494ca11e Initial load duke parents: diff changeset	183	in.close();
06bc494ca11e Initial load duke parents: diff changeset	184
06bc494ca11e Initial load duke parents: diff changeset	185	// Convert to a string
06bc494ca11e Initial load duke parents: diff changeset	186	String allCharsString = new String(allChars);
06bc494ca11e Initial load duke parents: diff changeset	187
06bc494ca11e Initial load duke parents: diff changeset	188	return allCharsString;
06bc494ca11e Initial load duke parents: diff changeset	189
06bc494ca11e Initial load duke parents: diff changeset	190	} catch (FileNotFoundException e) {
06bc494ca11e Initial load duke parents: diff changeset	191	System.err.println(e);
06bc494ca11e Initial load duke parents: diff changeset	192	return "";
06bc494ca11e Initial load duke parents: diff changeset	193	} catch (IOException e) {
06bc494ca11e Initial load duke parents: diff changeset	194	System.err.println(e);
06bc494ca11e Initial load duke parents: diff changeset	195	return "";
06bc494ca11e Initial load duke parents: diff changeset	196	}
06bc494ca11e Initial load duke parents: diff changeset	197	}
06bc494ca11e Initial load duke parents: diff changeset	198
06bc494ca11e Initial load duke parents: diff changeset	199	public static int findString(String fileString, String stringToFind) {
06bc494ca11e Initial load duke parents: diff changeset	200	return fileString.indexOf(stringToFind);
06bc494ca11e Initial load duke parents: diff changeset	201	}
06bc494ca11e Initial load duke parents: diff changeset	202	}

author	lana
	Thu, 20 Jan 2011 10:49:03 -0800
changeset 7957	900a9e8d6c4e
parent 7681	1f0819a3341f
child 23971	f5ff1f5a8dee
permissions	-rw-r--r--