Merge pull request #184 from lukas-krecan/ignore-missing2

#182 Ignore paths even if present in expected value
lukas-krecan · May 25, 2019 · 0eb1924 · 0eb1924
2 parents 8a67530 + e1eaa97
commit 0eb1924
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 3 deletions.
diff --git a/json-unit-assertj/src/main/java/net/javacrumbs/jsonunit/assertj/JsonAssert.java b/json-unit-assertj/src/main/java/net/javacrumbs/jsonunit/assertj/JsonAssert.java
@@ -340,6 +340,13 @@ public ConfigurableJsonAssert withTolerance(double tolerance) {
             return withTolerance(BigDecimal.valueOf(tolerance));
         }
 
+        /**
+         * Makes JsonUnit ignore the specified paths in the actual value. If the path matches,
+         * it's completely ignored. It may be missing, null or have any value
+         *
+         * @param pathsToBeIgnored
+         * @return
+         */
         public ConfigurableJsonAssert whenIgnoringPaths(String... pathsToBeIgnored) {
             return withConfiguration(c -> c.whenIgnoringPaths(pathsToBeIgnored));
         }

diff --git a/json-unit-core/src/main/java/net/javacrumbs/jsonunit/core/Configuration.java b/json-unit-core/src/main/java/net/javacrumbs/jsonunit/core/Configuration.java
@@ -118,6 +118,13 @@ public Configuration withOptions(Options options) {
         return new Configuration(tolerance, options, ignorePlaceholder, matchers, pathsToBeIgnored, differenceListener);
     }
 
+    /**
+     * Makes JsonUnit ignore the specified paths in the actual value. If the path matches,
+     * it's completely ignored. It may be missing, null or have any value
+     *
+     * @param pathsToBeIgnored
+     * @return
+     */
     public Configuration whenIgnoringPaths(String... pathsToBeIgnored) {
         return new Configuration(tolerance, options, ignorePlaceholder, matchers, asList(pathsToBeIgnored), differenceListener);
     }

diff --git a/json-unit-core/src/main/java/net/javacrumbs/jsonunit/core/internal/Diff.java b/json-unit-core/src/main/java/net/javacrumbs/jsonunit/core/internal/Diff.java
@@ -151,6 +151,7 @@ private void compareObjectNodes(Context context) {
             }
 
             removePathsToBeIgnored(path, extraKeys);
+            removePathsToBeIgnored(path, missingKeys);
 
             removeMissingIgnoredElements(expected, missingKeys);
 
@@ -172,8 +173,8 @@ private void compareObjectNodes(Context context) {
         }
     }
 
-    private boolean removeMissingIgnoredElements(Node expected, Set<String> missingKeys) {
-        return missingKeys.removeIf(missingKey -> shouldIgnoreElement(expected.get(missingKey)));
+    private void removeMissingIgnoredElements(Node expected, Set<String> missingKeys) {
+        missingKeys.removeIf(missingKey -> shouldIgnoreElement(expected.get(missingKey)));
     }
 
     @SuppressWarnings("unchecked")

diff --git a/json-unit-fluent/src/main/java/net/javacrumbs/jsonunit/fluent/JsonFluentAssert.java b/json-unit-fluent/src/main/java/net/javacrumbs/jsonunit/fluent/JsonFluentAssert.java
@@ -357,7 +357,8 @@ public ConfigurableJsonFluentAssert node(String newPath) {
         }
 
         /**
-         * Adds paths to be ignored
+         * Makes JsonUnit ignore the specified paths in the actual value. If the path matches,
+         * it's completely ignored. It may be missing, null or have any value
          */
         public ConfigurableJsonFluentAssert whenIgnoringPaths(String... pathsToBeIgnored) {
             return new ConfigurableJsonFluentAssert(actual, path, description, configuration.whenIgnoringPaths(pathsToBeIgnored));

diff --git a/json-unit/src/main/java/net/javacrumbs/jsonunit/JsonMatchers.java b/json-unit/src/main/java/net/javacrumbs/jsonunit/JsonMatchers.java
@@ -163,6 +163,10 @@ public ConfigurableJsonMatcher<T> withMatcher(String matcherName, Matcher<?> mat
             return this;
         }
 
+        /**
+         * Makes JsonUnit ignore the specified paths in the actual value. If the path matches,
+         * it's completely ignored. It may be missing, null or have any value
+         */
         public ConfigurableJsonMatcher<T> whenIgnoringPaths(String... paths) {
             configuration = configuration.whenIgnoringPaths(paths);
             return this;

diff --git a/tests/test-base/src/main/java/net/javacrumbs/jsonunit/test/base/AbstractAssertJTest.java b/tests/test-base/src/main/java/net/javacrumbs/jsonunit/test/base/AbstractAssertJTest.java
@@ -411,6 +411,20 @@ void multipleFailuresErrorShouldbeCorrectlyFormatted() {
             });
     }
 
+    @Test
+    void shouldIgnoreMissingPathEvenIfItIsInExpectedValue() {
+        assertThatJson("{\"root\":{\"foo\":1}}")
+                .whenIgnoringPaths("root.bar", "missing")
+                .isEqualTo("{\"root\":{\"foo\":1, \"bar\":2}, \"missing\":{\"quux\":\"test\"}}");
+    }
+
+    @Test
+    void shouldIgnoreArrayElement() {
+        assertThatJson("{\"root\":[0, 1, 2]}")
+                .whenIgnoringPaths("root[1]")
+                .isEqualTo("{\"root\":[0, 8, 2]}");
+    }
+
     @Test
     void arraySimpleIgnoringOrderNotEqualComparison() {
         assertThatJson("{\"a\":[{\"b\": 1}, {\"c\": 1}, {\"d\": 1}]}").when(Option.IGNORING_ARRAY_ORDER).node("a").isArray()