Test Setup Guide

This guide explains how to set up the test environment for TrustWeave development.

Prerequisites

  • Java 21+: Required for compilation and runtime
  • Docker: Required for TestContainers (integration tests)
  • Gradle 8.5+: Automatically downloaded via Gradle Wrapper

Quick Setup

1. Install Docker

Ensure Docker is installed and running:

1
2

docker --version
docker ps

2. Run Tests 

1
2
3
4
5
6
7
8
9
10
11

# Run all tests
./gradlew test

# Run tests for a specific module
./gradlew :did:plugins:key:test

# Run only unit tests (skip integration tests)
./gradlew test -PskipIntegrationTests=true

# Run only integration tests
./gradlew test --tests "*IntegrationTest"

Test Environment Variables

Configure test behavior using environment variables:

1
2
3
4
5
6
7
8
9
10
11

# Use real services instead of mocks (requires credentials)
export VERICORE_TEST_USE_REAL_SERVICES=true

# Set test timeout (seconds)
export VERICORE_TEST_TIMEOUT_SECONDS=60

# Skip integration tests
export VERICORE_SKIP_INTEGRATION_TESTS=true

# Set log level
export VERICORE_TEST_LOG_LEVEL=DEBUG

TestContainers Setup

Integration tests use TestContainers for external services:

  • LocalStack: AWS services (KMS, S3)
  • HashiCorp Vault: Vault KMS testing
  • Ganache: Ethereum local node
  • PostgreSQL: Database wallet tests

TestContainers automatically downloads and manages containers.

Test Coverage

Generate coverage reports:

1
2
3
4
5
6
7
8

# Generate coverage report for all modules
./gradlew koverReport

# View coverage report
open build/reports/kover/index.html

# Check coverage thresholds
./gradlew koverVerify

Troubleshooting

Docker Issues

If TestContainers fails to start:

1
2
3
4
5
6

# Check Docker is running
docker ps

# Restart Docker daemon
# Linux/Mac: sudo systemctl restart docker
# Windows: Restart Docker Desktop

Port Conflicts

If ports are already in use:

1
2
3
4
5

# Check what's using the port
# Linux/Mac: lsof -i :4566
# Windows: netstat -ano | findstr :4566

# Kill the process or change TestContainer configuration

Memory Issues

Increase JVM memory for tests:

1
2

export GRADLE_OPTS="-Xmx4g -Xms1g"
./gradlew test

Next Steps