mirror of
https://github.com/whekin/household-bot.git
synced 2026-03-31 10:24:02 +00:00
docs(test): add e2e runbook and use .bun-version in CI/CD
This commit is contained in:
64
docs/runbooks/e2e-tests.md
Normal file
64
docs/runbooks/e2e-tests.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# End-to-End Smoke Tests
|
||||
|
||||
## Overview
|
||||
|
||||
The `scripts/e2e/billing-flow.ts` script runs a deterministic end-to-end
|
||||
smoke test for the billing pipeline. It exercises:
|
||||
|
||||
- Purchase ingestion from a simulated topic message
|
||||
- Utility bill entry via bot commands
|
||||
- Monthly statement generation and balance verification
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Bun 1.3+ installed
|
||||
- A running Supabase/Postgres database with the schema applied
|
||||
- `DATABASE_URL` set (via `.env` or environment)
|
||||
|
||||
## Running locally
|
||||
|
||||
```bash
|
||||
# 1. Ensure .env has a valid DATABASE_URL
|
||||
cp .env.example .env
|
||||
# edit .env with real DATABASE_URL
|
||||
|
||||
# 2. Apply database migrations
|
||||
bun run db:migrate
|
||||
|
||||
# 3. Run the e2e smoke test
|
||||
bun run test:e2e
|
||||
```
|
||||
|
||||
The test seeds its own data (household + 3 roommates), runs the full
|
||||
purchase → utility → statement flow, asserts deterministic totals, and
|
||||
cleans up after itself.
|
||||
|
||||
## Expected output
|
||||
|
||||
On success:
|
||||
|
||||
```
|
||||
E2E smoke passed: purchase ingestion, utility updates, and statements are deterministic
|
||||
```
|
||||
|
||||
On failure the script exits with code 1 and prints the assertion error.
|
||||
|
||||
## CI integration
|
||||
|
||||
The e2e smoke test runs in CI as part of the quality matrix when the
|
||||
`DATABASE_URL` secret is configured. Without the secret, the job is
|
||||
skipped automatically.
|
||||
|
||||
## Test data
|
||||
|
||||
The test creates temporary records with random UUIDs:
|
||||
|
||||
| Entity | Details |
|
||||
| --------- | -------------------------- |
|
||||
| Household | "E2E Smoke Household" |
|
||||
| Alice | Admin, telegram ID 900001 |
|
||||
| Bob | Member, telegram ID 900002 |
|
||||
| Carol | Member, telegram ID 900003 |
|
||||
|
||||
All test data is cleaned up in a `finally` block via cascade delete on
|
||||
the household row.
|
||||
Reference in New Issue
Block a user