Support JUnit 5 in @InterceptTest (#177)

Co-authored-by: Jesse Wilson <jwilson@squareup.com>

Author: swankjesse

burst-gradle-plugin/src/test/kotlin/app/cash/burst/gradle/TestInterceptorGradlePluginTest.kt

@@ -154,4 +154,61 @@ class TestInterceptorGradlePluginTest {
       )
     }
   }
+
+  @Test
+  fun junit5KotlinTest() {
+    val tester = GradleTester("interceptorJunit5")
+    tester.cleanAndBuild(":lib:test")
+
+    with(tester.readTestSuite("app.cash.burst.tests.KotlinTestTest")) {
+      assertThat(systemOut).isEqualTo(
+        """
+        |intercepting kotlinTestTest
+        |@kotlin.test.BeforeTest before test
+        |@kotlin.test.Test running
+        |@kotlin.test.AfterTest after test
+        |intercepted kotlinTestTest
+        |
+        """.trimMargin(),
+      )
+    }
+  }
+
+  @Test
+  fun junit5OrgJunitTest() {
+    val tester = GradleTester("interceptorJunit5")
+    tester.cleanAndBuild(":lib:test")
+
+    with(tester.readTestSuite("app.cash.burst.tests.OrgJunitTest")) {
+      assertThat(systemOut).isEqualTo(
+        """
+        |intercepting orgJunitTest
+        |@org.junit.Before before test
+        |@org.junit.Test running
+        |@org.junit.After after test
+        |intercepted orgJunitTest
+        |
+        """.trimMargin(),
+      )
+    }
+  }
+
+  @Test
+  fun junit5OrgJunitJupiterApiTest() {
+    val tester = GradleTester("interceptorJunit5")
+    tester.cleanAndBuild(":lib:test")
+
+    with(tester.readTestSuite("app.cash.burst.tests.OrgJunitJupiterApiTest")) {
+      assertThat(systemOut).isEqualTo(
+        """
+        |intercepting orgJunitJupiterApiTest
+        |@org.junit.jupiter.api.BeforeEach before test
+        |@org.junit.jupiter.api.Test running
+        |@org.junit.jupiter.api.AfterEach after test
+        |intercepted orgJunitJupiterApiTest
+        |
+        """.trimMargin(),
+      )
+    }
+  }
 }

burst-gradle-plugin/src/test/projects/interceptorJunit5/build.gradle.kts

@@ -0,0 +1,41 @@
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+import org.jetbrains.kotlin.gradle.tasks.KotlinJvmCompile
+
+buildscript {
+  repositories {
+    maven {
+      url = file("$rootDir/../../../../../build/testMaven").toURI()
+    }
+    mavenCentral()
+    google()
+  }
+  dependencies {
+    classpath("app.cash.burst:burst-gradle-plugin:${project.property("burstVersion")}")
+    classpath(libs.kotlin.gradlePlugin)
+  }
+}
+
+allprojects {
+  repositories {
+    maven {
+      url = file("$rootDir/../../../../../build/testMaven").toURI()
+    }
+    mavenCentral()
+    google()
+  }
+
+  tasks.withType(JavaCompile::class.java).configureEach {
+    sourceCompatibility = "1.8"
+    targetCompatibility = "1.8"
+  }
+
+  tasks.withType(KotlinJvmCompile::class.java).configureEach {
+    compilerOptions {
+      jvmTarget.set(JvmTarget.JVM_1_8)
+    }
+  }
+
+  tasks.withType<Test> {
+    useJUnitPlatform()
+  }
+}

burst-gradle-plugin/src/test/projects/interceptorJunit5/lib/build.gradle.kts

@@ -0,0 +1,10 @@
+plugins {
+  kotlin("jvm")
+  id("app.cash.burst")
+}
+
+dependencies {
+  testImplementation(kotlin("test"))
+  testImplementation(libs.junit)
+  testRuntimeOnly(libs.junit.vintage.engine)
+}

burst-gradle-plugin/src/test/projects/interceptorJunit5/lib/src/test/kotlin/app/cash/burst/tests/BasicInterceptor.kt

@@ -0,0 +1,12 @@
+package app.cash.burst.tests
+
+import app.cash.burst.TestFunction
+import app.cash.burst.TestInterceptor
+
+class BasicInterceptor : TestInterceptor {
+  override fun intercept(testFunction: TestFunction) {
+    println("intercepting ${testFunction.functionName}")
+    testFunction()
+    println("intercepted ${testFunction.functionName}")
+  }
+}

burst-gradle-plugin/src/test/projects/interceptorJunit5/lib/src/test/kotlin/app/cash/burst/tests/KotlinTestTest.kt

@@ -0,0 +1,23 @@
+package app.cash.burst.tests
+
+import app.cash.burst.InterceptTest
+
+class KotlinTestTest {
+  @InterceptTest
+  val interceptor = BasicInterceptor()
+
+  @kotlin.test.BeforeTest
+  fun beforeTest() {
+    println("@kotlin.test.BeforeTest before test")
+  }
+
+  @kotlin.test.AfterTest
+  fun afterTest() {
+    println("@kotlin.test.AfterTest after test")
+  }
+
+  @kotlin.test.Test
+  fun kotlinTestTest() {
+    println("@kotlin.test.Test running")
+  }
+}

burst-gradle-plugin/src/test/projects/interceptorJunit5/lib/src/test/kotlin/app/cash/burst/tests/OrgJunitJupiterApiTest.kt

@@ -0,0 +1,23 @@
+package app.cash.burst.tests
+
+import app.cash.burst.InterceptTest
+
+class OrgJunitJupiterApiTest {
+  @InterceptTest
+  val interceptor = BasicInterceptor()
+
+  @org.junit.jupiter.api.BeforeEach
+  fun beforeTest() {
+    println("@org.junit.jupiter.api.BeforeEach before test")
+  }
+
+  @org.junit.jupiter.api.AfterEach
+  fun afterTest() {
+    println("@org.junit.jupiter.api.AfterEach after test")
+  }
+
+  @org.junit.jupiter.api.Test
+  fun orgJunitJupiterApiTest() {
+    println("@org.junit.jupiter.api.Test running")
+  }
+}

burst-gradle-plugin/src/test/projects/interceptorJunit5/lib/src/test/kotlin/app/cash/burst/tests/OrgJunitTest.kt

@@ -0,0 +1,23 @@
+package app.cash.burst.tests
+
+import app.cash.burst.InterceptTest
+
+class OrgJunitTest {
+  @InterceptTest
+  val interceptor = BasicInterceptor()
+
+  @org.junit.Before
+  fun beforeTest() {
+    println("@org.junit.Before before test")
+  }
+
+  @org.junit.After
+  fun afterTest() {
+    println("@org.junit.After after test")
+  }
+
+  @org.junit.Test
+  fun orgJunitTest() {
+    println("@org.junit.Test running")
+  }
+}

burst-gradle-plugin/src/test/projects/interceptorJunit5/settings.gradle.kts

@@ -0,0 +1,9 @@
+dependencyResolutionManagement {
+  versionCatalogs {
+    create("libs") {
+      from(files("../../../../../gradle/libs.versions.toml"))
+    }
+  }
+}
+
+include(":lib")

burst-kotlin-plugin/src/main/kotlin/app/cash/burst/kotlin/BurstApis.kt

@@ -101,11 +101,13 @@ internal class BurstApis private constructor(
       }
 
       val beforeTestSymbols = listOfNotNull(
+        pluginContext.referenceClass(junit5BeforeEachClassId),
         pluginContext.referenceClass(junitBeforeTestClassId),
         pluginContext.referenceClass(kotlinBeforeTestClassId),
       )
 
       val afterTestSymbols = listOfNotNull(
+        pluginContext.referenceClass(junit5AfterEachClassId),
         pluginContext.referenceClass(junitAfterTestClassId),
         pluginContext.referenceClass(kotlinAfterTestClassId),
       )
@@ -141,6 +143,8 @@ private val junitTestClassId = junitPackage.classId("Test")
 private val junitBeforeTestClassId = junitPackage.classId("Before")
 private val junitAfterTestClassId = junitPackage.classId("After")
 private val junit5Package = FqPackageName("org.junit.jupiter.api")
+private val junit5BeforeEachClassId = junit5Package.classId("BeforeEach")
+private val junit5AfterEachClassId = junit5Package.classId("AfterEach")
 private val junit5TestClassId = junit5Package.classId("Test")
 private val kotlinTestPackage = FqPackageName("kotlin.test")
 private val kotlinTestClassId = kotlinTestPackage.classId("Test")