Merge pull request #94 from Tapad/feature/versionTagOverride

Adding 'composeServiceVersionTask' to allow for overrriding of the de…

Author: kurtkopchik

README.md

@@ -58,6 +58,7 @@ plugin will attempt to locate it in one of three places with the precedence orde
    ```
     composeFile := // Specify the full path to the Compose File to use to create your test instance. It defaults to docker-compose.yml in your resources folder.   
     composeServiceName := // Specify the name of the service in the Docker Compose file being tested. This setting prevents the service image from being pull down from the Docker Registry. It defaults to the sbt Project name.
+    composeServiceVersionTask :=  The version to tag locally built images with in the docker-compose file. This defaults to the 'version' SettingKey.
     composeNoBuild := // True if a Docker Compose file is to be started without building any images and only using ones that already exist in the Docker Registry. This defaults to False.
     composeRemoveContainersOnShutdown := // True if a Docker Compose should remove containers when shutting down the compose instance. This defaults to True.
     composeRemoveNetworkOnShutdown := // True if a Docker Compose should remove the network it created when shutting down the compose instance. This defaults to True.

src/main/scala/com/tapad/docker/ComposeFile.scala

@@ -71,7 +71,7 @@ trait ComposeFile extends SettingsHelper with ComposeCustomTagHelpers with Print
       //compose file
       val (updatedImageName, imageSource) = if (!useExistingImages && serviceName == localService) {
         //If the image does not contain a tag or has the tag "latest" it will not be replaced
-        (replaceDefinedVersionTag(imageName, getSetting(version)), buildImageSource)
+        (replaceDefinedVersionTag(imageName, getComposeServiceVersion(state)), buildImageSource)
       } else if (imageName.toLowerCase.contains(useLocalBuildTag)) {
         (processImageTag(state, args, imageName), buildImageSource)
       } else if (imageName.toLowerCase.contains(skipPullTag) || containsArg(DockerComposePlugin.skipPullArg, args)) {
@@ -138,6 +138,18 @@ trait ComposeFile extends SettingsHelper with ComposeCustomTagHelpers with Print
     }
   }
 
+  /**
+   * Gets the version to use for local image tagging in docker compose
+   * @param state The sbt state
+   * @return The version to use for local image tagging in docker compose
+   */
+  def getComposeServiceVersion(implicit state: State): String = {
+    val extracted = Project.extract(state)
+    val (_, version) = extracted.runTask(composeServiceVersionTask, state)
+
+    version
+  }
+
   def getUnsupportedFieldErrorMsg(fieldName: String): String = {
     s"Docker Compose field '$fieldName:' is currently not supported by sbt-docker-compose. Please see the README for " +
       s"more information on the set of unsupported fields."

src/main/scala/com/tapad/docker/DockerComposeKeys.scala

@@ -8,6 +8,7 @@ object DockerComposeKeys extends DockerComposeKeysLocal
 trait DockerComposeKeysLocal {
   val composeFile = settingKey[String]("Specify the full path to the Compose File to use to create your test instance. It defaults to docker-compose.yml in your resources folder.")
   val composeServiceName = settingKey[String]("The name of the service in the Docker Compose file being tested. This setting prevents the service image from being pull down from the Docker Registry. This defaults to the Project name.")
+  val composeServiceVersionTask = taskKey[String]("The version to tag locally built images with in the docker-compose file. This defaults to the 'version' SettingKey.")
   val composeNoBuild = settingKey[Boolean]("True if a Docker Compose file is to be started without building any images and only using ones that already exist in the Docker Registry. This defaults to False.")
   val composeRemoveContainersOnShutdown = settingKey[Boolean]("True if a Docker Compose should remove containers when shutting down the compose instance. This defaults to True.")
   val composeRemoveNetworkOnShutdown = settingKey[Boolean]("True if a Docker Compose should remove the network it created when shutting down the compose instance. This defaults to True.")

src/main/scala/com/tapad/docker/DockerComposePlugin.scala

@@ -62,6 +62,7 @@ object DockerComposePlugin extends DockerComposePluginLocal {
   object autoImport {
     val composeFile = DockerComposeKeys.composeFile
     val composeServiceName = DockerComposeKeys.composeServiceName
+    val composeServiceVersionTask = DockerComposeKeys.composeServiceVersionTask
     val composeNoBuild = DockerComposeKeys.composeNoBuild
     val composeRemoveContainersOnShutdown = DockerComposeKeys.composeRemoveContainersOnShutdown
     val composeRemoveNetworkOnShutdown = DockerComposeKeys.composeRemoveNetworkOnShutdown

src/main/scala/com/tapad/docker/DockerComposeSettings.scala

@@ -26,6 +26,7 @@ trait DockerComposeSettingsLocal extends PrintFormatting {
     },
     // By default set the Compose service name to be that of the sbt Project Name
     composeServiceName := name.value.toLowerCase,
+    composeServiceVersionTask := version.value,
     composeNoBuild := false,
     composeRemoveContainersOnShutdown := true,
     composeRemoveNetworkOnShutdown := true,

src/test/scala/ComposeFileProcessingSpec.scala

@@ -381,6 +381,7 @@ class ComposeFileProcessingSpec extends FunSuite with BeforeAndAfter with OneIns
     doReturn(versionNumber).when(composeMock).getSetting(version)(null)
     doReturn(noBuild).when(composeMock).getSetting(composeNoBuild)(null)
     doReturn(false).when(composeMock).getSetting(suppressColorFormatting)(null)
+    doReturn(versionNumber).when(composeMock).getComposeServiceVersion(null)
 
     (composeMock, composeFilePath)
   }

src/test/scala/PrintFormattingSpec.scala

@@ -118,6 +118,7 @@ class PrintFormattingSpec extends FunSuite with BeforeAndAfter with OneInstanceP
     doReturn(versionNumber).when(composeMock).getSetting(version)(null)
     doReturn(noBuild).when(composeMock).getSetting(composeNoBuild)(null)
     doReturn(containerHost).when(composeMock).getContainerHost(any[String], any[String], any[JValue])
+    doReturn("1.0.0").when(composeMock).getComposeServiceVersion(null)
 
     serviceNames.zip(containerIds).foreach {
       case (serviceName, containerId) =>