/*
* Copyright 2002-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
*
* 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.web.servlet.mvc.condition;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import javax.servlet.http.HttpServletRequest;
import org.junit.Test;
import org.springframework.http.MediaType;
import org.springframework.mock.web.test.MockHttpServletRequest;
import org.springframework.web.accept.ContentNegotiationManager;
import org.springframework.web.accept.FixedContentNegotiationStrategy;
import org.springframework.web.accept.HeaderContentNegotiationStrategy;
import org.springframework.web.servlet.mvc.condition.ProducesRequestCondition.ProduceMediaTypeExpression;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
/**
* Unit tests for {@link ProducesRequestCondition}.
*
* @author Arjen Poutsma
* @author Rossen Stoyanchev
*/
public class ProducesRequestConditionTests {
@Test
public void match() {
ProducesRequestCondition condition = new ProducesRequestCondition("text/plain");
HttpServletRequest request = createRequest("text/plain");
assertNotNull(condition.getMatchingCondition(request));
}
@Test
public void matchNegated() {
ProducesRequestCondition condition = new ProducesRequestCondition("!text/plain");
HttpServletRequest request = createRequest("text/plain");
assertNull(condition.getMatchingCondition(request));
}
@Test
public void matchNegatedWithoutAcceptHeader() {
ProducesRequestCondition condition = new ProducesRequestCondition("!text/plain");
assertNotNull(condition.getMatchingCondition(new MockHttpServletRequest()));
assertEquals(Collections.emptySet(), condition.getProducibleMediaTypes());
}
@Test
public void getProducibleMediaTypes() {
ProducesRequestCondition condition = new ProducesRequestCondition("!application/xml");
assertEquals(Collections.emptySet(), condition.getProducibleMediaTypes());
}
@Test
public void matchWildcard() {
ProducesRequestCondition condition = new ProducesRequestCondition("text/*");
HttpServletRequest request = createRequest("text/plain");
assertNotNull(condition.getMatchingCondition(request));
}
@Test
public void matchMultiple() {
ProducesRequestCondition condition = new ProducesRequestCondition("text/plain", "application/xml");
HttpServletRequest request = createRequest("text/plain");
assertNotNull(condition.getMatchingCondition(request));
}
@Test
public void matchSingle() {
ProducesRequestCondition condition = new ProducesRequestCondition("text/plain");
HttpServletRequest request = createRequest("application/xml");
assertNull(condition.getMatchingCondition(request));
}
@Test // gh-21670
public void matchWithParameters() {
String base = "application/atom+xml";
ProducesRequestCondition condition = new ProducesRequestCondition(base + ";type=feed");
HttpServletRequest request = createRequest(base + ";type=entry");
assertNull("Declared parameter value must match if present in request",
condition.getMatchingCondition(request));
condition = new ProducesRequestCondition(base + ";type=feed");
request = createRequest(base + ";type=feed");
assertNotNull("Declared parameter value must match if present in request",
condition.getMatchingCondition(request));
condition = new ProducesRequestCondition(base + ";type=feed");
request = createRequest(base);
assertNotNull("Declared parameter has no impact if not present in request",
condition.getMatchingCondition(request));
condition = new ProducesRequestCondition(base);
request = createRequest(base + ";type=feed");
assertNotNull("No impact from other parameters in request",
condition.getMatchingCondition(request));
}
@Test
public void matchParseError() {
ProducesRequestCondition condition = new ProducesRequestCondition("text/plain");
HttpServletRequest request = createRequest("bogus");
assertNull(condition.getMatchingCondition(request));
}
@Test
public void matchParseErrorWithNegation() {
ProducesRequestCondition condition = new ProducesRequestCondition("!text/plain");
HttpServletRequest request = createRequest("bogus");
assertNull(condition.getMatchingCondition(request));
}
@Test
public void matchByRequestParameter() {
String[] produces = {"text/plain"};
String[] headers = {};
ProducesRequestCondition condition = new ProducesRequestCondition(produces, headers);
HttpServletRequest request = new MockHttpServletRequest("GET", "/foo.txt");
assertNotNull(condition.getMatchingCondition(request));
}
@Test // SPR-17550
public void matchWithNegationAndMediaTypeAllWithQualityParameter() {
ProducesRequestCondition condition = new ProducesRequestCondition("!application/json");
HttpServletRequest request = createRequest(
"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8");
assertNotNull(condition.getMatchingCondition(request));
}
@Test // gh-22853
public void matchAndCompare() {
ContentNegotiationManager manager = new ContentNegotiationManager(
new HeaderContentNegotiationStrategy(),
new FixedContentNegotiationStrategy(MediaType.TEXT_HTML));
ProducesRequestCondition none = new ProducesRequestCondition(new String[0], null, manager);
ProducesRequestCondition html = new ProducesRequestCondition(new String[] {"text/html"}, null, manager);
MockHttpServletRequest request = new MockHttpServletRequest();
request.addHeader("Accept", "*/*");
ProducesRequestCondition noneMatch = none.getMatchingCondition(request);
ProducesRequestCondition htmlMatch = html.getMatchingCondition(request);
assertEquals(1, noneMatch.compareTo(htmlMatch, request));
}
@Test
public void compareTo() {
ProducesRequestCondition html = new ProducesRequestCondition("text/html");
ProducesRequestCondition xml = new ProducesRequestCondition("application/xml");
ProducesRequestCondition none = new ProducesRequestCondition();
HttpServletRequest request = createRequest("application/xml, text/html");
assertTrue(html.compareTo(xml, request) > 0);
assertTrue(xml.compareTo(html, request) < 0);
assertTrue(xml.compareTo(none, request) < 0);
assertTrue(none.compareTo(xml, request) > 0);
assertTrue(html.compareTo(none, request) < 0);
assertTrue(none.compareTo(html, request) > 0);
request = createRequest("application/xml, text/*");
assertTrue(html.compareTo(xml, request) > 0);
assertTrue(xml.compareTo(html, request) < 0);
request = createRequest("application/pdf");
assertEquals(0, html.compareTo(xml, request));
assertEquals(0, xml.compareTo(html, request));
// See SPR-7000
request = createRequest("text/html;q=0.9,application/xml");
assertTrue(html.compareTo(xml, request) > 0);
assertTrue(xml.compareTo(html, request) < 0);
}
@Test
public void compareToWithSingleExpression() {
HttpServletRequest request = createRequest("text/plain");
ProducesRequestCondition condition1 = new ProducesRequestCondition("text/plain");
ProducesRequestCondition condition2 = new ProducesRequestCondition("text/*");
int result = condition1.compareTo(condition2, request);
assertTrue("Invalid comparison result: " + result, result < 0);
result = condition2.compareTo(condition1, request);
assertTrue("Invalid comparison result: " + result, result > 0);
}
@Test
public void compareToMultipleExpressions() {
ProducesRequestCondition condition1 = new ProducesRequestCondition("*/*", "text/plain");
ProducesRequestCondition condition2 = new ProducesRequestCondition("text/*", "text/plain;q=0.7");
HttpServletRequest request = createRequest("text/plain");
int result = condition1.compareTo(condition2, request);
assertTrue("Invalid comparison result: " + result, result < 0);
result = condition2.compareTo(condition1, request);
assertTrue("Invalid comparison result: " + result, result > 0);
}
@Test
public void compareToMultipleExpressionsAndMultipleAcceptHeaderValues() {
ProducesRequestCondition condition1 = new ProducesRequestCondition("text/*", "text/plain");
ProducesRequestCondition condition2 = new ProducesRequestCondition("application/*", "application/xml");
HttpServletRequest request = createRequest("text/plain", "application/xml");
int result = condition1.compareTo(condition2, request);
assertTrue("Invalid comparison result: " + result, result < 0);
result = condition2.compareTo(condition1, request);
assertTrue("Invalid comparison result: " + result, result > 0);
request = createRequest("application/xml", "text/plain");
result = condition1.compareTo(condition2, request);
assertTrue("Invalid comparison result: " + result, result > 0);
result = condition2.compareTo(condition1, request);
assertTrue("Invalid comparison result: " + result, result < 0);
}
// SPR-8536
@Test
public void compareToMediaTypeAll() {
MockHttpServletRequest request = new MockHttpServletRequest();
ProducesRequestCondition condition1 = new ProducesRequestCondition();
ProducesRequestCondition condition2 = new ProducesRequestCondition("application/json");
assertTrue("Should have picked '*/*' condition as an exact match",
condition1.compareTo(condition2, request) < 0);
assertTrue("Should have picked '*/*' condition as an exact match",
condition2.compareTo(condition1, request) > 0);
condition1 = new ProducesRequestCondition("*/*");
condition2 = new ProducesRequestCondition("application/json");
assertTrue(condition1.compareTo(condition2, request) < 0);
assertTrue(condition2.compareTo(condition1, request) > 0);
request.addHeader("Accept", "*/*");
condition1 = new ProducesRequestCondition();
condition2 = new ProducesRequestCondition("application/json");
assertTrue(condition1.compareTo(condition2, request) < 0);
assertTrue(condition2.compareTo(condition1, request) > 0);
condition1 = new ProducesRequestCondition("*/*");
condition2 = new ProducesRequestCondition("application/json");
assertTrue(condition1.compareTo(condition2, request) < 0);
assertTrue(condition2.compareTo(condition1, request) > 0);
}
// SPR-9021
@Test
public void compareToMediaTypeAllWithParameter() {
HttpServletRequest request = createRequest("*/*;q=0.9");
ProducesRequestCondition condition1 = new ProducesRequestCondition();
ProducesRequestCondition condition2 = new ProducesRequestCondition("application/json");
assertTrue(condition1.compareTo(condition2, request) < 0);
assertTrue(condition2.compareTo(condition1, request) > 0);
}
@Test
public void compareToEqualMatch() {
HttpServletRequest request = createRequest("text/*");
ProducesRequestCondition condition1 = new ProducesRequestCondition("text/plain");
ProducesRequestCondition condition2 = new ProducesRequestCondition("text/xhtml");
int result = condition1.compareTo(condition2, request);
assertTrue("Should have used MediaType.equals(Object) to break the match", result < 0);
result = condition2.compareTo(condition1, request);
assertTrue("Should have used MediaType.equals(Object) to break the match", result > 0);
}
@Test
public void combine() {
ProducesRequestCondition condition1 = new ProducesRequestCondition("text/plain");
ProducesRequestCondition condition2 = new ProducesRequestCondition("application/xml");
ProducesRequestCondition result = condition1.combine(condition2);
assertEquals(condition2, result);
}
@Test
public void combineWithDefault() {
ProducesRequestCondition condition1 = new ProducesRequestCondition("text/plain");
ProducesRequestCondition condition2 = new ProducesRequestCondition();
ProducesRequestCondition result = condition1.combine(condition2);
assertEquals(condition1, result);
}
@Test
public void instantiateWithProducesAndHeaderConditions() {
String[] produces = new String[] {"text/plain"};
String[] headers = new String[]{"foo=bar", "accept=application/xml,application/pdf"};
ProducesRequestCondition condition = new ProducesRequestCondition(produces, headers);
assertConditions(condition, "text/plain", "application/xml", "application/pdf");
}
@Test
public void getMatchingCondition() {
HttpServletRequest request = createRequest("text/plain");
ProducesRequestCondition condition = new ProducesRequestCondition("text/plain", "application/xml");
ProducesRequestCondition result = condition.getMatchingCondition(request);
assertConditions(result, "text/plain");
condition = new ProducesRequestCondition("application/xml");
result = condition.getMatchingCondition(request);
assertNull(result);
}
private MockHttpServletRequest createRequest(String... headerValue) {
MockHttpServletRequest request = new MockHttpServletRequest();
Arrays.stream(headerValue).forEach(value -> request.addHeader("Accept", headerValue));
return request;
}
private void assertConditions(ProducesRequestCondition condition, String... expected) {
Collection<ProduceMediaTypeExpression> expressions = condition.getContent();
assertEquals("Invalid number of conditions", expressions.size(), expected.length);
for (String s : expected) {
boolean found = false;
for (ProduceMediaTypeExpression expr : expressions) {
String conditionMediaType = expr.getMediaType().toString();
if (conditionMediaType.equals(s)) {
found = true;
break;
}
}
if (!found) {
fail("Condition [" + s + "] not found");
}
}
}
}
