Fix bug where specifying promoteTrack used incorrect release notes an…

…d name (#733) Signed-off-by: Alex Saveau <[email protected]>
Triple-T · Oct 30, 2019 · 0feba82 · 0feba82
1 parent 07dc011
commit 0feba82
Show file tree

Hide file tree

Showing 18 changed files with 244 additions and 25 deletions.
diff --git a/play/plugin/src/main/kotlin/com/github/triplet/gradle/play/tasks/PromoteRelease.kt b/play/plugin/src/main/kotlin/com/github/triplet/gradle/play/tasks/PromoteRelease.kt
@@ -29,15 +29,14 @@ internal abstract class PromoteRelease @Inject constructor(
         }
     }
 
-    abstract class Promoter :
-            ArtifactWorkerBase<ArtifactWorkerBase.ArtifactPublishingParams>() {
+    abstract class Promoter : ArtifactWorkerBase<ArtifactWorkerBase.ArtifactPublishingParams>() {
         override fun upload() {
             edits2.promoteRelease(
                     config.promoteTrackOrDefault,
                     config.fromTrack,
                     config.releaseStatus,
-                    findReleaseName(),
-                    findReleaseNotes(),
+                    findReleaseName(config.promoteTrackOrDefault),
+                    findReleaseNotes(config.promoteTrackOrDefault),
                     config.userFraction,
                     config.retain.artifacts
             )

diff --git a/play/plugin/src/main/kotlin/com/github/triplet/gradle/play/tasks/PublishApk.kt b/play/plugin/src/main/kotlin/com/github/triplet/gradle/play/tasks/PublishApk.kt
@@ -78,8 +78,8 @@ internal abstract class PublishApk @Inject constructor(
                     parameters.skippedMarker.get().asFile.exists(),
                     config.trackOrDefault,
                     config.releaseStatusOrDefault,
-                    findReleaseName(),
-                    findReleaseNotes(),
+                    findReleaseName(config.trackOrDefault),
+                    findReleaseNotes(config.trackOrDefault),
                     config.userFractionOrDefault,
                     config.retain.artifacts
             )

diff --git a/play/plugin/src/main/kotlin/com/github/triplet/gradle/play/tasks/PublishBundle.kt b/play/plugin/src/main/kotlin/com/github/triplet/gradle/play/tasks/PublishBundle.kt
@@ -60,8 +60,8 @@ internal abstract class PublishBundle @Inject constructor(
                     parameters.skippedMarker.get().asFile.exists(),
                     config.trackOrDefault,
                     config.releaseStatusOrDefault,
-                    findReleaseName(),
-                    findReleaseNotes(),
+                    findReleaseName(config.trackOrDefault),
+                    findReleaseNotes(config.trackOrDefault),
                     config.userFractionOrDefault,
                     config.retain.artifacts
             )

diff --git a/...c/main/kotlin/com/github/triplet/gradle/play/tasks/internal/workers/ArtifactWorkerBase.kt b/...c/main/kotlin/com/github/triplet/gradle/play/tasks/internal/workers/ArtifactWorkerBase.kt
@@ -4,7 +4,6 @@ import com.github.triplet.gradle.common.utils.orNull
 import com.github.triplet.gradle.common.utils.readProcessed
 import com.github.triplet.gradle.play.internal.RELEASE_NAMES_DEFAULT_NAME
 import com.github.triplet.gradle.play.internal.RELEASE_NOTES_DEFAULT_NAME
-import com.github.triplet.gradle.play.internal.trackOrDefault
 import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.file.RegularFileProperty
 import org.gradle.api.provider.Property
@@ -32,12 +31,12 @@ internal abstract class ArtifactWorkerBase<T : ArtifactWorkerBase.ArtifactPublis
         return onTheFlyBuild
     }
 
-    protected fun findReleaseName(): String? {
+    protected fun findReleaseName(track: String): String? {
         return if (config.releaseName != null) {
             config.releaseName
         } else if (parameters.consoleNamesDir.isPresent) {
             val dir = parameters.consoleNamesDir.get()
-            val file = dir.file("${config.trackOrDefault}.txt").asFile.orNull()
+            val file = dir.file("$track.txt").asFile.orNull()
                     ?: dir.file(RELEASE_NAMES_DEFAULT_NAME).asFile.orNull()
 
             file?.readProcessed()?.lines()?.firstOrNull()
@@ -46,10 +45,10 @@ internal abstract class ArtifactWorkerBase<T : ArtifactWorkerBase.ArtifactPublis
         }
     }
 
-    protected fun findReleaseNotes(): Map<String, String?> {
+    protected fun findReleaseNotes(track: String): Map<String, String?> {
         val locales = parameters.releaseNotesDir.orNull?.asFile?.listFiles().orEmpty()
         return locales.mapNotNull { locale ->
-            var result = File(locale, "${config.trackOrDefault}.txt").orNull()
+            var result = File(locale, "$track.txt").orNull()
             if (result == null) result = File(locale, RELEASE_NOTES_DEFAULT_NAME).orNull()
             result
         }.associate { notes ->

diff --git a/...xtures/PromoteReleaseIntegrationTest/src/consoleNames/play/release-names/custom-track.txt b/...xtures/PromoteReleaseIntegrationTest/src/consoleNames/play/release-names/custom-track.txt
@@ -0,0 +1 @@
+myCustomName
diff --git a/...st/fixtures/PromoteReleaseIntegrationTest/src/consoleNames/play/release-names/default.txt b/...st/fixtures/PromoteReleaseIntegrationTest/src/consoleNames/play/release-names/default.txt
@@ -1 +1 @@
-myCustomName
+myDefaultName
diff --git a/...tures/PromoteReleaseIntegrationTest/src/consoleNames/play/release-names/promote-track.txt b/...tures/PromoteReleaseIntegrationTest/src/consoleNames/play/release-names/promote-track.txt
@@ -0,0 +1 @@
+myPromoteName
diff --git a/...tures/PromoteReleaseIntegrationTest/src/releaseNotes/play/release-notes/en-US/default.txt b/...tures/PromoteReleaseIntegrationTest/src/releaseNotes/play/release-notes/en-US/default.txt
@@ -1 +1 @@
-My custom release notes
+My default release notes
diff --git a/...PromoteReleaseIntegrationTest/src/releaseNotes/play/release-notes/en-US/promote-track.txt b/...PromoteReleaseIntegrationTest/src/releaseNotes/play/release-notes/en-US/promote-track.txt
@@ -0,0 +1 @@
+Promote track release notes
diff --git a/...t/fixtures/PublishApkIntegrationTest/src/consoleNames/play/release-names/custom-track.txt b/...t/fixtures/PublishApkIntegrationTest/src/consoleNames/play/release-names/custom-track.txt
@@ -0,0 +1 @@
+myCustomName
diff --git a/...c/test/fixtures/PublishApkIntegrationTest/src/consoleNames/play/release-names/default.txt b/...c/test/fixtures/PublishApkIntegrationTest/src/consoleNames/play/release-names/default.txt
@@ -1 +1 @@
-myCustomName
+myDefaultName
diff --git a/.../fixtures/PublishApkIntegrationTest/src/releaseNotes/play/release-notes/en-US/default.txt b/.../fixtures/PublishApkIntegrationTest/src/releaseNotes/play/release-notes/en-US/default.txt
@@ -1 +1 @@
-My custom release notes
+My default release notes
diff --git a/...ixtures/PublishBundleIntegrationTest/src/consoleNames/play/release-names/custom-track.txt b/...ixtures/PublishBundleIntegrationTest/src/consoleNames/play/release-names/custom-track.txt
@@ -0,0 +1 @@
+myCustomName
diff --git a/...est/fixtures/PublishBundleIntegrationTest/src/consoleNames/play/release-names/default.txt b/...est/fixtures/PublishBundleIntegrationTest/src/consoleNames/play/release-names/default.txt
@@ -1 +1 @@
-myCustomName
+myDefaultName
diff --git a/...xtures/PublishBundleIntegrationTest/src/releaseNotes/play/release-notes/en-US/default.txt b/...xtures/PublishBundleIntegrationTest/src/releaseNotes/play/release-notes/en-US/default.txt
@@ -1 +1 @@
-My custom release notes
+My default release notes
diff --git a/...gin/src/test/kotlin/com/github/triplet/gradle/play/tasks/PromoteReleaseIntegrationTest.kt b/...gin/src/test/kotlin/com/github/triplet/gradle/play/tasks/PromoteReleaseIntegrationTest.kt
@@ -147,7 +147,7 @@ class PromoteReleaseIntegrationTest : IntegrationTestBase() {
     }
 
     @Test
-    fun `Build uses correct release name`() {
+    fun `Build picks default release name when no track specific ones are available`() {
         @Suppress("UnnecessaryQualifiedReference")
         // language=gradle
         val config = """
@@ -160,13 +160,60 @@ class PromoteReleaseIntegrationTest : IntegrationTestBase() {
 
         val result = execute(config, "promoteConsoleNamesArtifact")
 
+        assertThat(result.task(":promoteConsoleNamesArtifact")).isNotNull()
+        assertThat(result.task(":promoteConsoleNamesArtifact")!!.outcome)
+                .isEqualTo(TaskOutcome.SUCCESS)
+        assertThat(result.output).contains("promoteRelease(")
+        assertThat(result.output).contains("releaseName=myDefaultName")
+    }
+
+    @Test
+    fun `Build picks track specific release name when available`() {
+        @Suppress("UnnecessaryQualifiedReference")
+        // language=gradle
+        val config = """
+            com.github.triplet.gradle.play.tasks.PromoteReleaseIntegrationBridge.installFactories()
+
+            android.buildTypes {
+                consoleNames {}
+            }
+
+            play.track 'custom-track'
+        """
+
+        val result = execute(config, "promoteConsoleNamesArtifact")
+
         assertThat(result.task(":promoteConsoleNamesArtifact")).isNotNull()
         assertThat(result.task(":promoteConsoleNamesArtifact")!!.outcome)
                 .isEqualTo(TaskOutcome.SUCCESS)
         assertThat(result.output).contains("promoteRelease(")
         assertThat(result.output).contains("releaseName=myCustomName")
     }
 
+    @Test
+    fun `Build picks promote track specific release name when available`() {
+        @Suppress("UnnecessaryQualifiedReference")
+        // language=gradle
+        val config = """
+            com.github.triplet.gradle.play.tasks.PromoteReleaseIntegrationBridge.installFactories()
+
+            android.buildTypes {
+                consoleNames {}
+            }
+
+            play.track 'custom-track'
+            play.promoteTrack 'promote-track'
+        """
+
+        val result = execute(config, "promoteConsoleNamesArtifact")
+
+        assertThat(result.task(":promoteConsoleNamesArtifact")).isNotNull()
+        assertThat(result.task(":promoteConsoleNamesArtifact")!!.outcome)
+                .isEqualTo(TaskOutcome.SUCCESS)
+        assertThat(result.output).contains("promoteRelease(")
+        assertThat(result.output).contains("releaseName=myPromoteName")
+    }
+
     @Test
     fun `Build picks default release notes when no track specific ones are available`() {
         @Suppress("UnnecessaryQualifiedReference")
@@ -185,7 +232,7 @@ class PromoteReleaseIntegrationTest : IntegrationTestBase() {
         assertThat(result.task(":promoteReleaseNotesArtifact")!!.outcome)
                 .isEqualTo(TaskOutcome.SUCCESS)
         assertThat(result.output).contains("promoteRelease(")
-        assertThat(result.output).contains("releaseNotes={en-US=My custom release notes, " +
+        assertThat(result.output).contains("releaseNotes={en-US=My default release notes, " +
                                                    "fr-FR=Mes notes de mise à jour}")
     }
 
@@ -213,6 +260,31 @@ class PromoteReleaseIntegrationTest : IntegrationTestBase() {
                                                    "fr-FR=Mes notes de mise à jour}")
     }
 
+    @Test
+    fun `Build picks promote track specific release notes when available`() {
+        @Suppress("UnnecessaryQualifiedReference")
+        // language=gradle
+        val config = """
+            com.github.triplet.gradle.play.tasks.PromoteReleaseIntegrationBridge.installFactories()
+
+            android.buildTypes {
+                releaseNotes {}
+            }
+
+            play.track 'custom-track'
+            play.promoteTrack 'promote-track'
+        """
+
+        val result = execute(config, "promoteReleaseNotesArtifact")
+
+        assertThat(result.task(":promoteReleaseNotesArtifact")).isNotNull()
+        assertThat(result.task(":promoteReleaseNotesArtifact")!!.outcome)
+                .isEqualTo(TaskOutcome.SUCCESS)
+        assertThat(result.output).contains("promoteRelease(")
+        assertThat(result.output).contains("releaseNotes={en-US=Promote track release notes, " +
+                                                   "fr-FR=Mes notes de mise à jour}")
+    }
+
     @Test
     fun `Build uses correct user fraction`() {
         @Suppress("UnnecessaryQualifiedReference")

diff --git a/.../plugin/src/test/kotlin/com/github/triplet/gradle/play/tasks/PublishApkIntegrationTest.kt b/.../plugin/src/test/kotlin/com/github/triplet/gradle/play/tasks/PublishApkIntegrationTest.kt
@@ -433,7 +433,7 @@ class PublishApkIntegrationTest : IntegrationTestBase() {
     }
 
     @Test
-    fun `Build uses correct release name`() {
+    fun `Build picks default release name when no track specific ones are available`() {
         @Suppress("UnnecessaryQualifiedReference")
         // language=gradle
         val config = """
@@ -446,6 +446,53 @@ class PublishApkIntegrationTest : IntegrationTestBase() {
 
         val result = execute(config, "publishConsoleNamesApk")
 
+        assertThat(result.task(":publishConsoleNamesApk")).isNotNull()
+        assertThat(result.task(":publishConsoleNamesApk")!!.outcome)
+                .isEqualTo(TaskOutcome.SUCCESS)
+        assertThat(result.output).contains("publishApk(")
+        assertThat(result.output).contains("releaseName=myDefaultName")
+    }
+
+    @Test
+    fun `Build picks track specific release name when available`() {
+        @Suppress("UnnecessaryQualifiedReference")
+        // language=gradle
+        val config = """
+            com.github.triplet.gradle.play.tasks.PublishApkIntegrationBridge.installFactories()
+
+            android.buildTypes {
+                consoleNames {}
+            }
+
+            play.track 'custom-track'
+        """
+
+        val result = execute(config, "publishConsoleNamesApk")
+
+        assertThat(result.task(":publishConsoleNamesApk")).isNotNull()
+        assertThat(result.task(":publishConsoleNamesApk")!!.outcome)
+                .isEqualTo(TaskOutcome.SUCCESS)
+        assertThat(result.output).contains("publishApk(")
+        assertThat(result.output).contains("releaseName=myCustomName")
+    }
+
+    @Test
+    fun `Build ignores promote track specific release name when available`() {
+        @Suppress("UnnecessaryQualifiedReference")
+        // language=gradle
+        val config = """
+            com.github.triplet.gradle.play.tasks.PublishApkIntegrationBridge.installFactories()
+
+            android.buildTypes {
+                consoleNames {}
+            }
+
+            play.track 'custom-track'
+            play.promoteTrack 'promote-track'
+        """
+
+        val result = execute(config, "publishConsoleNamesApk")
+
         assertThat(result.task(":publishConsoleNamesApk")).isNotNull()
         assertThat(result.task(":publishConsoleNamesApk")!!.outcome)
                 .isEqualTo(TaskOutcome.SUCCESS)
@@ -471,7 +518,7 @@ class PublishApkIntegrationTest : IntegrationTestBase() {
         assertThat(result.task(":publishReleaseNotesApk")!!.outcome)
                 .isEqualTo(TaskOutcome.SUCCESS)
         assertThat(result.output).contains("publishApk(")
-        assertThat(result.output).contains("releaseNotes={en-US=My custom release notes, " +
+        assertThat(result.output).contains("releaseNotes={en-US=My default release notes, " +
                                                    "fr-FR=Mes notes de mise à jour}")
     }
 
@@ -499,6 +546,31 @@ class PublishApkIntegrationTest : IntegrationTestBase() {
                                                    "fr-FR=Mes notes de mise à jour}")
     }
 
+    @Test
+    fun `Build ignores promote track specific release notes when available`() {
+        @Suppress("UnnecessaryQualifiedReference")
+        // language=gradle
+        val config = """
+            com.github.triplet.gradle.play.tasks.PublishApkIntegrationBridge.installFactories()
+
+            android.buildTypes {
+                releaseNotes {}
+            }
+
+            play.track 'custom-track'
+            play.promoteTrack 'promote-track'
+        """
+
+        val result = execute(config, "publishReleaseNotesApk")
+
+        assertThat(result.task(":publishReleaseNotesApk")).isNotNull()
+        assertThat(result.task(":publishReleaseNotesApk")!!.outcome)
+                .isEqualTo(TaskOutcome.SUCCESS)
+        assertThat(result.output).contains("publishApk(")
+        assertThat(result.output).contains("releaseNotes={en-US=Custom track release notes, " +
+                                                   "fr-FR=Mes notes de mise à jour}")
+    }
+
     @Test
     fun `Build uses correct user fraction`() {
         @Suppress("UnnecessaryQualifiedReference")