INTEXT-141: Add SqsMessageHandler template ctor

JIRA: https://jira.spring.io/browse/INTEXT-141

Adding in a constructor to the `SqsMessageHandler` so that `QueueMessagingTemplate` can be configured independently.

Updated with comments

- Updated the `spring-integration-aws-1.0.xsd` to include the `queue-messaging-template` param.
- Updated the `SqsOutboundChannelAdapterParserTest` to look for the `queue-messaging-template` param, and validate that `sqs` and `resource-resolver-id` params are mutually exclusive to `queue-messaging-template`.
- Added tests for the parser.
- Added test for the new constructor.

Updated with feedback
- Validation for `sqs` parameter missing in xml config
- Made `SqsMessageHandlerWithQueueMessagingTemplateTests` use the same tests as `SqsMessageHandler` tests by moving the tests to a common parent class: `AbstractSqsMessageHandlerTest`
- Other minor fixes.

Whitespace and error message fixes.

Polishing

src/test/java/org/springframework/integration/aws/config/xml/SqsOutboundChannelAdapterParserTests-context-bad.xml

@@ -0,0 +1,27 @@
+<?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-aws="http://www.springframework.org/schema/integration/aws"
+	   xmlns:aws-messaging="http://www.springframework.org/schema/cloud/aws/messaging"
+	   xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
+	   http://www.springframework.org/schema/integration/aws http://www.springframework.org/schema/integration/aws/spring-integration-aws.xsd
+	   http://www.springframework.org/schema/cloud/aws/messaging http://www.springframework.org/schema/cloud/aws/messaging/spring-cloud-aws-messaging.xsd">
+
+	<aws-messaging:sqs-async-client id="sqs"/>
+
+	<bean id="resourceIdResolver" class="org.mockito.Mockito" factory-method="mock">
+		<constructor-arg value="org.springframework.cloud.aws.core.env.ResourceIdResolver"/>
+	</bean>
+
+	<aws-messaging:queue-messaging-template amazon-sqs="sqs" id="queueMessagingTemplate"/>
+
+	<int-aws:sqs-outbound-channel-adapter sqs="sqs"
+										  auto-startup="false"
+										  channel="errorChannel"
+										  phase="100"
+										  id="sqsOutboundChannelAdapter"
+										  queue="foo"
+										  resource-id-resolver="resourceIdResolver"
+										  queue-messaging-template="queueMessagingTemplate"/>
+
+</beans>

src/test/java/org/springframework/integration/aws/config/xml/SqsOutboundChannelAdapterParserTests-context-bad2.xml

@@ -0,0 +1,26 @@
+<?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-aws="http://www.springframework.org/schema/integration/aws"
+	   xmlns:aws-messaging="http://www.springframework.org/schema/cloud/aws/messaging"
+	   xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
+	   http://www.springframework.org/schema/integration/aws http://www.springframework.org/schema/integration/aws/spring-integration-aws.xsd
+	   http://www.springframework.org/schema/cloud/aws/messaging http://www.springframework.org/schema/cloud/aws/messaging/spring-cloud-aws-messaging.xsd">
+
+	<aws-messaging:sqs-async-client id="sqs"/>
+
+	<bean id="resourceIdResolver" class="org.mockito.Mockito" factory-method="mock">
+		<constructor-arg value="org.springframework.cloud.aws.core.env.ResourceIdResolver"/>
+	</bean>
+
+	<aws-messaging:queue-messaging-template amazon-sqs="sqs" id="queueMessagingTemplate"/>
+
+	<int-aws:sqs-outbound-channel-adapter sqs="sqs"
+										  auto-startup="false"
+										  channel="errorChannel"
+										  phase="100"
+										  id="sqsOutboundChannelAdapter"
+										  queue="foo"
+										  queue-messaging-template="queueMessagingTemplate"/>
+
+</beans>

src/test/java/org/springframework/integration/aws/config/xml/SqsOutboundChannelAdapterParserTests-context-bad3.xml

@@ -0,0 +1,26 @@
+<?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-aws="http://www.springframework.org/schema/integration/aws"
+	   xmlns:aws-messaging="http://www.springframework.org/schema/cloud/aws/messaging"
+	   xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
+	   http://www.springframework.org/schema/integration/aws http://www.springframework.org/schema/integration/aws/spring-integration-aws.xsd
+	   http://www.springframework.org/schema/cloud/aws/messaging http://www.springframework.org/schema/cloud/aws/messaging/spring-cloud-aws-messaging.xsd">
+
+	<aws-messaging:sqs-async-client id="sqs"/>
+
+	<bean id="resourceIdResolver" class="org.mockito.Mockito" factory-method="mock">
+		<constructor-arg value="org.springframework.cloud.aws.core.env.ResourceIdResolver"/>
+	</bean>
+
+	<aws-messaging:queue-messaging-template amazon-sqs="sqs" id="queueMessagingTemplate"/>
+
+	<int-aws:sqs-outbound-channel-adapter auto-startup="false"
+										  channel="errorChannel"
+										  phase="100"
+										  id="sqsOutboundChannelAdapter"
+										  queue="foo"
+										  resource-id-resolver="resourceIdResolver"
+										  queue-messaging-template="queueMessagingTemplate"/>
+
+</beans>

src/test/java/org/springframework/integration/aws/config/xml/SqsOutboundChannelAdapterParserTests-context-bad4.xml

@@ -0,0 +1,25 @@
+<?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-aws="http://www.springframework.org/schema/integration/aws"
+	   xmlns:aws-messaging="http://www.springframework.org/schema/cloud/aws/messaging"
+	   xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
+	   http://www.springframework.org/schema/integration/aws http://www.springframework.org/schema/integration/aws/spring-integration-aws.xsd
+	   http://www.springframework.org/schema/cloud/aws/messaging http://www.springframework.org/schema/cloud/aws/messaging/spring-cloud-aws-messaging.xsd">
+
+	<aws-messaging:sqs-async-client id="sqs"/>
+
+	<bean id="resourceIdResolver" class="org.mockito.Mockito" factory-method="mock">
+		<constructor-arg value="org.springframework.cloud.aws.core.env.ResourceIdResolver"/>
+	</bean>
+
+	<aws-messaging:queue-messaging-template amazon-sqs="sqs" id="queueMessagingTemplate"/>
+
+	<int-aws:sqs-outbound-channel-adapter auto-startup="false"
+										  channel="errorChannel"
+										  phase="100"
+										  id="sqsOutboundChannelAdapter"
+										  queue="foo"
+										  resource-id-resolver="resourceIdResolver"/>
+
+</beans>

src/test/java/org/springframework/integration/aws/config/xml/SqsOutboundChannelAdapterParserTests-context-good.xml

@@ -0,0 +1,33 @@
+<?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-aws="http://www.springframework.org/schema/integration/aws"
+	   xmlns:aws-messaging="http://www.springframework.org/schema/cloud/aws/messaging"
+	   xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
+	   http://www.springframework.org/schema/integration/aws http://www.springframework.org/schema/integration/aws/spring-integration-aws.xsd
+	   http://www.springframework.org/schema/cloud/aws/messaging http://www.springframework.org/schema/cloud/aws/messaging/spring-cloud-aws-messaging.xsd">
+
+	<aws-messaging:sqs-async-client id="sqs"/>
+
+	<bean id="resourceIdResolver" class="org.mockito.Mockito" factory-method="mock">
+		<constructor-arg value="org.springframework.cloud.aws.core.env.ResourceIdResolver"/>
+	</bean>
+
+	<aws-messaging:queue-messaging-template amazon-sqs="sqs" id="queueMessagingTemplate"/>
+
+	<int-aws:sqs-outbound-channel-adapter sqs="sqs"
+										  auto-startup="false"
+										  channel="errorChannel"
+										  phase="100"
+										  id="sqsOutboundChannelAdapterWithSqs"
+										  queue="foo"
+										  resource-id-resolver="resourceIdResolver"/>
+
+	<int-aws:sqs-outbound-channel-adapter auto-startup="false"
+										  channel="errorChannel"
+										  phase="100"
+										  id="sqsOutboundChannelAdapterWithQueueMessagingTemplate"
+										  queue="foo"
+										  queue-messaging-template="queueMessagingTemplate"/>
+
+</beans>

src/test/java/org/springframework/integration/aws/config/xml/SqsOutboundChannelAdapterParserTests.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2015 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 org.springframework.integration.aws.config.xml;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+import org.springframework.beans.factory.BeanDefinitionStoreException;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.support.ClassPathXmlApplicationContext;
+import org.springframework.integration.aws.outbound.SqsMessageHandler;
+import org.springframework.integration.test.util.TestUtils;
+
+/**
+ * @author Rahul Pilani
+ * @author Artem Bilan
+ */
+public class SqsOutboundChannelAdapterParserTests {
+
+	@Test(expected = BeanDefinitionStoreException.class)
+	public void test_sqs_resource_resolver_defined_with_queue_messaging_template() {
+		new ClassPathXmlApplicationContext("SqsOutboundChannelAdapterParserTests-context-bad.xml", this.getClass());
+	}
+
+	@Test(expected = BeanDefinitionStoreException.class)
+	public void test_sqs_defined_with_queue_messaging_template() {
+		new ClassPathXmlApplicationContext("SqsOutboundChannelAdapterParserTests-context-bad2.xml", this.getClass());
+	}
+
+	@Test(expected = BeanDefinitionStoreException.class)
+	public void test_resource_resolver_defined_with_queue_messaging_template() {
+		new ClassPathXmlApplicationContext("SqsOutboundChannelAdapterParserTests-context-bad3.xml", this.getClass());
+	}
+
+	@Test(expected = BeanDefinitionStoreException.class)
+	public void test_neither_sqs_nor_queue_messaging_template_defined() {
+		new ClassPathXmlApplicationContext("SqsOutboundChannelAdapterParserTests-context-bad4.xml", this.getClass());
+	}
+
+	@Test
+	public void test_happy_path_with_queue_messaging_template() {
+		ApplicationContext applicationContext =
+				new ClassPathXmlApplicationContext("SqsOutboundChannelAdapterParserTests-context-good.xml", this.getClass());
+
+		SqsMessageHandler handlerWithTemplate =
+				applicationContext.getBean("sqsOutboundChannelAdapterWithQueueMessagingTemplate.handler",
+						SqsMessageHandler.class);
+		Assert.assertNotNull(TestUtils.getPropertyValue(handlerWithTemplate, "template"));
+
+		SqsMessageHandler handlerWithSqs = applicationContext.getBean("sqsOutboundChannelAdapterWithSqs.handler",
+				SqsMessageHandler.class);
+		Assert.assertNotNull(TestUtils.getPropertyValue(handlerWithSqs, "template"));
+	}
+
+}

src/test/java/org/springframework/integration/aws/outbound/AbstractSqsMessageHandlerTests.java

@@ -0,0 +1,91 @@
+/*
+ * Copyright 2015 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 org.springframework.integration.aws.outbound;
+
+import static org.hamcrest.Matchers.instanceOf;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertThat;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+import org.junit.Test;
+import org.mockito.ArgumentCaptor;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.expression.Expression;
+import org.springframework.expression.spel.standard.SpelExpressionParser;
+import org.springframework.integration.aws.support.AwsHeaders;
+import org.springframework.messaging.Message;
+import org.springframework.messaging.MessageChannel;
+import org.springframework.messaging.MessageHandlingException;
+import org.springframework.messaging.support.MessageBuilder;
+
+import com.amazonaws.services.sqs.AmazonSQS;
+import com.amazonaws.services.sqs.model.SendMessageRequest;
+
+/**
+ * Parent class to contain tests that exercise the SqsMessageHandler class
+ *
+ * Subclasses can instantiate SqsMessageHandler in their own way.
+ *
+ * @author Rahul Pilani
+ * @author Artem Bilan
+ */
+public abstract class AbstractSqsMessageHandlerTests {
+
+	@Autowired
+	protected AmazonSQS amazonSqs;
+
+	@Autowired
+	protected MessageChannel sqsSendChannel;
+
+	@Autowired
+	protected SqsMessageHandler sqsMessageHandler;
+
+	@Test
+	public void testSqsMessageHandler() {
+		Message<String> message = MessageBuilder.withPayload("message").build();
+		try {
+			this.sqsSendChannel.send(message);
+		}
+		catch (Exception e) {
+			assertThat(e, instanceOf(MessageHandlingException.class));
+			assertThat(e.getCause(), instanceOf(IllegalStateException.class));
+		}
+
+		this.sqsMessageHandler.setQueue("foo");
+		this.sqsSendChannel.send(message);
+		ArgumentCaptor<SendMessageRequest> sendMessageRequestArgumentCaptor =
+				ArgumentCaptor.forClass(SendMessageRequest.class);
+		verify(this.amazonSqs).sendMessage(sendMessageRequestArgumentCaptor.capture());
+		assertEquals("http://queue-url.com/foo", sendMessageRequestArgumentCaptor.getValue().getQueueUrl());
+
+		message = MessageBuilder.withPayload("message").setHeader(AwsHeaders.QUEUE, "bar").build();
+		this.sqsSendChannel.send(message);
+		verify(this.amazonSqs, times(2)).sendMessage(sendMessageRequestArgumentCaptor.capture());
+		assertEquals("http://queue-url.com/bar", sendMessageRequestArgumentCaptor.getValue().getQueueUrl());
+
+		SpelExpressionParser spelExpressionParser = new SpelExpressionParser();
+		Expression expression = spelExpressionParser.parseExpression("headers.foo");
+		this.sqsMessageHandler.setQueueExpression(expression);
+		message = MessageBuilder.withPayload("message").setHeader("foo", "baz").build();
+		this.sqsSendChannel.send(message);
+		verify(this.amazonSqs, times(3)).sendMessage(sendMessageRequestArgumentCaptor.capture());
+		assertEquals("http://queue-url.com/baz", sendMessageRequestArgumentCaptor.getValue().getQueueUrl());
+	}
+
+}

src/test/java/org/springframework/integration/aws/outbound/SqsMessageHandlerTests.java

@@ -16,89 +16,36 @@
 
 package org.springframework.integration.aws.outbound;
 
-import static org.hamcrest.Matchers.instanceOf;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertThat;
 import static org.mockito.Matchers.any;
 import static org.mockito.Mockito.doAnswer;
 import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.times;
-import static org.mockito.Mockito.verify;
 
-import org.junit.Test;
 import org.junit.runner.RunWith;
-import org.mockito.ArgumentCaptor;
 import org.mockito.invocation.InvocationOnMock;
 import org.mockito.stubbing.Answer;
 
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.expression.Expression;
-import org.springframework.expression.spel.standard.SpelExpressionParser;
 import org.springframework.integration.annotation.ServiceActivator;
-import org.springframework.integration.aws.support.AwsHeaders;
 import org.springframework.integration.config.EnableIntegration;
-import org.springframework.messaging.Message;
-import org.springframework.messaging.MessageChannel;
 import org.springframework.messaging.MessageHandler;
-import org.springframework.messaging.MessageHandlingException;
-import org.springframework.messaging.support.MessageBuilder;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 
 import com.amazonaws.services.sqs.AmazonSQS;
 import com.amazonaws.services.sqs.model.GetQueueUrlRequest;
 import com.amazonaws.services.sqs.model.GetQueueUrlResult;
-import com.amazonaws.services.sqs.model.SendMessageRequest;
 
 /**
+ * Instantiating SqsMessageHandler using amazonSqs.
+ *
  * @author Artem Bilan
+ * @author Rahul Pilani
  */
 @RunWith(SpringJUnit4ClassRunner.class)
 @ContextConfiguration
-public class SqsMessageHandlerTests {
+public class SqsMessageHandlerTests extends AbstractSqsMessageHandlerTests {
 
-	@Autowired
-	private AmazonSQS amazonSqs;
-
-	@Autowired
-	private MessageChannel sqsSendChannel;
-
-	@Autowired
-	private SqsMessageHandler sqsMessageHandler;
-
-	@Test
-	public void testSqsMessageHandler() {
-		Message<String> message = MessageBuilder.withPayload("message").build();
-		try {
-			this.sqsSendChannel.send(message);
-		}
-		catch (Exception e) {
-			assertThat(e, instanceOf(MessageHandlingException.class));
-			assertThat(e.getCause(), instanceOf(IllegalStateException.class));
-		}
-
-		this.sqsMessageHandler.setQueue("foo");
-		this.sqsSendChannel.send(message);
-		ArgumentCaptor<SendMessageRequest> sendMessageRequestArgumentCaptor =
-				ArgumentCaptor.forClass(SendMessageRequest.class);
-		verify(this.amazonSqs).sendMessage(sendMessageRequestArgumentCaptor.capture());
-		assertEquals("http://queue-url.com/foo", sendMessageRequestArgumentCaptor.getValue().getQueueUrl());
-
-		message = MessageBuilder.withPayload("message").setHeader(AwsHeaders.QUEUE, "bar").build();
-		this.sqsSendChannel.send(message);
-		verify(this.amazonSqs, times(2)).sendMessage(sendMessageRequestArgumentCaptor.capture());
-		assertEquals("http://queue-url.com/bar", sendMessageRequestArgumentCaptor.getValue().getQueueUrl());
-
-		SpelExpressionParser spelExpressionParser = new SpelExpressionParser();
-		Expression expression = spelExpressionParser.parseExpression("headers.foo");
-		this.sqsMessageHandler.setQueueExpression(expression);
-		message = MessageBuilder.withPayload("message").setHeader("foo", "baz").build();
-		this.sqsSendChannel.send(message);
-		verify(this.amazonSqs, times(3)).sendMessage(sendMessageRequestArgumentCaptor.capture());
-		assertEquals("http://queue-url.com/baz", sendMessageRequestArgumentCaptor.getValue().getQueueUrl());
-	}
 
 	@Configuration
 	@EnableIntegration

src/test/java/org/springframework/integration/aws/outbound/SqsMessageHandlerWithQueueMessagingTemplateTests.java

@@ -0,0 +1,86 @@
+/*
+ * Copyright 2015 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 org.springframework.integration.aws.outbound;
+
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.doAnswer;
+import static org.mockito.Mockito.mock;
+
+import org.junit.runner.RunWith;
+import org.mockito.invocation.InvocationOnMock;
+import org.mockito.stubbing.Answer;
+
+import org.springframework.cloud.aws.messaging.core.QueueMessagingTemplate;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.integration.annotation.ServiceActivator;
+import org.springframework.integration.config.EnableIntegration;
+import org.springframework.messaging.MessageHandler;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+
+import com.amazonaws.services.sqs.AmazonSQS;
+import com.amazonaws.services.sqs.model.GetQueueUrlRequest;
+import com.amazonaws.services.sqs.model.GetQueueUrlResult;
+
+/**
+ * Instantiating SqsMessageHandler using QueueMessagingTemplate.
+ *
+ * @author Rahul Pilani
+ */
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration
+public class SqsMessageHandlerWithQueueMessagingTemplateTests extends AbstractSqsMessageHandlerTests {
+
+
+	@Configuration
+	@EnableIntegration
+	public static class ContextConfiguration {
+
+		@Bean
+		public AmazonSQS amazonSqs() {
+			AmazonSQS amazonSqs = mock(AmazonSQS.class);
+
+			doAnswer(new Answer<GetQueueUrlResult>() {
+
+				@Override
+				public GetQueueUrlResult answer(InvocationOnMock invocation) throws Throwable {
+					GetQueueUrlRequest getQueueUrlRequest = (GetQueueUrlRequest) invocation.getArguments()[0];
+					GetQueueUrlResult queueUrl = new GetQueueUrlResult();
+					queueUrl.setQueueUrl("http://queue-url.com/" + getQueueUrlRequest.getQueueName());
+					return queueUrl;
+				}
+
+			}).when(amazonSqs).getQueueUrl(any(GetQueueUrlRequest.class));
+
+			return amazonSqs;
+		}
+
+		@Bean
+		public QueueMessagingTemplate queueMessagingTemplate() {
+			return new QueueMessagingTemplate(amazonSqs());
+		}
+
+		@Bean
+		@ServiceActivator(inputChannel = "sqsSendChannel")
+		public MessageHandler sqsMessageHandler() {
+			return new SqsMessageHandler(queueMessagingTemplate());
+		}
+
+	}
+
+}