feat(testcontainers): Show Docling Serve UI (#90)

When starting a Docling Server Testcontainer and the UI is enabled, the URL for the UI will be logged in the console.

Furthermore, the DoclingServeContainer now provides two additional convenient methods: getApiUrl() and getUiUrl().

Signed-off-by: Thomas Vitale <[email protected]>

Author: ThomasVitale

docling-testcontainers/src/main/java/ai/docling/testcontainers/serve/DoclingServeContainer.java

@@ -6,6 +6,8 @@
 import org.testcontainers.containers.wait.strategy.Wait;
 import org.testcontainers.utility.DockerImageName;
 
+import com.github.dockerjava.api.command.InspectContainerResponse;
+
 import ai.docling.testcontainers.serve.config.DoclingServeContainerConfig;
 
 /**
@@ -59,4 +61,26 @@ public DoclingServeContainer(DoclingServeContainerConfig config) {
   public int getPort() {
     return getMappedPort(DEFAULT_DOCLING_PORT);
   }
+
+  /**
+   * The URL where to access the Docling Serve API.
+   */
+  public String getApiUrl() {
+    return "http://" + getHost() + ":" + getPort();
+  }
+
+  /**
+   * The URL where to access the Docling Serve UI, if enabled.
+   */
+  public String getUiUrl() {
+    return getApiUrl() + "/ui";
+  }
+
+  @Override
+  protected void containerIsStarted(InspectContainerResponse containerInfo) {
+    if (config.enableUi()) {
+      LOG.info(() -> "Docling Serve UI: %s".formatted(getUiUrl()));
+    }
+  }
+
 }

docling-testcontainers/src/test/java/ai/docling/testcontainers/serve/DoclingServeContainerAvailableTests.java

@@ -15,11 +15,11 @@
 
 import ai.docling.testcontainers.serve.config.DoclingServeContainerConfig;
 
-import tools.jackson.databind.ObjectMapper;
+import tools.jackson.databind.json.JsonMapper;
 
 @Testcontainers
 class DoclingServeContainerAvailableTests {
-  private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
+  private static final JsonMapper JSON_MAPPER = JsonMapper.builder().build();
   private record HealthResponse(String status) {}
 
   @Container
@@ -33,7 +33,7 @@ private record HealthResponse(String status) {}
   @Test
   void containerAvailable() throws IOException, InterruptedException {
     var healthRequest = HttpRequest.newBuilder(
-        URI.create("http://localhost:%d/health".formatted(this.doclingContainer.getPort()))
+        URI.create("%s/health".formatted(this.doclingContainer.getApiUrl()))
     )
         .header("Accept", "application/json")
         .timeout(Duration.ofSeconds(10))
@@ -48,14 +48,17 @@ void containerAvailable() throws IOException, InterruptedException {
         .isNotNull()
         .usingRecursiveComparison()
         .isEqualTo(new HealthResponse("ok"));
+
+    assertThat(this.doclingContainer.getUiUrl())
+        .isEqualTo(this.doclingContainer.getApiUrl() + "/ui");
   }
 
   private static <T> HttpResponse.BodyHandler<T> jsonBodyHandler(Class<T> type) {
     return responseInfo -> HttpResponse.BodySubscribers.mapping(
         HttpResponse.BodySubscribers.ofByteArray(),
         bytes -> {
           try {
-            return OBJECT_MAPPER.readValue(bytes, type);
+            return JSON_MAPPER.readValue(bytes, type);
           } catch (Exception e) {
             throw new RuntimeException(e);
           }