Skip to content

Commit dbafb48

Browse files
committed
docs: consolidate test scripts documentation into main README
1 parent 718cc79 commit dbafb48

File tree

2 files changed

+43
-154
lines changed

2 files changed

+43
-154
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,9 +246,52 @@ python3 -m venv venv
246246
source venv/bin/activate
247247
pip install -r requirements.txt
248248

249+
# Ensure services are running
250+
make dev
251+
249252
# Run tests (from project root)
250253
./scripts/send_webhook.sh # Full webhook pipeline test
251254
./scripts/test-correlation-tracing.sh # Distributed tracing verification
255+
./scripts/test-dev-environment.sh # Development environment health check
256+
```
257+
258+
#### Available Test Scripts
259+
260+
**`send_webhook.sh` - End-to-End Webhook Test**
261+
- Validates complete issue processing pipeline
262+
- Generates development JWT token and sends test GitHub webhook
263+
- Verifies issue storage, triggers AI classification, and displays statistics
264+
- Dev JWT uses `sub: '0'` with `dev_mode: true` (valid for 1 hour)
265+
266+
**`test-correlation-tracing.sh` - Correlation ID Tracing Test**
267+
- Tests distributed tracing system using correlation IDs
268+
- Traces correlation ID through all service logs (ingress → classifier → gateway)
269+
- Verifies end-to-end request tracking across microservices
270+
271+
**`test-dev-environment.sh` - Development Environment Health Check**
272+
- Validates all development services are running and healthy
273+
- Checks connectivity and basic functionality of core services
274+
275+
#### Troubleshooting Tests
276+
277+
**"ModuleNotFoundError: No module named 'jose'"**
278+
```bash
279+
pip install -r requirements.txt
280+
```
281+
282+
**"Issue not found in API"**
283+
```bash
284+
# Check services are running
285+
docker ps
286+
287+
# Verify gateway health
288+
curl http://localhost:8002/health
289+
290+
# Check classifier logs
291+
docker logs dispatchai-classifier --tail 20
292+
293+
# Verify database contents
294+
docker exec dispatchai-postgres psql -U postgres -d dispatchai -c "SELECT * FROM dispatchai.issues ORDER BY created_at DESC LIMIT 1;"
252295
```
253296

254297
### Code Quality & Testing

scripts/README.md

Lines changed: 0 additions & 154 deletions
This file was deleted.

0 commit comments

Comments
 (0)