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 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
#![warn(missing_docs)] #![doc( html_logo_url = "https://raw.githubusercontent.com/lipanski/mockito/master/docs/logo-black.png" )] //! //! Mockito is a library for creating HTTP mocks to be used in integration tests or for offline work. //! It runs an HTTP server on a local port which delivers, creates and remove the mocks. //! //! The server is run on a separate thread within the same process and will be removed //! at the end of the run. //! //! # Getting Started //! //! Using compiler flags, set the URL of your web client to address returned by `mockito::server_url()` or `mockito::server_address()`. //! //! ## Example //! //! ``` //! #[cfg(test)] //! use mockito; //! //! #[cfg(not(test))] //! let url = "https://api.twitter.com"; //! //! #[cfg(test)] //! let url = &mockito::server_url(); //! ``` //! //! Then start mocking: //! //! ## Example //! //! ``` //! #[cfg(test)] //! mod tests { //! use mockito::mock; //! //! #[test] //! fn test_something() { //! let _m = mock("GET", "/hello") //! .with_status(201) //! .with_header("content-type", "text/plain") //! .with_header("x-api-key", "1234") //! .with_body("world") //! .create(); //! //! // Any calls to GET /hello beyond this line will respond with 201, the //! // `content-type: text/plain` header and the body "world". //! } //! } //! ``` //! //! # Lifetime //! //! Just like any Rust object, a mock is available only through its lifetime. You'll want to assign //! the mocks to variables in order to extend and control their lifetime. //! //! Avoid using the underscore matcher when creating your mocks, as in `let _ = mock("GET", "/")`. //! This will end your mock's lifetime immediately. You can still use the underscore to prefix your variable //! names in an assignment, but don't limit it to just this one character. //! //! ## Example //! //! ``` //! use mockito::mock; //! //! let _m1 = mock("GET", "/long").with_body("hello").create(); //! //! { //! let _m2 = mock("GET", "/short").with_body("hi").create(); //! //! // Requests to GET /short will be mocked til here //! } //! //! // Requests to GET /long will be mocked til here //! ``` //! //! # Limitations //! //! Creating mocks from threads is currently not possible. Please use the main (test) thread for that. //! See the note on threads at the end for more details. //! //! # Asserts //! //! You can use the `Mock::assert` method to **assert that a mock was called**. In other words, the //! `Mock#assert` method can validate that your code performed the expected HTTP requests. //! //! By default, the method expects that only one request to your mock was triggered. //! //! ## Example //! //! ```no_run //! use std::net::TcpStream; //! use std::io::{Read, Write}; //! use mockito::{mock, server_address}; //! //! let mock = mock("GET", "/hello").create(); //! //! { //! // Place a request //! let mut stream = TcpStream::connect(server_address()).unwrap(); //! stream.write_all("GET /hello HTTP/1.1\r\n\r\n".as_bytes()).unwrap(); //! let mut response = String::new(); //! stream.read_to_string(&mut response).unwrap(); //! stream.flush().unwrap(); //! } //! //! mock.assert(); //! ``` //! //! When several mocks can match a request, Mockito applies the first one that still expects requests. //! You can use this behaviour to provide **different responses for subsequent requests to the same endpoint**. //! //! ## Example //! //! ``` //! use std::net::TcpStream; //! use std::io::{Read, Write}; //! use mockito::{mock, server_address}; //! //! let english_hello_mock = mock("GET", "/hello").with_body("good bye").create(); //! let french_hello_mock = mock("GET", "/hello").with_body("au revoir").create(); //! //! { //! // Place a request to GET /hello //! let mut stream = TcpStream::connect(server_address()).unwrap(); //! stream.write_all("GET /hello HTTP/1.1\r\n\r\n".as_bytes()).unwrap(); //! let mut response = String::new(); //! stream.read_to_string(&mut response).unwrap(); //! stream.flush().unwrap(); //! } //! //! english_hello_mock.assert(); //! //! { //! // Place another request to GET /hello //! let mut stream = TcpStream::connect(server_address()).unwrap(); //! stream.write_all("GET /hello HTTP/1.1\r\n\r\n".as_bytes()).unwrap(); //! let mut response = String::new(); //! stream.read_to_string(&mut response).unwrap(); //! stream.flush().unwrap(); //! } //! //! french_hello_mock.assert(); //! ``` //! //! If you're expecting more than 1 request, you can use the `Mock::expect` method to specify the exact amount of requests: //! //! ## Example //! //! ```no_run //! use std::net::TcpStream; //! use std::io::{Read, Write}; //! use mockito::{mock, server_address}; //! //! let mock = mockito::mock("GET", "/hello").expect(3).create(); //! //! for _ in 0..3 { //! // Place a request //! let mut stream = TcpStream::connect(server_address()).unwrap(); //! stream.write_all("GET /hello HTTP/1.1\r\n\r\n".as_bytes()).unwrap(); //! let mut response = String::new(); //! stream.read_to_string(&mut response).unwrap(); //! stream.flush().unwrap(); //! } //! //! mock.assert(); //! ``` //! //! You can also work with ranges, by using the `Mock::expect_at_least` and `Mock::expect_at_most` methods: //! //! ## Example //! //! ```no_run //! use std::net::TcpStream; //! use std::io::{Read, Write}; //! use mockito::{mock, server_address}; //! //! let mock = mockito::mock("GET", "/hello").expect_at_least(2).expect_at_most(4).create(); //! //! for _ in 0..3 { //! // Place a request //! let mut stream = TcpStream::connect(server_address()).unwrap(); //! stream.write_all("GET /hello HTTP/1.1\r\n\r\n".as_bytes()).unwrap(); //! let mut response = String::new(); //! stream.read_to_string(&mut response).unwrap(); //! stream.flush().unwrap(); //! } //! //! mock.assert(); //! ``` //! //! The errors produced by the `assert` method contain information about the tested mock, but also about the //! **last unmatched request**, which can be very useful to track down an error in your implementation or //! a missing or incomplete mock. A colored diff is also displayed. //! //! Color output is enabled by default, but can be toggled with the `color` feature flag. //! //! Here's an example of how a `Mock#assert` error looks like: //! //! ```text //! > Expected 1 request(s) to: //! //! POST /users?number=one //! bob //! //! ...but received 0 //! //! > The last unmatched request was: //! //! POST /users?number=two //! content-length: 5 //! alice //! //! > Difference: //! //! # A colored diff //! //! ``` //! //! # Matchers //! //! Mockito can match your request by method, path, query, headers or body. //! //! Various matchers are provided by the `Matcher` type: exact, partial (regular expressions), any or missing. //! //! # Matching by path //! //! By default, the request path is compared by its exact value: //! //! ## Example //! //! ``` //! use mockito::mock; //! //! // Matched only calls to GET /hello //! let _m = mock("GET", "/hello").create(); //! ``` //! //! You can also match the path partially, by using a regular expression: //! //! ## Example //! //! ``` //! use mockito::{mock, Matcher}; //! //! // Will match calls to GET /hello/1 and GET /hello/2 //! let _m = mock("GET", Matcher::Regex(r"^/hello/(1|2)$".to_string())).create(); //! ``` //! //! Or you can catch all requests, by using the `Matcher::Any` variant: //! //! ## Example //! //! ``` //! use mockito::{mock, Matcher}; //! //! // Will match any GET request //! let _m = mock("GET", Matcher::Any).create(); //! ``` //! //! # Matching by query //! //! You can match the query part by using the `Mock#match_query` function together with the various matchers, //! most notably `Matcher::UrlEncoded`: //! //! ## Example //! //! ``` //! use mockito::{mock, Matcher}; //! //! // This will match requests containing the URL-encoded //! // query parameter `greeting=good%20day` //! let _m1 = mock("GET", "/test") //! .match_query(Matcher::UrlEncoded("greeting".into(), "good day".into())) //! .create(); //! //! // This will match requests containing the URL-encoded //! // query parameters `hello=world` and `greeting=good%20day` //! let _m2 = mock("GET", "/test") //! .match_query(Matcher::AllOf(vec![ //! Matcher::UrlEncoded("hello".into(), "world".into()), //! Matcher::UrlEncoded("greeting".into(), "good day".into()) //! ])) //! .create(); //! //! // You can achieve similar results with the regex matcher //! let _m3 = mock("GET", "/test") //! .match_query(Matcher::Regex("hello=world".into())) //! .create(); //! ``` //! //! Note that the key/value arguments for `Matcher::UrlEncoded` should be left in plain (unencoded) format. //! //! You can also specify the query as part of the path argument in a `mock` call, in which case an exact //! match will be performed: //! //! ## Example //! //! ``` //! use mockito::mock; //! //! // This will perform a full match against the query part //! let _m = mock("GET", "/test?hello=world").create(); //! ``` //! //! # Matching by header //! //! By default, headers are compared by their exact value. The header name letter case is ignored though. //! //! ## Example //! //! ``` //! use mockito::mock; //! //! let _m1 = mock("GET", "/hello") //! .match_header("content-type", "application/json") //! .with_body(r#"{"hello": "world"}"#) //! .create(); //! //! let _m2 = mock("GET", "/hello") //! .match_header("content-type", "text/plain") //! .with_body("world") //! .create(); //! //! // JSON requests to GET /hello will respond with JSON, while plain requests //! // will respond with text. //! ``` //! //! You can also match a header value with a *regular expressions*, by using the `Matcher::Regex` matcher: //! //! ## Example //! //! ``` //! use mockito::{mock, Matcher}; //! //! let _m = mock("GET", "/hello") //! .match_header("content-type", Matcher::Regex(r".*json.*".to_string())) //! .with_body(r#"{"hello": "world"}"#) //! .create(); //! ``` //! //! Or you can match a header *only by its field name*, by setting the `Mock::match_header` value to `Matcher::Any`. //! //! ## Example //! //! ``` //! use mockito::{mock, Matcher}; //! //! let _m = mock("GET", "/hello") //! .match_header("content-type", Matcher::Any) //! .with_body("something") //! .create(); //! //! // Requests containing any content-type header value will be mocked. //! // Requests not containing this header will return `501 Mock Not Found`. //! ``` //! //! You can mock requests that should be *missing a particular header field*, by setting the `Mock::match_header` //! value to `Matcher::Missing`. //! //! ## Example //! //! ``` //! use mockito::{mock, Matcher}; //! //! let _m = mock("GET", "/hello") //! .match_header("authorization", Matcher::Missing) //! .with_body("no authorization header") //! .create(); //! //! // Requests without the authorization header will be matched. //! // Requests containing the authorization header will return `501 Mock Not Found`. //! ``` //! //! # Matching by body //! //! You can match a request by its body by using the `Mock#match_body` method. //! By default the request body is ignored, similar to passing the `Matcher::Any` argument to the `match_body` method. //! //! You can match a body by an exact value: //! //! ## Example //! //! ``` //! use mockito::mock; //! //! // Will match requests to POST / whenever the request body is "hello" //! let _m = mock("POST", "/").match_body("hello").create(); //! ``` //! //! Or you can match the body by using a regular expression: //! //! ## Example //! //! ``` //! use mockito::{mock, Matcher}; //! //! // Will match requests to POST / whenever the request body *contains* the word "hello" (e.g. "hello world") //! let _m = mock("POST", "/").match_body(Matcher::Regex("hello".to_string())).create(); //! ``` //! //! Or you can match the body using a JSON object: //! //! ## Example //! //! ``` //! # extern crate mockito; //! #[macro_use] //! extern crate serde_json; //! use mockito::{mock, Matcher}; //! //! # fn main() { //! // Will match requests to POST / whenever the request body matches the json object //! let _m = mock("POST", "/").match_body(Matcher::Json(json!({"hello": "world"}))).create(); //! # } //! ``` //! //! If `serde_json::json!` is not exposed, you can use `Matcher::JsonString` the same way, //! but by passing a `String` to the matcher: //! //! ``` //! use mockito::{mock, Matcher}; //! //! // Will match requests to POST / whenever the request body matches the json object //! let _m = mock("POST", "/") //! .match_body( //! Matcher::JsonString(r#"{"hello": "world"}"#.to_string()) //! ) //! .create(); //! ``` //! //! # The `AnyOf` matcher //! //! The `Matcher::AnyOf` construct takes a vector of matchers as arguments and will be enabled //! if at least one of the provided matchers matches the request. //! //! ## Example //! //! ``` //! use mockito::{mock, Matcher}; //! //! // Will match requests to POST / whenever the request body is either `hello=world` or `{"hello":"world"}` //! let _m = mock("POST", "/") //! .match_body( //! Matcher::AnyOf(vec![ //! Matcher::Exact("hello=world".to_string()), //! Matcher::JsonString(r#"{"hello": "world"}"#.to_string()), //! ]) //! ) //! .create(); //!``` //! //! # The `AllOf` matcher //! //! The `Matcher::AllOf` construct takes a vector of matchers as arguments and will be enabled //! if all of the provided matchers match the request. //! //! ## Example //! //! ``` //! use mockito::{mock, Matcher}; //! //! // Will match requests to POST / whenever the request body contains both `hello` and `world` //! let _m = mock("POST", "/") //! .match_body( //! Matcher::AllOf(vec![ //! Matcher::Regex("hello".to_string()), //! Matcher::Regex("world".to_string()), //! ]) //! ) //! .create(); //!``` //! //! # Non-matching calls //! //! Any calls to the Mockito server that are not matched will return *501 Mock Not Found*. //! //! Note that **mocks are matched in reverse order** - the most recent one wins. //! //! # Cleaning up //! //! As mentioned earlier, mocks are cleaned up at the end of their normal Rust lifetime. However, //! you can always use the `reset` method to clean up *all* the mocks registered so far. //! //! ## Example //! //! ``` //! use mockito::{mock, reset}; //! //! let _m1 = mock("GET", "/1").create(); //! let _m2 = mock("GET", "/2").create(); //! let _m3 = mock("GET", "/3").create(); //! //! reset(); //! //! // Nothing is mocked at this point //! ``` //! //! Or you can use `std::mem::drop` to remove a single mock without having to wait for its scope to end: //! //! ## Example //! //! ``` //! use mockito::mock; //! use std::mem; //! //! let m = mock("GET", "/hello").create(); //! //! // Requests to GET /hello are mocked //! //! mem::drop(m); //! //! // Still in the scope of `m`, but requests to GET /hello aren't mocked any more //! ``` //! //! # Debug //! //! Mockito uses the `env_logger` crate under the hood to provide useful debugging information. //! //! If you'd like to activate the debug output, introduce the [env_logger](https://crates.rs/crates/env_logger) crate //! within your project and initialize it before each test that needs debugging: //! //! ``` //! #[test] //! fn example_test() { //! let _ = env_logger::try_init(); //! // ... //! } //! ``` //! //! Run your tests with: //! //! ```sh //! RUST_LOG=mockito=debug cargo test //! ``` //! //! # Threads //! //! Mockito records all your mocks on the same server running in the background. For this //! reason, Mockito tests are run sequentially. This is handled internally via a thread-local //! mutex lock acquired **whenever you create a mock**. Tests that don't create mocks will //! still be run in parallel. //! #[macro_use] extern crate lazy_static; #[macro_use] extern crate log; use serde_json; mod diff; mod request; mod response; mod server; type Request = request::Request; type Response = response::Response; use percent_encoding::percent_decode; use rand::distributions::Alphanumeric; use rand::{thread_rng, Rng}; use regex::Regex; use std::cell::RefCell; use std::convert::{From, Into}; use std::fmt; use std::io; use std::ops::Drop; use std::path::Path; use std::sync::Arc; use std::sync::{LockResult, Mutex, MutexGuard}; lazy_static! { // A global lock that ensure all Mockito tests are run on a single thread. static ref TEST_MUTEX: Mutex<()> = Mutex::new(()); } thread_local!( // A thread-local reference to the global lock. This is acquired within `Mock#create()`. static LOCAL_TEST_MUTEX: RefCell<LockResult<MutexGuard<'static, ()>>> = RefCell::new(TEST_MUTEX.lock()); ); /// /// Points to the address the mock server is running at. /// Can be used with `std::net::TcpStream`. /// #[deprecated(note = "Call server_address() instead")] pub const SERVER_ADDRESS: &str = SERVER_ADDRESS_INTERNAL; const SERVER_ADDRESS_INTERNAL: &str = "127.0.0.1:1234"; /// /// Points to the URL the mock server is running at. /// #[deprecated(note = "Call server_url() instead")] pub const SERVER_URL: &str = "http://127.0.0.1:1234"; pub use crate::server::address as server_address; pub use crate::server::url as server_url; use assert_json_diff::assert_json_include_no_panic; /// /// Initializes a mock for the provided `method` and `path`. /// /// The mock is registered to the server only after the `create()` method has been called. /// /// ## Example /// /// ``` /// use mockito::mock; /// /// let _m1 = mock("GET", "/"); /// let _m2 = mock("POST", "/users"); /// let _m3 = mock("DELETE", "/users?id=1"); /// ``` /// pub fn mock<P: Into<Matcher>>(method: &str, path: P) -> Mock { Mock::new(method, path) } /// /// Removes all the mocks stored on the server. /// pub fn reset() { server::try_start(); let mut state = server::STATE.lock().unwrap(); state.mocks.clear(); } #[allow(missing_docs)] pub fn start() { server::try_start(); } /// /// Allows matching the request path or headers in multiple ways: matching the exact value, matching any value (as /// long as it is present), matching by regular expression or checking that a particular header is missing. /// /// These matchers are used within the `mock` and `Mock::match_header` calls. /// #[derive(Clone, PartialEq, Debug)] #[allow(deprecated)] // Rust bug #38832 pub enum Matcher { /// Matches the exact path or header value. There's also an implementation of `From<&str>` /// to keep things simple and backwards compatible. Exact(String), /// Matches a path or header value by a regular expression. Regex(String), /// Matches a specified JSON body from a `serde_json::Value` Json(serde_json::Value), /// Matches a specified JSON body from a `String` JsonString(String), /// Matches a partial JSON body from a `serde_json::Value` PartialJson(serde_json::Value), /// Matches a specified partial JSON body from a `String` PartialJsonString(String), /// Matches a URL-encoded key/value pair, where both key and value should be specified /// in plain (unencoded) format UrlEncoded(String, String), /// At least one matcher must match AnyOf(Vec<Matcher>), /// All matchers must match AllOf(Vec<Matcher>), /// Matches any path or any header value. Any, /// Checks that a header is not present in the request. Missing, } impl<'a> From<&'a str> for Matcher { fn from(value: &str) -> Self { Matcher::Exact(value.to_string()) } } impl fmt::Display for Matcher { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { let join_matches = |matches: &[Matcher]| { matches .iter() .map(Matcher::to_string) .fold(String::new(), |acc, matcher| { if acc.len() > 0 { format!("{}, {}", acc, matcher) } else { format!("{}", matcher) } }) }; let result = match self { Matcher::Exact(ref value) => value.to_string(), Matcher::Regex(ref value) => format!("{} (regex)", value), Matcher::Json(ref json_obj) => format!("{} (json)", json_obj), Matcher::JsonString(ref value) => format!("{} (json)", value), Matcher::PartialJson(ref json_obj) => format!("{} (partial json)", json_obj), Matcher::PartialJsonString(ref value) => format!("{} (partial json)", value), Matcher::UrlEncoded(ref field, ref value) => { format!("{}={} (urlencoded)", field, value) } Matcher::Any => "(any)".to_string(), Matcher::AnyOf(x) => format!("({}) (any of)", join_matches(x)), Matcher::AllOf(x) => format!("({}) (all of)", join_matches(x)), Matcher::Missing => "(missing)".to_string(), }; write!(f, "{}", result) } } impl Matcher { fn matches_values(&self, header_values: &[&str]) -> bool { match self { Matcher::Missing => header_values.is_empty(), // AnyOf([…Missing…]) is handled here, but // AnyOf([Something]) is handled in the last block. // That's because Missing matches against all values at once, // but other matchers match against individual values. Matcher::AnyOf(ref matchers) if header_values.is_empty() => { matchers.iter().any(|m| m.matches_values(header_values)) } Matcher::AllOf(ref matchers) if header_values.is_empty() => { matchers.iter().all(|m| m.matches_values(header_values)) } _ => { !header_values.is_empty() && header_values.iter().all(|val| self.matches_value(val)) } } } #[allow(deprecated)] fn matches_value(&self, other: &str) -> bool { match self { Matcher::Exact(ref value) => value == other, Matcher::Regex(ref regex) => Regex::new(regex).unwrap().is_match(other), Matcher::Json(ref json_obj) => { let other: serde_json::Value = serde_json::from_str(other).unwrap(); *json_obj == other } Matcher::JsonString(ref value) => { let value: serde_json::Value = serde_json::from_str(value).unwrap(); let other: serde_json::Value = serde_json::from_str(other).unwrap(); value == other } Matcher::PartialJson(ref json_obj) => { let actual: serde_json::Value = serde_json::from_str(other).unwrap(); let expected = json_obj.clone(); assert_json_include_no_panic(&actual, &expected).is_ok() } Matcher::PartialJsonString(ref value) => { let expected: serde_json::Value = serde_json::from_str(value).unwrap(); let actual: serde_json::Value = serde_json::from_str(other).unwrap(); assert_json_include_no_panic(&actual, &expected).is_ok() } Matcher::UrlEncoded(ref expected_field, ref expected_value) => other .split('&') .map(|pair| { let mut parts = pair.splitn(2, '='); let field = percent_decode(parts.next().unwrap().as_bytes()).decode_utf8_lossy(); let value = percent_decode(parts.next().unwrap_or("").as_bytes()).decode_utf8_lossy(); (field.to_string(), value.to_string()) }) .any(|(ref field, ref value)| field == expected_field && value == expected_value), Matcher::Any => true, Matcher::AnyOf(ref matchers) => matchers.iter().any(|m| m.matches_value(other)), Matcher::AllOf(ref matchers) => matchers.iter().all(|m| m.matches_value(other)), Matcher::Missing => other.is_empty(), } } } #[derive(Clone, PartialEq, Debug)] enum PathAndQueryMatcher { Unified(Matcher), Split(Box<Matcher>, Box<Matcher>), } impl PathAndQueryMatcher { fn matches_value(&self, other: &str) -> bool { match self { PathAndQueryMatcher::Unified(matcher) => matcher.matches_value(other), PathAndQueryMatcher::Split(ref path_matcher, ref query_matcher) => { let mut parts = other.splitn(2, '?'); let path = parts.next().unwrap(); let query = parts.next().unwrap_or(""); path_matcher.matches_value(path) && query_matcher.matches_value(query) } } } } /// /// Stores information about a mocked request. Should be initialized via `mockito::mock()`. /// #[derive(Clone, PartialEq, Debug)] pub struct Mock { id: String, method: String, path: PathAndQueryMatcher, headers: Vec<(String, Matcher)>, body: Matcher, response: Response, hits: usize, expected_hits_at_least: Option<usize>, expected_hits_at_most: Option<usize>, is_remote: bool, /// Used to warn of mocks missing a `.create()` call. See issue #112 created: bool, } impl Mock { fn new<P: Into<Matcher>>(method: &str, path: P) -> Self { Self { id: thread_rng().sample_iter(&Alphanumeric).take(24).collect(), method: method.to_owned().to_uppercase(), path: PathAndQueryMatcher::Unified(path.into()), headers: Vec::new(), body: Matcher::Any, response: Response::default(), hits: 0, expected_hits_at_least: None, expected_hits_at_most: None, is_remote: false, created: false, } } /// /// Allows matching against the query part when responding with a mock. /// /// Note that you can also specify the query as part of the path argument /// in a `mock` call, in which case an exact match will be performed. /// Any future calls of `Mock#match_query` will override the query matcher. /// /// ## Example /// /// ``` /// use mockito::{mock, Matcher}; /// /// // This will match requests containing the URL-encoded /// // query parameter `greeting=good%20day` /// let _m1 = mock("GET", "/test") /// .match_query(Matcher::UrlEncoded("greeting".into(), "good day".into())) /// .create(); /// /// // This will match requests containing the URL-encoded /// // query parameters `hello=world` and `greeting=good%20day` /// let _m2 = mock("GET", "/test") /// .match_query(Matcher::AllOf(vec![ /// Matcher::UrlEncoded("hello".into(), "world".into()), /// Matcher::UrlEncoded("greeting".into(), "good day".into()) /// ])) /// .create(); /// /// // You can achieve similar results with the regex matcher /// let _m3 = mock("GET", "/test") /// .match_query(Matcher::Regex("hello=world".into())) /// .create(); /// ``` /// pub fn match_query<M: Into<Matcher>>(mut self, query: M) -> Self { let new_path = match &self.path { PathAndQueryMatcher::Unified(matcher) => { PathAndQueryMatcher::Split(Box::new(matcher.clone()), Box::new(query.into())) } PathAndQueryMatcher::Split(path, _) => { PathAndQueryMatcher::Split(path.clone(), Box::new(query.into())) } }; self.path = new_path; self } /// /// Allows matching a particular request header when responding with a mock. /// /// When matching a request, the field letter case is ignored. /// /// ## Example /// /// ``` /// use mockito::mock; /// /// let _m = mock("GET", "/").match_header("content-type", "application/json"); /// ``` /// /// Like most other `Mock` methods, it allows chanining: /// /// ## Example /// /// ``` /// use mockito::mock; /// /// let _m = mock("GET", "/") /// .match_header("content-type", "application/json") /// .match_header("authorization", "password"); /// ``` /// pub fn match_header<M: Into<Matcher>>(mut self, field: &str, value: M) -> Self { self.headers .push((field.to_owned().to_lowercase(), value.into())); self } /// /// Allows matching a particular request body when responding with a mock. /// /// ## Example /// /// ``` /// use mockito::mock; /// /// let _m1 = mock("POST", "/").match_body(r#"{"hello": "world"}"#).with_body("json").create(); /// let _m2 = mock("POST", "/").match_body("hello=world").with_body("form").create(); /// /// // Requests passing `{"hello": "world"}` inside the body will be responded with "json". /// // Requests passing `hello=world` inside the body will be responded with "form". /// ``` /// pub fn match_body<M: Into<Matcher>>(mut self, body: M) -> Self { self.body = body.into(); self } /// /// Sets the status code of the mock response. The default status code is 200. /// /// ## Example /// /// ``` /// use mockito::mock; /// /// let _m = mock("GET", "/").with_status(201); /// ``` /// pub fn with_status(mut self, status: usize) -> Self { self.response.status = status.into(); self } /// /// Sets a header of the mock response. /// /// ## Example /// /// ``` /// use mockito::mock; /// /// let _m = mock("GET", "/").with_header("content-type", "application/json"); /// ``` /// pub fn with_header(mut self, field: &str, value: &str) -> Self { self.response .headers .push((field.to_owned(), value.to_owned())); self } /// /// Sets the body of the mock response. Its `Content-Length` is handled automatically. /// /// ## Example /// /// ``` /// use mockito::mock; /// /// let _m = mock("GET", "/").with_body("hello world"); /// ``` /// pub fn with_body<StrOrBytes: AsRef<[u8]>>(mut self, body: StrOrBytes) -> Self { self.response.body = response::Body::Bytes(body.as_ref().to_owned()); self } /// /// Sets the body of the mock response dynamically. The response will use chunked transfer encoding. /// /// The function must be thread-safe. If it's a closure, it can't be borrowing its context. /// Use `move` closures and `Arc` to share any data. /// /// ## Example /// /// ``` /// use mockito::mock; /// /// let _m = mock("GET", "/").with_body_from_fn(|w| w.write_all(b"hello world")); /// ``` /// pub fn with_body_from_fn( mut self, cb: impl Fn(&mut dyn io::Write) -> io::Result<()> + Send + Sync + 'static, ) -> Self { self.response.body = response::Body::Fn(Arc::new(cb)); self } /// /// Sets the body of the mock response from the contents of a file stored under `path`. /// Its `Content-Length` is handled automatically. /// /// ## Example /// /// ``` /// use mockito::mock; /// /// let _m = mock("GET", "/").with_body_from_file("tests/files/simple.http"); /// ``` /// pub fn with_body_from_file(mut self, path: impl AsRef<Path>) -> Self { self.response.body = response::Body::Bytes(std::fs::read(path).unwrap()); self } /// /// Sets the expected amount of requests that this mock is supposed to receive. /// This is only enforced when calling the `assert` method. /// Defaults to 1 request. /// #[allow(clippy::missing_const_for_fn)] pub fn expect(mut self, hits: usize) -> Self { self.expected_hits_at_least = Some(hits); self.expected_hits_at_most = Some(hits); self } /// /// Sets the minimum amount of requests that this mock is supposed to receive. /// This is only enforced when calling the `assert` method. /// pub fn expect_at_least(mut self, hits: usize) -> Self { self.expected_hits_at_least = Some(hits); if self.expected_hits_at_most.is_some() && self.expected_hits_at_most < self.expected_hits_at_least { self.expected_hits_at_most = None; } self } /// /// Sets the maximum amount of requests that this mock is supposed to receive. /// This is only enforced when calling the `assert` method. /// pub fn expect_at_most(mut self, hits: usize) -> Self { self.expected_hits_at_most = Some(hits); if self.expected_hits_at_least.is_some() && self.expected_hits_at_least > self.expected_hits_at_most { self.expected_hits_at_least = None; } self } /// /// Asserts that the expected amount of requests (defaults to 1 request) were performed. /// pub fn assert(&self) { let mut opt_hits = None; let mut opt_message = None; { let state = server::STATE.lock().unwrap(); if let Some(remote_mock) = state.mocks.iter().find(|mock| mock.id == self.id) { opt_hits = Some(remote_mock.hits); let mut message = match (self.expected_hits_at_least, self.expected_hits_at_most) { (Some(min), Some(max)) if min == max => format!( "\n> Expected {} request(s) to:\n{}\n...but received {}\n\n", min, self, remote_mock.hits ), (Some(min), Some(max)) => format!( "\n> Expected between {} and {} request(s) to:\n{}\n...but received {}\n\n", min, max, self, remote_mock.hits ), (Some(min), None) => format!( "\n> Expected at least {} request(s) to:\n{}\n...but received {}\n\n", min, self, remote_mock.hits ), (None, Some(max)) => format!( "\n> Expected at most {} request(s) to:\n{}\n...but received {}\n\n", max, self, remote_mock.hits ), (None, None) => format!( "\n> Expected 1 request(s) to:\n{}\n...but received {}\n\n", self, remote_mock.hits ), }; if let Some(last_request) = state.unmatched_requests.last() { message.push_str(&format!( "> The last unmatched request was:\n{}\n", last_request )); let difference = diff::compare(&self.to_string(), &last_request.to_string()); message.push_str(&format!("> Difference:\n{}\n", difference)); } opt_message = Some(message); } } match (opt_hits, opt_message) { (Some(hits), Some(message)) => assert!( match (self.expected_hits_at_least, self.expected_hits_at_most) { (Some(min), Some(max)) => hits >= min && hits <= max, (Some(min), None) => hits >= min, (None, Some(max)) => hits <= max, (None, None) => hits == 1, }, "{}", message ), _ => panic!("Could not retrieve enough information about the remote mock."), } } /// /// Registers the mock to the server - your mock will be served only after calling this method. /// /// ## Example /// /// ``` /// use mockito::mock; /// /// let _m = mock("GET", "/").with_body("hello world").create(); /// ``` /// #[must_use] pub fn create(mut self) -> Self { server::try_start(); // Ensures Mockito tests are run sequentially. LOCAL_TEST_MUTEX.with(|_| {}); let mut state = server::STATE.lock().unwrap(); self.created = true; let mut remote_mock = self.clone(); remote_mock.is_remote = true; state.mocks.push(remote_mock); self } #[allow(clippy::missing_const_for_fn)] fn is_local(&self) -> bool { !self.is_remote } } impl Drop for Mock { fn drop(&mut self) { if self.is_local() { let mut state = server::STATE.lock().unwrap(); if let Some(pos) = state.mocks.iter().position(|mock| mock.id == self.id) { state.mocks.remove(pos); } debug!("Mock::drop() called for {}", self); if !self.created { warn!("Missing .create() call on mock {}", self); } } } } impl fmt::Display for PathAndQueryMatcher { #[allow(deprecated)] fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { PathAndQueryMatcher::Unified(matcher) => { write!(f, "{}\r\n", &matcher) } PathAndQueryMatcher::Split(path, query) => { write!(f, "{}?{}\r\n", &path, &query) } } } } impl fmt::Display for Mock { #[allow(deprecated)] fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { let mut formatted = String::new(); formatted.push_str("\r\n"); formatted.push_str(&self.method); formatted.push_str(" "); formatted.push_str(&self.path.to_string()); for &(ref key, ref value) in &self.headers { formatted.push_str(key); formatted.push_str(": "); formatted.push_str(&value.to_string()); formatted.push_str("\r\n"); } match self.body { Matcher::Exact(ref value) | Matcher::JsonString(ref value) | Matcher::PartialJsonString(ref value) | Matcher::Regex(ref value) => { formatted.push_str(value); formatted.push_str("\r\n"); } Matcher::Json(ref json_obj) | Matcher::PartialJson(ref json_obj) => { formatted.push_str(&json_obj.to_string()); formatted.push_str("\r\n") } Matcher::UrlEncoded(ref field, ref value) => { formatted.push_str(field); formatted.push_str("="); formatted.push_str(value); } Matcher::Missing => formatted.push_str("(missing)\r\n"), Matcher::AnyOf(..) => formatted.push_str("(any of)\r\n"), Matcher::AllOf(..) => formatted.push_str("(all of)\r\n"), Matcher::Any => {} } f.write_str(&formatted) } }