Crate pact_mock_server_ffi

The pact_mock_server crate provides a number of exported functions using C bindings for controlling the mock server. These can be used in any language that supports C bindings.

create_mock_server

External interface to create a mock server. A pointer to the pact JSON as a C string is passed in, as well as the port for the mock server to run on. A value of 0 for the port will result in a port being allocated by the operating system. The port of the mock server is returned.

mock_server_matched

Simple function that returns a boolean value given the port number of the mock service. This value will be true if all the expectations of the pact that the mock server was created with have been met. It will return false if any request did not match, an un-recognised request was received or an expected request was not received.

mock_server_mismatches

This returns all the mismatches, un-expected requests and missing requests in JSON format, given the port number of the mock server.

IMPORTANT NOTE: The JSON string for the result is allocated on the rust heap, and will have to be freed once the code using the mock server is complete. The cleanup_mock_server function is provided for this purpose. If the mock server is not cleaned up properly, this will result in memory leaks as the rust heap will not be reclaimed.

cleanup_mock_server

This function will try terminate the mock server with the given port number and cleanup any memory allocated for it by the mock_server_mismatches function. Returns true, unless a mock server with the given port number does not exist, or the function fails in some way.

NOTE: Although close() on the listerner for the mock server is called, this does not currently work and the listerner will continue handling requests. In this case, it will always return a 501 once the mock server has been cleaned up.

write_pact_file

External interface to trigger a mock server to write out its pact file. This function should be called if all the consumer tests have passed. The directory to write the file to is passed as the second parameter. If a NULL pointer is passed, the current working directory is used.

Returns 0 if the pact file was successfully written. Returns a positive code if the file can not be written, or there is no mock server running on that port or the function panics.

Modules

bodies	Functions to support processing request/response bodies
handles	Handles wrapping Rust models

Enums

DateTimeResult

Result of generating a datetime value from a format string

Functions

cleanup_mock_server	External interface to cleanup a mock server. This function will try terminate the mock server with the given port number and cleanup any memory allocated for it. Returns true, unless a mock server with the given port number does not exist, or the function panics.
create_mock_server	External interface to create a mock server. A pointer to the pact JSON as a C string is passed in, as well as the port for the mock server to run on. A value of 0 for the port will result in a port being allocated by the operating system. The port of the mock server is returned.
create_mock_server_for_pact	External interface to create a mock server. A Pact handle is passed in, as well as the port for the mock server to run on. A value of 0 for the port will result in a port being allocated by the operating system. The port of the mock server is returned.
free_string	Frees the memory allocated to a string by another function
generate_datetime_string	Generates a datetime value from the provided format string, using the current system date and time NOTE: The memory for the returned string needs to be freed with the free_string function
given	Adds a provider state to the Interaction
init	Initialise the mock server library, can provide an environment variable name to use to set the log levels.
mock_server_matched	External interface to check if a mock server has matched all its requests. The port number is passed in, and if all requests have been matched, true is returned. False is returned if there is no mock server on the given port, or if any request has not been successfully matched, or the method panics.
mock_server_mismatches	External interface to get all the mismatches from a mock server. The port number of the mock server is passed in, and a pointer to a C string with the mismatches in JSON format is returned.
new_interaction	Creates a new Interaction and returns a handle to it
new_pact	Creates a new Pact model and returns a handle to it
response_status	Configures the response for the Interaction
upon_receiving	Sets the description for the Interaction
with_body	Adds the body for the interaction
with_header	Configures a header for the Interaction
with_query_parameter	Configures a query parameter for the Interaction
with_request	Configures the request for the Interaction
write_pact_file	External interface to trigger a mock server to write out its pact file. This function should be called if all the consumer tests have passed. The directory to write the file to is passed as the second parameter. If a NULL pointer is passed, the current working directory is used.