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

#![warn(missing_docs, clippy::missing_docs_in_private_items)]
// None of the tests are seen by the linter, so none of the utilities are marked
// as used. But docs don't generate for the below if they are `#[cfg(test)]`.
// This is a compromise.
#![allow(dead_code)]

//! Tests for Merino that work by reading from the external API only.
//!
//! Since the URL endpoints Merino exposes to the world are its public API, and
//! other systems depend on them, the paths used in tests here are important
//! details, and used to keep compatibility.
//!
//! This is structured as a separate crate so that it produces a single test
//! binary instead of one test per file like would happen if this were
//! `merino/tests/...`. This improves compilation and test times.
//!
//! The primary tool used by tests is [`merino_test`], which creates mock
//! servers, sets up the application for testing, and provides helpers to inspect
//! the state of the app. It then calls the test function that is passed to it,
//! providing the above tools as an argument.
//!
//! # Examples:
//!
//! A realistic test:
//!
//! ```
//! use merino_integration_tests::{TestingTools, merino_test_macro};
//!
//! #[merino_test_macro(|settings| settings.debug = true)]
//! async fn lbheartbeat_works(TestingTools { test_client, .. }: TestingTools) {
//!    let response = test_client
//!        .get("/__lbheartbeat__")
//!        .send()
//!        .await
//!        .expect("failed to execute request");
//!
//!    assert_eq!(response.status(), StatusCode::OK);
//!    assert_eq!(response.content_length(), Some(0));
//! }
//! ```
//!
//! Basic usage:
//!
//! ```
//! use merino_integration_tests::{merino_test_macro, TestingTools};
//!
//! #[merino_test_macro]
//! async fn test_function(TestingTools { test_client, .. }: TestingTools) {
//!     // test using test_client
//! }
//! ```
//!
//! Settings can be customized:
//!
//! ```
//! use merino_integration_tests::{merino_test_macro, TestingTools};
//!
//! #[merino_test_macro(|settings| settings.debug = true)]
//! async fn test_function(TestingTools { test_client, .. }: TestingTools) {
//!     // test using test_client while the debug setting is true.
//! }
//! ```
//!
//! Other test macros, like `parameterized`, can be used:
//!
//! ```
//! use merino_integration_tests::{TestingTools, merino_test_macro};
//! use parameterized::parameterized;
//!
//! #[merino_test_macro(|settings, ttl: u64| settings.redis_cache.default_ttl = ttl)]
//! #[parameterized(ttl = { 300, 600 })]
//! async fn test(TestingTools { .. }: TestingTools) {
//!     // test will run twice, once with each TTL setting.
//! }
//! ```

mod caching;
mod debug;
mod dockerflow;
mod general;
mod logging;
mod providers;
mod reconfigure;
mod suggest;
mod utils;

pub use crate::utils::{
    logging::{LogWatcher, TracingJsonEvent},
    metrics::MetricsWatcher,
    test_tools::{merino_test, TestingTools},
};

pub use merino_integration_tests_macro::merino_test as merino_test_macro;