Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue #109 unique key for an arrays of json objects #177

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Issue #109 unique key for an arrays of json objects #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/main/java/org/skyscreamer/jsonassert/Customization.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,24 @@
public final class Customization {
private final Pattern path;
private final ValueMatcher<Object> comparator;
private String arrayUniqueKey;

public Customization(String path, ValueMatcher<Object> comparator) {
assert path != null;
assert comparator != null;
this.path = Pattern.compile(buildPattern(path));
this.comparator = comparator;
}
public Customization(String path, String arrayUniqueKey) {
assert path != null;
this.path = Pattern.compile(buildPattern(path));
this.comparator = null;
this.arrayUniqueKey=arrayUniqueKey;
}

public String getArrayUniqueKey() {
return arrayUniqueKey;
}

private String buildPattern(String path) {
return buildPatternLevel1(path);
Expand Down
10 changes: 9 additions & 1 deletion src/main/java/org/skyscreamer/jsonassert/comparator/AbstractComparator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,15 @@ protected void checkJsonObjectKeysExpectedInActual(String prefix, JSONObject exp

protected void compareJSONArrayOfJsonObjects(String key, JSONArray expected, JSONArray actual, JSONCompareResult result) throws JSONException {
String uniqueKey = findUniqueKey(expected);
doCompareJSONArrayOfJsonObjects(key, expected, actual, result, uniqueKey);
}

protected void compareJSONArrayOfJsonObjects(String key, JSONArray expected, JSONArray actual, JSONCompareResult result, String uniqueKey) throws JSONException {
doCompareJSONArrayOfJsonObjects(key, expected, actual, result, uniqueKey);
}

private void doCompareJSONArrayOfJsonObjects(String key, JSONArray expected, JSONArray actual,
JSONCompareResult result, String uniqueKey) throws JSONException {
if (uniqueKey == null || !isUsableAsUniqueKey(uniqueKey, actual)) {
// An expensive last resort
recursivelyCompareJSONArray(key, expected, actual, result);
Expand All @@ -103,7 +112,6 @@ protected void compareJSONArrayOfJsonObjects(String key, JSONArray expected, JSO
}
}
}

protected void compareJSONArrayOfSimpleValues(String key, JSONArray expected, JSONArray actual, JSONCompareResult result) throws JSONException {
Map<Object, Integer> expectedCount = JSONCompareUtil.getCardinalityMap(jsonArrayToList(expected));
Map<Object, Integer> actualCount = JSONCompareUtil.getCardinalityMap(jsonArrayToList(actual));
Expand Down
10 changes: 8 additions & 2 deletions src/main/java/org/skyscreamer/jsonassert/comparator/CustomComparator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

package org.skyscreamer.jsonassert.comparator;

import org.json.JSONArray;
import org.json.JSONException;
import org.skyscreamer.jsonassert.Customization;
import org.skyscreamer.jsonassert.JSONCompareMode;
Expand All @@ -35,7 +36,7 @@ public CustomComparator(JSONCompareMode mode, Customization... customizations)
@Override
public void compareValues(String prefix, Object expectedValue, Object actualValue, JSONCompareResult result) throws JSONException {
Customization customization = getCustomization(prefix);
if (customization != null) {
if (customization != null && customization.getArrayUniqueKey() == null) {
try {
if (!customization.matches(prefix, actualValue, expectedValue, result)) {
result.fail(prefix, expectedValue, actualValue);
Expand All @@ -45,7 +46,12 @@ public void compareValues(String prefix, Object expectedValue, Object actualValu
result.fail(prefix, e);
}
} else {
super.compareValues(prefix, expectedValue, actualValue, result);
String arrayUniqueKey = customization == null ? null : customization.getArrayUniqueKey();
if (expectedValue instanceof JSONArray && arrayUniqueKey != null) {
compareJSONArrayOfJsonObjects(prefix, (JSONArray) expectedValue, (JSONArray) actualValue, result, arrayUniqueKey);
} else {
super.compareValues(prefix, expectedValue, actualValue, result);
}
}
}

Expand Down
64 changes: 64 additions & 0 deletions src/test/java/org/skyscreamer/jsonassert/JSONArrayObjectsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
package org.skyscreamer.jsonassert;


import java.util.UUID;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.junit.Test;
import org.skyscreamer.jsonassert.comparator.CustomComparator;

public class JSONArrayObjectsTest {

public static final UUID RANDOM_ID_1 = UUID.randomUUID();
public static final UUID RANDOM_ID_2 = UUID.randomUUID();
public static final String ARRAY_NAME = "arrayName";
public static final String ID = "id";
public static final String DATE = "date";

@Test
public void testJsonArrayWithIgnoredFieldAndProvidedIdField() throws JSONException {

JSONArray jsonArray1 = getJsonArray(RANDOM_ID_1, RANDOM_ID_2);
JSONArray jsonArray2 = getJsonArray(RANDOM_ID_2, RANDOM_ID_1);

JSONObject jsonObject1 = new JSONObject();
jsonObject1.put(ARRAY_NAME, jsonArray1);

JSONObject jsonObject2 = new JSONObject();
jsonObject2.put(ARRAY_NAME, jsonArray2);

CustomComparator customComparator = new CustomComparator(
JSONCompareMode.LENIENT,
new Customization("**." + DATE, getDummyMatcher()), //ignoring this field
new Customization(ARRAY_NAME, ID)
);

JSONAssert.assertEquals(jsonObject1, jsonObject2, customComparator);
}

private static ValueMatcher<Object> getDummyMatcher() {
return new ValueMatcher<Object>() {
@Override
public boolean equal(Object o1, Object o2) {
return true;
}
};
}

private static JSONArray getJsonArray(UUID randomId2, UUID randomId1) throws JSONException {
JSONArray jsonArray1 = new JSONArray();

JSONObject jsonObject1 = new JSONObject();
jsonObject1.put(ID, randomId2);
jsonObject1.put(DATE, UUID.randomUUID());

JSONObject jsonObject2 = new JSONObject();
jsonObject2.put(ID, randomId1);
jsonObject2.put(DATE, UUID.randomUUID());

jsonArray1.put(jsonObject1);
jsonArray1.put(jsonObject2);
return jsonArray1;
}
}