org.springframework.test.web.servlet.result.HeaderResultMatchers Maven / Gradle / Ivy
Show all versions of spring-test Show documentation
/*
* Copyright 2002-2020 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
*
* https://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 org.springframework.test.web.servlet.result;
import java.util.Arrays;
import java.util.List;
import org.hamcrest.Matcher;
import org.springframework.http.HttpHeaders;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.test.web.servlet.ResultMatcher;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.springframework.test.util.AssertionErrors.assertEquals;
import static org.springframework.test.util.AssertionErrors.assertFalse;
import static org.springframework.test.util.AssertionErrors.assertNotNull;
import static org.springframework.test.util.AssertionErrors.assertTrue;
/**
* Factory for response header assertions.
*
* An instance of this class is available via
* {@link MockMvcResultMatchers#header}.
*
* @author Rossen Stoyanchev
* @author Sam Brannen
* @author Brian Clozel
* @since 3.2
*/
public class HeaderResultMatchers {
/**
* Protected constructor.
* See {@link MockMvcResultMatchers#header()}.
*/
protected HeaderResultMatchers() {
}
/**
* Assert the primary value of the response header with the given Hamcrest
* String {@code Matcher}.
*/
public ResultMatcher string(String name, Matcher matcher) {
return result -> assertThat("Response header '" + name + "'", result.getResponse().getHeader(name), matcher);
}
/**
* Assert the values of the response header with the given Hamcrest
* Iterable {@link Matcher}.
* @since 4.3
*/
public ResultMatcher stringValues(String name, Matcher> matcher) {
return result -> {
List values = result.getResponse().getHeaders(name);
assertThat("Response header '" + name + "'", values, matcher);
};
}
/**
* Assert the primary value of the response header as a String value.
*/
public ResultMatcher string(String name, String value) {
return result -> assertEquals("Response header '" + name + "'", value, result.getResponse().getHeader(name));
}
/**
* Assert the values of the response header as String values.
* @since 4.3
*/
public ResultMatcher stringValues(String name, String... values) {
return result -> {
List