SCANJLIB-204 Rework the API and add isSonarCloud()

Author: henryju

its/it-simple-scanner/src/main/java/com/sonar/scanner/lib/it/Main.java

@@ -21,8 +21,8 @@
 
 import java.util.HashMap;
 import java.util.Map;
-import org.sonarsource.scanner.lib.EmbeddedScanner;
 import org.sonarsource.scanner.lib.LogOutput;
+import org.sonarsource.scanner.lib.ScannerEngineBootstrapper;
 import org.sonarsource.scanner.lib.StdOutLogOutput;
 
 public class Main {
@@ -43,11 +43,12 @@ public static void main(String[] args) {
     System.exit(0);
   }
 
-  private static void runProject(Map<String, String> props) {
+  private static void runProject(Map<String, String> props) throws Exception {
     LogOutput logOutput = new StdOutLogOutput();
-    EmbeddedScanner scanner = EmbeddedScanner.create("Simple Scanner", "1.0", logOutput);
-    scanner.addGlobalProperties(props);
-    scanner.start();
-    scanner.execute(props);
+    try (var scannerEngine = new ScannerEngineBootstrapper("Simple Scanner", "1.0", logOutput)
+      .addBootstrapProperties(props)
+      .bootstrap()) {
+      scannerEngine.analyze(props);
+    }
   }
 }

lib/pom.xml

@@ -44,7 +44,7 @@
     <!-- unit tests -->
     <dependency>
       <groupId>org.junit.jupiter</groupId>
-        <artifactId>junit-jupiter-engine</artifactId>
+      <artifactId>junit-jupiter-engine</artifactId>
       <scope>test</scope>
     </dependency>
     <dependency>

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

@@ -19,7 +19,6 @@
  */
 package org.sonarsource.scanner.lib;
 
-@FunctionalInterface
 public interface LogOutput {
 
   void log(String formattedMessage, Level level);

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

@@ -0,0 +1,115 @@
+/*
+ * 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;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+import org.sonarsource.scanner.lib.internal.ClassloadRules;
+import org.sonarsource.scanner.lib.internal.InternalProperties;
+import org.sonarsource.scanner.lib.internal.IsolatedLauncherFactory;
+import org.sonarsource.scanner.lib.internal.cache.Logger;
+
+/**
+ * Entry point to run a Sonar analysis programmatically.
+ */
+public class ScannerEngineBootstrapper {
+  private static final String SONAR_HOST_URL_ENV_VAR = "SONAR_HOST_URL";
+  private static final String SONARCLOUD_HOST = "https://sonarcloud.io";
+  private final IsolatedLauncherFactory launcherFactory;
+  private final LogOutput logOutput;
+  private final Map<String, String> bootstrapProperties = new HashMap<>();
+  private final System2 system;
+
+  public ScannerEngineBootstrapper(String app, String version, final LogOutput logOutput) {
+    this(app, version, logOutput, new System2());
+  }
+
+  /**
+   * For testing.
+   */
+  public ScannerEngineBootstrapper(String app, String version, final LogOutput logOutput, System2 system2) {
+    this(new LoggerAdapter(logOutput), logOutput, system2);
+    this.setBootstrapProperty(InternalProperties.SCANNER_APP, app)
+      .setBootstrapProperty(InternalProperties.SCANNER_APP_VERSION, version);
+  }
+
+  private ScannerEngineBootstrapper(Logger logger, LogOutput logOutput, System2 system) {
+    this(logOutput, system, new IsolatedLauncherFactory(logger));
+  }
+
+  ScannerEngineBootstrapper(LogOutput logOutput, System2 system, IsolatedLauncherFactory launcherFactory) {
+    this.launcherFactory = launcherFactory;
+    this.logOutput = logOutput;
+    this.system = system;
+  }
+
+  /**
+   * Declare technical properties needed to bootstrap (sonar.host.url, credentials, proxy, ...).
+   */
+  public ScannerEngineBootstrapper addBootstrapProperties(Map<String, String> p) {
+    bootstrapProperties.putAll(p);
+    return this;
+  }
+
+  /**
+   * Declare a technical property needed to bootstrap (sonar.host.url, credentials, proxy, ...).
+   */
+  public ScannerEngineBootstrapper setBootstrapProperty(String key, String value) {
+    bootstrapProperties.put(key, value);
+    return this;
+  }
+
+  /**
+   * Bootstrap the scanner-engine.
+   */
+  public ScannerEngineFacade bootstrap() {
+    initBootstrapDefaultValues();
+    Set<String> unmaskRules = new HashSet<>();
+    unmaskRules.add("org.sonarsource.scanner.lib.internal.batch.");
+    ClassloadRules rules = new ClassloadRules(Collections.emptySet(), unmaskRules);
+    var properties = Map.copyOf(bootstrapProperties);
+    var isSonarCloud = getSonarCloudUrl().equals(properties.get(ScannerProperties.HOST_URL));
+    var launcher = launcherFactory.createLauncher(properties, rules);
+    return new ScannerEngineFacade(properties, launcher, logOutput, isSonarCloud);
+  }
+
+  private void initBootstrapDefaultValues() {
+    String sonarHostUrl = system.getEnvironmentVariable(SONAR_HOST_URL_ENV_VAR);
+    if (sonarHostUrl != null) {
+      setBootstrapPropertyIfNotAlreadySet(ScannerProperties.HOST_URL, sonarHostUrl);
+    } else {
+      setBootstrapPropertyIfNotAlreadySet(ScannerProperties.HOST_URL, getSonarCloudUrl());
+    }
+  }
+
+  private String getSonarCloudUrl() {
+    return bootstrapProperties.getOrDefault("sonar.scanner.sonarcloudUrl", SONARCLOUD_HOST);
+  }
+
+  private void setBootstrapPropertyIfNotAlreadySet(String key, String value) {
+    if (!bootstrapProperties.containsKey(key)) {
+      setBootstrapProperty(key, value);
+    }
+  }
+
+}