Stove 项目使用教程

Stove 项目使用教程

stove Stove: The easiest way of writing e2e tests for your JVM back-end API with Kotlin 项目地址: https://gitcode.com/gh_mirrors/stov/stove

1. 项目介绍

Stove 是一个用于为 JVM 后端 API 编写端到端（e2e）测试的 Kotlin 库。它旨在简化 e2e 测试的编写过程，支持多种物理依赖和框架，如 Kafka、Couchbase、Wiremock、PostgresSql、ElasticSearch、MongoDB、MSSQL、Redis 等。Stove 还支持 Spring、Ktor 和 Quarkus 等框架。

2. 项目快速启动

2.1 环境准备

在开始之前，请确保你已经安装了以下工具和环境：

• JDK 11 或更高版本
• Kotlin 编程语言
• Gradle 构建工具

2.2 项目克隆

首先，克隆 Stove 项目到本地：

git clone https://github.com/Trendyol/stove.git
cd stove

2.3 构建项目

使用 Gradle 构建项目：

./gradlew build

2.4 运行示例测试

进入示例目录并运行测试：

cd examples
./gradlew test

3. 应用案例和最佳实践

3.1 使用 Stove 进行端到端测试

以下是一个简单的示例，展示了如何使用 Stove 进行端到端测试：

import stove.TestSystem

fun main() {
    TestSystem {
        httpClient {
            baseUrl = "http://localhost:8001"
        }
        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()
}

3.2 最佳实践

• 模块化测试：将测试代码模块化，便于维护和扩展。
• 使用物理依赖：在测试中使用真实的物理依赖（如 Kafka、Couchbase 等），以确保测试的真实性和可靠性。
• 持续集成：将 Stove 测试集成到 CI/CD 流程中，确保每次代码提交都能自动进行端到端测试。

4. 典型生态项目

Stove 作为一个端到端测试框架，可以与以下生态项目结合使用：

• Spring Boot：用于构建和测试 Spring 应用程序。
• Ktor：用于构建和测试 Kotlin 异步 Web 应用程序。
• Quarkus：用于构建和测试云原生 Java 应用程序。
• Testcontainers：用于在测试中启动和管理 Docker 容器，提供真实的物理依赖环境。

通过结合这些生态项目，Stove 可以为 JVM 后端 API 提供全面的端到端测试解决方案。

stove Stove: The easiest way of writing e2e tests for your JVM back-end API with Kotlin 项目地址: https://gitcode.com/gh_mirrors/stov/stove