/*
 * Copyright 2021 Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.keycloak.it.cli.dist;

import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.keycloak.quarkus.runtime.cli.command.AbstractStartCommand.OPTIMIZED_BUILD_OPTION_LONG;
import static org.keycloak.quarkus.runtime.cli.command.Main.CONFIG_FILE_LONG_NAME;

import org.junit.jupiter.api.MethodOrderer;
import org.junit.jupiter.api.Order;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestMethodOrder;
import org.keycloak.it.junit5.extension.CLIResult;
import org.keycloak.it.junit5.extension.DistributionTest;
import org.keycloak.it.junit5.extension.DryRun;

import io.quarkus.test.junit.main.Launch;
import org.keycloak.it.junit5.extension.RawDistOnly;
import org.keycloak.it.junit5.extension.WithEnvVars;
import org.keycloak.it.utils.KeycloakDistribution;

@WithEnvVars({"KC_CACHE", "local"}) // avoid flakey port conflicts
@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
@DistributionTest
@Tag(DistributionTest.WIN)
public class StartCommandDistTest {

    @DryRun
    @Test
    @Launch({ "start", "--db=dev-file", "--hostname-strict=false" })
    void failNoTls(CLIResult cliResult) {
        assertTrue(cliResult.getErrorOutput().contains("Key material not provided to setup HTTPS"),
                () -> "The Output:\n" + cliResult.getErrorOutput() + "doesn't contains the expected string.");
    }

    @DryRun
    @Test
    @Launch({ "start", "--db=dev-file", "--spi-events-listener-jboss-logging-success-level" })
    void failSpiArgMissingValue(CLIResult cliResult) {
        assertTrue(cliResult.getErrorOutput().contains("spi argument --spi-events-listener-jboss-logging-success-level requires a value"),
                () -> "The Output:\n" + cliResult.getErrorOutput() + "doesn't contains the expected string.");
    }

    @DryRun
    @Test
    @Launch({ "build", "--db=dev-file", "--spi-events-listener-jboss-logging-success-level=debug" })
    void warnSpiRuntimeAtBuildtime(CLIResult cliResult) {
        assertTrue(cliResult.getOutput().contains("The following run time options were found, but will be ignored during build time: kc.spi-events-listener-jboss-logging-success-level"),
                () -> "The Output:\n" + cliResult.getOutput() + "doesn't contains the expected string.");
    }

    @DryRun
    @Test
    @RawDistOnly(reason = "Containers are immutable")
    void errorSpiBuildtimeAtRuntime(KeycloakDistribution dist) {
        CLIResult cliResult = dist.run("build",  "--db=dev-file");
        cliResult.assertBuild();

        cliResult = dist.run("start", "--optimized", "--http-enabled=true", "--hostname-strict=false", "--spi-events-listener-jboss-logging-enabled=false");
        cliResult.assertError("The following build time options have values that differ from what is persisted - the new values will NOT be used until another build is run: kc.spi-events-listener-jboss-logging-enabled");
    }

    @DryRun
    @WithEnvVars({"KC_SPI_EVENTS_LISTENER_JBOSS_LOGGING_ENABLED", "false"})
    @Test
    @RawDistOnly(reason = "Containers are immutable")
    void noErrorSpiBuildtimeNotChanged(KeycloakDistribution dist) {
        CLIResult cliResult = dist.run("build", "--db=dev-file");
        cliResult.assertBuild();

        cliResult = dist.run("start", "--optimized", "--http-enabled=true", "--hostname-strict=false");
        cliResult.assertNoError("The following build time options");
    }

    @DryRun
    @Test
    @Launch({ "--profile=dev", "start",  "--db=dev-file" })
    void failUsingDevProfile(CLIResult cliResult) {
        assertTrue(cliResult.getErrorOutput().contains("ERROR: You can not 'start' the server in development mode. Please re-build the server first, using 'kc.sh build' for the default production mode."),
                () -> "The Output:\n" + cliResult.getErrorOutput() + "doesn't contains the expected string.");
    }

    @Test
    @Launch({ "-v", "start", "--db=dev-file", "--http-enabled=true", "--hostname-strict=false" })
    void testHttpEnabled(CLIResult cliResult) {
        cliResult.assertStarted();
    }

    @DryRun
    @Test
    @Launch({ "-v", "start", "--db=dev-mem", OPTIMIZED_BUILD_OPTION_LONG})
    void failBuildPropertyNotAvailable(CLIResult cliResult) {
        cliResult.assertError("Build time option: '--db' not usable with pre-built image and --optimized");
    }

    @DryRun
    @Test
    @Launch({ "--profile=dev", "start", "--http-enabled=true", "--hostname-strict=false" })
    void failIfAutoBuildUsingDevProfile(CLIResult cliResult) {
        assertThat(cliResult.getErrorOutput(), containsString("You can not 'start' the server in development mode. Please re-build the server first, using 'kc.sh build' for the default production mode."));
        assertEquals(4, cliResult.getErrorStream().size());
    }

    @DryRun
    @WithEnvVars({"KC_HTTP_ENABLED", "true", "KC_HOSTNAME_STRICT", "false"})
    @Test
    @Launch({ "start", "--optimized" })
    @Order(1)
    void failIfOptimizedUsedForFirstFastStartup(CLIResult cliResult) {
        cliResult.assertError("The '--optimized' flag was used for first ever server start.");
    }

    @DryRun
    @Test
    @Launch({ "start", "--optimized", "--http-enabled=true", "--hostname-strict=false" })
    @Order(2)
    void failIfOptimizedUsedForFirstStartup(CLIResult cliResult) {
        cliResult.assertError("The '--optimized' flag was used for first ever server start.");
    }

    @Test
    @Launch({ "start", "--db=dev-file", "--http-enabled=true" })
    void failNoHostnameNotSet(CLIResult cliResult) {
        assertTrue(cliResult.getErrorOutput().contains("ERROR: hostname is not configured; either configure hostname, or set hostname-strict to false"),
                () -> "The Output:\n" + cliResult.getOutput() + "doesn't contains the expected string.");
    }

    @DryRun
    @Test
    @Launch({ "start", "--db=dev-file", "--http-enabled=true", "--hostname-strict=false", "--metrics-enabled=true" })
    void testStartUsingAutoBuild(CLIResult cliResult) {
        cliResult.assertNoMessage("ignored during build");
        cliResult.assertMessage("Changes detected in configuration. Updating the server image.");
        cliResult.assertMessage("Updating the configuration and installing your custom providers, if any. Please wait.");
        cliResult.assertMessage("Server configuration updated and persisted. Run the following command to review the configuration:");
        cliResult.assertMessage(KeycloakDistribution.SCRIPT_CMD + " show-config");
        cliResult.assertMessage("Next time you run the server, just run:");
        cliResult.assertMessage(KeycloakDistribution.SCRIPT_CMD + " start --http-enabled=true --hostname-strict=false " + OPTIMIZED_BUILD_OPTION_LONG);
        assertFalse(cliResult.getOutput().contains("--metrics-enabled"));
        assertTrue(cliResult.getErrorOutput().isBlank(), cliResult.getErrorOutput());
    }

    @DryRun
    @Test
    @Launch({ "start", "--optimized", "--http-enabled=true", "--hostname-strict=false", "--db=postgres" })
    void testStartUsingOptimizedDoesNotAllowBuildOptions(CLIResult cliResult) {
        cliResult.assertError("Build time option: '--db' not usable with pre-built image and --optimized");
    }

    @DryRun
    @Test
    @Launch({ "start", "--db=dev-file", "--http-enabled=true", "--cache-remote-host=localhost", "--hostname-strict=false", "--cache-remote-tls-enabled=false", "--transaction-xa-enabled=true" })
    void testStartNoWarningOnDisabledRuntimeOption(CLIResult cliResult) {
        cliResult.assertNoMessage("cache-remote-tls-enabled: Available only when remote host is set");
    }

    @DryRun
    @Test
    @WithEnvVars({"KC_LOG", "invalid"})
    @Launch({ "start", "--db=dev-file", "--http-enabled=false", "--hostname-strict=false" })
    void testStartUsingOptimizedInvalidEnvOption(CLIResult cliResult) {
        cliResult.assertError("Invalid value for option 'KC_LOG': invalid. Expected values are: console, file, syslog");
    }

    @DryRun
    @Test
    @RawDistOnly(reason = "Containers are immutable")
    void testWarningWhenOverridingBuildOptionsDuringStart(KeycloakDistribution dist) {
        CLIResult cliResult = dist.run("build", "--db=postgres", "--features=preview");
        cliResult.assertBuild();
        cliResult = dist.run("start", "--db=dev-file", "--hostname=localhost", "--http-enabled=true");
        cliResult.assertMessage("The previous optimized build will be overridden with the following build options:");
        cliResult.assertMessage("- db=postgres > db=dev-file"); // back to the default value
        cliResult.assertMessage("- features=preview > features=<unset>"); // no default value, the <unset> is shown
        cliResult.assertMessage("To avoid that, run the 'build' command again and then start the optimized server instance using the '--optimized' flag.");
        assertTrue(cliResult.getErrorOutput().isBlank());
        // should not show warning if the re-augmentation did not happen through the build command
        // an optimized server image should ideally be created by running a build
        cliResult = dist.run("start", "--db=dev-mem", "--hostname=localhost", "--http-enabled=true");
        cliResult.assertNoMessage("The previous optimized build will be overridden with the following build options:");
        assertTrue(cliResult.getErrorOutput().isBlank());
        dist.run("build", "--db=postgres");
        cliResult = dist.run("start", "--db=dev-file", "--hostname=localhost", "--http-enabled=true");
        cliResult.assertMessage("- db=postgres > db=dev-file");
        cliResult.assertNoMessage("- features=preview > features=<unset>");
        assertTrue(cliResult.getErrorOutput().isBlank());
        dist.run("build", "--db=postgres");
        cliResult = dist.run("start", "--db=dev-mem", "--hostname=localhost", "--http-enabled=true");
        cliResult.assertMessage("- db=postgres > db=dev-mem"); // option overridden during the start
        assertTrue(cliResult.getErrorOutput().isBlank());
        dist.run("build", "--db=dev-mem");
        cliResult = dist.run("start", "--db=dev-mem", "--hostname=localhost", "--http-enabled=true");
        cliResult.assertNoMessage("- db=postgres > db=postgres"); // option did not change not need to show
        assertTrue(cliResult.getErrorOutput().isBlank());
        dist.run("build", "--db=dev-mem");
        cliResult = dist.run("start", "--db=dev-mem", "--cache=local", "--hostname=localhost", "--http-enabled=true");
        cliResult.assertNoMessage("The previous optimized build will be overridden with the following build options:"); // no message, same values provided during auto-build
    }

    @DryRun
    @Test
    @RawDistOnly(reason = "Containers are immutable")
    void testStartAfterStartDev(KeycloakDistribution dist) {
        CLIResult cliResult = dist.run("start-dev");
        cliResult.assertStartedDevMode();

        cliResult = dist.run("start", "--db=dev-file", "--http-enabled", "true", "--hostname-strict", "false");
        cliResult.assertNotDevMode();
        assertTrue(cliResult.getErrorOutput().isBlank());
    }

    @DryRun
    @Test
    @RawDistOnly(reason = "Containers are immutable")
    void testErrorWhenOverridingNonCliBuildOptionsDuringStart(KeycloakDistribution dist) {
        CLIResult cliResult = dist.run("build", "--db=dev-file", "--features=preview");
        cliResult.assertBuild();
        dist.setEnvVar("KC_DB", "postgres");
        cliResult = dist.run("start", "--optimized", "--hostname=localhost", "--http-enabled=true");
        cliResult.assertError("The following build time options have values that differ from what is persisted - the new values will NOT be used until another build is run: kc.db");
    }

    @DryRun
    @Test
    @Launch({CONFIG_FILE_LONG_NAME + "=src/test/resources/non-existing.conf", "start", "--db=dev-file"})
    void testInvalidConfigFileOption(CLIResult cliResult) {
        cliResult.assertError("File specified via '--config-file' or '-cf' option does not exist.");
        cliResult.assertError(String.format("Try '%s --help' for more information on the available options.", KeycloakDistribution.SCRIPT_CMD));
    }

    @RawDistOnly(reason = "Containers are immutable")
    @Test
    void testRuntimeValuesAreNotCaptured(KeycloakDistribution dist) {
        // confirm that the invalid value prevents startup - if this passes, then we need to use a different
        // spi provider
        CLIResult cliResult = dist.run("start", "--db=dev-file", "--spi-events-listener-jboss-logging-success-level=invalid", "--http-enabled", "true", "--hostname-strict", "false");
        cliResult.assertError("Failed to start quarkus");

        // if there was no auto-build use an explicit build to potentially capture the runtime default
        if (!cliResult.getOutput().contains("Server configuration updated and persisted")) {
            cliResult = dist.run("build", "--db=dev-file", "--spi-events-listener-jboss-logging-success-level=invalid");
            cliResult.assertBuild();
        }

        // the invalid value should not be the default
        cliResult = dist.run("start", "--db=dev-file", "--http-enabled", "true", "--hostname-strict", "false");
        cliResult.assertNoBuild();
        cliResult.assertStarted();
    }
}
