Implement method level test filtering

Author: jakobcodes

src/main/scala/org/scalatestplus/junit/JUnitRunner.scala

@@ -16,12 +16,15 @@
  */
 package org.scalatestplus.junit
 
-import org.scalatest._
+import org.scalatest.{Args, ConfigMap, DynaTags, Stopper, Suite, Tracker, Filter}
 import org.junit.runner.notification.RunNotifier
 import org.junit.runner.notification.Failure
 import org.junit.runner.Description
 import org.junit.runner.manipulation.{Filter => TestFilter, Filterable, NoTestsRemainException}
 
+import scala.collection.JavaConverters._
+import scala.collection.mutable
+
 /*
  I think that Stopper really should be a no-op, like it is, because the user has
  no way to stop it. This is wierd, because it will call nested suites. So the tests
@@ -71,6 +74,8 @@ final class JUnitRunner(suiteClass: java.lang.Class[_ <: Suite]) extends org.jun
    */
   val getDescription = createDescription(suiteToRun)
 
+  private val excludedTests: mutable.Set[String] = mutable.Set()
+
   private def createDescription(suite: Suite): Description = {
     val description = Description.createSuiteDescription(suite.getClass)
     // If we don't add the testNames and nested suites in, we get
@@ -96,12 +101,29 @@ final class JUnitRunner(suiteClass: java.lang.Class[_ <: Suite]) extends org.jun
    */
   def run(notifier: RunNotifier): Unit = {
     try {
+      val includedTests: Set[String] = suiteToRun.testNames.diff(excludedTests)
+      val testTags: Map[String, Map[String, Set[String]]] = Map(
+        suiteToRun.suiteId ->
+          includedTests.map(test => test -> Set("INCLUDE")).toMap
+      )
+      val filter = Filter(
+        tagsToInclude = Some(Set("INCLUDE")),
+        dynaTags = DynaTags(suiteTags = Map.empty, testTags = testTags)
+      )
       // TODO: What should this Tracker be?
-      suiteToRun.run(None, Args(new RunNotifierReporter(notifier),
-                                Stopper.default, Filter(), ConfigMap.empty, None,
-                                new Tracker))
-    }
-    catch {
+      suiteToRun.run(
+        None,
+        Args(
+          new RunNotifierReporter(notifier),
+          Stopper.default,
+          filter,
+          ConfigMap.empty,
+          None,
+          new Tracker,
+          Set.empty
+        )
+      )
+    } catch {
       case e: Exception =>
         notifier.fireTestFailure(new Failure(getDescription, e))
     }
@@ -113,10 +135,16 @@ final class JUnitRunner(suiteClass: java.lang.Class[_ <: Suite]) extends org.jun
    *
    *  @return the expected number of tests that will run when this suite is run
    */
-  override def testCount() = suiteToRun.expectedTestCount(Filter())
+  override def testCount(): Int = suiteToRun.expectedTestCount(Filter())
 
+  @throws(classOf[NoTestsRemainException])
   override def filter(filter: TestFilter): Unit = {
-    if (!filter.shouldRun(getDescription)) throw new NoTestsRemainException
+    getDescription.getChildren.asScala
+      .filter(child => !filter.shouldRun(child))
+      .foreach(child => excludedTests.add(child.getMethodName))
+    if (getDescription.getChildren.isEmpty) {
+      throw new NoTestsRemainException()
+    }
   }
 
 }

src/test/scala/org/scalatestplus/junit/JUnitRunnerSuite.scala

@@ -103,6 +103,30 @@ package org.scalatestplus.junit {
         assert(1 === 1)
       }
     }
+
+    class MethodExclusionFilter(methodNamePattern: String) extends TestFilter {
+      override def shouldRun(description: Description): Boolean = {
+        !description.getMethodName().contains(methodNamePattern)
+      }
+
+      override def describe(): String = s"Excludes tests with method names containing: '$methodNamePattern'"
+    }
+
+    @RunWith(classOf[JUnitRunner])
+    class MethodFilterTargetSuite extends funsuite.AnyFunSuite {
+
+      test("JUnit ran this OK!") {
+        assert(1 === 1)
+      }
+
+      test("should pass filter and execute") {
+        assert(2 === 2)
+      }
+
+      test("should be filtered out") {
+        assert(3 === 5)
+      }
+    }
   }
 
   import org.junit.runner.Description
@@ -112,6 +136,7 @@ package org.scalatestplus.junit {
   import org.scalatestplus.junit.helpers.EasySuite
   import org.scalatestplus.junit.helpers.KerblooeySuite
   import org.scalatestplus.junit.helpers.{FilteredInSuite, FilteredOutSuite, NameFilter}
+  import org.scalatestplus.junit.helpers.{MethodExclusionFilter, MethodFilterTargetSuite}
   import scala.util.Try
 
   class JUnitRunnerSuite extends funsuite.AnyFunSuite {
@@ -190,5 +215,24 @@ package org.scalatestplus.junit {
       assert(runNotifier.ran.head.getDisplayName ===
         "JUnit ran this OK!(org.scalatestplus.junit.helpers.FilteredInSuite)")
     }
+
+    test("Should execute only methods that don't match the filter pattern") {
+      class ExecutedTestsNotifier extends RunNotifier {
+        var executedTests: List[Description] = Nil
+
+        override def fireTestFinished(description: Description): Unit = {
+          executedTests = description :: executedTests
+        }
+      }
+      val runNotifier = new ExecutedTestsNotifier()
+      val runner = new JUnitRunner(classOf[MethodFilterTargetSuite])
+
+      val excludeMethodFilter = new MethodExclusionFilter("should be filtered out")
+
+      runner.filter(excludeMethodFilter)
+      runner.run(runNotifier)
+
+      assert(runNotifier.executedTests.size === 2) // Verifies that only 2 tests ran (one was filtered out)
+    }
   }
 }