env

Java library for a microservice environment emulation.

Idea is to be agnostic to tools used for specific external system emulation (e.g. docker, remote server, java standalone app or process). It enables to build up mixed environment.

How to use

1. Add needed dependencies:

testImplementation "io.github.adven27:env-db-postgresql:<version>"
testImplementation "io.github.adven27:env-db-mssql:<version>"
testImplementation "io.github.adven27:env-db-mysql:<version>"
testImplementation "io.github.adven27:env-db-oracle:<version>"
testImplementation "io.github.adven27:env-db-oracle-temp:<version>"
testImplementation "io.github.adven27:env-db-db2:<version>"

testImplementation "io.github.adven27:env-redis:<version>"

testImplementation "io.github.adven27:env-mq-rabbit:<version>"
testImplementation "io.github.adven27:env-mq-ibmmq:<version>"
testImplementation "io.github.adven27:env-mq-kafka:<version>"
testImplementation "io.github.adven27:env-mq-kafka-embedded:<version>"

testImplementation "io.github.adven27:env-wiremock:<version>"
testImplementation "io.github.adven27:env-grpc-mock:<version>"

testImplementation "io.github.adven27:env-jar-application:<version>"

2. Set up systems:

class SomeEnvironment : Environment(
    "DB" to PostgreSqlContainerSystem(),
    "KAFKA" to EmbeddedKafkaSystem("some.topic", "another.topic"),
    "RATES_API" to WiremockSystem(
        helpers = mapOf(
            "rateOf" to Helper { c, _ -> mapOf("USD" to 10, "RUB" to 100, "JPY" to 0.1, "CNY" to 0.01)[c.toString()] },
        ),
        afterStart = {
            stubFor(
                get(urlPathEqualTo("/rates"))
                    .withQueryParam("baseCurrency", equalTo("EUR"))
                    .withQueryParam("quoteCurrencies", notMatching("^\$"))
                    .willReturn(
                        okJson(
                            """
                            {
                            "baseCurrency": "EUR",
                            "rates": {
                                {{#each request.query.quoteCurrencies as |cur|}}
                                  "{{cur}}" : {{#if (rateOf cur)}} {{rateOf cur}} {{else}} null {{/if}} {{#unless @last}},{{/unless}}
                                {{/each}}
                                }
                            }
                            """.trimIndent()
                        )
                    )
            )
        }
    )
) {
    fun database() = env<PostgreSqlContainerSystem>().config
    fun kafka() = env<EmbeddedKafkaSystem>().config.bootstrapServers
    fun api() = env<WiremockSystem>()
}

3. Use in tests:

class MyTestClass {
    companion object {
        private val ENV: SomeEnvironment = SomeEnvironment()

        @BeforeClass @JvmStatic
        fun setup() {
           ENV.up()
        }

        @AfterClass @JvmStatic
        fun teardown() {
           ENV.down()
        }
    }

    @Test fun testSomething() {
        //some interactions with environment
        ENV.api().client.resetRequests()
        //some test
        ...
    }
}

Run as standalone process

Environment class implementation could be run as standalone java application with io.github.adven27.env.core.EnvStarter

For example as gradle task:

task runEnv(type: JavaExec) {
    group = "Execution"
    description = "Run some environment"
    classpath = sourceSets.test.runtimeClasspath
    main = "io.github.adven27.env.core.EnvStarter"

    args 'SomeEnvironment'
    systemProperty 'SPECS_ENV_START', true
    systemProperty 'SPECS_ENV_FIXED', true
    standardInput = System.in
}

Examples

For more info see demo project