Integration Testing

CoCache runs integration tests that verify the full stack against a real Redis instance. These tests validate distributed cache operations, pub/sub event propagation, and Spring Boot auto-configuration end-to-end.

CI Pipeline Architecture

The integration tests run in GitHub Actions with separate jobs for unit and integration tests. Redis-dependent modules use a Redis service container.

mermaid

graph TB
    subgraph sg_85 ["Integration Test Workflow"]
        direction TB
        CoreJob["cocache-core-test<br>No Redis needed"]
        SpringJob["cocache-spring-test<br>No Redis needed"]
        RedisJob["cocache-spring-redis-test<br>Redis service container"]
        StarterJob["cocache-spring-boot-starter-test<br>Redis service container"]
    end

    subgraph sg_86 ["Redis Service"]
        direction TB
        Redis["redis:latest<br>port 6379"]
    end

    CoreJob -->|"depends"| RedisJob
    CoreJob -->|"depends"| StarterJob
    Redis --> RedisJob
    Redis --> StarterJob

    style CoreJob fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style SpringJob fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style RedisJob fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style StarterJob fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style Redis fill:#2d333b,stroke:#6d5dfc,color:#e6edf3

GitHub Actions Workflow

The integration test workflow is defined in .github/workflows/integration-test.yml and runs on every pull request.

Job 1: cocache-core-test

Runs core unit tests without Redis:

yaml

cocache-core-test:
  name: CoCache Core Test
  runs-on: ubuntu-latest
  steps:
    - uses: actions/checkout@master
    - uses: actions/setup-java@v5
      with:
        java-version: '17'
        distribution: 'temurin'
    - run: ./gradlew cocache-core:clean cocache-core:check

Job 2: cocache-spring-test

Runs Spring integration tests without Redis:

yaml

cocache-spring-test:
  name: CoCache Spring Test
  runs-on: ubuntu-latest
  steps:
    - uses: actions/checkout@master
    - uses: actions/setup-java@v5
      with:
        java-version: '17'
        distribution: 'temurin'
    - run: ./gradlew cocache-spring:clean cocache-spring:check

Job 3: cocache-spring-redis-test

Runs Redis integration tests with a service container:

yaml

cocache-spring-redis-test:
  name: CoCache Spring Redis Test
  needs: [cocache-core-test]
  runs-on: ubuntu-latest
  services:
    redis:
      image: redis
      options: >-
        --health-cmd "redis-cli ping"
        --health-interval 10s
        --health-timeout 5s
        --health-retries 5
      ports:
        - 6379:6379
  steps:
    - uses: actions/checkout@master
    - uses: actions/setup-java@v5
      with:
        java-version: '17'
        distribution: 'temurin'
    - run: ./gradlew cocache-spring-redis:clean cocache-spring-redis:check

Job 4: cocache-spring-boot-starter-test

Runs Spring Boot auto-configuration integration tests:

yaml

cocache-spring-boot-starter-test:
  name: CoCache Spring Boot Starter Test
  needs: [cocache-core-test]
  runs-on: ubuntu-latest
  services:
    redis:
      image: redis
      options: >-
        --health-cmd "redis-cli ping"
        --health-interval 10s
        --health-timeout 5s
        --health-retries 5
      ports:
        - 6379:6379
  steps:
    - uses: actions/checkout@master
    - uses: actions/setup-java@v5
      with:
        java-version: '17'
        distribution: 'temurin'
    - run: ./gradlew cocache-spring-boot-starter:clean cocache-spring-boot-starter:check

Source: .github/workflows/integration-test.yml

Redis Service Container

The Redis service container configuration includes health checks to ensure Redis is ready before tests run:

mermaid

sequenceDiagram
autonumber
    participant GH as GitHub Actions
    participant Redis as Redis Container
    participant Health as Health Check
    participant Test as Gradle Test

    GH->>Redis: Start redis:latest image
    GH->>Redis: Expose port 6379
    loop Health check
        Health->>Redis: redis-cli ping
        Redis-->>Health: PONG
    end
    Note over Redis: Health check passes<br>(5 retries, 10s interval)
    GH->>Test: Run ./gradlew check
    Test->>Redis: Connect to localhost:6379
    Test->>Test: Execute integration tests

Key health check parameters:

Parameter	Value	Purpose
`--health-cmd`	`redis-cli ping`	Command to verify Redis is responsive
`--health-interval`	`10s`	Time between health check attempts
`--health-timeout`	`5s`	Maximum wait for a single health check
`--health-retries`	`5`	Number of failures before marking unhealthy

Integration Test Modules

cocache-spring-redis

Tests the Redis distributed cache implementation, including:

RedisDistributedCache operations (get, set, evict, TTL)
RedisCacheEvictedEventBus pub/sub functionality
Multi-instance synchronization via Redis pub/sub

mermaid

graph TB
    subgraph sg_87 ["cocache-spring-redis Tests"]
        direction TB
        RedisDC["RedisDistributedCache<br>DistributedCacheSpec"]
        RedisEB["RedisCacheEvictedEventBus<br>CacheEvictedEventBusSpec"]
        RedisSync["RedisMultipleInstanceSync<br>MultipleInstanceSyncSpec"]
    end

    subgraph sg_88 ["Real Redis"]
        direction TB
        Redis["localhost:6379"]
    end

    RedisDC --> Redis
    RedisEB --> Redis
    RedisSync --> Redis

    style RedisDC fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style RedisEB fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style RedisSync fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style Redis fill:#2d333b,stroke:#6d5dfc,color:#e6edf3

cocache-spring-boot-starter

Tests the auto-configuration end-to-end:

CoCacheAutoConfiguration bean creation
@EnableCoCache proxy generation
Spring Cache integration via CoCacheManager
Custom bean override behavior
CosID integration (when available)

mermaid

graph TB
    subgraph sg_89 ["cocache-spring-boot-starter Tests"]
        direction TB
        AutoConf["CoCacheAutoConfiguration<br>Bean registration"]
        ProxyTest["Proxy generation<br>@EnableCoCache"]
        CacheMgr["CoCacheManager<br>Spring Cache bridge"]
        BeanOverride["Custom bean overrides<br>ClientSideCache, CacheSource"]
    end

    subgraph sg_90 ["Spring Boot Test Context"]
        direction TB
        Context["ApplicationContext"]
        Redis["Redis Connection"]
    end

    AutoConf --> Context
    ProxyTest --> Context
    CacheMgr --> Context
    BeanOverride --> Context
    Context --> Redis

    style AutoConf fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style ProxyTest fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style CacheMgr fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style BeanOverride fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style Context fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style Redis fill:#2d333b,stroke:#6d5dfc,color:#e6edf3

Running Integration Tests Locally

Prerequisites

A running Redis instance is required. The simplest approach:

bash

# Using Docker
docker run -d --name cocache-redis -p 6379:6379 redis:latest

# Verify
redis-cli ping
# Expected: PONG

Run Integration Tests

bash

# Redis integration tests
./gradlew :cocache-spring-redis:check

# Spring Boot starter integration tests
./gradlew :cocache-spring-boot-starter:check

# All integration tests
./gradlew :cocache-spring-redis:check :cocache-spring-boot-starter:check

Cleanup

bash

docker stop cocache-redis && docker rm cocache-redis

CI Job Dependency Graph

mermaid

graph LR
    subgraph sg_91 ["No Redis"]
        A["cocache-core-test"]
        B["cocache-spring-test"]
    end

    subgraph sg_92 ["With Redis"]
        C["cocache-spring-redis-test"]
        D["cocache-spring-boot-starter-test"]
    end

    A -->|"needs"| C
    A -->|"needs"| D

    style A fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style B fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style C fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style D fill:#2d333b,stroke:#6d5dfc,color:#e6edf3

Note that cocache-spring-test runs independently (no Redis dependency and no downstream dependents). The cocache-spring-redis-test and cocache-spring-boot-starter-test both depend on cocache-core-test passing first.

Example Application Integration

The cocache-example module demonstrates a complete Spring Boot application with CoCache:

kotlin

@EnableCoCache(caches = [
    UserCache::class,
    UserExtendInfoCache::class,
    UserExtendInfoJoinCache::class
])
@EnableCaching
@SpringBootApplication
class AppServer

Source: cocache-example/.../AppServer.kt

The example includes:

Component	Description	Source
`UserCache`	Basic cache with `@CoCache` + `@GuavaCache`	UserCache.kt
`UserExtendInfoCache`	Extended user info cache	UserExtendInfoCache.kt
`UserExtendInfoJoinCache`	JoinCache composing two caches	UserExtendInfoJoinCache.kt
`TestController`	REST API using cache	TestController.kt
`UserCacheConfiguration`	Custom ClientSideCache and CacheSource beans	UserCacheConfiguration.kt
`ClassDefinedCacheConfiguration`	Programmatic CoherentCache creation	ClassDefinedCacheConfiguration.kt

Testing Overview -- TCK test specifications and architecture
Unit Testing -- Using TCK base classes for unit tests
Performance Patterns -- Concurrency and cache protection patterns
Quick Start Guide -- Setting up a CoCache application

Integration Testing ​

CI Pipeline Architecture ​

GitHub Actions Workflow ​

Job 1: cocache-core-test ​

Job 2: cocache-spring-test ​

Job 3: cocache-spring-redis-test ​

Job 4: cocache-spring-boot-starter-test ​

Redis Service Container ​

Integration Test Modules ​

cocache-spring-redis ​

cocache-spring-boot-starter ​

Running Integration Tests Locally ​

Prerequisites ​

Run Integration Tests ​

Cleanup ​

CI Job Dependency Graph ​

Example Application Integration ​

Related Pages ​

Integration Testing

CI Pipeline Architecture

GitHub Actions Workflow

Job 1: cocache-core-test

Job 2: cocache-spring-test

Job 3: cocache-spring-redis-test

Job 4: cocache-spring-boot-starter-test

Redis Service Container

Integration Test Modules

cocache-spring-redis

cocache-spring-boot-starter

Running Integration Tests Locally

Prerequisites

Run Integration Tests

Cleanup

CI Job Dependency Graph

Example Application Integration

Related Pages