1 /*
   2  * Copyright (c) 2015, 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.OutputAnalyzer;
  25 import jdk.test.lib.dcmd.CommandExecutor;
  26 import jdk.test.lib.dcmd.JMXExecutor;
  27 import org.testng.annotations.Test;
  28 import static org.testng.Assert.*;
  29 
  30 /*
  31  * @test
  32  * @bug 8054890
  33  * @summary Test of VM.set_flag diagnostic command
  34  * @modules java.base/jdk.internal.misc
  35  * @library /testlibrary
  36  * @build jdk.test.lib.*
  37  * @build jdk.test.lib.dcmd.*
  38  * @run testng SetVMFlagTest
  39  */
  40 
  41 public class SetVMFlagTest {
  42     private static final String MANAGEABLE_PATTERN = "\\s*bool\\s+(\\S+)\\s+[\\:]?=\\s+" +
  43                                                      "(.*?)\\s+\\{manageable\\}";
  44     private static final String IMMUTABLE_PATTERN = "\\s*uintx\\s+(\\S+)\\s+[\\:]?=\\s+" +
  45                                                     "(.*?)\\s+\\{product\\}";
  46 
  47     public void run(CommandExecutor executor) {
  48         setMutableFlag(executor);
  49         setMutableFlagWithInvalidValue(executor);
  50         setImmutableFlag(executor);
  51         setNonExistingFlag(executor);
  52     }
  53 
  54     @Test
  55     public void jmx() {
  56         run(new JMXExecutor());
  57     }
  58 
  59     private void setMutableFlag(CommandExecutor executor) {
  60         OutputAnalyzer out = getAllFlags(executor);
  61         String flagName = out.firstMatch(MANAGEABLE_PATTERN, 1);
  62         String flagVal = out.firstMatch(MANAGEABLE_PATTERN, 2);
  63 
  64         System.out.println("### Setting a mutable flag '" + flagName + "'");
  65 
  66         if (flagVal == null) {
  67             System.err.println(out.getOutput());
  68             throw new Error("Can not find a boolean manageable flag");
  69         }
  70 
  71         Boolean blnVal = Boolean.parseBoolean(flagVal);
  72 
  73         out = executor.execute("VM.set_flag " + flagName + " " + (blnVal ? 0 : 1));
  74         out.stderrShouldBeEmpty();
  75 
  76         out = getAllFlags(executor);
  77 
  78         String newFlagVal = out.firstMatch(MANAGEABLE_PATTERN.replace("(\\S+)", flagName), 1);
  79 
  80         assertNotEquals(newFlagVal, flagVal);
  81     }
  82 
  83     private void setMutableFlagWithInvalidValue(CommandExecutor executor) {
  84         OutputAnalyzer out = getAllFlags(executor);
  85         String flagName = out.firstMatch(MANAGEABLE_PATTERN, 1);
  86         String flagVal = out.firstMatch(MANAGEABLE_PATTERN, 2);
  87 
  88         System.out.println("### Setting a mutable flag '" + flagName + "' to an invalid value");
  89 
  90         if (flagVal == null) {
  91             System.err.println(out.getOutput());
  92             throw new Error("Can not find a boolean manageable flag");
  93         }
  94 
  95         // a boolean flag accepts only 0/1 as its value
  96         out = executor.execute("VM.set_flag " + flagName + " unexpected_value");
  97         out.stderrShouldBeEmpty();
  98         out.stdoutShouldContain("flag value must be a boolean (1/0 or true/false)");
  99 
 100         out = getAllFlags(executor);
 101 
 102         String newFlagVal = out.firstMatch(MANAGEABLE_PATTERN.replace("(\\S+)", flagName), 1);
 103 
 104         assertEquals(newFlagVal, flagVal);
 105     }
 106 
 107     private void setImmutableFlag(CommandExecutor executor) {
 108         OutputAnalyzer out = getAllFlags(executor);
 109         String flagName = out.firstMatch(IMMUTABLE_PATTERN, 1);
 110         String flagVal = out.firstMatch(IMMUTABLE_PATTERN, 2);
 111 
 112         System.out.println("### Setting an immutable flag '" + flagName + "'");
 113 
 114         if (flagVal == null) {
 115             System.err.println(out.getOutput());
 116             throw new Error("Can not find an immutable uintx flag");
 117         }
 118 
 119         Long numVal = Long.parseLong(flagVal);
 120 
 121         out = executor.execute("VM.set_flag " + flagName + " " + (numVal + 1));
 122         out.stderrShouldBeEmpty();
 123         out.stdoutShouldContain("only 'writeable' flags can be set");
 124 
 125         out = getAllFlags(executor);
 126 
 127         String newFlagVal = out.firstMatch(IMMUTABLE_PATTERN.replace("(\\S+)", flagName), 1);
 128 
 129         assertEquals(newFlagVal, flagVal);
 130     }
 131 
 132     private void setNonExistingFlag(CommandExecutor executor) {
 133         String unknownFlag = "ThisIsUnknownFlag";
 134         System.out.println("### Setting a non-existing flag '" + unknownFlag + "'");
 135         OutputAnalyzer out = executor.execute("VM.set_flag " + unknownFlag + " 1");
 136         out.stderrShouldBeEmpty();
 137         out.stdoutShouldContain("flag " + unknownFlag + " does not exist");
 138     }
 139 
 140     private OutputAnalyzer getAllFlags(CommandExecutor executor) {
 141         return executor.execute("VM.flags -all", true);
 142     }
 143 }