/*

 * Copyright (c) 2017, 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

 * @summary Test JVM's memory resource awareness when running inside docker container

 * @requires docker.support

 * @library /test/lib

 * @modules java.base/jdk.internal.misc

 *          java.management

 *          jdk.jartool/sun.tools.jar

 * @build Common AttemptOOM sun.hotspot.WhiteBox PrintContainerInfo

 * @run driver ClassFileInstaller -jar whitebox.jar sun.hotspot.WhiteBox sun.hotspot.WhiteBox$WhiteBoxPermission

 * @run driver TestMemoryAwareness

 */

import jdk.test.lib.containers.docker.DockerRunOptions;

import jdk.test.lib.containers.docker.DockerTestUtils;

public class TestMemoryAwareness {

    private static final String imageName = Common.imageName("memory");

    public static void main(String[] args) throws Exception {

        if (!DockerTestUtils.canTestDocker()) {

            return;

        }

        Common.prepareWhiteBox();

        DockerTestUtils.buildJdkDockerImage(imageName, "Dockerfile-BasicTest", "jdk-docker");

        try {

            testMemoryLimit("100m", "104857600");

            testMemoryLimit("500m", "524288000");

            testMemoryLimit("1g", "1073741824");

            testMemoryLimit("4g", "4294967296");

            testMemorySoftLimit("500m", "524288000");

            testMemorySoftLimit("1g", "1073741824");

            // Add extra 10 Mb to allocator limit, to be sure to cause OOM

            testOOM("256m", 256 + 10);

        } finally {

            DockerTestUtils.removeDockerImage(imageName);

        }

    }

    private static void testMemoryLimit(String valueToSet, String expectedTraceValue)

            throws Exception {

        Common.logNewTestCase("memory limit: " + valueToSet);

        DockerRunOptions opts = Common.newOpts(imageName)

            .addDockerOpts("--memory", valueToSet);

        Common.run(opts)

            .shouldMatch("Memory Limit is:.*" + expectedTraceValue);

    }

    private static void testMemorySoftLimit(String valueToSet, String expectedTraceValue)

            throws Exception {

        Common.logNewTestCase("memory soft limit: " + valueToSet);

        DockerRunOptions opts = Common.newOpts(imageName, "PrintContainerInfo");

        Common.addWhiteBoxOpts(opts);

        opts.addDockerOpts("--memory-reservation=" + valueToSet);

        Common.run(opts)

            .shouldMatch("Memory Soft Limit.*" + expectedTraceValue);

    }

    // provoke OOM inside the container, see how VM reacts

    private static void testOOM(String dockerMemLimit, int sizeToAllocInMb) throws Exception {

        Common.logNewTestCase("OOM");

        DockerRunOptions opts = Common.newOpts(imageName, "AttemptOOM")

            .addDockerOpts("--memory", dockerMemLimit, "--memory-swap", dockerMemLimit);

        opts.classParams.add("" + sizeToAllocInMb);

        DockerTestUtils.dockerRunJava(opts)

            .shouldHaveExitValue(1)

            .shouldContain("Entering AttemptOOM main")

            .shouldNotContain("AttemptOOM allocation successful")

            .shouldContain("java.lang.OutOfMemoryError");

    }

}