/*
* Copyright (c) 2016, 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 8154119 8154262 8156077 8157987 8154261
* @summary Test modules support in javadoc.
* @author bpatel
* @library ../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build JavadocTester
* @run main TestModules
*/
public class TestModules extends JavadocTester {
public static void main(String... args) throws Exception {
TestModules tester = new TestModules();
tester.runTests();
}
@Test
void test1() {
javadoc("-d", "out", "-use",
"-modulesourcepath", testSrc,
"-addmods", "module1,module2",
"testpkgmdl1", "testpkgmdl2");
checkExit(Exit.OK);
testDescription(true);
testNoDescription(false);
testOverviewSummaryModules();
testModuleLink();
}
@Test
void test2() {
javadoc("-d", "out-html5", "-html5", "-use",
"-modulesourcepath", testSrc,
"-addmods", "module1,module2",
"testpkgmdl1", "testpkgmdl2");
checkExit(Exit.OK);
testHtml5Description(true);
testHtml5NoDescription(false);
testHtml5OverviewSummaryModules();
testModuleLink();
}
@Test
void test3() {
javadoc("-d", "out-nocomment", "-nocomment", "-use",
"-modulesourcepath", testSrc,
"-addmods", "module1,module2",
"testpkgmdl1", "testpkgmdl2");
checkExit(Exit.OK);
testDescription(false);
testNoDescription(true);
testModuleLink();
}
@Test
void test4() {
javadoc("-d", "out-html5-nocomment", "-nocomment", "-html5", "-use",
"-modulesourcepath", testSrc,
"-addmods", "module1,module2",
"testpkgmdl1", "testpkgmdl2");
checkExit(Exit.OK);
testHtml5Description(false);
testHtml5NoDescription(true);
testModuleLink();
}
@Test
void test5() {
javadoc("-d", "out-nomodule", "-use",
"-sourcepath", testSrc,
"testpkgnomodule", "testpkgnomodule1");
checkExit(Exit.OK);
testOverviewSummaryPackages();
}
@Test
void test6() {
javadoc("-d", "out-mdltags", "-author", "-version",
"-tag", "regular:a:Regular Tag:",
"-tag", "moduletag:s:Module Tag:",
"-modulesourcepath", testSrc,
"-addmods", "moduletags,module2",
"testpkgmdltags", "testpkgmdl2");
checkExit(Exit.OK);
testModuleTags();
}
@Test
void test7() {
javadoc("-d", "out-moduleSummary", "-use",
"-modulesourcepath", testSrc,
"-addmods", "module1,module2",
"testpkgmdl1", "testpkgmdl2", "testpkg2mdl2");
checkExit(Exit.OK);
testModuleSummary();
testNegatedModuleSummary();
}
@Test
void test8() {
javadoc("-d", "out-html5-nomodule", "-html5", "-use",
"-sourcepath", testSrc,
"testpkgnomodule", "testpkgnomodule1");
checkExit(Exit.OK);
testHtml5OverviewSummaryPackages();
}
void testDescription(boolean found) {
checkOutput("module1-summary.html", found,
"\n"
+ "\n"
+ "\n"
+ "\n"
+ "
This is a test description for the module1 module.
");
checkOutput("module2-summary.html", found,
"\n"
+ "\n"
+ "\n"
+ "\n"
+ "This is a test description for the module2 module.
");
}
void testNoDescription(boolean found) {
checkOutput("module1-summary.html", found,
"\n"
+ "
\n"
+ "- \n"
+ "
\n"
+ "- \n"
+ "");
checkOutput("module2-summary.html", found,
"
\n"
+ "
\n"
+ "- \n"
+ "
\n"
+ "- \n"
+ "");
}
void testHtml5Description(boolean found) {
checkOutput("module1-summary.html", found,
"\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "
This is a test description for the module1 module.
\n"
+ "");
checkOutput("module2-summary.html", found,
"\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "This is a test description for the module2 module.
\n"
+ "");
}
void testHtml5NoDescription(boolean found) {
checkOutput("module1-summary.html", found,
"\n"
+ "
\n"
+ "- \n"
+ "
\n"
+ "- \n"
+ "");
checkOutput("module2-summary.html", found,
"
\n"
+ "
\n"
+ "- \n"
+ "
\n"
+ "- \n"
+ "");
}
void testModuleLink() {
checkOutput("overview-summary.html", true,
"
- Module
");
checkOutput("module1-summary.html", true,
"- Module
");
checkOutput("module2-summary.html", true,
"- Module
");
checkOutput("testpkgmdl1/package-summary.html", true,
"- Module
");
checkOutput("testpkgmdl1/TestClassInModule1.html", true,
"- Module
");
checkOutput("testpkgmdl1/class-use/TestClassInModule1.html", true,
"- Module
");
checkOutput("testpkgmdl2/package-summary.html", true,
"- Module
");
checkOutput("testpkgmdl2/TestClassInModule2.html", true,
"- Module
");
checkOutput("testpkgmdl2/class-use/TestClassInModule2.html", true,
"- Module
");
}
void testNoModuleLink() {
checkOutput("testpkgnomodule/package-summary.html", true,
"\n"
+ "- Package
");
checkOutput("testpkgnomodule/TestClassNoModule.html", true,
"\n"
+ "- Package
");
checkOutput("testpkgnomodule/class-use/TestClassNoModule.html", true,
"\n"
+ "- Package
");
}
void testModuleTags() {
checkOutput("moduletags-summary.html", true,
"Type Link: TestClassInModuleTags
.");
checkOutput("moduletags-summary.html", true,
"Member Link: testMethod(String)
.");
checkOutput("moduletags-summary.html", true,
"Package Link: testpkgmdltags
.");
checkOutput("moduletags-summary.html", true,
"- Since:
\n"
+ "- JDK 9
");
checkOutput("moduletags-summary.html", true,
"- See Also:
\n"
+ "- \"Test see tag\", \n"
+ "
"
+ "TestClassInModuleTags
");
checkOutput("moduletags-summary.html", true,
"- Regular Tag:
\n"
+ "- Just a regular simple tag.
");
checkOutput("moduletags-summary.html", true,
"- Module Tag:
\n"
+ "- Just a simple module tag.
");
checkOutput("moduletags-summary.html", true,
"- Version:
\n"
+ "- 1.0
");
checkOutput("moduletags-summary.html", true,
"- Author:
\n"
+ "- Bhavesh Patel
");
checkOutput("testpkgmdltags/TestClassInModuleTags.html", false,
"- Module Tag:
\n"
+ "- Just a simple module tag.
");
}
void testOverviewSummaryModules() {
checkOutput("overview-summary.html", true,
"\n"
+ "Modules \n"
+ "\n"
+ "Module | \n"
+ "Description | \n"
+ "
");
checkOutput("overview-summary.html", false,
"\n"
+ "Packages \n"
+ "\n"
+ "Package | \n"
+ "Description | \n"
+ "
");
}
void testOverviewSummaryPackages() {
checkOutput("overview-summary.html", false,
"\n"
+ "Modules \n"
+ "\n"
+ "Module | \n"
+ "Description | \n"
+ "
");
checkOutput("overview-summary.html", true,
"\n"
+ "Packages \n"
+ "\n"
+ "Package | \n"
+ "Description | \n"
+ "
");
}
void testHtml5OverviewSummaryModules() {
checkOutput("overview-summary.html", true,
"\n"
+ "Modules \n"
+ "\n"
+ "Module | \n"
+ "Description | \n"
+ "
");
checkOutput("overview-summary.html", false,
"\n"
+ "Packages \n"
+ "\n"
+ "Package | \n"
+ "Description | \n"
+ "
");
}
void testHtml5OverviewSummaryPackages() {
checkOutput("overview-summary.html", false,
"\n"
+ "Modules \n"
+ "\n"
+ "Module | \n"
+ "Description | \n"
+ "
");
checkOutput("overview-summary.html", true,
"\n"
+ "Packages \n"
+ "\n"
+ "Package | \n"
+ "Description | \n"
+ "
");
}
void testModuleSummary() {
checkOutput("module1-summary.html", true,
"");
checkOutput("module1-summary.html", true,
"\n"
+ "\n"
+ "\n"
+ "");
checkOutput("module1-summary.html", true,
"\n"
+ "testpkgmdl1 | \n"
+ "All Modules | \n"
+ " | \n"
+ "
");
checkOutput("module1-summary.html", true,
"\n"
+ "\n"
+ "\n"
+ "");
checkOutput("module1-summary.html", true,
"\n"
+ "module2 | \n"
+ "\n"
+ " This is a test description for the module2 module. \n"
+ " | \n"
+ "
");
checkOutput("module2-summary.html", true,
"- Description | Modules | "
+ "Packages | Services
");
checkOutput("module2-summary.html", true,
"\n"
+ "\n"
+ "\n"
+ "");
checkOutput("module2-summary.html", true,
"\n"
+ "testpkg2mdl2 | \n"
+ "module1 | \n"
+ " | \n"
+ "
");
checkOutput("module2-summary.html", true,
"\n"
+ "\n"
+ "\n"
+ "");
checkOutput("module2-summary.html", true,
"\n"
+ "java.base | \n"
+ " | \n"
+ "
");
checkOutput("module2-summary.html", true,
"\n"
+ "\n"
+ "\n"
+ "");
checkOutput("module2-summary.html", true,
"\n"
+ "TestClassInModule2 | \n"
+ " | \n"
+ "
");
checkOutput("module2-summary.html", true,
"\n"
+ "testpkg2mdl2.TestInterfaceInModule2 (Implementation: "
+ "TestClassInModule2) | \n"
+ " | \n"
+ "
Exported Packages \n"
+ "\n"
+ "Package | \n"
+ "Module | \n"
+ "Description | \n"
+ "
");
checkOutput("module2-summary.html", true,
"Requires \n"
+ "\n"
+ "Module | \n"
+ "Description | \n"
+ "
");
checkOutput("module2-summary.html", true,
"Uses \n"
+ "\n"
+ "Type | \n"
+ "Description | \n"
+ "
");
checkOutput("module2-summary.html", true,
"Provides \n"
+ "\n"
+ "Type | \n"
+ "Description | \n"
+ "
");
}
void testNegatedModuleSummary() {
checkOutput("module1-summary.html", false,
"\n"
+ "\n"
+ "\n"
+ "");
}
}