Replace dockerVersion with dockerApiVersion (#1296)

* Add dockerApiVersion validation

* Fix typo

* Move `dockerApiVersion` to `DockerKeysEx`

* Restore previous methods as deprecated for compatibility issues

* Update docs

* Set `sbtApiVersion` for integration test

Author: rodrigorn

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

@@ -0,0 +1,14 @@
+package com.typesafe.sbt.packager.docker
+
+import scala.util.matching.Regex
+
+case class DockerApiVersion(major: Int, minor: Int)
+
+object DockerApiVersion {
+  private val DockerApiVersionPattern: Regex = """^'?([0-9]+)\.([0-9]+)'?$""".r
+
+  def parse(version: String): Option[DockerApiVersion] =
+    Option(version).collect {
+      case DockerApiVersionPattern(major, minor) => new DockerApiVersion(major.toInt, minor.toInt)
+    }
+}

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

@@ -111,6 +111,11 @@ object DockerPlugin extends AutoPlugin {
     dockerVersion := Try(Process(dockerExecCommand.value ++ Seq("version", "--format", "'{{.Server.Version}}'")).!!).toOption
       .map(_.trim)
       .flatMap(DockerVersion.parse),
+    dockerApiVersion := Try(
+      Process(dockerExecCommand.value ++ Seq("version", "--format", "'{{.Server.APIVersion}}'")).!!
+    ).toOption
+      .map(_.trim)
+      .flatMap(DockerApiVersion.parse),
     dockerBuildOptions := Seq("--force-rm") ++ dockerAliases.value.flatMap { alias =>
       Seq("-t", alias.toString)
     },
@@ -243,8 +248,8 @@ object DockerPlugin extends AutoPlugin {
         nonEmptyMappings((mappings in Docker).value),
         filesExist((mappings in Docker).value),
         validateExposedPorts(dockerExposedPorts.value, dockerExposedUdpPorts.value),
-        validateDockerVersion(dockerVersion.value),
-        validateDockerPermissionStrategy(dockerPermissionStrategy.value, dockerVersion.value)
+        validateDockerVersion(dockerApiVersion.value),
+        validateDockerPermissionStrategy(dockerPermissionStrategy.value, dockerVersion.value, dockerApiVersion.value)
       ),
       dockerPackageMappings := MappingsHelper.contentOf(sourceDirectory.value),
       dockerGenerateConfig := {
@@ -638,8 +643,8 @@ object DockerPlugin extends AutoPlugin {
     }
   }
 
-  private[this] def validateDockerVersion(dockerVersion: Option[DockerVersion]): Validation.Validator = () => {
-    dockerVersion match {
+  private[this] def validateDockerVersion(dockerApiVersion: Option[DockerApiVersion]): Validation.Validator = () => {
+    dockerApiVersion match {
       case Some(_) => List.empty
       case None =>
         List(
@@ -649,7 +654,7 @@ object DockerPlugin extends AutoPlugin {
             howToFix = """|sbt-native packager tries to parse the `docker version` output. This can fail if
              |
              |  - the output has changed:
-             |    $ docker version --format '{{.Server.Version}}'
+             |    $ docker version --format '{{.Server.APIVersion}}'
              |
              |  - no `docker` executable is available
              |    $ which docker
@@ -658,52 +663,53 @@ object DockerPlugin extends AutoPlugin {
              |
              |You can display the parsed docker version in the sbt console with:
              |
-             |  sbt:your-project> show dockerVersion
+             |  sbt:your-project> show dockerApiVersion
              |
              |As a last resort you could hard code the docker version, but it's not recommended!!
              |
-             |  import com.typesafe.sbt.packager.docker.DockerVersion
-             |  dockerVersion := Some(DockerVersion(18, 9, 0, Some("ce"))
+             |  import com.typesafe.sbt.packager.docker.DockerApiVersion
+             |  dockerApiVersion := Some(DockerApiVersion(1, 40))
           """.stripMargin
           )
         )
     }
   }
 
   private[this] def validateDockerPermissionStrategy(strategy: DockerPermissionStrategy,
-                                                     dockerVersion: Option[DockerVersion]): Validation.Validator =
+                                                     dockerVersion: Option[DockerVersion],
+                                                     dockerApiVersion: Option[DockerApiVersion]): Validation.Validator =
     () => {
-      (strategy, dockerVersion) match {
-        case (DockerPermissionStrategy.MultiStage, Some(ver)) if !DockerSupport.multiStage(ver) =>
+      (strategy, dockerVersion, dockerApiVersion) match {
+        case (DockerPermissionStrategy.MultiStage, Some(ver), Some(apiVer)) if !DockerSupport.multiStage(ver, apiVer) =>
           List(
             ValidationError(
               description =
                 s"The detected Docker version $ver is not compatible with DockerPermissionStrategy.MultiStage",
               howToFix =
                 """|sbt-native packager tries to parse the `docker version` output.
-             |To use multi-stage build, upgrade your Docker, pick another strategy, or override dockerVersion:
+             |To use multi-stage build, upgrade your Docker, pick another strategy, or override dockerApiVersion:
              |
              |  import com.typesafe.sbt.packager.docker.DockerPermissionStrategy
              |  dockerPermissionStrategy := DockerPermissionStrategy.Run
              |
-             |  import com.typesafe.sbt.packager.docker.DockerVersion
-             |  dockerVersion := Some(DockerVersion(18, 9, 0, Some("ce"))
+             |  import com.typesafe.sbt.packager.docker.DockerApiVersion
+             |  dockerApiVersion := Some(DockerApiVersion(1, 40))
           """.stripMargin
             )
           )
-        case (DockerPermissionStrategy.CopyChown, Some(ver)) if !DockerSupport.chownFlag(ver) =>
+        case (DockerPermissionStrategy.CopyChown, Some(ver), Some(apiVer)) if !DockerSupport.chownFlag(ver, apiVer) =>
           List(
             ValidationError(
               description =
                 s"The detected Docker version $ver is not compatible with DockerPermissionStrategy.CopyChown",
               howToFix = """|sbt-native packager tries to parse the `docker version` output.
-             |To use --chown flag, upgrade your Docker, pick another strategy, or override dockerVersion:
+             |To use --chown flag, upgrade your Docker, pick another strategy, or override dockerApiVersion:
              |
              |  import com.typesafe.sbt.packager.docker.DockerPermissionStrategy
              |  dockerPermissionStrategy := DockerPermissionStrategy.Run
              |
-             |  import com.typesafe.sbt.packager.docker.DockerVersion
-             |  dockerVersion := Some(DockerVersion(18, 9, 0, Some("ce"))
+             |  import com.typesafe.sbt.packager.docker.DockerApiVersion
+             |  dockerApiVersion := Some(DockerApiVersion(1, 40))
           """.stripMargin
             )
           )

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

@@ -52,7 +52,12 @@ object DockerSpotifyClientPlugin extends AutoPlugin {
 
   override lazy val projectSettings: Seq[Setting[_]] = inConfig(Docker)(clientSettings)
 
-  def clientSettings = Seq(publishLocal := publishLocalDocker.value, dockerVersion := dockerServerVersion.value)
+  def clientSettings =
+    Seq(
+      publishLocal := publishLocalDocker.value,
+      dockerVersion := dockerServerVersion.value,
+      dockerApiVersion := dockerServerApiVersion.value
+    )
 
   def publishLocalDocker: Def.Initialize[Task[Unit]] = Def.task {
     val context = stage.value
@@ -71,6 +76,11 @@ object DockerSpotifyClientPlugin extends AutoPlugin {
     docker.dockerServerVersion()
   }
 
+  def dockerServerApiVersion: Def.Initialize[Task[Option[DockerApiVersion]]] = Def.task {
+    val docker = new DockerClientTask()
+    docker.dockerServerApiVersion()
+  }
+
 }
 
 /**
@@ -111,4 +121,9 @@ private class DockerClientTask {
     val docker: DockerClient = DefaultDockerClient.fromEnv().build()
     DockerVersion.parse(docker.version().version())
   }
+
+  def dockerServerApiVersion(): Option[DockerApiVersion] = {
+    val docker: DockerClient = DefaultDockerClient.fromEnv().build()
+    DockerApiVersion.parse(docker.version().apiVersion())
+  }
 }

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

@@ -2,9 +2,17 @@ package com.typesafe.sbt.packager.docker
 
 object DockerSupport {
 
+  @deprecated
   def chownFlag(version: DockerVersion): Boolean =
     (version.major == 17 && version.minor >= 9) || version.major > 17
 
+  @deprecated
   def multiStage(version: DockerVersion): Boolean =
     (version.major == 17 && version.minor >= 5) || version.major > 17
+
+  def chownFlag(version: DockerVersion, apiVersion: DockerApiVersion): Boolean =
+    ((version.major == 17 && version.minor >= 9) || version.major > 17) || (apiVersion.major == 1 && apiVersion.minor >= 32)
+
+  def multiStage(version: DockerVersion, apiVersion: DockerApiVersion): Boolean =
+    ((version.major == 17 && version.minor >= 5) || version.major > 17) || (apiVersion.major == 1 && apiVersion.minor >= 29)
 }

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

@@ -56,4 +56,5 @@ private[packager] trait DockerKeysEx extends DockerKeys {
   lazy val dockerChmodType = settingKey[DockerChmodType]("The file permissions for the files copied into Docker image.")
   lazy val dockerAdditionalPermissions =
     taskKey[Seq[(DockerChmodType, String)]]("Explicit chmod calls to some of the paths.")
+  val dockerApiVersion = TaskKey[Option[DockerApiVersion]]("dockerApiVersion", "The docker server api version")
 }

src/sbt-test/docker/file-permission/changes/dockerversion.sbt

@@ -1,3 +1,4 @@
 import com.typesafe.sbt.packager.docker._
 
 dockerVersion := Some(DockerVersion(1, 13, 0, None))
+dockerApiVersion := Some(DockerApiVersion(1, 28))

src/sphinx/formats/docker.rst

@@ -142,6 +142,9 @@ Environment Settings
   ``dockerVersion``
     The docker server version. Used to leverage new docker features while maintaining backwards compatibility.
 
+  ``dockerApiVersion``
+    The docker server API version. Used to leverage new docker features while maintaining backwards compatibility.
+
 Publishing Settings
 ~~~~~~~~~~~~~~~~~~~
 

src/test/scala/com/typesafe/sbt/packager/docker/DockerApiVersionSpec.scala

@@ -0,0 +1,10 @@
+package com.typesafe.sbt.packager.docker
+
+import org.scalatest._
+
+class DockerApiVersionSpec extends FlatSpec with DiagrammedAssertions {
+  "DockerApiVersion" should "parse 1.40" in {
+    val v = DockerApiVersion.parse("1.40")
+    assert(v == Some(DockerApiVersion(1, 40)))
+  }
+}