This project provides both a restful web api and command line interface to run pact mock servers. It is a single executable binary and is able to manage multiple mock servers. The lifecycle of each mock server can be controlled by the restful web api or through the command line interface. It implements the V1 Pact specification.
The mock server is bundles as a single binary executable pact_mock_server_cli. Running this with out any options displays
the standard help.
```console $ ./pactmockservercli error: 'pactmockservercli' requires a subcommand, but one was not provided
USAGE:
pactmockserver_cli [FLAGS] [OPTIONS]
For more information try --help
$ ./pactmockservercli --help ./pactmockservercli v0.0.0 Standalone Pact mock server
USAGE:
pactmockserver_cli [FLAGS] [OPTIONS]
FLAGS: --help Prints help information -v, --version Prints version information
OPTIONS:
-h, --host
SUBCOMMANDS: create Creates a new mock server from a pact file help Prints this message or the help of the given subcommand(s) list Lists all the running mock servers start Starts the master mock server verify Verify the mock server by id or port number, and generate a pact file if all ok ```
The following options are available for all subcommands:
This sets the host the master mock server runs on. By default this will be localhost.
This sets the port that the master mock server runs on. By default this will be 8080. The start command will start the master server using this port.
This sets the log level that the CLI and mock servers log at. It defaults to info. Valid values are: error, warn, info, debug, trace, none.
This prints either the main help or the help for a sub-command.
This starts the master mock server. This server needs to be running for the other sub-commands to work.
```console $ ./pactmockserver_cli help start start v0.0.0 Starts the master mock server
USAGE: start [FLAGS] [OPTIONS]
FLAGS: --help Prints help information
OPTIONS:
-h, --host
This sets the output directory that log files and pact files are written to. It defaults to the current working directory.
console
$ ./pact_mock_server_cli start -l debug -o logs/
15:40:08 [DEBUG] hyper::server: threads = 10
15:40:08 [INFO] pact_mock_server_cli::server: Server started on port 8080
This creates a new pact mock server managed by the master server from a pact file. The ID and port of the mock server will be displayed.
```console $ ./pactmockserver_cli help create create v0.0.0 Creates a new mock server from a pact file
USAGE:
create [FLAGS] [OPTIONS] --file
FLAGS: --help Prints help information
OPTIONS:
-f, --file
This option specifies the pact file to base the mock server on. It is a mandatory option.
console
$ ./pact_mock_server_cli create -f ../../../libpact_matching/tests/pact.json
15:43:47 [INFO] pact_mock_server_cli::create_mock: Creating mock server from file ../../../libpact_matching/tests/pact.json
Mock server "7d1bf906d0ff42528f2d7d794dd19c5b" started on port 52943
Lists out all running mock servers with their ID, port, provider name and status.
```console $ ./pactmockservercli list --help pactmockservercli-list v0.0.0 Lists all the running mock servers
USAGE: pactmockserver_cli list [FLAGS] [OPTIONS]
FLAGS: --help Prints help information
OPTIONS:
-h, --host
console
$ ./pact_mock_server_cli list
Mock Server Id Port Provider Status
7d1bf906d0ff42528f2d7d794dd19c5b 52943 Alice Service error
This checks that the mock server, specified by ID or port number, has met all the expectations of the pact file. If all expectations have been met, the pact file will be written out to the output directory that was specified with the start sub-command. If there is any errors, no pact file will be written and the errors displayed to the console.
```console $ ./pactmockservercli verify --help pactmockservercli-verify v0.0.0 Verify the mock server by id or port number, and generate a pact file if all ok
USAGE:
pactmockserver_cli verify [FLAGS] [OPTIONS] --mock-server-id
FLAGS: --help Prints help information
OPTIONS:
-h, --host
The ID of the mock server to verify. Either this option or the mock server port option must be provided.
The port number of the mock server to verify. Either this option or the mock server ID option must be provided.
In the case of a mock server that has issues:
```console $ ./pactmockserver_cli verify -m 52943 Mock server 7d1bf906d0ff42528f2d7d794dd19c5b/52943 failed verification with 1 errors
0 - Expected request was not received - {"method":"GET","path":"/mallory","query":"name=ron&status=good"} ```
and for a mock server that has matched all requests:
console
$ ./pact_mock_server_cli verify -m 52943
Mock server 7d1bf906d0ff42528f2d7d794dd19c5b/52943 verified ok
The master mock server provides a restful JSON API, and this API is what the command line sub-commands use to communicate and control the master server.
This returns a list of all running mock servers managed by this master server.
example request:
GET http://localhost:8080/ HTTP/1.1
example response:
json
{
"mockServers": [
{
"id": "7d1bf906d0ff42528f2d7d794dd19c5b",
"port": 52943,
"provider": "Alice Service",
"status": "ok"
}
]
}
This creates a new mock server from a pact file that must be present as JSON in the body. Returns the details of the mock server in the response.
example request:
POST http://localhost:8080/ HTTP/1.1
Content-Type: application/json
payload:
json
{
"provider": {
"name": "Alice Service"
},
"consumer": {
"name": "Consumer"
},
"interactions": [
{
"description": "a retrieve Mallory request",
"request": {
"method": "GET",
"path": "/mallory",
"query": "name=ron&status=good"
},
"response": {
"status": 200,
"headers": {
"Content-Type": "text/html"
},
"body": "\"That is some good Mallory.\""
}
}
]
}
example response:
json
{
"mockServer": {
"id": "81c3483901e647ba8f545f2842d09cba",
"port": 58276
}
}
This is returned when if the mock server was created successfully.
This is returned if the pact JSON could not be parsed or the mock server could not be started.
This checks that the mock server, specified by ID or port number, has met all the expectations of the pact file. If all expectations have been met, the pact file will be written out to the output directory that was specified with the start sub-command. If any mismatched requests where received by the mock server, they will be returned.
example request:
POST http://localhost:8080/mockserver/52943/verify HTTP/1.1
example successful response:
json
{
"mockServer": {
"id": "7d1bf906d0ff42528f2d7d794dd19c5b",
"port": 52943,
"provider": "Alice Service",
"status": "ok"
}
}
example unsuccessful response:
json
{
"mismatches": [
{
"method": "GET",
"path": "/mallory",
"request": {
"method": "GET",
"path": "/mallory",
"query": "name=ron&status=good"
},
"type": "missing-request"
}
],
"mockServer": {
"id": "81c3483901e647ba8f545f2842d09cba",
"port": 58276,
"provider": "Alice Service",
"status": "error"
}
}
This is returned when all expectations have been successfully met.
This is returned if any expectations have not been met, or any unrecognised requests where received.
This is returned if the ID or port number did not correspond to a running mock server or the pact file could not be written.
example response:
json
"No mock server running with port '58277'"