Merge branch 'testcontainers:main' into feat/update-compose-container

Author: fokion

build.gradle

@@ -135,7 +135,7 @@ subprojects {
     }
 
     checkstyle {
-        toolVersion = "10.12.4"
+        toolVersion = "10.23.0"
         configFile = rootProject.file('config/checkstyle/checkstyle.xml')
     }
 }

core/src/main/java/org/testcontainers/containers/DockerModelRunnerContainer.java

@@ -0,0 +1,89 @@
+package org.testcontainers.containers;
+
+import com.github.dockerjava.api.command.InspectContainerResponse;
+import lombok.extern.slf4j.Slf4j;
+import org.testcontainers.containers.wait.strategy.Wait;
+import org.testcontainers.utility.DockerImageName;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.OutputStream;
+import java.net.HttpURLConnection;
+import java.net.URL;
+import java.nio.charset.StandardCharsets;
+
+/**
+ * Testcontainers proxy container for the Docker Model Runner service
+ * provided by Docker Desktop.
+ * <p>
+ * Supported images: {@code alpine/socat}
+ * <p>
+ * Exposed ports: 80
+ */
+@Slf4j
+public class DockerModelRunnerContainer extends SocatContainer {
+
+    private static final String MODEL_RUNNER_ENDPOINT = "model-runner.docker.internal";
+
+    private static final int PORT = 80;
+
+    private String model;
+
+    public DockerModelRunnerContainer(String image) {
+        this(DockerImageName.parse(image));
+    }
+
+    public DockerModelRunnerContainer(DockerImageName image) {
+        super(image);
+        withTarget(PORT, MODEL_RUNNER_ENDPOINT);
+        waitingFor(Wait.forHttp("/").forResponsePredicate(res -> res.contains("The service is running")));
+    }
+
+    @Override
+    protected void containerIsStarted(InspectContainerResponse containerInfo) {
+        if (this.model != null) {
+            logger().info("Pulling model: {}. Please be patient.", this.model);
+
+            String url = getBaseEndpoint() + "/models/create";
+            String payload = String.format("{\"from\": \"%s\"}", this.model);
+
+            try {
+                HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection();
+                connection.setRequestMethod("POST");
+                connection.setRequestProperty("Content-Type", "application/json");
+                connection.setDoOutput(true);
+
+                try (OutputStream os = connection.getOutputStream()) {
+                    os.write(payload.getBytes());
+                    os.flush();
+                }
+
+                try (
+                    BufferedReader br = new BufferedReader(
+                        new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8)
+                    )
+                ) {
+                    while (br.readLine() != null) {}
+                }
+                connection.disconnect();
+            } catch (IOException e) {
+                logger().error("Failed to pull model {}: {}", this.model, e);
+            }
+            logger().info("Finished pulling model: {}", this.model);
+        }
+    }
+
+    public DockerModelRunnerContainer withModel(String model) {
+        this.model = model;
+        return this;
+    }
+
+    public String getBaseEndpoint() {
+        return "http://" + getHost() + ":" + getMappedPort(PORT);
+    }
+
+    public String getOpenAIEndpoint() {
+        return getBaseEndpoint() + "/engines";
+    }
+}

core/src/main/java/org/testcontainers/images/PullPolicy.java

@@ -40,7 +40,7 @@ public static synchronized ImagePullPolicy defaultPolicy() {
                         .currentThread()
                         .getContextClassLoader()
                         .loadClass(imagePullPolicyClassName)
-                        .getConstructor()
+                        .getDeclaredConstructor()
                         .newInstance();
             } catch (Exception e) {
                 throw new IllegalArgumentException(

core/src/main/java/org/testcontainers/utility/RyukContainer.java

@@ -9,7 +9,7 @@
 class RyukContainer extends GenericContainer<RyukContainer> {
 
     RyukContainer() {
-        super("testcontainers/ryuk:0.11.0");
+        super("testcontainers/ryuk:0.12.0");
         withExposedPorts(8080);
         withCreateContainerCmdModifier(cmd -> {
             cmd.withName("testcontainers-ryuk-" + DockerClientFactory.SESSION_ID);

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

@@ -0,0 +1,49 @@
+package org.testcontainers.containers;
+
+import io.restassured.RestAssured;
+import io.restassured.response.Response;
+import org.junit.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assumptions.assumeThat;
+
+public class DockerModelRunnerContainerTest {
+
+    @Test
+    public void checkStatus() {
+        assumeThat(System.getenv("CI")).isNull();
+
+        try (
+            // container {
+            DockerModelRunnerContainer dmr = new DockerModelRunnerContainer("alpine/socat:1.7.4.3-r0")
+            // }
+        ) {
+            dmr.start();
+
+            Response modelResponse = RestAssured.get(dmr.getBaseEndpoint() + "/status").thenReturn();
+            assertThat(modelResponse.body().asString()).contains("The service is running");
+        }
+    }
+
+    @Test
+    public void pullsModelAndExposesInference() {
+        assumeThat(System.getenv("CI")).isNull();
+
+        String modelName = "ai/smollm2:360M-Q4_K_M";
+
+        try (
+            // pullModel {
+            DockerModelRunnerContainer dmr = new DockerModelRunnerContainer("alpine/socat:1.7.4.3-r0")
+                .withModel(modelName)
+            // }
+        ) {
+            dmr.start();
+
+            Response modelResponse = RestAssured.get(dmr.getBaseEndpoint() + "/models").thenReturn();
+            assertThat(modelResponse.body().jsonPath().getList("tags.flatten()")).contains(modelName);
+
+            Response openAiResponse = RestAssured.get(dmr.getOpenAIEndpoint() + "/v1/models").prettyPeek().thenReturn();
+            assertThat(openAiResponse.body().jsonPath().getList("data.id")).contains(modelName);
+        }
+    }
+}

core/src/test/java/org/testcontainers/images/OverrideImagePullPolicyTest.java

@@ -51,4 +51,20 @@ public void simpleConfigurationTest() {
             container.stop();
         }
     }
+
+    @Test
+    public void alwaysPullConfigurationTest() {
+        Mockito
+            .doReturn(AlwaysPullPolicy.class.getCanonicalName())
+            .when(TestcontainersConfiguration.getInstance())
+            .getImagePullPolicy();
+
+        try (DockerRegistryContainer registry = new DockerRegistryContainer()) {
+            registry.start();
+            GenericContainer<?> container = new GenericContainer<>(registry.createImage()).withExposedPorts(8080);
+            container.start();
+            assertThat(container.getImage().imagePullPolicy).isInstanceOf(AlwaysPullPolicy.class);
+            container.stop();
+        }
+    }
 }

docs/examples/junit4/generic/src/test/java/generic/support/TestSpecificImageNameSubstitutor.java

@@ -13,7 +13,7 @@ public class TestSpecificImageNameSubstitutor extends ImageNameSubstitutor {
     @Override
     public DockerImageName apply(final DockerImageName original) {
         if (original.equals(DockerImageName.parse("registry.mycompany.com/mirror/mysql:8.0.36"))) {
-            return DockerImageName.parse("mysql");
+            return DockerImageName.parse("mysql:8.0.36");
         } else {
             return original;
         }

docs/features/advanced_options.md

@@ -38,6 +38,14 @@ You can also configure Testcontainers to use your custom implementation by using
     pull.policy=com.mycompany.testcontainers.ExampleImagePullPolicy
     ```
 
+You can also use the provided implementation to always pull images
+
+=== "`src/test/resources/testcontainers.properties`"
+    ```text
+    pull.policy=org.testcontainers.images.AlwaysPullPolicy
+    ```
+
+
 Please see [the documentation on configuration mechanisms](./configuration.md) for more information.
 
 ## Customizing the container

docs/modules/databases/r2dbc.md

@@ -35,7 +35,7 @@ So that the URL becomes:
 
 #### Using ClickHouse
 
-`r2dbc:tc:clickhouse:///databasename?TC_IMAGE_TAG=21.9.2-alpine`
+`r2dbc:tc:clickhouse:///databasename?TC_IMAGE_TAG=21.11.11-alpine`
 
 #### Using MySQL
 

docs/modules/docker_model_runner.md

@@ -0,0 +1,41 @@
+# Docker Model Runner
+
+This module helps connect to [Docker Model Runner](https://docs.docker.com/desktop/features/model-runner/)
+provided by Docker Desktop 4.40.0.
+
+## DockerModelRunner's usage examples
+
+You can start a Docker Model Runner proxy container instance from any Java application by using:
+
+<!--codeinclude-->
+[Create a DockerModelRunnerContainer](../../core/src/test/java/org/testcontainers/containers/DockerModelRunnerContainerTest.java) inside_block:container
+<!--/codeinclude-->
+
+### Pulling the model
+
+Pulling the model is as simple as:
+
+<!--codeinclude-->
+[Pull model](../../core/src/test/java/org/testcontainers/containers/DockerModelRunnerContainerTest.java) inside_block:pullModel
+<!--/codeinclude-->
+
+## Adding this module to your project dependencies
+
+*Docker Model Runner support is part of the core Testcontainers library.*
+
+Add the following dependency to your `pom.xml`/`build.gradle` file:
+
+=== "Gradle"
+    ```groovy
+    testImplementation "org.testcontainers:testcontainers:{{latest_version}}"
+    ```
+=== "Maven"
+    ```xml
+    <dependency>
+        <groupId>org.testcontainers</groupId>
+        <artifactId>testcontainers</artifactId>
+        <version>{{latest_version}}</version>
+        <scope>test</scope>
+    </dependency>
+    ```
+