Introduce MockTestcontainersConfiguration JUnit Jupiter extension

This is the replacement for MockTestcontainersConfigurationRule for internal
JUnit Jupiter tests.

This change removes references to BlockJUnit4ClassRunner.

Tested with:

./gradlew :testcontainers:test --tests 'org.testcontainers.containers.ReusabilityUnitTests$*'

Author: kcooney

core/src/test/java/org/testcontainers/containers/ReusabilityUnitTests.java

@@ -9,27 +9,24 @@
 import com.github.dockerjava.api.command.InspectContainerResponse;
 import com.github.dockerjava.api.command.ListContainersCmd;
 import com.github.dockerjava.api.command.StartContainerCmd;
+import com.github.dockerjava.api.model.Container;
 import com.github.dockerjava.core.command.CreateContainerCmdImpl;
 import com.github.dockerjava.core.command.InspectContainerCmdImpl;
 import com.github.dockerjava.core.command.ListContainersCmdImpl;
 import com.github.dockerjava.core.command.StartContainerCmdImpl;
 import lombok.RequiredArgsConstructor;
 import lombok.experimental.FieldDefaults;
-import org.junit.Rule;
-import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedClass;
 import org.junit.jupiter.params.provider.MethodSource;
-import org.junit.runner.RunWith;
-import org.junit.runners.BlockJUnit4ClassRunner;
 import org.mockito.Answers;
 import org.mockito.Mockito;
 import org.mockito.stubbing.Answer;
 import org.testcontainers.DockerClientFactory;
 import org.testcontainers.TestImages;
 import org.testcontainers.containers.startupcheck.StartupCheckStrategy;
 import org.testcontainers.containers.wait.strategy.AbstractWaitStrategy;
-import org.testcontainers.utility.MockTestcontainersConfigurationRule;
+import org.testcontainers.utility.MockTestcontainersConfiguration;
 import org.testcontainers.utility.MountableFile;
 import org.testcontainers.utility.TestcontainersConfiguration;
 
@@ -55,13 +52,12 @@
 
 public class ReusabilityUnitTests {
 
-    @Nested
     @ParameterizedClass
     @MethodSource("data")
     @RequiredArgsConstructor
     @FieldDefaults(makeFinal = true)
-    public class CanBeReusedTest {
-        public Object[][] data() {
+    public static class CanBeReusedTest {
+        public static Object[][] data() {
             return new Object[][] {
                 { "generic", new GenericContainer<>(TestImages.TINY_IMAGE), true },
                 { "anonymous generic", new GenericContainer(TestImages.TINY_IMAGE) {}, true },
@@ -86,14 +82,14 @@ public void shouldBeReusable() {
             }
         }
 
-        class CustomContainer extends GenericContainer<CustomContainer> {
+        static class CustomContainer extends GenericContainer<CustomContainer> {
 
             CustomContainer() {
                 super(TestImages.TINY_IMAGE);
             }
         }
 
-        class CustomContainerWithContainerIsCreated
+        static class CustomContainerWithContainerIsCreated
             extends GenericContainer<CustomContainerWithContainerIsCreated> {
 
             CustomContainerWithContainerIsCreated() {
@@ -107,10 +103,8 @@ protected void containerIsCreated(String containerId) {
         }
     }
 
-    @Nested
-    @RunWith(BlockJUnit4ClassRunner.class)
     @FieldDefaults(makeFinal = true)
-    public class HooksTest extends AbstractReusabilityTest {
+    public static class HooksTest extends AbstractReusabilityTest {
 
         List<String> script = new ArrayList<>();
 
@@ -189,10 +183,8 @@ public void shouldNotCallHookIfNotReused() {
         }
     }
 
-    @Nested
-    @RunWith(BlockJUnit4ClassRunner.class)
     @FieldDefaults(makeFinal = true)
-    public class HashTest extends AbstractReusabilityTest {
+    public static class HashTest extends AbstractReusabilityTest {
 
         protected GenericContainer<?> container = makeReusable(
             new GenericContainer(TestImages.TINY_IMAGE) {
@@ -304,22 +296,20 @@ public void shouldHashCopiedFiles() {
         }
     }
 
-
-    interface TestStrategy {
-        void withCopyFileToContainer(MountableFile mountableFile, String path);
-
-        void clear();
-    }
-
-    @Nested
     @ParameterizedClass
     @MethodSource("strategies")
     @FieldDefaults(makeFinal = true)
-    public class CopyFilesHashTest {
+    public static class CopyFilesHashTest {
 
         private final TestStrategy strategy;
 
-        private class MountableFileTestStrategy implements TestStrategy {
+        interface TestStrategy {
+            void withCopyFileToContainer(MountableFile mountableFile, String path);
+
+            void clear();
+        }
+
+        private static class MountableFileTestStrategy implements TestStrategy {
 
             private final GenericContainer<?> container;
 
@@ -338,7 +328,7 @@ public void clear() {
             }
         }
 
-        private class TransferableTestStrategy implements TestStrategy {
+        private static class TransferableTestStrategy implements TestStrategy {
 
             private final GenericContainer<?> container;
 
@@ -357,7 +347,7 @@ public void clear() {
             }
         }
 
-        public List<Function<GenericContainer<?>, TestStrategy>> strategies() {
+        public static List<Function<GenericContainer<?>, TestStrategy>> strategies() {
             return Arrays.asList(MountableFileTestStrategy::new, TransferableTestStrategy::new);
         }
 
@@ -508,11 +498,9 @@ public void folderPermissions() throws Exception {
         }
     }
 
+    @MockTestcontainersConfiguration
     @FieldDefaults(makeFinal = true)
-    public abstract class AbstractReusabilityTest {
-
-        @Rule
-        public MockTestcontainersConfigurationRule configurationMock = new MockTestcontainersConfigurationRule();
+    public abstract static class AbstractReusabilityTest {
 
         protected DockerClient client = Mockito.mock(DockerClient.class);
 

core/src/test/java/org/testcontainers/utility/MockTestcontainersConfiguration.java

@@ -0,0 +1,20 @@
+package org.testcontainers.utility;
+
+import org.junit.jupiter.api.extension.ExtendWith;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * A JUnit Jupiter extension that applies a spy on {@link TestcontainersConfiguration}
+ * for testing features that depend on the global configuration.
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+@ExtendWith(MockTestcontainersConfigurationExtension.class)
+@Inherited
+public @interface MockTestcontainersConfiguration {
+}

core/src/test/java/org/testcontainers/utility/MockTestcontainersConfigurationExtension.java

@@ -0,0 +1,40 @@
+package org.testcontainers.utility;
+
+import org.junit.jupiter.api.extension.AfterEachCallback;
+import org.junit.jupiter.api.extension.BeforeEachCallback;
+import org.junit.jupiter.api.extension.ExtensionContext;
+import org.junit.jupiter.api.extension.ExtensionContext.Namespace;
+import org.junit.jupiter.api.extension.ExtensionContext.Store;
+import org.mockito.Mockito;
+
+import java.util.concurrent.atomic.AtomicReference;
+
+/**
+ * This extension applies a spy on {@link TestcontainersConfiguration}
+ * for testing features that depend on the global configuration.
+ */
+class MockTestcontainersConfigurationExtension implements BeforeEachCallback, AfterEachCallback {
+
+    private static final Namespace NAMESPACE = Namespace.create(MockTestcontainersConfigurationExtension.class);
+
+    private static final String PREVIOUS_REF = "previousRef";
+
+    private static AtomicReference<TestcontainersConfiguration> REF = TestcontainersConfiguration.getInstanceField();
+
+    @Override
+    public void beforeEach(ExtensionContext context) {
+        TestcontainersConfiguration previous = REF.get();
+        if (previous == null) {
+            previous = TestcontainersConfiguration.getInstance();
+        }
+        REF.set(Mockito.spy(previous));
+        context.getStore(NAMESPACE).put(PREVIOUS_REF, previous);
+    }
+
+    @Override
+    public void afterEach(ExtensionContext context) {
+        TestcontainersConfiguration previous = context.getStore(NAMESPACE).get(PREVIOUS_REF, TestcontainersConfiguration.class);
+        REF.set(previous);
+        Mockito.validateMockitoUsage();
+    }
+}