File: BadOptionsTest.java

package info (click to toggle)
openjdk-25 25~36ea-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 825,300 kB
  • sloc: java: 5,585,424; cpp: 1,333,938; xml: 1,321,242; ansic: 487,993; asm: 404,003; objc: 21,088; sh: 15,102; javascript: 13,265; python: 8,319; makefile: 2,519; perl: 357; awk: 351; pascal: 103; exp: 83; sed: 72; jsp: 24
file content (241 lines) | stat: -rw-r--r-- 9,002 bytes parent folder | download | duplicates (5)
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/*
 * Copyright (c) 2002, 2024, 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 8169676 8175055 8323016
 * @summary boolean result of Option.process is often ignored
 * @modules jdk.compiler/com.sun.tools.javac.api
 * @modules jdk.compiler/com.sun.tools.javac.main
 * @modules jdk.javadoc/jdk.javadoc.internal.api
 * @modules jdk.javadoc/jdk.javadoc.internal.tool
 * @library /tools/lib
 * @build toolbox.JavacTask toolbox.JavadocTask toolbox.TestRunner toolbox.ToolBox
 * @run main BadOptionsTest
 */

import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.Paths;

import toolbox.JavadocTask;
import toolbox.ModuleBuilder;
import toolbox.Task;
import toolbox.TestRunner;
import toolbox.ToolBox;

/*
 * This is primarily a test of the error reporting mechanisms
 * for bad options provided by javac and utilized by javadoc.
 * It is not an exhaustive test of all bad option forms detected
 * by javac/javadoc.
 */
public class BadOptionsTest extends TestRunner {

    public static void main(String... args) throws Exception {
        BadOptionsTest t = new BadOptionsTest();
        t.runTests();
    }

    private final ToolBox tb = new ToolBox();
    private final Path src = Paths.get("src");

    BadOptionsTest() throws IOException {
        super(System.err);
        init();
    }

    void init() throws IOException {
        tb.writeJavaFiles(src,
                "public class C { }");

    }

    @Test
    public void testAddModulesEmptyArg() {
        Task.Result result = new JavadocTask(tb, Task.Mode.CMDLINE)
                .options("--add-modules=")
                .files(src.resolve("C.java"))
                .run(Task.Expect.FAIL)
                .writeAll();
        checkFound(result.getOutput(Task.OutputKind.DIRECT),
                "error: no value for --add-modules option");
        checkNotFound(result, "Exception", "at jdk.javadoc/");
    }

    @Test
    public void testAddModulesBadName() {
        Task.Result result = new JavadocTask(tb, Task.Mode.CMDLINE)
                .options("-quiet",
                        "--add-modules", "123")
                .files(src.resolve("C.java"))
                .run(Task.Expect.FAIL)
                .writeAll();
        checkFound(result.getOutput(Task.OutputKind.DIRECT),
                "error: bad name in value for --add-modules option: '123'");
        checkNotFound(result, "Exception", "at jdk.javadoc/");
    }

    @Test
    public void testAddExportsEmptyArg() {
        Task.Result result = new JavadocTask(tb, Task.Mode.CMDLINE)
                .options("--add-exports=")
                .files(src.resolve("C.java"))
                .run(Task.Expect.FAIL)
                .writeAll();
        checkFound(result.getOutput(Task.OutputKind.DIRECT),
                "error: no value for --add-exports option");
        checkNotFound(result, "Exception", "at jdk.javadoc/");
    }

    @Test
    public void testAddExportsBadArg() {
        Task.Result result = new JavadocTask(tb, Task.Mode.CMDLINE)
                .options("--add-exports=m/p")
                .files(src.resolve("C.java"))
                .run(Task.Expect.FAIL)
                .writeAll();
        checkFound(result.getOutput(Task.OutputKind.DIRECT),
                "error: bad value for --add-exports option: 'm/p'");
        checkNotFound(result, "Exception", "at jdk.javadoc/");
    }

    @Test
    public void testAddExportsBadName() {
        Task.Result result = new JavadocTask(tb, Task.Mode.CMDLINE)
                .options("--add-exports", "m!/p1=m2")
                .files(src.resolve("C.java"))
                .run()
                .writeAll();
        checkFound(result.getOutput(Task.OutputKind.DIRECT),
                "warning: bad name in value for --add-exports option: 'm!'");
        checkNotFound(result, "Exception", "at jdk.javadoc/");
    }

    @Test
    public void testSourcePathAndModuleSourceConflict() throws IOException {
        Path msrc = Paths.get("msrc");
        new ModuleBuilder(tb, "m1")
                .exports("p1")
                .classes("package p1; public class C1 { }")
                .write(msrc);
        Task.Result result = new JavadocTask(tb, Task.Mode.CMDLINE)
                .options("-sourcepath", "src",
                        "--module-source-path", msrc.getFileName().toString(),
                        "--module", "m1")
                .run(Task.Expect.FAIL)
                .writeAll();
        checkFound(result.getOutput(Task.OutputKind.DIRECT),
                "error: cannot specify both --source-path and --module-source-path");
        checkFound(result.getOutput(Task.OutputKind.DIRECT),
                "1 error");
    }

    @Test
    public void testOptionNotFound_NoSuggestions() {
        var result = new JavadocTask(tb, Task.Mode.CMDLINE)
                .options("--not-a-path")
                .run(Task.Expect.FAIL)
                .writeAll();
        checkFound(String.join("\n", result.getOutputLines(Task.OutputKind.DIRECT)),
                """
                    error: invalid flag: --not-a-path
                    For more details on available options, use --help or --help-extra"""
        );
    }

    @Test
    public void testOptionNotFound_OneSuggestion() {
        var result = new JavadocTask(tb, Task.Mode.CMDLINE)
                .options("--middle-path")
                .run(Task.Expect.FAIL)
                .writeAll();
        checkFound(String.join("\n", result.getOutputLines(Task.OutputKind.DIRECT)),
                """
                    error: invalid flag: --middle-path
                    Did you mean: --module-path
                    For more details on available options, use --help or --help-extra"""
        );
    }

    @Test
    public void testOptionNotFound_TwoSuggestions() {
        var result = new JavadocTask(tb, Task.Mode.CMDLINE)
                .options("--sourcepath")
                .run(Task.Expect.FAIL)
                .writeAll();
        checkFound(String.join("\n", result.getOutputLines(Task.OutputKind.DIRECT)),
                """
                    error: invalid flag: --sourcepath
                    Did you mean one of: --source-path -sourcepath
                    For more details on available options, use --help or --help-extra"""
        );
    }

    @Test
    public void testOptionNotFound_ThreeSuggestions() {
        var result = new JavadocTask(tb, Task.Mode.CMDLINE)
                .options("--classpath")
                .run(Task.Expect.FAIL)
                .writeAll();
        checkFound(String.join("\n", result.getOutputLines(Task.OutputKind.DIRECT)),
                """
                    error: invalid flag: --classpath
                    Did you mean one of: --class-path -classpath -bootclasspath
                    For more details on available options, use --help or --help-extra"""
        );
    }

    @Test
    public void testOptionNotFound_DocletOption() {
        var result = new JavadocTask(tb, Task.Mode.CMDLINE)
                .options("-tiglet")
                .run(Task.Expect.FAIL)
                .writeAll();
        checkFound(String.join("\n", result.getOutputLines(Task.OutputKind.DIRECT)),
                """
                    error: invalid flag: -tiglet
                    Did you mean: -taglet
                    For more details on available options, use --help or --help-extra"""
        );
    }

    private void checkFound(String log, String... expect) {
        for (String e : expect) {
            if (!log.contains(e)) {
                error("Expected string not found: '" + e + "'");
            }
        }
    }

    private void checkNotFound(Task.Result result, String... unexpected) {
        for (Task.OutputKind k : Task.OutputKind.values()) {
            String r = result.getOutput(k);
            for (String u : unexpected) {
                if (r.contains(u)) {
                    error("Unexpected string found: '" + u + "'");
                }
            }
        }
    }
}