INT-4517: Refactor beans in IntegrationRegistrar (#2537)

* INT-4517: Refactor beans in IntegrationRegistrar

JIRA: https://jira.spring.io/browse/INT-4517

The `IntegrationRegistrar` populates beans into the application context
too early and when the `allowBeanDefinitionsOverride` is disabled we
end up with the `BeanDefinitionOverrideException` just because end-user
beans are applied later.

* Move most of the bean definitions which can be overridden in the target
application from the `IntegrationRegistrar` into the
`DefaultConfiguringBeanFactoryPostProcessor`
* Revise their registration logic to be sure that some of them are
registered only once in the parent context nad others are registered
in the child context as well
* Refactor a `DslIntegrationConfigurationInitializer` do not register
an `IntegrationFlowDefinition.ReplyProducerCleaner` in the child context
one more time: it doesn't bring any local store within the current
child context
* Introduce a `NoBeansOverrideAnnotationConfigContextLoader` in tests
to ensure that in some test-cases we disallow an
`allowBeanDefinitionsOverride` as it is now in Spring Boot since it is
enabled by default in the Spring Framework

* Revernt DslIntegrationConfigurationInitializer changes

Regsiter all the required infrastructure beans in all the application
contexts to avoid class loader issue for `static` store access

Author: artembilan

spring-integration-core/src/main/java/org/springframework/integration/config/DefaultConfiguringBeanFactoryPostProcessor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2016 the original author or authors.
+ * Copyright 2014-2018 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.
@@ -20,16 +20,13 @@
 import org.springframework.beans.factory.support.BeanDefinitionBuilder;
 import org.springframework.beans.factory.support.BeanDefinitionReaderUtils;
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
-import org.springframework.beans.factory.support.ManagedList;
-import org.springframework.context.Lifecycle;
 import org.springframework.integration.channel.DirectChannel;
-import org.springframework.integration.context.IntegrationContextUtils;
-import org.springframework.integration.support.SmartLifecycleRoleController;
 
 /**
  * Shared utility methods for Integration configuration.
  *
  * @author Artem Bilan
+ *
  * @since 4.0
  */
 public final class IntegrationConfigUtils {
@@ -43,6 +40,7 @@ public final class IntegrationConfigUtils {
 
 	public static void registerSpelFunctionBean(BeanDefinitionRegistry registry, String functionId, String className,
 												String methodSignature) {
+
 		BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(SpelFunctionFactoryBean.class)
 				.addConstructorArgValue(className)
 				.addConstructorArgValue(methodSignature);
@@ -55,17 +53,6 @@ public static void autoCreateDirectChannel(String channelName, BeanDefinitionReg
 		BeanDefinitionReaderUtils.registerBeanDefinition(holder, registry);
 	}
 
-	public static void registerRoleControllerDefinitionIfNecessary(BeanDefinitionRegistry registry) {
-		if (!registry.containsBeanDefinition(
-				IntegrationContextUtils.INTEGRATION_LIFECYCLE_ROLE_CONTROLLER)) {
-			BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(SmartLifecycleRoleController.class);
-			builder.addConstructorArgValue(new ManagedList<String>());
-			builder.addConstructorArgValue(new ManagedList<Lifecycle>());
-			registry.registerBeanDefinition(
-					IntegrationContextUtils.INTEGRATION_LIFECYCLE_ROLE_CONTROLLER, builder.getBeanDefinition());
-		}
-	}
-
 	private IntegrationConfigUtils() {
 	}
 

spring-integration-core/src/main/java/org/springframework/integration/config/IntegrationConfigUtils.java

@@ -57,7 +57,6 @@ public final BeanDefinition parse(Element element, ParserContext parserContext)
 		if (!this.initialized.getAndSet(true)) {
 			verifySchemaVersion(element, parserContext);
 			IntegrationRegistrar integrationRegistrar = new IntegrationRegistrar();
-			integrationRegistrar.setBeanClassLoader(parserContext.getReaderContext().getBeanClassLoader());
 			integrationRegistrar.registerBeanDefinitions(null, parserContext.getRegistry());
 		}
 		return this.delegate.parse(element, parserContext);

spring-integration-core/src/main/java/org/springframework/integration/config/IntegrationRegistrar.java

@@ -41,7 +41,6 @@ public class AnnotationConfigParser implements BeanDefinitionParser {
 	@Override
 	public BeanDefinition parse(final Element element, ParserContext parserContext) {
 		IntegrationRegistrar integrationRegistrar = new IntegrationRegistrar();
-		integrationRegistrar.setBeanClassLoader(parserContext.getReaderContext().getBeanClassLoader());
 
 		StandardAnnotationMetadata importingClassMetadata =
 				new StandardAnnotationMetadata(Object.class) {

spring-integration-core/src/main/java/org/springframework/integration/config/xml/AbstractIntegrationNamespaceHandler.java

@@ -41,6 +41,8 @@ public abstract class IntegrationContextUtils {
 
 	public static final String ERROR_CHANNEL_BEAN_NAME = "errorChannel";
 
+	public static final String ERROR_LOGGER_BEAN_NAME = "_org.springframework.integration.errorLogger";
+
 	public static final String NULL_CHANNEL_BEAN_NAME = "nullChannel";
 
 	public static final String METADATA_STORE_BEAN_NAME = "metadataStore";

spring-integration-core/src/main/java/org/springframework/integration/config/xml/AnnotationConfigParser.java

@@ -118,6 +118,7 @@
 import org.springframework.integration.support.SmartLifecycleRoleController;
 import org.springframework.integration.test.util.OnlyOnceTrigger;
 import org.springframework.integration.test.util.TestUtils;
+import org.springframework.integration.util.NoBeansOverrideAnnotationConfigContextLoader;
 import org.springframework.messaging.Message;
 import org.springframework.messaging.MessageChannel;
 import org.springframework.messaging.MessageDeliveryException;
@@ -136,7 +137,6 @@
 import org.springframework.test.annotation.DirtiesContext;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
-import org.springframework.test.context.support.AnnotationConfigContextLoader;
 import org.springframework.util.ClassUtils;
 import org.springframework.util.MultiValueMap;
 
@@ -148,7 +148,7 @@
  * @author Gary Russell
  * @since 4.0
  */
-@ContextConfiguration(loader = AnnotationConfigContextLoader.class,
+@ContextConfiguration(loader = NoBeansOverrideAnnotationConfigContextLoader.class,
 		classes = { EnableIntegrationTests.ContextConfiguration.class,
 				EnableIntegrationTests.ContextConfiguration2.class })
 @RunWith(SpringJUnit4ClassRunner.class)
@@ -961,6 +961,7 @@ public Number convert(Boolean source) {
 		public Integer getInvoked() {
 			return invoked.get();
 		}
+
 	}
 
 	@Configuration
@@ -1443,6 +1444,7 @@ public interface TestGateway2 {
 		String phase() default "";
 
 		Poller[] poller() default { };
+
 	}
 
 	@Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })
@@ -1461,6 +1463,7 @@ public interface TestGateway2 {
 		String phase() default "";
 
 		Poller[] poller() default { };
+
 	}
 
 	@Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })
@@ -1566,6 +1569,7 @@ public interface TestGateway2 {
 		String phase() default "";
 
 		Poller[] poller() default { };
+
 	}
 
 	@Target(ElementType.METHOD)
@@ -1614,6 +1618,7 @@ public interface TestGateway2 {
 	public @interface MyBridgeFrom {
 
 		String value() default "";
+
 	}
 
 	@Target(ElementType.METHOD)

spring-integration-core/src/main/java/org/springframework/integration/context/IntegrationContextUtils.java

@@ -75,6 +75,7 @@
 import org.springframework.integration.support.MessageBuilder;
 import org.springframework.integration.support.MutableMessageBuilder;
 import org.springframework.integration.transformer.PayloadSerializingTransformer;
+import org.springframework.integration.util.NoBeansOverrideAnnotationConfigContextLoader;
 import org.springframework.messaging.Message;
 import org.springframework.messaging.MessageChannel;
 import org.springframework.messaging.MessageDeliveryException;
@@ -91,6 +92,7 @@
 import org.springframework.stereotype.Component;
 import org.springframework.stereotype.Service;
 import org.springframework.test.annotation.DirtiesContext;
+import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.junit4.SpringRunner;
 
 /**
@@ -101,6 +103,7 @@
  *
  * @since 5.0
  */
+@ContextConfiguration(loader = NoBeansOverrideAnnotationConfigContextLoader.class)
 @RunWith(SpringRunner.class)
 @DirtiesContext
 public class IntegrationFlowTests {
@@ -482,11 +485,13 @@ public void testDedicatedPollingThreadFlow() throws InterruptedException {
 	public interface ControlBusGateway {
 
 		void send(String command);
+
 	}
 
 	@Configuration
 	@EnableIntegration
 	public static class SupplierContextConfiguration1 {
+
 		@Bean
 		public IntegrationFlow supplierFlow() {
 			return IntegrationFlows.from(() -> "foo")
@@ -512,15 +517,17 @@ public TaskScheduler taskScheduler() {
 		public MessageChannel suppliedChannel() {
 			return MessageChannels.queue(10).get();
 		}
+
 	}
 
 	@Configuration
 	@EnableIntegration
 	public static class SupplierContextConfiguration2 {
+
 		@Bean
 		public IntegrationFlow supplierFlow2() {
 			return IntegrationFlows.from(() -> "foo", c -> c.poller(Pollers.fixedDelay(100).maxMessagesPerPoll(1)))
-					.<String, String>transform(p -> p.toUpperCase())
+					.<String, String>transform(String::toUpperCase)
 					.channel("suppliedChannel2")
 					.get();
 		}
@@ -529,6 +536,7 @@ public IntegrationFlow supplierFlow2() {
 		public MessageChannel suppliedChannel2() {
 			return MessageChannels.queue(10).get();
 		}
+
 	}
 
 	@Configuration
@@ -542,18 +550,6 @@ public IntegrationFlow controlBusFlow() {
 					.get();
 		}
 
-		@Bean(name = PollerMetadata.DEFAULT_POLLER)
-		public PollerMetadata poller() {
-			return Pollers.fixedRate(500).get();
-		}
-
-		@Bean(name = IntegrationContextUtils.TASK_SCHEDULER_BEAN_NAME)
-		public TaskScheduler taskScheduler() {
-			ThreadPoolTaskScheduler threadPoolTaskScheduler = new ThreadPoolTaskScheduler();
-			threadPoolTaskScheduler.setPoolSize(100);
-			return threadPoolTaskScheduler;
-		}
-
 		@Bean
 		public MessageChannel inputChannel() {
 			return MessageChannels.direct().get();
@@ -690,6 +686,7 @@ public static class AnnotationTestService {
 		public void handle(Object payload) {
 			assertEquals(100, payload);
 		}
+
 	}
 
 	@Configuration
@@ -856,6 +853,7 @@ public static class GreetingService extends AbstractReplyProducingMessageHandler
 		protected Object handleRequestMessage(Message<?> requestMessage) {
 			return "Hello " + this.worldService.world() + " and " + requestMessage.getPayload();
 		}
+
 	}
 
 	@Service
@@ -864,6 +862,7 @@ public static class WorldService {
 		public String world() {
 			return "World";
 		}
+
 	}
 
 

spring-integration-core/src/test/java/org/springframework/integration/configuration/EnableIntegrationTests.java

@@ -82,6 +82,7 @@
 import org.springframework.integration.support.SmartLifecycleRoleController;
 import org.springframework.integration.test.util.TestUtils;
 import org.springframework.integration.transformer.MessageTransformingHandler;
+import org.springframework.integration.util.NoBeansOverrideAnnotationConfigContextLoader;
 import org.springframework.messaging.Message;
 import org.springframework.messaging.MessageChannel;
 import org.springframework.messaging.MessageDeliveryException;
@@ -102,7 +103,8 @@
  *
  * @since 5.0
  */
-@ContextConfiguration(classes = ManualFlowTests.RootConfiguration.class)
+@ContextConfiguration(loader = NoBeansOverrideAnnotationConfigContextLoader.class,
+		classes = ManualFlowTests.RootConfiguration.class)
 @RunWith(SpringRunner.class)
 @DirtiesContext
 public class ManualFlowTests {

spring-integration-core/src/test/java/org/springframework/integration/dsl/flows/IntegrationFlowTests.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2018 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.util;
+
+import org.springframework.beans.factory.support.DefaultListableBeanFactory;
+import org.springframework.test.context.support.AnnotationConfigContextLoader;
+
+/**
+ * @author Artem Bilan
+ *
+ * @since 5.1
+ */
+public class NoBeansOverrideAnnotationConfigContextLoader extends AnnotationConfigContextLoader {
+
+	@Override
+	protected void customizeBeanFactory(DefaultListableBeanFactory beanFactory) {
+		beanFactory.setAllowBeanDefinitionOverriding(false);
+	}
+
+}