Fix resolution happening on event loop (#391)

This commit makes sure that the resolution of test resources happens
on the blocking executors. Without this, if an exception was thrown
during startup of a test container, then the Netty event loop was
corrupted and the server stopped responding.

Author: melix

build.gradle

@@ -3,6 +3,12 @@ plugins {
     id "io.micronaut.build.internal.quality-reporting"
 }
 
+pluginManager.apply(io.micronaut.build.catalogs.MicronautVersionCatalogUpdatePlugin)
+
+tasks.withType(io.micronaut.build.catalogs.tasks.VersionCatalogUpdate).configureEach {
+    outputDirectory = file("gradle")
+}
+
 tasks.named("publishGuide") {
     properties['micronautVersion'] = micronautVersion
 }

gradle/libs.versions.toml

@@ -16,34 +16,34 @@
 # a managed version (a version which alias starts with "managed-"
 
 [versions]
-micronaut = "4.0.0"
+micronaut = "4.0.1"
 micronaut-platform = "4.0.0-RC1"
 micronaut-aot = "2.0.0"
-micronaut-aws = "4.0.0"
-micronaut-data = "4.0.0"
-micronaut-discovery = "4.0.0"
+micronaut-aws = "4.0.1"
+micronaut-data = "4.0.2"
+micronaut-discovery = "4.0.1"
 micronaut-docs = "2.0.0"
-micronaut-elasticsearch = "5.0.0"
-micronaut-email = "2.0.0"
-micronaut-kafka = "5.0.0"
+micronaut-elasticsearch = "5.0.1"
+micronaut-email = "2.0.2"
+micronaut-kafka = "5.0.2"
 micronaut-logging = "1.0.0"
-micronaut-mongodb = "5.0.0-M8"
-micronaut-mqtt = "3.0.0"
-micronaut-neo4j = "6.0.0"
-micronaut-rabbitmq = "4.0.0"
-micronaut-r2dbc = "5.0.0"
-micronaut-reactor = "3.0.0"
+micronaut-mongodb = "5.0.1"
+micronaut-mqtt = "3.0.1"
+micronaut-neo4j = "6.0.1"
+micronaut-rabbitmq = "4.0.1"
+micronaut-r2dbc = "5.0.1"
+micronaut-reactor = "3.0.1"
 micronaut-gradle-plugin = "4.0.0-M3"
-micronaut-redis = "6.0.0"
-micronaut-security = "4.0.0"
-micronaut-serde = "2.0.0"
-micronaut-sql = "5.0.0"
+micronaut-redis = "6.0.1"
+micronaut-security = "4.0.1"
+micronaut-serde = "2.1.0"
+micronaut-sql = "5.0.1"
 micronaut-test = "4.0.0"
 groovy = "4.0.13"
 spock = "2.3-groovy-4.0"
 vertx-client = "4.4.2"
-amazon-awssdk-v1 = "1.12.503"
-amazon-awssdk-v2 = "2.20.98"
+amazon-awssdk-v1 = "1.12.517"
+amazon-awssdk-v2 = "2.20.114"
 
 # Managed versions appear in the BOM
 managed-testcontainers = "1.18.3"

test-resources-server/build.gradle

@@ -4,6 +4,7 @@ plugins {
     id 'io.micronaut.build.internal.kafka-testing'
     alias(libs.plugins.micronaut.miniapp)
     alias(libs.plugins.micronaut.aot)
+    id('java-test-fixtures')
 }
 
 description = """
@@ -23,13 +24,16 @@ dependencies {
     runtimeOnly(mn.micronaut.management)
     runtimeOnly(mnSerde.micronaut.serde.jackson)
 
+    testFixturesImplementation(project(':micronaut-test-resources-core'))
+    testFixturesImplementation(project(':micronaut-test-resources-testcontainers'))
     testImplementation(mn.micronaut.http.client)
     testImplementation(project(':micronaut-test-resources-client'))
     testRuntimeOnly(project(':micronaut-test-resources-kafka'))
 
     // For logback conversion
     aotPlugins(mnLogging.logback.classic)
     aotPlugins("org.fusesource.jansi:jansi:1.18")
+    aotPlugins(testFixtures(project(":micronaut-test-resources-server")))
 }
 
 application {

test-resources-server/src/main/java/io/micronaut/testresources/server/TestResourcesController.java

@@ -19,6 +19,8 @@
 import io.micronaut.http.annotation.Controller;
 import io.micronaut.http.annotation.Get;
 import io.micronaut.http.annotation.Post;
+import io.micronaut.scheduling.TaskExecutors;
+import io.micronaut.scheduling.annotation.ExecuteOn;
 import io.micronaut.testresources.core.TestResourcesResolver;
 import io.micronaut.testresources.embedded.TestResourcesResolverLoader;
 import io.micronaut.testresources.testcontainers.TestContainers;
@@ -30,13 +32,13 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
-import java.util.stream.Collectors;
 
 /**
  * A client responsible for connecting to a test resources
  * server.
  */
 @Controller("/")
+@ExecuteOn(TaskExecutors.BLOCKING)
 public final class TestResourcesController implements TestResourcesResolver {
     private static final Logger LOGGER = LoggerFactory.getLogger(TestResourcesController.class);
 
@@ -56,7 +58,7 @@ public List<String> getResolvableProperties(Map<String, Collection<String>> prop
             .flatMap(Collection::stream)
             .distinct()
             .peek(p -> LOGGER.debug("For configuration {} and property entries {} , resolvable property: {}", testResourcesConfig, propertyEntries, p))
-            .collect(Collectors.toList());
+            .toList();
     }
 
     @Override
@@ -67,7 +69,7 @@ public List<String> getRequiredProperties(String expression) {
             .map(testResourcesResolver -> testResourcesResolver.getRequiredProperties(expression))
             .flatMap(Collection::stream)
             .distinct()
-            .collect(Collectors.toList());
+            .toList();
     }
 
     @Override
@@ -78,7 +80,7 @@ public List<String> getRequiredPropertyEntries() {
             .map(TestResourcesResolver::getRequiredPropertyEntries)
             .flatMap(Collection::stream)
             .distinct()
-            .collect(Collectors.toList());
+            .toList();
     }
 
     @Post("/resolve")
@@ -125,7 +127,7 @@ public List<TestContainer> listContainersByScope(@Nullable String scope) {
                     c.getContainerId(),
                     entry.getKey().toString())
                 ))
-            .collect(Collectors.toList());
+            .toList();
     }
 
 }

test-resources-server/src/test/groovy/io/micronaut/testresources/server/TestResourcesControllerTest.groovy

@@ -20,7 +20,7 @@ class TestResourcesControllerTest extends Specification {
 
     def "verifies that server can instantiate container"() {
         expect:
-        client.resolvableProperties == ['kafka.bootstrap.servers']
+        client.resolvableProperties ==~ ['kafka.bootstrap.servers', 'failing.message', 'failing.container']
         client.listContainers().empty
 
         when:
@@ -38,6 +38,58 @@ class TestResourcesControllerTest extends Specification {
         client.listContainers().empty
     }
 
+    def "can resolve a valid property after an error in a regular test resource"() {
+        expect:
+        client.resolvableProperties ==~ ['kafka.bootstrap.servers', 'failing.message', 'failing.container']
+        client.listContainers().empty
+
+        when: "resolution of a property fails"
+        client.resolve("failing.message", [:], [:])
+
+        then:
+        RuntimeException ex = thrown()
+
+        when: "resolves another property"
+        client.resolve("kafka.bootstrap.servers", [:], [:])
+
+        then:
+        def containers = client.listContainers()
+        containers.size() == 1
+        containers[0].imageName.startsWith 'confluentinc/cp-kafka'
+
+        when:
+        client.closeAll()
+
+        then:
+        client.listContainers().empty
+    }
+
+    def "can resolve a valid property after an error in a container test resource"() {
+        expect:
+        client.resolvableProperties ==~ ['kafka.bootstrap.servers', 'failing.message', 'failing.container']
+        client.listContainers().empty
+
+        when: "resolution of a property which starts a container"
+        client.resolve("failing.container", [:], [:])
+
+        then:
+        RuntimeException ex = thrown()
+
+        when: "resolves another property"
+        client.resolve("kafka.bootstrap.servers", [:], [:])
+
+        then:
+        def containers = client.listContainers()
+        containers.size() == 1
+        containers[0].imageName.startsWith 'confluentinc/cp-kafka'
+
+        when:
+        client.closeAll()
+
+        then:
+        client.listContainers().empty
+    }
+
     @Client("/")
     static interface DiagnosticsClient extends TestResourcesClient {
         @Get("/testcontainers")

test-resources-server/src/testFixtures/java/io/micronaut/testresources/fixtures/FailingContainer.java

@@ -0,0 +1,56 @@
+/*
+ * 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.testresources.fixtures;
+
+import io.micronaut.testresources.testcontainers.AbstractTestContainersProvider;
+import org.testcontainers.containers.ContainerLaunchException;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.utility.DockerImageName;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+
+public class FailingContainer extends AbstractTestContainersProvider<GenericContainer<?>> {
+
+    public static final String FAILING_CONTAINER = "failing.container";
+
+    @Override
+    public List<String> getResolvableProperties(Map<String, Collection<String>> propertyEntries, Map<String, Object> testResourcesConfig) {
+        return List.of(FAILING_CONTAINER);
+    }
+
+    @Override
+    protected String getSimpleName() {
+        return "failing";
+    }
+
+    @Override
+    protected String getDefaultImageName() {
+        return "foo";
+    }
+
+    @Override
+    protected GenericContainer<?> createContainer(DockerImageName imageName, Map<String, Object> requestedProperties, Map<String, Object> testResourcesConfig) {
+        throw new ContainerLaunchException("test");
+    }
+
+    @Override
+    protected Optional<String> resolveProperty(String propertyName, GenericContainer<?> container) {
+        return Optional.empty();
+    }
+}

test-resources-server/src/testFixtures/java/io/micronaut/testresources/fixtures/FailingTestResource.java

@@ -0,0 +1,41 @@
+/*
+ * 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.testresources.fixtures;
+
+import io.micronaut.testresources.core.TestResourcesResolver;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+
+public class FailingTestResource implements TestResourcesResolver {
+
+    public static final String FAILING_MESSAGE = "failing.message";
+
+    @Override
+    public List<String> getResolvableProperties(Map<String, Collection<String>> propertyEntries, Map<String, Object> testResourcesConfig) {
+        return List.of(FAILING_MESSAGE);
+    }
+
+    @Override
+    public Optional<String> resolve(String propertyName, Map<String, Object> properties, Map<String, Object> testResourcesConfig) {
+        if (FAILING_MESSAGE.equals(propertyName)) {
+            throw new RuntimeException("This is failing");
+        }
+        return Optional.empty();
+    }
+}

test-resources-server/src/testFixtures/resources/META-INF/services/io.micronaut.testresources.core.TestResourcesResolver

@@ -0,0 +1,2 @@
+io.micronaut.testresources.fixtures.FailingTestResource
+io.micronaut.testresources.fixtures.FailingContainer