SCANJLIB-221 Fallback to local JRE if no result from server

Author: henryju

lib/src/main/java/org/sonarsource/scanner/lib/InProcessScannerEngineFacade.java

@@ -23,7 +23,7 @@
 import javax.annotation.Nullable;
 import org.sonarsource.scanner.lib.internal.IsolatedLauncherFactory;
 
-public class InProcessScannerEngineFacade extends ScannerEngineFacade {
+class InProcessScannerEngineFacade extends ScannerEngineFacade {
   private final IsolatedLauncherFactory.IsolatedLauncherAndClassloader launcherAndCl;
 
   InProcessScannerEngineFacade(Map<String, String> bootstrapProperties, IsolatedLauncherFactory.IsolatedLauncherAndClassloader launcherAndCl,

lib/src/main/java/org/sonarsource/scanner/lib/NewScannerEngineFacade.java

@@ -23,7 +23,7 @@
 import javax.annotation.Nullable;
 import org.sonarsource.scanner.lib.internal.ScannerEngineLauncher;
 
-public class NewScannerEngineFacade extends ScannerEngineFacade {
+class NewScannerEngineFacade extends ScannerEngineFacade {
   private final ScannerEngineLauncher launcher;
 
   NewScannerEngineFacade(Map<String, String> bootstrapProperties, ScannerEngineLauncher launcher, LogOutput logOutput,

lib/src/main/java/org/sonarsource/scanner/lib/ScannerEngineBootstrapper.java

@@ -33,6 +33,7 @@
 import org.sonarsource.scanner.lib.internal.InternalProperties;
 import org.sonarsource.scanner.lib.internal.IsolatedLauncherFactory;
 import org.sonarsource.scanner.lib.internal.OsResolver;
+import org.sonarsource.scanner.lib.internal.Paths2;
 import org.sonarsource.scanner.lib.internal.ScannerEngineLauncherFactory;
 import org.sonarsource.scanner.lib.internal.cache.FileCache;
 import org.sonarsource.scanner.lib.internal.cache.Logger;

lib/src/main/java/org/sonarsource/scanner/lib/SimulationScannerEngineFacade.java

@@ -31,7 +31,7 @@
 import javax.annotation.Nullable;
 import org.sonarsource.scanner.lib.internal.InternalProperties;
 
-public class SimulationScannerEngineFacade extends ScannerEngineFacade {
+class SimulationScannerEngineFacade extends ScannerEngineFacade {
 
   SimulationScannerEngineFacade(Map<String, String> bootstrapProperties, LogOutput logOutput, boolean isSonarCloud,
                                 @Nullable String serverVersion) {

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

@@ -42,7 +42,7 @@ public class JavaRunner {
   private final Logger logger;
   private final JreCacheHit jreCacheHit;
 
-  public JavaRunner(@Nullable Path javaExecutable, Logger logger, JreCacheHit jreCacheHit) {
+  public JavaRunner(Path javaExecutable, Logger logger, JreCacheHit jreCacheHit) {
     this.javaExecutable = javaExecutable;
     this.logger = logger;
     this.jreCacheHit = jreCacheHit;
@@ -55,7 +55,7 @@ public JreCacheHit getJreCacheHit() {
   public void execute(List<String> args, @Nullable String input) {
     try {
       List<String> command = new ArrayList<>(args);
-      command.add(0, getJavaExecutable());
+      command.add(0, javaExecutable.toString());
       Process process = new ProcessBuilder(command).start();
       if (input != null) {
         try (OutputStream stdin = process.getOutputStream();
@@ -74,12 +74,8 @@ public void execute(List<String> args, @Nullable String input) {
     }
   }
 
-  String getJavaExecutable() {
-    if (javaExecutable != null) {
-      return javaExecutable.toAbsolutePath().toString();
-    }
-    // Will try to use the java executable in the PATH
-    return "java";
+  public Path getJavaExecutable() {
+    return javaExecutable;
   }
 
   void tryParse(String stdout) {

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

@@ -34,6 +34,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import javax.annotation.Nullable;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.SystemUtils;
@@ -77,32 +78,38 @@ public JavaRunner createRunner(ServerConnection serverConnection, FileCache file
       logger.info("JRE provisioning is disabled");
     } else {
       var cachedFile = getJreFromServer(serverConnection, fileCache, properties, true);
-      // TODO catch exception and fallback to system java
-      return new JavaRunner(cachedFile.getPathInCache(), logger, cachedFile.isCacheHit() ? JreCacheHit.HIT : JreCacheHit.MISS);
+      if (cachedFile.isPresent()) {
+        return new JavaRunner(cachedFile.get().getPathInCache(), logger, cachedFile.get().isCacheHit() ? JreCacheHit.HIT : JreCacheHit.MISS);
+      }
     }
     String javaHome = system.getEnvironmentVariable("JAVA_HOME");
+    var javaExe = "java" + (SystemUtils.IS_OS_WINDOWS ? ".exe" : "");
     if (javaHome != null) {
-      var javaExecutable = Paths.get(javaHome, "bin", "java" + (SystemUtils.IS_OS_WINDOWS ? ".exe" : ""));
+      var javaExecutable = Paths.get(javaHome, "bin", javaExe);
       if (Files.exists(javaExecutable)) {
         logger.info(format("Using the java executable '%s' from JAVA_HOME", javaExecutable));
         return new JavaRunner(javaExecutable, logger, JreCacheHit.DISABLED);
       }
     }
     logger.info("The java executable in the PATH will be used");
-    return new JavaRunner(null, logger, JreCacheHit.DISABLED);
+    return new JavaRunner(Paths.get(javaExe), logger, JreCacheHit.DISABLED);
   }
 
-  private CachedFile getJreFromServer(ServerConnection serverConnection, FileCache fileCache, Map<String, String> properties, boolean retry) {
+  private Optional<CachedFile> getJreFromServer(ServerConnection serverConnection, FileCache fileCache, Map<String, String> properties, boolean retry) {
     String os = properties.get(SCANNER_OS);
     String arch = properties.get(SCANNER_ARCH);
     logger.info(format("JRE provisioning: os[%s], arch[%s]", os, arch));
 
     try {
       var jreMetadata = getJreMetadata(serverConnection, os, arch);
-      var cachedFile = fileCache.getOrDownload(jreMetadata.getFilename(), jreMetadata.getSha256(), "SHA-256",
-        new JreDownloader(serverConnection, jreMetadata));
+      if (jreMetadata.isEmpty()) {
+        logger.info("No JRE found for this OS/architecture");
+        return Optional.empty();
+      }
+      var cachedFile = fileCache.getOrDownload(jreMetadata.get().getFilename(), jreMetadata.get().getSha256(), "SHA-256",
+        new JreDownloader(serverConnection, jreMetadata.get()));
       var extractedDirectory = extractArchive(cachedFile.getPathInCache());
-      return new CachedFile(extractedDirectory.resolve(jreMetadata.javaPath), cachedFile.isCacheHit());
+      return Optional.of(new CachedFile(extractedDirectory.resolve(jreMetadata.get().javaPath), cachedFile.isCacheHit()));
     } catch (HashMismatchException e) {
       if (retry) {
         // A new JRE might have been published between the metadata fetch and the download
@@ -113,16 +120,13 @@ private CachedFile getJreFromServer(ServerConnection serverConnection, FileCache
     }
   }
 
-  private static JreMetadata getJreMetadata(ServerConnection serverConnection, String os, String arch) {
+  private static Optional<JreMetadata> getJreMetadata(ServerConnection serverConnection, String os, String arch) {
     try {
       String response = serverConnection.callRestApi(format(API_PATH_JRE + "?os=%s&arch=%s", os, arch));
       Type listType = new TypeToken<ArrayList<JreMetadata>>() {
       }.getType();
       List<JreMetadata> jres = new Gson().fromJson(response, listType);
-      if (jres.isEmpty()) {
-        throw new IllegalStateException("No JRE metadata found for os[" + os + "] and arch[" + arch + "]");
-      }
-      return jres.get(0);
+      return jres.stream().findFirst();
     } catch (IOException e) {
       throw new IllegalStateException("Failed to get JRE metadata", e);
     }

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

@@ -23,7 +23,6 @@
 import java.nio.file.Files;
 import java.util.List;
 import java.util.Locale;
-import org.sonarsource.scanner.lib.Paths2;
 import org.sonarsource.scanner.lib.System2;
 import org.sonarsource.scanner.lib.internal.cache.Logger;
 

…/org/sonarsource/scanner/lib/Paths2.java …rsource/scanner/lib/internal/Paths2.javalib/src/main/java/org/sonarsource/scanner/lib/Paths2.java renamed to lib/src/main/java/org/sonarsource/scanner/lib/internal/Paths2.java lib/src/main/java/org/sonarsource/scanner/lib/Paths2.java renamed to lib/src/main/java/org/sonarsource/scanner/lib/internal/Paths2.java

@@ -17,7 +17,7 @@
  * 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;
+package org.sonarsource.scanner.lib.internal;
 
 import java.nio.file.Path;
 import java.nio.file.Paths;

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

@@ -24,6 +24,7 @@
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.HashMap;
 import java.util.Map;
 import org.apache.commons.io.FileUtils;
@@ -39,7 +40,6 @@
 
 import static java.util.Objects.requireNonNull;
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.ArgumentMatchers.matches;
@@ -76,17 +76,18 @@ void createRunner_jreProvisioning() throws IOException {
     JavaRunner runner = underTest.createRunner(serverConnection, fileCache, new HashMap<>());
 
     assertThat(runner.getJavaExecutable()).isNotNull();
-    assertThat(new File(runner.getJavaExecutable())).exists();
+    assertThat(runner.getJavaExecutable()).exists();
   }
 
   @Test
-  void createRunner_jreProvisioning_noMatch() throws IOException {
+  void createRunner_jreProvisioning_noMatch_fallback_to_local() throws IOException {
     when(serverConnection.callRestApi(matches(API_PATH_JRE + ".*"))).thenReturn("[]");
-
     Map<String, String> props = Map.of(SCANNER_OS, "linux", SCANNER_ARCH, "x64");
-    assertThatThrownBy(() -> underTest.createRunner(serverConnection, fileCache, props))
-      .isInstanceOf(IllegalStateException.class)
-      .hasMessage("No JRE metadata found for os[linux] and arch[x64]");
+
+    JavaRunner runner = underTest.createRunner(serverConnection, fileCache, props);
+
+    assertThat(runner.getJavaExecutable()).isEqualTo(Paths.get("java"+ (SystemUtils.IS_OS_WINDOWS ? ".exe" : "")));
+    assertThat(runner.getJreCacheHit()).isEqualTo(JreCacheHit.DISABLED);
   }
 
   @Test
@@ -96,7 +97,7 @@ void createRunner_jreExeProperty() {
 
     JavaRunner runner = underTest.createRunner(serverConnection, fileCache, properties);
 
-    assertThat(runner.getJavaExecutable()).isEqualTo(javaExe.toAbsolutePath().toString());
+    assertThat(runner.getJavaExecutable()).isEqualTo(javaExe);
     assertThat(runner.getJreCacheHit()).isEqualTo(JreCacheHit.DISABLED);
   }
 
@@ -112,7 +113,7 @@ void createRunner_jreProvisioningSkipAndJavaHome() throws IOException {
     JavaRunner runner = underTest.createRunner(serverConnection, fileCache, properties);
 
     assertThat(runner.getJavaExecutable()).isEqualTo(
-      temp.resolve("bin/java" + (SystemUtils.IS_OS_WINDOWS ? ".exe" : "")).toAbsolutePath().toString());
+      temp.resolve("bin/java" + (SystemUtils.IS_OS_WINDOWS ? ".exe" : "")));
     assertThat(runner.getJreCacheHit()).isEqualTo(JreCacheHit.DISABLED);
   }
 
@@ -122,7 +123,7 @@ void createRunner_jreProvisioningSkipAndNoJavaHome() {
 
     JavaRunner runner = underTest.createRunner(serverConnection, fileCache, properties);
 
-    assertThat(runner.getJavaExecutable()).isEqualTo("java");
+    assertThat(runner.getJavaExecutable()).isEqualTo(Paths.get("java" + (SystemUtils.IS_OS_WINDOWS ? ".exe" : "")));
     assertThat(runner.getJreCacheHit()).isEqualTo(JreCacheHit.DISABLED);
   }
 

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

@@ -22,26 +22,24 @@
 import java.nio.file.Paths;
 import java.util.List;
 import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.Mock;
-import org.mockito.junit.jupiter.MockitoExtension;
 import org.sonarsource.scanner.lib.internal.cache.Logger;
 
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.ArgumentMatchers.matches;
 import static org.mockito.Mockito.after;
+import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verify;
 
-@ExtendWith(MockitoExtension.class)
 class JavaRunnerTest {
 
   @Mock
-  private Logger logger;
+  private Logger logger = mock(Logger.class);
 
   @Test
   void execute_shouldLogProcessOutput() {
-    JavaRunner runner = new JavaRunner(null, logger, JreCacheHit.DISABLED);
+    JavaRunner runner = new JavaRunner(Paths.get("java"), logger, JreCacheHit.DISABLED);
 
     runner.execute(List.of("--version"), "test");
     verify(logger, after(1000).atLeastOnce()).info(anyString());
@@ -61,7 +59,7 @@ void execute_whenInvalidRunner_shouldFail() {
 
   @Test
   void execute_shouldFailWhenBadRunner() {
-    JavaRunner runner = new JavaRunner(null, logger, JreCacheHit.DISABLED);
+    JavaRunner runner = new JavaRunner(Paths.get("java"), logger, JreCacheHit.DISABLED);
     List<String> command = List.of("unknown-command");
     assertThatThrownBy(() -> runner.execute(command, "test"))
       .isInstanceOf(IllegalStateException.class)
@@ -70,7 +68,7 @@ void execute_shouldFailWhenBadRunner() {
 
   @Test
   void tryParse_shouldParseLogMessages() {
-    JavaRunner runner = new JavaRunner(null, logger, JreCacheHit.DISABLED);
+    JavaRunner runner = new JavaRunner(Paths.get("java"), logger, JreCacheHit.DISABLED);
 
     runner.tryParse("{\n" +
       "    \"level\": \"ERROR\",\n" +
@@ -92,7 +90,7 @@ void tryParse_shouldParseLogMessages() {
 
   @Test
   void tryParse_whenCannotParse_shouldLogInfo() {
-    JavaRunner runner = new JavaRunner(null, logger, JreCacheHit.DISABLED);
+    JavaRunner runner = new JavaRunner(Paths.get("java"), logger, JreCacheHit.DISABLED);
     runner.tryParse("INFO: test");
     verify(logger).info("[stdout] INFO: test");
   }