Refactor the loading of the Sonar Home Directory

Author: henryju

its/it-tests/src/test/java/com/sonar/scanner/lib/it/PropertiesTest.java

@@ -26,22 +26,25 @@
 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.junit.ClassRule;
+import org.junit.Rule;
 import org.junit.Test;
+import org.junit.rules.TemporaryFolder;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 public class PropertiesTest {
   @ClassRule
   public static final OrchestratorRule ORCHESTRATOR = ScannerJavaLibraryTestSuite.ORCHESTRATOR;
 
+  @Rule
+  public TemporaryFolder temp = new TemporaryFolder();
+
   @Test
   public void testRuntimeEnvironmentPassedAsUserAgent() throws IOException {
     SimpleScanner scanner = new SimpleScanner();
-    Map<String, String> params = new HashMap<>();
-    BuildResult buildResult = scanner.executeSimpleProject(project("js-sample"), ORCHESTRATOR.getServer().getUrl(), params, Map.of());
+    BuildResult buildResult = scanner.executeSimpleProject(project("js-sample"), ORCHESTRATOR.getServer().getUrl(), Map.of(), Map.of());
     assertThat(buildResult.getLastStatus()).isZero();
     assertThat(buildResult.getLogs()).contains("2 files indexed");
 
@@ -53,13 +56,32 @@ public void testRuntimeEnvironmentPassedAsUserAgent() throws IOException {
   @Test
   public void passConfigurationUsingEnvVariables() throws IOException {
     SimpleScanner scanner = new SimpleScanner();
-    Map<String, String> params = new HashMap<>();
-    BuildResult buildResult = scanner.executeSimpleProject(project("js-sample"), ORCHESTRATOR.getServer().getUrl(), params, Map.of("SONAR_SCANNER_JSON_PARAMS", "{\"sonar.exclusions\": \"**/Hello.js\"}"));
+    BuildResult buildResult = scanner.executeSimpleProject(project("js-sample"), ORCHESTRATOR.getServer().getUrl(), Map.of(), Map.of("SONAR_SCANNER_JSON_PARAMS", "{\"sonar.exclusions\": \"**/Hello.js\"}"));
     assertThat(buildResult.getLastStatus()).isZero();
 
     assertThat(buildResult.getLogs()).contains("1 file indexed");
   }
 
+  @Test
+  public void overrideHomeDirectoryWithEnv() throws IOException {
+    var userHome = temp.newFolder();
+    SimpleScanner scanner = new SimpleScanner();
+    BuildResult buildResult = scanner.executeSimpleProject(project("js-sample"), ORCHESTRATOR.getServer().getUrl(), Map.of(), Map.of("SONAR_USER_HOME", userHome.getAbsolutePath()));
+    assertThat(buildResult.getLastStatus()).isZero();
+
+    assertThat(userHome.toPath().resolve("cache")).isDirectoryRecursivelyContaining(("glob:**/*scanner-engine*.jar"));
+  }
+
+  @Test
+  public void overrideHomeDirectoryWithProps() throws IOException {
+    var userHome = temp.newFolder();
+    SimpleScanner scanner = new SimpleScanner();
+    BuildResult buildResult = scanner.executeSimpleProject(project("js-sample"), ORCHESTRATOR.getServer().getUrl(), Map.of("sonar.userHome", userHome.getAbsolutePath()), Map.of());
+    assertThat(buildResult.getLastStatus()).isZero();
+
+    assertThat(userHome.toPath().resolve("cache")).isDirectoryRecursivelyContaining(("glob:**/*scanner-engine*.jar"));
+  }
+
   private static Path project(String projectName) {
     return Paths.get("..", "projects", projectName);
   }

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

@@ -35,6 +35,7 @@ public class EnvironmentConfig {
   private static final String SONARQUBE_SCANNER_PARAMS = "SONARQUBE_SCANNER_PARAMS";
   private static final String GENERIC_ENV_PREFIX = "SONAR_SCANNER_";
   private static final String SONAR_HOST_URL_ENV_VAR = "SONAR_HOST_URL";
+  private static final String SONAR_USER_HOME_ENV_VAR = "SONAR_USER_HOME";
 
   private EnvironmentConfig() {
     // only static methods
@@ -47,6 +48,7 @@ public static Map<String, String> load(LogOutput logger) {
   static Map<String, String> load(Map<String, String> env, LogOutput logger) {
     var loadedProps = new HashMap<String, String>();
     Optional.ofNullable(env.get(SONAR_HOST_URL_ENV_VAR)).ifPresent(url -> loadedProps.put(ScannerProperties.HOST_URL, url));
+    Optional.ofNullable(env.get(SONAR_USER_HOME_ENV_VAR)).ifPresent(path -> loadedProps.put(ScannerProperties.SONAR_USER_HOME, path));
     env.forEach((key, value) -> {
       if (!key.equals(SONAR_SCANNER_JSON_PARAMS) && key.startsWith(GENERIC_ENV_PREFIX)) {
         processEnvVariable(key, value, loadedProps, logger);

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

@@ -27,13 +27,18 @@
  */
 public interface ScannerProperties {
   /**
-   * HTTP URL of Sonar server, "http://localhost:9000" by default
+   * URL of the Sonar server, default to SonarCloud
    */
   String HOST_URL = "sonar.host.url";
 
   /**
    * Working directory containing generated reports and temporary data.
    */
   String WORK_DIR = "sonar.working.directory";
-  
+
+  /**
+   * Base dir for various locations (cache, SSL, …). Default to ~/.sonar
+   */
+  String SONAR_USER_HOME = "sonar.userHome";
+
 }

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

@@ -37,7 +37,7 @@ class JarDownloaderFactory {
 
   JarDownloader create() {
     FileCache fileCache = new FileCacheBuilder(logger)
-      .setUserHome(userHome)
+      .setSonarUserHome(userHome)
       .build();
     BootstrapIndexDownloader bootstrapIndexDownloader = new BootstrapIndexDownloader(serverConnection, logger);
     JarDownloader.ScannerFileDownloader scannerFileDownloader = new JarDownloader.ScannerFileDownloader(serverConnection);

lib/src/main/java/org/sonarsource/scanner/lib/internal/cache/FileCacheBuilder.java

@@ -19,41 +19,32 @@
  */
 package org.sonarsource.scanner.lib.internal.cache;
 
-import java.io.File;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import javax.annotation.Nullable;
 
 public class FileCacheBuilder {
   private final Logger logger;
-  private File userHome;
+  private Path sonarUserHome;
 
   public FileCacheBuilder(Logger logger) {
     this.logger = logger;
   }
 
-  public FileCacheBuilder setUserHome(File d) {
-    this.userHome = d;
-    return this;
-  }
-
-  public FileCacheBuilder setUserHome(@Nullable String path) {
-    this.userHome = (path == null) ? null : new File(path);
+  public FileCacheBuilder setSonarUserHome(@Nullable String userHomeProperty) {
+    this.sonarUserHome = (userHomeProperty == null) ? null : Paths.get(userHomeProperty);
     return this;
   }
 
   public FileCache build() {
-    if (userHome == null) {
-      userHome = findHome();
+    if (sonarUserHome == null) {
+      sonarUserHome = findDefaultHome();
     }
-    File cacheDir = new File(userHome, "cache");
-    return FileCache.create(cacheDir.toPath(), logger);
+    var cacheDir = sonarUserHome.resolve("cache");
+    return FileCache.create(cacheDir, logger);
   }
 
-  private static File findHome() {
-    String path = System.getenv("SONAR_USER_HOME");
-    if (path == null) {
-      // Default
-      path = System.getProperty("user.home") + File.separator + ".sonar";
-    }
-    return new File(path);
+  private static Path findDefaultHome() {
+    return Paths.get("").resolve(".sonar");
   }
 }

lib/src/test/java/org/sonarsource/scanner/lib/EnvironmentConfigTest.java

@@ -37,10 +37,12 @@ class EnvironmentConfigTest {
   @Test
   void shouldProcessSpecificEnvVariables() {
     var inputProperties = EnvironmentConfig.load(
-      Map.of("SONAR_HOST_URL", "http://foo"), logOutput);
+      Map.of("SONAR_HOST_URL", "http://foo",
+        "SONAR_USER_HOME", "my/user/home"), logOutput);
 
     assertThat(inputProperties).containsOnly(
-      entry("sonar.host.url", "http://foo"));
+      entry("sonar.host.url", "http://foo"),
+      entry("sonar.userHome", "my/user/home"));
   }
 
   @Test

lib/src/test/java/org/sonarsource/scanner/lib/internal/cache/FileCacheBuilderTest.java

@@ -38,7 +38,7 @@ public class FileCacheBuilderTest {
   @Test
   public void setUserHome() throws Exception {
     File userHome = temp.newFolder();
-    FileCache cache = new FileCacheBuilder(mock(Logger.class)).setUserHome(userHome).build();
+    FileCache cache = new FileCacheBuilder(mock(Logger.class)).setSonarUserHome(userHome.getAbsolutePath()).build();
 
     assertThat(cache.getDir()).isDirectory().exists();
     assertThat(cache.getDir().getName()).isEqualTo("cache");
@@ -47,7 +47,7 @@ public void setUserHome() throws Exception {
 
   @Test
   public void user_home_property_can_be_null() {
-    FileCache cache = new FileCacheBuilder(mock(Logger.class)).setUserHome((String) null).build();
+    FileCache cache = new FileCacheBuilder(mock(Logger.class)).setSonarUserHome((String) null).build();
 
     // does not fail. It uses default path or env variable
     assertThat(cache.getDir()).isDirectory().exists();
@@ -62,7 +62,7 @@ public void user_home_property_can_be_a_symlink() throws IOException {
     symlink.delete();
     Files.createSymbolicLink(symlink.toPath(), realSonarHome.toPath());
 
-    FileCache cache = new FileCacheBuilder(mock(Logger.class)).setUserHome(symlink).build();
+    FileCache cache = new FileCacheBuilder(mock(Logger.class)).setSonarUserHome(symlink.getAbsolutePath()).build();
 
     assertThat(cache.getDir()).isDirectory().exists();
     assertThat(cache.getDir().getName()).isEqualTo("cache");

pom.xml

@@ -112,7 +112,7 @@
       <dependency>
         <groupId>org.assertj</groupId>
         <artifactId>assertj-core</artifactId>
-        <version>3.11.1</version>
+        <version>3.24.2</version>
       </dependency>
       <dependency>
         <groupId>commons-codec</groupId>