Add basic integration tests for static site

Author: romanowski

project/Build.scala

@@ -1159,6 +1159,7 @@ object Build {
 
   val testcasesOutputDir = taskKey[String]("Root directory where tests classses are generated")
   val testcasesSourceRoot = taskKey[String]("Root directory where tests sources are generated")
+  val testDocumentationRoot = taskKey[String]("Root directory where tests documentation are stored")
   val generateSelfDocumentation = taskKey[Unit]("Generate example documentation")
   // Note: the two tasks below should be one, but a bug in Tasty prevents that
   val generateScala3Documentation = taskKey[Unit]("Generate documentation for dotty lib")
@@ -1532,7 +1533,9 @@ object Build {
           buildInfoKeys in Test := Seq[BuildInfoKey](
             Build.testcasesOutputDir.in(Test),
             Build.testcasesSourceRoot.in(Test),
+            Build.testDocumentationRoot,
           ),
+          testDocumentationRoot := (baseDirectory.value / "test-documentations").getAbsolutePath,
           buildInfoPackage in Test := "dotty.dokka",
           BuildInfoPlugin.buildInfoScopedSettings(Test),
           BuildInfoPlugin.buildInfoDefaultSettings,

scala3doc/src/dotty/dokka/Main.scala

@@ -78,13 +78,13 @@ case class Args(
   tastyRoots: Seq[File],
   classpath: String,
   output: File,
-  docsRoot: Option[String],
-  projectVersion: Option[String],
-  projectTitle: Option[String],
-  projectLogo: Option[String],
-  defaultSyntax: Option[Args.CommentSyntax],
-  sourceLinks: List[String],
-  revision: Option[String]
+  docsRoot: Option[String] = None,
+  projectVersion: Option[String] = None,
+  projectTitle: Option[String] = None,
+  projectLogo: Option[String] = None,
+  defaultSyntax: Option[Args.CommentSyntax] = None,
+  sourceLinks: List[String] = Nil,
+  revision: Option[String] = None
 )
 
 object Args:
@@ -121,12 +121,8 @@ enum DocConfiguration extends BaseDocConfiguration:
   * - [](package.DottyDokkaConfig) is our config for Dokka.
   */
 object Main:
-  def main(args: Array[String]): Unit =
+  def main(parsedArgs: Args): Unit =
     try
-      val rawArgs = new RawArgs
-      new CmdLineParser(rawArgs).parseArgument(args:_*)
-      val parsedArgs = rawArgs.toArgs
-
       val (files, dirs) = parsedArgs.tastyRoots.partition(_.isFile)
       val (providedTastyFiles, jars) = files.toList.map(_.getAbsolutePath).partition(_.endsWith(".tasty"))
       jars.foreach(j => if(!j.endsWith(".jar")) sys.error(s"Provided file $j is not jar not tasty file") )
@@ -147,11 +143,17 @@ object Main:
       new DokkaGenerator(new DottyDokkaConfig(config), DokkaConsoleLogger.INSTANCE).generate()
 
       println("Done")
-
-      // Sometimes jvm is hanging, so we want to be sure that we force shout down the jvm
-      sys.exit(0)
     catch
       case a: Exception =>
         a.printStackTrace()
         // Sometimes jvm is hanging, so we want to be sure that we force shout down the jvm
         sys.exit(1)
+
+  def main(args: Array[String]): Unit =
+      val rawArgs = new RawArgs
+      new CmdLineParser(rawArgs).parseArgument(args:_*)
+      main(rawArgs.toArgs)
+      // Sometimes jvm is hanging, so we want to be sure that we force shout down the jvm
+      sys.exit(0)
+
+

scala3doc/src/dotty/dokka/transformers/PackageHierarchyTransformer.scala

@@ -63,12 +63,9 @@ class PackageHierarchyTransformer(context: DokkaContext) extends PageTransformer
 
     val packagePagesWithTokens = packagePages.map(page => (("""\.""".r.split(page.getName)).toSeq, page))
 
-    val maxDepthElem = packagePagesWithTokens.maxBy( (tokens, page) => tokens.size )
-
-    page.modified(
-      page.getName,
+    val newPages = if packagePagesWithTokens.isEmpty then page.getChildren else
+      val maxDepthElem = packagePagesWithTokens.maxBy( (tokens, page) => tokens.size )
       (otherPages ++ buildPackageTree(maxDepthElem(0).size, packagePagesWithTokens, Seq.empty)).asJava
-    )
-
 
+    page.modified(page.getName, newPages)
   }

scala3doc/test-documentations/basic/docs/Adoc.md

@@ -0,0 +1,6 @@
+---
+title: Adoc
+---
+# Header in Adoc
+
+And a text!

scala3doc/test-documentations/basic/docs/dir/index.md

@@ -0,0 +1,6 @@
+---
+title: A directory
+---
+# {{  page.title }}
+
+And a text!

scala3doc/test-documentations/basic/docs/dir/nested.md

@@ -0,0 +1,6 @@
+---
+title: Nested in a directory
+---
+# {{  page.title }}
+
+And a text!

scala3doc/test-documentations/basic/docs/index.md

@@ -0,0 +1,3 @@
+# {{ page.title }} in header
+
+And a text!

scala3doc/test-documentations/basic/images/basic.svg

@@ -0,0 +1,6 @@
+---
+title: Basic test
+---
+# Header
+
+And a text!

scala3doc/test-documentations/basic/index.md

@@ -0,0 +1,75 @@
+package dotty.dokka
+package site
+
+import java.nio.file.Files
+import java.nio.file.Path
+import java.nio.file.Paths
+import org.junit.Test
+import org.junit.Assert._
+import org.jsoup.Jsoup
+import org.jsoup.nodes.Document
+import java.nio.charset.Charset
+
+
+class SiteGeneratationTest:
+  val projectName = "Test Project Name"
+  val projectTitle = "Test Project Title"
+  val projectVersion = "1.0.1-M1"
+
+  private def withGeneratedSite(base: Path)(op: Path => Unit) =
+    val dest = Files.createTempDirectory("test-doc")
+    try
+      val args = Args(
+          name = projectName,
+          tastyRoots = Nil ,
+          classpath = System.getProperty("java.class.path"),
+          output = dest.toFile,
+          docsRoot = Some(base.toAbsolutePath.toString),
+          projectVersion = Some(projectVersion),
+          projectTitle = Some(projectTitle)
+        )
+      Main.main(args)
+      op(dest)
+
+    finally println(dest.toFile) // IO.delete(dest.toFile)
+
+  val testDocPath = Paths.get(BuildInfo.testDocumentationRoot)
+
+  class DocumentContext(d: Document, path: Path):
+    import collection.JavaConverters._
+
+    def niceMsg(msg: String) = s"$msg in $path (body):\n ${d.html()}:\n"
+
+    def assertTextsIn(selector: String, expected: String*) =
+      assertFalse(niceMsg("Selector not found"), d.select(selector).isEmpty)
+      val found = d.select(selector).eachText.asScala
+      assertEquals(niceMsg(s"Context does not match for '$selector'"), expected.toList, found.toList)
+
+  def withHtmlFile(path: Path)(op: DocumentContext => Unit) = {
+    assertTrue(s"File at $path does not exisits!", Files.exists(path))
+    val content = new String(Files.readAllBytes(path), Charset.defaultCharset())
+    val document = Jsoup.parse(content)
+    op(DocumentContext(document, path))
+  }
+
+  @Test
+  def basicTest() = withGeneratedSite(testDocPath.resolve("basic")){ dest =>
+
+    def checkFile(path: String)(title: String, header: String, parents: Seq[String] = Nil) =
+      withHtmlFile(dest.resolve(path)){ content  =>
+        content.assertTextsIn(".projectName", projectName)
+        content.assertTextsIn(".projectVersion", projectVersion)
+        content.assertTextsIn("h1", header)
+        content.assertTextsIn("title", title)
+        content.assertTextsIn(".breadcrumbs a", (parents :+ title):_*)
+    }
+
+    checkFile("index.html")(title = "Basic test", header = "Header")
+    checkFile("docs/Adoc.html")(title = "Adoc", header = "Header in Adoc", parents = Seq(projectTitle))
+    checkFile("docs/Adoc.html")(title = "Adoc", header = "Header in Adoc", parents = Seq(projectTitle))
+    checkFile("docs/dir/index.html")(title = "A directory", header = "A directory", parents = Seq(projectTitle))
+    checkFile("docs/dir/nested.html")(
+      title = "Nested in a directory", header = "Nested in a directory", parents = Seq(projectTitle, "A directory"))
+
+    checkFile("docs/index.html")(title = projectTitle, header = s"$projectTitle in header")
+  }