Prevent native packager bin-compat issues

build.sbt

@@ -48,6 +48,7 @@ lazy val root = (project in file("."))
       IO.write(versionFile, versionSource)
 
       Seq(versionFile)
+
     }
 
     addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % Versions.nativePackager)

src/main/scala/com/lightbend/rp/sbtreactiveapp/App.scala

@@ -444,10 +444,10 @@ case object BasicApp extends DeployableApp {
           val log = streams.value.log
           val execCommand = dockerExecCommand.value
 
-          publishDocker(execCommand, alias.versioned, log)
+          publishDocker(execCommand, NativePackagerCompat.versioned(alias), log)
 
           if (dockerUpdateLatest.value) {
-            publishDocker(execCommand, alias.latest, log)
+            publishDocker(execCommand, NativePackagerCompat.latest(alias), log)
           }
         }))
 

src/main/scala/com/lightbend/rp/sbtreactiveapp/Deploy.scala

@@ -16,18 +16,14 @@
 
 package com.lightbend.rp.sbtreactiveapp
 
-import com.lightbend.rp.sbtreactiveapp.BasicApp._
-import com.lightbend.rp.sbtreactiveapp.SbtReactiveAppPlugin.localImport._
 import com.lightbend.rp.sbtreactiveapp.SbtReactiveAppPlugin._
-import com.typesafe.sbt.SbtNativePackager
-import com.typesafe.sbt.packager.docker
-import com.typesafe.sbt.packager.docker.DockerPlugin.publishLocalDocker
+import com.lightbend.rp.sbtreactiveapp.SbtReactiveAppPlugin.localImport._
 import com.typesafe.sbt.packager.Keys.stage
+import com.typesafe.sbt.packager.docker.DockerPlugin.publishLocalDocker
+import sbt.Keys._
 import sbt._
 
 import scala.collection.immutable.Seq
-import com.typesafe.sbt.packager.docker.DockerSupport
-import Keys._
 
 trait DeployableApp extends App {
   private val installReactiveSandbox = new java.util.concurrent.atomic.AtomicBoolean(false)
@@ -51,7 +47,6 @@ trait DeployableApp extends App {
     deployMinikubePlayHttpSecretKeyValue := "dev-minikube",
     deploy := {
       import complete.DefaultParsers._
-      import scala.sys.process._
 
       val args = spaceDelimited("<arg>").parsed
       val isPlagom = Set("play", "lagom").contains(appType.value)
@@ -175,7 +170,7 @@ trait DeployableApp extends App {
 
           val rpArgs =
             Vector(
-              dockerAlias.value.versioned,
+              NativePackagerCompat.versioned(dockerAlias.value),
               "--env",
               s"JAVA_OPTS=${javaOpts.mkString(" ")}") ++
               (if (bootstrapEnabled) Vector("--akka-cluster-skip-validation", "--pod-controller-replicas", deployMinikubeAkkaClusterBootstrapContactPoints.value.toString) else Vector.empty) ++
@@ -190,7 +185,7 @@ trait DeployableApp extends App {
               minikubeExec.getAbsolutePath +: dockerBuildCommand.value,
             log)
 
-          log.info(s"Built image ${dockerAlias.value.versioned}")
+          log.info(s"Built image ${NativePackagerCompat.versioned(dockerAlias.value)}")
 
           if (reactiveSandbox) {
             // FIXME: Make tiller & reactive-sandbox names configurable

src/main/scala/com/lightbend/rp/sbtreactiveapp/NativePackagerCompat.scala

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2017 Lightbend, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.lightbend.rp.sbtreactiveapp
+
+import com.typesafe.sbt.packager.docker.DockerAlias
+
+/**
+ * `sbt-native-packager` is not SemVer compliant and classes like `DockerAlias` break binary compatibility
+ * in patch releases. This object provides makes all 1.3.x versions of `sbt-native-packager` compatible.
+ */
+object NativePackagerCompat {
+
+  // removed from `sbt-native-packager` (https://github.com/sbt/sbt-native-packager/pull/1138/files#diff-6aa67d5df515952c884df8bad5ff2ac4L12)
+  def untagged(dockerAlias: DockerAlias): String =
+    dockerAlias.registryHost.map(_ + "/").getOrElse("") +
+      dockerAlias.username.map(_ + "/").getOrElse("") + dockerAlias.name
+
+  // removed from `sbt-native-packager` (https://github.com/sbt/sbt-native-packager/pull/1138/files#diff-6aa67d5df515952c884df8bad5ff2ac4L12)
+  def versioned(dockerAlias: DockerAlias): String = {
+    untagged(dockerAlias) + dockerAlias.tag.map(":" + _).getOrElse("")
+  }
+
+  // removed from `sbt-native-packager` (https://github.com/sbt/sbt-native-packager/pull/1138/files#diff-6aa67d5df515952c884df8bad5ff2ac4L12)
+  def latest(dockerAlias: DockerAlias) = s"${untagged(dockerAlias)}:latest"
+}

src/main/scala/com/lightbend/rp/sbtreactiveapp/SbtReactiveAppPlugin.scala

@@ -19,6 +19,7 @@ package com.lightbend.rp.sbtreactiveapp
 import com.typesafe.sbt.packager.Keys._
 import com.typesafe.sbt.packager.archetypes.scripts.BashStartScriptPlugin
 import com.typesafe.sbt.packager.docker
+import com.typesafe.sbt.packager.docker.DockerKeys
 import sbt.{ Def, _ }
 import sbt.Keys._
 import sbt.plugins.JvmPlugin
@@ -92,7 +93,7 @@ object SbtReactiveAppPlugin extends AutoPlugin {
     }
   }
 
-  object localImport extends docker.DockerKeys
+  val localImport: DockerKeys = docker.DockerPlugin.autoImport
 
   override def requires = SbtReactiveAppPluginAll && docker.DockerPlugin && BashStartScriptPlugin && SbtReactiveAppPluginAll
 

src/sbt-test/sbt-reactive-app/native-packager-cross-version-compat/build.sbt

@@ -0,0 +1,11 @@
+name := "hello"
+scalaVersion := "2.11.12"
+
+lazy val root = (project in file("."))
+  .enablePlugins(SbtReactiveAppPlugin)
+  .settings(
+    packageName in Docker := "hello-play",
+    httpIngressPorts := Seq(9000),
+    httpIngressPaths := Seq("/")
+  )
+

src/sbt-test/sbt-reactive-app/native-packager-cross-version-compat/project/plugins.sbt

@@ -0,0 +1,7 @@
+sys.props.get("plugin.version") match {
+  case Some(x) => addSbtPlugin("com.lightbend.rp" % "sbt-reactive-app" % x)
+  case _ => sys.error("""|The system property 'plugin.version' is not defined.
+                         |Specify this property using the scriptedLaunchOpts -D.""".stripMargin)
+}
+
+addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.3.15")

src/sbt-test/sbt-reactive-app/native-packager-cross-version-compat/src/main/scala/Main.scala

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

src/sbt-test/sbt-reactive-app/native-packager-cross-version-compat/test

@@ -0,0 +1,7 @@
+# This test only checks `sbt` starts successfully into a shell.
+# Since Play 2.6.21 there's a dependency issue between Play's sbt-plugin and sbt-reactive-app where both bring in
+# incompatible versions of `sbt-native-packager`. Users adding both `sbt-reactive-app` and a direct or transitive
+# dependency to an incompatible version of `sbt-reactive-app` would be DoS-ing themselves.
+# Just starting `sbt` is enough to assert the fixes for compat work.
+
+> about

src/sbt-test/sbt-reactive-app/play-endpoints/project/plugins.sbt

@@ -4,5 +4,5 @@ sys.props.get("plugin.version") match {
                          |Specify this property using the scriptedLaunchOpts -D.""".stripMargin)
 }
 
-addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.6.7")
+addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.6.21")