review: add snapshot test with proper redaction

Author: BillCarsonFr

crates/matrix-sdk-crypto/src/machine/tests/send_encrypted_to_device.rs

@@ -13,9 +13,10 @@
 // limitations under the License.
 
 use assert_matches2::{assert_let, assert_matches};
+use insta::assert_json_snapshot;
 use matrix_sdk_test::async_test;
 use ruma::{events::AnyToDeviceEvent, serde::Raw, to_device::DeviceIdOrAllDevices};
-use serde_json::{json, value::to_raw_value};
+use serde_json::{json, value::to_raw_value, Value};
 
 use crate::{
     machine::{
@@ -112,11 +113,17 @@ async fn test_processed_to_device_variants() {
     let (alice, bob) =
         get_machine_pair_with_session(tests::alice_id(), tests::user_id(), false).await;
 
-    let custom_event_type = "m.new_device";
+    let custom_event_type = "rtc.call.encryption_keys";
 
     let custom_content = json!({
             "device_id": "XYZABCDE",
-            "rooms": ["!726s6s6q:example.com"]
+            "call_id": "",
+            "keys": [
+                {
+                    "index": 0,
+                    "key": "I7qrSrCR7Yo9B4iGVnR8IA"
+                }
+            ],
     });
 
     let device = alice.get_device(bob.user_id(), bob.device_id(), None).await.unwrap().unwrap();
@@ -210,14 +217,38 @@ async fn test_processed_to_device_variants() {
     let processed_event = &processed[0];
     assert_matches!(processed_event, ProcessedToDeviceEvent::Decrypted(_));
 
+    assert_json_snapshot!(
+        serde_json::from_str::<Value>(processed_event.to_raw().json().get()).unwrap(),
+         {
+             ".keys.ed25519" => "[sender_ed25519_key]",
+             r#"["org.matrix.msc4147.device_keys"].device_id"# => "[ABCDEFGH]",
+             r#"["org.matrix.msc4147.device_keys"].keys"# => "++REDACTED++",
+             r#"["org.matrix.msc4147.device_keys"].signatures"# => "++REDACTED++",
+             ".recipient_keys.ed25519" => "[recipient_sender_key]",
+        }
+    );
+
     let processed_event = &processed[1];
     assert_matches!(processed_event, ProcessedToDeviceEvent::PlainText(_));
+    assert_json_snapshot!(
+        serde_json::from_str::<Value>(processed_event.to_raw().json().get()).unwrap(),
+    );
 
     let processed_event = &processed[2];
     assert_matches!(processed_event, ProcessedToDeviceEvent::Invalid(_));
+    assert_json_snapshot!(
+        serde_json::from_str::<Value>(processed_event.to_raw().json().get()).unwrap(),
+    );
 
     let processed_event = &processed[3];
-    assert_matches!(processed_event, ProcessedToDeviceEvent::UnableToDecrypt { .. });
+    assert_matches!(processed_event, ProcessedToDeviceEvent::UnableToDecrypt(_));
+    assert_json_snapshot!(
+        serde_json::from_str::<Value>(processed_event.to_raw().json().get()).unwrap(),
+        {
+            ".content.sender_key" => "[sender_ed25519_key]",
+            ".content.ciphertext" => "[++REDACTED++]",
+        }
+    );
 }
 
 #[async_test]

crates/matrix-sdk-crypto/src/machine/tests/snapshots/matrix_sdk_crypto__machine__tests__send_encrypted_to_device__processed_to_device_variants-2.snap

@@ -0,0 +1,14 @@
+---
+source: crates/matrix-sdk-crypto/src/machine/tests/send_encrypted_to_device.rs
+expression: "serde_json::from_str::<Value>(processed_event.to_raw().json().get()).unwrap()"
+---
+{
+  "content": {
+    "device_id": "XYZABCDE",
+    "rooms": [
+      "!726s6s6q:example.com"
+    ]
+  },
+  "sender": "@alice:example.com",
+  "type": "m.new_device"
+}

crates/matrix-sdk-crypto/src/machine/tests/snapshots/matrix_sdk_crypto__machine__tests__send_encrypted_to_device__processed_to_device_variants-3.snap

@@ -0,0 +1,13 @@
+---
+source: crates/matrix-sdk-crypto/src/machine/tests/send_encrypted_to_device.rs
+expression: "serde_json::from_str::<Value>(processed_event.to_raw().json().get()).unwrap()"
+---
+{
+  "content": {
+    "device_id": "XYZABCDE",
+    "rooms": [
+      "!726s6s6q:example.com"
+    ]
+  },
+  "sender": "@alice:example.com"
+}

crates/matrix-sdk-crypto/src/machine/tests/snapshots/matrix_sdk_crypto__machine__tests__send_encrypted_to_device__processed_to_device_variants-4.snap

@@ -0,0 +1,14 @@
+---
+source: crates/matrix-sdk-crypto/src/machine/tests/send_encrypted_to_device.rs
+expression: "serde_json::from_str::<Value>(processed_event.to_raw().json().get()).unwrap()"
+---
+{
+  "content": {
+    "algorithm": "m.olm.v1.curve25519-aes-sha2",
+    "ciphertext": "[++REDACTED++]",
+    "org.matrix.msgid": "93ee0170aa7740d0ac9ee137e820302d",
+    "sender_key": "[sender_ed25519_key]"
+  },
+  "sender": "@alice:example.org",
+  "type": "m.room.encrypted"
+}

crates/matrix-sdk-crypto/src/machine/tests/snapshots/matrix_sdk_crypto__machine__tests__send_encrypted_to_device__processed_to_device_variants.snap

@@ -0,0 +1,35 @@
+---
+source: crates/matrix-sdk-crypto/src/machine/tests/send_encrypted_to_device.rs
+expression: "serde_json::from_str::<Value>(processed_event.to_raw().json().get()).unwrap()"
+---
+{
+  "content": {
+    "call_id": "",
+    "device_id": "XYZABCDE",
+    "keys": [
+      {
+        "index": 0,
+        "key": "I7qrSrCR7Yo9B4iGVnR8IA"
+      }
+    ]
+  },
+  "keys": {
+    "ed25519": "[sender_ed25519_key]"
+  },
+  "org.matrix.msc4147.device_keys": {
+    "algorithms": [
+      "m.olm.v1.curve25519-aes-sha2",
+      "m.megolm.v1.aes-sha2"
+    ],
+    "device_id": "[ABCDEFGH]",
+    "keys": "++REDACTED++",
+    "signatures": "++REDACTED++",
+    "user_id": "@alice:example.org"
+  },
+  "recipient": "@bob:example.com",
+  "recipient_keys": {
+    "ed25519": "[recipient_sender_key]"
+  },
+  "sender": "@alice:example.org",
+  "type": "rtc.call.encryption_keys"
+}