net.javacrumbs.jsonunit.spring.JsonUnitResultMatchers Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of json-unit-spring Show documentation
Spring Mock assertions
The newest version!
/**
 * Copyright 2009-2019 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 

 * http://www.apache.org/licenses/LICENSE-2.0
 * 

 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.javacrumbs.jsonunit.spring;

import java.io.UnsupportedEncodingException;
import java.nio.charset.StandardCharsets;
import java.util.function.Consumer;
import java.util.function.Function;
import net.javacrumbs.jsonunit.core.Configuration;
import net.javacrumbs.jsonunit.core.internal.matchers.InternalMatcher;
import org.jetbrains.annotations.NotNull;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.ResultMatcher;

/**
 * Matchers compatible with Spring MVC test framework.
 * 

 * Sample usage:
 * 
 * 
 * this.mockMvc.perform(get("/sample").accept(MediaType.APPLICATION_JSON)).andExpect(json().isEqualTo(CORRECT_JSON));
 * 
 */
public class JsonUnitResultMatchers extends AbstractSpringMatchers {
    private JsonUnitResultMatchers(Configuration configuration, Function jsonTransformer) {
        super(configuration, jsonTransformer);
    }

    /**
     * Creates JsonUnitResultMatchers to be used for JSON assertions.
     */
    public static JsonUnitResultMatchers json() {
        return new JsonUnitResultMatchers(Configuration.empty(), Function.identity());
    }

    @Override
    @NotNull
    ResultMatcher matcher(@NotNull Consumer matcher) {
        return new JsonResultMatcher(configuration, matcher, jsonTransformer);
    }

    @Override
    @NotNull
    JsonUnitResultMatchers matchers(
            @NotNull Configuration configuration, @NotNull Function jsonTransformer) {
        return new JsonUnitResultMatchers(configuration, jsonTransformer);
    }

    private static class JsonResultMatcher extends AbstractSpringMatcher implements ResultMatcher {
        private JsonResultMatcher(
                @NotNull Configuration configuration,
                @NotNull Consumer matcher,
                @NotNull Function jsonTransformer) {
            super(configuration, matcher, jsonTransformer);
        }

        @Override
        public void match(@NotNull MvcResult result) throws Exception {
            String actual = getContentAsString(result.getResponse());
            doMatch(actual);
        }

        @NotNull
        private String getContentAsString(@NotNull MockHttpServletResponse response)
                throws UnsupportedEncodingException {
            return response.getContentAsString(StandardCharsets.UTF_8);
        }
    }
}