1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/*
* Copyright (c) 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 8272984
* @summary javadoc support for SOURCE_DATE_EPOCH
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.*
* @run main TestDateOption
*/
import java.nio.file.Path;
import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;
import java.util.Date;
import java.util.Locale;
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
public class TestDateOption extends JavadocTester {
/**
* The entry point of the test.
*
* @param args the array of command line arguments
* @throws Exception if the test fails
*/
public static void main(String... args) throws Exception {
var tester = new TestDateOption();
tester.runTests();
}
ToolBox tb = new ToolBox();
@Test
public void testDateOption(Path base) throws Exception {
ZonedDateTime zdt = ZonedDateTime.now(); // uses current date, time, timezone etc
// adjust the calendar to some date before the default used by javadoc (i.e. today/now)
// set a specific time, such as 10 to 3. (Rupert Brooke, Grantchester)
ZonedDateTime testDate = zdt.minusDays(100)
.withHour(14)
.withMinute(50)
.withSecond(0);
out.println("Test Date: '" + testDate + "'");
Path srcDir = base.resolve("src");
tb.writeJavaFiles(srcDir, """
package p;
/** Comment. */
public interface I { }
""");
Path outDir = base.resolve("out");
javadoc("-d", outDir.toString(),
"-sourcepath", srcDir.toString(),
"--date", testDate.toString(),
"p");
checkExit(Exit.OK);
int featureVersion = Runtime.version().feature();
// The following format is as used by javadoc; it is the historical format used by Date.toString()
DateTimeFormatter fmt =
DateTimeFormatter.ofPattern("EEE MMM dd HH:mm:ss zzz yyyy").withLocale(Locale.US);
String generatedByStamp = testDate.format(fmt);
String generatedBy = String.format("<!-- Generated by javadoc (%d) on %s -->",
featureVersion, generatedByStamp);
DateTimeFormatter dateFormat = DateTimeFormatter.ofPattern("yyyy-MM-dd");
String dcCreatedStamp = testDate.format(dateFormat);
String dcCreated = String.format("""
<meta name="dc.created" content="%s">""",
dcCreatedStamp);
// check the timestamps in all generated HTML files
for (Path file : tb.findFiles(".html", outputDir)) {
checkOutput(outputDir.relativize(file).toString(), true,
generatedBy,
dcCreated);
}
}
@Test
public void testBadDateOption(Path base) throws Exception {
Path srcDir = base.resolve("src");
tb.writeJavaFiles(srcDir, """
package p;
/** Comment. */
public interface I { }
""");
Path outDir = base.resolve("out");
javadoc("-d", outDir.toString(),
"-sourcepath", srcDir.toString(),
"--date", "NOT A DATE",
"p");
checkExit(Exit.CMDERR);
checkOutput(Output.OUT, true,
"error: value for '--date' not valid: NOT A DATE");
}
@Test
public void testInvalidDateOption(Path base) throws Exception {
Path srcDir = base.resolve("src");
tb.writeJavaFiles(srcDir, """
package p;
/** Comment. */
public interface I { }
""");
Path outDir = base.resolve("out");
javadoc("-d", outDir.toString(),
"-sourcepath", srcDir.toString(),
"--date", new Date(0).toInstant().toString(),
"p");
checkExit(Exit.CMDERR);
checkOutput(Output.OUT, true,
"error: value for '--date' out of range: 1970-01-01T00:00:00Z");
}
}
|
