Remove assertion_line from stored snapshots (#218)

CHANGELOG.md

@@ -5,6 +5,7 @@ All notable changes to insta and cargo-insta are documented here.
 ## 1.13.0
 
 - Fixed a bug where an extra newline was emitted following the snapshot header.
+- `assertion_line` is no longer retained in snapshots. (#218)
 
 ## 1.12.0
 

cargo-insta/src/cargo.rs

@@ -221,7 +221,9 @@ impl SnapshotContainer {
             for snapshot in self.snapshots.iter() {
                 match snapshot.op {
                     Operation::Accept => {
-                        fs::rename(&self.snapshot_path, &self.target_path)?;
+                        let snapshot = Snapshot::from_file(&self.snapshot_path)?;
+                        snapshot.save(&self.target_path)?;
+                        fs::remove_file(&self.snapshot_path)?;
                     }
                     Operation::Reject => {
                         fs::remove_file(&self.snapshot_path)?;

src/runtime.rs

@@ -328,7 +328,7 @@ impl<'a> SnapshotAssertionContext<'a> {
                 if let Some(ref snapshot_file) = self.snapshot_file {
                     let mut new_path = snapshot_file.to_path_buf();
                     new_path.set_extension("snap.new");
-                    new_snapshot.save(&new_path)?;
+                    new_snapshot.save_new(&new_path)?;
                     if should_print {
                         elog!(
                             "{} {}",

src/snapshot.rs

@@ -267,18 +267,41 @@ impl Snapshot {
         &self.snapshot.0
     }
 
-    pub(crate) fn save<P: AsRef<Path>>(&self, path: P) -> Result<(), Box<dyn Error>> {
+    fn save_with_metadata<P: AsRef<Path>>(
+        &self,
+        path: P,
+        md: &MetaData,
+    ) -> Result<(), Box<dyn Error>> {
         let path = path.as_ref();
         if let Some(folder) = path.parent() {
             fs::create_dir_all(&folder)?;
         }
         let mut f = fs::File::create(&path)?;
-        serde_yaml::to_writer(&mut f, &self.metadata)?;
+        serde_yaml::to_writer(&mut f, md)?;
         f.write_all(b"---\n")?;
         f.write_all(self.contents_str().as_bytes())?;
         f.write_all(b"\n")?;
         Ok(())
     }
+
+    /// Saves the snapshot.
+    #[doc(hidden)]
+    pub fn save<P: AsRef<Path>>(&self, path: P) -> Result<(), Box<dyn Error>> {
+        // we do not want to retain the assertion line on the metadata when storing
+        // as a regular snapshot.
+        if self.metadata.assertion_line.is_some() {
+            let mut metadata = self.metadata.clone();
+            metadata.assertion_line = None;
+            self.save_with_metadata(path, &metadata)
+        } else {
+            self.save_with_metadata(path, &self.metadata)
+        }
+    }
+
+    /// Same as `save` but also holds information only relevant for `.new` files.
+    pub(crate) fn save_new<P: AsRef<Path>>(&self, path: P) -> Result<(), Box<dyn Error>> {
+        self.save_with_metadata(path, &self.metadata)
+    }
 }
 
 /// The contents of a Snapshot

src/snapshots/insta__test__embedded.snap

@@ -1,6 +1,5 @@
 ---
 source: src/test.rs
-assertion_line: 3
 expression: "\"Just a string\""
 ---
 Just a string

tests/snapshots/snapshot_no_module_prepending.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_settings.rs
-assertion_line: 74
 expression: "vec![1, 2, 3]"
 ---
 - 1

tests/snapshots/test_basic__debug_vector.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 8
 expression: "vec![1, 2, 3]"
 ---
 [

tests/snapshots/test_basic__display.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 69
 expression: td
 ---
 TestDisplay struct

tests/snapshots/test_basic__json_vector.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 41
 expression: "vec![1, 2, 3]"
 ---
 [

tests/snapshots/test_basic__nested__nested_module.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 54
 expression: "\"aoeu\""
 ---
 aoeu

tests/snapshots/test_basic__unnamed_debug_vector-2.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 14
 expression: "vec![1, 2, 3, 4]"
 ---
 [

tests/snapshots/test_basic__unnamed_debug_vector-3.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 15
 expression: "vec![1, 2, 3, 4, 5]"
 ---
 [

tests/snapshots/test_basic__unnamed_debug_vector.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 13
 expression: "vec![1, 2, 3]"
 ---
 [

tests/snapshots/test_basic__unnamed_display-2.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 76
 expression: "\"whatever\""
 ---
 whatever

tests/snapshots/test_basic__unnamed_display.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 75
 expression: td
 ---
 TestDisplay struct

tests/snapshots/test_basic__unnamed_json_vector-2.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 47
 expression: "vec![1, 2, 3, 4]"
 ---
 [

tests/snapshots/test_basic__unnamed_json_vector-3.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 48
 expression: "vec![1, 2, 3, 4, 5]"
 ---
 [

tests/snapshots/test_basic__unnamed_json_vector.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 46
 expression: "vec![1, 2, 3]"
 ---
 [

tests/snapshots/test_basic__unnamed_nested_closure.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 22
 expression: "vec![1, 2, 3]"
 ---
 [

tests/snapshots/test_basic__unnamed_yaml_vector-2.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 35
 expression: "vec![1, 2, 3, 4]"
 ---
 - 1

tests/snapshots/test_basic__unnamed_yaml_vector-3.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 36
 expression: "vec![1, 2, 3, 4, 5]"
 ---
 - 1

tests/snapshots/test_basic__unnamed_yaml_vector.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 34
 expression: "vec![1, 2, 3]"
 ---
 - 1

tests/snapshots/test_basic__yaml_vector.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_basic.rs
-assertion_line: 29
 expression: "vec![1, 2, 3]"
 ---
 - 1

tests/snapshots/test_bugs__crlf.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_bugs.rs
-assertion_line: 3
 expression: "\"foo\\r\\nbar\\r\\nbaz\""
 ---
 foo

tests/snapshots/test_bugs__trailing_crlf.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_bugs.rs
-assertion_line: 8
 expression: "\"foo\\r\\nbar\\r\\nbaz\\r\\n\""
 ---
 foo

tests/snapshots/test_glob__basic_globbing@goodbye.txt.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_glob.rs
-assertion_line: 7
 expression: "&contents"
 input_file: tests/inputs/goodbye.txt
 ---

tests/snapshots/test_glob__basic_globbing@hello.txt.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_glob.rs
-assertion_line: 7
 expression: "&contents"
 input_file: tests/inputs/hello.txt
 ---

tests/snapshots/test_glob__globs_follow_links@goodbye.txt.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_glob.rs
-assertion_line: 15
 expression: "&contents"
 input_file: tests/inputs/goodbye.txt
 ---

tests/snapshots/test_glob__globs_follow_links@hello.txt.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_glob.rs
-assertion_line: 15
 expression: "&contents"
 input_file: tests/inputs/hello.txt
 ---

tests/snapshots/test_inline__unnamed_single_line-2.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_inline.rs
-assertion_line: 31
 expression: "\"Testing-2\""
 ---
 Testing-2

tests/snapshots/test_inline__unnamed_single_line.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_inline.rs
-assertion_line: 30
 expression: "\"Testing\""
 ---
 Testing

tests/snapshots/test_inline__unnamed_thread_single_line-2.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_inline.rs
-assertion_line: 43
 expression: "\"Testing-thread-2\""
 ---
 Testing-thread-2

tests/snapshots/test_inline__unnamed_thread_single_line.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_inline.rs
-assertion_line: 42
 expression: "\"Testing-thread\""
 ---
 Testing-thread

tests/snapshots/test_redaction__foo_bar.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 22
 expression: "Selector::parse(\".foo.bar\").unwrap()"
 ---
 Selector {

tests/snapshots/test_redaction__foo_bar_alt.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 23
 expression: "Selector::parse(\".foo[\\\"bar\\\"]\").unwrap()"
 ---
 Selector {

tests/snapshots/test_redaction__foo_bar_deep.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 28
 expression: "Selector::parse(\".foo.bar.**\").unwrap()"
 ---
 Selector {

tests/snapshots/test_redaction__foo_bar_full_range.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 24
 expression: "Selector::parse(\".foo.bar[]\").unwrap()"
 ---
 Selector {

tests/snapshots/test_redaction__foo_bar_range.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 27
 expression: "Selector::parse(\".foo.bar[10:20]\").unwrap()"
 ---
 Selector {

tests/snapshots/test_redaction__foo_bar_range_from.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 26
 expression: "Selector::parse(\".foo.bar[10:]\").unwrap()"
 ---
 Selector {

tests/snapshots/test_redaction__foo_bar_range_to.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 25
 expression: "Selector::parse(\".foo.bar[:10]\").unwrap()"
 ---
 Selector {

tests/snapshots/test_redaction__map_key_redaction.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 340
 expression: foo
 ---
 hm:

tests/snapshots/test_redaction__struct_array_redaction.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 307
 expression: "vec![checkout]"
 ---
 - _id: "[checkout_id]"

tests/snapshots/test_redaction__user.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 56
 expression: "&User{id: 23,\n      username: \"john_doe\".to_string(),\n      email: Email(\"[email protected]\".to_string()),\n      extra: \"\".to_string(),}"
 ---
 id: "[id]"

tests/snapshots/test_redaction__user_csv.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 85
 expression: "&User{id: 44,\n      username: \"julius_csv\".to_string(),\n      email: Email(\"[email protected]\".to_string()),\n      extra: \"\".to_string(),}"
 ---
 id,username,email,extra

tests/snapshots/test_redaction__user_json.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 123
 expression: "&User{id: 9999,\n      username: \"jason_doe\".to_string(),\n      email: Email(\"[email protected]\".to_string()),\n      extra: \"ssn goes here\".to_string(),}"
 ---
 {

tests/snapshots/test_redaction__user_json_flags.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 359
 expression: "&User{id: 122,\n      username: \"jason_doe\".to_string(),\n      flags:\n          vec![\"zzz\".into(), \"foo\".into(), \"aha\".into(),\n               \"is_admin\".into()].into_iter().collect(),}"
 ---
 {

tests/snapshots/test_redaction__user_json_flags_alt.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 384
 expression: "&User{id: 122,\n      username: \"jason_doe\".to_string(),\n      flags:\n          MySet(vec![\"zzz\".into(), \"foo\".into(), \"aha\".into(),\n                     \"is_admin\".into()].into_iter().collect()),}"
 ---
 {

tests/snapshots/test_redaction__user_json_settings.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 140
 expression: "&User{id: 122,\n      username: \"jason_doe\".to_string(),\n      email: Email(\"[email protected]\".to_string()),\n      extra: \"ssn goes here\".to_string(),}"
 ---
 {

tests/snapshots/test_redaction__user_json_settings_callback.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 161
 expression: "&User{id: 1234,\n      username: \"jason_doe\".to_string(),\n      email: Email(\"[email protected]\".to_string()),\n      extra: \"extra here\".to_string(),}"
 ---
 {

tests/snapshots/test_redaction__user_ron.snap

@@ -1,6 +1,5 @@
 ---
 source: tests/test_redaction.rs
-assertion_line: 98
 expression: "&User{id: 53,\n      username: \"john_ron\".to_string(),\n      email: Email(\"[email protected]\".to_string()),\n      extra: \"\".to_string(),}"
 ---
 User(