add redactedProperties

php-arsenal · Sep 4, 2021 · 974723b · 974723b
1 parent c0febc9
commit 974723b
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 6 deletions.
diff --git a/src/SnapshotDriver/SnapshotJsonObjectDriver.php b/src/SnapshotDriver/SnapshotJsonObjectDriver.php
@@ -14,7 +14,10 @@
 
 class SnapshotJsonObjectDriver implements Driver
 {
-    public function __construct(private array $ignoredProperties = [])
+    public function __construct(
+        private array $ignoredProperties = [],
+        private array $redactedProperties = []
+    )
     {
     }
 
@@ -39,7 +42,8 @@ public function serialize($data): string
             AbstractNormalizer::IGNORED_ATTRIBUTES => $this->ignoredProperties,
         ]);
 
-        $this->unsetIgnoredKeys($normalizedData, $this->ignoredProperties);
+        $this->ignoreKeys($normalizedData, $this->ignoredProperties);
+        $this->redactKeys($normalizedData, $this->redactedProperties);
 
         return $serializer->serialize($normalizedData, JsonEncoder::FORMAT, [
             'json_encode_options' => JSON_PRETTY_PRINT
@@ -56,14 +60,27 @@ public function match($expected, $actual)
         Assert::assertEquals($expected, $this->serialize($actual));
     }
 
-    private function unsetIgnoredKeys(array &$values, array $ignoredKeys): void
+    private function ignoreKeys(array &$values, array $ignoredKeys): void
     {
         foreach($values as $key => $value) {
             if (in_array($key, $ignoredKeys)) {
                 unset($values[$key]);
             }
             else if(is_array($value)) {
-                $this->unsetIgnoredKeys($value, $ignoredKeys);
+                $this->ignoreKeys($value, $ignoredKeys);
+                $values[$key] = $value;
+            }
+        }
+    }
+
+    private function redactKeys(array &$values, array $redactedKeys): void
+    {
+        foreach($values as $key => $value) {
+            if (in_array($key, $redactedKeys)) {
+                $values[$key] = 'REDACTED';
+            }
+            else if(is_array($value)) {
+                $this->redactKeys($value, $redactedKeys);
                 $values[$key] = $value;
             }
         }

diff --git a/src/Traits/AssertMatchesJsonObjectSnapshotTrait.php b/src/Traits/AssertMatchesJsonObjectSnapshotTrait.php
@@ -9,8 +9,8 @@ trait AssertMatchesJsonObjectSnapshotTrait
 {
     use MatchesSnapshots;
 
-    public function assertMatchesJsonObjectSnapshot($actual, array $ignoredProperties = []): void
+    public function assertMatchesJsonObjectSnapshot($actual, array $ignoredProperties = [], array $redactedProperties = []): void
     {
-        $this->assertMatchesSnapshot($actual, new SnapshotJsonObjectDriver($ignoredProperties));
+        $this->assertMatchesSnapshot($actual, new SnapshotJsonObjectDriver($ignoredProperties, $redactedProperties));
     }
 }