[Docker] add multiple docker tags support (#1138)

* add multiple docker tags support

* refactor, fix scripted tests

* refactor DockerAlias, add dockerUntaggedImage

* avoid mutable tags value

* scalafmt

* fix docker publishing

* fix ProgressHandler, alias test

* add docs

* more readable apis in DockerAlias class

* update docs

* update sbt-scalafmt to 1.15

* fix scripted test

* clean and rerun scalafmt

Author: kimxogus

project/plugins.sbt

@@ -12,4 +12,4 @@ libraryDependencies += "jline" % "jline" % "2.11"
 addSbtPlugin("org.foundweekends" % "sbt-bintray" % "0.5.1")
 
 // For code formatting
-addSbtPlugin("com.lucidchart" % "sbt-scalafmt" % "1.10")
+addSbtPlugin("com.lucidchart" % "sbt-scalafmt" % "1.15")

src/main/scala/com/typesafe/sbt/packager/Hashing.scala

@@ -19,7 +19,7 @@ object Hashing {
     try {
       def read(): Unit = in.read(buffer) match {
         case x if x <= 0 => ()
-        case size => md.update(buffer, 0, size); read()
+        case size        => md.update(buffer, 0, size); read()
       }
       read()
     } finally in.close()

src/main/scala/com/typesafe/sbt/packager/archetypes/MaintainerScriptHelper.scala

@@ -65,10 +65,9 @@ trait MaintainerScriptHelper {
     * @return maintainerScripts with appended `scripts`
     * @see [[maintainerScriptsAppendFromFile]]
     */
-  def maintainerScriptsAppend(
-    current: Map[String, Seq[String]] = Map.empty,
-    replacements: Seq[(String, String)] = Nil
-  )(scripts: (String, String)*): Map[String, Seq[String]] = {
+  def maintainerScriptsAppend(current: Map[String, Seq[String]] = Map.empty, replacements: Seq[(String, String)] = Nil)(
+    scripts: (String, String)*
+  ): Map[String, Seq[String]] = {
     val appended = scripts.map {
       case (key, script) =>
         key -> TemplateWriter.generateScriptFromLines((current.getOrElse(key, Seq.empty) :+ script), replacements)

src/main/scala/com/typesafe/sbt/packager/archetypes/scripts/BashStartScriptKeys.scala

@@ -20,10 +20,8 @@ trait BashStartScriptKeys {
        |""".stripMargin
   )
 
-  val bashScriptDefines = TaskKey[Seq[String]](
-    "bashScriptDefines",
-    "A list of definitions that should be written to the bash file template."
-  )
+  val bashScriptDefines =
+    TaskKey[Seq[String]]("bashScriptDefines", "A list of definitions that should be written to the bash file template.")
   val bashScriptExtraDefines = TaskKey[Seq[String]](
     "bashScriptExtraDefines",
     "A list of extra definitions that should be written to the bash file template."

src/main/scala/com/typesafe/sbt/packager/archetypes/scripts/BashStartScriptPlugin.scala

@@ -129,10 +129,8 @@ object BashStartScriptPlugin extends AutoPlugin with ApplicationIniGenerator wit
     else
       ""
 
-  override protected[this] def createReplacementsForMainScript(
-    mainClass: String,
-    mainClasses: Seq[String],
-    config: SpecializedScriptConfig
-  ): Seq[(String, String)] =
+  override protected[this] def createReplacementsForMainScript(mainClass: String,
+                                                               mainClasses: Seq[String],
+                                                               config: SpecializedScriptConfig): Seq[(String, String)] =
     Seq("app_mainclass" -> mainClass, "available_main_classes" -> usageMainClassReplacement(mainClasses)) ++ config.replacements
 }

src/main/scala/com/typesafe/sbt/packager/archetypes/scripts/BatStartScriptPlugin.scala

@@ -101,7 +101,9 @@ object BatStartScriptPlugin extends AutoPlugin with ApplicationIniGenerator with
     def apply(name: String): Seq[(String, String)] =
       Seq("APP_NAME" -> name, "APP_ENV_NAME" -> NameHelper.makeEnvFriendlyName(name))
 
-    def appDefines(mainClass: String, config: BatScriptConfig, replacements: Seq[(String, String)]): (String, String) = {
+    def appDefines(mainClass: String,
+                   config: BatScriptConfig,
+                   replacements: Seq[(String, String)]): (String, String) = {
       val defines = Seq(makeWindowsRelativeClasspathDefine(config.scriptClasspath), Defines.mainClass(mainClass)) ++
         config.configLocation.map(Defines.configFileDefine) ++
         config.extraDefines
@@ -140,11 +142,9 @@ object BatStartScriptPlugin extends AutoPlugin with ApplicationIniGenerator with
       }
   }
 
-  override protected[this] def createReplacementsForMainScript(
-    mainClass: String,
-    mainClasses: Seq[String],
-    config: SpecializedScriptConfig
-  ): Seq[(String, String)] =
+  override protected[this] def createReplacementsForMainScript(mainClass: String,
+                                                               mainClasses: Seq[String],
+                                                               config: SpecializedScriptConfig): Seq[(String, String)] =
     config.replacements :+ Replacements.appDefines(mainClass, config, config.replacements)
 
 }

src/main/scala/com/typesafe/sbt/packager/archetypes/scripts/StartScriptMainClassConfig.scala

@@ -45,7 +45,7 @@ object StartScriptMainClassConfig {
     (mainClass, additionalMainClasses) match {
       // only one main - create the default script
       case (Some(main), Seq()) => SingleMain(main)
-      case (None, Seq(main)) => SingleMain(main)
+      case (None, Seq(main))   => SingleMain(main)
       // main explicitly set and multiple discoveredMainClasses
       case (Some(main), additional) => ExplicitMainWithAdditional(main, additional)
       // no main class at all

src/main/scala/com/typesafe/sbt/packager/debian/DebianPlugin.scala

@@ -382,9 +382,7 @@ trait DebianPluginLike {
 
   private[debian] final def validateUserGroupNames(user: String, streams: TaskStreams): Unit = {
     if ((UserNamePattern findFirstIn user).isEmpty) {
-      streams.log.warn(
-        "The user or group '" + user + "' may contain invalid characters for Debian based distributions"
-      )
+      streams.log.warn("The user or group '" + user + "' may contain invalid characters for Debian based distributions")
     }
     if (user.length > 32) {
       streams.log.warn(

src/main/scala/com/typesafe/sbt/packager/debian/Keys.scala

@@ -16,10 +16,8 @@ trait DebianKeys {
     SettingKey[Seq[String]]("debian-package-dependencies", "Packages that this debian package depends on.")
   val debianPackageProvides =
     SettingKey[Seq[String]]("debian-package-provides", "Packages that are provided by the currently packaged one.")
-  val debianPackageRecommends = SettingKey[Seq[String]](
-    "debian-package-recommends",
-    "Packages recommended to use with the currently packaged one."
-  )
+  val debianPackageRecommends =
+    SettingKey[Seq[String]]("debian-package-recommends", "Packages recommended to use with the currently packaged one.")
   val debianPackageInfo =
     SettingKey[PackageInfo]("debian-package-info", "Information (name, version, etc.) about a debian package.")
   val debianPackageMetadata =

src/main/scala/com/typesafe/sbt/packager/docker/DockerAlias.scala

@@ -10,11 +10,18 @@ package com.typesafe.sbt.packager.docker
   * @param tag Optional tag for the image, e.g. the version
   */
 case class DockerAlias(registryHost: Option[String], username: Option[String], name: String, tag: Option[String]) {
-  protected val untagged = registryHost.map(_ + "/").getOrElse("") + username.map(_ + "/").getOrElse("") + name
 
-  /** Tag with (optional) given version */
-  val versioned = untagged + tag.map(":" + _).getOrElse("")
+  def withRegistryHost(registryHost: Option[String]): DockerAlias = copy(registryHost = registryHost)
 
-  /** Tag with version 'latest' */
-  val latest = s"$untagged:latest"
+  def withUsername(username: Option[String]): DockerAlias = copy(username = username)
+
+  def withName(name: String): DockerAlias = copy(name = name)
+
+  def withTag(tag: Option[String]): DockerAlias = copy(tag = tag)
+
+  override def toString: String =
+    registryHost.map(_ + "/").getOrElse("") +
+      username.map(_ + "/").getOrElse("") +
+      name +
+      tag.map(":" + _).getOrElse("")
 }