Fail ignition build when the same jar with multiple versions found in the module build result

Fixes: IGN-10168

Author: ia-vzhang

gradle-module-plugin/build.gradle.kts

@@ -61,6 +61,7 @@ dependencies {
     implementation(libs.kotlinXmlBuilder)
     api(libs.moduleSigner)
     testImplementation(libs.kotlinTestJunit)
+    testImplementation(libs.junit.jupiter.api)
     testImplementation("io.ia.sdk.tools.module.gen:generator-core")
 }
 

gradle-module-plugin/gradle/libs.versions.toml

@@ -1,13 +1,15 @@
 [versions]
 kotlin = "1.7.10"
 moshi = "1.9.3"
+junit-jupiter = "5.11.4"
 
 [libraries]
 # Dependencies referencable in buildscripts.  Note that dashes are replaced by periods in the buildscript reference.
 guava = { module = "com.google.guava:guava", version = "30.1.1-jre" }
 kotlinTest = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
 kotlinTestJunit = { module = "org.jetbrains.kotlin:kotlin-test-junit", version.ref = "kotlin" }
 kotlinXmlBuilder = { module = "org.redundent:kotlin-xml-builder", version = "1.7.2" }
+junit-jupiter-api = { module = "org.junit.jupiter:junit-jupiter-api", version.ref = "junit-jupiter" }
 moshi = { module = "com.squareup.moshi:moshi-kotlin", version.ref = "moshi" }
 moshiCodegen = { module = "com.squareup.moshi:moshi-kotlin-codegen", version.ref = "moshi" }
 moduleSigner = { module = "com.inductiveautomation.ignitionsdk:module-signer", version = "0.0.1.ia" }

gradle-module-plugin/src/functionalTest/kotlin/io/ia/sdk/gradle/modl/task/ZipModuleTests.kt

@@ -3,11 +3,62 @@ package io.ia.sdk.gradle.modl.task
 import io.ia.ignition.module.generator.ModuleGenerator
 import io.ia.sdk.gradle.modl.BaseTest
 import io.ia.sdk.gradle.modl.util.unsignedModuleName
-import org.junit.Test
-import kotlin.test.assertTrue
+import org.gradle.api.Project
+import org.gradle.api.internal.project.DefaultProject
+import org.gradle.api.tasks.TaskExecutionException
+import org.gradle.testfixtures.ProjectBuilder
+import org.junit.jupiter.api.Assertions.assertThrows
+import org.junit.jupiter.api.Assertions.assertTrue
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.io.TempDir
+import java.io.File
 
 class ZipModuleTests : BaseTest() {
 
+    @TempDir
+    lateinit var testProjectDir: File
+    private lateinit var project: Project
+    private lateinit var task: ZipModule
+
+    @BeforeEach
+    fun setup() {
+        project = ProjectBuilder.builder().withProjectDir(testProjectDir).build() as DefaultProject
+        task = project.tasks.create("testTask", ZipModule::class.java)
+
+        // Set up the task properties with the test directory
+        task.content.set(project.objects.directoryProperty().fileValue(File(testProjectDir, "content")))
+        task.unsignedModule.set(project.objects.fileProperty().fileValue(File(testProjectDir, "output.modl")))
+    }
+
+    @Test
+    fun `task succeeds when no duplicate jars exist`() {
+        // Arrange
+        val contentDir = File(testProjectDir, "content").apply { mkdirs() }
+        File(contentDir, "my-lib-1.0.jar").createNewFile()
+        File(contentDir, "another-lib-2.0.jar").createNewFile()
+
+        // Act & Assert: The task should not throw an exception
+        task.execute()
+    }
+
+    @Test
+    fun `task fails when duplicate jars with different versions exist`() {
+        // Arrange
+        val contentDir = File(testProjectDir, "content").apply { mkdirs() }
+        File(contentDir, "my-lib-1.0.jar").createNewFile()
+        File(contentDir, "my-lib-2.0.jar").createNewFile() // This is the duplicate
+
+        // Act & Assert: The task should throw a TaskExecutionException
+        val exception = assertThrows(TaskExecutionException::class.java) {
+            task.execute()
+        }
+
+        // Verify the exception message
+        val expectedMessage = "Jar with 'my-lib' has multiple versions presented"
+        assertTrue(exception.message!!.contains(expectedMessage))
+    }
+
     @Test
     fun `unsigned module is built and has appropriate name`() {
         val name = "Some Thing"

gradle-module-plugin/src/main/kotlin/io/ia/sdk/gradle/modl/task/ZipModule.kt

@@ -13,6 +13,8 @@ import org.gradle.api.tasks.OutputFile
 import org.gradle.api.tasks.PathSensitive
 import org.gradle.api.tasks.PathSensitivity
 import org.gradle.api.tasks.TaskAction
+import org.gradle.api.tasks.TaskExecutionException
+import java.io.File
 import javax.inject.Inject
 
 /**
@@ -46,10 +48,45 @@ open class ZipModule @Inject constructor(objects: ObjectFactory) : DefaultTask()
         val unsignedFile = unsignedModule.get()
         val contentDir = content.get().asFile
 
+        checkDuplicateJars(contentDir)
+
         project.logger.info("Zipping '${contentDir.absolutePath}' into ' ${unsignedFile.asFile.absolutePath}'")
         project.ant.invokeMethod(
             "zip",
             mapOf("basedir" to contentDir, "destfile" to unsignedFile)
         )
     }
+
+    /**
+     * Try to detect jars in contentDir with the same name but have multiple
+     * versions existed.  Fail the build when it's found.
+     **/
+    fun checkDuplicateJars(contentDir: File) {
+        project.logger.info("Parsing file name in: ${contentDir.absolutePath}")
+
+        val fileMap = mutableMapOf<String, String>()
+        val regex = "^(.+?)-(\\d+.*)(?:\\.jar)".toRegex()
+
+        contentDir.walk().filter { it.isFile }.forEach { file ->
+            val matchResult = regex.find(file.name) // Match all the jar files
+
+            if (matchResult != null) {
+                val name = matchResult.groupValues[1]
+                val version = matchResult.groupValues[2]
+
+                if (fileMap.containsKey(name)) {
+                    throw TaskExecutionException(
+                        this,
+                        IllegalArgumentException(
+                            """Jar with '$name' has multiple versions presented in ${contentDir.absolutePath}
+                            Please ensure only one version exist (preferably the highest) and update lib.version.toml file if needed.
+                            """.trimIndent()
+                        )
+                    )
+                } else {
+                    fileMap[name] = version
+                }
+            }
+        }
+    }
 }