SCANJLIB-220 Get full path of java on windows

Author: ericg138

lib/src/main/java/org/sonarsource/scanner/lib/internal/JavaRunnerFactory.java

@@ -22,12 +22,15 @@
 import com.google.gson.Gson;
 import com.google.gson.annotations.SerializedName;
 import com.google.gson.reflect.TypeToken;
+import java.io.BufferedReader;
 import java.io.FileOutputStream;
 import java.io.IOException;
+import java.io.InputStreamReader;
 import java.lang.reflect.Type;
 import java.nio.channels.FileChannel;
 import java.nio.channels.FileLock;
 import java.nio.channels.OverlappingFileLockException;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -37,7 +40,6 @@
 import java.util.Optional;
 import javax.annotation.Nullable;
 import org.apache.commons.lang3.StringUtils;
-import org.apache.commons.lang3.SystemUtils;
 import org.sonarsource.scanner.lib.System2;
 import org.sonarsource.scanner.lib.internal.cache.CachedFile;
 import org.sonarsource.scanner.lib.internal.cache.FileCache;
@@ -61,10 +63,12 @@ public class JavaRunnerFactory {
 
   private final Logger logger;
   private final System2 system;
+  private final ProcessWrapperFactory processWrapperFactory;
 
-  public JavaRunnerFactory(Logger logger, System2 system) {
+  public JavaRunnerFactory(Logger logger, System2 system, ProcessWrapperFactory processWrapperFactory) {
     this.logger = logger;
     this.system = system;
+    this.processWrapperFactory = processWrapperFactory;
   }
 
   public JavaRunner createRunner(ServerConnection serverConnection, FileCache fileCache, Map<String, String> properties) {
@@ -83,7 +87,7 @@ public JavaRunner createRunner(ServerConnection serverConnection, FileCache file
       }
     }
     String javaHome = system.getEnvironmentVariable("JAVA_HOME");
-    var javaExe = "java" + (SystemUtils.IS_OS_WINDOWS ? ".exe" : "");
+    var javaExe = "java" + (isOsWindows() ? ".exe" : "");
     if (javaHome != null) {
       var javaExecutable = Paths.get(javaHome, "bin", javaExe);
       if (Files.exists(javaExecutable)) {
@@ -92,7 +96,36 @@ public JavaRunner createRunner(ServerConnection serverConnection, FileCache file
       }
     }
     logger.info("The java executable in the PATH will be used");
-    return new JavaRunner(Paths.get(javaExe), logger, JreCacheHit.DISABLED);
+    return new JavaRunner(isOsWindows() ? findJavaInPath(javaExe) : Paths.get(javaExe), logger, JreCacheHit.DISABLED);
+  }
+
+  private boolean isOsWindows() {
+    String osName = system.getProperty("os.name");
+    return osName != null && osName.startsWith("Windows");
+  }
+
+  private Path findJavaInPath(String javaExe) {
+    // Windows will search current directory in addition to the PATH variable, which is unsecure.
+    // To avoid it we use where.exe to find the java binary only in PATH.
+    try {
+      ProcessWrapperFactory.ProcessWrapper process = processWrapperFactory.create("C:\\Windows\\System32\\where.exe", "$PATH:" + javaExe);
+
+      Path javaExecutable;
+      try (BufferedReader reader = new BufferedReader(new InputStreamReader(process.getInputStream(), StandardCharsets.UTF_8))) {
+        javaExecutable = Paths.get(reader.lines().findFirst().orElseThrow());
+        logger.debug(format("Found java executable in PATH at '%s'", javaExecutable.toAbsolutePath()));
+      }
+
+      int exit = process.waitFor();
+      if (exit != 0) {
+        throw new IllegalStateException(format("Command execution exited with code: %d", exit));
+      }
+
+      return javaExecutable;
+    } catch (Exception e) {
+      Thread.currentThread().interrupt();
+      throw new IllegalStateException("Cannot find java executable in PATH", e);
+    }
   }
 
   private Optional<CachedFile> getJreFromServer(ServerConnection serverConnection, FileCache fileCache, Map<String, String> properties, boolean retry) {

lib/src/main/java/org/sonarsource/scanner/lib/internal/ProcessWrapperFactory.java

@@ -0,0 +1,48 @@
+/*
+ * SonarScanner Java Library
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonarsource.scanner.lib.internal;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+public class ProcessWrapperFactory {
+
+  public ProcessWrapper create(String... command) throws IOException {
+    return new ProcessWrapper(new ProcessBuilder()
+      .command(command)
+      .start());
+  }
+
+  public static class ProcessWrapper {
+    private final Process process;
+
+    public ProcessWrapper(Process process) {
+      this.process = process;
+    }
+
+    public InputStream getInputStream() {
+      return process.getInputStream();
+    }
+
+    public int waitFor() throws InterruptedException {
+      return process.waitFor();
+    }
+  }
+}

lib/src/main/java/org/sonarsource/scanner/lib/internal/ScannerEngineLauncherFactory.java

@@ -41,7 +41,7 @@ public class ScannerEngineLauncherFactory {
 
   public ScannerEngineLauncherFactory(Logger logger, System2 system) {
     this.logger = logger;
-    this.javaRunnerFactory = new JavaRunnerFactory(logger, system);
+    this.javaRunnerFactory = new JavaRunnerFactory(logger, system, new ProcessWrapperFactory());
   }
 
   ScannerEngineLauncherFactory(Logger logger, JavaRunnerFactory javaRunnerFactory) {

lib/src/test/java/org/sonarsource/scanner/lib/internal/JavaRunnerFactoryTest.java

@@ -29,7 +29,7 @@
 import java.util.Map;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.io.IOUtils;
-import org.apache.commons.lang3.SystemUtils;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 import org.sonarsource.scanner.lib.System2;
@@ -58,12 +58,18 @@ class JavaRunnerFactoryTest {
   private final FileCache fileCache = mock(FileCache.class);
   private final System2 system = mock(System2.class);
   private final Logger logger = mock(Logger.class);
+  private final ProcessWrapperFactory processWrapperFactory = mock(ProcessWrapperFactory.class);
 
-  private final JavaRunnerFactory underTest = new JavaRunnerFactory(logger, system);
+  private final JavaRunnerFactory underTest = new JavaRunnerFactory(logger, system, processWrapperFactory);
 
   @TempDir
   private Path temp;
 
+  @BeforeEach
+  void setUp() {
+    when(system.getProperty("os.name")).thenReturn("linux");
+  }
+
   @Test
   void createRunner_jreProvisioning() throws IOException {
     var jre = temp.resolve("fake-jre.zip");
@@ -86,7 +92,7 @@ void createRunner_jreProvisioning_noMatch_fallback_to_local() throws IOException
 
     JavaRunner runner = underTest.createRunner(serverConnection, fileCache, props);
 
-    assertThat(runner.getJavaExecutable()).isEqualTo(Paths.get("java"+ (SystemUtils.IS_OS_WINDOWS ? ".exe" : "")));
+    assertThat(runner.getJavaExecutable()).isEqualTo(Paths.get("java"));
     assertThat(runner.getJreCacheHit()).isEqualTo(JreCacheHit.DISABLED);
   }
 
@@ -105,15 +111,14 @@ void createRunner_jreExeProperty() {
   void createRunner_jreProvisioningSkipAndJavaHome() throws IOException {
     var javaHome = temp.toAbsolutePath();
     Files.createDirectories(javaHome.resolve("bin"));
-    Files.createFile(javaHome.resolve("bin/java" + (SystemUtils.IS_OS_WINDOWS ? ".exe" : "")));
+    Files.createFile(javaHome.resolve("bin/java"));
 
     when(system.getEnvironmentVariable("JAVA_HOME")).thenReturn(javaHome.toString());
     Map<String, String> properties = Map.of(SKIP_JRE_PROVISIONING, "true");
 
     JavaRunner runner = underTest.createRunner(serverConnection, fileCache, properties);
 
-    assertThat(runner.getJavaExecutable()).isEqualTo(
-      temp.resolve("bin/java" + (SystemUtils.IS_OS_WINDOWS ? ".exe" : "")));
+    assertThat(runner.getJavaExecutable()).isEqualTo(temp.resolve("bin/java"));
     assertThat(runner.getJreCacheHit()).isEqualTo(JreCacheHit.DISABLED);
   }
 
@@ -123,7 +128,23 @@ void createRunner_jreProvisioningSkipAndNoJavaHome() {
 
     JavaRunner runner = underTest.createRunner(serverConnection, fileCache, properties);
 
-    assertThat(runner.getJavaExecutable()).isEqualTo(Paths.get("java" + (SystemUtils.IS_OS_WINDOWS ? ".exe" : "")));
+    assertThat(runner.getJavaExecutable()).isEqualTo(Paths.get("java"));
+    assertThat(runner.getJreCacheHit()).isEqualTo(JreCacheHit.DISABLED);
+  }
+
+  @Test
+  void createRunner_jreProvisioningSkipAndNoJavaHome_windows() throws IOException, InterruptedException {
+    when(system.getProperty("os.name")).thenReturn("Windows 10");
+    ProcessWrapperFactory.ProcessWrapper processWrapper = mock(ProcessWrapperFactory.ProcessWrapper.class);
+    when(processWrapper.getInputStream()).thenReturn(IOUtils.toInputStream("C:\\bin\\java.exe", StandardCharsets.UTF_8));
+    when(processWrapper.waitFor()).thenReturn(0);
+    when(processWrapperFactory.create("C:\\Windows\\System32\\where.exe", "$PATH:java.exe")).thenReturn(processWrapper);
+
+    Map<String, String> properties = Map.of(SKIP_JRE_PROVISIONING, "true");
+
+    JavaRunner runner = underTest.createRunner(serverConnection, fileCache, properties);
+
+    assertThat(runner.getJavaExecutable()).isEqualTo(Paths.get("C:\\bin\\java.exe"));
     assertThat(runner.getJreCacheHit()).isEqualTo(JreCacheHit.DISABLED);
   }
 

lib/src/test/java/org/sonarsource/scanner/lib/internal/ProcessWrapperFactoryTest.java

@@ -0,0 +1,36 @@
+/*
+ * SonarScanner Java Library
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonarsource.scanner.lib.internal;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class ProcessWrapperFactoryTest {
+
+  @Test
+  void create() throws IOException, InterruptedException {
+    ProcessWrapperFactory.ProcessWrapper process = new ProcessWrapperFactory().create("java", "--version");
+    assertThat(process.getInputStream()).asString(StandardCharsets.UTF_8).isNotNull();
+    assertThat(process.waitFor()).isZero();
+  }
+}