SCANNERAPI-180 sonarcloud.io a default host for BitbucketCloud

Make sonarcloud.io the default host when scanner is executed from BitbucketCloud pipeline.

Author: michal-duda-sonarsource

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

@@ -36,31 +36,40 @@
 
 /**
  * Entry point to run SonarQube analysis programmatically.
+ *
  * @since 2.2
  */
 public class EmbeddedScanner {
+  private static final String BITBUCKET_CLOUD_ENV_VAR = "BITBUCKET_BUILD_NUMBER";
+  private static final String SONARCLOUD_HOST = "https://sonarcloud.io";
   private final IsolatedLauncherFactory launcherFactory;
   private IsolatedLauncher launcher;
   private final LogOutput logOutput;
   private final Map<String, String> globalProperties = new HashMap<>();
   private final Logger logger;
   private final Set<String> classloaderMask = new HashSet<>();
   private final Set<String> classloaderUnmask = new HashSet<>();
+  private final System2 system;
 
-  EmbeddedScanner(IsolatedLauncherFactory bl, Logger logger, LogOutput logOutput) {
+  EmbeddedScanner(IsolatedLauncherFactory bl, Logger logger, LogOutput logOutput, System2 system) {
     this.logger = logger;
     this.launcherFactory = bl;
     this.logOutput = logOutput;
     this.classloaderUnmask.add("org.sonarsource.scanner.api.internal.batch.");
+    this.system = system;
   }
 
-  public static EmbeddedScanner create(String app, String version, final LogOutput logOutput) {
+  public static EmbeddedScanner create(String app, String version, final LogOutput logOutput, System2 system2) {
     Logger logger = new LoggerAdapter(logOutput);
-    return new EmbeddedScanner(new IsolatedLauncherFactory(logger), logger, logOutput)
+    return new EmbeddedScanner(new IsolatedLauncherFactory(logger), logger, logOutput, system2)
       .setGlobalProperty(InternalProperties.SCANNER_APP, app)
       .setGlobalProperty(InternalProperties.SCANNER_APP_VERSION, version);
   }
 
+  public static EmbeddedScanner create(String app, String version, final LogOutput logOutput) {
+    return create(app, version, logOutput, new System2());
+  }
+
   public Map<String, String> globalProperties() {
     return globalProperties;
   }
@@ -132,7 +141,12 @@ public void execute(Map<String, String> taskProps) {
   }
 
   private void initGlobalDefaultValues() {
-    setGlobalDefaultValue(ScannerProperties.HOST_URL, "http://localhost:9000");
+    if (system.getEnvironmentVariable(BITBUCKET_CLOUD_ENV_VAR) != null) {
+      setGlobalDefaultValue(ScannerProperties.HOST_URL, SONARCLOUD_HOST);
+      logger.info("Bitbucket Cloud Pipelines detected");
+    } else {
+      setGlobalDefaultValue(ScannerProperties.HOST_URL, "http://localhost:9000");
+    }
   }
 
   private void initAnalysisProperties(Map<String, String> p) {

api/src/main/java/org/sonarsource/scanner/api/System2.java

@@ -0,0 +1,33 @@
+/*
+ * SonarQube Scanner API
+ * Copyright (C) 2011-2018 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.api;
+
+import javax.annotation.CheckForNull;
+import javax.annotation.Nonnull;
+
+/**
+ * A proxy class for java.lang.System (for mocking).
+ */
+public class System2 {
+  @CheckForNull
+  public String getEnvironmentVariable(@Nonnull String key) {
+    return System.getenv(key);
+  }
+}

api/src/test/java/org/sonarsource/scanner/api/EmbeddedScannerTest.java

@@ -40,6 +40,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyMap;
 import static org.mockito.ArgumentMatchers.argThat;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verify;
@@ -62,15 +63,18 @@ public void should_create() {
   private IsolatedLauncher launcher;
   private EmbeddedScanner scanner;
   private Logger logger;
+  private System2 system;
 
   @Before
   public void setUp() {
     launcherFactory = mock(IsolatedLauncherFactory.class);
     launcher = mock(IsolatedLauncher.class);
     logger = mock(Logger.class);
+    system = mock(System2.class);
+
     when(launcher.getVersion()).thenReturn("5.2");
-    when(launcherFactory.createLauncher(any(Map.class), any(ClassloadRules.class))).thenReturn(launcher);
-    scanner = new EmbeddedScanner(launcherFactory, logger, mock(LogOutput.class));
+    when(launcherFactory.createLauncher(anyMap(), any(ClassloadRules.class))).thenReturn(launcher);
+    scanner = new EmbeddedScanner(launcherFactory, logger, mock(LogOutput.class), system);
   }
 
   @Test
@@ -94,6 +98,22 @@ public void test_app() {
     assertThat(scanner.appVersion()).isEqualTo("3.1");
   }
 
+  @Test
+  public void should_set_localhost_as_host_by_default() {
+    scanner.start();
+
+    assertThat(scanner.globalProperty("sonar.host.url", null)).isEqualTo("http://localhost:9000");
+  }
+
+  @Test
+  public void should_set_sonarcloud_as_host_if_executed_from_bitbucket_cloud() {
+    when(system.getEnvironmentVariable("BITBUCKET_BUILD_NUMBER")).thenReturn("123");
+
+    scanner.start();
+
+    assertThat(scanner.globalProperty("sonar.host.url", null)).isEqualTo("https://sonarcloud.io");
+  }
+
   @Test
   public void should_set_properties() {
     EmbeddedScanner scanner = EmbeddedScanner.create("test", "1.0", mock(LogOutput.class));
@@ -167,7 +187,7 @@ public boolean matches(Map o) {
   @Test
   public void should_launch_in_simulation_mode() throws IOException {
     launcherFactory = new IsolatedLauncherFactory(mock(Logger.class));
-    scanner = new EmbeddedScanner(launcherFactory, mock(Logger.class), mock(LogOutput.class));
+    scanner = new EmbeddedScanner(launcherFactory, mock(Logger.class), mock(LogOutput.class), system);
 
     File dump = temp.newFile();
     Map<String, String> p = new HashMap<>();