Skip to content

Commit b6b9b78

Browse files
committed
CCM-14205 - Added readme for performance tests
1 parent 820f495 commit b6b9b78

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

tests/performance/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# performance
2+
3+
Load tests for the client-callbacks service. These tests run against a real deployed AWS environment — they are not unit tests and cannot run locally without a live stack.
4+
5+
## Prerequisites
6+
7+
- AWS credentials configured for the target environment
8+
- The service deployed to the target environment
9+
10+
## Environment Variables
11+
12+
| Variable | Required | Default | Description |
13+
|---|---|---|---|
14+
| `ENVIRONMENT` | Yes || Target environment name (e.g. `dev`) |
15+
| `AWS_ACCOUNT_ID` | Yes || AWS account ID for the target environment |
16+
| `AWS_REGION` | No | `eu-west-2` | AWS region |
17+
| `PROJECT` | No | `nhs` | Project name prefix used in resource naming |
18+
| `COMPONENT` | No | `callbacks` | Component name used in resource naming |
19+
20+
## Running
21+
22+
From the repository root:
23+
24+
```bash
25+
ENVIRONMENT=dev AWS_ACCOUNT_ID=123456789012 npm run test:performance --workspace tests/performance
26+
```
27+
28+
## What the Tests Do
29+
30+
The global setup creates a test client subscription config in the S3 subscription config bucket.
31+
32+
The load test sends ~3,000 events/s to the SQS inbound queue for 30 seconds, then reads CloudWatch Logs to assert that the p95 Lambda processing time is below 500ms.
33+
34+
The global teardown removes the test client subscription config from S3.

0 commit comments

Comments
 (0)