main.wisp.deployment.Deployment.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wisp-deployment Show documentation
a module containing deployment helpers
There is a newer version: 2024.11.22.172133-fe9b482
package wisp.deployment

import java.util.*

/** Deployment describes the context in which the application is running
 */
data class Deployment @JvmOverloads constructor(
    /**
     * The name of this deployment. This is used for debugging and should not be parsed.
     *
     * All pods in the same deployment will have this same name.
     */
    val name: String,

    /**
     * Whether the service is running in a production environment, having an SLA or handling customer data.
     */
    val isProduction: Boolean = false,

    /**
     * Whether the service is running in a staging environment.
     */
    val isStaging: Boolean = false,

    /**
     * Whether the service is running in a test environment, either locally or in a CI.
     */
    val isTest: Boolean = false,

    /**
     * Whether the service is running on a local developer machine, including as a Docker image.
     */
    val isLocalDevelopment: Boolean = false
) {
    init {
        when {
            isProduction -> check(!isStaging && !isTest && !isLocalDevelopment)
            isStaging -> check(!isProduction && !isTest && !isLocalDevelopment)
            isTest -> check(!isProduction && !isStaging && !isLocalDevelopment)
            isLocalDevelopment -> check(!isProduction && !isStaging && !isTest)
        }
    }

    /**
     * Returns true if running in a managed cluster, such as a staging or production cluster. Mutually exclusive with isFake.
     */
    val isReal: Boolean
        get() = !isFake

    /**
     * Returns true if running outside of a cluster (CI or local development). Mutually exclusive with isReal.
     */
    val isFake: Boolean
        get() = isTest || isLocalDevelopment

    fun mapToEnvironmentName() = when {
        isProduction -> "production"
        isStaging -> "staging"
        isTest -> "testing"
        else -> "development"
    }
}

val PRODUCTION = Deployment(
    "production",
    isProduction = true,
    isStaging = false,
    isTest = false,
    isLocalDevelopment = false
)

val STAGING = Deployment(
    "staging",
    isProduction = false,
    isStaging = true,
    isTest = false,
    isLocalDevelopment = false
)

val TESTING = Deployment(
    "testing",
    isProduction = false,
    isStaging = false,
    isTest = true,
    isLocalDevelopment = false
)

val DEVELOPMENT = Deployment(
    "development",
    isProduction = false,
    isStaging = false,
    isTest = false,
    isLocalDevelopment = true
)

val deployments = mapOf(
    "production" to PRODUCTION,
    "staging" to STAGING,
    "testing" to TESTING,
    "test" to TESTING,
    "development" to DEVELOPMENT,
    "dev" to DEVELOPMENT
)

/**
 * Determines a Deployment based on the value within the ENVIRONMENT variable, defaulting to
 * local development if not set (i.e. isLocalDevelopment == true)
 */
fun getDeploymentFromEnvironmentVariable(
    /** The default deployment if ENVIRONMENT is not set */
    defaultDeployment: Deployment = DEVELOPMENT,

    /** Environment Variable loader, use the real version if none supplied */
    environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real
): Deployment {
    val environment = environmentVariableLoader.getEnvironmentVariableOrDefault("ENVIRONMENT", "")
    return deployments[environment.lowercase(Locale.getDefault())] ?: defaultDeployment
}