Contract Testing

### Get user by ID
# @name getUserById
# @contract.provider UserService
# @contract.state "user exists with id 1"

GET {{baseUrl}}/users/1

>>>
expect status 200
expect body.id == 1
expect body.name type string
expect body.email type string
<<<

# Verify contracts against a provider
hitspec contract verify contracts/ --provider http://localhost:3000

# With a state handler script
hitspec contract verify contracts/ \
  --provider http://localhost:3000 \
  --state-handler ./setup-states.sh

# Verbose output
hitspec contract verify contracts/ --provider http://localhost:3000 -v

#!/bin/bash
# setup-states.sh
case "$1" in
  "user exists with id 1")
    curl -s -X POST http://localhost:3000/test/seed-user -d '{"id": 1, "name": "John"}' > /dev/null
    ;;
  "no users exist")
    curl -s -X POST http://localhost:3000/test/clear-users > /dev/null
    ;;
esac

hitspec contract verify <contracts-dir> [flags]

@baseUrl = {{baseUrl}}

### List all users
# @name listUsers
# @contract.provider UserService

GET {{baseUrl}}/users

>>>
expect status 200
expect body type array
expect body length >= 0
<<<

### Create a user
# @name createUser
# @contract.provider UserService
# @contract.state "database is empty"

POST {{baseUrl}}/users
Content-Type: application/json

{
  "name": "Jane Doe",
  "email": "jane@example.com"
}

>>>
expect status 201
expect body.id exists
expect body.name == "Jane Doe"
<<<