README.md

Examples for using Rio to write integration test

• Examples for using Rio to write integration test
  • Prerequisites
  • Setup
  • Write tests
    • Manual tests
    • Write automation tests
  • Debug

Prerequisites

• Docker
• NodeJS: 18+

Setup

Suppose that you are trying to write integration test for your API POST /checkout, this system under test is deployed on your testing environment. To make it simple, this API forwards request to a 3rd party API POST /pay, then returns responded data from 3rd party back to the caller. See server/index.ts for more details

Run the below command to start Rio and your example API server before running your test suites

make example-up

Verify whether your test API is ready

curl http://localhost:8808/ping

Verify whether Rio is ready

curl http://localhost:8896/ping

In the real world scenario, you don't need to setup these steps because your API and mock server (Rio) are already deployed in testing environment. Instead, you need to configure the root URL of 3rd party API to Rio mock server

Write tests

Manual tests

Reset all stubs

curl -X DELETE http://localhost:8896/reset?namespace=reset_all

Submit a stub to mock

curl --location 'http://localhost:8896/stub/create_many' \
--header 'Content-Type: application/json' \
--data '{
  "stubs": [
    {
      "request": {
        "method": "POST",
        "url": [
          {
            "name": "contains",
            "value": "/pay"
          }
        ]
      },
      "response": {
        "status_code": 200,
        "header": {
          "Content-Type": "application/json"
        },
        "body": {
          "id": "bfd4ea04-f2ad-444b-b672-9b739d0546fc",
          "createdAt": "2023-07-03T08:17:24Z"
        }
      },
      "active": true
    }
  ]
}'

Perform a CURL to test to API

curl --location 'http://localhost:8808/checkout' \
--header 'Content-Type: application/json' \
--data '{
    "cardNumber": "123456789",
    "amount": 30000
}'

Write automation tests

See example

make example-test

Debug

• Get Rio's logs: make rio-logs

• List defined stubs: curl http://localhost:8896/stub/list

• List of receiving requests: curl -X POST http://localhost:8896/incoming_request/list

• Cleanup environment: make rio-down