Remove scala3doc-test

Move testcases into  dedicated project.

Author: romanowski

.github/workflows/ci.yaml

@@ -5,12 +5,12 @@ on:
     paths-ignore:
       # Do not run everything on changes only in docs
       - 'scala3doc/**' 
-      - 'scala3doc-test/**'
+      - 'scala3doc-testcases/**'
   pull_request:
     paths-ignore:
       # Do not run everything on changes only in docs
       - 'scala3doc/**' 
-      - 'scala3doc-test/**'
+      - 'scala3doc-testcases/**'
   schedule:
     - cron: '0 3 * * *'  # Every day at 3 AM
 

.github/workflows/scala3doc.yaml

@@ -33,7 +33,7 @@ jobs:
           java-version: 11
 
       - name: Compile and test
-        run: ./project/scripts/sbt scala3doc-test/test
+        run: ./project/scripts/sbt scala3doc/test
 
       - name: Locally publish self
         run: ./project/scripts/sbt scala3doc/publishLocal

build.sbt

@@ -21,7 +21,7 @@ val `tasty-core` = Build.`tasty-core`
 val `tasty-core-bootstrapped` = Build.`tasty-core-bootstrapped`
 val `tasty-core-scala2` = Build.`tasty-core-scala2`
 val scala3doc = Build.scala3doc
-val `scala3doc-test` = Build.`scala3doc-test`
+val `scala3doc-testcases` = Build.`scala3doc-testcases`
 val `scala3-bench-run` = Build.`scala3-bench-run`
 val dist = Build.dist
 val `community-build` = Build.`community-build`

project/Build.scala

@@ -1158,8 +1158,10 @@ object Build {
   lazy val `scala3-bench-bootstrapped` = project.in(file("bench")).asDottyBench(Bootstrapped)
   lazy val `scala3-bench-run` = project.in(file("bench-run")).asDottyBench(Bootstrapped)
 
+  val testcasesOutputDir = taskKey[String]("Root directory where tests classses are generated")
+  val testcasesSourceRoot = taskKey[String]("Root directory where tests sources are generated")
   lazy val `scala3doc` = project.in(file("scala3doc")).asScala3doc
-  lazy val `scala3doc-test` = project.in(file("scala3doc-test")).asScala3docTest
+  lazy val `scala3doc-testcases` = project.in(file("scala3doc-testcases")).asScala3docTestcases
 
   // sbt plugin to use Dotty in your own build, see
   // https://github.com/lampepfl/scala3-example-project for usage.
@@ -1448,60 +1450,34 @@ object Build {
       settings(commonBenchmarkSettings).
       enablePlugins(JmhPlugin)
 
-    def commonScala3docSettings = Seq(
-      resolvers += Resolver.jcenterRepo,
-      resolvers += Resolver.bintrayRepo("kotlin", "kotlin-dev"),
-      resolvers += Resolver.bintrayRepo("virtuslab", "dokka"),
-    )
-
     def asScala3doc: Project =
       project.settings(commonBootstrappedSettings).
-        settings(commonScala3docSettings).
         dependsOn(`scala3-compiler-bootstrapped`).
         dependsOn(`scala3-tasty-inspector`).
-        settings(artifactsForScala3Documentation := Seq(
-          // All projects below will be used to generated documentation for Scala 3
-          classDirectory.in(`scala3-interfaces`).in(Compile).value,
-          classDirectory.in(`tasty-core`).in(Compile).value,
-          classDirectory.in(`scala3-library`).in(Compile).value,
-          // TODO this one fails to load using TASTY
-          // classDirectory.in(`stdlib-bootstrapped`).in(Compile).value,
-        ))
-
-    def asScala3docTest: Project =
-      project.settings(commonBootstrappedSettings0).
-        settings(commonScala3docSettings).
-        dependsOn(`scala3doc`).
         settings(
-          Compile/doc/target := baseDirectory.value / "../out/doc" / name.value,
-          doc/scalaInstance := {
-            val externalNonBootstrappedDeps = externalDependencyClasspath.in(`scala3doc`, Compile).value
-            val scalaLibrary = findArtifact(externalNonBootstrappedDeps, "scala-library")
-
-            // IMPORTANT: We need to use actual jars to form the ScalaInstance and not
-            // just directories containing classfiles because sbt maintains a cache of
-            // compiler instances. This cache is invalidated based on timestamps
-            // however this is only implemented on jars, directories are never
-            // invalidated.
-            val tastyCore = packageBin.in(`tasty-core`, Compile).value
-            val dottyLibrary = packageBin.in(`scala3-library-bootstrapped`, Compile).value
-            val dottyInterfaces = packageBin.in(`scala3-interfaces`, Compile).value
-            val dottyCompiler = packageBin.in(`scala3-compiler-bootstrapped`, Compile).value
-            val doctool = packageBin.in(`scala3doc`, Compile).value
-
-            val allJars = Seq(tastyCore, dottyLibrary, dottyInterfaces, dottyCompiler, doctool) ++ externalNonBootstrappedDeps.map(_.data)
-
-            makeScalaInstance(
-              state.value,
-              scalaVersion.value,
-              scalaLibrary,
-              dottyLibrary,
-              dottyCompiler,
-              allJars
-            )
+          resolvers += Resolver.jcenterRepo,
+          resolvers += Resolver.bintrayRepo("kotlin", "kotlin-dev"),
+          resolvers += Resolver.bintrayRepo("virtuslab", "dokka"),
+          artifactsForScala3Documentation := Seq(
+            // All projects below will be used to generated documentation for Scala 3
+            classDirectory.in(`scala3-interfaces`).in(Compile).value,
+            classDirectory.in(`tasty-core`).in(Compile).value,
+            classDirectory.in(`scala3-library`).in(Compile).value,
+            // TODO this one fails to load using TASTY
+            // classDirectory.in(`stdlib-bootstrapped`).in(Compile).value,
+          ),
+          test.in(Test) := {
+            // Test
+            compile.in(Compile).in(`scala3doc-testcases`).value
+            test.in(Test).value
           },
+          testcasesOutputDir.in(Test) := classDirectory.in(Compile).in(`scala3doc-testcases`).value.getAbsolutePath.toString,
+          testcasesSourceRoot.in(Test) := (baseDirectory.in(`scala3doc-testcases`).value / "src").getAbsolutePath.toString
         )
 
+    def asScala3docTestcases: Project =
+      project.dependsOn(`scala3-compiler-bootstrapped`).settings(commonBootstrappedSettings)
+
     def asDist(implicit mode: Mode): Project = project.
       enablePlugins(PackPlugin).
       withCommonSettings.

scala3doc-test/build.sbt

@@ -2,7 +2,7 @@ val flexmarkVersion = "0.42.12"
 val jacksonVersion = "2.9.8"
 val scalaTagsVersion = "0.9.1"
 val dokkaSiteVersion = "0.1.9"
-
+val dokkaVersion = "1.4.10.2"
 
 libraryDependencies ++= Seq(
   "org.scala-lang" %% "scala3-tasty-inspector" % scalaVersion.value,
@@ -11,16 +11,20 @@ libraryDependencies ++= Seq(
   "com.vladsch.flexmark" % "flexmark-all" % flexmarkVersion,
   "nl.big-o" % "liqp" % "0.6.7",
   "args4j" % "args4j" % "2.33",
+
+  "org.jetbrains.dokka" % "dokka-test-api" % dokkaVersion % "test",
+  "com.novocode" % "junit-interface" % "0.11" % "test",
 )
 
 val generateSelfDocumentation = inputKey[Unit]("Generate example documentation")
 generateSelfDocumentation := Def.inputTaskDyn {
-  runSelfDocumentation(classDirectory.in(Compile).value.getAbsolutePath)
+  generateDocumentation(classDirectory.in(Compile).value.getAbsolutePath, "scala3doc", "self", "-d documentation")
 }.evaluated
 
-def runSelfDocumentation(classDir: String) = Def.taskDyn {
-    val mapping = "src/main/scala=https://github.com/lampepfl/scala3doc/tree/master/src/main/scala#L"
-    run.in(Compile).toTask(s" -o output/self -t $classDir -d documentation -n scala3doc -s $mapping")
+
+def generateDocumentation(targets: String, name: String, outDir: String, params: String = "") = Def.taskDyn {
+    val sourceMapping = "=https://github.com/lampepfl/dotty/tree/master#L"
+    run.in(Compile).toTask(s""" -o output/$outDir -t $targets -n "$name" -s $sourceMapping $params""")
 }
 
 // Uncomment to debug dokka processing (require to run debug in listen mode on 5005 port)
@@ -29,22 +33,31 @@ def runSelfDocumentation(classDir: String) = Def.taskDyn {
 fork.in(run) := true
 Compile / mainClass := Some("dotty.dokka.Main")
 
-
-def generateDottyDocsFromClasspath(artifacts: Seq[String]) =  Def.taskDyn {
-  val roots = artifacts.mkString(java.io.File.pathSeparator)
-  val mapping = "=https://github.com/lampepfl/dotty/tree/master#L"
-  if (artifacts.isEmpty) Def.task {
-    streams.value.log.error("Dotty lib wasn't found")
-  } else Def.task {
-    run.in(Compile).toTask(s" -o output/stdLib -t $roots -d dotty-docs/docs -n dotty-lib -s $mapping ").value
-  }
-}
+// There is a bug in dokka that prevents parallel tests withing the same jvm
+fork.in(test) := true
+Test / parallelExecution := false
 
 val generateScala3Documentation = taskKey[Unit]("Generate documentation for dotty lib")
 generateScala3Documentation := Def.taskDyn {
   val dottyJars = Build.artifactsForScala3Documentation.value.map(_.toString)
+  val roots = dottyJars.mkString(java.io.File.pathSeparator)
 
-  streams.value.log.info(s"Documenting classes from:\n${dottyJars.mkString("\n")}")
+  if (dottyJars.isEmpty) Def.task { streams.value.log.error("Dotty lib wasn't found") } 
+  else generateDocumentation(roots, "Scala 3", "stdLib", "-d dotty-docs/docs")
+}.value
 
-  generateDottyDocsFromClasspath(dottyJars)
+val generateTestcasesDocumentation  = taskKey[Unit]("Generate documentation for testcases, usefull for debugging tests")
+generateTestcasesDocumentation := Def.taskDyn {
+  val dottyJars = Build.artifactsForScala3Documentation.value.map(_.toString)
+  generateDocumentation(Build.testcasesOutputDir.in(Test).value, "Scala3doc testcases", "testcases")
 }.value
+
+
+buildInfoKeys in Test := Seq[BuildInfoKey](
+  Build.testcasesOutputDir.in(Test),
+  Build.testcasesSourceRoot.in(Test),
+)
+
+buildInfoPackage in Test := "dotty.dokka"
+BuildInfoPlugin.buildInfoScopedSettings(Test)
+BuildInfoPlugin.buildInfoDefaultSettings

scala3doc-test/src/example/Documentation2.scala renamed to scala3doc-testcases/src/example/Documentation2.scala

@@ -51,15 +51,15 @@ abstract class MultipleFileTest(val sourceFiles: List[String], val tastyFolders:
         def cleanup(s: String) = s.replace("\n", " ").replaceAll(" +", " ")
 
         val allFromSource = sourceFiles.map{ file => 
-            val all = signaturesFromSource(Source.fromFile(s"${BuildInfo.testSourceRoot}/tests/$file.scala"))
+            val all = signaturesFromSource(Source.fromFile(s"${BuildInfo.test_testcasesSourceRoot}/tests/$file.scala"))
             (all.expected, all.unexpected)
         }
 
         val expectedFromSource = allFromSource.map(_._1).flatten.filter(extractSymbolName(_) != "NULL").map(cleanup)
         val unexpectedFromSource = allFromSource.map(_._2).flatten.filter(extractSymbolName(_) != "NULL").map(cleanup)
         val unexpectedSignatureSymbolNames = unexpectedFromSource.map(extractSymbolName)
 
-        val allFromDocumentation = tastyFolders.flatMap(folder => signaturesFromDocumentation(s"${BuildInfo.testOutputDir}/tests/$folder"))
+        val allFromDocumentation = tastyFolders.flatMap(folder => signaturesFromDocumentation(s"${BuildInfo.test_testcasesOutputDir}/tests/$folder"))
         val fromDocumentation = allFromDocumentation.filter(extractSymbolName(_) != "NULL").map(cleanup)
 
         val documentedSignatures = fromDocumentation.flatMap(matchSignature(_, expectedFromSource)).toSet

scala3doc-test/src/example/Inheritance.scala renamed to scala3doc-testcases/src/example/Inheritance.scala

@@ -123,7 +123,7 @@ class MemberLookupTests {
     import java.io.File
     import scala.collection.mutable.ListBuffer
 
-    val classRoot = new File(BuildInfo.testOutputDir)
+    val classRoot = new File(BuildInfo.test_testcasesOutputDir)
 
     def go(bld: ListBuffer[String])(file: File): Unit =
       file.listFiles.foreach { f =>