jdk-sandbox: test/langtools/jdk/javadoc/doclet/testHtmlLandmarkRegions/TestHtmlLandmarkRegions.java@48b88b9c11eb (annotated)

53270 f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	1	/*
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	2	* Copyright (c) 2018, 2019, Oracle and/or its affiliates. All rights reserved.
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	4	*
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	5	* This code is free software; you can redistribute it and/or modify it
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	6	* under the terms of the GNU General Public License version 2 only, as
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	7	* published by the Free Software Foundation.
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	8	*
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	9	* This code is distributed in the hope that it will be useful, but WITHOUT
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	12	* version 2 for more details (a copy is included in the LICENSE file that
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	13	* accompanied this code).
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	14	*
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	15	* You should have received a copy of the GNU General Public License version
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	16	* 2 along with this work; if not, write to the Free Software Foundation,
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	17	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	18	*
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	19	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	20	* or visit www.oracle.com if you need additional information or have any
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	21	* questions.
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	22	*/
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	23
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	24	/*
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	25	* @test
59294 48b88b9c11eb 8223378: CSS solution for navbar problem with <a> elements is not ideal hannesw parents: 54500 diff changeset	26	* @bug 8210047 8199892 8215599 8223378
53270 f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	27	* @summary some pages contains content outside of landmark region
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	28	* @library /tools/lib ../../lib
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	29	* @modules
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	30	* jdk.javadoc/jdk.javadoc.internal.tool
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	31	* jdk.compiler/com.sun.tools.javac.api
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	32	* jdk.compiler/com.sun.tools.javac.main
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	33	* @build javadoc.tester.*
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	34	* @run main TestHtmlLandmarkRegions
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	35	*/
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	36
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	37
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	38	import java.nio.file.Files;
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	39	import java.nio.file.Path;
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	40	import java.nio.file.Paths;
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	41	import java.util.List;
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	42
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	43	import builder.ClassBuilder;
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	44	import toolbox.ModuleBuilder;
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	45	import toolbox.ToolBox;
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	46
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	47	import javadoc.tester.JavadocTester;
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	48
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	49	public class TestHtmlLandmarkRegions extends JavadocTester {
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	50
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	51	final ToolBox tb;
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	52
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	53	public static void main(String... args) throws Exception {
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	54	TestHtmlLandmarkRegions tester = new TestHtmlLandmarkRegions();
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	55	tester.runTests(m -> new Object[]{Paths.get(m.getName())});
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	56	}
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	57
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	58	TestHtmlLandmarkRegions() {
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	59	tb = new ToolBox();
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	60	}
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	61
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	62	@Test
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	63	public void testModules(Path base) throws Exception {
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	64	Path srcDir = base.resolve("src");
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	65	createModules(srcDir);
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	66
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	67	Path outDir = base.resolve("out");
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	68	javadoc("-d", outDir.toString(),
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	69	"-doctitle", "Document Title",
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	70	"-header", "Test Header",
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	71	"--module-source-path", srcDir.toString(),
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	72	"--module", "m1,m2");
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	73
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	74	checkExit(Exit.OK);
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	75
54350 4f9772f4403d 8215599: Remove support for javadoc "frames" mode pmuthuswamy parents: 53991 diff changeset	76	checkOrder("index.html",
59294 48b88b9c11eb 8223378: CSS solution for navbar problem with <a> elements is not ideal hannesw parents: 54500 diff changeset	77	"<header role=\"banner\" class=\"flexHeader\">\n"
53270 f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	78	+ "<nav role=\"navigation\">",
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	79	"<main role=\"main\">\n"
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	80	+ "<div class=\"header\">\n"
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	81	+ "<h1 class=\"title\">Document Title</h1>",
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	82	"<footer role=\"contentinfo\">\n"
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	83	+ "<nav role=\"navigation\">");
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	84	}
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	85
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	86	@Test
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	87	public void testPackages(Path base) throws Exception {
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	88	Path srcDir = base.resolve("src");
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	89	createPackages(srcDir);
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	90
53991 786825220790 8219801: Pages do not have <h1> jjg parents: 53883 diff changeset	91	Path outDir = base.resolve("out");
53270 f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	92	javadoc("-d", outDir.toString(),
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	93	"-doctitle", "Document Title",
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	94	"-header", "Test Header",
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	95	"-sourcepath", srcDir.toString(),
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	96	"pkg1", "pkg2");
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	97
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	98	checkExit(Exit.OK);
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	99
54350 4f9772f4403d 8215599: Remove support for javadoc "frames" mode pmuthuswamy parents: 53991 diff changeset	100	checkOrder("index.html",
59294 48b88b9c11eb 8223378: CSS solution for navbar problem with <a> elements is not ideal hannesw parents: 54500 diff changeset	101	"<header role=\"banner\" class=\"flexHeader\">\n"
53270 f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	102	+ "<nav role=\"navigation\">",
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	103	"<main role=\"main\">\n"
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	104	+ "<div class=\"header\">\n"
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	105	+ "<h1 class=\"title\">Document Title</h1>",
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	106	"<footer role=\"contentinfo\">\n" +
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	107	"<nav role=\"navigation\">");
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	108	}
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	109
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	110	@Test
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	111	public void testDocFiles(Path base) throws Exception {
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	112	Path srcDir = base.resolve("src");
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	113	createPackages(srcDir);
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	114	Path docFiles = Files.createDirectory(srcDir.resolve("pkg1").resolve("doc-files"));
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	115	Files.write(docFiles.resolve("s.html"), List.of(
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	116	"<html>\n"
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	117	+ " <head>\n"
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	118	+ " <title>\"Hello World\"</title>\n"
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	119	+ " </head>\n"
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	120	+ " <body>\n"
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	121	+ " A sample doc file.\n"
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	122	+ " </body>\n"
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	123	+ "</html>"));
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	124
53991 786825220790 8219801: Pages do not have <h1> jjg parents: 53883 diff changeset	125	Path outDir = base.resolve("out");
53270 f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	126	javadoc("-d", outDir.toString(),
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	127	"-sourcepath", srcDir.toString(),
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	128	"pkg1", "pkg2");
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	129
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	130	checkExit(Exit.OK);
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	131
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	132	checkOrder("pkg1/doc-files/s.html",
59294 48b88b9c11eb 8223378: CSS solution for navbar problem with <a> elements is not ideal hannesw parents: 54500 diff changeset	133	"<header role=\"banner\" class=\"flexHeader\">\n"
53270 f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	134	+ "<nav role=\"navigation\">\n",
59294 48b88b9c11eb 8223378: CSS solution for navbar problem with <a> elements is not ideal hannesw parents: 54500 diff changeset	135	"<main role=\"main\">\n"
48b88b9c11eb 8223378: CSS solution for navbar problem with <a> elements is not ideal hannesw parents: 54500 diff changeset	136	+ "<div class=\"contentContainer\">A sample doc file",
53270 f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	137	"<footer role=\"contentinfo\">\n"
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	138	+ "<nav role=\"navigation\">"
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	139	);
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	140	}
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	141
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	142	void createModules(Path srcDir) throws Exception {
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	143	new ModuleBuilder(tb, "m1")
53991 786825220790 8219801: Pages do not have <h1> jjg parents: 53883 diff changeset	144	.classes("package p1; public class a { }")
786825220790 8219801: Pages do not have <h1> jjg parents: 53883 diff changeset	145	.classes("package p2; public class b { }")
53270 f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	146	.write(srcDir);
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	147	new ModuleBuilder(tb, "m2")
53991 786825220790 8219801: Pages do not have <h1> jjg parents: 53883 diff changeset	148	.classes("package p3; public class c { }")
786825220790 8219801: Pages do not have <h1> jjg parents: 53883 diff changeset	149	.classes("package p4; public class d { }")
53270 f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	150	.write(srcDir);
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	151	}
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	152
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	153	void createPackages(Path srcDir) throws Exception {
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	154	new ClassBuilder(tb, "pkg1.A")
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	155	.setModifiers("public", "class")
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	156	.write(srcDir);
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	157	new ClassBuilder(tb, "pkg2.B")
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	158	.setModifiers("public", "class")
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	159	.write(srcDir);
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	160	}
f3a42c440fcb 8199892: Missing landmarks when generating docs using html sources pmuthuswamy parents: diff changeset	161	}

author	hannesw
	Wed, 27 Nov 2019 13:08:16 +0100
changeset 59294	48b88b9c11eb
parent 54500	71ef6db01d8e
permissions	-rw-r--r--