File: Settings.java

package info (click to toggle)
openjdk-24 24.0.2%2B12-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 831,900 kB
  • sloc: java: 5,677,020; cpp: 1,323,154; xml: 1,320,524; ansic: 486,889; asm: 405,131; objc: 21,025; sh: 15,221; javascript: 11,049; python: 8,222; makefile: 2,504; perl: 357; awk: 351; sed: 172; pascal: 103; exp: 54; jsp: 24; csh: 3
file content (330 lines) | stat: -rw-r--r-- 13,443 bytes parent folder | download | duplicates (4)
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
/*
 * Copyright (c) 2010, 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.
 */
import java.io.File;
import java.io.IOException;

/*
 * @test
 * @bug 6994753 7123582 8305950 8281658 8310201 8311653 8343804
 * @summary tests -XshowSettings options
 * @modules jdk.compiler
 *          jdk.zipfs
 * @compile -XDignore.symbol.file Settings.java
 * @run main Settings
 * @author ksrini
 */
public class Settings extends TestHelper {
    private static File testJar = null;

    static void init() throws IOException {
        if  (testJar != null) {
            return;
        }
        testJar = new File("test.jar");
        StringBuilder tsrc = new StringBuilder();
        tsrc.append("public static void main(String... args) {\n");
        tsrc.append("   for (String x : args) {\n");
        tsrc.append("        System.out.println(x);\n");
        tsrc.append("   }\n");
        tsrc.append("}\n");
        createJar(testJar, tsrc.toString());
    }

    static void checkContains(TestResult tr, String str) {
        if (!tr.contains(str)) {
            System.out.println(tr);
            throw new RuntimeException(str + " not found");
        }
    }

    static void checkNotContains(TestResult tr, String str) {
        if (!tr.notContains(str)) {
            System.out.println(tr);
            throw new RuntimeException(str + " found");
        }
    }

    private static final String VM_SETTINGS = "VM settings:";
    private static final String PROP_SETTINGS = "Property settings:";
    private static final String LOCALE_SETTINGS = "Locale settings:";
    private static final String LOCALE_SUMMARY_SETTINGS =
                "Locale settings summary:";
    private static final String AVAILABLE_LOCALES = "available locales";
    private static final String SEC_PROPS_SETTINGS = "Security properties:";
    private static final String SEC_SUMMARY_PROPS_SETTINGS =
                "Security settings summary:";
    private static final String SEC_PROVIDER_SETTINGS =
                "Security provider static configuration:";
    private static final String SEC_TLS_SETTINGS = "Security TLS configuration";
    private static final String BAD_SEC_OPTION_MSG = "Valid \"security\" suboption values are";
    private static final String SYSTEM_SETTINGS = "Operating System Metrics:";
    private static final String METRICS_NOT_AVAILABLE_MSG = "No metrics available for this platform";
    private static final String STACKSIZE_SETTINGS = "Stack Size:";
    private static final String TIMEZONE_SETTINGS = "default timezone";
    private static final String TZDATA_SETTINGS = "tzdata version";
    private static final String ERR_MSG = "Unrecognized showSettings option:";

    /*
     * "all" should print verbose settings
     */
    static void containsAllOptions(TestResult tr) {
        checkContains(tr, VM_SETTINGS);
        checkContains(tr, PROP_SETTINGS);
        checkContains(tr, LOCALE_SETTINGS);
        checkContains(tr, AVAILABLE_LOCALES);
        checkNotContains(tr, LOCALE_SUMMARY_SETTINGS);
        checkContains(tr, SEC_PROPS_SETTINGS);
        checkNotContains(tr, SEC_SUMMARY_PROPS_SETTINGS);
        checkContains(tr, SEC_PROVIDER_SETTINGS);
        checkContains(tr, SEC_TLS_SETTINGS);
        checkContains(tr, TIMEZONE_SETTINGS);
        checkContains(tr, TZDATA_SETTINGS);
        if (System.getProperty("os.name").contains("Linux")) {
            checkContains(tr, SYSTEM_SETTINGS);
        } else {
            // only invoke system option by default on Linux
            checkNotContains(tr, METRICS_NOT_AVAILABLE_MSG);
        }
    }
    /*
     * default (no options) should print non verbose
     * details on each component
     */
    static void containsDefaultOptions(TestResult tr) {
        checkContains(tr, VM_SETTINGS);
        checkContains(tr, PROP_SETTINGS);
        checkNotContains(tr, LOCALE_SETTINGS);
        checkNotContains(tr, AVAILABLE_LOCALES);
        checkContains(tr, LOCALE_SUMMARY_SETTINGS);
        // no verbose security settings unless "security" or "all" used
        checkNotContains(tr, SEC_PROPS_SETTINGS);
        checkContains(tr, SEC_SUMMARY_PROPS_SETTINGS);
        checkContains(tr, SEC_PROVIDER_SETTINGS);
        checkContains(tr, SEC_TLS_SETTINGS);
        checkContains(tr, TIMEZONE_SETTINGS);
        checkContains(tr, TZDATA_SETTINGS);
        if (System.getProperty("os.name").contains("Linux")) {
            checkContains(tr, SYSTEM_SETTINGS);
        } else {
            // only invoke system option by default on Linux
            checkNotContains(tr, METRICS_NOT_AVAILABLE_MSG);
        }
    }

    static void runTestOptionDefault() throws IOException {
        int stackSize = 256; // in kb
        if (getArch().equals("ppc64") || getArch().equals("ppc64le")) {
            stackSize = 800;
        } else if (getArch().equals("aarch64")) {
            /*
             * The max value of minimum stack size allowed for aarch64 can be estimated as
             * such: suppose the vm page size is 64KB and the test runs with a debug build,
             * the initial _java_thread_min_stack_allowed defined in os_linux_aarch64.cpp is
             * 72K, stack guard zones could take 192KB, and the shadow zone needs 128KB,
             * after aligning up all parts to the page size, the final size would be 448KB.
             * See details in JDK-8163363
             */
            stackSize = 448;
        }
        TestResult tr;
        tr = doExec(javaCmd, "-Xms64m", "-Xmx512m",
                "-Xss" + stackSize + "k", "-XshowSettings", "-jar", testJar.getAbsolutePath());
        // Check the stack size logs printed by -XshowSettings to verify -Xss meaningfully.
        checkContains(tr, STACKSIZE_SETTINGS);
        containsDefaultOptions(tr);
        if (!tr.isOK()) {
            System.out.println(tr);
            throw new RuntimeException("test fails");
        }
        tr = doExec(javaCmd, "-Xms65536k", "-Xmx712m",
                "-Xss" + (stackSize * 1024), "-XshowSettings", "-jar", testJar.getAbsolutePath());
        checkContains(tr, STACKSIZE_SETTINGS);
        containsDefaultOptions(tr);
        if (!tr.isOK()) {
            System.out.println(tr);
            throw new RuntimeException("test fails");
        }
    }

    static void runTestOptionAll() throws IOException {
        init();
        TestResult tr = doExec(javaCmd, "-XshowSettings:all");
        containsAllOptions(tr);
    }

    static void runTestOptionVM() throws IOException {
        TestResult tr = doExec(javaCmd, "-XshowSettings:vm");
        checkContains(tr, VM_SETTINGS);
        checkNotContains(tr, PROP_SETTINGS);
        checkNotContains(tr, LOCALE_SETTINGS);
    }

    static void runTestOptionProperty() throws IOException {
        TestResult tr = doExec(javaCmd, "-XshowSettings:properties");
        checkNotContains(tr, VM_SETTINGS);
        checkContains(tr, PROP_SETTINGS);
        checkNotContains(tr, LOCALE_SETTINGS);
    }

    static void runTestOptionLocale() throws IOException {
        TestResult tr = doExec(javaCmd, "-XshowSettings:locale");
        checkNotContains(tr, VM_SETTINGS);
        checkNotContains(tr, PROP_SETTINGS);
        checkContains(tr, LOCALE_SETTINGS);
        checkContains(tr, AVAILABLE_LOCALES);
        checkNotContains(tr, LOCALE_SUMMARY_SETTINGS);
        checkContains(tr, TIMEZONE_SETTINGS);
        checkContains(tr, TZDATA_SETTINGS);
    }

    static void runTestOptionSecurity() throws IOException {
        TestResult tr = doExec(javaCmd, "-XshowSettings:security");
        checkNotContains(tr, VM_SETTINGS);
        checkNotContains(tr, PROP_SETTINGS);
        checkContains(tr, SEC_PROPS_SETTINGS);
        checkContains(tr, SEC_PROVIDER_SETTINGS);
        checkContains(tr, SEC_TLS_SETTINGS);
    }

    static void runTestOptionSecurityProps() throws IOException {
        TestResult tr = doExec(javaCmd, "-XshowSettings:security:properties");
        checkContains(tr, SEC_PROPS_SETTINGS);
        checkNotContains(tr, SEC_PROVIDER_SETTINGS);
        checkNotContains(tr, SEC_TLS_SETTINGS);
        // test a well known property for sanity
        checkContains(tr, "keystore.type=pkcs12");
    }

    static void runTestOptionSecurityProv() throws IOException {
        TestResult tr = doExec(javaCmd, "-XshowSettings:security:providers");
        checkNotContains(tr, SEC_PROPS_SETTINGS);
        checkContains(tr, SEC_PROVIDER_SETTINGS);
        checkNotContains(tr, SEC_TLS_SETTINGS);
        // test a well known Provider for sanity
        checkContains(tr, "Provider name: SUN");
        // test for a well known alias (SunJCE: AlgorithmParameterGenerator.DiffieHellman)
        checkContains(tr, "aliases: [1.2.840.113549.1.3.1, " +
                "DH, OID.1.2.840.113549.1.3.1]");
    }

    static void runTestOptionSecurityTLS() throws IOException {
        TestResult tr = doExec(javaCmd, "-XshowSettings:security:tls");
        checkNotContains(tr, SEC_PROPS_SETTINGS);
        checkNotContains(tr, SEC_PROVIDER_SETTINGS);
        checkContains(tr, SEC_TLS_SETTINGS);
        // test a well known TLS config for sanity
        checkContains(tr, "TLSv1.2");
    }

    // ensure error message is printed when unrecognized option used
    static void runTestOptionBadSecurityOption() throws IOException {
        TestResult tr = doExec(javaCmd, "-XshowSettings:security:bad");
        tr.checkNegative();
        checkContains(tr, BAD_SEC_OPTION_MSG);
        // we print all security settings in such scenario
        checkNotContains(tr, SEC_PROPS_SETTINGS);
        checkNotContains(tr, SEC_PROVIDER_SETTINGS);
        checkNotContains(tr, SEC_TLS_SETTINGS);
    }
    static void runTestOptionSystem() throws IOException {
        TestResult tr = doExec(javaCmd, "-XshowSettings:system");
        if (System.getProperty("os.name").contains("Linux")) {
            checkNotContains(tr, VM_SETTINGS);
            checkNotContains(tr, PROP_SETTINGS);
            checkNotContains(tr, LOCALE_SETTINGS);
            checkContains(tr, SYSTEM_SETTINGS);
        } else {
            // "system" should print a "No metrics available"
            // message on other OSes
            checkNotContains(tr, VM_SETTINGS);
            checkContains(tr, METRICS_NOT_AVAILABLE_MSG);
        }
    }

    static void runTestBadOptions() throws IOException {
        TestResult tr = doExec(javaCmd, "-XshowSettingsBadOption");
        tr.checkNegative();
        checkNotContains(tr, VM_SETTINGS);
        checkNotContains(tr, PROP_SETTINGS);
        checkNotContains(tr, LOCALE_SETTINGS);
        checkContains(tr, "Unrecognized option: -XshowSettingsBadOption");

        // no such component option
        tr = doExec(javaCmd, "-XshowSettings:BadOption");
        tr.checkNegative();
        checkNotContains(tr, VM_SETTINGS);
        checkNotContains(tr, PROP_SETTINGS);
        checkNotContains(tr, LOCALE_SETTINGS);
        checkContains(tr, ERR_MSG);

        // don't allow invalid sub options
        tr = doExec(javaCmd, "-XshowSettings:locale:bad");
        tr.checkNegative();
        checkContains(tr, ERR_MSG);

        // don't allow ":" as an option
        tr = doExec(javaCmd, "-XshowSettings:");
        tr.checkNegative();
        checkContains(tr, ERR_MSG);

        // case-sensitive test
        tr = doExec(javaCmd, "-XshowSettings:VM");
        tr.checkNegative();
        checkContains(tr, ERR_MSG);

        // exclude this enum value
        tr = doExec(javaCmd, "-XshowSettings:empty");
        tr.checkNegative();
        checkContains(tr, ERR_MSG);


    }

    static void runTest7123582() throws IOException {
        TestResult tr = doExec(javaCmd, "-XshowSettings", "-version");
        if (!tr.isOK()) {
            System.out.println(tr);
            throw new RuntimeException("test fails");
        }
        containsDefaultOptions(tr);
    }

    public static void main(String... args) throws IOException {
        runTestOptionAll();
        runTestOptionDefault();
        runTestOptionVM();
        runTestOptionProperty();
        runTestOptionLocale();
        runTestOptionSecurity();
        runTestOptionSecurityProps();
        runTestOptionSecurityProv();
        runTestOptionSecurityTLS();
        runTestOptionBadSecurityOption();
        runTestOptionSystem();
        runTestBadOptions();
        runTest7123582();
        if (testExitValue != 0) {
            throw new Error(testExitValue + " tests failed");
        }
    }
}