Merge pull request #50771 from gsmet/improve-container-runtime-detection

Improve Docker and Podman CLI detection and error messages

Author: gsmet

core/deployment/src/main/java/io/quarkus/deployment/util/ContainerRuntimeUtil.java

@@ -1,15 +1,18 @@
 package io.quarkus.deployment.util;
 
+import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Optional;
 import java.util.regex.Pattern;
 
 import org.eclipse.microprofile.config.ConfigProvider;
 import org.jboss.logging.Logger;
 
 import io.smallrye.common.os.OS;
 import io.smallrye.common.process.ProcessBuilder;
+import io.smallrye.common.process.ProcessUtil;
 import io.smallrye.config.SmallRyeConfig;
 
 public final class ContainerRuntimeUtil {
@@ -73,8 +76,8 @@ public static ContainerRuntime detectContainerRuntime(boolean required, boolean
             storeContainerRuntimeInSystemProperty(ContainerRuntime.UNAVAILABLE);
 
             if (required) {
-                throw new IllegalStateException("No container runtime was found. "
-                        + "Make sure you have either Docker or Podman installed in your environment.");
+                throw new IllegalStateException("No container CLI was found. "
+                        + "Make sure you have either Docker or Podman CLI installed in your environment.");
             }
 
             return ContainerRuntime.UNAVAILABLE;
@@ -147,7 +150,14 @@ private static ContainerRuntime fullyResolveContainerRuntime(ContainerRuntime co
             boolean silent) {
         String execName = containerRuntimeEnvironment.getExecutableName();
         try {
-            return ProcessBuilder.newBuilder(execName)
+            Optional<Path> execPath = ProcessUtil.pathOfCommand(Path.of(execName));
+            if (execPath.isEmpty()) {
+                // this should never happen as we have detected the presence of the Docker/Podman CLI before
+                throw new IllegalStateException(
+                        String.format("Unable to find command: %s in $PATH: %s", execName, ProcessUtil.searchPath()));
+            }
+
+            return ProcessBuilder.newBuilder(execPath.get())
                     .arguments("info")
                     .output().gatherOnFail(true).processWith(br -> {
                         boolean rootless = false;
@@ -218,14 +228,20 @@ private static void storeContainerRuntimeInSystemProperty(ContainerRuntime conta
 
     private static String getVersionOutputFor(ContainerRuntime containerRuntime) {
         String execName = containerRuntime.getExecutableName();
+        Optional<Path> execPath = ProcessUtil.pathOfCommand(Path.of(execName));
+        if (execPath.isEmpty()) {
+            log.debugf("Unable to find command %s in $PATH: %s", execName, ProcessUtil.searchPath());
+            return "";
+        }
+
         try {
-            return ProcessBuilder.newBuilder(execName)
+            return ProcessBuilder.newBuilder(execPath.get())
                     .arguments("--version")
                     .output().gatherOnFail(true).toSingleString(16384)
                     .run();
         } catch (Throwable t) {
             // If an exception is thrown in the process, just return an empty String
-            log.debugf(t, "Failure to read version output from %s", execName);
+            log.debugf(t, "Failure to read version output from %s", execPath.get());
             return "";
         }
     }

docs/src/main/asciidoc/compose-dev-services.adoc

@@ -35,9 +35,9 @@ This integration provides a seamless development experience while giving you ful
 To use Compose Dev Services, you need:
 
 1. A working *local* container environment: https://docs.docker.com/get-started/get-docker/[Docker] or https://podman.io/docs/installation[Podman]
-
-2. Compose tooling such as `docker-compose` or `podman-compose`
-(Note that `docker compose` and `podman compose` commands internally call these binaries) :
+2. The `docker` or `podman` CLI present in the `$PATH`
+3. Compose tooling such as `docker-compose` or `podman-compose`
+(Note that `docker compose` and `podman compose` commands internally call these binaries):
 
 * For Docker: https://docs.docker.com/compose/install/[Installing Docker Compose]
 * For Podman: https://podman-desktop.io/docs/compose/setting-up-compose[Setting up Compose]