GH-3055: Deprecate JUnit 4 classes in the project

artembilan · artembilan · commit f8a3744045b2 · 2025-04-28T16:04:13.000-04:00
Fixes: #3055 JUnit 4 is no longer actively maintained, and the last maintenance release was JUnit 4.13.2 in February 2021. In addition, JUnit 4 has a Java 1.5 baseline. Furthermore, the JUnit team is planning to release JUnit 6.0 with a Java 17 baseline later this year. Since JUnit 5 support has been deprecated in Spring Framework, we also follow same theme and deprecate for removal JUnit 4 rules implementations in favor of respective utils for JUnit 5
diff --git a/build.gradle b/build.gradle
@@ -50,7 +50,6 @@ ext {
 	hibernateValidationVersion = '8.0.2.Final'
 	jacksonBomVersion = '2.18.3'
 	jaywayJsonPathVersion = '2.9.0'
-	junit4Version = '4.13.2'
 	junitJupiterVersion = '5.12.2'
 	kotlinCoroutinesVersion = '1.10.2'
 	log4jVersion = '2.24.3'
@@ -442,9 +441,6 @@ project('spring-rabbit') {
 		testRuntimeOnly 'com.fasterxml.jackson.core:jackson-databind'
 		testRuntimeOnly 'com.fasterxml.jackson.dataformat:jackson-dataformat-xml'
 		testRuntimeOnly 'com.fasterxml.jackson.module:jackson-module-kotlin'
-		testRuntimeOnly("junit:junit:$junit4Version") {
-			exclude group: 'org.hamcrest', module: 'hamcrest-core'
-		}
 	}
 }
 
@@ -503,9 +499,6 @@ project('spring-rabbit-junit') {
 		api 'org.junit.jupiter:junit-jupiter-api'
 		api "org.assertj:assertj-core:$assertjVersion"
 
-		optionalApi("junit:junit:$junit4Version") {
-			exclude group: 'org.hamcrest', module: 'hamcrest-core'
-		}
 		optionalApi 'org.testcontainers:rabbitmq'
 		optionalApi 'org.testcontainers:junit-jupiter'
 		optionalApi "ch.qos.logback:logback-classic:$logbackVersion"
diff --git a/spring-rabbit-junit/src/main/java/org/springframework/amqp/rabbit/junit/BrokerRunning.java b/spring-rabbit-junit/src/main/java/org/springframework/amqp/rabbit/junit/BrokerRunning.java
@@ -62,7 +62,9 @@
  *
  * @since 1.7
  *
+ * @deprecated since 4.0 in favor of JUnit 5 {@link RabbitAvailable}.
  */
+@Deprecated(since = "4.0", forRemoval = true)
 public final class BrokerRunning extends TestWatcher {
 
 	private static final Log LOGGER = LogFactory.getLog(BrokerRunningSupport.class);
diff --git a/spring-rabbit-junit/src/main/java/org/springframework/amqp/rabbit/junit/JUnitUtils.java b/spring-rabbit-junit/src/main/java/org/springframework/amqp/rabbit/junit/JUnitUtils.java
@@ -131,11 +131,6 @@ public static void revertLevels(String methodName, LevelsContainer container) {
 				((Logger) LogManager.getLogger(key)).setLevel(value);
 			}
 		});
-		container.oldLevels.forEach((key, value) -> {
-			if (!key.equals(BrokerRunning.class)) {
-				((Logger) LogManager.getLogger(key)).setLevel(value);
-			}
-		});
 //		container.oldLbLevels.forEach((key, value) ->
 //				((ch.qos.logback.classic.Logger) LoggerFactory.getLogger(key)).setLevel(value));
 	}
diff --git a/spring-rabbit-junit/src/main/java/org/springframework/amqp/rabbit/junit/LogLevelAdjuster.java b/spring-rabbit-junit/src/main/java/org/springframework/amqp/rabbit/junit/LogLevelAdjuster.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2025 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.
@@ -32,16 +32,19 @@
  * A JUnit method &#064;Rule that changes the logger level for a set of classes
  * while a test method is running. Useful for performance or scalability tests
  * where we don't want to generate a large log in a tight inner loop.
- *
+ * <p>
  * As well as adjusting Log4j, this also adjusts loggers for logback. The amqp-client
- * library now uses slf4j. Since we have logback on the CP (for the appender)
+ * library now uses Slf4J. Since we have logback on the CP (for the appender)
  * we can't add the slf4j-log4j bridge as well.
  *
  * @author Dave Syer
  * @author Artem Bilan
  * @author Gary Russell
  *
+ * @deprecated since 4.0 in favor of JUnit 5 {@link LogLevels}.
+ *
  */
+@Deprecated(since = "4.0", forRemoval = true)
 public class LogLevelAdjuster implements MethodRule {
 
 	private final List<Class<?>> classes;
diff --git a/spring-rabbit-junit/src/main/java/org/springframework/amqp/rabbit/junit/LongRunning.java b/spring-rabbit-junit/src/main/java/org/springframework/amqp/rabbit/junit/LongRunning.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2024 the original author or authors.
+ * Copyright 2017-2025 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.
@@ -30,8 +30,9 @@
  * the value that {@link Boolean#parseBoolean(String)} evaluates to {@code true}.
  *
  * @author Gary Russell
- * @since 2.0.2
+ * @author Artem Bilan
  *
+ * @since 2.0.2
  */
 @ExtendWith(LongRunningIntegrationTestCondition.class)
 @Target({ ElementType.TYPE })
@@ -40,10 +41,10 @@
 public @interface LongRunning {
 
 	/**
-	 * The name of the variable/property used to determine whether long running tests
+	 * The name of the variable/property used to determine whether long-running tests
 	 * should run.
 	 * @return the name of the variable/property.
 	 */
-	String value() default LongRunningIntegrationTest.RUN_LONG_INTEGRATION_TESTS;
+	String value() default LongRunningIntegrationTestCondition.RUN_LONG_INTEGRATION_TESTS;
 
 }
diff --git a/spring-rabbit-junit/src/main/java/org/springframework/amqp/rabbit/junit/LongRunningIntegrationTest.java b/spring-rabbit-junit/src/main/java/org/springframework/amqp/rabbit/junit/LongRunningIntegrationTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2019 the original author or authors.
+ * Copyright 2013-2025 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.
@@ -24,19 +24,23 @@
 import org.junit.runners.model.Statement;
 
 /**
- * Rule to prevent long running tests from running on every build; set environment
+ * Rule to prevent long-running tests from running on every build; set environment
  * variable RUN_LONG_INTEGRATION_TESTS on a CI nightly build to ensure coverage.
  *
  * @author Gary Russell
  * @author Artem Bilan
+ *
  * @since 1.2.1
  *
+ * @deprecated since 4.0 in favor of JUnit 5 {@link LongRunning}.
  */
+@Deprecated(since = "4.0", forRemoval = true)
 public class LongRunningIntegrationTest extends TestWatcher {
 
 	private static final Log logger = LogFactory.getLog(LongRunningIntegrationTest.class); // NOSONAR - lower case
 
-	public static final String RUN_LONG_INTEGRATION_TESTS = "RUN_LONG_INTEGRATION_TESTS";
+	public static final String RUN_LONG_INTEGRATION_TESTS =
+			LongRunningIntegrationTestCondition.RUN_LONG_INTEGRATION_TESTS;
 
 	private boolean shouldRun = false;
 
@@ -56,7 +60,7 @@ public LongRunningIntegrationTest(String property) {
 	@Override
 	public Statement apply(Statement base, Description description) {
 		if (!this.shouldRun) {
-			logger.info("Skipping long running test " + description.toString());
+			logger.info("Skipping long running test " + description);
 		}
 		Assume.assumeTrue(this.shouldRun);
 		return super.apply(base, description);
diff --git a/spring-rabbit-junit/src/main/java/org/springframework/amqp/rabbit/junit/LongRunningIntegrationTestCondition.java b/spring-rabbit-junit/src/main/java/org/springframework/amqp/rabbit/junit/LongRunningIntegrationTestCondition.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2019 the original author or authors.
+ * Copyright 2017-2025 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.
@@ -28,15 +28,20 @@
 import org.springframework.util.StringUtils;
 
 /**
- * {@link ExecutionCondition} to skip long running tests unless an environment
+ * {@link ExecutionCondition} to skip long-running tests unless an environment
  * variable or property is set.
  *
  * @author Gary Russell
+ * @author Artem Bilan
+ *
  * @since 2.0.2
+ *
  * @see LongRunning
  */
 public class LongRunningIntegrationTestCondition implements ExecutionCondition {
 
+	public static final String RUN_LONG_INTEGRATION_TESTS = "RUN_LONG_INTEGRATION_TESTS";
+
 	private static final ConditionEvaluationResult ENABLED = ConditionEvaluationResult.enabled(
 			"@LongRunning is not present");
 
@@ -50,7 +55,7 @@ public ConditionEvaluationResult evaluateExecutionCondition(ExtensionContext con
 			LongRunning longRunning = mergedAnnotation.synthesize();
 			String property = longRunning.value();
 			if (!StringUtils.hasText(property)) {
-				property = LongRunningIntegrationTest.RUN_LONG_INTEGRATION_TESTS;
+				property = RUN_LONG_INTEGRATION_TESTS;
 			}
 			return JUnitUtils.parseBooleanProperty(property)
 					? ConditionEvaluationResult.enabled("Long running tests must run")
diff --git a/spring-rabbit-junit/src/main/java/org/springframework/amqp/rabbit/junit/package-info.java b/spring-rabbit-junit/src/main/java/org/springframework/amqp/rabbit/junit/package-info.java
@@ -1,6 +1,5 @@
 /**
- * Provides support classes (Rules etc. with no spring-rabbit dependencies) for JUnit
- * tests.
+ * Provides support classes for JUnit tests.
  */
 @org.jspecify.annotations.NullMarked
 package org.springframework.amqp.rabbit.junit;
diff --git a/spring-rabbit-junit/src/test/java/org/springframework/amqp/rabbit/junit/BrokerRunningTests.java b/spring-rabbit-junit/src/test/java/org/springframework/amqp/rabbit/junit/BrokerRunningTests.java
diff --git a/spring-rabbit/src/test/java/org/springframework/amqp/rabbit/core/RabbitTemplateIntegrationTests.java b/spring-rabbit/src/test/java/org/springframework/amqp/rabbit/core/RabbitTemplateIntegrationTests.java
@@ -79,7 +79,6 @@
 import org.springframework.amqp.rabbit.connection.PublisherCallbackChannelImpl;
 import org.springframework.amqp.rabbit.connection.RabbitResourceHolder;
 import org.springframework.amqp.rabbit.connection.SingleConnectionFactory;
-import org.springframework.amqp.rabbit.junit.BrokerRunning;
 import org.springframework.amqp.rabbit.junit.BrokerTestUtils;
 import org.springframework.amqp.rabbit.junit.LogLevels;
 import org.springframework.amqp.rabbit.junit.RabbitAvailable;
@@ -146,8 +145,7 @@
 		RabbitTemplateIntegrationTests.NO_CORRELATION})
 @LogLevels(classes = {RabbitTemplate.class, DirectMessageListenerContainer.class,
 		DirectReplyToMessageListenerContainer.class,
-		RabbitAdmin.class, RabbitTemplateIntegrationTests.class, BrokerRunning.class,
-		ClosingRecoveryListener.class},
+		RabbitAdmin.class, RabbitTemplateIntegrationTests.class, ClosingRecoveryListener.class},
 		level = "DEBUG")
 @DirtiesContext
 public class RabbitTemplateIntegrationTests {
diff --git a/spring-rabbit/src/test/java/org/springframework/amqp/rabbit/listener/DirectMessageListenerContainerIntegrationTests.java b/spring-rabbit/src/test/java/org/springframework/amqp/rabbit/listener/DirectMessageListenerContainerIntegrationTests.java
@@ -48,7 +48,6 @@
 import org.springframework.amqp.rabbit.connection.ConnectionFactory;
 import org.springframework.amqp.rabbit.core.RabbitAdmin;
 import org.springframework.amqp.rabbit.core.RabbitTemplate;
-import org.springframework.amqp.rabbit.junit.BrokerRunning;
 import org.springframework.amqp.rabbit.junit.BrokerRunningSupport;
 import org.springframework.amqp.rabbit.junit.LogLevels;
 import org.springframework.amqp.rabbit.junit.RabbitAvailable;
@@ -89,15 +88,15 @@
  * @since 2.0
  *
  */
-@RabbitAvailable(queues = { DirectMessageListenerContainerIntegrationTests.Q1,
+@RabbitAvailable(queues = {DirectMessageListenerContainerIntegrationTests.Q1,
 		DirectMessageListenerContainerIntegrationTests.Q2,
 		DirectMessageListenerContainerIntegrationTests.Q3,
 		DirectMessageListenerContainerIntegrationTests.EQ1,
 		DirectMessageListenerContainerIntegrationTests.EQ2,
-		DirectMessageListenerContainerIntegrationTests.DLQ1 })
-@LogLevels(classes = { CachingConnectionFactory.class, DirectReplyToMessageListenerContainer.class,
-			DirectMessageListenerContainer.class, DirectMessageListenerContainerIntegrationTests.class,
-			BrokerRunning.class }, level = "DEBUG")
+		DirectMessageListenerContainerIntegrationTests.DLQ1})
+@LogLevels(classes = {CachingConnectionFactory.class, DirectReplyToMessageListenerContainer.class,
+		DirectMessageListenerContainer.class, DirectMessageListenerContainerIntegrationTests.class},
+		level = "DEBUG")
 public class DirectMessageListenerContainerIntegrationTests {
 
 	public static final String Q1 = "testQ1.DirectMessageListenerContainerIntegrationTests";
@@ -309,7 +308,7 @@ public void testQueueManagementQueueInstances() throws Exception {
 		container.setConsumerTagStrategy(new Tag());
 		container.afterPropertiesSet();
 		container.setQueues(new Queue(Q1));
-		assertThat(container.getQueueNames()).isEqualTo(new String[]{Q1});
+		assertThat(container.getQueueNames()).isEqualTo(new String[] {Q1});
 		container.start();
 		container.addQueues(new Queue(Q2));
 		assertThat(consumersOnQueue(Q1, 2)).isTrue();
@@ -392,7 +391,8 @@ else if (event instanceof ListenerContainerConsumerTerminatedEvent) {
 				latch2.countDown();
 			}
 		});
-		container.setMessageListener(m -> { });
+		container.setMessageListener(m -> {
+		});
 		container.setIdleEventInterval(50L);
 		container.setBeanName("events");
 		container.setConsumerTagStrategy(new Tag());
@@ -563,7 +563,8 @@ private void testRecoverDeletedQueueGuts(boolean autoDeclare, BrokerRunningSuppo
 		container.setQueueNames(Q1, Q2);
 		container.setConsumersPerQueue(2);
 		container.setConsumersPerQueue(2);
-		container.setMessageListener(m -> { });
+		container.setMessageListener(m -> {
+		});
 		container.setFailedDeclarationRetryInterval(500);
 		container.setBeanName("deleteQauto=" + autoDeclare);
 		container.setConsumerTagStrategy(new Tag());
@@ -650,7 +651,8 @@ public void testNonManagedContainerDoesntStartWhenConnectionFactoryDestroyed() t
 		});
 
 		DirectMessageListenerContainer container = new DirectMessageListenerContainer(cf);
-		container.setMessageListener(m -> { });
+		container.setMessageListener(m -> {
+		});
 		container.setQueueNames(Q1);
 		container.setBeanName("stopAfterDestroyBeforeStart");
 		container.afterPropertiesSet();
@@ -741,6 +743,7 @@ public void testMessageAckListenerWithSuccessfulAck() throws Exception {
 		final CountDownLatch latch = new CountDownLatch(1);
 		container.setQueueNames(Q1);
 		container.setMessageListener(new MessageListener() {
+
 			@Override
 			public void onMessage(Message message) {
 			}
@@ -777,6 +780,7 @@ public void testMessageAckListenerWithFailedAck() throws Exception {
 		final CountDownLatch latch = new CountDownLatch(1);
 		container.setQueueNames(Q1);
 		container.setMessageListener(new MessageListener() {
+
 			@Override
 			public void onMessage(Message message) {
 				cf.resetConnection();
@@ -914,4 +918,5 @@ public String createConsumerTag(String queue) {
 		}
 
 	}
+
 }
diff --git a/src/reference/antora/modules/ROOT/pages/testing.adoc b/src/reference/antora/modules/ROOT/pages/testing.adoc
diff --git a/src/reference/antora/modules/ROOT/pages/whats-new.adoc b/src/reference/antora/modules/ROOT/pages/whats-new.adoc

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,9 @@`
`62`	`62`	`*`
`63`	`63`	`* @since 1.7`
`64`	`64`	`*`
	`65`	`+ * @deprecated since 4.0 in favor of JUnit 5 {@link RabbitAvailable}.`
`65`	`66`	`*/`
	`67`	`+@Deprecated(since = "4.0", forRemoval = true)`
`66`	`68`	`public final class BrokerRunning extends TestWatcher {`
`67`	`69`
`68`	`70`	`private static final Log LOGGER = LogFactory.getLog(BrokerRunningSupport.class);`
Original file line number	Diff line number	Diff line change
`@@ -131,11 +131,6 @@ public static void revertLevels(String methodName, LevelsContainer container) {`
`131`	`131`	`((Logger) LogManager.getLogger(key)).setLevel(value);`
`132`	`132`	`}`
`133`	`133`	`});`
`134`		`- container.oldLevels.forEach((key, value) -> {`
`135`		`- if (!key.equals(BrokerRunning.class)) {`
`136`		`- ((Logger) LogManager.getLogger(key)).setLevel(value);`
`137`		`- }`
`138`		`- });`
`139`	`134`	`// container.oldLbLevels.forEach((key, value) ->`
`140`	`135`	`// ((ch.qos.logback.classic.Logger) LoggerFactory.getLogger(key)).setLevel(value));`
`141`	`136`	`}`