Add workspace symbol tests

Author: nicolasstucki

language-server/test/dotty/tools/languageserver/DocumentSymbolTest.scala

@@ -7,17 +7,17 @@ import dotty.tools.languageserver.util.Code._
 class DocumentSymbolTest {
 
   @Test def documentSymbol0: Unit =
-    code"class ${m1}Foo$m2".withSource.documentSymbol(m1, ("Foo", "Class", m1 to m2))
+    code"class ${m1}Foo$m2".withSource.documentSymbol(m1, (m1 to m2).symInfo("Foo", "Class"))
 
   @Test def documentSymbol1: Unit =
     code"class ${m1}Foo$m2; class ${m3}Bar$m4".withSource
-      .documentSymbol(m1, ("Foo", "Class", m1 to m2), ("Bar", "Class", m3 to m4))
+      .documentSymbol(m1, (m1 to m2).symInfo("Foo", "Class"), (m3 to m4).symInfo("Bar", "Class"))
 
   @Test def documentSymbol3: Unit = {
     withSources(
       code"class ${m1}Foo$m2",
       code"class ${m3}Bar$m4"
-    ) .documentSymbol(m1, ("Foo", "Class", m1 to m2))
-      .documentSymbol(m3, ("Bar", "Class", m3 to m4))
+    ) .documentSymbol(m1, (m1 to m2).symInfo("Foo", "Class"))
+      .documentSymbol(m3, (m3 to m4).symInfo("Bar", "Class"))
   }
 }

language-server/test/dotty/tools/languageserver/Main.scala

@@ -58,5 +58,6 @@ object Main {
     classOf[ReferencesTest],
     classOf[RenameTest],
     classOf[DocumentSymbolTest],
+    classOf[SymbolTest],
   )
 }

language-server/test/dotty/tools/languageserver/SymbolTest.scala

@@ -0,0 +1,27 @@
+package dotty.tools.languageserver
+
+import org.junit.Test
+
+import dotty.tools.languageserver.util.Code._
+
+class SymbolTest {
+
+//  @Test def symbol0: Unit =
+//    code"class ${m1}Foo$m2".withSource.symbol("Foo", ("Foo", "Class", m1 to m2))
+
+  @Test def symbol1: Unit = {
+    val Foo = (m1 to m2).withCode("Foo")
+    val Bar = (m3 to m4).withCode("Bar")
+    val fooFoo = (m5 to m6).withCode("Foo")
+    withSources(
+      code"class $Foo",
+      code"class $Bar",
+      code"""package foo
+            |class $fooFoo {
+            |  class Bar
+            |}
+          """
+    ) .symbol("Foo", Foo.range.symInfo("Foo", "Class"), fooFoo.range.symInfo("Foo", "Class", "foo"))
+      .symbol("Bar", Bar.range.symInfo("Bar", "Class"))
+  }
+}

language-server/test/dotty/tools/languageserver/util/CodeRange.scala

@@ -30,14 +30,17 @@ case class CodeRange(start: CodeMarker, end: CodeMarker) {
 
   def withCode(text: String): CodeInRange = CodeInRange(text, this)
 
-  def toLSPRange: PosCtx[Range] = {
+  def symInfo(name: String, kind: String, container: String = null): SymInfo =
+    new SymInfo(name, kind, this, container)
+
+  def toRange: PosCtx[Range] = {
     check()
     new Range(start.toPosition, end.toPosition)
   }
 
-  def toLSPLocation: PosCtx[Location] = {
+  def toLocation: PosCtx[Location] = {
     check()
-    new Location(file.uri, toLSPRange)
+    new Location(file.uri, toRange)
   }
 
   def show: PosCtx[String] =

language-server/test/dotty/tools/languageserver/util/CodeTester.scala

@@ -4,6 +4,7 @@ import dotty.tools.languageserver.util.Code.SourceWithPositions
 import dotty.tools.languageserver.util.actions._
 import dotty.tools.languageserver.util.embedded.CodeMarker
 import dotty.tools.languageserver.util.server.{TestFile, TestServer}
+import org.eclipse.lsp4j.SymbolInformation
 
 class CodeTester(sources: List[SourceWithPositions], actions: List[Action]) {
 
@@ -32,9 +33,12 @@ class CodeTester(sources: List[SourceWithPositions], actions: List[Action]) {
   def rename(marker: CodeMarker, newName: String, expected: List[CodeRange]): CodeTester =
     doAction(new CodeRename(marker, newName, expected)) // TODO apply changes to the sources and positions
 
-  def documentSymbol(marker: CodeMarker, symbols: (String, String, CodeRange)*): CodeTester =
+  def documentSymbol(marker: CodeMarker, symbols: SymInfo*): CodeTester =
     doAction(new CodeDocumentSymbol(marker, symbols))
 
+  def symbol(query: String, symbols: SymInfo*): CodeTester =
+    doAction(new CodeSymbol(query, symbols))
+
   private def doAction(action: Action): this.type = {
     try {
       action.execute()(testServer, positions)

language-server/test/dotty/tools/languageserver/util/SymInfo.scala

@@ -0,0 +1,14 @@
+package dotty.tools.languageserver.util
+
+import dotty.tools.languageserver.util.PositionContext._
+import org.eclipse.lsp4j._
+
+class SymInfo(name: String, kind: String, range: CodeRange, container: String) {
+  def toSymInformation: PosCtx[SymbolInformation] =
+    new SymbolInformation(name, SymbolKind.valueOf(kind), range.toLocation, container)
+
+  def show: PosCtx[String] =
+    s"SymInfo($name, $kind, ${range.show}, $container)"
+  override def toString: String =
+    s"SymInfo($name, $kind, $range, $container)"
+}

language-server/test/dotty/tools/languageserver/util/actions/CodeDefinition.scala

@@ -8,7 +8,7 @@ class CodeDefinition(val range: CodeRange, refOpt: Option[CodeRange]) extends Ac
   override def onMarker(marker: CodeMarker): Exec[Unit] = {
     val res = server.definition(marker.toTextDocumentPositionParams).get()
     assert(res.size() == refOpt.size, res)
-    refOpt.foreach(ref => assert(res.get(0) == ref.toLSPLocation, res))
+    refOpt.foreach(ref => assert(res.get(0) == ref.toLocation, res))
   }
 
   override def show: PositionContext.PosCtx[String] =

language-server/test/dotty/tools/languageserver/util/actions/CodeDocumentHighlight.scala

@@ -15,7 +15,7 @@ class CodeDocumentHighlight(val range: CodeRange, highs: Seq[(CodeRange, String)
     assert(refs.size == kinds.length, res)
     res.asScala.zip(refs).zip(kinds).foreach { case ((dhl, ref), kind) =>
       assert(dhl.getKind == DocumentHighlightKind.valueOf(kind), res)
-      assert(dhl.getRange == ref.toLSPRange, res)
+      assert(dhl.getRange == ref.toRange, res)
     }
   }
 

language-server/test/dotty/tools/languageserver/util/actions/CodeDocumentSymbol.scala

@@ -1,22 +1,20 @@
 package dotty.tools.languageserver.util.actions
 
 import dotty.tools.languageserver.util.embedded.CodeMarker
-import dotty.tools.languageserver.util.{CodeRange, PositionContext}
+import dotty.tools.languageserver.util.{PositionContext, SymInfo}
 
 import scala.collection.JavaConverters._
 
-class CodeDocumentSymbol(val marker: CodeMarker, symbols: Seq[(String, String, CodeRange)]) extends ActionOnMarker {
+class CodeDocumentSymbol(val marker: CodeMarker, symbols: Seq[SymInfo]) extends ActionOnMarker {
 
   override def execute(): Exec[Unit] = {
     val res = server.documentSymbol(marker.toDocumentSymbolParams).get()
     assert(res.size() == symbols.size, res)
-    for ((symInfo, (name, kind, range)) <- res.asScala.zip(symbols)) {
-      assert(symInfo.getName == name, res)
-      assert(symInfo.getKind.toString == kind, res)
-      assert(symInfo.getLocation == range.toLSPLocation, res)
+    for ((symInfo, expected) <- res.asScala.zip(symbols)) {
+      assert(symInfo == expected.toSymInformation, res)
     }
   }
 
   override def show: PositionContext.PosCtx[String] =
-    s"CodeDocumentSymbol(${marker.show}, ${symbols.map(x => (x._1, x._2, x._3.show))})"
+    s"CodeDocumentSymbol(${marker.show}, ${symbols.map(_.show)})"
 }

language-server/test/dotty/tools/languageserver/util/actions/CodeReferences.scala

@@ -10,7 +10,7 @@ class CodeReferences(val range: CodeRange, refs: List[CodeRange], withDecl: Bool
   override def onMarker(marker: CodeMarker): Exec[Unit] = {
     val res = server.references(marker.toReferenceParams(withDecl)).get()
     assert(res.size() == refs.size)
-    res.asScala.zip(refs).foreach { case (loc, ref) => assert(loc == ref.toLSPLocation, res) }
+    res.asScala.zip(refs).foreach { case (loc, ref) => assert(loc == ref.toLocation, res) }
   }
 
   override def show: PositionContext.PosCtx[String] =

language-server/test/dotty/tools/languageserver/util/actions/CodeRename.scala

@@ -14,7 +14,7 @@ class CodeRename(val marker: CodeMarker, newName: String, expected: List[CodeRan
     assert(expected.forall { exp =>
       editItems.exists { editItem =>
         editItem.getNewText == newName &&
-        editItem.getRange == exp.toLSPRange
+        editItem.getRange == exp.toRange
       }
     }, res)
   }

language-server/test/dotty/tools/languageserver/util/actions/CodeSymbol.scala

@@ -0,0 +1,20 @@
+package dotty.tools.languageserver.util.actions
+
+import dotty.tools.languageserver.util.{CodeRange, PositionContext, SymInfo}
+import org.eclipse.lsp4j._
+
+import scala.collection.JavaConverters._
+
+class CodeSymbol(query: String, symbols: Seq[SymInfo]) extends Action {
+
+  override def execute(): Exec[Unit] = {
+    val res = server.symbol(new WorkspaceSymbolParams(query)).get()
+    assert(res.size() == symbols.size, res)
+    for ((symInfo, expected) <- res.asScala.zip(symbols)) {
+      assert(symInfo == expected.toSymInformation, res)
+    }
+  }
+
+  override def show: PositionContext.PosCtx[String] =
+    s"CodeDocumentSymbol($query, ${symbols.map(_.show)})"
+}