summary | Environment selector and validator for environments such as (local, dev, qa, stg, prod) ) |
jar | kiit.common.jar |
package | kiit.common.envs |
artifact | dev.kiit:kiit-common |
sources | src/common/common/src/main/kotlin/kiit/common/envs |
example | src/lib/kotlin/slate-examples/src/main/kotlin/slatekit/examples/Example_Env.kt |
dependency | kiit-results |
Use the following settings in gradle for installing this component.
buildscript {
// Kotlin version currently being used
ext.kotlin_version = '1.8.22'
// Reference version
ext.kiit_version = '3.1.0'
// ...
}
repositories {
// Currently stored in Git Hub Packages.
maven {
url "https://maven.pkg.github.com/slatekit/kiit"
credentials {
username = System.getenv('GIT_PACKAGES_INSTALL_ACTOR')
password = System.getenv('GIT_PACKAGES_INSTALL_TOKEN')
}
}
// ...
}
dependencies {
// Other dependencies ...
implementation "dev.kiit:kiit-common:$kiit_version"
}
// required
import kiit.common.envs.*
// optional
import kiit.results.Try
import kiit.results.Success
n/a
// CASE 1: Build a list of environments
val envs1 = Envs(listOf(
Env("loc", EnvMode.Dev , desc = "Dev environment (local)"),
Env("dev", EnvMode.Dev , desc = "Dev environment (dev)"),
Env("qat", EnvMode.Qat , desc = "QAT environment (test)"),
Env("stg", EnvMode.Uat , desc = "STG environment (demo)"),
Env("pro", EnvMode.Pro , desc = "LIVE environment")
))
// CASE 2: Use the default list of environments ( same as above )
val envs = slatekit.common.envs.Envs.defaults()
// CASE 3: Get one of the environments by api
val qa1 = envs.get("qa1")
println( qa1 )
// CASE 4: Validate one of the environments by api
println( envs.isValid("qa2") )
// CASE 5: Current environment ( nothing - none selected )
println( envs.current )
// CASE 6: Select an environment
val envs2 = envs.select("dev")
println( envs2 )
// CASE 7: Get info about currently selected environment
println( envs2.name )
println( envs2.isDev )
println( envs2.isQat )
println( envs2.isUat )
println( envs2.isPro )
println( envs2.current )