jdk-24/test/langtools/jdk/javadoc/doclet/testUnnamedPackage/TestUnnamedPackage.java
Jonathan Gibbons 2294f225c0 8286311: remove boilerplate from use of runTests
Reviewed-by: hannesw
2022-12-22 21:20:43 +00:00

188 lines
7.9 KiB
Java

/*
* Copyright (c) 2003, 2022, 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 4904075 4774450 5015144 8043698 8196201 8203791 8184205 8260223
* 8256208
* @summary Reference unnamed package as "Unnamed", not empty string.
* Generate a package summary for the unnamed package.
* @library ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build javadoc.tester.*
* @run main TestUnnamedPackage
*/
import javadoc.tester.JavadocTester;
public class TestUnnamedPackage extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestUnnamedPackage();
tester.runTests();
}
@Test
public void test() {
javadoc("-d", "out",
"-sourcepath", testSrc("src1"),
testSrc("src1/C.java"));
checkExit(Exit.OK);
checkOutput("index.html", true,
"""
<script type="text/javascript">window.location.replace('package-summary.html')</script>
<noscript>
<meta http-equiv="Refresh" content="0;package-summary.html">
</noscript>""");
checkOutput("package-summary.html", true,
"""
<h1 title="Unnamed Package" class="title">Unnamed Package</h1>""",
"This is a package comment for the unnamed package.",
"This is a class in the unnamed package.");
checkOutput("package-summary.html", true,
"<title>Unnamed Package</title>");
checkOutput("package-tree.html", true,
"""
<h1 class="title">Hierarchy For Unnamed Package</h1>""");
checkOutput("index-all.html", true,
"""
title="class in Unnamed Package\"""");
checkOutput("C.html", true,
"<a href=\"package-summary.html\">");
checkOutput("allclasses-index.html", true,
"""
<div id="all-classes-table">
<div class="caption"><span>Classes</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><\
a href="C.html" title="class in Unnamed Package">C</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">This is a class in the unnamed package.</div>
</div>
</div>""");
checkOutput("allpackages-index.html", true,
"""
<div class="caption"><span>Package Summary</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="package-summary.html">Unnamed Package</a></div>
<div class="col-last even-row-color">
<div class="block">This is a package comment for the unnamed package.</div>
</div>
</div>""");
checkOutput("type-search-index.js", true,
"""
{"l":"All Classes and Interfaces","u":"allclasses-index.html"}""");
checkOutput("package-search-index.js", true,
"""
{"l":"All Packages","u":"allpackages-index.html"}""");
checkOutput("index-all.html", true,
"""
<br><a href="allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a\
><span class="vertical-separator">|</span><a href="allpackages-index.html">All&n\
bsp;Packages</a>""");
checkOutput("type-search-index.js", true,
"""
{"l":"All Classes and Interfaces","u":"allclasses-index.html"}""",
"""
{"p":"<Unnamed>","l":"C"}""");
checkOutput("member-search-index.js", true,
"""
{"p":"<Unnamed>","c":"C","l":"C()","u":"%3Cinit%3E()"}""");
checkOutput("package-search-index.js", true,
"""
{"l":"All Packages","u":"allpackages-index.html"}""");
checkOutput("package-search-index.js", false, "Unnamed");
checkOutput(Output.OUT, false,
"BadSource");
}
@Test
public void testUse() {
javadoc("-d", "out-use",
"-use",
testSrc("src2/A.java"),
testSrc("src2/B.java"));
checkExit(Exit.OK);
checkOutput("package-use.html", true,
"""
Classes in <a href="package-summary.html">Unnamed Package</a> used by <a href="p\
ackage-summary.html">Unnamed Package</a>""");
checkOutput("class-use/A.html", true,
"""
<h2>Uses of <a href="../A.html" title="class in Unnamed Package">A</a> in <a hre\
f="../package-summary.html">Unnamed Package</a></h2>""",
"""
Fields in <a href="../package-summary.html">Unnamed Package</a> declared as <a h\
ref="../A.html" title="class in Unnamed Package">A</a>""",
"""
Methods in <a href="../package-summary.html">Unnamed Package</a> that return <a \
href="../A.html" title="class in Unnamed Package">A</a>""",
"""
Constructors in <a href="../package-summary.html">Unnamed Package</a> with param\
eters of type <a href="../A.html" title="class in Unnamed Package">A</a>""");
}
@Test
public void testMixed() {
javadoc("-d", "out-mixed",
"-sourcepath", testSrc("src1"),
testSrc("src1/C.java"),
"pkg");
checkExit(Exit.OK);
checkOutput("index.html", true,
"""
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"\
><a href="package-summary.html">Unnamed Package</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
<div class="block">This is a package comment for the unnamed package.</div>
</div>
<div class="col-first odd-row-color all-packages-table all-packages-table-tab1">\
<a href="pkg/package-summary.html">pkg</a></div>
<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
<div class="block">This is a package comment for package pkg.</div>""");
}
}