SONARGO-70 Add "integration-test" to common Gradle modules (#4)

Author: petertrr

gradle-modules/src/main/kotlin/org.sonarsource.cloud-native.integration-test.gradle.kts

@@ -0,0 +1,61 @@
+/*
+ * SonarSource Cloud Native Gradle Modules
+ * Copyright (C) 2024-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+import org.gradle.api.tasks.testing.logging.TestExceptionFormat
+import org.gradle.api.tasks.testing.logging.TestLogEvent.FAILED
+import org.gradle.api.tasks.testing.logging.TestLogEvent.PASSED
+import org.gradle.api.tasks.testing.logging.TestLogEvent.SKIPPED
+import org.gradle.api.tasks.testing.logging.TestLogEvent.STARTED
+import org.sonarsource.cloudnative.gradle.IntegrationTestExtension
+
+// Inspiration: https://docs.gradle.org/current/samples/sample_jvm_multi_project_with_additional_test_types.html
+
+plugins {
+    java
+    id("org.sonarsource.cloud-native.java-conventions")
+}
+
+val integrationTest by sourceSets.creating
+val integrationTestConfiguration = extensions.create<IntegrationTestExtension>("integrationTest")
+
+configurations[integrationTest.implementationConfigurationName].extendsFrom(configurations.testImplementation.get())
+configurations[integrationTest.runtimeOnlyConfigurationName].extendsFrom(configurations.testRuntimeOnly.get())
+
+tasks.register<Test>("integrationTest") {
+    description = "Runs integration tests."
+    group = "verification"
+    inputs.dir(integrationTestConfiguration.testSources)
+    inputs.property("SQ version", System.getProperty("sonar.runtimeVersion", "LATEST_RELEASE"))
+    inputs.property("keep SQ running", System.getProperty("keepSonarqubeRunning", "false"))
+    useJUnitPlatform()
+
+    testClassesDirs = integrationTest.output.classesDirs
+    classpath = configurations[integrationTest.runtimeClasspathConfigurationName] + integrationTest.output
+
+    if (System.getProperty("sonar.runtimeVersion") != null) {
+        systemProperty("sonar.runtimeVersion", System.getProperty("sonar.runtimeVersion", "LATEST_RELEASE"))
+    }
+
+    if (System.getProperty("keepSonarqubeRunning") != null) {
+        systemProperty("keepSonarqubeRunning", System.getProperty("keepSonarqubeRunning"))
+    }
+
+    testLogging {
+        // log the full stack trace (default is the 1st line of the stack trace)
+        exceptionFormat = TestExceptionFormat.FULL
+        events(STARTED, PASSED, SKIPPED, FAILED)
+    }
+}

gradle-modules/src/main/kotlin/org/sonarsource/cloudnative/gradle/IntegrationTestExtension.kt

@@ -0,0 +1,31 @@
+package org.sonarsource.cloudnative.gradle
+
+import groovy.lang.Closure
+import org.gradle.api.Project
+import org.gradle.api.file.DirectoryProperty
+import org.gradle.api.tasks.testing.Test
+import org.gradle.kotlin.dsl.named
+
+interface IntegrationTestExtension {
+    /**
+     * The directory containing the source files for the integration tests.
+     * Will be treated as a task input for the integration test task to check if the task is up-to-date.
+     */
+    val testSources: DirectoryProperty
+
+    /**
+     * Additional configuration for the integration test task.
+     */
+    fun Project.configureTask(action: Test.() -> Unit) {
+        tasks.named<Test>("integrationTest", action)
+    }
+
+    /**
+     * Additional configuration for the integration test task.
+     */
+    fun Project.configureTask(action: Closure<*>) {
+        tasks.named<Test>("integrationTest") {
+            action.call(this)
+        }
+    }
+}