feat(workers): Parse GradleDefinitions from .ort.env.yml file

Extend the `EnvironmentDefinitionFactory` to support creating
`GradleDefinition` instances from the `.ort.env.yml` file.

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

Author: bs-ondem

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

@@ -25,6 +25,7 @@ import org.eclipse.apoapsis.ortserver.model.CredentialsType
 import org.eclipse.apoapsis.ortserver.model.InfrastructureService
 import org.eclipse.apoapsis.ortserver.workers.common.env.definition.ConanDefinition
 import org.eclipse.apoapsis.ortserver.workers.common.env.definition.EnvironmentServiceDefinition
+import org.eclipse.apoapsis.ortserver.workers.common.env.definition.GradleDefinition
 import org.eclipse.apoapsis.ortserver.workers.common.env.definition.MavenDefinition
 import org.eclipse.apoapsis.ortserver.workers.common.env.definition.NpmAuthMode
 import org.eclipse.apoapsis.ortserver.workers.common.env.definition.NpmDefinition
@@ -42,6 +43,9 @@ class EnvironmentDefinitionFactory {
         /** The name for the [ConanDefinition] type. */
         const val CONAN_TYPE = "conan"
 
+        /** The name for the [GradleDefinition] type. */
+        const val GRADLE_TYPE = "gradle"
+
         /** The name for the [MavenDefinition] type. */
         const val MAVEN_TYPE = "maven"
 
@@ -75,6 +79,7 @@ class EnvironmentDefinitionFactory {
     ): Result<EnvironmentServiceDefinition> =
         when (type) {
             CONAN_TYPE -> createConanDefinition(service, DefinitionProperties(properties))
+            GRADLE_TYPE -> createGradleDefinition(service, DefinitionProperties(properties))
             MAVEN_TYPE -> createMavenDefinition(service, DefinitionProperties(properties))
             NPM_TYPE -> createNpmDefinition(service, DefinitionProperties(properties))
             NUGET_TYPE -> createNuGetDefinition(service, DefinitionProperties(properties))
@@ -99,6 +104,18 @@ class EnvironmentDefinitionFactory {
             )
         }
 
+    /**
+     * Create a definition for the _init.gradle.kts_ configuration file of Gradle with the given [service] and
+     * [properties].
+     */
+    private fun createGradleDefinition(
+        service: InfrastructureService,
+        properties: DefinitionProperties
+    ): Result<EnvironmentServiceDefinition> =
+        properties.withRequiredProperties {
+            GradleDefinition(service, credentialsTypes())
+        }
+
     /**
      * Create a definition for Maven's _settings.xml_ file with the given [service] and [properties].
      */

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

@@ -39,6 +39,7 @@ import org.eclipse.apoapsis.ortserver.workers.common.common.env.REMOTE_NAME
 import org.eclipse.apoapsis.ortserver.workers.common.common.env.REMOTE_URL
 import org.eclipse.apoapsis.ortserver.workers.common.env.definition.ConanDefinition
 import org.eclipse.apoapsis.ortserver.workers.common.env.definition.EnvironmentServiceDefinition
+import org.eclipse.apoapsis.ortserver.workers.common.env.definition.GradleDefinition
 import org.eclipse.apoapsis.ortserver.workers.common.env.definition.MavenDefinition
 import org.eclipse.apoapsis.ortserver.workers.common.env.definition.NpmAuthMode
 import org.eclipse.apoapsis.ortserver.workers.common.env.definition.NpmDefinition
@@ -451,6 +452,36 @@ class EnvironmentDefinitionFactoryTest : WordSpec() {
                 definition.credentialsTypes() shouldBe EnumSet.of(CredentialsType.GIT_CREDENTIALS_FILE)
             }
         }
+
+        "A GradleDefinition" should {
+            "be created successfully" {
+                val definition = createSuccessful(EnvironmentDefinitionFactory.GRADLE_TYPE, emptyMap())
+
+                definition.shouldBeInstanceOf<GradleDefinition>()
+            }
+
+            "fail if there are unsupported properties" {
+                val unsupportedProperty1 = "anotherProperty"
+                val unsupportedProperty2 = "oneMoreUnsupportedProperty"
+                val properties =
+                    mapOf(unsupportedProperty1 to "bar", unsupportedProperty2 to "baz")
+
+                val exception = createFailed(EnvironmentDefinitionFactory.GRADLE_TYPE, properties)
+
+                exception.message shouldContain "'$unsupportedProperty1'"
+                exception.message shouldContain "'$unsupportedProperty2'"
+            }
+
+            "allow overriding the credentials types" {
+                val properties = mapOf(
+                    EnvironmentDefinitionFactory.CREDENTIALS_TYPE_PROPERTY to "GIT_CREDENTIALS_FILE"
+                )
+
+                val definition = createSuccessful(EnvironmentDefinitionFactory.GRADLE_TYPE, properties)
+
+                definition.credentialsTypes() shouldBe EnumSet.of(CredentialsType.GIT_CREDENTIALS_FILE)
+            }
+        }
     }
 
     /**

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

@@ -28,6 +28,8 @@ environmentDefinitions:
       name: "conan-center"
       url: "https://conan.example.org/api/v1"
       verifySsl: true
+  gradle:
+    - service: "example-maven-central"
   maven:
     - service: "example-maven-central"
       id: "central"