Spring/spring-integration
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GH-3938: Fix HTTP XML configuration for ambiguity (#3939)

Browse Source 
* GH-3938: Fix HTTP XML configuration for ambiguity

Fixes https://github.com/spring-projects/spring-integration/issues/3938

The `encoding-mode` is a property of the `RestTemplate`.
Therefore, it cannot be set on the component configuration together with
an externally injected `rest-template`

Even if `HttpRequestExecutingMessageHandler` has an assertion for such
an ambiguity, the XML parser just ignores this `encoding-mode`
when it encounters the `rest-template`

* Fix `HttpAdapterParsingUtils.verifyNoRestTemplateAttributes()` to check for not allowed
attributes with a `encoding-mode` as well
* Remove a `default` from the `encoding-mode` to not cause an ambiguity in the parser
* Fix some typos in the `spring-integration-http.xsd`
* Rework `OutboundResponseTypeTests` to JUnit 5

**Cherry-pick to `5.5.x`**

* * Fix error handling for `encoding-mode` in the `HttpAdapterParsingUtils`
* Cover `encoding-mode` and `rest-template` ambiguity with a test against failing XML configuration

* * Improve error message for ambiguous attributes in the `HttpAdapterParsingUtils`
This commit is contained in:
Artem Bilan
2022-11-07 15:47:19 -05:00
committed by Gary Russell
parent d45801b690
commit e4e80419c5
5 changed files with 89 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
spring-integration-http/src/test/java/org/springframework/integration/http/config/OutboundResponseTypeTests-context-encoding-mode-fail.xml Normal file
View File

@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:int-http="http://www.springframework.org/schema/integration/http"
xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/integration/http https://www.springframework.org/schema/integration/http/spring-integration-http.xsd">
<bean id="restTemplate" class="org.mockito.Mockito" factory-method="mock">
<constructor-arg value="org.springframework.web.client.RestTemplate"/>
</bean>
<int-http:outbound-gateway url="/fake"
rest-template="restTemplate"
encoding-mode="NONE"/>
</beans>

5
spring-integration-http/src/test/java/org/springframework/integration/http/config/OutboundResponseTypeTests-context.xml
View File

@@ -3,15 +3,12 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:int="http://www.springframework.org/schema/integration"
xmlns:int-http="http://www.springframework.org/schema/integration/http"
xmlns:util="http://www.springframework.org/schema/util"
xsi:schemaLocation="http://www.springframework.org/schema/integration/http
https://www.springframework.org/schema/integration/http/spring-integration-http.xsd
http://www.springframework.org/schema/integration
https://www.springframework.org/schema/integration/spring-integration.xsd
http://www.springframework.org/schema/beans
https://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/util
https://www.springframework.org/schema/util/spring-util.xsd">
https://www.springframework.org/schema/beans/spring-beans.xsd">
<bean id="restTemplate" class="org.springframework.web.client.RestTemplate"/>

92
spring-integration-http/src/test/java/org/springframework/integration/http/config/OutboundResponseTypeTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-2022 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.
@@ -17,20 +17,17 @@
package org.springframework.integration.http.config;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.fail;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.header;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.method;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo;
import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;
import java.util.Collections;
import java.util.Map;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.parsing.BeanDefinitionParsingException;
import org.springframework.context.support.ClassPathXmlApplicationContext;
@@ -44,8 +41,7 @@ import org.springframework.messaging.MessageChannel;
import org.springframework.messaging.MessageHandlingException;
import org.springframework.messaging.support.GenericMessage;
import org.springframework.test.annotation.DirtiesContext;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
import org.springframework.test.web.client.MockRestServiceServer;
import org.springframework.web.client.RestTemplate;
@@ -53,13 +49,10 @@ import org.springframework.web.client.RestTemplate;
* @author Oleg Zhurakousky
* @author Artem Bilan
* @author Gary Russell
* @since 2.2
*
* <p>
* see https://jira.springsource.org/browse/INT-2397
* @since 2.2
*/
@ContextConfiguration
@RunWith(SpringJUnit4ClassRunner.class)
@SpringJUnitConfig
@DirtiesContext
public class OutboundResponseTypeTests {
@@ -95,18 +88,18 @@ public class OutboundResponseTypeTests {
private MockRestServiceServer mockServer;
@Before
@BeforeEach
public void setup() {
this.mockServer = MockRestServiceServer.createServer(this.restTemplate);
}
@Test
public void testDefaultResponseType() throws Exception {
public void testDefaultResponseType() {
this.mockServer.expect(requestTo("/testApps/outboundResponse"))
.andExpect(method(HttpMethod.POST))
.andRespond(withSuccess(HttpMethod.POST.name(), MediaType.TEXT_PLAIN));
this.requestChannel.send(new GenericMessage<String>("Hello"));
this.requestChannel.send(new GenericMessage<>("Hello"));
Message<?> message = this.replyChannel.receive(5000);
assertThat(message).isNotNull();
assertThat(message.getPayload() instanceof ResponseEntity).isTrue();
@@ -115,12 +108,12 @@ public class OutboundResponseTypeTests {
}
@Test
public void testWithResponseTypeSet() throws Exception {
public void testWithResponseTypeSet() {
this.mockServer.expect(requestTo("/testApps/outboundResponse"))
.andExpect(method(HttpMethod.POST))
.andRespond(withSuccess(HttpMethod.POST.name(), MediaType.TEXT_PLAIN));
this.resTypeSetChannel.send(new GenericMessage<String>("Hello"));
this.resTypeSetChannel.send(new GenericMessage<>("Hello"));
Message<?> message = this.replyChannel.receive(5000);
assertThat(message).isNotNull();
assertThat(message.getPayload() instanceof String).isTrue();
@@ -129,12 +122,12 @@ public class OutboundResponseTypeTests {
}
@Test
public void testWithResponseTypeExpressionSet() throws Exception {
public void testWithResponseTypeExpressionSet() {
this.mockServer.expect(requestTo("/testApps/outboundResponse"))
.andExpect(method(HttpMethod.POST))
.andRespond(withSuccess(HttpMethod.POST.name(), MediaType.TEXT_PLAIN));
this.resTypeExpressionSetChannel.send(new GenericMessage<String>("java.lang.String"));
this.resTypeExpressionSetChannel.send(new GenericMessage<>("java.lang.String"));
Message<?> message = this.replyChannel.receive(5000);
assertThat(message).isNotNull();
assertThat(message.getPayload() instanceof String).isTrue();
@@ -143,7 +136,7 @@ public class OutboundResponseTypeTests {
}
@Test
public void testWithResponseTypeExpressionSetAsClass() throws Exception {
public void testWithResponseTypeExpressionSetAsClass() {
this.mockServer = MockRestServiceServer.createServer(this.restTemplateWithConverters);
this.mockServer.expect(requestTo("/testApps/outboundResponse"))
.andExpect(method(HttpMethod.POST))
@@ -158,12 +151,12 @@ public class OutboundResponseTypeTests {
}
@Test
public void testInt2706ResponseTypeExpressionAsPrimitive() throws Exception {
public void testInt2706ResponseTypeExpressionAsPrimitive() {
this.mockServer.expect(requestTo("/testApps/outboundResponse"))
.andExpect(method(HttpMethod.POST))
.andRespond(withSuccess(HttpMethod.POST.name(), MediaType.TEXT_PLAIN));
this.resTypeExpressionSetChannel.send(new GenericMessage<String>("byte[]"));
this.resTypeExpressionSetChannel.send(new GenericMessage<>("byte[]"));
Message<?> message = this.replyChannel.receive(5000);
assertThat(message).isNotNull();
assertThat(message.getPayload() instanceof byte[]).isTrue();
@@ -172,12 +165,12 @@ public class OutboundResponseTypeTests {
}
@Test
public void testInt2706ResponseTypePrimitiveArrayClassAsString() throws Exception {
public void testInt2706ResponseTypePrimitiveArrayClassAsString() {
this.mockServer.expect(requestTo("/testApps/outboundResponse"))
.andExpect(method(HttpMethod.POST))
.andRespond(withSuccess(HttpMethod.POST.name(), MediaType.TEXT_PLAIN));
this.resPrimitiveStringPresentationChannel.send(new GenericMessage<byte[]>("hello".getBytes()));
this.resPrimitiveStringPresentationChannel.send(new GenericMessage<>("hello".getBytes()));
Message<?> message = this.replyChannel.receive(5000);
assertThat(message).isNotNull();
assertThat(message.getPayload() instanceof byte[]).isTrue();
@@ -186,44 +179,43 @@ public class OutboundResponseTypeTests {
}
@Test
public void testInt3052InvalidResponseType() throws Exception {
try {
this.invalidResponseTypeChannel.send(new GenericMessage<byte[]>("hello".getBytes()));
fail("IllegalStateException expected.");
}
catch (Exception e) {
assertThat(e).isInstanceOf(MessageHandlingException.class);
Throwable t = e.getCause();
assertThat(t).isInstanceOf(IllegalStateException.class);
assertThat(t.getMessage()).contains("'expectedResponseType' can be an instance of " +
"'Class<?>', 'String' or 'ParameterizedTypeReference<?>'");
}
public void testInt3052InvalidResponseType() {
assertThatExceptionOfType(MessageHandlingException.class)
.isThrownBy(() -> this.invalidResponseTypeChannel.send(new GenericMessage<>("hello".getBytes())))
.withCauseInstanceOf(IllegalStateException.class)
.withStackTraceContaining("'expectedResponseType' can be an instance of " +
"'Class<?>', 'String' or 'ParameterizedTypeReference<?>'");
}
@Test
public void testMutuallyExclusivityInMethodAndMethodExpression() throws Exception {
try {
new ClassPathXmlApplicationContext("OutboundResponseTypeTests-context-fail.xml", this.getClass()).close();
fail("Expected BeansException");
}
catch (BeansException e) {
assertThat(e instanceof BeanDefinitionParsingException).isTrue();
assertThat(e.getMessage().contains("The 'expected-response-type' " +
"and 'expected-response-type-expression' are mutually exclusive")).isTrue();
}
public void testMutuallyExclusivityInMethodAndMethodExpression() {
assertThatExceptionOfType(BeanDefinitionParsingException.class)
.isThrownBy(() -> new ClassPathXmlApplicationContext("OutboundResponseTypeTests-context-fail.xml",
getClass()))
.withMessageContaining("The 'expected-response-type' " +
"and 'expected-response-type-expression' are mutually exclusive");
}
@Test
public void testContentTypePropagation() throws Exception {
public void testContentTypePropagation() {
this.mockServer.expect(requestTo("/testApps/outboundResponse"))
.andExpect(method(HttpMethod.POST))
.andExpect(header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON.toString()))
.andRespond(withSuccess(HttpMethod.POST.name(), MediaType.TEXT_PLAIN));
this.contentTypePropagationChannel
.send(new GenericMessage<Map<String, String>>(Collections.singletonMap("foo", "bar")));
.send(new GenericMessage<>(Collections.singletonMap("foo", "bar")));
this.mockServer.verify();
}
@Test
public void notAllowedEncodingModeWhenExternalRestTemplate() {
assertThatExceptionOfType(BeanDefinitionParsingException.class)
.isThrownBy(() -> new ClassPathXmlApplicationContext(
"OutboundResponseTypeTests-context-encoding-mode-fail.xml", getClass()))
.withMessageContaining("When providing a 'rest-template' reference, " +
"the 'encoding-mode' must be set on the 'RestTemplate.uriTemplateHandler' property.");
}
}