Deprecate junit-jupiter-migrationsupport for removal in 7.0

Author: marcphilipp

documentation/src/docs/asciidoc/release-notes/release-notes-6.0.0-M1.adoc

@@ -110,6 +110,8 @@ repository on GitHub.
 * The contracts for the `Executable` parameters of Kotlin-specific `assertTimeout`
   functions were changed from `callsInPlace(executable, EXACTLY_ONCE)` to
   `callsInPlace(executable, AT_MOST_ONCE)` which might result in compilation errors.
+* The `junit-jupiter-migrationsupport` artifact and its contained classes are now
+  deprecated and will be removed in the next major version.
 
 [[release-notes-6.0.0-M1-junit-jupiter-new-features-and-improvements]]
 ==== New Features and Improvements

documentation/src/docs/asciidoc/user-guide/appendix.adoc

@@ -108,8 +108,8 @@ Please refer to the corresponding sections for <<running-tests-build-maven-bom,
   `junit-jupiter-params`::
     Support for <<writing-tests-parameterized-tests>> in JUnit Jupiter.
   `junit-jupiter-migrationsupport`::
-    Support for migrating from JUnit 4 to JUnit Jupiter; only required for support for
-    JUnit 4's `@Ignore` annotation and for running selected JUnit 4 rules.
+    _Deprecated_ support for migrating from JUnit 4 to JUnit Jupiter; only required for
+    support for JUnit 4's `@Ignore` annotation and for running selected JUnit 4 rules.
 
 [[dependency-metadata-junit-vintage]]
 ==== JUnit Vintage

documentation/src/docs/asciidoc/user-guide/migration-from-junit4.adoc

@@ -256,6 +256,9 @@ include::{testDir}/example/ParameterizedMigrationDemo.java[tags=after]
 [[migrating-from-junit4-rule-support]]
 === Limited JUnit 4 Rule Support
 
+WARNING: _JUnit 4 rule support_ is deprecated for removal since version 6.0.0. Please
+migrate to the corresponding APIs and extensions provided by JUnit Jupiter.
+
 As stated above, JUnit Jupiter does not and will not support JUnit 4 rules natively. The
 JUnit team realizes, however, that many organizations, especially large ones, are likely
 to have large JUnit 4 code bases that make use of custom rules. To serve these
@@ -290,6 +293,9 @@ extension model of JUnit Jupiter instead of the rule-based model of JUnit 4.
 [[migrating-from-junit4-ignore-annotation-support]]
 === JUnit 4 @Ignore Support
 
+WARNING: _JUnit 4 `@Ignore` support_ is deprecated for removal since version 6.0.0. Please
+use JUnit Jupiter's `@Disabled` annotation instead.
+
 In order to provide a smooth migration path from JUnit 4 to JUnit Jupiter, the
 `junit-jupiter-migrationsupport` module provides support for JUnit 4's `@Ignore`
 annotation analogous to Jupiter's `{Disabled}` annotation.

documentation/src/test/java/example/IgnoredTestsDemo.java

@@ -16,6 +16,7 @@
 import org.junit.jupiter.migrationsupport.EnableJUnit4MigrationSupport;
 
 // @ExtendWith(IgnoreCondition.class)
+@SuppressWarnings("removal")
 @EnableJUnit4MigrationSupport
 class IgnoredTestsDemo {
 

junit-jupiter-migrationsupport/src/main/java/org/junit/jupiter/migrationsupport/EnableJUnit4MigrationSupport.java

@@ -10,7 +10,7 @@
 
 package org.junit.jupiter.migrationsupport;
 
-import static org.apiguardian.api.API.Status.STABLE;
+import static org.apiguardian.api.API.Status.DEPRECATED;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
@@ -47,10 +47,14 @@
  * @see ExpectedExceptionSupport
  * @see IgnoreCondition
  * @see EnableRuleMigrationSupport
+ * @deprecated Please migrate to Jupiter extensions and use
+ * {@link org.junit.jupiter.api.Disabled @Disabled} instead.
  */
+@SuppressWarnings("removal")
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
-@API(status = STABLE, since = "5.7")
+@API(status = DEPRECATED, since = "6.0")
+@Deprecated(since = "6.0", forRemoval = true)
 @EnableRuleMigrationSupport
 @ExtendWith(IgnoreCondition.class)
 public @interface EnableJUnit4MigrationSupport {

junit-jupiter-migrationsupport/src/main/java/org/junit/jupiter/migrationsupport/conditions/IgnoreCondition.java

@@ -10,7 +10,7 @@
 
 package org.junit.jupiter.migrationsupport.conditions;
 
-import static org.apiguardian.api.API.Status.STABLE;
+import static org.apiguardian.api.API.Status.DEPRECATED;
 import static org.junit.platform.commons.support.AnnotationSupport.findAnnotation;
 
 import java.lang.reflect.AnnotatedElement;
@@ -32,8 +32,10 @@
  * @see org.junit.jupiter.api.Disabled @Disabled
  * @see #evaluateExecutionCondition(ExtensionContext)
  * @see org.junit.jupiter.migrationsupport.EnableJUnit4MigrationSupport
+ * @deprecated Please use {@link org.junit.jupiter.api.Disabled @Disabled} instead.
  */
-@API(status = STABLE, since = "5.7")
+@API(status = DEPRECATED, since = "6.0")
+@Deprecated(since = "6.0", forRemoval = true)
 public class IgnoreCondition implements ExecutionCondition {
 
 	private static final ConditionEvaluationResult ENABLED = //

junit-jupiter-migrationsupport/src/main/java/org/junit/jupiter/migrationsupport/conditions/package-info.java

@@ -1,7 +1,7 @@
 /**
- * Extensions which provide support for conditional test execution features of
- * JUnit 4 (e.g., the {@link org.junit.Ignore @Ignore} annotation) within JUnit
- * Jupiter.
+ * <em>Deprecated</em> extensions that provide support for conditional test
+ * execution features of JUnit 4 (e.g., the {@link org.junit.Ignore @Ignore}
+ * annotation) within JUnit Jupiter.
  */
 
 @NullMarked

junit-jupiter-migrationsupport/src/main/java/org/junit/jupiter/migrationsupport/package-info.java

@@ -1,5 +1,5 @@
 /**
- * Support for migrating from JUnit 4 to JUnit Jupiter.
+ * <em>Deprecated</em> support for migrating from JUnit 4 to JUnit Jupiter.
  */
 
 @NullMarked

junit-jupiter-migrationsupport/src/main/java/org/junit/jupiter/migrationsupport/rules/EnableRuleMigrationSupport.java

@@ -10,7 +10,7 @@
 
 package org.junit.jupiter.migrationsupport.rules;
 
-import static org.apiguardian.api.API.Status.STABLE;
+import static org.apiguardian.api.API.Status.DEPRECATED;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
@@ -36,10 +36,13 @@
  * @see VerifierSupport
  * @see ExpectedExceptionSupport
  * @see org.junit.jupiter.migrationsupport.EnableJUnit4MigrationSupport
+ * @deprecated Please migrate to Jupiter extensions.
  */
+@SuppressWarnings("removal")
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
-@API(status = STABLE, since = "5.7")
+@API(status = DEPRECATED, since = "6.0")
+@Deprecated(since = "6.0", forRemoval = true)
 @ExtendWith(ExternalResourceSupport.class)
 @ExtendWith(VerifierSupport.class)
 @ExtendWith(ExpectedExceptionSupport.class)

junit-jupiter-migrationsupport/src/main/java/org/junit/jupiter/migrationsupport/rules/ExpectedExceptionSupport.java

@@ -12,14 +12,15 @@
 
 import static java.lang.Boolean.FALSE;
 import static java.lang.Boolean.TRUE;
-import static org.apiguardian.api.API.Status.STABLE;
+import static org.apiguardian.api.API.Status.DEPRECATED;
 
 import org.apiguardian.api.API;
 import org.junit.jupiter.api.extension.AfterEachCallback;
 import org.junit.jupiter.api.extension.ExtensionContext;
 import org.junit.jupiter.api.extension.ExtensionContext.Namespace;
 import org.junit.jupiter.api.extension.ExtensionContext.Store;
 import org.junit.jupiter.api.extension.TestExecutionExceptionHandler;
+import org.junit.jupiter.api.function.Executable;
 import org.junit.jupiter.migrationsupport.rules.adapter.ExpectedExceptionAdapter;
 import org.junit.rules.ExpectedException;
 
@@ -38,8 +39,13 @@
  * @see org.junit.rules.ExpectedException
  * @see org.junit.rules.TestRule
  * @see org.junit.Rule
+ * @deprecated Please use
+ * {@link org.junit.jupiter.api.Assertions#assertThrows(Class, Executable)}
+ * instead.
  */
-@API(status = STABLE, since = "5.7")
+@SuppressWarnings("removal")
+@API(status = DEPRECATED, since = "6.0")
+@Deprecated(since = "6.0", forRemoval = true)
 public class ExpectedExceptionSupport implements AfterEachCallback, TestExecutionExceptionHandler {
 
 	private static final String EXCEPTION_WAS_HANDLED = "exceptionWasHandled";