[patch] adding parameters for setting username and email

robertfmurdock · Sep 12, 2024 · 6fb89a9 · 6fb89a9
1 parent 1210a84
commit 6fb89a9
Show file tree

Hide file tree

Showing 8 changed files with 81 additions and 16 deletions.
diff --git a/tools/git-adapter/src/commonMain/kotlin/com/zegreatrob/tools/adapter/git/GitAdapter.kt b/tools/git-adapter/src/commonMain/kotlin/com/zegreatrob/tools/adapter/git/GitAdapter.kt
@@ -14,20 +14,24 @@ class GitAdapter(private val workingDirectory: String) {
         workingDirectory,
     ).trim()
 
-    fun newAnnotatedTag(name: String, ref: String) {
-        runProcess(
+    fun newAnnotatedTag(name: String, ref: String, userName: String?, userEmail: String?) {
+        val command = listOf("git") + inlineConfig("user.name", userName) + inlineConfig("user.email", userEmail) +
             listOf(
-                "git",
                 "tag",
                 "--annotate",
                 "--message=$name",
                 name,
                 ref,
-            ),
+            )
+        runProcess(
+            command,
             workingDirectory,
         )
     }
 
+    private fun inlineConfig(property: String, value: String?) =
+        if (value != null) listOf("-c", "$property=$value") else emptyList()
+
     fun pushTags() {
         runProcess(listOf("git", "push", "--tags"), workingDirectory)
     }

diff --git a/tools/tagger-cli/src/commonMain/kotlin/com/zegreatrob/tools/tagger/cli/Tag.kt b/tools/tagger-cli/src/commonMain/kotlin/com/zegreatrob/tools/tagger/cli/Tag.kt
@@ -16,10 +16,12 @@ class Tag : CliktCommand() {
     private val dir by argument("git-repo")
     private val releaseBranch by option().required()
     private val version: String by option().required()
+    private val userName: String? by option()
+    private val userEmail: String? by option()
     private val warningsAsErrors by option().boolean().default(false)
     override fun run() {
         TaggerCore(GitAdapter(dir))
-            .tag(version, releaseBranch)
+            .tag(version, releaseBranch, userName, userEmail)
             .let {
                 when (it) {
                     TagResult.Success -> echo("Success!")

diff --git a/tools/tagger-cli/src/jvmTest/kotlin/com/zegreatrob/tools/tagger/cli/TagCommandTest.kt b/tools/tagger-cli/src/jvmTest/kotlin/com/zegreatrob/tools/tagger/cli/TagCommandTest.kt
@@ -25,10 +25,21 @@ class TagCommandTest : TagTestSpec {
         arguments += projectDir.absolutePath
     }
 
-    override fun configureWithOverrides(releaseBranch: String?, warningsAsErrors: Boolean?) {
+    override fun configureWithOverrides(
+        releaseBranch: String?,
+        userName: String?,
+        userEmail: String?,
+        warningsAsErrors: Boolean?,
+    ) {
         if (releaseBranch != null) {
             arguments += "--release-branch=$releaseBranch"
         }
+        if (userName != null) {
+            arguments += "--user-name=$userName"
+        }
+        if (userEmail != null) {
+            arguments += "--user-email=$userEmail"
+        }
         if (warningsAsErrors != null) {
             arguments += "--warnings-as-errors=$warningsAsErrors"
         }

diff --git a/tools/tagger-core/src/commonMain/kotlin/com/zegreatrob/tools/tagger/core/Tag.kt b/tools/tagger-core/src/commonMain/kotlin/com/zegreatrob/tools/tagger/core/Tag.kt
@@ -2,7 +2,7 @@ package com.zegreatrob.tools.tagger.core
 
 private fun String.isSnapshot() = contains("SNAPSHOT")
 
-fun TaggerCore.tag(version: String, releaseBranch: String?): TagResult {
+fun TaggerCore.tag(version: String, releaseBranch: String?, userName: String?, userEmail: String?): TagResult {
     val isSnapshot = version.isSnapshot()
     val headTag = adapter.showTag("HEAD")
     val alreadyTagged = headTag != null
@@ -19,9 +19,8 @@ fun TaggerCore.tag(version: String, releaseBranch: String?): TagResult {
             ),
         )
     } else {
-        kotlin.runCatching { adapter.newAnnotatedTag(version, "HEAD") }
+        kotlin.runCatching { adapter.newAnnotatedTag(version, "HEAD", userName, userEmail) }
             .map {
-                println("lol")
                 adapter.pushTags()
                 TagResult.Success
             }.getOrElse {

diff --git a/.../tagger-plugin/src/functionalTest/kotlin/com/zegreatrob/tools/tagger/TagFunctionalTest.kt b/.../tagger-plugin/src/functionalTest/kotlin/com/zegreatrob/tools/tagger/TagFunctionalTest.kt
@@ -35,14 +35,21 @@ class TagFunctionalTest : TagTestSpec {
         )
     }
 
-    override fun configureWithOverrides(releaseBranch: String?, warningsAsErrors: Boolean?) {
+    override fun configureWithOverrides(
+        releaseBranch: String?,
+        userName: String?,
+        userEmail: String?,
+        warningsAsErrors: Boolean?,
+    ) {
         buildFile.writeText(
             """
             plugins {
                 id("com.zegreatrob.tools.tagger")
             }
             tagger {
                 ${if (releaseBranch != null) "releaseBranch = \"$releaseBranch\"" else ""}
+                ${if (userName != null) "userName = \"$userName\"" else ""}
+                ${if (userEmail != null) "userEmail = \"$userEmail\"" else ""}
                 ${if (warningsAsErrors != null) "warningsAsErrors.set($warningsAsErrors)" else ""}
             }
             """.trimIndent(),

diff --git a/tools/tagger-plugin/src/main/kotlin/com/zegreatrob/tools/tagger/TagVersion.kt b/tools/tagger-plugin/src/main/kotlin/com/zegreatrob/tools/tagger/TagVersion.kt
@@ -25,10 +25,10 @@ open class TagVersion :
     private fun isSnapshot() = version.contains("SNAPSHOT")
 
     @TaskAction
-    fun execute() {
-        when (val result = taggerExtension.core.tag(version, taggerExtension.releaseBranch)) {
+    fun execute() = taggerExtension.run {
+        when (val result = core.tag(this@TagVersion.version, releaseBranch, userName, userEmail)) {
             TagResult.Success -> {}
-            is TagResult.Error -> if (taggerExtension.warningsAsErrors.get()) {
+            is TagResult.Error -> if (warningsAsErrors.get()) {
                 throw GradleException(result.message)
             } else {
                 logger.warn(result.message)

diff --git a/tools/tagger-plugin/src/main/kotlin/com/zegreatrob/tools/tagger/TaggerExtension.kt b/tools/tagger-plugin/src/main/kotlin/com/zegreatrob/tools/tagger/TaggerExtension.kt
@@ -19,6 +19,12 @@ open class TaggerExtension(
     @Input
     var releaseBranch: String? = null
 
+    @Input
+    var userName: String? = null
+
+    @Input
+    var userEmail: String? = null
+
     @Input
     var warningsAsErrors = objectFactory.property<Boolean>().convention(false)
 

diff --git a/tools/tagger-test/src/jvmMain/kotlin/com/zegreatrob/tools/tagger/TagTestSpec.kt b/tools/tagger-test/src/jvmMain/kotlin/com/zegreatrob/tools/tagger/TagTestSpec.kt
@@ -37,19 +37,29 @@ interface TagTestSpec {
     fun configureWithDefaults()
     fun configureWithOverrides(
         releaseBranch: String? = null,
+        userName: String? = null,
+        userEmail: String? = null,
         warningsAsErrors: Boolean? = null,
     )
 
     fun execute(version: String): TestResult
 
     @BeforeTest
     fun checkPrerequisites() {
-        assertEquals("/dev/null", System.getenv("GIT_CONFIG_GLOBAL"), "Ensure this is set for the test to work as intended")
-        assertEquals("/dev/null", System.getenv("GIT_CONFIG_SYSTEM"), "Ensure this is set for the test to work as intended")
+        assertEquals(
+            "/dev/null",
+            System.getenv("GIT_CONFIG_GLOBAL"),
+            "Ensure this is set for the test to work as intended",
+        )
+        assertEquals(
+            "/dev/null",
+            System.getenv("GIT_CONFIG_SYSTEM"),
+            "Ensure this is set for the test to work as intended",
+        )
     }
 
     @Test
-    fun tagWillTagAndPushSuccessfully() {
+    fun whenUserNameAndEmailAreConfiguredTagWillTagAndPush() {
         configureWithDefaults()
 
         val originDirectory = createTempDirectory()
@@ -77,6 +87,32 @@ interface TagTestSpec {
         assertEquals(expectedVersion, gitAdapter.showTag("HEAD"))
     }
 
+    @Test
+    fun whenUserNameAndEmailAreParametersTagWillTagAndPush() {
+        configureWithOverrides(releaseBranch = "master", userName = "RoB as Test", userEmail = "[email protected]", warningsAsErrors = true)
+
+        val originDirectory = createTempDirectory()
+        val originGrgit = Grgit.init(fun InitOp.() {
+            this.dir = originDirectory.absolutePathString()
+        })
+        disableGpgSign(originDirectory.absolutePathString())
+        originGrgit.commit(fun CommitOp.() {
+            this.message = "init"
+        })
+        val grgit = initializeGitRepo(
+            listOf("init", "[patch] commit 1", "[patch] commit 2"),
+            remoteUrl = originDirectory.absolutePathString(),
+        )
+        grgit.push()
+
+        val expectedVersion = "1.0.0"
+        val result = execute(expectedVersion)
+        assertIsNot<TestResult.Failure>(result, message = "$result")
+
+        val gitAdapter = GitAdapter(this.projectDir.absolutePath)
+        assertEquals(expectedVersion, gitAdapter.showTag("HEAD"))
+    }
+
     @Test
     fun tagWillFailWhenUserEmailAndNameAreNotConfigured() {
         configureWithOverrides(releaseBranch = "master", warningsAsErrors = true)