1 /*
   2  * Copyright (c) 2015, 2019, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 import jdk.test.lib.process.ProcessTools;
  25 import jdk.test.lib.process.OutputAnalyzer;
  26 import jdk.test.lib.cli.*;
  27 
  28 /*
  29  * @test
  30  * @bug 8066821
  31  * @summary Test that various options are deprecated. See deprecated_jvm_flags in arguments.cpp.
  32  * @modules java.base/jdk.internal.misc
  33  * @library /test/lib
  34  */
  35 public class VMDeprecatedOptions {
  36 
  37     /**
  38      * each entry is {[0]: option name, [1]: value to set
  39      * (true/false/n/string)}.
  40      */
  41     public static final String[][] DEPRECATED_OPTIONS = {
  42         // deprecated non-alias flags:
  43         {"MaxGCMinorPauseMillis",     "1032"},
  44         {"MaxRAMFraction",            "8"},
  45         {"MinRAMFraction",            "2"},
  46         {"InitialRAMFraction",        "64"},
  47         {"TLABStats",                 "false"},
  48         {"AllowRedefinitionToAddDeleteMethods", "true"},
  49         {"CompactFields", "true"},
  50         {"FieldsAllocationStyle", "1"},
  51 
  52         // deprecated alias flags (see also aliased_jvm_flags):
  53         {"DefaultMaxRAMFraction", "4"},
  54         {"CreateMinidumpOnCrash", "false"}
  55     };
  56 
  57     static String getDeprecationString(String optionName) {
  58         return "Option " + optionName
  59             + " was deprecated in version [\\S]+ and will likely be removed in a future release";
  60     }
  61 
  62     static void testDeprecated(String[][] optionInfo) throws Throwable {
  63         String optionNames[] = new String[optionInfo.length];
  64         String expectedValues[] = new String[optionInfo.length];
  65         for (int i = 0; i < optionInfo.length; i++) {
  66             optionNames[i] = optionInfo[i][0];
  67             expectedValues[i] = optionInfo[i][1];
  68         }
  69 
  70         OutputAnalyzer output = CommandLineOptionTest.startVMWithOptions(optionNames, expectedValues);
  71 
  72         // check for option deprecation messages:
  73         output.shouldHaveExitValue(0);
  74         for (String[] deprecated : optionInfo) {
  75             String match = getDeprecationString(deprecated[0]);
  76             output.shouldMatch(match);
  77         }
  78     }
  79 
  80     // Deprecated diagnostic command line options need to be preceded on the
  81     // command line by -XX:+UnlockDiagnosticVMOptions.
  82     static void testDeprecatedDiagnostic(String option, String value)  throws Throwable {
  83         String XXoption = CommandLineOptionTest.prepareFlag(option, value);
  84         ProcessBuilder processBuilder = ProcessTools.createJavaProcessBuilder(
  85             CommandLineOptionTest.UNLOCK_DIAGNOSTIC_VM_OPTIONS, XXoption, "-version");
  86         OutputAnalyzer output = new OutputAnalyzer(processBuilder.start());
  87         // check for option deprecation message:
  88         output.shouldHaveExitValue(0);
  89         String match = getDeprecationString(option);
  90         output.shouldMatch(match);
  91     }
  92 
  93     // Deprecated experimental command line options need to be preceded on the
  94     // command line by -XX:+UnlockExperimentalVMOption.
  95     static void testDeprecatedExperimental(String option, String value)  throws Throwable {
  96         String XXoption = CommandLineOptionTest.prepareFlag(option, value);
  97         ProcessBuilder processBuilder = ProcessTools.createJavaProcessBuilder(
  98             CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS, XXoption, "-version");
  99         OutputAnalyzer output = new OutputAnalyzer(processBuilder.start());
 100         // check for option deprecation message:
 101         output.shouldHaveExitValue(0);
 102         String match = getDeprecationString(option);
 103         output.shouldMatch(match);
 104     }
 105 
 106     public static void main(String[] args) throws Throwable {
 107         testDeprecated(DEPRECATED_OPTIONS);  // Make sure that each deprecated option is mentioned in the output.
 108     }
 109 }