Creating a filtered description tree from Specs2 utilities - keeps ordering and hashCodes intact

Author: Igal Tabachnik

src/java/io/bazel/rulesscala/specs2/Specs2RunnerBuilder.scala

@@ -11,6 +11,8 @@ import org.junit.runners.Suite
 import org.junit.runners.model.RunnerBuilder
 import org.specs2.concurrent.ExecutionEnv
 import org.specs2.control.Action
+import org.specs2.data.Trees._
+import org.specs2.fp.TreeLoc
 import org.specs2.main.{Arguments, CommandLine, Select}
 import org.specs2.specification.core.{Env, Fragment, SpecStructure}
 import org.specs2.specification.process.Stats
@@ -60,10 +62,15 @@ class FilteredSpecs2ClassRunner(testClass: Class[_], testFilter: Pattern)
   }
 
   private def createFilteredDescription(specStructure: SpecStructure, ee: ExecutionEnv): Description = {
-    val tree = allFragmentDescriptions(ee)
-    val desc = Description.createSuiteDescription(testClass)
-    tree.values.filter(matchingFilter).foreach(desc.addChild)
-    desc
+    val descTree = createDescriptionTree(ee).map(_._2)
+    descTree.toTree.bottomUp {
+      (description: Description, children: Stream[Description]) =>
+        children.filter(matchingFilter).foreach {
+          child => description.addChild(child)
+        }
+        description
+    }.rootLabel
+
   }
 
   def matchesFilter: Boolean = {
@@ -79,10 +86,12 @@ class FilteredSpecs2ClassRunner(testClass: Class[_], testFilter: Pattern)
     else sanitized
   }
 
+  private def createDescriptionTree(implicit ee: ExecutionEnv): TreeLoc[(Fragment, Description)] =
+    Try(allDescriptions[specs2_v4].createDescriptionTree(specStructure)(ee))
+      .getOrElse(allDescriptions[specs2_v3].createDescriptionTree(specStructure))
+
   private def allFragmentDescriptions(implicit ee: ExecutionEnv): Map[Fragment, Description] =
-    Try(allDescriptions[specs2_v4].fragmentDescriptions(specStructure)(ee))
-      .orElse(Try(allDescriptions[specs2_v3].fragmentDescriptions(specStructure)))
-      .getOrElse(Map.empty)
+    createDescriptionTree(ee).toTree.flattenLeft.toMap
 
   /**
     * Retrieves an original (un-sanitized) text of an example fragment,
@@ -129,8 +138,11 @@ class FilteredSpecs2ClassRunner(testClass: Class[_], testFilter: Pattern)
   }
 
   private def matchingFilter(desc: Description): Boolean = {
-    val testCase = desc.getClassName + "#" + desc.getMethodName
-    testFilter.toString.r.findAllIn(testCase).nonEmpty
+    if (desc.isSuite) true
+    else {
+      val testCase = desc.getClassName + "#" + Option(desc.getMethodName).mkString
+      testFilter.toString.r.findFirstIn(testCase).nonEmpty
+    }
   }
 
   private def specs2Examples(implicit ee: ExecutionEnv): List[String] =

src/java/io/bazel/rulesscala/specs2/package.scala

@@ -2,17 +2,18 @@ package io.bazel.rulesscala
 
 import org.junit.runner.Description
 import org.specs2.concurrent.ExecutionEnv
+import org.specs2.fp.TreeLoc
 import org.specs2.reporter.JUnitDescriptions
 import org.specs2.specification.core.{Fragment, SpecStructure}
 
 package object specs2 {
   type specs2_v4 = {
     //noinspection ScalaUnusedSymbol
-    def fragmentDescriptions(spec: SpecStructure)(ee: ExecutionEnv): Map[Fragment, Description]
+    def createDescriptionTree(spec: SpecStructure)(ee: ExecutionEnv): TreeLoc[(Fragment, Description)]
   }
   type specs2_v3 = {
     //noinspection ScalaUnusedSymbol
-    def fragmentDescriptions(spec: SpecStructure): Map[Fragment, Description]
+    def createDescriptionTree(spec: SpecStructure): TreeLoc[(Fragment, Description)]
   }
 
   def allDescriptions[T]: T = JUnitDescriptions.asInstanceOf[T]

test/src/main/scala/scalarules/test/junit/specs2/Specs2Tests.scala

@@ -17,14 +17,6 @@ class JunitSpecs2Test extends SpecWithJUnit {
   }
 }
 
-class FailingSpecs2Test extends SpecWithJUnit {
-
-  "specs2 tests" should {
-    "succeed" >> success
-    "fail" >> failure
-  }
-}
-
 class JunitSpecs2AnotherTest extends SpecWithJUnit {
 
   "other specs2 tests" should {

test_expect_failure/scala_junit_test/BUILD

@@ -23,6 +23,6 @@ scala_junit_test(
 scala_specs2_junit_test(
     name = "specs2_failing_test",
     size = "small",
-    srcs = ["specs2/FailingTest.scala"],
+    srcs = ["specs2/FailingTest.scala", "specs2/SuiteWithOneFailingTest.scala"],
     suffixes = ["Test"],
 )

test_expect_failure/scala_junit_test/specs2/SuiteWithOneFailingTest.scala

@@ -0,0 +1,15 @@
+package scalarules.test.junit.specs2
+
+import org.specs2.mutable.SpecWithJUnit
+
+class SuiteWithOneFailingTest extends SpecWithJUnit {
+
+  "specs2 tests" should {
+    "succeed" >> success
+    "fail" >> failure("boom")
+  }
+
+  "some other suite" should {
+    "do stuff" >> success
+  }
+}

test_rules_scala.sh

@@ -548,13 +548,13 @@ scala_specs2_only_failed_test_shows_in_the_xml(){
   bazel test \
     --nocache_test_results \
     --test_output=streamed \
-    '--test_filter=scalarules.test.junit.specs2.FailingSpecs2Test#specs2 tests should::fail$' \
-    test:Specs2Tests
-  matches=$(grep -c -e "testcase name='specs2 tests should::fail'" -e "testcase name='specs2 tests should::succeed'" ./bazel-testlogs/test/Specs2Tests/test.xml)
+    '--test_filter=scalarules.test.junit.specs2.SuiteWithOneFailingTest#specs2 tests should::fail$' \
+    test_expect_failure/scala_junit_test:specs2_failing_test
+  matches=$(grep -c -e "testcase name='specs2 tests should::fail'" -e "testcase name='specs2 tests should::succeed'" ./bazel-testlogs/test_expect_failure/scala_junit_test/specs2_failing_test/test.xml)
   if [ $matches -eq 1 ]; then
     return 0
   else
-    echo "Expecting only one result, found more than one. Please check 'bazel-testlogs/test/Specs2Tests/test.xml'"
+    echo "Expecting only one result, found more than one. Please check './bazel-testlogs/test_expect_failure/scala_junit_test/specs2_failing_test/test.xml'"
     return 1
   fi
   test -e