gozzmock

README

gozzmock

Mock server in go!

Inspired by http://www.mock-server.com/

Docker Hub

https://hub.docker.com/r/travix/gozzmock/

Description

Travix uses gozzmock to avoid dependencies on 3rd party services at test environment. Gozzmock is a "transparent" mock and fully manageable trow API calls. Transparency means, some calls can be mocked, other calls will be send to real endpoint.

Package manager: dep

Install

 docker pull travix/gozzmock

Examples

For instance, there is a task to mock GitHub API call https://api.github.com/user By default, /user returns

{
  "message": "Requires authentication",
  "documentation_url": "https://developer.github.com/v3"
}

Run container with gozzmock

docker run -it -p8080:8080 travix/gozzmock

Upload a "forward" expectation to gozzmock. Expectation structure:

{
    "key": "forwardExpectation",
    "forward": {
        "host": "api.github.com",
        "scheme": "https"
    }
}

Expectation should be sent to /gozzmock/add_expectation endpoint like this

curl -d '{"forward":{"host":"api.github.com","scheme":"https"},"key":"forwardExpectation"}' -X POST http://192.168.99.100:8080/gozzmock/add_expectation

NOTE 192.168.99.100 - ip of host machine

To validate that expectation works

curl http://192.168.99.100:8080/user

returns

{
  "message": "Requires authentication",
  "documentation_url": "https://developer.github.com/v3"
}

Add expectation with response:

{
    "key": "responseExpectation",
    "request": {
        "method": "GET",
        "path": "mocked"
    },
    "response": {
        "body": "response from gozzmock",
        "headers": [
            {
                "Content-Type": "text/plain; charset=utf-8"
            }
        ],
        "httpcode": 200
    },
    "priority": 1
}

curl -d '{"key":"responseExpectation","request":{"method":"GET","path":"mocked"},"response":{"body":"response from gozzmock","headers":[{"Content-Type":"text/plain; charset=utf-8"}],"httpcode":200},"priority":1}' -X POST http://192.168.99.100:8080/gozzmock/add_expectation

Send request with "mocked" in path:

curl http://192.168.99.100:8080/user?arg=mocked
curl http://192.168.99.100:8080/user?mocked
curl http://192.168.99.100:8080/user/mocked

For all those request response will be from expectation:

response from gozzmock

To remove expectation, send request to /gozzmock/remove_expectation with structure:

{
    "key": "responseExpectation"
}

curl -d '{"key":"responseExpectation"}' -X POST http://192.168.99.100:8080/gozzmock/remove_expectation

Arguments

loglevel - log level. Values: debug, info, warn, error, fatal, panic. Default: debug expectations - array of expectations is json format. Default: empty. It is used to load default/forward expectations when appication starts.

Example

docker run -it -p8080:8080 travix/gozzmock --expectations="[{\"key\": \"k1\"},{\"key\": \"k2\"}]" --loglevel=info

Structure of expectations

Root level

• key - unique identifier for message. If another expectation is added with same key, original will be replaced
• priority (optional) - is used to define order. First expectation has greatest priority.
• dealy (optional) - delay in seconds before sending response
• request - block of filters/conditions for incoming request
• response - this block will be sent as response if incoming request passes filter in "request" block
• forward - this block describes forwarding/proxy. If incoming request passes filter in "request" block, request will be re-sent according to "forward" block.

NOTE only one block should be set: response or forward

Request

Structure of "request" block

• method - HTTP method: POST, GET, ...
• path - path, including query (?) and fragments (#)
• body - request body
• headers - headers in request

NOTE It is allowed to use regex as well as simple string. For instance, if path: ".*" - it will be parsed as regex. if string "abc" - it will be used as substring

Forward

Structure of "forward" block

• Scheme - HTTP or HTTPS
• host - target host name. Host name of original request will be replaced with this value. Path and query will be same.
• headers - headers which will be added/replaced when forwarding

Response

Structure of "response" block

• method - HTTP method: POST, GET, ...
• path - path, including query (?) and fragments (#)
• body - response body
• headers - headers in response

Endpoints

• /gozzmock/status - status and readiness endpoint
• /gozzmock/add_expectation - add or update an expectation
• /gozzmock/remove_expectation - remove expectation by key
• /gozzmock/get_expectations - get list of all stored expectations