testing.md

Testing

Prerequisites

Docker is required to run the test suite. The tests use DynamoDB Local running in a Docker container.

Make Commands

The Makefile provides convenient commands for development:

Command	Description
make check	Run all checks: quality and coverage
make quality	Run quality checks: format, credo, hex-outdated, hex-audit, unused-deps
make coverage	Run tests with coverage and trace
make test	Start DynamoDB Local (if not running) and run the test suite
make test.watch	Start DynamoDB Local and run tests in watch mode (re-runs on file changes)
make compose	Start only the DynamoDB Local container
make format	Check code formatting
make credo	Run Credo static analysis
make hex-outdated	Check for outdated dependencies
make hex-audit	Audit dependencies for security vulnerabilities
make unused-deps	Check for unused dependencies

Running Specific Tests

You can pass arguments to filter which tests to run:

# Run a specific test file
make test test/read_test.exs

Docker Compose

The docker-compose.test.yml file defines the DynamoDB Local service:

• Image: amazon/dynamodb-local:latest
• Port: 8099 (mapped to container's 8000)
• Mode: In-memory with shared database (-sharedDb -inMemory)

The container is started automatically by the Make commands, but you can also manage it manually:

# Start the container
docker compose -f docker-compose.test.yml up -d

# Stop the container
docker compose -f docker-compose.test.yml down