bugfix: Fixed test suite discovery with the presence of companion obj…

…ect. (#5030) * Fixed test suite discovery with the presence of companion object.
scalameta · Mar 8, 2023 · 784494b · 784494b
1 parent 34b3cc8
commit 784494b
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 0 deletions.
diff --git a/metals/src/main/scala/scala/meta/internal/metals/testProvider/TestSuitesProvider.scala b/metals/src/main/scala/scala/meta/internal/metals/testProvider/TestSuitesProvider.scala
@@ -419,6 +419,11 @@ final class TestSuitesProvider(
       currentTarget.testSymbols
         .readOnlySnapshot()
         .toList
+        // sort the symbols lexically so that symbols with the same fullyQualifiedName
+        // will be grouped, and the class will come before companion object (i.e.
+        // `a.b.WordSpec#` < `a.b.WordSpec.`). This ensures that the class is put into the cache
+        // instead of the companion object.
+        .sortBy { case (symbol, _) => symbol }
         .foldLeft(List.empty[TestEntry]) {
           case (entries, (symbol, testSymbolInfo)) =>
             val fullyQualifiedName =

diff --git a/tests/unit/src/test/scala/tests/testProvider/TestSuitesProviderSuite.scala b/tests/unit/src/test/scala/tests/testProvider/TestSuitesProviderSuite.scala
@@ -645,6 +645,67 @@ class TestSuitesProviderSuite extends BaseLspSuite("testSuitesFinderSuite") {
     },
   )
 
+  checkEvents(
+    "scalatest-any-word-spec-with-companion-object",
+    List("org.scalatest::scalatest:3.2.13"),
+    s"""|
+        |/app/src/main/scala/a/b/WordSpec.scala
+        |package a.b
+        |import org.scalatest.wordspec.AnyWordSpec
+        |
+        |class WordSpec extends AnyWordSpec {
+        |  import WordSpec._
+        |  "A Set" when {
+        |    "empty" should {
+        |      "have size 0" in {
+        |        assert(foo == "bar")
+        |        assert(Set.empty.size == 0)
+        |      }
+        |    }
+        |  }
+        |}
+        |
+        |object WordSpec {
+           def foo: String = "bar"
+        |}
+        |""".stripMargin,
+    file = "app/src/main/scala/a/b/WordSpec.scala",
+    expected = () => {
+      val fcqn = "a.b.WordSpec"
+      val className = "WordSpec"
+      val symbol = "a/b/WordSpec#"
+      val file = "app/src/main/scala/a/b/WordSpec.scala"
+      List(
+        BuildTargetUpdate(
+          "app",
+          targetUri,
+          List[TestExplorerEvent](
+            AddTestSuite(
+              fcqn,
+              className,
+              symbol,
+              QuickLocation(
+                classUriFor(file),
+                (3, 6, 3, 14),
+              ).toLsp,
+              canResolveChildren = true,
+            ),
+            AddTestCases(
+              fcqn,
+              className,
+              List(
+                TestCaseEntry(
+                  "A Set when empty should have size 0",
+                  QuickLocation(classUriFor(file), (7, 6, 7, 19)).toLsp,
+                )
+              ).asJava,
+            ),
+          ).asJava,
+        )
+      )
+    },
+  )
+
   checkEvents(
     "scalatest-any-flat-spec",
     List("org.scalatest::scalatest:3.2.13"),