Simba

中文

English

中文

English

Appearance

测试概览 ​

Simba 的测试策略基于三层方法构建：使用 mock 的快速单元测试、使用真实基础设施的后端特定集成测试，以及强制所有三个后端（JDBC、Redis、Zookeeper）行为一致性的共享技术兼容性套件（TCK）。

测试策略 ​

下图展示了整体测试方法以及测试如何从核心抽象流向后端特定实现。

mermaid
flowchart TB
    subgraph core["Core Test Infrastructure"]
        style core fill:#161b22,stroke:#30363d,color:#e6edf3
        TCK["simba-test TCK<br>MutexContendServiceSpec"]
        LS["LockSpec"]
    end

    subgraph unit["Unit Tests"]
        style unit fill:#161b22,stroke:#30363d,color:#e6edf3
        UT1["ContendPeriod Tests"]
        UT2["MutexOwner Tests"]
        UT3["MutexState Tests"]
        UT4["AbstractScheduler<br>Mock Tests"]
    end

    subgraph integration["Integration Tests"]
        style integration fill:#161b22,stroke:#30363d,color:#e6edf3
        JDBC["JdbcMutexContend<br>ServiceTest<br>(MySQL required)"]
        REDIS["SpringRedisMutex<br>ContendServiceTest<br>(Redis required)"]
        ZK["ZookeeperMutex<br>ContendServiceTest<br>(Embedded Server)"]
    end

    subgraph tools["Quality Tools"]
        style tools fill:#161b22,stroke:#30363d,color:#e6edf3
        DET["Detekt 1.23.8"]
        JAC["JaCoCo Coverage"]
    end

    TCK --> JDBC
    TCK --> REDIS
    TCK --> ZK
    LS --> JDBC
    LS --> REDIS
    LS --> ZK
    DET --> core
    DET --> unit
    DET --> integration
    JAC --> core
    JAC --> integration

    style TCK fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style LS fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style UT1 fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style UT2 fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style UT3 fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style UT4 fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style JDBC fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style REDIS fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style ZK fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style DET fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style JAC fill:#2d333b,stroke:#6d5dfc,color:#e6edf3

测试金字塔 ​

Simba 遵循为分布式系统调整的标准测试金字塔：

层级数量速度基础设施用途
单元测试约 15 个测试每个 < 1 秒无验证值对象（MutexOwner、MutexState、ContendPeriod）和时序逻辑
TCK（共享）每个后端 5 个用例每个 5-30 秒按后端验证完整的竞争生命周期：start、restart、guard、multiContend、schedule
集成测试5 个用例 x 3 个后端每个 5-60 秒MySQL、Redis、ZK在真实基础设施上确认 TCK 合规性

5 个 TCK 测试用例 ​

每个后端都必须通过在 MutexContendServiceSpec 中定义的全部五个用例：

测试常量验证内容
start()START_MUTEX竞争者可以获取和释放所有权。获取时触发 onAcquired，停止时触发 onReleased。
restart()RESTART_MUTEX在 stop() + start() 之后，同一竞争者可以重新获取和重新释放。状态正确重置。
guard()GUARD_MUTEX获取后，所有者通过 TTL 续期继续持有锁（等待 3 秒，然后验证仍然持有所有权）。
multiContend()MULTI_CONTEND_MUTEX10 个竞争者竞争同一个互斥锁。任意时刻只有一个持有。AtomicInteger 计数器断言互斥：获取时 incrementAndGet() 必须等于 1，释放时 decrementAndGet() 必须等于 0。运行 30 秒。
schedule()SCHEDULE_MUTEX验证 AbstractScheduler 集成：调度器获取领导权，执行其 work() 回调，并响应 start()/stop() 生命周期。使用 CountDownLatch，超时 5 秒。

后端测试要求 ​

mermaid
flowchart LR
    subgraph requirements["Infrastructure Requirements"]
        style requirements fill:#161b22,stroke:#30363d,color:#e6edf3
        JDBC_REQ["JDBC/MySQL<br><br>Running MySQL 8.x<br>Port 3306, db: simba_db<br>Init script required"]
        REDIS_REQ["Redis<br><br>Running Redis 7.x+<br>Default port 6379<br>Standalone mode"]
        ZK_REQ["Zookeeper<br><br>No external infra<br>Uses Curator<br>TestingServer<br>(embedded)"]
    end

    style JDBC_REQ fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style REDIS_REQ fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style ZK_REQ fill:#2d333b,stroke:#6d5dfc,color:#e6edf3

JDBC/MySQL 后端 ​

前提条件：一个正在运行的 MySQL 实例。

连接默认值（来自 JdbcMutexContendServiceTest）：

jdbc:mysql://localhost:3306/simba_db
username: root
password: root

初始化：在首次测试执行前运行初始化脚本：

bash
mysql -u root -proot < simba-jdbc/src/init-script/init-simba-mysql.sql

测试类为 5 个互斥锁常量（start、restart、guard、multiContend、schedule）中的每一个调用 jdbcMutexOwnerRepository.tryInitMutex()。

配置：initialDelay=2s，ttl=2s，transition=5s。

Redis 后端 ​

前提条件：一个在 localhost:6379 上运行的 Redis 实例。

SpringRedisMutexContendServiceTest 中的测试类使用默认独立模式配置的 LettuceConnectionFactory。

配置：ttl=2s，transition=1s。

Redis 后端使用 Lua 脚本进行原子操作：

  • mutex_acquire.lua -- 尝试 SET NX PX，成功时发布 acquired 事件
  • mutex_guard.lua -- 为当前所有者续期 TTL
  • mutex_release.lua -- 如果调用者是所有者则释放锁

Zookeeper 后端 ​

不需要外部基础设施。 ZookeeperMutexContendServiceTest 中的测试类使用 Curator 的内嵌 TestingServer：

kotlin
testingServer = TestingServer()
testingServer.start()
curatorFramework = CuratorFrameworkFactory.newClient(
    testingServer.connectString, RetryNTimes(1, 10)
)
curatorFramework.start()

这使得 Zookeeper 模块在本地和 CI 中最容易运行，无需任何外部依赖。

运行测试 ​

所有模块 ​

bash
./gradlew check

单个后端模块 ​

bash
./gradlew simba-core:check            # 仅单元测试（不需要基础设施）
./gradlew simba-jdbc:check            # 需要 MySQL
./gradlew simba-spring-redis:check    # 需要 Redis
./gradlew simba-zookeeper:check       # 不需要外部基础设施

仅 TCK ​

TCK 基类位于 simba-test（发布为 me.ahoo.simba:simba-test）。它们本身不包含可执行的测试用例 -- 当后端模块扩展 MutexContendServiceSpec 时测试才会运行。

覆盖率和质量 ​

静态分析（Detekt） ​

Detekt 配置位于 config/detekt/detekt.yml。关键设置：

  • autoCorrect = true
  • 运行：./gradlew detekt

代码覆盖率（JaCoCo） ​

code-coverage-report 模块聚合来自所有子模块的 JaCoCo 报告：

bash
./gradlew codeCoverageReport

报告生成在 code-coverage-report/build/reports/jacoco/ 目录下。

mermaid
pie title Test Distribution by Backend
    "Zookeeper (embedded)" : 5
    "Redis (integration)" : 5
    "JDBC (integration)" : 5
    "Core (unit)" : 15

CI 集成 ​

在持续集成中，只有 Zookeeper 后端可以在没有服务容器的情况下运行。JDBC 和 Redis 后端需要以下之一：

  • 由 CI 运行器提供的 Docker Compose 服务
  • GitHub Actions 服务容器

典型的 CI 策略：

mermaid
sequenceDiagram
autonumber
    participant CI as CI Runner
    participant Gradle as Gradle
    participant ZK as Zookeeper Test
    participant MySQL as MySQL Container
    participant Redis as Redis Container

    CI->>MySQL: Start container
    CI->>Redis: Start container
    CI->>Gradle: ./gradlew check
    Gradle->>ZK: simba-zookeeper:check (embedded server)
    Gradle->>MySQL: simba-jdbc:check (connects to container)
    Gradle->>Redis: simba-spring-redis:check (connects to container)
    Gradle->>CI: Results
    CI->>Gradle: ./gradlew codeCoverageReport
    Gradle->>CI: Aggregated coverage

关键文件参考 ​

文件用途
simba-test/.../MutexContendServiceSpec.ktTCK 基类，包含 5 个强制测试用例
simba-test/.../LockSpec.kt锁测试的 TCK 基类
simba-jdbc/.../JdbcMutexContendServiceTest.ktJDBC 后端集成测试
simba-spring-redis/.../SpringRedisMutexContendServiceTest.ktRedis 后端集成测试
simba-zookeeper/.../ZookeeperMutexContendServiceTest.ktZookeeper 后端集成测试（内嵌）
simba-jdbc/src/init-script/init-simba-mysql.sqlMySQL 初始化脚本
config/detekt/detekt.ymlDetekt 静态分析配置

下一步 ​

  • 单元测试 -- 如何使用 MockK 和 JUnit 5 编写单元测试
  • 集成测试 -- 后端特定设置和 Docker Compose 示例
  • TCK 参考 -- MutexContendServiceSpec 的详细解析及其扩展方式

基于 Apache License 2.0 发布。

Copyright 2021-present Ahoo Wang