Struct httpmock::MockServer

pub struct MockServer { /* private fields */ }

A mock server that is able to receive and respond to HTTP requests.

Implementations

impl MockServer

pub async fn connect_async(address: &str) -> Self

Asynchronously connects to a remote mock server that is running in standalone mode using the provided address of the form : (e.g. “127.0.0.1:8080”) to establish the connection. Note: This method requires the feature remote to be enabled.

pub fn connect(address: &str) -> Self

Synchronously connects to a remote mock server that is running in standalone mode using the provided address of the form : (e.g. “127.0.0.1:8080”) to establish the connection. Note: This method requires the feature remote to be enabled.

pub async fn connect_from_env_async() -> Self

Asynchronously connects to a remote mock server that is running in standalone mode using connection parameters stored in HTTPMOCK_HOST and HTTPMOCK_PORT environment variables. Note: This method requires the feature remote to be enabled.

pub fn connect_from_env() -> Self

Synchronously connects to a remote mock server that is running in standalone mode using connection parameters stored in HTTPMOCK_HOST and HTTPMOCK_PORT environment variables. Note: This method requires the feature remote to be enabled.

pub async fn start_async() -> Self

Starts a new MockServer asynchronously.

Attention: This library manages a pool of MockServer instances in the background. Instead of always starting a new mock server, a MockServer instance is only created on demand if there is no free MockServer instance in the pool and the pool has not reached a maximum size yet. Otherwise, THIS METHOD WILL BLOCK the executing function until a free mock server is available.

This allows to run many tests in parallel, but will prevent exhaust the executing machine by creating too many mock servers.

A MockServer instance is automatically taken from the pool whenever this method is called. The instance is put back into the pool automatically when the corresponding ‘MockServer’ variable gets out of scope.

pub fn start() -> MockServer

Starts a new MockServer synchronously.

Attention: This library manages a pool of MockServer instances in the background. Instead of always starting a new mock server, a MockServer instance is only created on demand if there is no free MockServer instance in the pool and the pool has not reached a maximum size yet. Otherwise, THIS METHOD WILL BLOCK the executing function until a free mock server is available.

This allows to run many tests in parallel, but will prevent exhaust the executing machine by creating too many mock servers.

A MockServer instance is automatically taken from the pool whenever this method is called. The instance is put back into the pool automatically when the corresponding ‘MockServer’ variable gets out of scope.

pub fn host(&self) -> String

The hostname of the MockServer. By default, this is 127.0.0.1. In standalone mode, the hostname will be the host where the standalone mock server is running.

pub fn port(&self) -> u16

The TCP port that the mock server is listening on.

pub fn address(&self) -> &SocketAddr

Builds the address for a specific path on the mock server.

Example:

// Start a local mock server for exclusive use by this test function.
let server = httpmock::MockServer::start();

let expected_addr_str = format!("127.0.0.1:{}", server.port());

// Get the address of the MockServer.
let addr = server.address();

// Ensure the returned URL is as expected
assert_eq!(expected_addr_str, addr.to_string());

pub fn url<S: Into<String>>(&self, path: S) -> String

Builds the URL for a specific path on the mock server.

Example:

// Start a local mock server for exclusive use by this test function.
let server = httpmock::MockServer::start();

let expected_url = format!("http://127.0.0.1:{}/hello", server.port());

// Get the URL for path "/hello".
let url = server.url("/hello");

// Ensure the returned URL is as expected
assert_eq!(expected_url, url);

pub fn base_url(&self) -> String

Builds the base URL for the mock server.

Example:

// Start a local mock server for exclusive use by this test function.
let server = httpmock::MockServer::start();

let expected_url = format!("http://127.0.0.1:{}", server.port());

// Get the URL for path "/hello".
let url = server.base_url();

// Ensure the returned URL is as expected
assert_eq!(expected_url, url);

pub fn mock<F>(&self, config_fn: F) -> Mock<'_>

where F: FnOnce(When, Then),

Creates a Mock object on the mock server.

Example:

use isahc::get;

let server = httpmock::MockServer::start();

let mock = server.mock(|when, then| {
    when.path("/hello");
    then.status(200);
});

get(server.url("/hello")).unwrap();

mock.assert();

pub async fn mock_async<'a, F>(&'a self, spec_fn: F) -> Mock<'a>

where F: FnOnce(When, Then),

Creates a Mock object on the mock server.

Example:

use isahc::{get_async};
async_std::task::block_on(async {
    let server = httpmock::MockServer::start();

    let mock = server
        .mock_async(|when, then| {
            when.path("/hello");
            then.status(200);
        })
        .await;

    get_async(server.url("/hello")).await.unwrap();

    mock.assert_async().await;
});

Trait Implementations

impl Drop for MockServer

fn drop(&mut self)

Executes the destructor for this type.