Add test for basic reporting in Scala3doc

Author: romanowski

scala3doc/src/dotty/dokka/Scala3doc.scala

@@ -26,9 +26,12 @@ class Scala3DocDokkaLogger(using DocContext) extends DokkaLogger:
 
   def info(msg: String): Unit = report.inform(msg)
   def progress(msg: String): Unit = report.informProgress(msg)
+
+  private val dokkaAlphaWarning = "Dokka 1.4.* is an alpha project"
   def warn(msg: String): Unit =
-    warnings += 1
-    report.warning(msg)
+    if msg != dokkaAlphaWarning then
+      warnings += 1
+      report.warning(msg)
 
   private var errors = 0
   private var warnings = 0
@@ -80,12 +83,12 @@ object Scala3doc:
 
       if (parsedArgs.output.exists()) IO.delete(parsedArgs.output)
 
-      run(updatedArgs, new Scala3DocDokkaLogger)
+      run(updatedArgs)
       report.inform("Done")
     else report.error("Failure")
     reporter
 
-  private [dokka] def run(args: Args, logger: DokkaLogger = DokkaConsoleLogger.INSTANCE)(using DocContext) =
-    new DokkaGenerator(new DottyDokkaConfig(args, summon[DocContext]), logger).generate()
+  private [dokka] def run(args: Args)(using DocContext) =
+    new DokkaGenerator(new DottyDokkaConfig(args, summon[DocContext]), new Scala3DocDokkaLogger).generate()
 
 

scala3doc/test/dotty/dokka/RaportingTest.scala

@@ -0,0 +1,64 @@
+package dotty.dokka
+
+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
+import dotty.tools.dotc.core.Contexts._
+
+class ReportingTest:
+  import Scala3doc.Args
+
+  private def checkReportedDiagnostics(
+    newArgs: Args => Args = identity,
+    ctx: Context = testContext)(
+    op: ReportedDiagnostics => Unit): Unit =
+
+    val dest = Files.createTempDirectory("test-doc")
+    try
+      val args = Args(
+          name = "Test Project Name",
+          output = dest.toFile,
+          tastyFiles = tastyFiles("nested") // Random package
+        )
+      Scala3doc.run(newArgs(args))(using ctx)
+      op(ctx.reportedDiagnostics)
+
+    finally IO.delete(dest.toFile)
+
+  @Test
+  def noMessageForMostCases = checkReportedDiagnostics(){ diag =>
+    assertNoWarning(diag)
+    assertNoErrors(diag)
+    assertNoInfos(diag)
+  }
+
+  @Test
+  def noClassesErors = checkReportedDiagnostics(_.copy(tastyFiles = Nil)){ diag =>
+    assertMessagesAbout(diag.errorMsgs)("classes should no be empty")
+  }
+
+  @Test
+  def errorsInCaseOfIncompletClasspath =
+    val notTasty = Files.createTempFile("broken", ".notTasty")
+    try
+      Files.write(notTasty, "Random file".getBytes)
+      checkReportedDiagnostics(a => a.copy(tastyFiles = notTasty.toFile +: a.tastyFiles)){ diag =>
+        assertMessagesAbout(diag.errorMsgs)("File extension is not `tasty` or `jar`")
+      }
+    finally Files.delete(notTasty)
+
+  @Test
+  def verbosePrintsDokkaMessage =
+    val ctx = testContext
+    ctx.setSetting(ctx.settings.verbose, true)
+    checkReportedDiagnostics(ctx = ctx){ diag =>
+      assertNoWarning(diag)
+      assertNoErrors(diag)
+
+      assertMessagesAbout(diag.infoMsgs)("dotty.dokka.DottyDokkaPlugin", "generation completed successfully")
+    }

scala3doc/test/dotty/dokka/ScaladocTest.scala

@@ -11,6 +11,7 @@ import scala.jdk.CollectionConverters.{ListHasAsScala, SeqHasAsJava}
 import org.junit.{Test, Rule}
 import org.junit.rules.{TemporaryFolder, ErrorCollector}
 import java.io.File
+import dotty.tools.dotc.core.Contexts._
 
 abstract class ScaladocTest(val name: String):
   def assertions: Seq[Assertion]
@@ -22,22 +23,11 @@ abstract class ScaladocTest(val name: String):
 
   private def args = Scala3doc.Args(
       name = "test",
-      tastyFiles = tastyFiles.map(new File(_)),
+      tastyFiles = tastyFiles(name),
       output = getTempDir().getRoot,
       projectVersion = Some("1.0")
     )
 
-  private def tastyFiles =
-    def listFilesSafe(dir: File) = Option(dir.listFiles).getOrElse {
-      throw AssertionError(s"$dir not found. The test name is incorrect or scala3doc-testcases were not recompiled.")
-    }
-    def collectFiles(dir: File): List[String] = listFilesSafe(dir).toList.flatMap {
-        case f if f.isDirectory => collectFiles(f)
-        case f if f.getName endsWith ".tasty" => f.getAbsolutePath :: Nil
-        case _ => Nil
-      }
-    collectFiles(File(s"${BuildInfo.test_testcasesOutputDir}/tests/$name"))
-
   @Rule
   def collector = _collector
   private val _collector = new ErrorCollector();
@@ -46,8 +36,8 @@ abstract class ScaladocTest(val name: String):
   @Test
   def executeTest =
     DokkaTestGenerator(
-      DottyDokkaConfig(args),
-      TestLogger(DokkaConsoleLogger.INSTANCE),
+      DottyDokkaConfig(args, testContext),
+      TestLogger(new Scala3DocDokkaLogger(using testContext)),
       assertions.asTestMethods,
       Nil.asJava
     ).generate()

scala3doc/test/dotty/dokka/site/SiteGeneratationTest.scala

@@ -9,7 +9,7 @@ import org.junit.Assert._
 import org.jsoup.Jsoup
 import org.jsoup.nodes.Document
 import java.nio.charset.Charset
-
+import dotty.tools.dotc.core.Contexts._
 
 class SiteGeneratationTest:
   val projectName = "Test Project Name"
@@ -24,10 +24,10 @@ class SiteGeneratationTest:
           docsRoot = Some(base.toAbsolutePath.toString),
           projectVersion = Some(projectVersion),
         )
-      Scala3doc.run(args)
+      Scala3doc.run(args)(using testContext)
       op(dest)
 
-    finally println(dest.toFile) // IO.delete(dest.toFile)
+    finally IO.delete(dest.toFile)
 
   val testDocPath = Paths.get(BuildInfo.testDocumentationRoot)
 

scala3doc/test/dotty/dokka/testUtils.scala

@@ -0,0 +1,62 @@
+package dotty.dokka
+
+import dotty.tools.dotc.core.Contexts._
+import dotty.tools.dotc.reporting.Diagnostic
+import dotty.tools.dotc.reporting.ConsoleReporter
+import dotty.tools.dotc.interfaces.Diagnostic.{ERROR, INFO, WARNING}
+import org.junit.Assert._
+import java.io.File
+
+case class ReportedDiagnostics(errors: List[Diagnostic], warnings: List[Diagnostic], infos: List[Diagnostic]):
+  def errorMsgs = errors.map(_.msg.rawMessage)
+  def warningMsgs = warnings.map(_.msg.rawMessage)
+  def infoMsgs = infos.map(_.msg.rawMessage)
+
+
+extension (c: Context) def reportedDiagnostics: ReportedDiagnostics =
+  val t = c.reporter.asInstanceOf[TestReporter]
+  ReportedDiagnostics(t.errors.result, t.warnings.result, t.infos.result)
+
+def assertNoWarning(diag: ReportedDiagnostics) = assertEquals("Warnings should be empty", Nil, diag.warningMsgs)
+def assertNoErrors(diag: ReportedDiagnostics) = assertEquals("Erros should be empty", Nil, diag.errorMsgs)
+def assertNoInfos(diag: ReportedDiagnostics) = assertEquals("Infos should be empty", Nil, diag.infoMsgs)
+
+def assertMessagesAbout(messages: Seq[String])(patterns: String*) =
+  patterns.foldLeft(messages){ (toCheck, pattern) =>
+    val (matching, rest) = toCheck.partition(_.contains(pattern))
+    assertTrue(
+      s"Unable to find messages matching `$pattern`in $toCheck" +
+        " (not that some methods may be filtered out by previous patterns",
+      matching.nonEmpty
+    )
+    rest
+  }
+
+class TestReporter extends ConsoleReporter:
+  val errors = List.newBuilder[Diagnostic]
+  val warnings = List.newBuilder[Diagnostic]
+  val infos = List.newBuilder[Diagnostic]
+
+
+  override def doReport(dia: Diagnostic)(using Context): Unit = dia.level match
+    case INFO =>
+      infos += dia
+    case ERROR =>
+      errors += dia
+      super.doReport(dia)
+    case WARNING =>
+      warnings += dia
+      super.doReport(dia)
+
+def testContext = (new ContextBase).initialCtx.fresh.setReporter(new TestReporter)
+
+def tastyFiles(name: String) =
+  def listFilesSafe(dir: File) = Option(dir.listFiles).getOrElse {
+    throw AssertionError(s"$dir not found. The test name is incorrect or scala3doc-testcases were not recompiled.")
+  }
+  def collectFiles(dir: File): List[File] = listFilesSafe(dir).toList.flatMap {
+      case f if f.isDirectory => collectFiles(f)
+      case f if f.getName endsWith ".tasty" => f :: Nil
+      case _ => Nil
+    }
+  collectFiles(File(s"${BuildInfo.test_testcasesOutputDir}/tests/$name"))