Add tests for Dottydoc from tasty

Duhemm · Duhemm · commit 0c555cc9bf03 · 2018-09-04T10:01:12.000+02:00
diff --git a/compiler/test/dotty/tools/IOUtils.scala b/compiler/test/dotty/tools/IOUtils.scala
@@ -0,0 +1,27 @@
+package dotty.tools
+
+import java.nio.file.{FileSystems, FileVisitOption, FileVisitResult, FileVisitor, Files, Path}
+import java.nio.file.attribute.BasicFileAttributes
+import java.util.EnumSet
+
+import scala.collection.JavaConverters.asScalaIteratorConverter
+
+object IOUtils {
+
+  def inTempDirectory[T](fn: Path => T): T = {
+    val temp = Files.createTempDirectory("temp")
+    try fn(temp)
+    finally {
+      val allFiles = getAll(temp, "glob:**").sortBy(_.toAbsolutePath.toString).reverse
+      allFiles.foreach(Files.delete(_))
+    }
+  }
+
+  def getAll(base: Path, pattern: String): List[Path] = {
+    val paths = Files.walk(base)
+    val matcher = FileSystems.getDefault.getPathMatcher(pattern)
+    try paths.filter(matcher.matches).iterator().asScala.toList
+    finally paths.close()
+  }
+
+}
diff --git a/compiler/test/dotty/tools/dotc/core/tasty/CommentPicklingTest.scala b/compiler/test/dotty/tools/dotc/core/tasty/CommentPicklingTest.scala
@@ -10,16 +10,11 @@ import dotty.tools.dotc.core.Mode
 import dotty.tools.dotc.core.Names.Name
 import dotty.tools.dotc.interfaces.Diagnostic.ERROR
 import dotty.tools.dotc.reporting.TestReporter
+import dotty.tools.IOUtils
 
-import dotty.tools.vulpix.{TestConfiguration, ParallelTesting}
+import dotty.tools.vulpix.TestConfiguration
 
-import java.io.IOException
-import java.nio.file.{FileSystems, FileVisitOption, FileVisitResult, FileVisitor, Files, Path}
-import java.nio.file.attribute.BasicFileAttributes
-import java.util.EnumSet
-
-import scala.collection.JavaConverters.asScalaIteratorConverter
-import scala.concurrent.duration.{Duration, DurationInt}
+import java.nio.file.{Files, Path}
 
 import org.junit.Test
 import org.junit.Assert.{assertEquals, assertFalse, fail}
@@ -86,7 +81,7 @@ class CommentPicklingTest {
   }
 
   private def compileAndUnpickle[T](sources: List[String])(fn: (List[tpd.Tree], Context) => T) = {
-    inTempDirectory { tmp =>
+    IOUtils.inTempDirectory { tmp =>
       val sourceFiles = sources.zipWithIndex.map {
         case (src, id) =>
           val path = tmp.resolve(s"Src$id.scala").toAbsolutePath
@@ -102,7 +97,7 @@ class CommentPicklingTest {
       Main.process(options.all, reporter)
       assertFalse("Compilation failed.", reporter.hasErrors)
 
-      val tastyFiles = getAll(tmp, "glob:**.tasty")
+      val tastyFiles = IOUtils.getAll(tmp, "glob:**.tasty")
       val unpicklingOptions = unpickleOptions
         .withClasspath(out.toAbsolutePath.toString)
         .and("dummy") // Need to pass a dummy source file name
@@ -126,20 +121,4 @@ class CommentPicklingTest {
     }
   }
 
-  private def inTempDirectory[T](fn: Path => T): T = {
-    val temp = Files.createTempDirectory("temp")
-    try fn(temp)
-    finally {
-      val allFiles = getAll(temp, "glob:**").sortBy(_.toAbsolutePath.toString).reverse
-      allFiles.foreach(Files.delete(_))
-    }
-  }
-
-  private def getAll(base: Path, pattern: String): List[Path] = {
-    val paths = Files.walk(base)
-    val matcher = FileSystems.getDefault.getPathMatcher(pattern)
-    try paths.filter(matcher.matches).iterator().asScala.toList
-    finally paths.close()
-  }
-
 }
diff --git a/doc-tool/test/ConstructorTest.scala b/doc-tool/test/ConstructorTest.scala
@@ -9,7 +9,10 @@ import model._
 import model.internal._
 import model.references._
 
-class Constructors extends DottyDocTest {
+class ConstructorsFromSourceTest extends ConstructorsBase with CheckFromSource
+class ConstructorsFromTastyTest extends ConstructorsBase with CheckFromTasty
+
+abstract class ConstructorsBase extends DottyDocTest {
   @Test def singleClassConstructor = {
     val source = new SourceFile (
       "Class.scala",
@@ -20,7 +23,9 @@ class Constructors extends DottyDocTest {
       """.stripMargin
     )
 
-    checkSources(source :: Nil) { packages =>
+    val className = "scala.Class"
+
+    check(className :: Nil, source :: Nil) { packages =>
       packages("scala") match {
         case PackageImpl(_, _, _, List(cls: Class), _, _, _, _) =>
           cls.constructors.headOption match {
@@ -42,7 +47,9 @@ class Constructors extends DottyDocTest {
       """.stripMargin
     )
 
-    checkSources(source :: Nil) { packages =>
+    val className = "scala.Class"
+
+    check(className :: Nil, source :: Nil) { packages =>
       packages("scala") match {
         case PackageImpl(_, _,  _, List(cls: Class), _, _, _, _) =>
           cls.constructors match {
@@ -67,7 +74,9 @@ class Constructors extends DottyDocTest {
       """.stripMargin
     )
 
-    checkSources(source :: Nil) { packages =>
+    val className = "scala.Class"
+
+    check(className :: Nil, source :: Nil) { packages =>
       packages("scala") match {
         case PackageImpl(_, _, _, List(cls: Class), _, _, _, _) =>
           cls.constructors match {
@@ -99,7 +108,9 @@ class Constructors extends DottyDocTest {
       """.stripMargin
     )
 
-    checkSources(source :: Nil) { packages =>
+    val className = "scala.Class"
+
+    check(className :: Nil, source :: Nil) { packages =>
       packages("scala") match {
         case PackageImpl(_, _, _, List(cls: Class), _, _, _, _) =>
           cls.constructors match {
@@ -137,7 +148,9 @@ class Constructors extends DottyDocTest {
       """.stripMargin
     )
 
-    checkSources(source :: Nil) { packages =>
+    val className = "scala.Class"
+
+    check(className :: Nil, source :: Nil) { packages =>
       packages("scala") match {
         case PackageImpl(_, _, _, List(cls: CaseClass, obj: Object), _, _, _, _) =>
           cls.constructors match {
@@ -170,7 +183,9 @@ class Constructors extends DottyDocTest {
       """.stripMargin
     )
 
-    checkSources(source :: Nil) { packages =>
+    val className = "scala.Trait"
+
+    check(className :: Nil, source :: Nil) { packages =>
       packages("scala") match {
         case PackageImpl(_, _, _, List(trt: Trait), _, _, _, _) =>
           trt.traitParams match {
diff --git a/doc-tool/test/DottyDocTest.scala b/doc-tool/test/DottyDocTest.scala
@@ -3,10 +3,12 @@ package dottydoc
 
 import vulpix.TestConfiguration
 
+import dotc.Compiler
 import dotc.core.Contexts.{ Context, ContextBase, FreshContext }
 import dotc.core.Comments.{ ContextDoc, ContextDocstrings }
 import dotc.util.SourceFile
 import dotc.core.Phases.Phase
+import dotty.tools.io.AbstractFile
 import dotc.typer.FrontEnd
 import dottydoc.core.{ DocASTPhase, ContextDottydoc }
 import model.Package
@@ -16,11 +18,12 @@ import dotc.interfaces.Diagnostic.ERROR
 import org.junit.Assert.fail
 
 import java.io.{ BufferedWriter, OutputStreamWriter }
+import java.nio.file.Files
 
 trait DottyDocTest extends MessageRendering {
   dotty.tools.dotc.parsing.Scanners // initialize keywords
 
-  implicit val ctx: FreshContext = {
+  private def freshCtx(extraClasspath: List[String]): FreshContext = {
     val base = new ContextBase
     import base.settings._
     val ctx = base.initialCtx.fresh
@@ -32,12 +35,13 @@ trait DottyDocTest extends MessageRendering {
     ctx.setProperty(ContextDoc, new ContextDottydoc)
     ctx.setSetting(
       ctx.settings.classpath,
-      TestConfiguration.basicClasspath
+      (TestConfiguration.basicClasspath :: extraClasspath).mkString(java.io.File.pathSeparator)
     )
     ctx.setReporter(new StoreReporter(ctx.reporter))
     base.initialize()(ctx)
     ctx
   }
+  implicit val ctx: FreshContext = freshCtx(Nil)
 
   private def compilerWithChecker(assertion: Map[String, Package] => Unit) = new DocCompiler {
     private[this] val assertionPhase: List[List[Phase]] =
@@ -93,9 +97,50 @@ trait DottyDocTest extends MessageRendering {
     run.compile(sources)
   }
 
-  def checkSources(sourceFiles: List[SourceFile])(assertion: Map[String, Package] => Unit): Unit = {
+  def checkFromSource(sourceFiles: List[SourceFile])(assertion: Map[String, Package] => Unit): Unit = {
     val c = compilerWithChecker(assertion)
     val run = c.newRun
     run.compileSources(sourceFiles)
   }
+
+  def checkFromTasty(classNames: List[String], sources: List[SourceFile])(assertion: Map[String, Package] => Unit): Unit = {
+    IOUtils.inTempDirectory { tmp =>
+      val ctx = "shadow ctx"
+      val out = tmp.resolve("out")
+      Files.createDirectories(out)
+
+      val dotcCtx = {
+        val ctx = freshCtx(out.toString :: Nil)
+        ctx.setSetting(ctx.settings.outputDir, AbstractFile.getDirectory(out))
+      }
+      val dotc = new Compiler
+      val run = dotc.newRun(dotcCtx)
+      run.compileSources(sources)
+      assert(!dotcCtx.reporter.hasErrors)
+
+      val fromTastyCtx = {
+        val ctx = freshCtx(out.toString :: Nil)
+        ctx.setSetting(ctx.settings.fromTasty, true)
+      }
+      val fromTastyCompiler = compilerWithChecker(assertion)
+      val fromTastyRun = fromTastyCompiler.newRun(fromTastyCtx)
+      fromTastyRun.compile(classNames)
+      assert(!fromTastyCtx.reporter.hasErrors)
+    }
+  }
+
+  def check(classNames: List[String], sources: List[SourceFile])(assertion: Map[String, Package] => Unit): Unit
+
+}
+
+trait CheckFromSource extends DottyDocTest {
+  override def check(classNames: List[String], sources: List[SourceFile])(assertion: Map[String, Package] => Unit): Unit = {
+    checkFromSource(sources)(assertion)
+  }
+}
+
+trait CheckFromTasty extends DottyDocTest {
+  override def check(classNames: List[String], sources: List[SourceFile])(assertion: Map[String, Package] => Unit): Unit = {
+    checkFromTasty(classNames, sources)(assertion)
+  }
 }
diff --git a/doc-tool/test/MarkdownTests.scala b/doc-tool/test/MarkdownTests.scala
@@ -10,7 +10,7 @@ import dotc.core.Contexts.{ Context, ContextBase, FreshContext }
 import dotc.core.Comments.{ ContextDoc, ContextDocstrings }
 import dottydoc.core.ContextDottydoc
 
-class MarkdownTests extends DottyDocTest {
+class MarkdownTests extends DottyDocTest with CheckFromSource {
   override implicit val ctx: FreshContext = {
     // TODO: check if can reuse parent instead of copy-paste
     val base = new ContextBase
diff --git a/doc-tool/test/PackageStructure.scala b/doc-tool/test/PackageStructure.scala
@@ -7,7 +7,10 @@ import org.junit.Assert._
 import dotc.util.SourceFile
 import model.internal._
 
-class PackageStructure extends DottyDocTest {
+class PackageStructureFromSourceTest extends PackageStructureBase with CheckFromSource
+class PackageStructureFromTastyTest extends PackageStructureBase with CheckFromTasty
+
+abstract class PackageStructureBase extends DottyDocTest {
   @Test def multipleCompilationUnits = {
     val source1 = new SourceFile(
       "TraitA.scala",
@@ -27,7 +30,9 @@ class PackageStructure extends DottyDocTest {
       """.stripMargin
     )
 
-    checkSources(source1 :: source2 :: Nil) { packages =>
+    val classNames = "scala.A" :: "scala.B" :: Nil
+
+    check(classNames, source1 :: source2 :: Nil) { packages =>
       packages("scala") match {
         case PackageImpl(_, _, _, List(tA, tB), _, _, _, _) =>
           assert(
@@ -59,7 +64,9 @@ class PackageStructure extends DottyDocTest {
       |trait B
       """.stripMargin)
 
-    checkSources(source1 :: source2 :: Nil) { packages =>
+    val classNames = "scala.collection.A" :: "scala.collection.B" :: Nil
+
+    check(classNames, source1 :: source2 :: Nil) { packages =>
       packages("scala.collection") match {
         case PackageImpl(_, _, "scala.collection", List(tA, tB), _, _, _, _) =>
           assert(
diff --git a/doc-tool/test/SimpleComments.scala b/doc-tool/test/SimpleComments.scala
@@ -2,11 +2,15 @@ package dotty.tools
 package dottydoc
 
 import model.internal._
+import dotc.util.SourceFile
 
 import org.junit.Test
 import org.junit.Assert._
 
-class TestSimpleComments extends DottyDocTest {
+class SimpleCommentsFromSourceTest extends SimpleCommentsBase with CheckFromSource
+class SimpleCommentsFromTastyTest extends SimpleCommentsBase with CheckFromTasty
+
+abstract class SimpleCommentsBase extends DottyDocTest {
 
   @Test def cookCommentEmptyClass = {
     val source =
@@ -31,15 +35,19 @@ class TestSimpleComments extends DottyDocTest {
   }
 
   @Test def simpleComment = {
-    val source =
+    val source = new SourceFile(
+      "HelloWorld.scala",
       """
       |package scala
       |
       |/** Hello, world! */
       |trait HelloWorld
       """.stripMargin
+    )
 
-    checkSource(source) { packages =>
+    val className = "scala.HelloWorld"
+
+    check(className :: Nil, source :: Nil) { packages =>
       val traitCmt =
         packages("scala")
         .children.find(_.path.mkString(".") == "scala.HelloWorld")
diff --git a/doc-tool/test/TemplateErrorTests.scala b/doc-tool/test/TemplateErrorTests.scala
@@ -5,7 +5,7 @@ package staticsite
 import org.junit.Test
 import org.junit.Assert._
 
-class TemplateErrorTests extends DottyDocTest with SourceFileOps {
+class TemplateErrorTests extends DottyDocTest with SourceFileOps with CheckFromSource {
   @Test def unclosedTag: Unit = {
     htmlPage(
       """|Yo dawg:
diff --git a/doc-tool/test/UsecaseTest.scala b/doc-tool/test/UsecaseTest.scala
diff --git a/doc-tool/test/WhitelistedStdLib.scala b/doc-tool/test/WhitelistedStdLib.scala
diff --git a/doc-tool/test/dotty/tools/dottydoc/staticsite/PageTests.scala b/doc-tool/test/dotty/tools/dottydoc/staticsite/PageTests.scala
diff --git a/doc-tool/test/dotty/tools/dottydoc/staticsite/SiteTests.scala b/doc-tool/test/dotty/tools/dottydoc/staticsite/SiteTests.scala
