Add a TestResourcesScope annotation

settings.gradle

@@ -20,7 +20,8 @@ enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")
 // e.g micronaut-test-resources-micronaut-test-extensions-core
 // is just micronaut-test-resources-extensions-core
 def extensionModules = [
-        'core'
+        'core',
+        'junit-platform'
 ]
 
 def jdbcModules = [

test-resources-build-tools/src/main/java/io/micronaut/testresources/buildtools/ServerUtils.java

@@ -295,6 +295,9 @@ private static void startAndWait(ServerFactory serverFactory,
             startAndWait(serverFactory, explicitPort, portFilePath, accessToken, serverClasspath, cdsDirectory);
             return;
         }
+        if (explicitPort != null) {
+            return;
+        }
         while (!Files.exists(portFilePath)) {
             try {
                 serverFactory.waitFor(Duration.of(STARTUP_TIME_WAIT_MS, ChronoUnit.MILLIS));

test-resources-extensions/test-resources-extensions-core/src/main/resources/META-INF/native-image/micronaut-test-resources-extensions-core/native-image.properties

@@ -0,0 +1 @@
+Args = --initialize-at-run-time=io.micronaut.test.extensions.testresources.TestResourcesClientHolder

test-resources-extensions/test-resources-extensions-junit-platform/build.gradle

@@ -0,0 +1,60 @@
+plugins {
+    id 'io.micronaut.build.internal.test-resources-mntest-extension'
+    id 'jvm-test-suite'
+    id("org.jetbrains.kotlin.jvm") version "1.8.21"
+    id("com.google.devtools.ksp") version "1.8.21-1.0.11"
+}
+
+description = """
+Provides JUnit 5 extensions to extend the capabiities of tests when
+test resources are present.
+"""
+
+testing {
+    suites {
+        spockTest(JvmTestSuite) {
+            dependencies {
+                implementation project(project.path)
+                implementation testFixtures(project(project.path))
+                implementation(mnTest.micronaut.test.spock)
+                compileOnly(mn.micronaut.inject.groovy)
+            }
+            targets.all {
+                tasks.named("check") {
+                    dependsOn(testTask)
+                }
+            }
+        }
+        koTest(JvmTestSuite) {
+            dependencies {
+                implementation project(project.path)
+                implementation testFixtures(project(project.path))
+                implementation(mnTest.micronaut.test.kotest5)
+            }
+            targets.all {
+                tasks.named("check") {
+                    dependsOn(testTask)
+                }
+            }
+        }
+    }
+}
+
+dependencies {
+    annotationProcessor(mn.micronaut.inject.java)
+    api(projects.micronautTestResourcesExtensionsCore)
+    api(projects.micronautTestResourcesClient)
+    implementation(libs.junit.jupiter.api)
+    implementation(libs.junit.platform.launcher)
+    testAnnotationProcessor(mn.micronaut.inject.java)
+    testImplementation(mnTest.micronaut.test.junit5)
+    testFixturesAnnotationProcessor(mn.micronaut.inject.java)
+    testFixturesApi(libs.junit.platform.launcher)
+    testFixturesApi(platform(mnTest.micronaut.test.bom))
+    testFixturesImplementation(projects.micronautTestResourcesClient)
+    testFixturesImplementation(projects.micronautTestResourcesExtensionsCore)
+    testRuntimeOnly(libs.junit.jupiter.engine)
+    testRuntimeOnly(mn.micronaut.context)
+    testRuntimeOnly(mn.snakeyaml)
+    kspKoTest(mn.micronaut.inject.kotlin)
+}

test-resources-extensions/test-resources-extensions-junit-platform/src/koTest/kotlin/io/micronaut/test/extensions/junit5/AbstractScopedTest.kt

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2003-2021 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micronaut.test.extensions.junit5
+
+import io.kotest.core.spec.Spec
+import io.kotest.core.spec.style.StringSpec
+import io.micronaut.test.extensions.testresources.junit5.FakeTestResourcesClient
+import org.junit.jupiter.api.AfterAll
+
+abstract class AbstractScopedTest(body: StringSpec.() -> Unit = {}) : StringSpec(body) {
+    override fun afterSpec(f: suspend (Spec) -> Unit) {
+        FakeTestResourcesClient.reset()
+    }
+}

test-resources-extensions/test-resources-extensions-junit-platform/src/koTest/kotlin/io/micronaut/test/extensions/junit5/ClassScopeTest.kt

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2003-2021 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micronaut.test.extensions.junit5
+
+import io.kotest.matchers.shouldBe
+import io.micronaut.test.extensions.junit5.annotation.ScopeNamingStrategy
+import io.micronaut.test.extensions.junit5.annotation.TestResourcesScope
+import io.micronaut.test.extensions.kotest5.annotation.MicronautTest
+
+@MicronautTest
+@TestResourcesScope(namingStrategy = ScopeNamingStrategy.TestClassName::class)
+internal class ClassScopeTest : ParentTestWithScope({
+    "scope name is the current test class name"() {
+        ScopeHolder.get().orElse(null) shouldBe ClassScopeTest::class.java.name
+    }
+})

test-resources-extensions/test-resources-extensions-junit-platform/src/koTest/kotlin/io/micronaut/test/extensions/junit5/InheritedScopeTest.kt

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2003-2021 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micronaut.test.extensions.junit5
+
+import io.kotest.matchers.shouldBe
+import io.micronaut.test.extensions.kotest5.annotation.MicronautTest
+
+@MicronautTest
+internal class InheritedScopeTest : ParentTestWithScope({
+
+    "scope from parent class is visible" {
+        ScopeHolder.get().orElse(null) shouldBe "from parent"
+    }
+
+})

test-resources-extensions/test-resources-extensions-junit-platform/src/koTest/kotlin/io/micronaut/test/extensions/junit5/PackageScopeTest.kt

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2003-2021 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micronaut.test.extensions.junit5
+
+import io.kotest.matchers.shouldBe
+import io.micronaut.test.extensions.junit5.annotation.ScopeNamingStrategy
+import io.micronaut.test.extensions.junit5.annotation.TestResourcesScope
+import io.micronaut.test.extensions.kotest5.annotation.MicronautTest
+
+@MicronautTest
+@TestResourcesScope(namingStrategy = ScopeNamingStrategy.PackageName::class)
+internal class PackageScopeTest : ParentTestWithScope({
+    "scope name is the current package" {
+        ScopeHolder.get().orElse(null) shouldBe PackageScopeTest::class.java.packageName
+    }
+})

test-resources-extensions/test-resources-extensions-junit-platform/src/koTest/kotlin/io/micronaut/test/extensions/junit5/ParentTestWithScope.kt

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2003-2021 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micronaut.test.extensions.junit5
+
+import io.kotest.core.spec.style.StringSpec
+import io.micronaut.test.extensions.junit5.annotation.TestResourcesScope
+
+@TestResourcesScope("from parent")
+internal abstract class ParentTestWithScope(body: StringSpec.() -> Unit = {}) : AbstractScopedTest(body)

test-resources-extensions/test-resources-extensions-junit-platform/src/main/java/io/micronaut/test/extensions/junit5/ScopeHolder.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2017-2021 original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micronaut.test.extensions.junit5;
+
+import io.micronaut.core.annotation.Internal;
+
+import java.util.Optional;
+
+/**
+ * Our JUnit listener needs to communicate with the test resources
+ * provider factory. Because they are both instantiated with
+ * service loading, we are using a thread local to share information.
+ */
+@Internal
+final class ScopeHolder {
+    private static final ThreadLocal<String> CURRENT_SCOPE = ThreadLocal.withInitial(() -> null);
+
+    private ScopeHolder() {
+    }
+
+    public static Optional<String> get() {
+        return Optional.ofNullable(CURRENT_SCOPE.get());
+    }
+
+    public static void set(String scope) {
+        CURRENT_SCOPE.set(scope);
+    }
+
+    public static void remove() {
+        CURRENT_SCOPE.remove();
+    }
+}

test-resources-extensions/test-resources-extensions-junit-platform/src/main/java/io/micronaut/test/extensions/junit5/ScopeTestPropertyProviderFactory.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2017-2021 original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micronaut.test.extensions.junit5;
+
+import io.micronaut.test.support.TestPropertyProvider;
+import io.micronaut.test.support.TestPropertyProviderFactory;
+import io.micronaut.testresources.core.Scope;
+
+import java.util.Map;
+
+public class ScopeTestPropertyProviderFactory implements TestPropertyProviderFactory {
+    @Override
+    public TestPropertyProvider create(Map<String, Object> availableProperties, Class<?> testClass) {
+        return () -> ScopeHolder.get()
+            .map(value -> Map.of(Scope.PROPERTY_KEY, value))
+            .orElseGet(Map::of);
+    }
+
+}