HTTP Mock Server

HTTP mock server allows you to test HTTP clients easily.

Basic information, such as requirements and installation steps, can be found at Readme.md file.

Classes provided

• httpmock::MockServer - class ready to be inhereted to define own behaviour of httpmock::MockServer::responseHandler() method.
• httpmock::TestEnvironment - Google Test environment class with mockserver running inside.

Helper functions

• httpmock::getFirstRunningMockServer() - port searcher function, trying to find free port to launch the server on.

First steps

To create a simple test, you need to follow these steps:

1. Derive class httpmock::MockServer and implement httpmock::MockServer::responseHandler(). This method is invoked on incomming requests.
2. Start a server (several choices)
   • Start a server manually by httpmock::MockServer::start() or
   • Use httpmock::getFirstRunningMockServer() to get mockserver running on first free port number, or
   • Use httpmock::createMockServerEnvironment() to get Google Test Environment with running mockserver on first free port number available.
3. Implement the test interacting with mockserver listening on localhost. Mockserver port can be obtained using httpmock::MockServer::getPort() method, or with following code if Google Test Environment is in use:

   // Mock is class derived from httpmock::IMockServer.
   ::testing::Environment *const env = ::testing::AddGlobalTestEnvironment(
       httpmock::createMockServerEnvironment<Mock>(serverStartingPortNumber));
    
   httpmock::TestEnvironment<httpmock::MockServerHolder> *mock_server_env
       = dynamic_cast<httpmock::TestEnvironment<httpmock::MockServerHolder> *>(env);
    
   int port = mock_server_env->getMock()->getPort();

Request handling

Method httpmock::MockServer::responseHandler() is responsible for request handling. Request arguments are passed as method arguments, which contains request path, method type, headers, POST data and URL arguments.

After processing request, the httpmock::MockServer::Response has to be returned. It contains response body and status.

Custom headers can be added into the response object using httpmock::MockServer::Response::addHeader() method, passing key-value httpmock::MockServer::Header object instances.