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 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
//! Utilities for setting up mock clients and test servers with similar features to `preroll::main!`.
//!
//! See [**preroll-example** on GitHub](https://github.com/eaze/preroll/tree/latest/preroll-example) for a full example of how to integrate test_utils for a service.
//!
//! ## Example:
//!
//! ```
//! use preroll::test_utils::{self, assert_status, TestResult};
//!
//! # #[allow(unused_mut)]
//! pub fn setup_routes(mut server: tide::Route<'_, std::sync::Arc<()>>) {
//! // Normally imported from your service's crate (lib.rs).
//! }
//!
//! #[async_std::main] // Would be #[async_std::test] instead.
//! async fn main() -> TestResult<()> {
//! let client = test_utils::create_client((), setup_routes).await.unwrap();
//!
//! let mut res = client.get("/monitor/ping").await.unwrap();
//!
//! let body = assert_status(&mut res, 200).await;
//! assert!(!body.is_empty());
//! Ok(())
//! }
//! ```
#![allow(clippy::unwrap_used)]
use std::convert::TryInto;
use std::env;
use std::fmt::Debug;
use std::sync::Arc;
use cfg_if::cfg_if;
use surf::{Client, Config, StatusCode, Url};
use tide::{http, Server};
use crate::builtins::monitor::setup_monitor;
use crate::logging::{log_format_json, log_format_pretty};
use crate::middleware::json_error::JsonError;
use crate::middleware::{JsonErrorMiddleware, LogMiddleware, RequestIdMiddleware};
use crate::VariadicRoutes;
#[cfg(feature = "honeycomb")]
use tracing_subscriber::Registry;
cfg_if! {
if #[cfg(feature = "postgres")] {
use async_std::sync::RwLock;
use sqlx::postgres::{PgConnectOptions, PgPoolOptions, Postgres};
use sqlx::ConnectOptions;
use tide::{Middleware, Next, Request};
use crate::middleware::postgres::{ConnectionWrap, ConnectionWrapInner};
}
}
/// The result type to use for tests.
///
/// This is a `surf::Result<T>`.
pub type TestResult<T> = surf::Result<T>;
/// Creates a test application with routes and mocks set up,
/// and hands back a client which is already connected to the server.
///
/// ## Example:
///
/// ```
/// use preroll::test_utils::{self, assert_status, TestResult};
///
/// # #[allow(unused_mut)]
/// pub fn setup_routes(mut server: tide::Route<'_, std::sync::Arc<()>>) {
/// // Normally imported from your service's crate (lib.rs).
/// }
///
/// #[async_std::main] // Would be #[async_std::test] instead.
/// async fn main() -> TestResult<()> {
/// let client = test_utils::create_client((), setup_routes).await.unwrap();
///
/// let mut res = client.get("/monitor/ping").await.unwrap();
///
/// let body = assert_status(&mut res, 200).await;
/// assert!(!body.is_empty());
/// Ok(())
/// }
/// ```
pub async fn create_client<State>(
state: State,
setup_routes_fns: impl Into<VariadicRoutes<State>>,
) -> TestResult<Client>
where
State: Send + Sync + 'static,
{
let server = create_server(state, setup_routes_fns)?;
let client: Client = Config::new()
.set_http_client(server)
.set_base_url(Url::parse("http://localhost:8080")?) // Address not actually used.
.try_into()?;
Ok(client)
}
/// Creates a test application with routes and mocks set up,
/// and hands back a client which is already connected to the server.
///
/// This function also hands back a postgres transaction connection which is
/// being used for the rest of the application, allowing easy rollback of everything.
///
/// ## Default database
///
/// By default, preroll's postgres test functionality will try to connect to a database on
/// `localhost` with a name matching `{crate_name}-test`, on the default postgres port `5432`.
///
/// If necessary, the following env variable overrides are available:
/// - `TEST_DATABASE_HOST`: Set the test database hostname.
/// - `TEST_DATABASE_PORT`: Set the test database port.
/// - `TEST_DATABASE_NAME`: Set the test database name.
///
/// If the crate name cannot be found from `CARGO_PKG_NAME`, then the name `database_test` will be used.
///
/// ## Important!
///
/// The `RwLockWriteGuard` returned from `pg_conn.write().await` MUST be [dropped][] before running
/// the test cases, or else there will be a writer conflict and the test will hang indefinitely.
///
/// ## Example:
///
/// ```no_run
/// use preroll::test_utils::{self, TestResult};
///
/// # #[allow(unused_mut)]
/// pub fn setup_routes(mut server: tide::Route<'_, std::sync::Arc<()>>) {
/// // Normally imported from your service's crate (lib.rs).
/// }
///
/// #[async_std::main] // Would be #[async_std::test] instead.
/// async fn main() -> TestResult<()> {
/// let (client, pg_conn) = test_utils::create_client_and_postgres((), setup_routes).await.unwrap();
///
/// {
/// # #[allow(unused_mut)]
/// let mut pg_conn = pg_conn.write().await;
///
/// // ... (test setup) ...
///
/// // The RwLockWriteGuard here MUST be dropped before running the test cases,
/// // or else there is a writer conflict and the test hangs indefinitely.
/// //
/// // Note: this is done automatically at the end of the closure.
/// // We are still explicitly dropping so as to avoid accidentally messing this up in the future.
/// std::mem::drop(pg_conn);
/// }
///
/// // ... (test cases) ...
///
/// Ok(())
/// }
/// ```
///
/// [dropped]: https://doc.rust-lang.org/reference/destructors.html
#[cfg(feature = "postgres")]
#[cfg_attr(feature = "docs", doc(cfg(feature = "postgres")))]
pub async fn create_client_and_postgres<State>(
state: State,
setup_routes_fns: impl Into<VariadicRoutes<State>>,
) -> TestResult<(Client, Arc<RwLock<ConnectionWrapInner<Postgres>>>)>
where
State: Send + Sync + 'static,
{
let mut server = create_server(state, setup_routes_fns)?;
// Fake PostgresConnectionMiddleware.
//
// We do this so that all connections within any test run can share the same Transaction and be rolled back on Drop.
let mut connect_opts = PgConnectOptions::new()
.host(
env::var("TEST_DATABASE_HOST")
.as_deref()
.unwrap_or("localhost"),
)
.port(
env::var("TEST_DATABASE_PORT")
.ok()
.map(|v| v.parse())
.transpose()?
.unwrap_or(5432),
)
.database(
env::var("TEST_DATABASE_NAME")
.or_else(|_| env::var("CARGO_PKG_NAME").map(|v| format!("{}-test", v)))
.as_deref()
.unwrap_or("database_test"),
);
connect_opts.log_statements(log::LevelFilter::Debug);
let pg_pool = PgPoolOptions::new()
.max_connections(5)
.connect_with(connect_opts)
.await?;
let conn_wrap = Arc::new(RwLock::new(ConnectionWrapInner::Transacting(
pg_pool.begin().await?,
)));
server.with(PostgresTestMiddleware(conn_wrap.clone()));
let client: Client = Config::new()
.set_http_client(server)
.set_base_url(Url::parse("http://localhost:8080")?) // Address not actually used.
.try_into()?;
Ok((client, conn_wrap))
}
#[allow(clippy::unnecessary_wraps)]
pub(crate) fn create_server<State>(
state: State,
setup_routes_fns: impl Into<VariadicRoutes<State>>,
) -> TestResult<Server<Arc<State>>>
where
State: Send + Sync + 'static,
{
dotenv::dotenv().ok();
let log_level: log::LevelFilter = env::var("LOGLEVEL")
.map(|v| v.parse().expect("LOGLEVEL must be a valid log level."))
.unwrap_or(log::LevelFilter::Off);
let environment = env::var("ENVIRONMENT").unwrap_or_else(|_| "development".to_string());
if environment.starts_with("prod") {
// Like Production
env_logger::builder()
.format(log_format_json)
.filter_level(log_level)
.write_style(env_logger::WriteStyle::Never)
.try_init()
.ok();
} else {
// Like Development
env_logger::builder()
.format(log_format_pretty)
.filter_level(log_level)
.try_init()
.ok();
}
#[cfg(feature = "honeycomb")]
{
let subscriber = Registry::default();
// .with(tracing_subscriber::fmt::Layer::default()) // log to stdout
tracing::subscriber::set_global_default(subscriber).ok();
}
let mut server = tide::with_state(Arc::new(state));
server.with(RequestIdMiddleware::new());
server.with(LogMiddleware::new());
server.with(JsonErrorMiddleware::new());
setup_monitor("preroll_test_utils", &mut server);
let mut version = 1;
for routes_fn in setup_routes_fns.into().routes {
routes_fn(server.at(&format!("/api/v{}", version)));
version += 1;
}
Ok(server)
}
#[cfg(feature = "postgres")]
#[cfg_attr(feature = "docs", doc(cfg(feature = "postgres")))]
#[derive(Debug, Clone)]
struct PostgresTestMiddleware(ConnectionWrap<Postgres>);
#[cfg(feature = "postgres")]
#[tide::utils::async_trait]
impl<State: Clone + Send + Sync + 'static> Middleware<State> for PostgresTestMiddleware {
async fn handle(&self, mut req: Request<State>, next: Next<'_, State>) -> tide::Result {
req.set_ext(self.0.clone());
Ok(next.run(req).await)
}
}
/// Creates a mock client directly connected to a server which is setup by the provided function.
///
/// ## Example:
/// ```
/// use preroll::test_utils;
/// use tide::Server;
///
/// fn setup_example_local_org_mocks(mock: &mut Server<()>) {
/// mock.at("hello-world").get(|_| async { Ok("Hello World!") });
/// }
///
/// #[async_std::main]
/// async fn main() {
/// let client = test_utils::mock_client("http://api.example_local.org/", setup_example_local_org_mocks);
///
/// let response = client
/// .get("http://api.example_local.org/hello-world")
/// .recv_string()
/// .await
/// .unwrap();
///
/// assert_eq!(response, "Hello World!");
/// }
/// ```
pub fn mock_client<MocksFn>(base_url: impl AsRef<str>, setup_mocks_fn: MocksFn) -> Client
where
MocksFn: Fn(&mut Server<()>),
{
let mut mocks_server = tide::new();
setup_mocks_fn(&mut mocks_server);
let mock_client: Client = Config::new()
.set_http_client(mocks_server)
.set_base_url(Url::parse(base_url.as_ref()).unwrap())
.try_into()
.expect("async-h1 client from config is infallible");
mock_client
}
/// A test helper to check all fields of a [`JsonError`][crate::JsonError].
///
/// ## Example:
///
/// ```
/// use preroll::test_utils::{self, assert_json_error, TestResult};
///
/// # #[allow(unused_mut)]
/// pub fn setup_routes(mut server: tide::Route<'_, std::sync::Arc<()>>) {
/// // Normally imported from your service's crate (lib.rs).
/// }
///
/// #[async_std::main] // Would be #[async_std::test] instead.
/// async fn main() -> TestResult<()> {
/// let client = test_utils::create_client((), setup_routes).await.unwrap();
///
/// let mut res = client.get("/not_found").await.unwrap();
///
/// assert_json_error(
/// &mut res,
/// 404,
/// "(no additional context)",
/// )
/// .await;
///
/// Ok(())
/// }
/// ```
#[allow(dead_code)] // Not actually dead code. (??)
#[track_caller]
pub async fn assert_json_error<Status>(
mut res: impl AsMut<http::Response>,
status: Status,
err_msg: &str,
) where
Status: TryInto<StatusCode>,
Status::Error: Debug,
{
let res = res.as_mut();
let status: StatusCode = status
.try_into()
.expect("test must specify valid status code");
let str_response = res.body_string().await.unwrap();
let error: JsonError = serde_json::from_str(&str_response).map_err(|e| {
surf::Error::from_str(
res.status(),
format!("Error, could not parse Response into JsonError! json err: \"{}\", response body: \"{}\"", e, str_response)
)
}).unwrap();
assert_eq!(res.status(), status);
assert_eq!(&error.title, status.canonical_reason());
assert_eq!(error.message, err_msg);
assert_eq!(error.status, status as u16);
assert_eq!(
error.request_id.as_str(),
res["X-Request-Id"].last().as_str()
);
if res.status().is_server_error() {
assert_eq!(
error
.correlation_id
.expect("Internal server errors must have correlation ids.")
.as_str(),
res["X-Correlation-Id"].last().as_str()
);
} else {
assert_eq!(error.correlation_id, None);
assert!(res.header("X-Correlation-Id").is_none());
}
}
/// Assert that a response has a status code and parse out the body to JSON if possible.
///
/// This helper has better assertion failure messages than doing this manually.
///
/// ## Example:
///
/// ```
/// use preroll::test_utils::{self, assert_status_json, TestResult};
/// use preroll::JsonError;
///
/// # #[allow(unused_mut)]
/// pub fn setup_routes(mut server: tide::Route<'_, std::sync::Arc<()>>) {
/// // Normally imported from your service's crate (lib.rs).
/// }
///
/// #[async_std::main] // Would be #[async_std::test] instead.
/// async fn main() -> TestResult<()> {
/// let client = test_utils::create_client((), setup_routes).await.unwrap();
///
/// let mut res = client.get("/not_found").await.unwrap();
///
/// let json: JsonError = assert_status_json(&mut res, 404).await;
/// assert_eq!(&json.title, res.status().canonical_reason());
///
/// Ok(())
/// }
/// ```
#[track_caller]
pub async fn assert_status_json<StructType, Status>(
mut res: impl AsMut<http::Response>,
status: Status,
) -> StructType
where
StructType: serde::de::DeserializeOwned,
Status: TryInto<StatusCode>,
Status::Error: Debug,
{
let res = res.as_mut();
let status: StatusCode = status
.try_into()
.expect("test must specify valid status code");
let body = res.body_string().await.unwrap();
assert_eq!(res.status(), status, "Response body: {}", body);
serde_json::from_str(&body).unwrap_or_else(|err| {
panic!(
"Error: \"{}\" Body was not parseable into a {}, body was: \"{}\"",
err,
std::any::type_name::<StructType>(),
body
)
})
}
/// Assert that a response has a specified status code and return the body as a string.
///
/// This helper has better assertion failure messages than doing this manually.
///
/// ## Example:
///
/// ```
/// use preroll::test_utils::{self, assert_status, TestResult};
///
/// # #[allow(unused_mut)]
/// pub fn setup_routes(mut server: tide::Route<'_, std::sync::Arc<()>>) {
/// // Normally imported from your service's crate (lib.rs).
/// }
///
/// #[async_std::main] // Would be #[async_std::test] instead.
/// async fn main() -> TestResult<()> {
/// let client = test_utils::create_client((), setup_routes).await.unwrap();
///
/// let mut res = client.get("/monitor/ping").await.unwrap();
///
/// let body = assert_status(&mut res, 200).await;
/// assert!(body.contains("-"));
/// Ok(())
/// }
/// ```
#[track_caller]
pub async fn assert_status<Status>(mut res: impl AsMut<http::Response>, status: Status) -> String
where
Status: TryInto<StatusCode>,
Status::Error: Debug,
{
let res = res.as_mut();
let status: StatusCode = status
.try_into()
.expect("test must specify valid status code");
let body = res.body_string().await.unwrap();
assert_eq!(res.status(), status, "Response body: {}", body);
body
}