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
148
149
150
151
152
153
154
155
156
157
158
159
|
/*
* Copyright (c) 2020, 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 8224612
* @key randomness
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build javadoc.tester.*
* @run main/othervm OptionsTest
*/
import javadoc.tester.JavadocTester;
import jdk.javadoc.doclet.Doclet;
import jdk.javadoc.doclet.DocletEnvironment;
import jdk.javadoc.doclet.Reporter;
import javax.lang.model.SourceVersion;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Locale;
import java.util.Random;
import java.util.Set;
import java.util.TreeSet;
import java.util.function.Supplier;
public class OptionsTest extends JavadocTester {
public static void main(String... args) throws Exception {
new OptionsTest().runTests();
}
@Test
public void testEmptySupportedOptionsDoclet(Path base) {
test(EmptySupportedOptionsDoclet.class);
}
private void test(Class<? extends Doclet> _class) {
javadoc("-doclet", _class.getName(),
"-docletpath", System.getProperty("test.classes", "."),
"--help");
checkExit(Exit.OK);
checkOutput(Output.OUT, false, "javadoc: error - fatal error encountered: java.lang.NullPointerException");
checkOutput(Output.OUT, false, "Provided by the %s doclet:".formatted(_class.getSimpleName()));
}
@Test
public void testNullSupportedOptionsDoclet(Path base) {
test(NullSupportedOptionsDoclet.class);
}
public static final class EmptySupportedOptionsDoclet implements Doclet {
private final Random random;
public EmptySupportedOptionsDoclet() {
long seed = Long.getLong("jdk.test.lib.random.seed", System.currentTimeMillis());
System.out.println("new java.util.Random(" + seed + ")");
this.random = new Random(seed);
}
@Override
public void init(Locale locale, Reporter reporter) {
}
@Override
public String getName() {
return getClass().getSimpleName();
}
@Override
public Set<? extends Option> getSupportedOptions() {
return randomEmptySet();
}
/*
* This method is used to check that emptiness of a set is determined
* by value (or in this case, by behavior), rather than by reference
* (i.e. there's no code like `s == Collections.EMPTY_SET`, etc.)
*/
private Set<? extends Option> randomEmptySet() {
List<Supplier<Set<? extends Option>>> emptySets = List.of(
Set::of,
Collections::emptySet,
HashSet::new,
TreeSet::new,
LinkedHashSet::new
);
int idx = random.nextInt(emptySets.size());
return emptySets.get(idx).get();
}
@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.latestSupported();
}
@Override
public boolean run(DocletEnvironment environment) {
return true;
}
}
/**
* An implementation of an otherwise well-behaving Doclet, that returns
* {@code null} from {@link #getSupportedOptions}.
*/
public static final class NullSupportedOptionsDoclet implements Doclet {
@Override
public void init(Locale locale, Reporter reporter) {
}
@Override
public String getName() {
return getClass().getSimpleName();
}
@Override
public Set<? extends Option> getSupportedOptions() {
return null;
}
@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.latestSupported();
}
@Override
public boolean run(DocletEnvironment environment) {
return true;
}
}
}
|
