1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
//! The `pact_mock_server` crate provides the in-process mock server for mocking HTTP requests
//! and generating responses based on a pact file. It implements the V3 Pact specification
//! (https://github.com/pact-foundation/pact-specification/tree/version-3).
//!
//! The exported functions using C bindings for controlling the mock server now live in the `pact_mock_server_ffi`
//! crate.
#![warn(missing_docs)]
use std::sync::Mutex;
use lazy_static::*;
use log::*;
use rustls::ServerConfig;
use serde_json::json;
use uuid::Uuid;
use pact_models::pact::{load_pact_from_json, Pact};
use crate::mock_server::MockServerConfig;
use crate::server_manager::ServerManager;
pub mod matching;
pub mod mock_server;
pub mod server_manager;
mod hyper_server;
pub mod tls;
/// Mock server errors
#[derive(thiserror::Error, Debug)]
pub enum MockServerError {
/// Invalid Pact Json
#[error("Invalid Pact JSON")]
InvalidPactJson,
/// Failed to start the mock server
#[error("Failed to start the mock server")]
MockServerFailedToStart
}
lazy_static! {
///
/// A global thread-safe, "init-on-demand" reference to a server manager.
/// When the server manager is initialized, it starts a separate thread on which
/// to serve requests.
///
pub static ref MANAGER: Mutex<Option<ServerManager>> = Mutex::new(Option::None);
}
/// Starts a mock server with the given ID, pact and port number. The ID needs to be unique. A port
/// number of 0 will result in an auto-allocated port by the operating system. Returns the port
/// that the mock server is running on wrapped in a `Result`.
///
/// * `id` - Unique ID for the mock server.
/// * `pact` - Pact model to use for the mock server.
/// * `addr` - Socket address that the server should listen on.
///
/// # Errors
///
/// An error with a message will be returned in the following conditions:
///
/// - If a mock server is not able to be started
pub fn start_mock_server(
id: String,
pact: Box<dyn Pact>,
addr: std::net::SocketAddr
) -> Result<i32, String> {
start_mock_server_with_config(id, pact, addr, MockServerConfig::default())
}
/// Starts a mock server with the given ID, pact and port number. The ID needs to be unique. A port
/// number of 0 will result in an auto-allocated port by the operating system. Returns the port
/// that the mock server is running on wrapped in a `Result`.
///
/// * `id` - Unique ID for the mock server.
/// * `pact` - Pact model to use for the mock server.
/// * `addr` - Socket address that the server should listen on.
/// * `config` - Configuration for the mock server
///
/// # Errors
///
/// An error with a message will be returned in the following conditions:
///
/// - If a mock server is not able to be started
pub fn start_mock_server_with_config(
id: String,
pact: Box<dyn Pact>,
addr: std::net::SocketAddr,
config: MockServerConfig
) -> Result<i32, String> {
MANAGER.lock().unwrap()
.get_or_insert_with(ServerManager::new)
.start_mock_server_with_addr(id, pact, addr, config)
.map(|addr| addr.port() as i32)
}
/// Starts a TLS mock server with the given ID, pact and port number. The ID needs to be unique. A port
/// number of 0 will result in an auto-allocated port by the operating system. Returns the port
/// that the mock server is running on wrapped in a `Result`.
///
/// * `id` - Unique ID for the mock server.
/// * `pact` - Pact model to use for the mock server.
/// * `addr` - Socket address that the server should listen on.
/// * `tls` - TLS config.
///
/// # Errors
///
/// An error with a message will be returned in the following conditions:
///
/// - If a mock server is not able to be started
pub fn start_tls_mock_server(
id: String,
pact: Box<dyn Pact>,
addr: std::net::SocketAddr,
tls: &ServerConfig
) -> Result<i32, String> {
start_tls_mock_server_with_config(id, pact, addr, tls, MockServerConfig::default())
}
/// Starts a TLS mock server with the given ID, pact and port number. The ID needs to be unique. A port
/// number of 0 will result in an auto-allocated port by the operating system. Returns the port
/// that the mock server is running on wrapped in a `Result`.
///
/// * `id` - Unique ID for the mock server.
/// * `pact` - Pact model to use for the mock server.
/// * `addr` - Socket address that the server should listen on.
/// * `tls` - TLS config.
/// * `config` - Configuration for the mock server
///
/// # Errors
///
/// An error with a message will be returned in the following conditions:
///
/// - If a mock server is not able to be started
pub fn start_tls_mock_server_with_config(
id: String,
pact: Box<dyn Pact>,
addr: std::net::SocketAddr,
tls: &ServerConfig,
config: MockServerConfig
) -> Result<i32, String> {
MANAGER.lock().unwrap()
.get_or_insert_with(ServerManager::new)
.start_tls_mock_server_with_addr(id, pact, addr, tls, config)
.map(|addr| addr.port() as i32)
}
/// Creates a mock server. Requires the pact JSON as a string 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.
///
/// * `pact_json` - Pact in JSON format
/// * `addr` - Socket address to listen on
pub fn create_mock_server(
pact_json: &str,
addr: std::net::SocketAddr
) -> anyhow::Result<i32> {
match serde_json::from_str(pact_json) {
Ok(pact_json) => {
let pact = load_pact_from_json("<create_mock_server>", &pact_json)?;
start_mock_server(Uuid::new_v4().to_string(), pact, addr)
.map_err(|err| {
error!("Could not start mock server: {}", err);
MockServerError::MockServerFailedToStart.into()
})
},
Err(err) => {
error!("Could not parse pact json: {}", err);
Err(MockServerError::InvalidPactJson.into())
}
}
}
/// Creates a TLS mock server. Requires the pact JSON as a string 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.
///
/// * `pact_json` - Pact in JSON format
/// * `addr` - Socket address to listen on
/// * `tls` - TLS config
pub fn create_tls_mock_server(
pact_json: &str,
addr: std::net::SocketAddr,
tls: &ServerConfig
) -> anyhow::Result<i32> {
match serde_json::from_str(pact_json) {
Ok(pact_json) => {
let pact = load_pact_from_json("<create_mock_server>", &pact_json)?;
start_tls_mock_server(Uuid::new_v4().to_string(), pact, addr, tls)
.map_err(|err| {
error!("Could not start mock server: {}", err);
MockServerError::MockServerFailedToStart.into()
})
},
Err(err) => {
error!("Could not parse pact json: {}", err);
Err(MockServerError::InvalidPactJson.into())
}
}
}
/// Function 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.
pub fn mock_server_matched(mock_server_port: i32) -> bool {
MANAGER.lock().unwrap()
.get_or_insert_with(ServerManager::new)
.find_mock_server_by_port_mut(mock_server_port as u16, &|mock_server| {
mock_server.mismatches().is_empty()
})
.unwrap_or(false)
}
/// Gets all the mismatches from a mock server. The port number of the mock
/// server is passed in, and the results are returned in JSON format as a String.
///
/// If there is no mock server with the provided port number, `None` is returned.
///
pub fn mock_server_mismatches(mock_server_port: i32) -> Option<std::string::String> {
MANAGER.lock().unwrap()
.get_or_insert_with(ServerManager::new)
.find_mock_server_by_port_mut(mock_server_port as u16, &|mock_server| {
let mismatches = mock_server.mismatches().iter()
.map(|mismatch| mismatch.to_json() )
.collect::<Vec<serde_json::Value>>();
json!(mismatches).to_string()
})
}
/// Write Pact File Errors
pub enum WritePactFileErr {
/// IO Error occurred
IOError,
/// No mock server was running on the port
NoMockServer
}
/// 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 `None` is passed in, the current working directory is used.
/// If overwrite is true, the file will be overwritten with the contents of the current pact.
/// Otherwise it will be merged with any existing pact file.
///
/// Returns `Ok` if the pact file was successfully written. Returns an `Err` if the file can
/// not be written, or there is no mock server running on that port.
pub fn write_pact_file(
mock_server_port: i32,
directory: Option<String>,
overwrite: bool
) -> Result<(), WritePactFileErr> {
let opt_result = MANAGER.lock().unwrap()
.get_or_insert_with(ServerManager::new)
.find_mock_server_by_port_mut(mock_server_port as u16, &|mock_server| {
mock_server.write_pact(&directory, overwrite)
.map(|_| ())
.map_err(|err| {
log::error!("Failed to write pact to file - {}", err);
WritePactFileErr::IOError
})
});
match opt_result {
Some(result) => result,
None => {
log::error!("No mock server running on port {}", mock_server_port);
Err(WritePactFileErr::NoMockServer)
}
}
}
/// Shuts down the mock server with the provided port. Returns a boolean value to indicate if
/// the mock server was successfully shut down.
pub fn shutdown_mock_server(mock_server_port: i32) -> bool {
MANAGER.lock().unwrap()
.get_or_insert_with(ServerManager::new)
.shutdown_mock_server_by_port(mock_server_port as u16)
}
#[cfg(test)]
mod tests;