SCANJLIB-266 Refactor the bootstrap method

Author: henryju

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

@@ -27,9 +27,11 @@
 import java.util.Locale;
 import java.util.Map;
 import java.util.Objects;
+import java.util.function.BiFunction;
 import javax.annotation.Nullable;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.lang3.StringUtils;
+import org.jetbrains.annotations.NotNull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.sonarsource.scanner.lib.internal.FailedBootstrap;
@@ -40,6 +42,7 @@
 import org.sonarsource.scanner.lib.internal.endpoint.ScannerEndpoint;
 import org.sonarsource.scanner.lib.internal.endpoint.ScannerEndpointResolver;
 import org.sonarsource.scanner.lib.internal.facade.forked.NewScannerEngineFacade;
+import org.sonarsource.scanner.lib.internal.facade.forked.ScannerEngineLauncher;
 import org.sonarsource.scanner.lib.internal.facade.forked.ScannerEngineLauncherFactory;
 import org.sonarsource.scanner.lib.internal.facade.inprocess.InProcessScannerEngineFacade;
 import org.sonarsource.scanner.lib.internal.facade.inprocess.IsolatedLauncherFactory;
@@ -143,34 +146,55 @@ public ScannerEngineBootstrapResult bootstrap() {
     // No HTTP call should be made before this point
     try {
       scannerHttpClient.init(httpConfig);
-
-      var serverVersion = !isSonarQubeCloud ? getServerVersion(scannerHttpClient) : null;
-
-      if (!isSonarQubeCloud && VersionUtils.isAtLeastIgnoringQualifier(serverVersion, SQ_VERSION_TOKEN_AUTHENTICATION) && Objects.nonNull(httpConfig.getLogin())) {
-        LOG.warn("Use of '{}' property has been deprecated in favor of '{}' (or the env variable alternative '{}'). Please use the latter when passing a token.", SONAR_LOGIN,
-          SONAR_TOKEN, TOKEN_ENV_VARIABLE);
-      }
-
-      ScannerEngineFacade scannerFacade;
-      if (isSonarQubeCloud || VersionUtils.isAtLeastIgnoringQualifier(serverVersion, SQ_VERSION_NEW_BOOTSTRAPPING)) {
-        var launcher = scannerEngineLauncherFactory.createLauncher(scannerHttpClient, fileCache, immutableProperties);
-
-        var adaptedProperties = adaptSslPropertiesToScannerProperties(immutableProperties, httpConfig);
-
-        scannerFacade = new NewScannerEngineFacade(adaptedProperties, launcher, isSonarQubeCloud, serverVersion);
-      } else {
-        var launcher = launcherFactory.createLauncher(scannerHttpClient, fileCache);
-        var adaptedProperties = adaptDeprecatedPropertiesForInProcessBootstrapping(immutableProperties, httpConfig);
-        scannerFacade = new InProcessScannerEngineFacade(adaptedProperties, launcher, false, serverVersion);
+      if (isSonarQubeCloud) {
+        return bootstrapCloud(fileCache, immutableProperties, httpConfig);
       }
-
-      logServerType(scannerFacade);
-      return new SuccessfulBootstrap(scannerFacade);
+      return bootstrapServer(fileCache, immutableProperties, httpConfig);
     } catch (MessageException e) {
       return handleException(e);
     }
   }
 
+  private ScannerEngineBootstrapResult bootstrapCloud(FileCache fileCache, Map<String, String> immutableProperties, HttpConfig httpConfig) {
+    ScannerEngineFacade scannerFacade;
+    LOG.info("Communicating with SonarQube Cloud");
+    scannerFacade = buildNewFacade(fileCache, immutableProperties, httpConfig,
+      (launcher, adaptedProperties) -> NewScannerEngineFacade.forSonarQubeCloud(adaptedProperties, launcher));
+    return new SuccessfulBootstrap(scannerFacade);
+  }
+
+  private ScannerEngineBootstrapResult bootstrapServer(FileCache fileCache, Map<String, String> immutableProperties, HttpConfig httpConfig) {
+    ScannerEngineFacade scannerFacade;
+    var serverVersion = getServerVersion(scannerHttpClient);
+    String serverLabel;
+    if (VersionUtils.compareMajor(serverVersion, 10) <= 0 || VersionUtils.compareMajor(serverVersion, 2025) >= 0) {
+      serverLabel = "SonarQube Server";
+    } else {
+      serverLabel = "SonarQube Community Build";
+    }
+    LOG.info("Communicating with {} {}", serverLabel, serverVersion);
+    if (VersionUtils.isAtLeastIgnoringQualifier(serverVersion, SQ_VERSION_TOKEN_AUTHENTICATION) && Objects.nonNull(httpConfig.getLogin())) {
+      LOG.warn("Use of '{}' property has been deprecated in favor of '{}' (or the env variable alternative '{}'). Please use the latter when passing a token.", SONAR_LOGIN,
+        SONAR_TOKEN, TOKEN_ENV_VARIABLE);
+    }
+    if (VersionUtils.isAtLeastIgnoringQualifier(serverVersion, SQ_VERSION_NEW_BOOTSTRAPPING)) {
+      scannerFacade = buildNewFacade(fileCache, immutableProperties, httpConfig,
+        (launcher, adaptedProperties) -> NewScannerEngineFacade.forSonarQubeServer(adaptedProperties, launcher, serverVersion));
+    } else {
+      var launcher = launcherFactory.createLauncher(scannerHttpClient, fileCache);
+      var adaptedProperties = adaptDeprecatedPropertiesForInProcessBootstrapping(immutableProperties, httpConfig);
+      scannerFacade = new InProcessScannerEngineFacade(adaptedProperties, launcher, false, serverVersion);
+    }
+    return new SuccessfulBootstrap(scannerFacade);
+  }
+
+  private ScannerEngineFacade buildNewFacade(FileCache fileCache, Map<String, String> immutableProperties, HttpConfig httpConfig,
+    BiFunction<ScannerEngineLauncher, Map<String, String>, ScannerEngineFacade> facadeFactory) {
+    var launcher = scannerEngineLauncherFactory.createLauncher(scannerHttpClient, fileCache, immutableProperties);
+    var adaptedProperties = adaptSslPropertiesToScannerProperties(immutableProperties, httpConfig);
+    return facadeFactory.apply(launcher, adaptedProperties);
+  }
+
   private static ScannerEngineBootstrapResult handleException(MessageException e) {
     var message = new StringBuilder(e.getMessage());
     if (e.getCause() instanceof HttpException) {
@@ -202,14 +226,6 @@ private static void logWithStacktraceOnlyIfDebug(String message, Throwable t) {
     }
   }
 
-  private static void logServerType(ScannerEngineFacade engine) {
-    if (engine.isSonarQubeCloud()) {
-      LOG.info("Communicating with SonarQube Cloud");
-    } else {
-      LOG.info("Communicating with {} {}", engine.getServerLabel(), engine.getServerVersion());
-    }
-  }
-
   /**
    * Older SonarQube versions used to rely on some different properties, or even {@link System} properties.
    * For backward compatibility, we adapt the new properties to the old format.

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

@@ -49,10 +49,4 @@ public interface ScannerEngineFacade extends AutoCloseable {
    */
   boolean analyze(Map<String, String> analysisProps);
 
-  /**
-   * Get the label of the server that the scanner is connected to. Distinguishes SonarQube Cloud, SonarQube Server and SonarQube Community Build.
-   *
-   * @return whether scanner is connected to SonarQube Cloud, Server or Community Build.
-   */
-  String getServerLabel();
 }

lib/src/main/java/org/sonarsource/scanner/lib/internal/facade/AbstractScannerEngineFacade.java

@@ -24,36 +24,35 @@
 import javax.annotation.Nullable;
 import org.sonarsource.scanner.lib.ScannerEngineFacade;
 import org.sonarsource.scanner.lib.internal.facade.forked.JreCacheHit;
-import org.sonarsource.scanner.lib.internal.util.VersionUtils;
 
 public abstract class AbstractScannerEngineFacade implements ScannerEngineFacade {
 
   private final Map<String, String> bootstrapProperties;
-  private final boolean isSonarCloud;
+  private final boolean isSonarQubeCloud;
   private final String serverVersion;
   private final boolean wasEngineCacheHit;
   private final JreCacheHit wasJreCacheHit;
 
-  protected AbstractScannerEngineFacade(Map<String, String> bootstrapProperties, boolean isSonarCloud, @Nullable String serverVersion,
+  protected AbstractScannerEngineFacade(Map<String, String> bootstrapProperties, boolean isSonarQubeCloud, @Nullable String serverVersion,
     boolean wasEngineCacheHit, @Nullable JreCacheHit wasJreCacheHit) {
     this.bootstrapProperties = bootstrapProperties;
-    this.isSonarCloud = isSonarCloud;
+    this.isSonarQubeCloud = isSonarQubeCloud;
     this.serverVersion = serverVersion;
     this.wasEngineCacheHit = wasEngineCacheHit;
     this.wasJreCacheHit = wasJreCacheHit;
   }
 
   @Override
   public String getServerVersion() {
-    if (isSonarCloud) {
-      throw new UnsupportedOperationException("Server version is not available for SonarCloud.");
+    if (isSonarQubeCloud) {
+      throw new UnsupportedOperationException("Server version is not available for SonarQube Cloud.");
     }
     return serverVersion;
   }
 
   @Override
   public boolean isSonarQubeCloud() {
-    return isSonarCloud;
+    return isSonarQubeCloud;
   }
 
   @Override
@@ -84,16 +83,4 @@ public Map<String, String> getBootstrapProperties() {
     return bootstrapProperties;
   }
 
-  @Override
-  public String getServerLabel() {
-    if (isSonarQubeCloud()) {
-      return "SonarQube Cloud";
-    }
-
-    String version = getServerVersion();
-    if (VersionUtils.compareMajor(version, 10) <= 0 || VersionUtils.compareMajor(version, 2025) >= 0) {
-      return "SonarQube Server";
-    }
-    return "SonarQube Community Build";
-  }
 }

lib/src/main/java/org/sonarsource/scanner/lib/internal/facade/forked/NewScannerEngineFacade.java

@@ -26,12 +26,20 @@
 public class NewScannerEngineFacade extends AbstractScannerEngineFacade {
   private final ScannerEngineLauncher launcher;
 
-  public NewScannerEngineFacade(Map<String, String> bootstrapProperties, ScannerEngineLauncher launcher,
-    boolean isSonarCloud, @Nullable String serverVersion) {
-    super(bootstrapProperties, isSonarCloud, serverVersion, launcher.isEngineCacheHit(), launcher.getJreCacheHit());
+  private NewScannerEngineFacade(Map<String, String> bootstrapProperties, ScannerEngineLauncher launcher,
+    boolean isSonarQubeCloud, @Nullable String serverVersion) {
+    super(bootstrapProperties, isSonarQubeCloud, serverVersion, launcher.isEngineCacheHit(), launcher.getJreCacheHit());
     this.launcher = launcher;
   }
 
+  public static NewScannerEngineFacade forSonarQubeCloud(Map<String, String> bootstrapProperties, ScannerEngineLauncher launcher) {
+    return new NewScannerEngineFacade(bootstrapProperties, launcher, true, null);
+  }
+
+  public static NewScannerEngineFacade forSonarQubeServer(Map<String, String> bootstrapProperties, ScannerEngineLauncher launcher, String serverVersion) {
+    return new NewScannerEngineFacade(bootstrapProperties, launcher, false, serverVersion);
+  }
+
   @Override
   protected boolean doAnalyze(Map<String, String> allProps) {
     return launcher.execute(allProps);