add remaining tests

Author: lrytz

test/junit/scala/tools/xsbt/BridgeTesting.scala

@@ -1,11 +1,13 @@
 package scala.tools.xsbt
 
+import xsbti.api.ClassLike
 import xsbti.api.DependencyContext._
 import xsbti.compile.{CompileProgress, DependencyChanges}
-import xsbti.{BasicVirtualFileRef, Logger, Position, Problem, Severity, VirtualFile, VirtualFileRef, Reporter => XReporter}
+import xsbti.{BasicVirtualFileRef, InteractiveConsoleInterface, Logger, Position, Problem, Severity, VirtualFile, VirtualFileRef, Reporter => XReporter}
 
 import java.io.{ByteArrayInputStream, File, InputStream}
 import java.nio.file.{Files, Path}
+import java.util.Optional
 import java.util.function.Supplier
 import scala.collection.mutable.ListBuffer
 import scala.tools.nsc.io.AbstractFile
@@ -24,6 +26,8 @@ class BridgeTesting {
 
   def mkCompiler: CompilerBridge = new CompilerBridge()
 
+  def mkConsole: InteractiveConsoleBridgeFactory = new InteractiveConsoleBridgeFactory()
+
   def mkScaladoc: ScaladocBridge = new ScaladocBridge()
 
   private val emptyChanges: DependencyChanges = new DependencyChanges {
@@ -104,6 +108,67 @@ class BridgeTesting {
       },
     )
   }
+
+  /**
+   * Compiles given source code using Scala compiler and returns API representation
+   * extracted by ExtractAPI class.
+   */
+  def extractApisFromSrc(src: String): Set[ClassLike] = withTemporaryDirectory { tmpDir =>
+    val (Seq(tempSrcFile), analysisCallback) = compileSrcs(tmpDir, src)
+    analysisCallback.apis(tempSrcFile)
+  }
+
+  /**
+   * Compiles given source code using Scala compiler and returns API representation
+   * extracted by ExtractAPI class.
+   */
+  def extractApisFromSrcs(srcs: List[String]*): Seq[Set[ClassLike]] = withTemporaryDirectory { tmpDir =>
+    val (tempSrcFiles, analysisCallback) = compileSrcss(tmpDir, mkReporter, srcs.toList)
+    tempSrcFiles.map(analysisCallback.apis)
+  }
+
+  def extractUsedNamesFromSrc(src: String): Map[String, Set[String]] = withTemporaryDirectory { tmpDir =>
+    val (_, analysisCallback) = compileSrcs(tmpDir, src)
+    analysisCallback.usedNames.toMap
+  }
+
+  /**
+   * Extract used names from the last source file in `sources`.
+   *
+   * The previous source files are provided to successfully compile examples.
+   * Only the names used in the last src file are returned.
+   */
+  def extractUsedNamesFromSrc(sources: String*): Map[String, Set[String]] = withTemporaryDirectory { tmpDir =>
+    val (srcFiles, analysisCallback) = compileSrcs(tmpDir, sources: _*)
+    srcFiles
+      .map { srcFile =>
+        val classesInSrc = analysisCallback.classNames(srcFile).map(_._1)
+        classesInSrc.map(className => className -> analysisCallback.usedNames(className)).toMap
+      }
+      .reduce(_ ++ _)
+  }
+
+  def interactiveConsole(baseDir: Path)(args: String*): InteractiveConsoleInterface = {
+    val targetDir = baseDir / "target"
+    Files.createDirectory(targetDir)
+    val sc = mkConsole
+    sc.createConsole(
+      args = Array("-usejavacp") ++ args,
+      bootClasspathString = "",
+      classpathString = "",
+      initialCommands = "",
+      cleanupCommands = "",
+      loader = Optional.empty,
+      bindNames = Array(),
+      bindValues = Array(),
+      log = TestLogger)
+  }
+
+  def withInteractiveConsole[A](f: InteractiveConsoleInterface => A): A = withTemporaryDirectory { tmpDir =>
+    val repl = interactiveConsole(tmpDir)()
+    try f(repl)
+    finally repl.close()
+  }
 }
 
 class TestingReporter extends XReporter {

test/junit/scala/tools/xsbt/ExtractAPITest.scala

@@ -0,0 +1,204 @@
+package scala.tools.xsbt
+
+import org.junit.Test
+import org.junit.Assert._
+import xsbti.api._
+
+class ExtractAPITest extends BridgeTesting {
+
+  @Test
+  def `ExtractAPI should extract children of a sealed class`(): Unit = {
+    def compileAndGetFooClassApi(src: String): ClassLike = {
+      val apis = extractApisFromSrc(src)
+      val FooApi = apis.find(_.name() == "Foo").get
+      FooApi
+    }
+
+    val src1 =
+      """|sealed abstract class Foo
+         |case class C1(x: Int) extends Foo
+         |""".stripMargin
+    val fooClassApi1 = compileAndGetFooClassApi(src1)
+    val src2 =
+      """|sealed abstract class Foo
+         |case class C1(x: Int) extends Foo
+         |case class C2(x: Int) extends Foo
+         |""".stripMargin
+    val fooClassApi2 = compileAndGetFooClassApi(src2)
+    assertFalse(SameAPI(fooClassApi1, fooClassApi2))
+  }
+
+  @Test
+  def `ExtractAPI should extract correctly the definition type of a package object`(): Unit = {
+    val src = "package object foo".stripMargin
+    val apis = extractApisFromSrc(src)
+    val Seq(fooClassApi) = apis.toSeq
+    assertEquals(fooClassApi.definitionType, DefinitionType.PackageModule)
+  }
+
+  @Test
+  def `ExtractAPI should extract nested classes`(): Unit = {
+    val src =
+      """class A {
+        |  class B
+        |}""".stripMargin
+    val apis = extractApisFromSrc(src).map(c => c.name -> c).toMap
+    assertEquals(apis.keys, Set("A", "A.B"))
+  }
+
+  @Test
+  def `ExtractAPI should not extract local classes`(): Unit = {
+    val src =
+      """class A
+        |class B
+        |class C { def foo: Unit = { class Inner2 extends B } }
+        |class D { def foo: Unit = { new B {} } }""".stripMargin
+    val apis = extractApisFromSrc(src).map(c => c.name -> c).toMap
+    assertEquals(apis.keys, Set("A", "B", "C", "D"))
+  }
+
+  @Test
+  def `ExtractAPI should extract flat (without members) api for a nested class`(): Unit = {
+    def compileAndGetFooClassApi(src: String): ClassLike = {
+      val apis = extractApisFromSrc(src)
+      val FooApi = apis.find(_.name() == "Foo").get
+      FooApi
+    }
+
+    val src1 =
+      """class Foo {
+        |  class A
+        |}""".stripMargin
+    val fooClassApi1 = compileAndGetFooClassApi(src1)
+    val src2 =
+      """class Foo {
+        |  class A {
+        |    def foo: Int = 123
+        |  }
+        |}""".stripMargin
+    val fooClassApi2 = compileAndGetFooClassApi(src2)
+    assertTrue(SameAPI(fooClassApi1, fooClassApi2))
+  }
+
+  @Test
+  def `ExtractAPI should extract private classes`(): Unit = {
+    val src =
+      """private class A
+        |class B { private class Inner1 extends A }
+        |""".stripMargin
+    val apis = extractApisFromSrc(src).map(c => c.name -> c).toMap
+    assertEquals(apis.keys, Set("A", "B", "B.Inner1"))
+  }
+
+  @Test
+  def `ExtractAPI should give stable names to members of existential types in method signatures`(): Unit = {
+    def compileAndGetFooMethodApi(src: String): Def = {
+      val sourceApi = extractApisFromSrc(src)
+      val FooApi = sourceApi.find(_.name() == "Foo").get
+      val fooMethodApi = FooApi.structure().declared().find(_.name == "foo").get
+      fooMethodApi.asInstanceOf[Def]
+    }
+
+    val src1 =
+      """class Box[T]
+        |class Foo {
+        |	 def foo: Box[_] = null
+        |}""".stripMargin
+    val fooMethodApi1 = compileAndGetFooMethodApi(src1)
+    val src2 =
+      """class Box[T]
+        |class Foo {
+        |  def bar: Box[_] = null
+        |	 def foo: Box[_] = null
+        |}""".stripMargin
+    val fooMethodApi2 = compileAndGetFooMethodApi(src2)
+    assertTrue("APIs are not the same.", SameAPI.apply(fooMethodApi1, fooMethodApi2))
+  }
+
+  /**
+   * Checks if representation of the inherited Namer class (with a declared self variable) in Global.Foo
+   * is stable between compiling from source and unpickling. We compare extracted APIs of Global when Global
+   * is compiled together with Namers or Namers is compiled first and then Global refers
+   * to Namers by unpickling types from class files.
+   */
+  @Test
+  def `ExtractAPI should make a stable representation of a self variable that has no self type`(): Unit = {
+    def selectNamer(apis: Set[ClassLike]): ClassLike = {
+      // TODO: this doesn't work yet because inherited classes are not extracted
+      apis.find(_.name == "Global.Foo.Namer").get
+    }
+
+    val src1 =
+      """|class Namers {
+         |  class Namer { thisNamer => }
+         |}
+         |""".stripMargin
+    val src2 =
+      """|class Global {
+         |  class Foo extends Namers
+         |}
+         |""".stripMargin
+    val apis =
+      extractApisFromSrcs(List(src1, src2), List(src2))
+    val _ :: src2Api1 :: src2Api2 :: Nil = apis.toList
+    val namerApi1 = selectNamer(src2Api1)
+    val namerApi2 = selectNamer(src2Api2)
+    assertTrue(SameAPI(namerApi1, namerApi2))
+  }
+
+  @Test
+  def `ExtractAPI should make a different representation for an inherited class`(): Unit = {
+    val src =
+      """|class A[T] {
+         |  abstract class AA { def t: T }
+         |}
+         |class B extends A[Int]
+    """.stripMargin
+    val apis = extractApisFromSrc(src).map(a => a.name -> a).toMap
+    assertEquals(apis.keySet, Set("A", "A.AA", "B", "B.AA"))
+    assertNotEquals(apis("A.AA"), apis("B.AA"))
+  }
+
+  @Test
+  def `ExtractAPI should handle package objects and type companions`(): Unit = {
+    val src =
+      """|package object abc {
+         |  type BuildInfoKey = BuildInfoKey.Entry[_]
+         |  object BuildInfoKey {
+         |    sealed trait Entry[A]
+         |  }
+         |}
+    """.stripMargin
+    val apis = extractApisFromSrc(src).map(a => a.name -> a).toMap
+    assertEquals(apis.keySet, Set("abc.package", "abc.BuildInfoKey", "abc.BuildInfoKey.Entry"))
+  }
+
+  /**
+   * Checks if self type is properly extracted in various cases of declaring a self type
+   * with our without a self variable.
+   */
+  @Test
+  def `ExtractAPI should represent a self type correctly`(): Unit = {
+    val srcX = "trait X"
+    val srcY = "trait Y"
+    val srcC1 = "class C1 { this: C1 => }"
+    val srcC2 = "class C2 { thisC: C2 => }"
+    val srcC3 = "class C3 { this: X => }"
+    val srcC4 = "class C4 { thisC: X => }"
+    val srcC5 = "class C5 extends AnyRef with X with Y { self: X with Y => }"
+    val srcC6 = "class C6 extends AnyRef with X { self: X with Y => }"
+    val srcC7 = "class C7 { _ => }"
+    val srcC8 = "class C8 { self => }"
+    val apis = extractApisFromSrcs(
+      List(srcX, srcY, srcC1, srcC2, srcC3, srcC4, srcC5, srcC6, srcC7, srcC8)
+    ).map(_.head)
+    val emptyType = EmptyType.of()
+
+    def hasSelfType(c: ClassLike): Boolean =
+      c.selfType != emptyType
+
+    val (withSelfType, withoutSelfType) = apis.partition(hasSelfType)
+    assertEquals(withSelfType.map(_.name).toSet, Set("C3", "C4", "C5", "C6"))
+    assertEquals(withoutSelfType.map(_.name).toSet, Set("X", "Y", "C1", "C2", "C7", "C8"))
+  }
+}