Struct MockServer 

pub struct MockServer { /* private fields */ }

A mock HTTP server for integration testing.

MockServer spawns an actual TCP server on a random port, allowing you to test HTTP client code against a real server. It records all incoming requests and allows you to configure canned responses.

Features

• Real TCP server: Listens on an actual port for real HTTP connections
• Request recording: Records all requests for later assertions
• Canned responses: Configure responses for specific paths
• Clean shutdown: Server shuts down when dropped

Example

use fastapi_core::testing::{MockServer, MockResponse};

// Start a mock server
let server = MockServer::start();

// Configure a response
server.mock_response("/api/users", MockResponse::ok().json(&vec!["Alice", "Bob"]));

// Make requests with your HTTP client
let url = format!("http://{}/api/users", server.addr());
// ... make request ...

// Assert requests were made
let requests = server.requests();
assert_eq!(requests.len(), 1);
assert_eq!(requests[0].path, "/api/users");

Implementations

impl MockServer

pub fn start() -> Self

Starts a new mock server on a random available port.

The server begins listening immediately and runs in a background thread.

Example

let server = MockServer::start();
println!("Server listening on {}", server.addr());

pub fn start_with_options(options: MockServerOptions) -> Self

Starts a mock server with custom options.

pub fn addr(&self) -> SocketAddr

Returns the socket address the server is listening on.

pub fn url(&self) -> String

Returns the base URL for the server (e.g., “http://127.0.0.1:12345”).

pub fn url_for(&self, path: &str) -> String

Returns a URL for the given path.

pub fn mock_response(&self, path: impl Into<String>, response: MockResponse)

Configures a canned response for a specific path.

Use * at the end of the path for prefix matching.

Example

server.mock_response("/api/users", MockResponse::ok().json(&users));
server.mock_response("/api/*", MockResponse::with_status(404));

pub fn set_default_response(&self, response: MockResponse)

Sets the default response for unmatched paths.

pub fn requests(&self) -> Vec<RecordedRequest>

Returns all recorded requests.

pub fn request_count(&self) -> usize

Returns the number of recorded requests.

pub fn requests_for(&self, path: &str) -> Vec<RecordedRequest>

Returns requests matching the given path.

pub fn last_request(&self) -> Option<RecordedRequest>

Returns the last recorded request.

pub fn clear_requests(&self)

Clears all recorded requests.

pub fn clear_responses(&self)

Clears all configured responses.

pub fn reset(&self)

Resets the server (clears requests and responses).

pub fn wait_for_requests(&self, count: usize, timeout: Duration) -> bool

Waits for a specific number of requests, with timeout.

Returns true if the expected number of requests were received, false if the timeout was reached.

pub fn assert_received(&self, path: &str)

Asserts that a request was made to the given path.

Panics

Panics if no request was made to the path.

pub fn assert_not_received(&self, path: &str)

Asserts that no request was made to the given path.

Panics

Panics if a request was made to the path.

pub fn assert_request_count(&self, expected: usize)

Asserts the total number of requests received.

Panics

Panics if the count doesn’t match.

Trait Implementations

impl Drop for MockServer

fn drop(&mut self)

Executes the destructor for this type.