Add docker:clean task

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

@@ -7,6 +7,7 @@ import java.util.concurrent.atomic.AtomicBoolean
 import sbt._
 import sbt.Keys.{
   cacheDirectory,
+  clean,
   mappings,
   name,
   publish,
@@ -94,6 +95,7 @@ object DockerPlugin extends AutoPlugin {
         else
           Seq()
       ),
+      dockerRmiCommand := dockerExecCommand.value ++ Seq("rmi"),
       dockerBuildCommand := dockerExecCommand.value ++ Seq("build") ++ dockerBuildOptions.value ++ Seq("."),
       dockerCommands := {
       val dockerBaseDirectory = (defaultLinuxInstallLocation in Docker).value
@@ -129,6 +131,14 @@ object DockerPlugin extends AutoPlugin {
         if (dockerUpdateLatest.value) {
           publishDocker(dockerExecCommand.value, alias.latest, log)
         }
+      },
+        clean := {
+        val alias = dockerAlias.value
+        val log = streams.value.log
+        rmiDocker(dockerRmiCommand.value, alias.versioned, log)
+        if (dockerUpdateLatest.value) {
+          rmiDocker(dockerRmiCommand.value, alias.latest, log)
+        }
       },
         sourceDirectory := sourceDirectory.value / "docker",
         stage := Stager.stage(Docker.name)(streams.value, stagingDirectory.value, mappings.value),
@@ -314,6 +324,29 @@ object DockerPlugin extends AutoPlugin {
       throw new RuntimeException("Nonzero exit value: " + ret)
   }
 
+  def rmiDocker(execCommand: Seq[String], tag: String, log: Logger): Unit = {
+    def rmiDockerLogger(log: Logger) = new ProcessLogger {
+      def error(err: => String): Unit = err match {
+        case s if !s.trim.isEmpty => log.error(s)
+        case s =>
+      }
+
+      def info(inf: => String): Unit = log.info(inf)
+
+      def buffer[T](f: => T): T = f
+    }
+
+    log.debug(s"Removing ${tag}")
+
+    val cmd = execCommand :+ tag
+    val ret = Process(cmd) ! rmiDockerLogger(log)
+
+    if (ret != 0)
+      sys.error(s"Nonzero exit value: ${ret}")
+    else
+      log.info(s"Removed image ${tag}")
+  }
+
   def publishDocker(execCommand: Seq[String], tag: String, log: Logger): Unit = {
     val loginRequired = new AtomicBoolean(false)
 

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

@@ -31,6 +31,8 @@ trait DockerKeys {
   val dockerBuildOptions = SettingKey[Seq[String]]("dockerBuildOptions", "Options used for the Docker build")
   val dockerBuildCommand = SettingKey[Seq[String]]("dockerBuildCommand", "Command for building the Docker image")
   val dockerLabels = SettingKey[Map[String, String]]("dockerLabels", "Labels applied to the Docker image")
+  val dockerRmiCommand =
+    SettingKey[Seq[String]]("dockerRmiCommand", "Command for removing the Docker image from the local registry")
 
   val dockerCommands = TaskKey[Seq[CmdLike]]("dockerCommands", "List of docker commands that form the Dockerfile")
 }

src/sbt-test/docker/rmi/build.sbt

@@ -0,0 +1,8 @@
+enablePlugins(DockerPlugin)
+enablePlugins(JavaAppPackaging)
+
+name := "rmi"
+
+version := "0.1.0"
+
+maintainer := "Tim Steinbach <[email protected]>"

src/sbt-test/docker/rmi/project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % sys.props("project.version"))

src/sbt-test/docker/rmi/src/main/scala/Main.scala

@@ -0,0 +1,3 @@
+object Main extends App {
+  println("Hello world")
+}

src/sbt-test/docker/rmi/test

@@ -0,0 +1,5 @@
+# Generate the Docker image locally
+> docker:publishLocal
+$ exec bash -c 'docker images | grep rmi'
+> docker:clean
+$ exec bash -c '[[ $(docker images) != *"rmi"* ]]'

src/sphinx/formats/docker.rst

@@ -140,6 +140,10 @@ Publishing Settings
     Overrides the default Docker build command. The reason for this is that many systems restrict docker execution to root, and while the accepted guidance is to alias the docker command ``alias docker='/usr/bin/docker'``, neither Java nor Scala support passing aliases to sub-processes, and most build systems run builds using a non-login, non-interactive shell, which also have limited support for aliases, which means that the only viable option is to use ``sudo docker`` directly.
     Defaults to ``Seq("[dockerExecCommand]", "build", "[dockerBuildOptions]", ".")``.
 
+  ``dockerRmiCommand``
+    Overrides the default Docker rmi command. This may be used if force flags or other options need to be passed to the command ``docker rmi``.
+    Defaults to ``Seq("[dockerExecCommand]", "rmi")`` and will be directly appended with the image name and tag.
+
 Tasks
 -----
 The Docker plugin provides the following commands:
@@ -153,6 +157,9 @@ The Docker plugin provides the following commands:
   ``docker:publish``
     Builds an image using the local Docker server, and pushes it to the configured remote repository.
 
+  ``docker:clean``
+    Removes the built image from the local Docker server.
+
 
 Customize
 ---------