Struct ServerManager 

pub struct ServerManager { /* private fields */ }

Struct to represent many mock servers running in a background thread

Implementations

impl ServerManager

pub fn new() -> ServerManager

Construct a new ServerManager for scheduling several instances of mock servers on one tokio runtime.

pub fn spawn_mock_server( &mut self, builder: MockServerBuilder, ) -> Result<Either<MockServer, (String, u16)>>

Consumes the mock server builder, and then spawns the resulting mock server on the server manager’s runtime. Note that this function will block the current calling thread.

The returned value depends on whether the mock server is directly managed by this manager or provided by a plugin. For plugin provided mock servers, the function will return the mock server ID and port.

pub fn spawn_http_mock_server( &mut self, builder: MockServerBuilder, ) -> Result<MockServer>

Consumes the mock server builder, and then spawns the resulting HTTP mock server on the server manager’s runtime. Note that this function will block the current calling thread.

This function does not handle mock servers provided by plugins.

pub fn start_mock_server_with_addr( &mut self, id: String, pact: Box<dyn Pact + Send + Sync>, addr: SocketAddr, config: MockServerConfig, ) -> Result<SocketAddr>

👎Deprecated since 2.0.0-beta.0: Use the mock server builder (MockServerBuilder)

Start a new server on the runtime

pub fn start_tls_mock_server_with_addr( &mut self, id: String, pact: Box<dyn Pact + Send + Sync>, addr: SocketAddr, tls_config: &ServerConfig, config: MockServerConfig, ) -> Result<SocketAddr>

👎Deprecated since 2.0.0-beta.0: Use the mock server builder (MockServerBuilder)

Start a new TLS server on the runtime

pub fn start_mock_server( &mut self, id: String, pact: Box<dyn Pact + Send + Sync>, port: u16, config: MockServerConfig, ) -> Result<u16>

👎Deprecated since 2.0.0-beta.0: Use the mock server builder (MockServerBuilder)

Start a new server on the runtime

pub async fn start_mock_server_nonblocking( &mut self, id: String, pact: Box<dyn Pact + Send + Sync>, port: u16, config: MockServerConfig, ) -> Result<u16, String>

👎Deprecated since 2.0.0-beta.0: Use the mock server builder (MockServerBuilder)

Start a new server on the runtime, returning the bound port the mock server is running on

pub fn start_tls_mock_server( &mut self, id: String, pact: Box<dyn Pact + Send + Sync>, port: u16, tls: &ServerConfig, config: MockServerConfig, ) -> Result<u16>

👎Deprecated since 2.0.0-beta.0: Use the mock server builder (MockServerBuilder)

Start a new TLS server on the runtime

pub fn start_mock_server_for_transport( &mut self, id: String, pact: Box<dyn Pact + Send + Sync>, addr: SocketAddr, transport: &CatalogueEntry, config: MockServerConfig, ) -> Result<SocketAddr>

👎Deprecated since 2.0.0-beta.0: Use the mock server builder (MockServerBuilder)

Start a new mock server for the provided transport on the runtime. Returns the socket address that the server is running on.

pub fn shutdown_mock_server_by_id<S: Into<String>>(&mut self, id: S) -> bool

Shut down a server by its id. This function will only shut down a local mock server, not one provided by a plugin.

pub fn shutdown_mock_server_by_port(&mut self, port: u16) -> bool

Shut down a server by its local port number

pub fn find_mock_server_by_id<R>( &self, id: &str, f: &dyn Fn(&ServerManager, Either<&MockServer, &PluginMockServer>) -> R, ) -> Option<R>

Find mock server by id, and map it using supplied function if found.

pub fn find_mock_server_by_port<R>( &mut self, port: u16, f: &dyn Fn(&ServerManager, &String, Either<&MockServer, &PluginMockServer>) -> R, ) -> Option<R>

Find a mock server by port number and map it using supplied function if found.

pub fn find_mock_server_by_port_mut<R>( &mut self, port: u16, f: &dyn Fn(&mut MockServer) -> R, ) -> Option<R>

Find a mock server by port number and apply a mutating operation on it if successful. This will only work for locally managed mock servers, not mock servers provided by plugins.

pub fn map_mock_servers<R, F>(&self, f: F) -> Vec<R>

where F: Fn(&MockServer) -> R,

Map all the running mock servers This will only work for locally managed mock servers, not mock servers provided by plugins.

pub fn store_mock_server_resource(&mut self, port: u16, s: CString) -> bool

Store a string that needs to be cleaned up when the mock server terminates

pub fn mock_server_matched(&self, id: &str) -> Option<bool>

Determines if the mock server running with the given ID has matched all its requests correctly. If there is no mock server running with that ID, it will return None. In the case the mock server has not received any requests, it will return Some(true) as this is the default state.

pub fn mock_server_matched_by_port(&self, port: u16) -> Option<bool>

Determines if the mock server running on the given port has matched all its requests correctly. If there is no mock server running on that port, it will return None. In the case the mock server has not received any requests, it will return Some(true) as this is the default state.

pub fn mock_server_mismatches(&self, id: &str) -> Result<Option<Vec<Value>>>

Returns all the mismatches from the mock server with the given ID. If there is no mock server with that ID, it will return None. The mismatch values are returned as JSON. This is to support mock servers provided by plugins, which can have a different format.

pub fn mock_server_mismatches_by_port( &self, port: u16, ) -> Result<Option<Vec<Value>>>

Returns all the mismatches from the mock server running on the given port. If there is no mock server running on that port, it will return None. The mismatch values are returned as JSON. This is to support mock servers provided by plugins, which can have a different format.