Send and receive SMS messages using your Android phone programmatically via a simple HTTP API
test: replace PostgreSQL with CockroachDB in integration tests (#896)
Acho Arnold2bc05d05985d
diff --git a/.gitignore b/.gitignoreindex b7c1baed..0aa9dfff 100644--- a/.gitignore+++ b/.gitignore@@ -12,3 +12,5 @@ tests/emulator/emulator.exeSECURITY_AUDIT_REPORT.md*.exe++docs/diff --git a/tests/.env.test b/tests/.env.testindex 0e2b1a5c..5692e7fe 100644--- a/tests/.env.test+++ b/tests/.env.test@@ -8,8 +8,9 @@ EVENTS_QUEUE_ENDPOINT=http://localhost:8000/v1/eventsEVENTS_QUEUE_USER_API_KEY=system-user-api-keyEVENTS_QUEUE_USER_ID=system-user-idFCM_ENDPOINT=http://wiremock:8080-DATABASE_URL=postgresql://dbusername:dbpassword@postgres:5432/httpsms-DATABASE_URL_DEDICATED=postgresql://dbusername:dbpassword@postgres:5432/httpsms+DATABASE_URL=postgresql://root@cockroachdb:26257/httpsms?sslmode=disable+DATABASE_URL_DEDICATED=postgresql://root@cockroachdb:26257/httpsms?sslmode=disable+DATABASE_MIGRATION_CONSTRAINT_FIX=1REDIS_URL=redis://@redis:6379APP_PORT=8000APP_NAME=httpSMSdiff --git a/tests/README.md b/tests/README.mdindex c914982d..a37653e5 100644--- a/tests/README.md+++ b/tests/README.md@@ -20,21 +20,21 @@ End-to-end integration tests for the httpSMS API. These tests validate the compl└──────────────┘│┌──────┴───────┐- │ PostgreSQL │ │ Redis │- │ Port 5435 │ │ Port 6379 │+ │ CockroachDB │ │ Redis │+ │ Port 26257 │ │ Port 6379 │└──────────────┘ └─────────────┘```### Components-| Component | Description |-| --------------- | ------------------------------------------------------- |-| **API** | The httpSMS Go API server running in Docker |-| **Emulator** | A Fiber v3 Go service that simulates an Android phone |-| **PostgreSQL** | Database for the API |-| **Redis** | Cache and queue backend |-| **Seed** | One-shot container that seeds test data into PostgreSQL |-| **Test Runner** | Go test binary that runs on the host machine |+| Component | Description |+| --------------- | -------------------------------------------------------- |+| **API** | The httpSMS Go API server running in Docker |+| **Emulator** | A Fiber v3 Go service that simulates an Android phone |+| **CockroachDB** | Database for the API (single-node, insecure mode) |+| **Redis** | Cache and queue backend |+| **Seed** | One-shot container that seeds test data into CockroachDB |+| **Test Runner** | Go test binary that runs on the host machine |### How It Works@@ -86,7 +86,7 @@ export FIREBASE_CREDENTIALS=$(jq -c . firebase-credentials.json)docker compose up -d --build --wait```-This starts PostgreSQL, Redis, the API, and the emulator. The `--wait` flag blocks until all health checks pass.+This starts CockroachDB, Redis, the API, and the emulator. The `--wait` flag blocks until all health checks pass.### 4. Wait for Seeding@@ -95,7 +95,7 @@ docker compose wait seedsleep 2```-The seed container inserts test users, phones, and API keys into PostgreSQL after the API has run its GORM migrations.+The seed container inserts test users, phones, and API keys into CockroachDB after the API has run its GORM migrations.### 5. Run Tests@@ -181,7 +181,7 @@ docker compose logs apiCommon issues:- `FIREBASE_CREDENTIALS` env var not set or malformed-- PostgreSQL not ready (increase `start_period` in healthcheck)+- CockroachDB not ready (increase `start_period` in healthcheck)### Tests timeout waiting for `delivered` statusdiff --git a/tests/docker-compose.yml b/tests/docker-compose.ymlindex 515b6298..3d82d47c 100644--- a/tests/docker-compose.yml+++ b/tests/docker-compose.yml@@ -1,18 +1,39 @@services:- postgres:- image: postgres:alpine- environment:- POSTGRES_DB: httpsms- POSTGRES_PASSWORD: dbpassword- POSTGRES_USER: dbusername+ cockroachdb:+ image: cockroachdb/cockroach:latest+ command: start-single-node --insecure --store=type=mem,size=640MiBports:- - "5435:5432"+ - "26257:26257"+ - "8081:8080"healthcheck:- test: ["CMD-SHELL", "pg_isready -U dbusername -d httpsms"]+ test:+ [+ "CMD",+ "cockroach",+ "sql",+ "--insecure",+ "--host=localhost",+ "--execute=SELECT 1;",+ ]interval: 5stimeout: 5sretries: 10- start_period: 5s+ start_period: 10s++ cockroachdb-init:+ image: cockroachdb/cockroach:latest+ depends_on:+ cockroachdb:+ condition: service_healthy+ entrypoint:+ [+ "cockroach",+ "sql",+ "--insecure",+ "--host=cockroachdb",+ "--execute=CREATE DATABASE IF NOT EXISTS httpsms;",+ ]+ restart: "no"redis:image: redis:latest@@ -61,8 +82,8 @@ services:ports:- "8000:8000"depends_on:- postgres:- condition: service_healthy+ cockroachdb-init:+ condition: service_completed_successfullyredis:condition: service_healthywiremock:@@ -81,24 +102,19 @@ services:start_period: 30sseed:- image: postgres:alpine+ image: cockroachdb/cockroach:latestdepends_on:api:condition: service_healthy- environment:- PGPASSWORD: dbpasswordvolumes:- ./seed.sql:/seed.sql:roentrypoint:[- "psql",- "-h",- "postgres",- "-U",- "dbusername",- "-d",- "httpsms",- "-f",- "/seed.sql",+ "cockroach",+ "sql",+ "--insecure",+ "--host=cockroachdb",+ "--database=httpsms",+ "--file=/seed.sql",]restart: "no"