io.json.compare.JSONCompare Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of json-compare Show documentation
Java library for comparing JSONs
The newest version!
package io.json.compare;

import com.fasterxml.jackson.databind.JsonNode;
import io.json.compare.matcher.JsonMatcher;
import io.json.compare.util.JsonUtils;
import org.junit.jupiter.api.AssertionFailureBuilder;

import java.io.IOException;
import java.util.List;
import java.util.Set;


/**
 * @author fslev
 */

public class JSONCompare {

    private JSONCompare() {
    }

    private static final String ASSERTION_ERROR_HINT_MESSAGE = "Json matching is by default case-sensitive and uses regular expressions." + System.lineSeparator() +
            "In case expected json contains any unintentional regexes, then quote them between \\Q and \\E delimiters.\n" +
            "For disabling case-sensitivity, use (?i) and (?-i) modifiers. Or, use a custom comparator.";

    public static void assertMatches(Object expected, Object actual) {
        assertMatches(expected, actual, null, null, null);
    }

    public static void assertNotMatches(Object expected, Object actual) {
        assertNotMatches(expected, actual, null, null, null);
    }

    public static void assertMatches(Object expected, Object actual, Set compareModes) {
        assertMatches(expected, actual, null, compareModes);
    }

    public static void assertNotMatches(Object expected, Object actual, Set compareModes) {
        assertNotMatches(expected, actual, null, compareModes);
    }

    public static void assertMatches(Object expected, Object actual, JsonComparator comparator) {
        assertMatches(expected, actual, comparator, null);
    }

    public static void assertNotMatches(Object expected, Object actual, JsonComparator comparator) {
        assertNotMatches(expected, actual, comparator, null);
    }

    public static void assertMatches(Object expected, Object actual, JsonComparator comparator, Set compareModes) {
        assertMatches(expected, actual, comparator, compareModes, null);
    }

    public static void assertNotMatches(Object expected, Object actual, JsonComparator comparator, Set compareModes) {
        assertNotMatches(expected, actual, comparator, compareModes, null);
    }

    public static void assertMatches(Object expected, Object actual, Set compareModes, String message) {
        assertMatches(expected, actual, null, compareModes, message);
    }

    public static void assertNotMatches(Object expected, Object actual, Set compareModes, String message) {
        assertNotMatches(expected, actual, null, compareModes, message);
    }

    public static void assertMatches(Object expected, Object actual, JsonComparator comparator, Set compareModes, String message) {
        JsonNode expectedJson = toJson(expected);
        JsonNode actualJson = toJson(actual);
        List diffs = new JsonMatcher(expectedJson, actualJson,
                comparator == null ? new DefaultJsonComparator(compareModes) : comparator, compareModes).match();
        if (!diffs.isEmpty()) {
            String defaultMessage = String.format("FOUND %s DIFFERENCE(S):%s%s%s",
                    diffs.size(), System.lineSeparator(), diffs.stream().map(diff ->
                            System.lineSeparator() + System.lineSeparator() + "_________________________DIFF__________________________" +
                                    System.lineSeparator() + diff).reduce(String::concat).get(), System.lineSeparator());
            if (comparator == null || comparator.getClass().equals(DefaultJsonComparator.class)) {
                defaultMessage += System.lineSeparator() + System.lineSeparator() + ASSERTION_ERROR_HINT_MESSAGE + System.lineSeparator();
            }
            AssertionFailureBuilder.assertionFailure().message(message == null ? defaultMessage : defaultMessage + System.lineSeparator() + message)
                    .expected(prettyPrint(expectedJson)).actual(prettyPrint(actualJson)).buildAndThrow();
        }
    }

    public static void assertNotMatches(Object expected, Object actual, JsonComparator comparator, Set compareModes, String message) {
        JsonNode expectedJson = toJson(expected);
        JsonNode actualJson = toJson(actual);
        List diffs = new JsonMatcher(expectedJson, actualJson,
                comparator == null ? new DefaultJsonComparator(compareModes) : comparator, compareModes).match();
        if (!diffs.isEmpty()) {
            return;
        }
        String defaultMessage = System.lineSeparator() + "JSONs are equal";
        AssertionFailureBuilder.assertionFailure().message(message == null ? defaultMessage : defaultMessage + System.lineSeparator() + message)
                .expected(prettyPrint(expectedJson)).actual(prettyPrint(actualJson))
                .includeValuesInMessage(false).buildAndThrow();
    }

    public static List diffs(Object expected, Object actual) {
        return diffs(expected, actual, null, null);
    }

    public static List diffs(Object expected, Object actual, Set compareModes) {
        return diffs(expected, actual, null, compareModes);
    }

    public static List diffs(Object expected, Object actual, JsonComparator comparator) {
        return diffs(expected, actual, comparator, null);
    }

    public static List diffs(Object expected, Object actual, JsonComparator comparator, Set compareModes) {
        JsonNode expectedJson = toJson(expected);
        JsonNode actualJson = toJson(actual);
        return new JsonMatcher(expectedJson, actualJson,
                comparator == null ? new DefaultJsonComparator(compareModes) : comparator, compareModes).match();
    }

    public static String prettyPrint(JsonNode jsonNode) {
        try {
            return JsonUtils.prettyPrint(jsonNode);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

    private static JsonNode toJson(Object obj) {
        try {
            return JsonUtils.toJson(obj);
        } catch (IOException e) {
            throw new RuntimeException(String.format("Invalid JSON%s%s%s", System.lineSeparator(), e, System.lineSeparator()));
        }
    }
}