Skip to content

QUICK_START_BDD.md

Latest commit

 

History

History
133 lines (99 loc) · 3.26 KB

QUICK_START_BDD.md

File metadata and controls

133 lines (99 loc) · 3.26 KB

BDD Testing - Quick Start Guide

Run automated BDD tests for TelemetryFlow Core IAM API using Newman.

Prerequisites

# Install Newman
npm install -g newman newman-reporter-htmlextra

# Start backend
docker-compose up -d backend

# Verify backend is running
curl http://localhost:3000/health

Run Tests

All Tests

pnpm test:bdd

Specific Module

pnpm test:bdd:users      # Users module
pnpm test:bdd:roles      # Roles module

With Options

pnpm test:bdd:verbose    # Detailed output
bash docs/postman/run-bdd-tests.sh --bail  # Stop on failure

Test Reports

Reports are auto-generated in docs/postman/reports/:

# View latest HTML report
open docs/postman/reports/report-*.html

Test Coverage

  • 33 BDD scenarios covering all IAM endpoints
  • 100% API coverage matching Swagger documentation
  • Given-When-Then format for clear test intent

Example Output

╔════════════════════════════════════════════════════════════════╗
║         TelemetryFlow Core - BDD API Tests (Newman)           ║
╚════════════════════════════════════════════════════════════════╝

✓ Newman installed
✓ Backend is running

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
🧪 Running BDD Tests
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Collection:  TelemetryFlow Core - IAM.postman_collection.json
Environment: TelemetryFlow Core - Local.postman_environment.json

→ Health Check
  GET http://localhost:3000/health [200 OK, 245B, 15ms]
  ✓ Status code is 200
  ✓ Response contains status ok

→ Get All Users
  GET http://localhost:3000/api/v2/users [200 OK, 1.2KB, 45ms]
  ✓ Status code is 200
  ✓ Response is an array
  ✓ Users have required fields

...

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
📊 Test Results
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

✅ All tests passed!

Reports generated:
  HTML: docs/postman/reports/report-20251203_214500.html
  JSON: docs/postman/reports/report-20251203_214500.json

CI/CD Integration

GitHub Actions

- name: Run BDD Tests
  run: pnpm test:bdd

GitLab CI

test:
  script:
    - pnpm test:bdd
  artifacts:
    paths:
      - docs/postman/reports/

Troubleshooting

Backend Not Running

docker-compose up -d backend
sleep 10

Newman Not Found

npm install -g newman newman-reporter-htmlextra

View Detailed Logs

pnpm test:bdd:verbose

See Also: