/*
 * Copyright (c) 2014, 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 com.oracle.java.testlibrary.*;
import com.oracle.java.testlibrary.cli.*;

/**
 * Test on bit manipulation related command line options,
 * that should be executed on CPU that supports all required
 * features.
 *
 * Note that this test intended to verify that VM could be launched with
 * specific options and that values of these options processed correctly.
 * In order to do that test launch a new VM with tested options, the same
 * flavor-specific flag as one that was used for parent VM (-client, -server,
 * -minimal, -graal) and '-version'.
 */
public class BMISupportedCPUTest extends BMICommandLineOptionTestBase {

    /**
     * Construct new test on {@code optionName} option.
     *
     * @param optionName Name of the option to be tested
     *                   without -XX:[+-] prefix.
     * @param warningMessage Message that can occur in VM output
     *                       if CPU on test box does not support
     *                       features required by the option.
     * @param cpuFeatures CPU features requires by the option.
     */
    public BMISupportedCPUTest(String optionName,
                               String warningMessage,
                               String... cpuFeatures) {
        super(optionName, warningMessage, cpuFeatures, null);
    }

    @Override
    public void runTestCases() throws Throwable {
        /*
          Verify that VM will successfully start up without warnings.
          VM will be launched with following flags:
          -XX:+<tested option> -version
        */
        String errorString = String.format("JVM should start with '-XX:+%s'"
                + " flag without any warnings", optionName);
        CommandLineOptionTest.verifySameJVMStartup(null,
                new String[] { warningMessage }, errorString, errorString,
                ExitCode.OK,
                CommandLineOptionTest.prepareBooleanFlag(optionName, true));

        /*
          Verify that VM will successfully start up without warnings.
          VM will be launched with following flags:
          -XX:-<tested option> -version
        */
        errorString = String.format("JVM should start with '-XX:-%s'"
                + " flag without any warnings", optionName);
        CommandLineOptionTest.verifySameJVMStartup(null,
                new String[] { warningMessage }, errorString,
                errorString, ExitCode.OK,
                CommandLineOptionTest.prepareBooleanFlag(optionName, false));

        /*
          Verify that on appropriate CPU option in on by default.
          VM will be launched with following flags:
          -version
        */
        CommandLineOptionTest.verifyOptionValueForSameVM(optionName, "true",
                String.format("Option '%s' is expected to have default value "
                    + "'true'", optionName));

        /*
          Verify that option could be explicitly turned off.
          VM will be launched with following flags:
          -XX:-<tested option> -version
        */
        CommandLineOptionTest.verifyOptionValueForSameVM(optionName, "false",
                String.format("Option '%s' is set to have value 'false'",
                    optionName),
                CommandLineOptionTest.prepareBooleanFlag(optionName, false));
    }
}