Sign inSign up

spuf/mockable-server

By spuf

•Updated over 1 year ago

Simple programmable HTTP server helps to mock external services in your tests.

Image
0

4.8K

spuf/mockable-server repository overview

⁠Mockable Server

Simple programmable HTTP server helps to mock external services in your tests.

⁠How it works

There are 2 HTTP servers: first is mock on port 8010, second is control on 8020.

Any request to mock server stores to Requests queue, and sends back data from Responses queue, or HTTP 501.

⁠Configuration

$ docker run --rm spuf/mockable-server --help
Usage of mockable-server:
  -control-addr string
        Control server address [CONTROL_ADDR] (default ":8020")
  -mock-addr string
        Mock server address [MOCK_ADDR] (default ":8010")

⁠Usage example

docker-compose.yml:

services:
  mockable-server:
    image: spuf/mockable-server:latest

  your-service:
    build: .
    environment:
      TEST_MOCKABLE_SERVER_BASE: http://mockable-server:8010
      TEST_MOCKABLE_SERVER_CONTROL_BASE: http://mockable-server:8020
    depends_on:
      - mockable-server

⁠Control API

Has health check endpoint :8020/healthz.

Uses JSON-API 1.0 at :8020/rpc/1.

⁠Requests queue

Show queue content:

{
    "method": "Requests.List",
    "params": []    
}

{
    "id": null,
    "result": [
        {
            "method": "GET",
            "url": "/requested-path?n=v",
            "headers": {
                "Accept": "*/*",
                "Accept-Encoding": "gzip, deflate",
                "Connection": "keep-alive"
            },
            "body": ""
        },
        {
            "method": "POST",
            "url": "/requested-path",
            "headers": {
                "Accept": "*/*",
                "Accept-Encoding": "gzip, deflate",
                "Connection": "keep-alive",
                "Content-Type": "application/x-www-form-urlencoded"
            },
            "body": "n=v"
        }
    ],
    "error": null
}

Clear queue content:

{
    "method": "Requests.Clear",
    "params": []    
}

{
    "result": true,
    "error": null
}

Pop request:

{
    "method": "Requests.Pop",
    "params": []    
}

{
    "result": {
        "method": "GET",
        "url": "/requested-path?n=v",
        "headers": {
            "Accept": "*/*",
            "Accept-Encoding": "gzip, deflate",
            "Connection": "keep-alive"
        },
        "body": ""
    },
    "error": null
}
⁠Responses queue

Show queue content:

{
    "method": "Responses.List",
    "params": []    
}

{
    "id": null,
    "result": [
        {
            "status": 200,
            "headers": {
                "Content-Type": "text/plain",
                "Extra-Header": "value"
            },
            "body": "Hello",
            "delay": 0
        },
        {
            "status": 200,
            "headers": {
                "Content-Type": "text/plain",
                "Extra-Header": "value"
            },
            "body": "Hello",
            "delay": 0.001
        }
    ],
    "error": null
}

Clear queue content:

{
    "method": "Responses.Clear",
    "params": []        
}

{
    "result": true,
    "error": null
}

Push response:

{
    "method": "Responses.Push",
    "params": [{
        "status": 200,
        "headers": {
            "Content-Type": "text/plain",
            "Extra-Header": "value"
        },
        "body": "Hello",
        "delay": null
    }]    
}              

{
    "result": true,
    "error": null
}

Push response with binary data:

{
    "method": "Responses.Push",
    "params": [{
        "status": 200,
        "headers": {
            "Content-Type": "text/plain",
            "Extra-Header": "value"
        },
        "isBodyBase64": true,
        "body": "SGVsbG8=",
        "delay": null
    }]    
}              

{
    "result": true,
    "error": null
}

Tag summary

Content type

Image

Digest

sha256:e332aae3d…

Size

8.7 MB

Last updated

almost 2 years ago

docker pull spuf/mockable-server