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
//! <div align="center"> //! <img src="https://github.com/mitsuhiko/insta/blob/master/assets/logo.png?raw=true" width="250" height="250"> //! <p><strong>insta: a snapshot testing library for Rust</strong></p> //! </div> //! //! # What are snapshot tests //! //! Snapshots tests (also sometimes called approval tests) are tests that //! assert values against a reference value (the snapshot). This is similar //! to how `assert_eq!` lets you compare a value against a reference value but //! unlike simple string assertions snapshot tests let you test against complex //! values and come with comprehensive tools to review changes. //! //! Snapshot tests are particularly useful if your reference values are very //! large or change often. //! //! # How it operates //! //! This crate exports multiple macros for snapshot testing: //! //! - `assert_snapshot!` for comparing basic string snapshots. //! - `assert_debug_snapshot!` for comparing `Debug` outputs of values. //! - `assert_display_snapshot!` for comparing `Display` outputs of values. //! - `assert_yaml_snapshot!` for comparing YAML serialized //! output of types implementing `serde::Serialize`. //! - `assert_ron_snapshot!` for comparing RON serialized output of //! types implementing `serde::Serialize`. (requires the `ron` feature) //! - `assert_json_snapshot!` for comparing JSON serialized output of //! types implementing `serde::Serialize`. //! //! Snapshots are stored in the `snapshots` folder right next to the test file //! where this is used. The name of the file is `<module>__<name>.snap` where //! the `name` of the snapshot. Snapshots can either be explicitly named or the //! name is derived from the test name. //! //! Additionally snapshots can also be stored inline. In that case the //! [`cargo-insta`](https://crates.io/crates/cargo-insta) tool is necessary. //! See [inline snapshots](#inline-snapshots) for more information. //! //! For macros that work with `serde::Serialize` this crate also permits //! redacting of partial values. See [redactions](#redactions) for more //! information. //! //! # What it looks like: //! //! This is what the cargo insta review UI looks like: //! //! <img src="https://github.com/mitsuhiko/insta/blob/master/assets/review.png?raw=true" alt=""> //! //! There is also a screencast that shows the entire workflow: [watch the insta //! introduction screencast](https://www.youtube.com/watch?v=7mIDiKK4eyo&feature=youtu.be) //! //! # Example //! //! Install `insta`: //! //! Recommended way if you have `cargo-edit` installed: //! //! ```ignore //! $ cargo add --dev insta //! ``` //! //! Alternatively edit your `Cargo.toml` manually and add `insta` as manual //! dependency. //! //! And for an improved review experience also install `cargo-insta`: //! //! ```ignore //! $ cargo install cargo-insta //! ``` //! //! ```rust,ignore //! use insta::assert_debug_snapshot; //! //! #[test] //! fn test_snapshots() { //! let value = vec![1, 2, 3]; //! assert_debug_snapshot!(value); //! } //! ``` //! //! The recommended flow is to run the tests once, have them fail and check //! if the result is okay. By default the new snapshots are stored next //! to the old ones with the extra `.new` extension. Once you are satisifed //! move the new files over. To simplify this workflow you can use //! `cargo insta review` which will let you interactively review them: //! //! ```ignore //! $ cargo test //! $ cargo insta review //! ``` //! //! For more information on updating see [Snapshot Updating]. //! //! [Snapshot Updating]: #snapshot-updating //! //! # Snapshot files //! //! The committed snapshot files will have a header with some meta information //! that can make debugging easier and the snapshot: //! //! ```ignore //! --- //! expression: "&User{id: Uuid::new_v4(), username: \"john_doe\".to_string(),}" //! source: tests/test_user.rs //! --- //! [ //! 1, //! 2, //! 3 //! ] //! ``` //! //! # Snapshot updating //! //! During test runs snapshots will be updated according to the `INSTA_UPDATE` //! environment variable. The default is `auto` which will write all new //! snapshots into `.snap.new` files if no CI is detected. //! //! `INSTA_UPDATE` modes: //! //! - `auto`: the default. `no` for CI environments or `new` otherwise //! - `always`: overwrites old snapshot files with new ones unasked //! - `new`: write new snapshots into `.snap.new` files. //! - `no`: does not update snapshot files at all (just runs tests) //! //! When `new` is used as mode the `cargo-insta` command can be used to review //! the snapshots conveniently: //! //! ```ignore //! $ cargo install cargo-insta //! $ cargo test //! $ cargo insta review //! ``` //! //! "enter" or "a" accepts a new snapshot, "escape" or "r" rejects, //! "space" or "s" skips the snapshot for now. //! //! For more information invoke `cargo insta --help`. //! //! # Test assertions //! //! By default the tests will fail when the snapshot assertion fails. However //! if a test produces more than one snapshot it can be useful to force a test //! to pass so that all new snapshots are created in one go. //! //! This can be enabled by setting `INSTA_FORCE_PASS` to `1`: //! //! ```ignore //! $ INSTA_FORCE_PASS=1 cargo test --no-fail-fast //! ``` //! //! A better way to do this is to run `cargo insta test --review` which will //! run all tests with force pass and then bring up the review tool: //! //! ```ignore //! $ cargo insta test --review //! ``` //! //! # Named snapshots //! //! All snapshot assertion functions let you leave out the snapshot name in //! which case the snapshot name is derived from the test name (with an optional //! leading `test_` prefix removed. //! //! This works because the rust test runner names the thread by the test name //! and the name is taken from the thread name. In case your test spawns additional //! threads this will not work and you will need to provide a name explicitly. //! //! Explicit snapshot naming can also otherwise be useful to be more explicit //! when multiple snapshots are tested within one function as the default //! behavior would be to just count up the snapshot names. //! //! To provide an explicit name provide the name of the snapshot as first //! argument to the macro: //! //! ```rust,ignore //! #[test] //! fn test_something() { //! assert_snapshot!("first_snapshot", "first value"); //! assert_snapshot!("second_snapshot", "second value"); //! } //! ``` //! //! This will create two snapshots: `first_snapshot` for the first value and //! `second_snapshot` for the second value. Without explicit naming the //! snapshots would be called `something` and `something-2`. //! //! # Redactions //! //! **Feature:** `redactions` //! //! For all snapshots created based on `serde::Serialize` output `insta` //! supports redactions. This permits replacing values with hardcoded other //! values to make snapshots stable when otherwise random or otherwise changing //! values are involved. Redactions became an optional feature in insta //! 0.11 and can be enabled with the `redactions` feature./ //! //! Redactions can be defined as the third argument to those macros with //! the syntax `{ selector => replacement_value }`. //! //! The following selectors exist: //! //! - `.key`: selects the given key //! - `["key"]`: alternative syntax for keys //! - `[index]`: selects the given index in an array //! - `[]`: selects all items on an array //! - `[:end]`: selects all items up to `end` (excluding, supports negative indexing) //! - `[start:]`: selects all items starting with `start` //! - `[start:end]`: selects all items from `start` to `end` (end excluding, //! supports negative indexing). //! - `.*`: selects all keys on that depth //! //! Example usage: //! //! ```rust,ignore //! #[derive(Serialize)] //! pub struct User { //! id: Uuid, //! username: String, //! extra: HashMap<String, String>, //! } //! //! assert_yaml_snapshot!(&User { //! id: Uuid::new_v4(), //! username: "john_doe".to_string(), //! extra: { //! let mut map = HashMap::new(); //! map.insert("ssn".to_string(), "123-123-123".to_string()); //! map //! }, //! }, { //! ".id" => "[uuid]", //! ".extra.ssn" => "[ssn]" //! }); //! ``` //! //! # Inline Snapshots //! //! Additionally snapshots can also be stored inline. In that case the format //! for the snapshot macros is `assert_snapshot!(reference_value, @"snapshot")`. //! The leading at sign (`@`) indicates that the following string is the //! reference value. `cargo-insta` will then update that string with the new //! value on review. //! //! Example: //! //! ```rust,ignore //! #[derive(Serialize)] //! pub struct User { //! username: String, //! } //! //! assert_yaml_snapshot!(User { //! username: "john_doe".to_string(), //! }, @""); //! ``` //! //! After the initial test failure you can run `cargo insta review` to //! accept the change. The file will then be updated automatically. //! //! # Features //! //! The following features exist: //! //! * `ron`: enables RON support (`assert_ron_snapshot!`) //! * `redactions`: enables support for redactions //! //! # Settings //! //! There are some settings that can be changed on a per-thread (and thus //! per-test) basis. For more information see [settings](struct.Settings.html). //! //! # Legacy Snapshot Formats //! //! With insta 0.11 the snapshot format was improved for inline snapshots. The //! old snapshot format will continue to be available but if you want to upgrade //! them make sure the tests pass first and then run the following command //! to force a rewrite of them all: //! //! ```text,ignore //! $ cargo insta test --accept --force-update-snapshots //! ``` #![allow(clippy::redundant_closure)] #[macro_use] mod macros; mod content; mod runtime; mod serialization; mod settings; mod snapshot; mod utils; #[macro_use] mod legacy_macros; #[cfg(feature = "redactions")] mod redaction; #[cfg(test)] mod test; pub use crate::settings::Settings; pub use crate::snapshot::{MetaData, Snapshot}; /// Exposes some library internals. /// /// You're unlikely to want to work with these objects but they /// are exposed for documentation primarily. pub mod internals { pub use crate::content::Content; pub use crate::runtime::AutoName; #[cfg(feature = "redactions")] pub use crate::settings::Redactions; pub use crate::snapshot::{MetaData, SnapshotContents}; } // exported for cargo-insta only #[doc(hidden)] pub use crate::{ runtime::print_snapshot_diff, snapshot::PendingInlineSnapshot, snapshot::SnapshotContents, }; // these are here to make the macros work #[doc(hidden)] pub mod _macro_support { pub use crate::content::Content; pub use crate::runtime::{assert_snapshot, AutoName, ReferenceValue}; pub use crate::serialization::{serialize_value, SerializationFormat, SnapshotLocation}; #[cfg(feature = "redactions")] pub use crate::{redaction::Selector, serialization::serialize_value_redacted}; }