io.quarkiverse.quinoa.deployment.config.PackageManagerCommandConfig Maven / Gradle / Ivy

Go to download
package io.quarkiverse.quinoa.deployment.config;

import java.util.Map;
import java.util.Objects;
import java.util.Optional;

import io.quarkus.runtime.annotations.ConfigDocDefault;
import io.quarkus.runtime.annotations.ConfigGroup;
import io.smallrye.config.WithDefault;

@ConfigGroup
public interface PackageManagerCommandConfig {

    String DEFAULT_DEV_SCRIPT_NAME = "start";
    String DEFAULT_DEV_COMMAND = "run " + DEFAULT_DEV_SCRIPT_NAME;
    String DEFAULT_INSTALL_COMMAND = "install";
    String DEFAULT_BUILD_COMMAND = "run build";
    String DEFAULT_TEST_COMMAND = "run test";

    /**
     * Custom command for installing all packages.
     * e.g. «ci --cache $CACHE_DIR/.npm --prefer-offline»
     */
    @ConfigDocDefault(DEFAULT_INSTALL_COMMAND)
    Optional install();

    /**
     * Environment variables for install command execution.
     */
    Map installEnv();

    /**
     * Custom command for installing all the packages without generating a lockfile (frozen lockfile)
     * and failing if an update is needed (useful in CI).
     */
    @ConfigDocDefault("Detected based on package manager")
    Optional ci();

    /**
     * Environment variables for ci command execution.
     */
    Map ciEnv();

    /**
     * Custom command for building the application.
     */
    @WithDefault(DEFAULT_BUILD_COMMAND)
    Optional build();

    /**
     * Environment variables for build command execution.
     */
    Map buildEnv();

    /**
     * Custom command for running tests for the application.
     */
    @ConfigDocDefault(DEFAULT_TEST_COMMAND)
    Optional test();

    /**
     * Environment variables for test command execution.
     */
    @ConfigDocDefault("CI=true")
    Map testEnv();

    /**
     * Custom command for starting the application in development mode.
     */
    @ConfigDocDefault("framework detection with fallback to '" + DEFAULT_DEV_SCRIPT_NAME + "'")
    Optional dev();

    /**
     * Environment variables for development command execution.
     */
    Map devEnv();

    static boolean isEqual(PackageManagerCommandConfig p1, PackageManagerCommandConfig p2) {
        if (!Objects.equals(p1.install(), p2.install())) {
            return false;
        }
        if (!Objects.equals(p1.installEnv(), p2.installEnv())) {
            return false;
        }
        if (!Objects.equals(p1.ci(), p2.ci())) {
            return false;
        }
        if (!Objects.equals(p1.ciEnv(), p2.ciEnv())) {
            return false;
        }
        if (!Objects.equals(p1.buildEnv(), p2.buildEnv())) {
            return false;
        }
        if (!Objects.equals(p1.testEnv(), p2.testEnv())) {
            return false;
        }
        if (!Objects.equals(p1.dev(), p2.dev())) {
            return false;
        }
        if (!Objects.equals(p1.devEnv(), p2.devEnv())) {
            return false;
        }
        return true;
    }
}