Merge pull request #59 from androidbod/feature/improve-connectivity-configuration-error-traceability-by-retaining-ioexception-and-parseexception-stacktraces-for-api-connection-exceptions

[JENKINS-75326] Improve api logging and fix issue caused by httpclient update

Author: kirk-fitz

src/main/java/org/quality/gates/sonar/api/ApiConnectionException.java

@@ -6,7 +6,7 @@
  */
 public class ApiConnectionException extends RuntimeException {
 
-    public ApiConnectionException(String message) {
-        super(message);
+    public ApiConnectionException(String message, Throwable cause) {
+        super(message, cause);
     }
 }

src/main/java/org/quality/gates/sonar/api/SonarHttpRequester.java

@@ -7,7 +7,9 @@
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Base64;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import org.apache.commons.lang.StringUtils;
 import org.apache.hc.client5.http.auth.AuthScope;
 import org.apache.hc.client5.http.auth.UsernamePasswordCredentials;
@@ -20,7 +22,6 @@
 import org.apache.hc.client5.http.protocol.HttpClientContext;
 import org.apache.hc.core5.http.HttpHeaders;
 import org.apache.hc.core5.http.NameValuePair;
-import org.apache.hc.core5.http.ParseException;
 import org.apache.hc.core5.http.io.entity.EntityUtils;
 import org.apache.hc.core5.http.message.BasicNameValuePair;
 import org.quality.gates.jenkins.plugin.JobConfigData;
@@ -66,7 +67,9 @@ public void setLogged(boolean logged) {
     private void loginApi(SonarInstance sonarInstance) {
         httpClientContext = HttpClientContext.create();
 
-        if (StringUtils.isNotEmpty(sonarInstance.getToken().getPlainText())) {
+        // For some reason the Token Secret can be null even if empty in the Global Configuration UI
+        if (sonarInstance.getToken() != null
+                && StringUtils.isNotEmpty(sonarInstance.getToken().getPlainText())) {
             token = sonarInstance.getToken().getPlainText();
             httpClient = HttpClientBuilder.create().build();
         } else {
@@ -121,19 +124,23 @@ private String executeGetRequest(CloseableHttpClient client, HttpGet request) th
             request.addHeader(HttpHeaders.AUTHORIZATION, authHeader);
         }
 
-        try (var response = client.execute(request, httpClientContext, classicHttpResponse -> classicHttpResponse)) {
-            var statusCode = response.getCode();
-            var entity = response.getEntity();
-            var returnResponse = EntityUtils.toString(entity);
+        try {
+            var responseMap = client.execute(request, httpClientContext, classicHttpResponse -> {
+                Map<String, Object> retVal = new HashMap<>();
+                retVal.put("statusCode", classicHttpResponse.getCode());
+                retVal.put("content", EntityUtils.toString(classicHttpResponse.getEntity()));
+                return retVal;
+            });
 
-            EntityUtils.consume(entity);
+            var statusCode = (Integer) responseMap.get("statusCode");
+            var returnResponse = responseMap.get("content").toString();
 
             if (statusCode != 200) {
                 throw new QGException("Expected status 200, got: " + statusCode + ". Response: " + returnResponse);
             }
 
             return returnResponse;
-        } catch (IOException | ParseException e) {
+        } catch (IOException e) {
             throw new QGException("GET execution error", e);
         }
     }

src/main/java/org/quality/gates/sonar/api/SonarHttpRequesterFactory.java

@@ -3,8 +3,6 @@
 import java.io.IOException;
 import org.apache.hc.client5.http.classic.methods.HttpGet;
 import org.apache.hc.client5.http.impl.classic.HttpClientBuilder;
-import org.apache.hc.client5.http.protocol.HttpClientContext;
-import org.apache.hc.core5.http.ParseException;
 import org.apache.hc.core5.http.io.entity.EntityUtils;
 import org.quality.gates.jenkins.plugin.SonarInstance;
 import org.quality.gates.sonar.api80.SonarHttpRequester80;
@@ -20,11 +18,9 @@ class SonarHttpRequesterFactory {
 
     static SonarHttpRequester getSonarHttpRequester(SonarInstance sonarInstance) {
         var request = new HttpGet(getSonarApiServerVersion(sonarInstance));
-        var context = HttpClientContext.create();
-
-        try (var client = HttpClientBuilder.create().build();
-                var response = client.execute(request, context, classicHttpResponse -> classicHttpResponse)) {
-            var sonarVersion = EntityUtils.toString(response.getEntity());
+        try (var client = HttpClientBuilder.create().build()) {
+            var sonarVersion = client.execute(
+                    request, classicHttpResponse -> EntityUtils.toString(classicHttpResponse.getEntity()));
 
             if (majorSonarVersion(sonarVersion) == 8 && minorSonarVersion(sonarVersion) <= 7) {
                 return new SonarHttpRequester80();
@@ -33,8 +29,8 @@ static SonarHttpRequester getSonarHttpRequester(SonarInstance sonarInstance) {
             } else {
                 throw new UnsuportedVersionException("Plugin doesn't support this version of sonar api!");
             }
-        } catch (IOException | ParseException e) {
-            throw new ApiConnectionException(e.getLocalizedMessage());
+        } catch (IOException e) {
+            throw new ApiConnectionException(e.getLocalizedMessage(), e);
         }
     }