Merge b1e580e into 60947b7

Changelog.md

@@ -1,6 +1,9 @@
 # Changelog
 
-## 3.1-SNAPSHOT
+## 4.0-SNAPSHOT
+Refactor base package name (io.json.compare)  
+Refactor JSON paths from assertion error message  
+Enhanced failed JSON conversion error message    
 
 ## 3.0
 Renamed JSONCompare.assertEquals() and .assertNotEquals() to .assertMatches() and .assertNotMatches()  

README.md

@@ -81,7 +81,7 @@ JSONCompare by default matches JSON fields and values using regular expressions.
 If you have unintentional regex characters inside either expected values or expected fields, then you can quote them:  
 
 ```javascript
-String expected = "{\"a\":\"\\Qd+\\E\"}";
+String expected = "{\"a\":\"\\\\Qd+\\\\E\"}";
 String actual = "{\"a\":\"d+\"}";
 JSONCompare.assertMatches(expected, actual);
 ```

pom.xml

@@ -23,7 +23,7 @@
 
     <groupId>com.github.fslev</groupId>
     <artifactId>json-compare</artifactId>
-    <version>3.1-SNAPSHOT</version>
+    <version>4.0-SNAPSHOT</version>
 
     <dependencies>
         <!--jackson-->

src/main/java/ro/skyah/comparator/CompareMode.java → src/main/java/io/json/compare/CompareMode.java

@@ -1,4 +1,4 @@
-package ro.skyah.comparator;
+package io.json.compare;
 
 public enum CompareMode {
     JSON_OBJECT_NON_EXTENSIBLE,

src/main/java/ro/skyah/comparator/DefaultJsonComparator.java → src/main/java/io/json/compare/DefaultJsonComparator.java

@@ -1,4 +1,4 @@
-package ro.skyah.comparator;
+package io.json.compare;
 
 import java.util.regex.Pattern;
 import java.util.regex.PatternSyntaxException;

src/main/java/ro/skyah/comparator/JSONCompare.java → src/main/java/io/json/compare/JSONCompare.java

@@ -1,12 +1,12 @@
-package ro.skyah.comparator;
+package io.json.compare;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import ro.skyah.comparator.matcher.JsonMatcher;
-import ro.skyah.comparator.matcher.MatcherException;
-import ro.skyah.util.MessageUtil;
+import io.json.compare.matcher.JsonMatcher;
+import io.json.compare.matcher.MatcherException;
+import io.json.compare.util.MessageUtil;
 
 import java.io.IOException;
 import java.util.Set;
@@ -103,13 +103,11 @@ public static String prettyPrint(JsonNode jsonNode) {
     }
 
     private static JsonNode toJson(Object obj) {
-        JsonNode jsonNode = null;
         try {
-            jsonNode = obj instanceof JsonNode ? (JsonNode) obj :
+            return obj instanceof JsonNode ? (JsonNode) obj :
                     (obj instanceof String) ? MAPPER.readTree(obj.toString()) : MAPPER.convertValue(obj, JsonNode.class);
         } catch (IOException e) {
-            fail(String.format("Cannot convert to JSON:\n%s", MessageUtil.cropL(obj.toString())));
+            throw new RuntimeException(String.format("Invalid JSON\n%s\n", e));
         }
-        return jsonNode;
     }
 }

src/main/java/ro/skyah/comparator/JsonComparator.java → src/main/java/io/json/compare/JsonComparator.java

@@ -1,4 +1,4 @@
-package ro.skyah.comparator;
+package io.json.compare;
 
 public interface JsonComparator {
 

src/main/java/ro/skyah/comparator/matcher/AbstractJsonMatcher.java → src/main/java/io/json/compare/matcher/AbstractJsonMatcher.java

@@ -1,9 +1,9 @@
-package ro.skyah.comparator.matcher;
+package io.json.compare.matcher;
 
 import com.fasterxml.jackson.databind.JsonNode;
-import ro.skyah.comparator.CompareMode;
-import ro.skyah.comparator.DefaultJsonComparator;
-import ro.skyah.comparator.JsonComparator;
+import io.json.compare.CompareMode;
+import io.json.compare.DefaultJsonComparator;
+import io.json.compare.JsonComparator;
 
 import java.util.HashSet;
 import java.util.Iterator;

src/main/java/ro/skyah/comparator/matcher/JsonArrayMatcher.java → src/main/java/io/json/compare/matcher/JsonArrayMatcher.java

@@ -1,10 +1,10 @@
-package ro.skyah.comparator.matcher;
+package io.json.compare.matcher;
 
 import com.fasterxml.jackson.databind.JsonNode;
-import ro.skyah.comparator.CompareMode;
-import ro.skyah.comparator.JSONCompare;
-import ro.skyah.comparator.JsonComparator;
-import ro.skyah.util.MessageUtil;
+import io.json.compare.CompareMode;
+import io.json.compare.JSONCompare;
+import io.json.compare.JsonComparator;
+import io.json.compare.util.MessageUtil;
 
 import java.util.HashSet;
 import java.util.Set;

src/main/java/ro/skyah/comparator/matcher/JsonMatcher.java → src/main/java/io/json/compare/matcher/JsonMatcher.java

@@ -1,8 +1,8 @@
-package ro.skyah.comparator.matcher;
+package io.json.compare.matcher;
 
 import com.fasterxml.jackson.databind.JsonNode;
-import ro.skyah.comparator.CompareMode;
-import ro.skyah.comparator.JsonComparator;
+import io.json.compare.CompareMode;
+import io.json.compare.JsonComparator;
 
 import java.util.Set;
 

src/main/java/ro/skyah/comparator/matcher/JsonObjectMatcher.java → src/main/java/io/json/compare/matcher/JsonObjectMatcher.java

@@ -1,9 +1,9 @@
-package ro.skyah.comparator.matcher;
+package io.json.compare.matcher;
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.jayway.jsonpath.PathNotFoundException;
-import ro.skyah.comparator.CompareMode;
-import ro.skyah.comparator.JsonComparator;
+import io.json.compare.CompareMode;
+import io.json.compare.JsonComparator;
 
 import java.util.*;
 
@@ -34,7 +34,7 @@ public void match() throws MatcherException {
                 case MATCH:
                     if (!jsonPathExpression.isPresent()) {
                         if (candidateEntries.isEmpty()) {
-                            throw new MatcherException(String.format("Field %s was not found or cannot be matched", expectedField));
+                            throw new MatcherException(String.format("Field '%s' was not found or cannot be matched", expectedField));
                         }
                         matchWithCandidateEntries(expectedSanitizedField, expectedValue, candidateEntries);
                     } else {
@@ -49,7 +49,7 @@ public void match() throws MatcherException {
                 case DO_NOT_MATCH:
                     if (!jsonPathExpression.isPresent()) {
                         if (!candidateEntries.isEmpty()) {
-                            throw new MatcherException(String.format("Field %s was found", expectedField));
+                            throw new MatcherException(String.format("Field '%s' was found", expectedField));
                         }
                     } else {
                         try {
@@ -83,7 +83,7 @@ private void matchWithCandidateEntries(String expectedKey, JsonNode expectedValu
                 if (it.hasNext()) {
                     continue;
                 } else {
-                    throw new MatcherException(String.format("%s <- \"%s\"", e.getMessage(), expectedKey));
+                    throw new MatcherException(String.format("%s <- %s", e.getMessage(), expectedKey));
                 }
             }
             matchedFieldNames.add(candidateField);

src/main/java/ro/skyah/comparator/matcher/JsonPathMatcher.java → src/main/java/io/json/compare/matcher/JsonPathMatcher.java

@@ -1,4 +1,4 @@
-package ro.skyah.comparator.matcher;
+package io.json.compare.matcher;
 
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.JsonNode;
@@ -7,8 +7,8 @@
 import com.jayway.jsonpath.JsonPath;
 import com.jayway.jsonpath.ParseContext;
 import com.jayway.jsonpath.spi.json.JacksonJsonNodeJsonProvider;
-import ro.skyah.comparator.CompareMode;
-import ro.skyah.comparator.JsonComparator;
+import io.json.compare.CompareMode;
+import io.json.compare.JsonComparator;
 
 import java.util.Set;
 

src/main/java/ro/skyah/comparator/matcher/JsonValueMatcher.java → src/main/java/io/json/compare/matcher/JsonValueMatcher.java

@@ -1,8 +1,8 @@
-package ro.skyah.comparator.matcher;
+package io.json.compare.matcher;
 
 import com.fasterxml.jackson.databind.JsonNode;
-import ro.skyah.comparator.CompareMode;
-import ro.skyah.comparator.JsonComparator;
+import io.json.compare.CompareMode;
+import io.json.compare.JsonComparator;
 
 import java.util.Set;
 

src/main/java/ro/skyah/comparator/matcher/MatcherException.java → src/main/java/io/json/compare/matcher/MatcherException.java

@@ -1,4 +1,4 @@
-package ro.skyah.comparator.matcher;
+package io.json.compare.matcher;
 
 public class MatcherException extends Exception {
 

src/main/java/ro/skyah/util/MessageUtil.java → src/main/java/io/json/compare/util/MessageUtil.java

@@ -1,4 +1,4 @@
-package ro.skyah.util;
+package io.json.compare.util;
 
 public final class MessageUtil {
 

src/test/java/ro/skyah/comparator/JSONArrayCompareTests.java → src/test/java/io/json/compare/matcher/JSONArrayCompareTests.java

@@ -1,5 +1,6 @@
-package ro.skyah.comparator;
+package io.json.compare.matcher;
 
+import io.json.compare.JSONCompare;
 import org.junit.jupiter.api.Test;
 
 public class JSONArrayCompareTests {

src/test/java/ro/skyah/comparator/JSONBooleanCompareTests.java → src/test/java/io/json/compare/matcher/JSONBooleanCompareTests.java

@@ -1,5 +1,6 @@
-package ro.skyah.comparator;
+package io.json.compare.matcher;
 
+import io.json.compare.JSONCompare;
 import org.junit.jupiter.api.Test;
 
 public class JSONBooleanCompareTests {

src/test/java/ro/skyah/comparator/JSONCompareMessageTests.java → src/test/java/io/json/compare/matcher/JSONCompareMessageTests.java

@@ -1,5 +1,7 @@
-package ro.skyah.comparator;
+package io.json.compare.matcher;
 
+import io.json.compare.CompareMode;
+import io.json.compare.JSONCompare;
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
@@ -72,7 +74,7 @@ public void checkNullMessageFromJSONObjectFailedCompare() {
         try {
             JSONCompare.assertMatches(expected, actual, new HashSet<>(Arrays.asList(CompareMode.JSON_OBJECT_NON_EXTENSIBLE)));
         } catch (AssertionError e) {
-            assertTrue(e.getMessage().contains("Field a was not found"));
+            assertTrue(e.getMessage().contains("Field 'a' was not found"));
         }
     }
 
@@ -102,7 +104,7 @@ public void checkMessageFromFailedMatchingBetweenHighDepthJsons() {
         try {
             JSONCompare.assertMatches(expected, actual, new HashSet<>(Arrays.asList(CompareMode.JSON_OBJECT_NON_EXTENSIBLE)));
         } catch (AssertionError e) {
-            System.out.println(e);
+            assertTrue(e.getMessage().contains("Field 'version' was not found or cannot be matched <- @"));
         }
     }
 

src/test/java/ro/skyah/comparator/JSONCompareModeTests.java → src/test/java/io/json/compare/matcher/JSONCompareModeTests.java

@@ -1,5 +1,8 @@
-package ro.skyah.comparator;
+package io.json.compare.matcher;
 
+import io.json.compare.CompareMode;
+import io.json.compare.JSONCompare;
+import io.json.compare.JsonComparator;
 import org.junit.jupiter.api.Test;
 
 import java.util.Arrays;

src/test/java/ro/skyah/comparator/JSONConvertibleObjectsCompareTests.java → src/test/java/io/json/compare/matcher/JSONConvertibleObjectsCompareTests.java

@@ -1,5 +1,7 @@
-package ro.skyah.comparator;
+package io.json.compare.matcher;
 
+import io.json.compare.CompareMode;
+import io.json.compare.JSONCompare;
 import org.junit.jupiter.api.Test;
 
 import java.util.Arrays;
@@ -37,12 +39,12 @@ public void checkJsonConversionErrorMessage() {
         String expected = "{\"a\":1,\"b\":[4,2,d]}";
         Map<String, Object> actual = new HashMap<>();
         actual.put("a", 1);
-        AssertionError e = assertThrows(AssertionError.class, () -> JSONCompare.assertMatches(expected, actual));
-        assertTrue(e.getMessage().contains("Cannot convert to JSON:"));
+        RuntimeException e = assertThrows(RuntimeException.class, () -> JSONCompare.assertMatches(expected, actual));
+        assertTrue(e.getMessage().contains("Invalid JSON"));
         assertTrue(e.getMessage().contains(expected));
-        AssertionError e1 = assertThrows(AssertionError.class, () -> JSONCompare.assertMatches("{\"a\":1}", "{\"a:1}"));
-        assertTrue(e1.getMessage().contains("Cannot convert to JSON:"));
-        AssertionError e2 = assertThrows(AssertionError.class, () -> JSONCompare.assertNotMatches("{\"a\":1}", "{\"a:2}"));
-        assertTrue(e2.getMessage().contains("Cannot convert to JSON:"));
+        RuntimeException e1 = assertThrows(RuntimeException.class, () -> JSONCompare.assertMatches("{\"a\":1}", "{\"a:1}"));
+        assertTrue(e1.getMessage().contains("Invalid JSON"));
+        RuntimeException e2 = assertThrows(RuntimeException.class, () -> JSONCompare.assertNotMatches("{\"a\":1}", "{\"a:2}"));
+        assertTrue(e2.getMessage().contains("Invalid JSON"));
     }
 }

src/test/java/ro/skyah/comparator/JSONEmptyValuesCompareTests.java → src/test/java/io/json/compare/matcher/JSONEmptyValuesCompareTests.java

@@ -1,5 +1,6 @@
-package ro.skyah.comparator;
+package io.json.compare.matcher;
 
+import io.json.compare.JSONCompare;
 import org.junit.jupiter.api.Test;
 
 public class JSONEmptyValuesCompareTests {

src/test/java/ro/skyah/comparator/JSONLargeCompareTests.java → src/test/java/io/json/compare/matcher/JSONLargeCompareTests.java

@@ -1,5 +1,6 @@
-package ro.skyah.comparator;
+package io.json.compare.matcher;
 
+import io.json.compare.JSONCompare;
 import org.junit.jupiter.api.Test;
 
 import java.io.ByteArrayOutputStream;

src/test/java/ro/skyah/comparator/JSONMixedCompareTests.java → src/test/java/io/json/compare/matcher/JSONMixedCompareTests.java

@@ -1,5 +1,6 @@
-package ro.skyah.comparator;
+package io.json.compare.matcher;
 
+import io.json.compare.JSONCompare;
 import org.junit.jupiter.api.Test;
 
 public class JSONMixedCompareTests {

src/test/java/ro/skyah/comparator/JSONNullCompareTests.java → src/test/java/io/json/compare/matcher/JSONNullCompareTests.java

@@ -1,5 +1,6 @@
-package ro.skyah.comparator;
+package io.json.compare.matcher;
 
+import io.json.compare.JSONCompare;
 import org.junit.jupiter.api.Test;
 
 public class JSONNullCompareTests {

src/test/java/ro/skyah/comparator/JSONObjectCompareTests.java → src/test/java/io/json/compare/matcher/JSONObjectCompareTests.java

@@ -1,5 +1,6 @@
-package ro.skyah.comparator;
+package io.json.compare.matcher;
 
+import io.json.compare.JSONCompare;
 import org.junit.jupiter.api.Test;
 
 public class JSONObjectCompareTests {

src/test/java/ro/skyah/comparator/JSONPathCompareTests.java → src/test/java/io/json/compare/matcher/JSONPathCompareTests.java

@@ -1,5 +1,7 @@
-package ro.skyah.comparator;
+package io.json.compare.matcher;
 
+import io.json.compare.CompareMode;
+import io.json.compare.JSONCompare;
 import org.junit.jupiter.api.Test;
 
 import java.util.Arrays;
@@ -194,7 +196,7 @@ public void checkInvalidOrNotFoundJsonPathErrorMessage() {
         try {
             JSONCompare.assertMatches(expected, actual);
         } catch (AssertionError e) {
-            assertTrue(e.getMessage().contains("No results for path: $['idontexist'] <- json path ('$.idontexist') <- \"a11\" <- \"a1\" <- \"a\""));
+            assertTrue(e.getMessage().contains("No results for path: $['idontexist'] <- json path ('$.idontexist') <- a11 <- a1 <- a"));
             return;
         }
         fail("No error thrown");
@@ -214,7 +216,7 @@ public void checkJsonPathAssertionErrorMessage() {
         try {
             JSONCompare.assertMatches(expected, actual);
         } catch (AssertionError e) {
-            assertTrue(e.getMessage().contains("But found: \"lorem\"  <- json path ('$.a') <- \"a11\" <- \"a1\" <- \"a\""));
+            assertTrue(e.getMessage().contains("But found: \"lorem\"  <- json path ('$.a') <- a11 <- a1 <- a"));
             return;
         }
         fail("No error thrown");
@@ -467,7 +469,7 @@ public void matchJsonObjectWithDifferentJsonPaths_negative() {
                 "                \"isbn\": \"0-553-21311-3\",\n" +
                 "                \"price\": 8.99\n" +
                 "            },\n" +
-                "!.*," +
+                "\"!.*\"" +
                 "]}";
         assertThrows(AssertionError.class, () -> JSONCompare.assertMatches(expected1, actual));
     }

src/test/java/ro/skyah/comparator/JSONRegexCompareTests.java → src/test/java/io/json/compare/matcher/JSONRegexCompareTests.java

@@ -1,5 +1,6 @@
-package ro.skyah.comparator;
+package io.json.compare.matcher;
 
+import io.json.compare.JSONCompare;
 import org.junit.jupiter.api.Test;
 
 public class JSONRegexCompareTests {

src/test/java/ro/skyah/comparator/JSONUseCaseCompareTests.java → src/test/java/io/json/compare/matcher/JSONUseCaseCompareTests.java

@@ -1,5 +1,6 @@
-package ro.skyah.comparator;
+package io.json.compare.matcher;
 
+import io.json.compare.JSONCompare;
 import org.junit.jupiter.api.Test;
 
 public class JSONUseCaseCompareTests {