workaround to junit launcher issue in intellij 2022.2 plus gradle 7.5.1

Signed-off-by: shalom <[email protected]>

Author: shalom938

analytics-provider/build.gradle.kts

@@ -13,9 +13,10 @@ dependencies {
 
 
 testing {
+    //basic shared configuration is in buildSrc/src/main/kotlin/digma-base.gradle.kts
+
     suites {
         val test by getting(JvmTestSuite::class) {
-            useJUnitJupiter(libs.versions.junit.get())
 
             dependencies {
                 implementation(project)

buildSrc/src/main/kotlin/common-kotlin.gradle.kts

@@ -29,6 +29,12 @@ kotlin {
 }
 
 
+dependencies{
+    //add the kotlin test library to all projects that apply this common-kotlin plugin.
+    //so all project are ready to use kotlin test
+    testImplementation(kotlin("test"))
+}
+
 tasks{
     properties("javaVersion", project).let {
         withType<KotlinCompile> {

buildSrc/src/main/kotlin/digma-base.gradle.kts

@@ -7,6 +7,7 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins{
     `java`
+    `jvm-test-suite`
     id("com.dorongold.task-tree")
     id("com.glovoapp.semantic-versioning")
 }
@@ -60,6 +61,43 @@ project.afterEvaluate{
 }
 
 
+
+testing {
+    //https://docs.gradle.org/current/userguide/jvm_test_suite_plugin.html
+
+    //this is the basic configuration of the test task for all projects.
+    //it can be extended in projects to add dependencies and other configuration.
+    //see for example analytics-provider project.
+    //jvmTestSuite eventually adds a test task to every project so the test task can also be configured
+    //independently like in legacy gradle versions. for example just adding testImplementation dependencies.
+    //but extending jvmTestSuite like in analytics-provider is more consice and safe with regards to depenency hell.
+    //so all projects are already configured to use junit jupiter.
+
+    suites {
+        val test by getting(JvmTestSuite::class) {
+            //this is the only place junit version should be mentioned in the project.
+            //it applies to all projects. can't use versions catalog in scripts plugins so using
+            //hard coded version.
+            useJUnitJupiter("5.8.2")
+
+            dependencies {
+                implementation(project)
+
+                //this is a workaround to an issue with junit launcher in intellij platform 2022.2 plus gradle 7.5.1.
+                //it is discussed in a slack thread and will probably be fixed in the next intellij platform patch.
+                //todo: when upgrading the platform version check if its fixed just by removing it and building the project with no errors.
+                //https://jetbrains-platform.slack.com/archives/CPL5291JP/p1660085792256189
+                runtimeOnly("org.junit.platform:junit-platform-launcher")
+                runtimeOnly("org.junit.jupiter:junit-jupiter-engine")
+            }
+        }
+    }
+}
+
+
+
+
+
 tasks{
 
     withType<JavaCompile> {

ide-common/build.gradle.kts

@@ -19,6 +19,4 @@ dependencies {
 
     implementation(project(":model"))
     implementation(project(":analytics-provider"))
-
-    testImplementation(kotlin("test"))
 }

ide-common/src/test/java/org/digma/intellij/plugin/test/ExampleJavaTest.java

@@ -0,0 +1,20 @@
+package org.digma.intellij.plugin.test;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+
+class ExampleJavaTest {
+
+    //this test is just for checking that the workaround in buildSrc/src/main/kotlin/digma-base.gradle.kts
+    //testing extension really works. see the dependency:
+    //runtimeOnly("org.junit.platform:junit-platform-launcher")
+    //runtimeOnly("org.junit.jupiter:junit-jupiter-engine")
+    //when it's fixed in intellij we can delete this test
+
+    @Test
+    void testMe() {
+        Assertions.assertTrue(1 > 0);
+    }
+
+}

model/build.gradle.kts

@@ -15,6 +15,4 @@ dependencies {
     //add kotlin stdlib version compatible with the intellij platform we're building for.
     //compileOnly because we don't need to package it in the plugin zip.
     compileOnly(libs.kotlin.stdlib.jdk8)
-
-    testImplementation(kotlin("test"))
 }

settings.gradle.kts

@@ -33,7 +33,6 @@ dependencyResolutionManagement {
             version("intellij-platform", "2022.2")
             //rdgen version is not always the same as platform version
             version("rider-rdgen", "2022.2.5")
-            version("junit", "5.8.2")
             //kotlin stdlib is not packaged with the plugin because intellij platform already contains it.
             //it's necessary for compilation in some cases for example rider protocol module.
             //it must target the lowest bundled stdlib version of the platform we support