https://github.com/Trendyol/stove
Stove: The easiest way of writing e2e/component tests for your JVM back-end API with Kotlin
https://github.com/Trendyol/stove
component-testing e2e-testing integration-testing kotlin ktor spring-boot test test-automation testcontainers testing testing-framework testing-tools
Last synced: 3 months ago
JSON representation
Stove: The easiest way of writing e2e/component tests for your JVM back-end API with Kotlin
- Host: GitHub
- URL: https://github.com/Trendyol/stove
- Owner: Trendyol
- License: apache-2.0
- Created: 2023-01-18T13:03:34.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T08:22:27.000Z (about 1 year ago)
- Last Synced: 2024-10-29T09:43:02.794Z (about 1 year ago)
- Topics: component-testing, e2e-testing, integration-testing, kotlin, ktor, spring-boot, test, test-automation, testcontainers, testing, testing-framework, testing-tools
- Language: Kotlin
- Homepage: https://trendyol.github.io/stove/
- Size: 7.24 MB
- Stars: 165
- Watchers: 14
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-java - Stove
- awesome-github-repos - Trendyol/stove - Stove: The easiest way of writing e2e/component tests for your JVM back-end app with Kotlin (Kotlin)
README
Stove
❝Where the infrastructure burns down to pure configurations(ashes)❞
 [
](https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/com/trendyol/) [](https://codecov.io/gh/Trendyol/stove) [](https://scorecard.dev/viewer/?uri=github.com/Trendyol/stove)
# What is Stove?
Stove is an end-to-end testing framework that simplifies testing by managing physical dependencies and your
application in a unified way.
Write infrastructure-agnostic but component-aware tests in Kotlin, regardless of your JVM-based tech stack.
### Key Features
* 🚀 Zero Boilerplate: Write clean, focused tests without infrastructure setup code
* 🔌 Pluggable Architecture: Easily extend with custom infrastructure components
* 🐳 Docker-Based: Leverages Testcontainers for reliable, isolated test environments
* 🌐 Framework Agnostic: Works with Spring, Ktor, Micronaut and other JVM frameworks _(up for grabs)_
* 🔄 Physical Dependencies: Built-in support for Kafka, Couchbase, PostgreSQL, and more
* ⚡ Fast Development: On top of the boilerplate free testing, optional Reuse test containers for blazing-fast local
development
## Supported Infrastructure
Physical dependencies:
* ✅ Kafka
* ✅ Couchbase
* ✅ PostgreSQL
* ✅ ElasticSearch
* ✅ MongoDB
* ✅ MSSQL
* ✅ Redis
* ✅ HTTP Client
* ✅ WireMock
Frameworks:
* ✅ Spring
* ✅ Ktor
* ✅ Micronaut
* ✅ [Quarkus](https://github.com/Trendyol/stove/tree/main/recipes/java-recipes/quarkus-recipe) (incubating)
## Quick Start
As of 5th June 2025, Stove's snapshot packages are hosted on [Central Sonatype](https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/com/trendyol/)
```kotlin
repositories {
maven("https://central.sonatype.com/repository/maven-snapshots")
}
```
For more info about how to use snapshots on the [central sonatype's docs.](https://central.sonatype.org/publish/publish-portal-snapshots/#consuming-snapshot-releases-for-your-project)
### Add the dependency
```kotlin
// Add the following dependencies to your build.gradle.kts
testImplementation("com.trendyol:stove-testing-e2e:${version}")
// And the any of the following for the infrastructure you want to use, for example Kafka
// you can also use Couchbase, PostgreSQL, ElasticSearch, MongoDB, MSSQL, Redis, HTTP Client, WireMock
// as much as you want
testImplementation("com.trendyol:stove-testing-e2e-kafka:${version}")
// And Application Under Test (AUT)
testImplementation("com.trendyol:stove-ktor-testing-e2e:${version}")
// Or
testImplementation("com.trendyol:stove-spring-testing-e2e:${version}")
```
### Set Up the TestSystem
```kotlin
TestSystem() {
if (isRunningLocally()) {
enableReuseForTestContainers()
// this will keep the dependencies running
// after the tests are finished,
// so next run will be blazing fast :)
keepDendenciesRunning()
}
}.with {
// Enables http client
// to make real http calls
// against the application under test
httpClient {
HttpClientSystemOptions(
baseUrl = "http://localhost:8001",
)
}
// Enables Couchbase physically
// and exposes the configuration
// to the application under test
couchbase {
CouchbaseSystemOptions(
defaultBucket = "Stove",
configureExposedConfiguration = { cfg -> listOf("couchbase.hosts=${cfg.hostsWithPort}") },
)
}
// Enables Kafka physically
// and exposes the configuration
// to the application under test
kafka {
KafkaSystemOptions(
configureExposedConfiguration = { cfg -> listOf("kafka.bootstrapServers=${cfg.boostrapServers}") },
)
}
// Enables Wiremock on the given port
// and provides configurable mock HTTP server
// for your external API calls
wiremock {
WireMockSystemOptions(
port = 9090,
removeStubAfterRequestMatched = true,
afterRequest = { e, _, _ ->
logger.info(e.request.toString())
},
)
}
// The Application Under Test.
// Enables Spring Boot application
// to be run with the given parameters.
springBoot(
runner = { parameters ->
stove.spring.example.run(parameters) { it.addTestSystemDependencies() }
},
withParameters = listOf(
"server.port=8001",
"logging.level.root=warn",
"logging.level.org.springframework.web=warn",
"spring.profiles.active=default",
"kafka.heartbeatInSeconds=2",
),
)
}.run()
```
### Write Tests
```kotlin
TestSystem.validate {
wiremock {
mockGet("/example-url", responseBody = None, statusCode = 200)
}
http {
get("/hello/index") { actual ->
actual shouldContain "Hi from Stove framework"
println(actual)
}
}
couchbase {
shouldQuery("SELECT * FROM system:keyspaces") { actual ->
println(actual)
}
}
kafka {
shouldBePublished {
actual.aggregateId == 123
&& metadata.topic = "example-topic"
&& metadata.headers["example-header"] == "example-value"
}
shouldBeConsumed {
actual.aggregateId == 123
&& metadata.topic = "example-topic"
&& metadata.headers["example-header"] == "example-value"
}
}
couchbase {
save(collection = "Backlogs", id = "id-of-backlog", instance = Backlog("id-of-backlog"))
}
http {
postAndExpectBodilessResponse("/backlog/reserve") { actual ->
actual.status.shouldBe(200)
}
}
kafka {
shouldBeConsumed {
actual.aggregateId == expectedId
}
}
}
```
## Why Stove?
The JVM ecosystem lacks a unified approach to end-to-end testing.
While tools like Testcontainers exist, developers still need to:
* Write extensive boilerplate code
* Complex setup code for each tech stack
* Create different testing setups for each framework
* Manage complex infrastructure configurations for each framework
This affects teams across many tech stacks:
* Kotlin with Spring Boot/Ktor
* Java with Spring Boot/Micronaut/Quarkus
* Scala with Spring Boot
Stove solves these challenges by providing:
* A unified testing API across all JVM stacks
* Built-in support for common infrastructure
* Clean, Kotlin-based test syntax
* Reusable test containers for fast local development
**Stove unifies the testing experience across all JVM stacks, making it easier to write clean, focused tests.**
## Resources
* 📖 [Documentation](https://trendyol.github.io/stove/)
* [📹 Youtube Session about how to use](https://youtu.be/DJ0CI5cBanc?t=669) _(Turkish)_
* 📝 [Motivation Article](https://medium.com/trendyol-tech/a-new-approach-to-the-api-end-to-end-testing-in-kotlin-f743fd1901f5)
## Status
> [!WARNING]
> While Stove is production-ready and extensively used, the API is not yet fully stabilized. Breaking changes may
> occur in minor releases, but migration guides will always be provided.
## Contributing
Contributions are welcome! Whether it's:
* 🐛 [Bug reports](https://github.com/Trendyol/stove/issues)
* 💡 [Feature requests](https://github.com/Trendyol/stove/issues)
* 📖 Documentation improvements
* 🚀 Code contributions
## License
Stove is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text.