GH-914: Honor AllowBeanDefOverriding = false (#915)

* GH-914: Honor AllowBeanDefOverriding = false

Fixes #914

* Rework `RabbitBootstrapConfiguration` into the `ImportBeanDefinitionRegistrar`
and check for bean definitions presence it is going to register.
This way an override from the `RabbitListenerTestBootstrap` is going to
have a precedence and its `RabbitListenerTestHarness` won't allow a
regular `RabbitListenerAnnotationBeanPostProcessor` to be registered
* Rework `TestRabbitTemplate` to gather all the listener container
from the `ContextRefreshedEvent` instead of the `SmartInitializingSingleton`.
Looks like Spring doesn't care about their order, therefore we need to
be sure that `RabbitListenerAnnotationBeanPostProcessor` has populated
its `registry` with containers before.
* Demonstrate that `allowBeanDefinitionOverriding = false` works well
now in the `ExampleRabbitListenerCaptureTest`
* Optimize `checkTestConfigs` and `updateCopyrights` Gradle tasks for
their `inputs` and `outputs` for better `UP-TO-DATE` handling

**Cherry-pick to 2.1.x without `build.gradle` changes**

* * Fix typo in the `ExampleRabbitListenerCaptureTest`

Author: artembilan

spring-rabbit-test/src/main/java/org/springframework/amqp/rabbit/test/TestRabbitTemplate.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2018 the original author or authors.
+ * Copyright 2017-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.
@@ -23,11 +23,13 @@
 import static org.mockito.Mockito.mock;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.atomic.AtomicReference;
+import java.util.stream.Stream;
 
 import org.springframework.amqp.core.Message;
 import org.springframework.amqp.core.MessageBuilder;
@@ -41,10 +43,11 @@
 import org.springframework.amqp.rabbit.listener.api.ChannelAwareMessageListener;
 import org.springframework.amqp.rabbit.support.RabbitExceptionTranslator;
 import org.springframework.beans.BeansException;
-import org.springframework.beans.factory.SmartInitializingSingleton;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ApplicationContextAware;
+import org.springframework.context.ApplicationListener;
+import org.springframework.context.event.ContextRefreshedEvent;
 
 import com.rabbitmq.client.AMQP.BasicProperties;
 import com.rabbitmq.client.Channel;
@@ -56,11 +59,13 @@
  * It does not currently support publisher confirms/returns.
  *
  * @author Gary Russell
+ * @author Artem Bilan
  *
  * @since 2.0
  *
  */
-public class TestRabbitTemplate extends RabbitTemplate implements ApplicationContextAware, SmartInitializingSingleton {
+public class TestRabbitTemplate extends RabbitTemplate
+		implements ApplicationContextAware, ApplicationListener<ContextRefreshedEvent> {
 
 	private static final String REPLY_QUEUE = "testRabbitTemplateReplyTo";
 
@@ -82,22 +87,21 @@ public void setApplicationContext(ApplicationContext applicationContext) throws
 	}
 
 	@Override
-	public void afterSingletonsInstantiated() {
-		this.registry.getListenerContainers()
-			.stream()
-			.map(container -> (AbstractMessageListenerContainer) container)
-			.forEach(c -> {
-				for (String queue : c.getQueueNames()) {
-					setupListener(c, queue);
-				}
-			});
-		this.applicationContext.getBeansOfType(AbstractMessageListenerContainer.class).values()
-			.stream()
-			.forEach(container -> {
-				for (String queue : container.getQueueNames()) {
-					setupListener(container, queue);
-				}
-			});
+	public void onApplicationEvent(ContextRefreshedEvent event) {
+		if (event.getApplicationContext().equals(this.applicationContext)) {
+			Stream<AbstractMessageListenerContainer> registryListenerContainers =
+					this.registry.getListenerContainers()
+							.stream()
+							.map(AbstractMessageListenerContainer.class::cast);
+
+			Stream<AbstractMessageListenerContainer> listenerContainerBeans =
+					this.applicationContext.getBeansOfType(AbstractMessageListenerContainer.class).values().stream();
+
+			Stream.concat(registryListenerContainers, listenerContainerBeans)
+					.forEach(container ->
+							Arrays.stream(container.getQueueNames())
+									.forEach(queue -> setupListener(container, queue)));
+		}
 	}
 
 	private void setupListener(AbstractMessageListenerContainer container, String queue) {
@@ -143,8 +147,8 @@ protected Message doSendAndReceiveWithFixed(String exchange, String routingKey,
 					Envelope envelope = new Envelope(1, false, "", REPLY_QUEUE);
 					reply.set(MessageBuilder.withBody(i.getArgument(4)) // NOSONAR magic #
 							.andProperties(getMessagePropertiesConverter()
-								.toMessageProperties(i.getArgument(3), envelope, // NOSONAR magic #
-									adapter.getEncoding()))
+									.toMessageProperties(i.getArgument(3), envelope, // NOSONAR magic #
+											adapter.getEncoding()))
 							.build());
 					return null;
 				}).given(channel).basicPublish(anyString(), anyString(), anyBoolean(), any(BasicProperties.class),

spring-rabbit-test/src/test/java/org/springframework/amqp/rabbit/test/ExampleRabbitListenerCaptureTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 the original author or authors.
+ * Copyright 2016-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.
@@ -39,21 +39,25 @@
 import org.springframework.amqp.rabbit.junit.BrokerRunning;
 import org.springframework.amqp.rabbit.test.RabbitListenerTestHarness.InvocationData;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.support.DefaultListableBeanFactory;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.messaging.handler.annotation.Header;
 import org.springframework.messaging.handler.annotation.Payload;
 import org.springframework.test.annotation.DirtiesContext;
 import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.context.support.AnnotationConfigContextLoader;
 
 /**
  * @author Gary Russell
+ * @author Artem Bilan
+ *
  * @since 1.6
  *
  */
-@ContextConfiguration
-@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(loader = ExampleRabbitListenerCaptureTest.NoBeansOverrideAnnotationConfigContextLoader.class)
+@RunWith(SpringRunner.class)
 @DirtiesContext
 public class ExampleRabbitListenerCaptureTest {
 
@@ -179,4 +183,15 @@ public void foo(@Payload String foo, @Header("amqp_receivedRoutingKey") String r
 
 	}
 
+
+	public static class NoBeansOverrideAnnotationConfigContextLoader extends AnnotationConfigContextLoader {
+
+		@Override
+		protected void customizeBeanFactory(DefaultListableBeanFactory beanFactory) {
+			beanFactory.setAllowBeanDefinitionOverriding(false);
+		}
+
+	}
+
 }
+

spring-rabbit-test/src/test/java/org/springframework/amqp/rabbit/test/TestRabbitTemplateTests.java

@@ -23,8 +23,6 @@
 import static org.mockito.BDDMockito.willReturn;
 import static org.mockito.Mockito.mock;
 
-import java.io.IOException;
-
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
@@ -45,6 +43,8 @@
 
 /**
  * @author Gary Russell
+ * @author Artem Bilan
+ *
  * @since 2.0
  *
  */
@@ -87,12 +87,12 @@ public static class Config {
 		public String smlc1In = "smlc1:";
 
 		@Bean
-		public TestRabbitTemplate template() throws IOException {
+		public TestRabbitTemplate template() {
 			return new TestRabbitTemplate(connectionFactory());
 		}
 
 		@Bean
-		public ConnectionFactory connectionFactory() throws IOException {
+		public ConnectionFactory connectionFactory() {
 			ConnectionFactory factory = mock(ConnectionFactory.class);
 			Connection connection = mock(Connection.class);
 			Channel channel = mock(Channel.class);
@@ -103,7 +103,7 @@ public ConnectionFactory connectionFactory() throws IOException {
 		}
 
 		@Bean
-		public SimpleRabbitListenerContainerFactory rabbitListenerContainerFactory() throws IOException {
+		public SimpleRabbitListenerContainerFactory rabbitListenerContainerFactory() {
 			SimpleRabbitListenerContainerFactory factory = new SimpleRabbitListenerContainerFactory();
 			factory.setConnectionFactory(connectionFactory());
 			return factory;
@@ -125,7 +125,7 @@ public String baz(String in) {
 		}
 
 		@Bean
-		public SimpleMessageListenerContainer smlc1() throws IOException {
+		public SimpleMessageListenerContainer smlc1() {
 			SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(connectionFactory());
 			container.setQueueNames("foo", "bar");
 			container.setMessageListener(new MessageListenerAdapter(new Object() {

spring-rabbit/src/main/java/org/springframework/amqp/rabbit/annotation/RabbitBootstrapConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * 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.
@@ -18,37 +18,44 @@
 
 import org.springframework.amqp.rabbit.config.RabbitListenerConfigUtils;
 import org.springframework.amqp.rabbit.listener.RabbitListenerEndpointRegistry;
-import org.springframework.beans.factory.config.BeanDefinition;
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Configuration;
-import org.springframework.context.annotation.Role;
+import org.springframework.beans.factory.support.BeanDefinitionRegistry;
+import org.springframework.beans.factory.support.RootBeanDefinition;
+import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
+import org.springframework.core.type.AnnotationMetadata;
 
 /**
- * {@code @Configuration} class that registers a {@link RabbitListenerAnnotationBeanPostProcessor}
- * bean capable of processing Spring's @{@link RabbitListener} annotation. Also register
- * a default {@link RabbitListenerEndpointRegistry}.
+ * An {@link ImportBeanDefinitionRegistrar} class that registers
+ * a {@link RabbitListenerAnnotationBeanPostProcessor} bean capable of processing
+ * Spring's @{@link RabbitListener} annotation.
+ * Also register a default {@link RabbitListenerEndpointRegistry}.
  *
  * <p>This configuration class is automatically imported when using the @{@link EnableRabbit}
- * annotation.  See {@link EnableRabbit} Javadoc for complete usage.
+ * annotation.
  *
  * @author Stephane Nicoll
+ * @author Artem Bilan
+ *
  * @since 1.4
+ *
  * @see RabbitListenerAnnotationBeanPostProcessor
  * @see RabbitListenerEndpointRegistry
  * @see EnableRabbit
  */
-@Configuration
-public class RabbitBootstrapConfiguration {
+public class RabbitBootstrapConfiguration implements ImportBeanDefinitionRegistrar {
 
-	@Bean(name = RabbitListenerConfigUtils.RABBIT_LISTENER_ANNOTATION_PROCESSOR_BEAN_NAME)
-	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
-	public RabbitListenerAnnotationBeanPostProcessor rabbitListenerAnnotationProcessor() {
-		return new RabbitListenerAnnotationBeanPostProcessor();
-	}
+	@Override
+	public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
+		if (!registry.containsBeanDefinition(
+				RabbitListenerConfigUtils.RABBIT_LISTENER_ANNOTATION_PROCESSOR_BEAN_NAME)) {
+
+			registry.registerBeanDefinition(RabbitListenerConfigUtils.RABBIT_LISTENER_ANNOTATION_PROCESSOR_BEAN_NAME,
+					new RootBeanDefinition(RabbitListenerAnnotationBeanPostProcessor.class));
+		}
 
-	@Bean(name = RabbitListenerConfigUtils.RABBIT_LISTENER_ENDPOINT_REGISTRY_BEAN_NAME)
-	public RabbitListenerEndpointRegistry defaultRabbitListenerEndpointRegistry() {
-		return new RabbitListenerEndpointRegistry();
+		if (!registry.containsBeanDefinition(RabbitListenerConfigUtils.RABBIT_LISTENER_ENDPOINT_REGISTRY_BEAN_NAME)) {
+			registry.registerBeanDefinition(RabbitListenerConfigUtils.RABBIT_LISTENER_ENDPOINT_REGISTRY_BEAN_NAME,
+					new RootBeanDefinition(RabbitListenerEndpointRegistry.class));
+		}
 	}
 
 }