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
#![warn(missing_docs)] #![doc(html_logo_url = "http://lipanski.github.io/mockito/logo/logo-black.png", html_root_url = "http://lipanski.github.io/mockito/generated/mockito/index.html")] //! //! Mockito is a library for creating HTTP mocks to be used in integration tests or for offline work. //! It runs an HTTP server on your local port 1234 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 `mockito::SERVER_URL` or `mockito::SERVER_ADDRESS`. //! //! ## Example //! //! ``` //! #[cfg(test)] //! use mockito; //! //! #[cfg(not(test))] //! const URL: &'static str = "https://api.twitter.com"; //! //! #[cfg(test)] //! const URL: &'static str = 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. //! //! ## 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 //! ``` //! //! Note how I **didn't use the same variable name** for both mocks (e.g. `let _`), as it would have ended the //! lifetime of the first mock with the second assignment. //! //! # Run your tests //! //! Due to the nature of this library (all your mocks are recorded on the same server running in background), //! it is highly recommended that you **run your tests on a single thread**: //! //! ```sh //! cargo test -- --test-threads=1 //! //! # Same, but using an environment variable //! RUST_TEST_THREADS=1 cargo test //! ``` //! //! # 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 perfomed the expected HTTP requests. //! //! By default, the method expects that only one request to your mock was triggered. //! //! ## Example //! //! ``` //! 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); //! } //! //! mock.assert(); //! ``` //! //! If you're expecting more than 1 request, you can use the `Mock::expect` method to specify the exact amout of requests: //! //! ## Example //! //! ``` //! 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); //! } //! //! 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. //! //! Here's an example of how a `Mock#assert` error looks like: //! //! ```text //! Expected 1 request(s) to: //! //! POST /users //! bob //! //! ...but received 0 //! //! The last unmatched request was: //! //! POST /users //! content-length: 5 //! alice //! ``` //! //! # Matchers //! //! Mockito can match your request by method, path, 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 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("{'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("{'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 Not Implemented`. //! ``` //! //! 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 Not Implemented`. //! ``` //! //! # 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(); //! ``` //! //! # Non-matching calls //! //! Any calls to the Mockito server that are not matched will return *501 Not Implemented*. //! //! 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 //! extern crate http_muncher; extern crate rand; extern crate regex; #[macro_use] extern crate lazy_static; mod server; mod request; mod response; type Request = request::Request; type Response = response::Response; use std::fs::File; use std::io::Read; use std::cmp::PartialEq; use std::convert::{From, Into}; use std::ops::Drop; use std::fmt; use rand::{thread_rng, Rng}; use regex::Regex; /// /// Points to the address the mock server is running at. /// Can be used with `std::net::TcpStream`. /// pub const SERVER_ADDRESS: &'static str = "127.0.0.1:1234"; /// /// Points to the URL the mock server is running at. /// pub const SERVER_URL: &'static str = "http://127.0.0.1:1234"; /// /// 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 state_mutex = server::STATE.clone(); let mut state = state_mutex.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)] 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 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) -> Matcher { Matcher::Exact(value.to_string()) } } impl PartialEq<String> for Matcher { fn eq(&self, other: &String) -> bool { match self { &Matcher::Exact(ref value) => { value == other }, &Matcher::Regex(ref regex) => { Regex::new(regex).unwrap().is_match(other) }, &Matcher::Any => true, &Matcher::Missing => false, } } } /// /// Stores information about a mocked request. Should be initialized via `mockito::mock()`. /// #[derive(Clone, PartialEq, Debug)] pub struct Mock { id: String, method: String, path: Matcher, headers: Vec<(String, Matcher)>, body: Matcher, response: Response, hits: usize, expected_hits: usize, is_remote: bool, } impl Mock { fn new<P: Into<Matcher>>(method: &str, path: P) -> Self { Mock { id: thread_rng().gen_ascii_chars().take(24).collect(), method: method.to_owned().to_uppercase(), path: path.into(), headers: Vec::new(), body: Matcher::Any, response: Response::default(), hits: 0, expected_hits: 1, is_remote: false, } } /// /// 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("{'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(mut self, body: &str) -> Self { self.response.body = body.to_owned(); 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: &str) -> Self { let mut file = File::open(path).unwrap(); let mut body = String::new(); file.read_to_string(&mut body).unwrap(); self.response.body = body; 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. /// pub fn expect(mut self, hits: usize) -> Self { self.expected_hits = hits; 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_mutex = server::STATE.clone(); let state = state_mutex.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 = format!("\r\nExpected {} request(s) to:\r\n{}\r\n...but received {}\r\n\r\n", self.expected_hits, self, remote_mock.hits); if let Some(last_request) = state.unmatched_requests.last() { message.push_str(&format!("The last unmatched request was:\r\n{}\r\n", last_request)); } opt_message = Some(message); } } match (opt_hits, opt_message) { (Some(hits), Some(message)) => assert_eq!(self.expected_hits, hits, "{}", 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(); /// ``` /// pub fn create(self) -> Self { server::try_start(); let state_mutex = server::STATE.clone(); let mut state = state_mutex.lock().unwrap(); let mut remote_mock = self.clone(); remote_mock.is_remote = true; state.mocks.push(remote_mock); self } fn is_local(&self) -> bool { !self.is_remote } } impl Drop for Mock { fn drop(&mut self) { if self.is_local() { let state_mutex = server::STATE.clone(); let mut state = state_mutex.lock().unwrap(); if let Some(pos) = state.mocks.iter().position(|mock| mock.id == self.id) { state.mocks.remove(pos); } } } } impl fmt::Display for Mock { 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(" "); match self.path { Matcher::Exact(ref value) => { formatted.push_str(value); formatted.push_str("\r\n"); }, Matcher::Regex(ref value) => { formatted.push_str(value); formatted.push_str(" (regex)\r\n") }, Matcher::Any => formatted.push_str("(any)\r\n"), Matcher::Missing => formatted.push_str("(missing)\r\n"), } for &(ref key, ref value) in &self.headers { match value { &Matcher::Exact(ref value) => { formatted.push_str(key); formatted.push_str(": "); formatted.push_str(value); }, &Matcher::Regex(ref value) => { formatted.push_str(key); formatted.push_str(": "); formatted.push_str(value); formatted.push_str(" (regex)") }, &Matcher::Any => { formatted.push_str(key); formatted.push_str(": "); formatted.push_str("(any)"); }, &Matcher::Missing => { formatted.push_str(key); formatted.push_str(": "); formatted.push_str("(missing)"); }, } formatted.push_str("\r\n"); } match self.body { Matcher::Exact(ref value) => { formatted.push_str(value); formatted.push_str("\r\n"); }, Matcher::Regex(ref value) => { formatted.push_str(value); formatted.push_str("\r\n"); }, Matcher::Missing => formatted.push_str("(missing)\r\n"), _ => {}, } write!(f, "{}", formatted) } }