Deprecate support for running JUnit tests

Closes testng-team#2847
krmahadevan · Dec 4, 2022 · 31a6810 · 31a6810
1 parent 8630a7e
commit 31a6810
Show file tree

Hide file tree

Showing 17 changed files with 82 additions and 11 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -1,5 +1,6 @@
 Current
 Fixed: GITHUB-2792: JUnitTestClass sets XmlTest as null when running JUnit 4 Tests using TestNG (Krishnan Mahadevan)
+Fixed: GITHUB-2847: Deprecate support for running JUnit tests (Krishnan Mahadevan)
 Fixed: GITHUB-2844: Deprecate support for running Spock Tests (Krishnan Mahadevan)
 Fixed: GITHUB-550: Weird @BeforeMethod and @AfterMethod behaviour with dependsOnMethods (Krishnan Mahadevan)
 Fixed: GITHUB-893: TestNG should provide an Api which allow to find all dependent of a specific test (Krishnan Mahadevan)

diff --git a/testng-core/src/main/java/org/testng/TestRunner.java b/testng-core/src/main/java/org/testng/TestRunner.java
@@ -15,6 +15,7 @@
 import java.util.concurrent.LinkedBlockingQueue;
 import java.util.concurrent.PriorityBlockingQueue;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
@@ -646,7 +647,18 @@ private void invokeTestConfigurations(ITestNGMethod[] testConfigurationMethods)
 
   private ITestNGMethod[] m_allJunitTestMethods = new ITestNGMethod[] {};
 
+  private static final AtomicBoolean warnOnce = new AtomicBoolean(false);
+
   private void privateRunJUnit() {
+    if (warnOnce.compareAndSet(false, true)) {
+      String msg =
+          "Support to run JUnit tests using TestNG stands deprecated "
+              + "and will be removed in future versions. You can now use the JUnit5 TestNG "
+              + "engine to run both JUnit and TestNG tests. For more information refer to "
+              + "https://github.com/junit-team/testng-engine .";
+      Logger.getLogger(TestRunner.class).warn(msg);
+    }
+
     final ClassInfoMap cim = new ClassInfoMap(m_testClassesFromXml, false);
     final Set<Class<?>> classes = cim.getClasses();
     final List<ITestNGMethod> runMethods = Lists.newArrayList();
@@ -656,7 +668,7 @@ private void privateRunJUnit() {
     // The resolution process is not specified in the JVM spec with a specific implementation,
     // so it can be eager => failure
     workers.add(
-        new IWorker<ITestNGMethod>() {
+        new IWorker<>() {
           /** @see TestMethodWorker#getTimeOut() */
           @Override
           public long getTimeOut() {

diff --git a/testng-core/src/main/java/org/testng/junit/IJUnitTestRunner.java b/testng-core/src/main/java/org/testng/junit/IJUnitTestRunner.java
@@ -9,7 +9,12 @@
 import org.testng.internal.ITestResultNotifier;
 import org.testng.internal.Utils;
 
-/** An abstraction interface over JUnit test runners. */
+/**
+ * An abstraction interface over JUnit test runners.
+ *
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
+ */
+@Deprecated
 public interface IJUnitTestRunner {
 
   void setInvokedMethodListeners(Collection<IInvokedMethodListener> listener);

diff --git a/testng-core/src/main/java/org/testng/junit/JUnit3TestClass.java b/testng-core/src/main/java/org/testng/junit/JUnit3TestClass.java
@@ -2,7 +2,10 @@
 
 import junit.framework.Test;
 
-/** @author lukas */
+/**
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
+ */
+@Deprecated
 public class JUnit3TestClass extends JUnitTestClass {
 
   public JUnit3TestClass(Test test) {

diff --git a/testng-core/src/main/java/org/testng/junit/JUnit3TestMethod.java b/testng-core/src/main/java/org/testng/junit/JUnit3TestMethod.java
@@ -6,6 +6,10 @@
 import org.testng.internal.ConstructorOrMethod;
 import org.testng.internal.Utils;
 
+/**
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
+ */
+@Deprecated
 public class JUnit3TestMethod extends JUnitTestMethod {
 
   public JUnit3TestMethod(ITestObjectFactory objectFactory, JUnitTestClass owner, Test test) {

diff --git a/testng-core/src/main/java/org/testng/junit/JUnit3TestRecognizer.java b/testng-core/src/main/java/org/testng/junit/JUnit3TestRecognizer.java
@@ -4,7 +4,10 @@
 import java.lang.reflect.Modifier;
 import junit.framework.Test;
 
-/** @author lukas */
+/**
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
+ */
+@Deprecated
 public class JUnit3TestRecognizer implements JUnitTestRecognizer {
 
   public JUnit3TestRecognizer() {}

diff --git a/testng-core/src/main/java/org/testng/junit/JUnit4ConfigurationMethod.java b/testng-core/src/main/java/org/testng/junit/JUnit4ConfigurationMethod.java
@@ -3,6 +3,10 @@
 import java.lang.reflect.Method;
 import org.testng.internal.ConstructorOrMethod;
 
+/**
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
+ */
+@Deprecated
 public class JUnit4ConfigurationMethod extends ConstructorOrMethod {
 
   private final Class<?> declaringClass;

diff --git a/testng-core/src/main/java/org/testng/junit/JUnit4TestClass.java b/testng-core/src/main/java/org/testng/junit/JUnit4TestClass.java
@@ -2,7 +2,10 @@
 
 import org.junit.runner.Description;
 
-/** @author lukas */
+/**
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
+ */
+@Deprecated
 public class JUnit4TestClass extends JUnitTestClass {
 
   public JUnit4TestClass(Description test) {

diff --git a/testng-core/src/main/java/org/testng/junit/JUnit4TestMethod.java b/testng-core/src/main/java/org/testng/junit/JUnit4TestMethod.java
@@ -7,6 +7,10 @@
 import org.testng.internal.Utils;
 import org.testng.log4testng.Logger;
 
+/**
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
+ */
+@Deprecated
 public class JUnit4TestMethod extends JUnitTestMethod {
 
   private static final AtomicBoolean warnOnce = new AtomicBoolean(false);

diff --git a/testng-core/src/main/java/org/testng/junit/JUnit4TestRecognizer.java b/testng-core/src/main/java/org/testng/junit/JUnit4TestRecognizer.java
@@ -4,7 +4,10 @@
 import java.lang.reflect.Method;
 import org.junit.runner.RunWith;
 
-/** @author lukas */
+/**
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
+ */
+@Deprecated
 public final class JUnit4TestRecognizer implements JUnitTestRecognizer {
 
   public JUnit4TestRecognizer() {}

diff --git a/testng-core/src/main/java/org/testng/junit/JUnit4TestRunner.java b/testng-core/src/main/java/org/testng/junit/JUnit4TestRunner.java
@@ -16,7 +16,12 @@
 import org.testng.internal.invokers.IInvocationStatus;
 import org.testng.internal.invokers.InvokedMethod;
 
-/** A JUnit TestRunner that records/triggers all information/events necessary to TestNG. */
+/**
+ * A JUnit TestRunner that records/triggers all information/events necessary to TestNG.
+ *
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
+ */
+@Deprecated
 public class JUnit4TestRunner implements IJUnitTestRunner {
 
   private final ITestObjectFactory objectFactory;

diff --git a/testng-core/src/main/java/org/testng/junit/JUnitMethodFinder.java b/testng-core/src/main/java/org/testng/junit/JUnitMethodFinder.java
@@ -18,8 +18,9 @@
  * This class locates all test and configuration methods according to JUnit. It is used to change
  * the strategy used by TestRunner to locate its test methods.
  *
- * @since May 3, 2004
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
  */
+@Deprecated
 public class JUnitMethodFinder implements ITestMethodFinder {
 
   private final ITestObjectFactory objectFactory;
@@ -119,7 +120,10 @@ public ITestNGMethod[] getAfterGroupsConfigurationMethods(Class<?> testClass) {
     return new ITestNGMethod[0];
   }
 }
-
+/**
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
+ */
+@Deprecated
 interface INameFilter {
   boolean accept(ConstructorOrMethod method);
 }
diff --git a/testng-core/src/main/java/org/testng/junit/JUnitTestClass.java b/testng-core/src/main/java/org/testng/junit/JUnitTestClass.java
@@ -8,6 +8,10 @@
 import org.testng.xml.XmlTest;
 
 // NO JUnit specific code here to avoid runtime errors
+/**
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
+ */
+@Deprecated
 public abstract class JUnitTestClass implements ITestClass {
 
   private List<ITestNGMethod> m_testMethods = Lists.newArrayList();

diff --git a/testng-core/src/main/java/org/testng/junit/JUnitTestFinder.java b/testng-core/src/main/java/org/testng/junit/JUnitTestFinder.java
@@ -4,6 +4,10 @@
 import org.testng.internal.Utils;
 import org.testng.internal.objects.InstanceCreator;
 
+/**
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
+ */
+@Deprecated
 public final class JUnitTestFinder {
 
   private static final String JUNIT3_TEST = "junit.framework.Test";

diff --git a/testng-core/src/main/java/org/testng/junit/JUnitTestMethod.java b/testng-core/src/main/java/org/testng/junit/JUnitTestMethod.java
@@ -6,6 +6,10 @@
 import org.testng.internal.ConstructorOrMethod;
 
 // NO JUnit specific code here to avoid runtime errors
+/**
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
+ */
+@Deprecated
 public abstract class JUnitTestMethod extends BaseTestMethod {
 
   protected JUnitTestMethod(

diff --git a/testng-core/src/main/java/org/testng/junit/JUnitTestRecognizer.java b/testng-core/src/main/java/org/testng/junit/JUnitTestRecognizer.java
@@ -1,6 +1,9 @@
 package org.testng.junit;
 
-/** @author lukas */
+/**
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
+ */
+@Deprecated
 interface JUnitTestRecognizer {
 
   boolean isTest(Class c);

diff --git a/testng-core/src/main/java/org/testng/junit/JUnitTestRunner.java b/testng-core/src/main/java/org/testng/junit/JUnitTestRunner.java
@@ -20,7 +20,12 @@
 import org.testng.internal.TestListenerHelper;
 import org.testng.internal.invokers.InvokedMethod;
 
-/** A JUnit TestRunner that records/triggers all information/events necessary to TestNG. */
+/**
+ * A JUnit TestRunner that records/triggers all information/events necessary to TestNG.
+ *
+ * @deprecated - Support for running JUnit tests stands deprecated as of TestNG <code>7.6.2</code>
+ */
+@Deprecated
 public class JUnitTestRunner implements TestListener, IJUnitTestRunner {
   public static final String SUITE_METHODNAME = "suite";