project/ScriptCommands.scala

package scala.build

import java.nio.file.Paths

import sbt._
import Keys._
import sbt.complete.Parser._
import sbt.complete.Parsers._

import BuildSettings.autoImport._
import VersionUtil._

/** Custom commands for use by the Jenkins scripts. This keeps the surface area and call syntax small. */
object ScriptCommands {
  def env(key: String) = Option(System.getenv(key)).getOrElse("")

  def all = Seq(
    setupPublishCoreNonOpt,
    setupPublishCore,
    setupValidateTest,
    setupBootstrapStarr, setupBootstrapLocker, setupBootstrapQuick, setupBootstrapPublish,
    enableOptimizerCommand,
    restarr, restarrFull,
  )

  /** Set up the environment for `validate/publish-core`.
   * The optional argument is the Artifactory snapshot repository URL. */
  def setupPublishCoreNonOpt = setup("setupPublishCoreNonOpt") { args =>
    Seq(
      Global / baseVersionSuffix := "SHA-SNAPSHOT"
    ) ++ (args flatMap {
      case url => publishTarget(url)
    }) ++ noDocs
  }

  /** Set up the environment for `validate/publish-core`.
    * The optional argument is the Artifactory snapshot repository URL. */
  def setupPublishCore = setup("setupPublishCore") { args =>
    Seq(
      Global / baseVersionSuffix := "SHA-SNAPSHOT",
    ) ++ (args flatMap {
      case url => publishTarget(url)
    }) ++ noDocs ++ enableOptimizer
  }

  /** Set up the environment for `validate/test`.
    * The optional argument is the Artifactory snapshot repository URL. */
  def setupValidateTest = setup("setupValidateTest") { args =>
    Seq(
      // include sha to prevent multiple builds running on the same jenkins worker from overriding each other
      // sbtTest/scripted uses publishLocal
      Global / baseVersionSuffix := "SHA-TEST-SNAPSHOT",
      LocalProject("test") / IntegrationTest / testOptions ++= Seq(Tests.Argument("--show-log"), Tests.Argument("--show-diff"))
    ) ++ (args flatMap {
      case url => Seq(Global / resolvers += "scala-pr" at url)
    }) ++ enableOptimizer
  }

  /** Set up the environment for building STARR in `validate/bootstrap`. The arguments are:
    * - Repository URL for publishing
    * - Version number to publish */
  def setupBootstrapStarr = setup("setupBootstrapStarr") { case Seq(fileOrUrl, ver) =>
    val url = fileToUrl(fileOrUrl)
    Seq(
      Global / baseVersion := ver,
      Global / baseVersionSuffix := "SPLIT"
    ) ++ publishTarget(url) ++ noDocs ++ enableOptimizer
  }

  /** Set up the environment for building locker in `validate/bootstrap`. The arguments are:
    * - Repository file or URL for publishing locker and resolving STARR
    * - Version number to publish */
  def setupBootstrapLocker = setup("setupBootstrapLocker") { case Seq(fileOrUrl, ver) =>
    val url = fileToUrl(fileOrUrl)
    Seq(
      Global / baseVersion := ver,
      Global / baseVersionSuffix := "SPLIT",
      Global / resolvers += "scala-pr" at url
    ) ++ publishTarget(url) ++ noDocs ++ enableOptimizer
  }

  /** Set up the environment for building quick in `validate/bootstrap`. The arguments are:
    * - Repository URL for publishing
    * - Version number to publish
    * - Optional: Repository for resolving (same as repository for publishing if not specified)
    * Note that the artifacts produced here are consumed by scala-dist, so the docs have to be built.
    */
  def setupBootstrapQuick = setup("setupBootstrapQuick") { case Seq(targetFileOrUrl, ver, resolverFileOrUrl) =>
    val targetUrl = fileToUrl(targetFileOrUrl)
    val resolverUrl = fileToUrl(resolverFileOrUrl)
    Seq(
      Global / baseVersion := ver,
      Global / baseVersionSuffix := "SPLIT",
      Global / resolvers += "scala-pr" at resolverUrl,
      LocalProject("test") / IntegrationTest / testOptions ++= Seq(Tests.Argument("--show-log"), Tests.Argument("--show-diff"))
    ) ++ publishTarget(targetUrl) ++ enableOptimizer
  }

  /** Set up the environment for publishing in `validate/bootstrap`. The arguments are:
    * - Temporary bootstrap repository URL for resolving modules
    * - Version number to publish
    * All artifacts are published to Sonatype. */
  def setupBootstrapPublish = setup("setupBootstrapPublish") { case Seq(fileOrUrl, ver) =>
    val url = fileToUrl(fileOrUrl)
    Seq(
      Global / baseVersion := ver,
      Global / baseVersionSuffix := "SPLIT",
      Global / resolvers += "scala-pr" at url,
      Global / publishTo := Some("sonatype-releases" at "https://oss.sonatype.org/service/local/staging/deploy/maven2"),
      Global / credentials ++= {
        val user = env("SONA_USER")
        val pass = env("SONA_PASS")
        if (user != "" && pass != "")
         List(Credentials("Sonatype Nexus Repository Manager", "oss.sonatype.org", user, pass))
        else Nil
      }
      // pgpSigningKey and pgpPassphrase are set externally by travis / the bootstrap script, as the sbt-pgp plugin is not enabled by default
    ) ++ enableOptimizer
  }

  def enableOptimizerCommand = setup("enableOptimizer")(_ => enableOptimizer)

  /** For local dev: sets `scalaVersion` to the version in `/buildcharacter.properties` or the given arg.
   * Running `reload` will re-read the build files, resetting `scalaVersion`. */
  def restarr = Command("restarr")(_ => (Space ~> token(StringBasic, "scalaVersion")).?) { (state, argSv) =>
    val x     = Project.extract(state)
    val oldSv = x.get(Global / scalaVersion)
    val newSv = argSv.getOrElse(readVersionFromPropsFile(state))
    state.log.info(s"Re-STARR'ing: setting scalaVersion from $oldSv to $newSv (`reload` to undo; IntelliJ still uses $oldSv)")
    val settings = Def.settings(
      Global    / scalaVersion   := newSv, // don't use version.value or it'll be a wrong, new value
      ThisBuild / target         := (ThisBuild / baseDirectory).value / "target-restarr",
      ThisBuild / buildDirectory := (ThisBuild / baseDirectory).value /  "build-restarr",
    )
    x.appendWithSession(settings, state)
  }

  /** For local dev: publishes locally (without optimizing) & then sets the new `scalaVersion`.
   * Also it generates `/buildcharacter.properties` which is the default used by `restarr`. */
  def restarrFull = Command.command("restarrFull") { state =>
    setupPublishCoreNonOpt.nameOption.get ::
        generateBuildCharacterPropertiesFile.key.label ::
        publishLocal.key.label ::
        restarr.nameOption.get ::
        state
  }

  private def readVersionFromPropsFile(state: State): String = {
    val propsFile = file("buildcharacter.properties")
    if (!propsFile.exists())
      throw new MessageOnlyException("No buildcharacter.properties found - try restarrFull")
    val props = readProps(propsFile)
    val newVersion = props("maven.version.number")
    val fullVersion = props("version.number")
    state.log.info(s"Read STARR version from buildcharacter.properties: $newVersion (full version: $fullVersion)")
    newVersion
  }

  private[this] def setup(name: String)(f: Seq[String] => Seq[Setting[_]]) = Command.args(name, name) { case (state, seq) =>
    Project.extract(state).appendWithSession(f(seq), state)
  }

  private[this] val enableOptimizer = Seq(
    //ThisBuild / Compile / scalacOptions ++= Seq("-opt:inline:scala/**")
    ThisBuild / Compile / scalacOptions ++= Seq("-opt:l:inline", "-opt-inline-from:scala/**")
  )

  val noDocs = Seq(
    ThisBuild / Compile / packageDoc / publishArtifact := false
  )

  private[this] def publishTarget(url: String) = {
    // Append build.timestamp to Artifactory URL to get consistent build numbers (see https://github.com/sbt/sbt/issues/2088):
    val url2 = if(url.startsWith("file:")) url else url.replaceAll("/$", "") + ";build.timestamp=" + System.currentTimeMillis

    Seq(
      Global / publishTo := Some("scala-pr-publish" at url2),
      Global / credentials ++= {
        val pass = env("PRIVATE_REPO_PASS")
        if (pass != "")
          List(Credentials("Artifactory Realm", "scala-ci.typesafe.com", "scala-ci", pass))
        else Nil
      }
    )
  }

  // If fileOrUrl is already a file:, http: or https: URL, return it, otherwise treat it as a local file and return a URL for it
  private[this] def fileToUrl(fileOrUrl: String): String =
    if(fileOrUrl.startsWith("file:") || fileOrUrl.startsWith("http:") || fileOrUrl.startsWith("https:")) fileOrUrl
    else Paths.get(fileOrUrl).toUri.toString

  /** Like `Def.sequential` but accumulate all results */
  def sequence[B](tasks: List[Def.Initialize[Task[B]]]): Def.Initialize[Task[List[B]]] = tasks match {
    case Nil => Def.task { Nil }
    case x :: xs => Def.taskDyn {
      val v = x.value
      sequence(xs).apply((t: Task[List[B]]) => t.map(l => v :: l))
    }
  }
}