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 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
//! A collection of different matching strategies provided out-of-the-box by `wiremock`.
//!
//! If the set of matchers provided out-of-the-box is not enough for your specific testing needs
//! you can implement your own thanks to the [`Match`] trait.
//!
//! Furthermore, `Fn` closures that take an immutable [`Request`] reference as input and return a boolean
//! as input automatically implement [`Match`] and can be used where a matcher is expected.
//!
//! Check [`Match`]'s documentation for examples.
use crate::{Match, Request};
use http_types::headers::{HeaderName, HeaderValue, HeaderValues};
use http_types::Method;
use log::debug;
use regex::Regex;
use serde::Serialize;
use std::convert::TryInto;
use std::str;
/// Implement the `Match` trait for all closures, out of the box,
/// if their signature is compatible.
impl<F> Match for F
where
F: Fn(&Request) -> bool,
F: Send + Sync,
{
fn matches(&self, request: &Request) -> bool {
// Just call the closure itself!
self(request)
}
}
#[derive(Debug)]
/// Match **exactly** the method of a request.
///
/// ### Example:
/// ```rust
/// use wiremock::{MockServer, Mock, ResponseTemplate};
/// use wiremock::matchers::method;
///
/// #[async_std::main]
/// async fn main() {
/// // Arrange
/// let mock_server = MockServer::start().await;
///
/// let response = ResponseTemplate::new(200);
/// let mock = Mock::given(method("GET")).respond_with(response);
///
/// mock_server.register(mock).await;
///
/// // Act
/// let status = surf::get(&mock_server.uri())
/// .await
/// .unwrap()
/// .status();
///
/// // Assert
/// assert_eq!(status, 200);
/// }
/// ```
pub struct MethodExactMatcher(Method);
/// Shorthand for [`MethodExactMatcher::new`].
pub fn method<T>(method: T) -> MethodExactMatcher
where
T: TryInto<Method>,
<T as TryInto<Method>>::Error: std::fmt::Debug,
{
MethodExactMatcher::new(method)
}
impl MethodExactMatcher {
pub fn new<T>(method: T) -> Self
where
T: TryInto<Method>,
<T as TryInto<Method>>::Error: std::fmt::Debug,
{
let method = method
.try_into()
.expect("Failed to convert to HTTP method.");
Self(method)
}
}
impl Match for MethodExactMatcher {
fn matches(&self, request: &Request) -> bool {
request.method == self.0
}
}
#[derive(Debug)]
/// Match all incoming requests, regardless of their method, path, headers or body.
///
/// You can use it to verify that a request has been fired towards the server, without making
/// any other assertion about it.
///
/// ### Example:
/// ```rust
/// use wiremock::{MockServer, Mock, ResponseTemplate};
/// use wiremock::matchers::any;
///
/// #[async_std::main]
/// async fn main() {
/// // Arrange
/// let mock_server = MockServer::start().await;
///
/// let response = ResponseTemplate::new(200);
/// // Respond with a `200 OK` to all requests hitting
/// // the mock server
/// let mock = Mock::given(any()).respond_with(response);
///
/// mock_server.register(mock).await;
///
/// // Act
/// let status = surf::get(&mock_server.uri())
/// .await
/// .unwrap()
/// .status();
///
/// // Assert
/// assert_eq!(status, 200);
/// }
/// ```
pub struct AnyMatcher;
/// Shorthand for [`AnyMatcher`].
pub fn any() -> AnyMatcher {
AnyMatcher
}
impl Match for AnyMatcher {
fn matches(&self, _request: &Request) -> bool {
true
}
}
#[derive(Debug)]
/// Match **exactly** the path of a request.
///
/// ### Example:
/// ```rust
/// use wiremock::{MockServer, Mock, ResponseTemplate};
/// use wiremock::matchers::path;
///
/// #[async_std::main]
/// async fn main() {
/// // Arrange
/// let mock_server = MockServer::start().await;
///
/// let response = ResponseTemplate::new(200).set_body_string("world");
/// let mock = Mock::given(path("/hello")).respond_with(response);
///
/// mock_server.register(mock).await;
///
/// // Act
/// let status = surf::get(format!("{}/hello", &mock_server.uri()))
/// .await
/// .unwrap()
/// .status();
///
/// // Assert
/// assert_eq!(status, 200);
/// }
/// ```
///
/// ### Example:
///
/// The path matcher ignores query parameters:
///
/// ```rust
/// use wiremock::{MockServer, Mock, ResponseTemplate};
/// use wiremock::matchers::path;
///
/// #[async_std::main]
/// async fn main() {
/// // Arrange
/// let mock_server = MockServer::start().await;
///
/// let response = ResponseTemplate::new(200).set_body_string("world");
/// let mock = Mock::given(path("/hello")).respond_with(response);
///
/// mock_server.register(mock).await;
///
/// // Act
/// let status = surf::get(format!("{}/hello?a_parameter=some_value", &mock_server.uri()))
/// .await
/// .unwrap()
/// .status();
///
/// // Assert
/// assert_eq!(status, 200);
/// }
/// ```
pub struct PathExactMatcher(String);
/// Shorthand for [`PathExactMatcher::new`].
pub fn path<T>(path: T) -> PathExactMatcher
where
T: Into<String>,
{
PathExactMatcher::new(path)
}
impl PathExactMatcher {
pub fn new<T: Into<String>>(path: T) -> Self {
let path = path.into();
// Prepend "/" to the path if missing.
if path.starts_with('/') {
Self(path)
} else {
Self(format!("/{}", path))
}
}
}
impl Match for PathExactMatcher {
fn matches(&self, request: &Request) -> bool {
request.url.path() == self.0
}
}
#[derive(Debug)]
/// Match the path of a request against a regular expression.
///
/// ### Example:
/// ```rust
/// use wiremock::{MockServer, Mock, ResponseTemplate};
/// use wiremock::matchers::path_regex;
///
/// #[async_std::main]
/// async fn main() {
/// // Arrange
/// let mock_server = MockServer::start().await;
///
/// let response = ResponseTemplate::new(200).set_body_string("world");
/// let mock = Mock::given(path_regex(r"^/hello/\d{3}$")).respond_with(response);
///
/// mock_server.register(mock).await;
///
/// // Act
/// let status = surf::get(format!("{}/hello/123", &mock_server.uri()))
/// .await
/// .unwrap()
/// .status();
///
/// // Assert
/// assert_eq!(status, 200);
/// }
/// ```
///
/// ### Example:
/// ```rust
/// use wiremock::{MockServer, Mock, ResponseTemplate};
/// use wiremock::matchers::path_regex;
///
/// #[async_std::main]
/// async fn main() {
/// // Arrange
/// let mock_server = MockServer::start().await;
///
/// let response = ResponseTemplate::new(200).set_body_string("world");
/// let mock = Mock::given(path_regex(r"^/users/[a-z0-9-~_]{1,}/posts$")).respond_with(response);
///
/// mock_server.register(mock).await;
///
/// // Act
/// let status = surf::get(format!("{}/users/da2854ea-b70f-46e7-babc-2846eff4d33c/posts", &mock_server.uri()))
/// .await
/// .unwrap()
/// .status();
///
/// // Assert
/// assert_eq!(status, 200);
/// }
/// ```
pub struct PathRegexMatcher(Regex);
/// Shorthand for [`PathRegexMatcher::new`].
pub fn path_regex<T>(path: T) -> PathRegexMatcher
where
T: Into<String>,
{
PathRegexMatcher::new(path)
}
impl PathRegexMatcher {
pub fn new<T: Into<String>>(path: T) -> Self {
let path = path.into();
Self(Regex::new(&path).expect("Failed to create regex for path matcher"))
}
}
impl Match for PathRegexMatcher {
fn matches(&self, request: &Request) -> bool {
self.0.is_match(request.url.path())
}
}
#[derive(Debug)]
/// Match **exactly** the header of a request.
///
/// ### Example:
/// ```rust
/// use wiremock::{MockServer, Mock, ResponseTemplate};
/// use wiremock::matchers::{header, headers};
///
/// #[async_std::main]
/// async fn main() {
/// // Arrange
/// let mock_server = MockServer::start().await;
///
/// Mock::given(header("custom", "header"))
/// .and(headers("cache-control", vec!["no-cache", "no-store"]))
/// .respond_with(ResponseTemplate::new(200))
/// .mount(&mock_server)
/// .await;
///
/// // Act
/// let status = surf::get(&mock_server.uri())
/// .header("custom", "header")
/// .header("cache-control", "no-cache, no-store")
/// .await
/// .unwrap()
/// .status();
///
/// // Assert
/// assert_eq!(status, 200);
/// }
/// ```
pub struct HeaderExactMatcher(HeaderName, HeaderValues);
/// Shorthand for [`HeaderExactMatcher::new`].
pub fn header<K, V>(key: K, value: V) -> HeaderExactMatcher
where
K: TryInto<HeaderName>,
<K as TryInto<HeaderName>>::Error: std::fmt::Debug,
V: TryInto<HeaderValue>,
<V as TryInto<HeaderValue>>::Error: std::fmt::Debug,
{
HeaderExactMatcher::new(key, value.try_into().map(HeaderValues::from).unwrap())
}
/// Shorthand for [`HeaderExactMatcher::new`] supporting multi valued headers.
pub fn headers<K, V>(key: K, values: Vec<V>) -> HeaderExactMatcher
where
K: TryInto<HeaderName>,
<K as TryInto<HeaderName>>::Error: std::fmt::Debug,
V: TryInto<HeaderValue>,
<V as TryInto<HeaderValue>>::Error: std::fmt::Debug,
{
let values = values
.into_iter()
.filter_map(|v| v.try_into().ok())
.collect::<HeaderValues>();
HeaderExactMatcher::new(key, values)
}
impl HeaderExactMatcher {
pub fn new<K, V>(key: K, value: V) -> Self
where
K: TryInto<HeaderName>,
<K as TryInto<HeaderName>>::Error: std::fmt::Debug,
V: TryInto<HeaderValues>,
<V as TryInto<HeaderValues>>::Error: std::fmt::Debug,
{
let key = key.try_into().expect("Failed to convert to header name.");
let value = value
.try_into()
.expect("Failed to convert to header value.");
Self(key, value)
}
}
impl Match for HeaderExactMatcher {
fn matches(&self, request: &Request) -> bool {
match request.headers.get(&self.0) {
None => false,
Some(values) => {
let headers: Vec<&str> = self.1.iter().map(HeaderValue::as_str).collect();
values.eq(headers.as_slice())
}
}
}
}
#[derive(Debug)]
/// Match **exactly** the header name of a request. It checks that the
/// header is present but does not validate the value.
///
/// ### Example:
/// ```rust
/// use wiremock::{MockServer, Mock, ResponseTemplate};
/// use wiremock::matchers::header;
///
/// #[async_std::main]
/// async fn main() {
/// // Arrange
/// use wiremock::matchers::header_exists;
/// let mock_server = MockServer::start().await;
///
/// Mock::given(header_exists("custom"))
/// .respond_with(ResponseTemplate::new(200))
/// .mount(&mock_server)
/// .await;
///
/// // Act
/// let status = surf::get(&mock_server.uri())
/// .header("custom", "header")
/// .await
/// .unwrap()
/// .status();
///
/// // Assert
/// assert_eq!(status, 200);
/// }
/// ```
pub struct HeaderExistsMatcher(HeaderName);
/// Shorthand for [`HeaderExistsMatcher::new`].
pub fn header_exists<K>(key: K) -> HeaderExistsMatcher
where
K: TryInto<HeaderName>,
<K as TryInto<HeaderName>>::Error: std::fmt::Debug,
{
HeaderExistsMatcher::new(key)
}
impl HeaderExistsMatcher {
pub fn new<K>(key: K) -> Self
where
K: TryInto<HeaderName>,
<K as TryInto<HeaderName>>::Error: std::fmt::Debug,
{
let key = key.try_into().expect("Failed to convert to header name.");
Self(key)
}
}
impl Match for HeaderExistsMatcher {
fn matches(&self, request: &Request) -> bool {
request.headers.get(&self.0).is_some()
}
}
#[derive(Debug)]
/// Match **exactly** the body of a request.
///
/// ### Example (string):
/// ```rust
/// use wiremock::{MockServer, Mock, ResponseTemplate};
/// use wiremock::matchers::body_string;
///
/// #[async_std::main]
/// async fn main() {
/// // Arrange
/// let mock_server = MockServer::start().await;
///
/// Mock::given(body_string("hello world!"))
/// .respond_with(ResponseTemplate::new(200))
/// .mount(&mock_server)
/// .await;
///
/// // Act
/// let status = surf::post(&mock_server.uri())
/// .body("hello world!")
/// .await
/// .unwrap()
/// .status();
///
/// // Assert
/// assert_eq!(status, 200);
/// }
/// ```
///
/// ### Example (json):
/// ```rust
/// use wiremock::{MockServer, Mock, ResponseTemplate};
/// use wiremock::matchers::body_json;
/// use serde_json::json;
///
/// #[async_std::main]
/// async fn main() {
/// // Arrange
/// let mock_server = MockServer::start().await;
///
/// let expected_body = json!({
/// "hello": "world!"
/// });
/// Mock::given(body_json(&expected_body))
/// .respond_with(ResponseTemplate::new(200))
/// .mount(&mock_server)
/// .await;
///
/// // Act
/// let status = surf::post(&mock_server.uri())
/// .body(expected_body)
/// .await
/// .unwrap()
/// .status();
///
/// // Assert
/// assert_eq!(status, 200);
/// }
/// ```
pub struct BodyExactMatcher(Vec<u8>);
impl BodyExactMatcher {
/// Specify the expected body as a string.
pub fn string<T: Into<String>>(body: T) -> Self {
let body = body.into();
Self(body.as_bytes().into())
}
/// Specify the expected body as a vector of bytes.
pub fn bytes<T: Into<Vec<u8>>>(body: T) -> Self {
let body = body.into();
Self(body)
}
/// Specify something JSON-serializable as the expected body.
pub fn json<T: Serialize>(body: T) -> Self {
let body = serde_json::to_vec(&body).expect("Failed to serialise body");
Self(body)
}
}
/// Shorthand for [`BodyExactMatcher::json`].
pub fn body_json<T>(body: T) -> BodyExactMatcher
where
T: Serialize,
{
BodyExactMatcher::json(body)
}
/// Shorthand for [`BodyExactMatcher::string`].
pub fn body_string<T>(body: T) -> BodyExactMatcher
where
T: Into<String>,
{
BodyExactMatcher::string(body)
}
/// Shorthand for [`BodyExactMatcher::bytes`].
pub fn body_bytes<T>(body: T) -> BodyExactMatcher
where
T: Into<Vec<u8>>,
{
BodyExactMatcher::bytes(body)
}
impl Match for BodyExactMatcher {
fn matches(&self, request: &Request) -> bool {
request.body == self.0
}
}
#[derive(Debug)]
/// Match part of the body of a request.
///
/// ### Example (string):
/// ```rust
/// use wiremock::{MockServer, Mock, ResponseTemplate};
/// use wiremock::matchers::body_string_contains;
///
/// #[async_std::main]
/// async fn main() {
/// // Arrange
/// let mock_server = MockServer::start().await;
///
/// Mock::given(body_string_contains("hello world"))
/// .respond_with(ResponseTemplate::new(200))
/// .mount(&mock_server)
/// .await;
///
/// // Act
/// let status = surf::post(&mock_server.uri())
/// .body("this is a hello world example!")
/// .await
/// .unwrap()
/// .status();
///
/// // Assert
/// assert_eq!(status, 200);
/// }
/// ```
pub struct BodyContainsMatcher(Vec<u8>);
impl BodyContainsMatcher {
/// Specify the part of the body that should be matched as a string.
pub fn string<T: Into<String>>(body: T) -> Self {
Self(body.into().as_bytes().into())
}
}
/// Shorthand for [`BodyContainsMatcher::string`].
pub fn body_string_contains<T>(body: T) -> BodyContainsMatcher
where
T: Into<String>,
{
BodyContainsMatcher::string(body)
}
impl Match for BodyContainsMatcher {
fn matches(&self, request: &Request) -> bool {
let body = match str::from_utf8(&request.body) {
Ok(body) => body.to_string(),
Err(err) => {
debug!("can't convert body from byte slice to string: {}", err);
return false;
}
};
let part = match str::from_utf8(&self.0) {
Ok(part) => part,
Err(err) => {
debug!(
"can't convert expected part from byte slice to string: {}",
err
);
return false;
}
};
body.contains(part)
}
}
#[derive(Debug)]
/// Match **exactly** the query parameter of a request.
///
/// ### Example:
/// ```rust
/// use wiremock::{MockServer, Mock, ResponseTemplate};
/// use wiremock::matchers::query_param;
///
/// #[async_std::main]
/// async fn main() {
/// // Arrange
/// let mock_server = MockServer::start().await;
///
/// Mock::given(query_param("hello", "world"))
/// .respond_with(ResponseTemplate::new(200))
/// .mount(&mock_server)
/// .await;
///
/// // Act
/// let status = surf::get(format!("{}?hello=world", &mock_server.uri()))
/// .await
/// .unwrap()
/// .status();
///
/// // Assert
/// assert_eq!(status, 200);
/// }
/// ```
pub struct QueryParamExactMatcher(String, String);
impl QueryParamExactMatcher {
/// Specify the expected value for a query parameter.
pub fn new<K: Into<String>, V: Into<String>>(key: K, value: V) -> Self {
let key = key.into();
let value = value.into();
Self(key, value)
}
}
/// Shorthand for [`QueryParamExactMatcher::new`].
pub fn query_param<K, V>(key: K, value: V) -> QueryParamExactMatcher
where
K: Into<String>,
V: Into<String>,
{
QueryParamExactMatcher::new(key, value)
}
impl Match for QueryParamExactMatcher {
fn matches(&self, request: &Request) -> bool {
request
.url
.query_pairs()
.any(|q| q.0 == self.0.as_str() && q.1 == self.1.as_str())
}
}
/// Match an incoming request if its body is encoded as JSON and can be deserialized
/// according to the specified schema.
///
/// ### Example:
/// ```rust
/// use wiremock::{MockServer, Mock, ResponseTemplate};
/// use wiremock::matchers::body_json_schema;
/// use serde_json::json;
/// use serde::{Deserialize, Serialize};
///
/// // The schema we expect the body to conform to.
/// #[derive(Deserialize, Serialize)]
/// struct Greeting {
/// hello: String,
/// }
///
/// #[async_std::main]
/// async fn main() {
/// // Arrange
/// let mock_server = MockServer::start().await;
///
/// Mock::given(body_json_schema::<Greeting>)
/// .respond_with(ResponseTemplate::new(200))
/// .mount(&mock_server)
/// .await;
///
/// // Both JSON objects have the same fields,
/// // therefore they'll match.
/// let success_cases = vec![
/// json!({"hello": "world!"}),
/// json!({"hello": "everyone!"}),
/// ];
/// for case in success_cases.into_iter() {
/// let status = surf::post(&mock_server.uri())
/// .body(case)
/// .await
/// .unwrap()
/// .status();
///
/// // Assert
/// assert_eq!(status, 200);
/// }
///
/// // This JSON object cannot be deserialized as `Greeting`
/// // because it does not have the `hello` field.
/// // It won't match.
/// let failure_case = json!({"world": "hello!"});
/// let status = surf::post(&mock_server.uri())
/// .body(failure_case)
/// .await
/// .unwrap()
/// .status();
///
/// // Assert
/// assert_eq!(status, 404);
/// }
/// ```
pub fn body_json_schema<T>(request: &Request) -> bool
where
for<'de> T: serde::de::Deserialize<'de>,
{
serde_json::from_slice::<T>(&request.body).is_ok()
}