feat(workers): Support Maven mirror definitions in MavenDefinition

Extend `MavenDefinition` with an optional `mirrorOf` property. If the new
property is set, the definition represents a mirror and associates it with
the specified repository ID.

Signed-off-by: Onur Demirci <[email protected]>

Author: bs-ondem

workers/common/src/main/kotlin/common/env/config/EnvironmentDefinitionFactory.kt

@@ -107,7 +107,12 @@ class EnvironmentDefinitionFactory {
         properties: DefinitionProperties
     ): Result<EnvironmentServiceDefinition> =
         properties.withRequiredProperties("id") {
-            MavenDefinition(service, credentialsTypes(), getProperty("id"))
+            MavenDefinition(
+                service = service,
+                credentialsTypes = credentialsTypes(),
+                id = getProperty("id"),
+                mirrorOf = getOptionalProperty("mirrorOf")
+            )
         }
 
     /**

workers/common/src/main/kotlin/common/env/definition/MavenDefinition.kt

@@ -38,5 +38,15 @@ class MavenDefinition(
      * In the generated _settings.xml_ file, the ID appears as the _id_ property for the corresponding server in the
      * _servers_ section. See https://maven.apache.org/settings.html#servers.
      */
-    val id: String
+    val id: String,
+
+    /**
+     * If set, this [MavenDefinition] is treated as a mirror definition and will additionally appear in the _mirrors_
+     * section of the generated _settings.xml_ file.
+     *
+     * The value specifies the repository ID that this mirror should apply to, as used in the _mirrorOf_ element of
+     * Maven’s mirror configuration. For example, to mirror Maven Central, use `"central"`, or use `"*"` to apply this
+     * mirror to all repositories.
+     */
+    val mirrorOf: String? = null
 ) : EnvironmentServiceDefinition(service, credentialsTypes)

workers/common/src/test/kotlin/common/env/config/EnvironmentDefinitionFactoryTest.kt

@@ -68,12 +68,24 @@ class EnvironmentDefinitionFactoryTest : WordSpec() {
         "A MavenDefinition" should {
             "be created successfully" {
                 val repositoryId = "my-repository"
-                val properties = mapOf("id" to repositoryId)
+                val mirrorOf = "central"
+                val properties = mapOf("id" to repositoryId, "mirrorOf" to mirrorOf)
 
                 val definition = createSuccessful(EnvironmentDefinitionFactory.MAVEN_TYPE, properties)
 
                 definition.shouldBeInstanceOf<MavenDefinition>()
                 definition.id shouldBe repositoryId
+                definition.mirrorOf shouldBe mirrorOf
+            }
+
+            "be created with default values" {
+                val repositoryId = "my-repository"
+                val properties = mapOf("id" to repositoryId)
+
+                val definition = createSuccessful(EnvironmentDefinitionFactory.MAVEN_TYPE, properties)
+
+                definition.shouldBeInstanceOf<MavenDefinition>()
+                definition.mirrorOf should beNull()
             }
 
             "fail if the ID is missing" {

workers/common/src/test/resources/.ort.env.all-options.yml

@@ -37,6 +37,7 @@ environmentDefinitions:
       id: "internal-repo"
       credentialsTypes:
         - "GIT_CREDENTIALS_FILE"
+      mirrorOf: "central"
   npm:
     - service: "example-npm-registry"
       scope: "@example"