From dc3bccc57f1da7a8973b4c5bec16b1ddbea546ae Mon Sep 17 00:00:00 2001
From: Ethan Atkins <contact@ethanatkins.com>
Date: Tue, 25 Aug 2020 12:35:35 -0700
Subject: [PATCH] Add scripted verification that doc works

In 1.4.0-RC2, doc did not actually generate html files for the project
clases. This was fixed in zinc and this commit updates the actions/doc
scripted test to verify that doc actually generates output for the
project classes.
---
 sbt/src/sbt-test/actions/doc/build.sbt       | 16 ++++++++++++-
 sbt/src/sbt-test/actions/doc/changes/B.scala |  6 +++++
 sbt/src/sbt-test/actions/doc/test            | 24 +++++++++++++++-----
 3 files changed, 39 insertions(+), 7 deletions(-)
 create mode 100644 sbt/src/sbt-test/actions/doc/changes/B.scala

diff --git a/sbt/src/sbt-test/actions/doc/build.sbt b/sbt/src/sbt-test/actions/doc/build.sbt
index 5fa581aa3..8f1b96ff9 100644
--- a/sbt/src/sbt-test/actions/doc/build.sbt
+++ b/sbt/src/sbt-test/actions/doc/build.sbt
@@ -1,5 +1,19 @@
+import complete.{ Parser, Parsers }
+import Parser._
+import Parsers._
+
 lazy val root = (project in file("."))
   .settings(
     crossPaths := false,
-    Compile / doc / scalacOptions += "-Xfatal-warnings"
+    crossScalaVersions := Seq("2.12.12", "2.13.3"),
+    scalaVersion := "2.12.12",
+    Compile / doc / scalacOptions += "-Xfatal-warnings",
+    commands += Command.command("excludeB") { s =>
+      val impl = """val src = (sources in Compile).value; src.filterNot(_.getName.contains("B"))"""
+      s"set sources in (Compile, doc) := { $impl }" :: s
+    },
+    commands += Command.arb(_ => ("setDocExtension": Parser[String]) ~> " " ~> matched(any.*)) { (s, filter: String) =>
+      val impl = s"""val src = (sources in Compile).value; src.filter(_.getName.endsWith("$filter"))"""
+      s"set sources in (Compile, doc) := { $impl }" :: s
+    },
   )
diff --git a/sbt/src/sbt-test/actions/doc/changes/B.scala b/sbt/src/sbt-test/actions/doc/changes/B.scala
new file mode 100644
index 000000000..1e17e20e9
--- /dev/null
+++ b/sbt/src/sbt-test/actions/doc/changes/B.scala
@@ -0,0 +1,6 @@
+object B {
+	/**
+	* @param i An argument
+	*/
+	def x(i: Int) = 3
+}
diff --git a/sbt/src/sbt-test/actions/doc/test b/sbt/src/sbt-test/actions/doc/test
index 3b86809ab..14318f4e5 100644
--- a/sbt/src/sbt-test/actions/doc/test
+++ b/sbt/src/sbt-test/actions/doc/test
@@ -1,35 +1,47 @@
-> debug
+-> doc
 
-# -> doc
-
-> set sources in (Compile, doc) := { val src = (sources in Compile).value; src.filterNot(_.getName contains "B") }
+> excludeB
 
 # hybrid project, only scaladoc run
 > doc
 $ exists target/api/index.js
+$ exists target/api/A$.html
 $ absent target/api/scala
 $ absent target/api/java
 
-> set sources in (Compile, doc) := { val src = (sources in (Compile, doc)).value; src.filterNot(_.getName endsWith ".java") }
+> setDocExtension scala
 
+# The original B.scala fails scaladoc
+$ copy-file changes/B.scala B.scala
 # compile task is superfluous. Since doc task preceded by compile task has been problematic due to scala
 # compiler's way of handling empty classpath. We have it here to test that our workaround works.
 > clean ; compile ; doc
 
 # pure scala project, only scaladoc at top level
 $ exists target/api/index.js
+$ exists target/api/A$.html
+$ exists target/api/B$.html
 $ absent target/api/package-list
 $ absent target/api/scala
 $ absent target/api/java
 
-> set sources in (Compile, doc) := { val src = (sources in Compile).value; src.filter(_.getName endsWith ".java") }
+> setDocExtension java
 
 > clean ; doc
 
 # pure java project, only javadoc at top level
 $ exists target/api/index.html
+$ exists target/api/pkg/J.html
 $ absent target/api/index.js
 
+> setDocExtension scala
+> ++2.13.3
+> clean
+$ absent target/api/A$.html
+> doc
+$ exists target/api/A$.html
+$ exists target/api/B$.html
+
 # pending
 # $ absent target/api/scala
 # $ absent target/api/java