CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to insta and cargo-insta are documented here.
 
+## 1.8.0
+
+- Added the ability to redact into a key. (#192)
+
 ## 1.7.2
 
 - Fixed an issue where selectors could not start with underscore. (#189)

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "insta"
-version = "1.7.2"
+version = "1.8.0"
 license = "Apache-2.0"
 authors = ["Armin Ronacher <armin.ronacher@active-4.com>"]
 description = "A snapshot testing library for Rust"

cargo-insta/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cargo-insta"
-version = "1.7.2"
+version = "1.8.0"
 license = "Apache-2.0"
 authors = ["Armin Ronacher <armin.ronacher@active-4.com>"]
 description = "A review tool for the insta snapshot testing library for Rust"
@@ -12,7 +12,7 @@ edition = "2018"
 readme = "README.md"
 
 [dependencies]
-insta = { version = "1.7.2", path = "..", features = ["redactions"] }
+insta = { version = "1.8.0", path = "..", features = ["redactions"] }
 console = "0.14.0"
 clap = { version = "2.33.3", default-features = false }
 difference = "2.0.0"

src/redaction.rs

@@ -417,10 +417,15 @@ impl<'a> Selector<'a> {
                 Content::Map(map) => Content::Map(
                     map.into_iter()
                         .map(|(key, value)| {
+                            path.push(PathItem::Field("$key"));
+                            let new_key = self.redact_impl(key.clone(), redaction, path);
+                            path.pop();
+
                             path.push(PathItem::Content(key.clone()));
                             let new_value = self.redact_impl(value, redaction, path);
                             path.pop();
-                            (key, new_value)
+
+                            (new_key, new_value)
                         })
                         .collect(),
                 ),

src/select_grammar.pest

@@ -1,6 +1,6 @@
 WHITESPACE = _{ WHITE_SPACE }
 
-ident = @{ ( "_" | XID_START ) ~ XID_CONTINUE* }
+ident = @{ ( "_" | "$" | XID_START ) ~ XID_CONTINUE* }
 deep_wildcard = { "." ~ "**" }
 wildcard = { "." ~ "*" }
 key = @{ "." ~ ident }

tests/snapshots/test_redaction__map_key_redaction.snap

@@ -0,0 +1,10 @@
+---
+source: tests/test_redaction.rs
+expression: foo
+---
+hm:
+  ? bucket: "[bucket]"
+    value: 0
+  : 42
+btm:
+  "[key]": 23

tests/test_redaction.rs

@@ -1,5 +1,7 @@
 #![cfg(feature = "redactions")]
 
+use std::collections::{BTreeMap, HashMap};
+
 use insta::_macro_support::Selector;
 use insta::{
     assert_debug_snapshot, assert_json_snapshot, assert_yaml_snapshot, with_settings, Settings,
@@ -307,3 +309,35 @@ fn test_struct_array_redaction() {
         "[].products[].product_name" => "[product_name]",
     });
 }
+
+#[test]
+fn test_map_key_redaction() {
+    #[derive(Serialize, Hash, PartialEq, PartialOrd, Eq, Ord)]
+    struct Key {
+        bucket: u32,
+        value: u32,
+    }
+
+    #[derive(Serialize)]
+    struct Foo {
+        hm: HashMap<Key, u32>,
+        btm: BTreeMap<(u32, u32), u32>,
+    }
+
+    let mut hm = HashMap::new();
+    hm.insert(
+        Key {
+            bucket: 1,
+            value: 0,
+        },
+        42,
+    );
+    let mut btm = BTreeMap::new();
+    btm.insert((0, 0), 23);
+    let foo = Foo { hm, btm };
+
+    insta::assert_yaml_snapshot!(foo, {
+        ".hm.$key.bucket" => "[bucket]",
+        ".btm.$key" => "[key]",
+    });
+}