SCANJLIB-263 Fix regression when host URL contains a path (#239)

Also improve error messages on HTTP errors.

Author: henryju

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

@@ -207,7 +207,7 @@ public void simple_analysis_with_proxy_auth() throws Exception {
 
     BuildResult buildResult = scanner.executeSimpleProject(project("js-sample"), ORCHESTRATOR.getServer().getUrl(), params, Map.of());
     assertThat(buildResult.getLastStatus()).isNotZero();
-    assertThat(buildResult.getLogs()).contains("Failed to query server version: HTTP 407 Proxy Authentication Required.");
+    assertThat(buildResult.getLogs()).containsPattern("Failed to query server version: GET http://(.*)/api/server/version failed with HTTP 407 Proxy Authentication Required.");
     assertThat(seenByProxy).isEmpty();
 
     params.put("sonar.scanner.proxyUser", PROXY_USER);

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

@@ -275,28 +275,17 @@ private static String getServerVersion(ScannerHttpClient scannerHttpClient) {
         }
         return serverVersion;
       } catch (Exception e2) {
-        var ex = new MessageException("Failed to query server version: " + formatMessage(e2), e2);
+        var ex = new MessageException("Failed to query server version: " + e2.getMessage(), e2);
         if (!e2.equals(httpException)) {
           ex.addSuppressed(httpException);
         }
         throw ex;
       }
     } catch (Exception e) {
-      throw new MessageException("Failed to query server version: " + formatMessage(e), e);
+      throw new MessageException("Failed to query server version: " + e.getMessage(), e);
     }
   }
 
-  private static String formatMessage(Exception e) {
-    if (e instanceof HttpException) {
-      String message = "HTTP " + ((HttpException) e).getCode();
-      if (StringUtils.isNotBlank(e.getMessage())) {
-        message += " " + e.getMessage();
-      }
-      return message;
-    }
-    return e.getMessage();
-  }
-
   private void initBootstrapDefaultValues(ScannerEndpoint endpoint) {
     setBootstrapPropertyIfNotAlreadySet(ScannerProperties.HOST_URL, endpoint.getWebEndpoint());
     setBootstrapPropertyIfNotAlreadySet(ScannerProperties.API_BASE_URL, endpoint.getApiEndpoint());

lib/src/main/java/org/sonarsource/scanner/lib/internal/endpoint/SonarQubeServer.java

@@ -19,7 +19,7 @@
  */
 package org.sonarsource.scanner.lib.internal.endpoint;
 
-import java.net.URI;
+import org.apache.commons.lang3.StringUtils;
 
 public class SonarQubeServer extends ScannerEndpoint {
 
@@ -28,7 +28,7 @@ public SonarQubeServer(String webEndpoint) {
   }
 
   private static String buildApiEndpoint(String webEndpoint) {
-    return URI.create(webEndpoint).resolve("/api/v2").toString();
+    return StringUtils.removeEnd(webEndpoint, "/") + "/api/v2";
   }
 
 }

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

@@ -80,8 +80,8 @@ private static ScannerEngineMetadata getScannerEngineMetadata(ScannerHttpClient
     try {
       String response = scannerHttpClient.callRestApi(API_PATH_ENGINE);
       return new Gson().fromJson(response, ScannerEngineMetadata.class);
-    } catch (IOException e) {
-      throw new IllegalStateException("Failed to get scanner-engine metadata", e);
+    } catch (Exception e) {
+      throw new IllegalStateException("Failed to get the scanner-engine metadata", e);
     }
   }
 

lib/src/main/java/org/sonarsource/scanner/lib/internal/facade/inprocess/BootstrapIndexDownloader.java

@@ -42,12 +42,12 @@ Collection<JarEntry> getIndex() {
       index = conn.callWebApi("/batch/index");
       LOG.debug("Get bootstrap completed");
     } catch (Exception e) {
-      throw new IllegalStateException("Fail to get bootstrap index from server", e);
+      throw new IllegalStateException("Failed to get the bootstrap index from the server", e);
     }
     return parse(index);
   }
 
-  private Collection<JarEntry> parse(String index) {
+  private static Collection<JarEntry> parse(String index) {
     final Collection<JarEntry> entries = new ArrayList<>();
 
     String[] lines = index.split("[\r\n]+");
@@ -60,7 +60,7 @@ private Collection<JarEntry> parse(String index) {
         entries.add(new JarEntry(filename, hash));
       } catch (Exception e) {
         LOG.error("Failed bootstrap index response: {}", index);
-        throw new IllegalStateException("Fail to parse entry in bootstrap index: " + line);
+        throw new IllegalStateException("Failed to parse the entry in the bootstrap index: " + line);
       }
     }
 

lib/src/main/java/org/sonarsource/scanner/lib/internal/http/HttpException.java

@@ -20,44 +20,31 @@
 package org.sonarsource.scanner.lib.internal.http;
 
 import java.net.URL;
-import java.util.Objects;
 import javax.annotation.Nullable;
+import org.apache.commons.lang3.StringUtils;
+import org.slf4j.LoggerFactory;
 
 public class HttpException extends RuntimeException {
-  private final URL requestUrl;
   private final int code;
-  @Nullable
-  private final String body;
 
-  public HttpException(URL requestUrl, int code, String message, @Nullable String body) {
-    super(message);
-    this.requestUrl = requestUrl;
-    this.code = code;
-    this.body = body;
+  public HttpException(URL requestUrl, int statusCode, String statusText, @Nullable String body) {
+    super(formatMessage(requestUrl, statusCode, statusText, body));
+    this.code = statusCode;
   }
 
-  public URL getRequestUrl() {
-    return requestUrl;
+  private static String formatMessage(URL requestUrl, int code, String statusText, @Nullable String body) {
+    String message = "GET " + requestUrl + " failed with HTTP " + code;
+    if (StringUtils.isNotBlank(statusText)) {
+      message += " " + statusText;
+    }
+    if (LoggerFactory.getLogger(HttpException.class).isDebugEnabled() && StringUtils.isNotBlank(body)) {
+      message += "\n" + body;
+    }
+    return message;
   }
 
   public int getCode() {
     return code;
   }
 
-  @Nullable
-  public String getBody() {
-    return body;
-  }
-
-  @Override
-  public boolean equals(Object o) {
-    if (!(o instanceof HttpException)) return false;
-    HttpException that = (HttpException) o;
-    return code == that.code && Objects.equals(requestUrl, that.requestUrl) && Objects.equals(body, that.body) && Objects.equals(getMessage(), that.getMessage());
-  }
-
-  @Override
-  public int hashCode() {
-    return Objects.hash(requestUrl, code, body, getMessage());
-  }
 }

lib/src/main/java/org/sonarsource/scanner/lib/internal/http/ScannerHttpClient.java

@@ -79,7 +79,6 @@ public void downloadFromExternalUrl(String url, Path toFile) {
    * @param url            the URL of the file to download
    * @param toFile         the target file
    * @param authentication if true, the request will be authenticated with the token
-   * @throws IOException           if connectivity problem or timeout (network) or IO error (when writing to file)
    * @throws IllegalStateException if HTTP response code is different than 2xx
    */
   private void downloadFile(String url, Path toFile, boolean authentication) {
@@ -96,15 +95,15 @@ private void downloadFile(String url, Path toFile, boolean authentication) {
     });
   }
 
-  public String callRestApi(String urlPath) throws IOException {
+  public String callRestApi(String urlPath) {
     if (!urlPath.startsWith("/")) {
       throw new IllegalArgumentException(format(EXCEPTION_MESSAGE_MISSING_SLASH, urlPath));
     }
     String url = httpConfig.getRestApiBaseUrl() + urlPath;
     return callApi(url);
   }
 
-  public String callWebApi(String urlPath) throws IOException {
+  public String callWebApi(String urlPath) {
     if (!urlPath.startsWith("/")) {
       throw new IllegalArgumentException(format(EXCEPTION_MESSAGE_MISSING_SLASH, urlPath));
     }
@@ -116,7 +115,6 @@ public String callWebApi(String urlPath) throws IOException {
    * Call a server API and get the response as a string.
    *
    * @param url the url to call
-   * @throws IOException           if connectivity problem or timeout (network)
    * @throws IllegalStateException if HTTP response code is different than 2xx
    */
   private String callApi(String url) {

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

@@ -82,7 +82,7 @@ class ScannerEngineBootstrapperTest {
   private Path dumpFile;
 
   @BeforeEach
-  public void setUp() {
+  void setUp() {
     this.dumpFile = dumpToFolder.resolve("dump.properties");
 
     when(system.getProperty("os.name")).thenReturn("linux_ubuntu");
@@ -121,18 +121,19 @@ void should_use_new_bootstrapping_with_sonarqube_10_6() throws Exception {
 
   @Test
   void should_report_apiv2_error_with_sq_10_6_even_if_older_version_ws_succeeded() throws Exception {
-    when(scannerHttpClient.callRestApi("/analysis/version")).thenThrow(new HttpException(URI.create("http://myserver").toURL(), 401, "", null));
+    when(scannerHttpClient.callRestApi("/analysis/version")).thenThrow(new HttpException(URI.create("http://myserver/api/v2/analysis/version").toURL(), 401, "", null));
     when(scannerHttpClient.callWebApi("/api/server/version")).thenReturn(SQ_VERSION_NEW_BOOTSTRAPPING);
     try (var bootstrapResult = underTest.setBootstrapProperty(ScannerProperties.HOST_URL, "http://localhost").bootstrap()) {
       assertThat(bootstrapResult.isSuccessful()).isFalse();
     }
 
-    assertThat(logTester.logs(Level.ERROR)).contains("Failed to query server version: HTTP 401. Please check the property sonar.token or the environment variable SONAR_TOKEN.");
+    assertThat(logTester.logs(Level.ERROR))
+      .contains("Failed to query server version: GET http://myserver/api/v2/analysis/version failed with HTTP 401. Please check the property sonar.token or the environment variable SONAR_TOKEN.");
   }
 
   @Test
   void should_report_technical_errors() throws Exception {
-    when(scannerHttpClient.callRestApi("/analysis/version")).thenThrow(new IOException("Socket closed"));
+    when(scannerHttpClient.callRestApi("/analysis/version")).thenThrow(new IllegalStateException("Socket closed"));
     try (var bootstrapResult = underTest.setBootstrapProperty(ScannerProperties.HOST_URL, "http://localhost").bootstrap()) {
       assertThat(bootstrapResult.isSuccessful()).isFalse();
     }
@@ -220,16 +221,16 @@ void should_show_help_on_proxy_auth_error() throws Exception {
 
     ScannerEngineBootstrapper bootstrapper = new ScannerEngineBootstrapper("Gradle", "3.1", system, scannerHttpClient,
       launcherFactory, scannerEngineLauncherFactory);
-    when(scannerHttpClient.callRestApi("/analysis/version")).thenThrow(new HttpException(URI.create("http://myserver").toURL(), 407, "Proxy Authentication Required", null));
-    when(scannerHttpClient.callWebApi("/api/server/version")).thenThrow(new HttpException(URI.create("http://myserver").toURL(), 407, "Proxy Authentication Required", null));
+    when(scannerHttpClient.callRestApi("/analysis/version")).thenThrow(new HttpException(URI.create("http://myserver/analysis/version").toURL(), 407, "Proxy Authentication Required", null));
+    when(scannerHttpClient.callWebApi("/api/server/version")).thenThrow(new HttpException(URI.create("http://myserver/api/server/version").toURL(), 407, "Proxy Authentication Required", null));
 
     logTester.setLevel(Level.DEBUG);
 
     try (var result = bootstrapper.setBootstrapProperty(ScannerProperties.HOST_URL, "http://myserver").bootstrap()) {
       assertThat(result.isSuccessful()).isFalse();
     }
 
-    assertThat(logTester.logs(Level.ERROR)).contains("Failed to query server version: HTTP 407 Proxy Authentication Required. Please check the properties sonar.scanner.proxyUser and " +
+    assertThat(logTester.logs(Level.ERROR)).contains("Failed to query server version: GET http://myserver/api/server/version failed with HTTP 407 Proxy Authentication Required. Please check the properties sonar.scanner.proxyUser and " +
       "sonar.scanner.proxyPassword.");
     assertThatNoServerTypeIsLogged();
   }
@@ -242,8 +243,8 @@ void should_preserve_both_exceptions_when_checking_version() throws Exception {
 
     ScannerEngineBootstrapper bootstrapper = new ScannerEngineBootstrapper("Gradle", "3.1", system, scannerHttpClient,
       launcherFactory, scannerEngineLauncherFactory);
-    when(scannerHttpClient.callRestApi("/analysis/version")).thenThrow(new HttpException(URI.create("http://myserver").toURL(), 404, "Not Found", null));
-    when(scannerHttpClient.callWebApi("/api/server/version")).thenThrow(new HttpException(URI.create("http://myserver").toURL(), 400, "Server Error", null));
+    when(scannerHttpClient.callRestApi("/analysis/version")).thenThrow(new HttpException(URI.create("http://myserver/analysis/version").toURL(), 404, "Not Found", null));
+    when(scannerHttpClient.callWebApi("/api/server/version")).thenThrow(new HttpException(URI.create("http://myserver/api/server/version").toURL(), 400, "Server Error", null));
 
     logTester.setLevel(Level.DEBUG);
 
@@ -253,11 +254,11 @@ void should_preserve_both_exceptions_when_checking_version() throws Exception {
 
     var loggedError = logTester.logEvents(Level.ERROR);
     assertThat(loggedError).hasSize(1);
-    assertThat(loggedError.get(0).getFormattedMessage()).contains("Failed to query server version: HTTP 400 Server Error");
+    assertThat(loggedError.get(0).getFormattedMessage()).contains("Failed to query server version: GET http://myserver/api/server/version failed with HTTP 400 Server Error");
     assertThat(ThrowableProxyUtil.asString(loggedError.get(0).getThrowableProxy()))
       .containsSubsequence(
-        "Suppressed: org.sonarsource.scanner.lib.internal.http.HttpException: Not Found",
-        "Caused by: org.sonarsource.scanner.lib.internal.http.HttpException: Server Error");
+        "Suppressed: org.sonarsource.scanner.lib.internal.http.HttpException: GET http://myserver/analysis/version failed with HTTP 404 Not Found",
+        "Caused by: org.sonarsource.scanner.lib.internal.http.HttpException: GET http://myserver/api/server/version failed with HTTP 400 Server Error");
     assertThatNoServerTypeIsLogged();
   }
 
@@ -278,7 +279,7 @@ void should_log_user_friendly_message_when_auth_error(int code) throws Exception
       assertThat(result.isSuccessful()).isFalse();
     }
 
-    assertThat(logTester.logs(Level.ERROR)).contains("Failed to query server version: HTTP " + code + " Unauthorized. Please check the property sonar.token or the environment variable SONAR_TOKEN" +
+    assertThat(logTester.logs(Level.ERROR)).contains("Failed to query server version: GET http://myserver failed with HTTP " + code + " Unauthorized. Please check the property sonar.token or the environment variable SONAR_TOKEN" +
       ".");
     assertThatNoServerTypeIsLogged();
   }

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

@@ -44,7 +44,7 @@ class FileCacheTest {
   private Path temp;
 
   @BeforeEach
-  public void setUp() {
+  void setUp() {
     fileHashes = mock(FileHashes.class);
     cache = new FileCache(temp, fileHashes);
   }

lib/src/test/java/org/sonarsource/scanner/lib/internal/endpoint/ScannerEndpointResolverTest.java

@@ -49,6 +49,17 @@ void should_recognize_sonarqube_cloud_endpoint_passed_through_host_url() {
     assertThat(endpoint.getApiEndpoint()).isEqualTo("https://api.sonarcloud.io");
   }
 
+  @Test
+  void should_recognize_sonarqube_server_endpoint_with_path() {
+    var props = Map.of(ScannerProperties.HOST_URL, "https://next.sonarqube.com/sonarqube");
+
+    var endpoint = ScannerEndpointResolver.resolveEndpoint(props);
+
+    assertThat(endpoint.isSonarQubeCloud()).isFalse();
+    assertThat(endpoint.getWebEndpoint()).isEqualTo("https://next.sonarqube.com/sonarqube");
+    assertThat(endpoint.getApiEndpoint()).isEqualTo("https://next.sonarqube.com/sonarqube/api/v2");
+  }
+
   @Test
   void should_recognize_sonarqube_cloud_endpoint_passed_through_cloud_url() {
     var props = Map.of(ScannerProperties.SONARQUBE_CLOUD_URL, "https://sonarcloud.io");