Upgrade to SF 5.1; Remove Deprecated Code

Polishing - PR Comments

Remove direct log4j usage in tests

- hazelcast depends on it; retain the dependency just in jmx

Fix hazelcast logger type

Author: garyrussell

build.gradle

@@ -122,7 +122,7 @@ subprojects { subproject ->
 		junitVintageVersion = '5.1.0'
 		jythonVersion = '2.5.3'
 		kryoShadedVersion = '3.0.3'
-		log4jVersion = '2.10.0'
+		log4jVersion = '2.11.0'
 		micrometerVersion = '1.0.3'
 		mockitoVersion = '2.11.0'
 		mysqlVersion = '6.0.6'
@@ -141,7 +141,7 @@ subprojects { subproject ->
 		springSecurityVersion = '5.1.0.BUILD-SNAPSHOT'
 		springSocialTwitterVersion = '1.1.2.RELEASE'
 		springRetryVersion = '1.2.2.RELEASE'
-		springVersion = project.hasProperty('springVersion') ? project.springVersion : '5.0.5.BUILD-SNAPSHOT'
+		springVersion = project.hasProperty('springVersion') ? project.springVersion : '5.1.0.BUILD-SNAPSHOT'
 		springWsVersion = '3.0.1.RELEASE'
 		tomcatVersion = "8.5.23"
 		xmlUnitVersion = '1.6'
@@ -291,7 +291,6 @@ project('spring-integration-test-support') {
 		compile "org.springframework:spring-messaging:$springVersion"
 		compile "org.springframework:spring-test:$springVersion"
 		compile ("org.apache.logging.log4j:log4j-core:$log4jVersion" , optional)
-		compile ('log4j:log4j:1.2.17', optional)
 	}
 }
 

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

@@ -23,7 +23,6 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
-import java.util.Properties;
 import java.util.Set;
 
 import org.apache.commons.logging.Log;
@@ -39,8 +38,6 @@
 import org.springframework.integration.channel.ChannelInterceptorAware;
 import org.springframework.integration.channel.interceptor.GlobalChannelInterceptorWrapper;
 import org.springframework.integration.channel.interceptor.VetoCapableInterceptor;
-import org.springframework.integration.context.IntegrationContextUtils;
-import org.springframework.integration.context.IntegrationProperties;
 import org.springframework.integration.support.utils.PatternMatchUtils;
 import org.springframework.messaging.support.ChannelInterceptor;
 import org.springframework.util.Assert;
@@ -105,12 +102,7 @@ public void afterSingletonsInstantiated() {
 			}
 		}
 
-		// TODO Remove this logic in 5.1
-		Properties integrationProperties = IntegrationContextUtils.getIntegrationProperties(this.beanFactory);
-
-		this.singletonsInstantiated =
-				Boolean.parseBoolean(integrationProperties.getProperty(
-						IntegrationProperties.POST_PROCESS_DYNAMIC_BEANS));
+		this.singletonsInstantiated = true;
 	}
 
 	@Override

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

@@ -77,13 +77,6 @@ public final class IntegrationProperties {
 	 */
 	public static final String ENDPOINTS_NO_AUTO_STARTUP = INTEGRATION_PROPERTIES_PREFIX + "endpoints.noAutoStartup";
 
-	/**
-	 * Whether {@link org.springframework.beans.factory.config.BeanPostProcessor}s should process beans registered at runtime.
-	 * Will be removed in 5.1.
-	 */
-	public static final String POST_PROCESS_DYNAMIC_BEANS = INTEGRATION_PROPERTIES_PREFIX + "postProcessDynamicBeans";
-
-
 	private static Properties defaults;
 
 	static {

spring-integration-core/src/main/java/org/springframework/integration/dispatcher/AbstractDispatcher.java

@@ -21,10 +21,9 @@
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
+import org.springframework.integration.support.utils.IntegrationUtils;
 import org.springframework.messaging.Message;
-import org.springframework.messaging.MessageDeliveryException;
 import org.springframework.messaging.MessageHandler;
-import org.springframework.messaging.MessagingException;
 import org.springframework.util.Assert;
 
 /**
@@ -117,41 +116,13 @@ protected boolean tryOptimizedDispatch(Message<?> message) {
 				return true;
 			}
 			catch (Exception e) {
-				throw wrapExceptionIfNecessary(message, e);
+				throw IntegrationUtils.wrapInDeliveryExceptionIfNecessary(message,
+						() -> "Dispatcher failed to deliver Message", e);
 			}
 		}
 		return false;
 	}
 
-	/**
-	 * If the exception is not a {@link MessagingException} or does not have a
-	 * {@link MessagingException#getFailedMessage() failedMessage}, wrap it in a new
-	 * {@link MessagingException} with the message. There is some inconsistency here in
-	 * that {@link MessagingException}s are wrapped in a {@link MessagingException} whereas
-	 * {@link Exception}s are wrapped in {@link MessageDeliveryException}. It is retained
-	 * for backwards compatibility and will be resolved in 5.1.
-	 * It also does not wrap other {@link RuntimeException}s.
-	 * TODO: Remove this in favor of
-	 * {@code #wrapInDeliveryExceptionIfNecessary(Message, Supplier, Exception)} in 5.1.
-	 * @param message the message.
-	 * @param e the exception.
-	 * @return the wrapper, if necessary, or the original exception.
-	 * @deprecated in favor of
-	 * {@code IntegrationUtils#wrapInDeliveryExceptionIfNecessary(Message, Supplier, Exception)}
-	 */
-	@Deprecated
-	protected RuntimeException wrapExceptionIfNecessary(Message<?> message, Exception e) {
-		RuntimeException runtimeException = (e instanceof RuntimeException)
-				? (RuntimeException) e
-				: new MessageDeliveryException(message,
-						"Dispatcher failed to deliver Message.", e);
-		if (e instanceof MessagingException &&
-				((MessagingException) e).getFailedMessage() == null) {
-			runtimeException = new MessagingException(message, "Dispatcher failed to deliver Message", e);
-		}
-		return runtimeException;
-	}
-
 	@Override
 	public String toString() {
 		return this.getClass().getSimpleName() + " with handlers: " + this.handlers.toString();

spring-integration-core/src/main/java/org/springframework/integration/dispatcher/UnicastingDispatcher.java

@@ -22,6 +22,7 @@
 import java.util.concurrent.Executor;
 
 import org.springframework.integration.MessageDispatchingException;
+import org.springframework.integration.support.utils.IntegrationUtils;
 import org.springframework.messaging.Message;
 import org.springframework.messaging.MessageDeliveryException;
 import org.springframework.messaging.MessageHandler;
@@ -145,8 +146,8 @@ private boolean doDispatch(Message<?> message) {
 				success = true; // we have a winner.
 			}
 			catch (Exception e) {
-				@SuppressWarnings("deprecation")
-				RuntimeException runtimeException = wrapExceptionIfNecessary(message, e);
+				RuntimeException runtimeException = IntegrationUtils.wrapInDeliveryExceptionIfNecessary(message,
+						() -> "Dispatcher failed to deliver Message", e);
 				exceptions.add(runtimeException);
 				this.handleExceptions(exceptions, message, !handlerIterator.hasNext());
 			}

spring-integration-core/src/main/java/org/springframework/integration/endpoint/PollingConsumer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-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.
@@ -135,14 +135,12 @@ protected void handleMessage(Message<?> message) {
 			if (!CollectionUtils.isEmpty(interceptorStack)) {
 				triggerAfterMessageHandled(theMessage, ex, interceptorStack);
 			}
-			// TODO: In 5.1 remove this; adding the failed message to the text is redundant
-			final Message<?> messageForText = theMessage;
 			throw IntegrationUtils.wrapInDeliveryExceptionIfNecessary(theMessage,
-					() -> "Failed to handle " + messageForText + " to " + this + " in " + this.handler, ex);
+					() -> "Failed to handle message to " + this + " in " + this.handler, ex);
 		}
 		catch (Error ex) { //NOSONAR - ok, we re-throw below
 			if (!CollectionUtils.isEmpty(interceptorStack)) {
-				String description = "Failed to handle " + theMessage + " to " + this + " in " + this.handler;
+				String description = "Failed to handle message to " + this + " in " + this.handler;
 				triggerAfterMessageHandled(theMessage,
 						new MessageDeliveryException(theMessage, description, ex),
 						interceptorStack);

spring-integration-core/src/main/resources/META-INF/spring.integration.default.properties

@@ -6,4 +6,3 @@ spring.integration.messagingTemplate.throwExceptionOnLateReply=false
 # Defaults to MessageHeaders.ID and MessageHeaders.TIMESTAMP
 spring.integration.readOnly.headers=
 spring.integration.endpoints.noAutoStartup=
-spring.integration.postProcessDynamicBeans=false

spring-integration-ip/src/test/java/org/springframework/integration/ip/tcp/InterceptedSharedConnectionTests.java

@@ -22,10 +22,6 @@
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertThat;
 
-import org.apache.log4j.Level;
-import org.apache.log4j.LogManager;
-import org.junit.AfterClass;
-import org.junit.BeforeClass;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
@@ -67,20 +63,6 @@ public class InterceptedSharedConnectionTests {
 	@Autowired
 	Listener listener;
 
-	private static Level existingLogLevel;
-
-	// temporary hooks to investigate CI failures
-	@BeforeClass
-	public static void setup() {
-		existingLogLevel = LogManager.getLogger("org.springframework.integration").getLevel();
-		LogManager.getLogger("org.springframework.integration").setLevel(Level.DEBUG);
-	}
-
-	@AfterClass
-	public static void tearDown() {
-		LogManager.getLogger("org.springframework.integration").setLevel(existingLogLevel);
-	}
-
 	/**
 	 * Tests a loopback. The client-side outbound adapter sends a message over
 	 * a connection from the client connection factory; the server side

spring-integration-jdbc/src/test/java/org/springframework/integration/jdbc/StoredProcExecutorTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-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.
@@ -27,7 +27,8 @@
 
 import javax.sql.DataSource;
 
-import org.apache.log4j.Logger;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import org.junit.Test;
 
 import org.springframework.beans.DirectFieldAccessor;
@@ -52,7 +53,7 @@
  */
 public class StoredProcExecutorTests {
 
-	private static final Logger LOGGER = Logger.getLogger(StoredProcExecutorTests.class);
+	private static final Log LOGGER = LogFactory.getLog(StoredProcExecutorTests.class);
 
 	@Test
 	public void testStoredProcExecutorWithNullDataSource() {

spring-integration-jms/src/test/java/org/springframework/integration/jms/request_reply/PipelineJmsTests.java

@@ -26,10 +26,7 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
-import org.apache.log4j.Level;
-import org.apache.log4j.LogManager;
 import org.junit.After;
-import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
 
@@ -54,11 +51,6 @@ public class PipelineJmsTests extends ActiveMQMultiContextTests {
 	@Rule
 	public LongRunningIntegrationTest longTests = new LongRunningIntegrationTest();
 
-	@Before
-	public void setLogLevel() {
-		LogManager.getLogger(getClass()).setLevel(Level.INFO);
-	}
-
 	@After
 	public void tearDown() {
 		this.executor.shutdownNow();

spring-integration-jms/src/test/java/org/springframework/integration/jms/request_reply/PipelineNamedReplyQueuesJmsTests.java

@@ -29,10 +29,7 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
-import org.apache.log4j.Level;
-import org.apache.log4j.LogManager;
 import org.junit.After;
-import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
 
@@ -59,11 +56,6 @@ public class PipelineNamedReplyQueuesJmsTests extends ActiveMQMultiContextTests
 	@Rule
 	public LongRunningIntegrationTest longTests = new LongRunningIntegrationTest();
 
-	@Before
-	public void setLogLevel() {
-		LogManager.getLogger(getClass()).setLevel(Level.INFO);
-	}
-
 	@After
 	public void tearDown() {
 		this.executor.shutdownNow();

spring-integration-jmx/src/test/java/org/springframework/integration/monitor/IdempotentReceiverIntegrationTests.java

@@ -250,7 +250,7 @@ public static MBeanServerFactoryBean mBeanServer() {
 
 		@Bean
 		public HazelcastInstance hazelcastInstance() {
-			return Hazelcast.newHazelcastInstance(new Config().setProperty("hazelcast.logging.type", "log4j"));
+			return Hazelcast.newHazelcastInstance(new Config().setProperty("hazelcast.logging.type", "slf4j"));
 		}