SONAR-16567 add an analysis warning when using a token expiring in less than 7 days.

2 files changed, 46 insertions, 4 deletions

diff --git a/sonar-scanner-engine/src/main/java/org/sonar/scanner/bootstrap/DefaultScannerWsClient.java b/sonar-scanner-engine/src/main/java/org/sonar/scanner/bootstrap/DefaultScannerWsClient.java
index 8dc5dc3a39f..0be294a4f99 100644
--- a/sonar-scanner-engine/src/main/java/org/sonar/scanner/bootstrap/DefaultScannerWsClient.java
+++ b/sonar-scanner-engine/src/main/java/org/sonar/scanner/bootstrap/DefaultScannerWsClient.java
@@ -23,11 +23,18 @@ import com.google.gson.JsonArray;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
+import java.time.LocalDateTime;
+import java.time.ZoneOffset;
+import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
 import java.util.ArrayList;
+import java.util.HashSet;
 import java.util.List;
+import java.util.Set;
 import javax.annotation.CheckForNull;
 import org.apache.commons.lang.StringUtils;
 import org.sonar.api.CoreProperties;
+import org.sonar.api.notifications.AnalysisWarnings;
 import org.sonar.api.utils.MessageException;
 import org.sonar.api.utils.log.Logger;
 import org.sonar.api.utils.log.Loggers;
@@ -41,21 +48,28 @@ import org.sonarqube.ws.client.WsResponse;
 import static java.lang.String.format;
 import static java.net.HttpURLConnection.HTTP_BAD_REQUEST;
 import static java.net.HttpURLConnection.HTTP_FORBIDDEN;
+import static java.net.HttpURLConnection.HTTP_OK;
 import static java.net.HttpURLConnection.HTTP_UNAUTHORIZED;
+import static org.sonar.api.utils.DateUtils.DATETIME_FORMAT;
 import static org.sonar.api.utils.Preconditions.checkState;
 
 public class DefaultScannerWsClient implements ScannerWsClient {
   private static final int MAX_ERROR_MSG_LEN = 128;
+  private static final String SQ_TOKEN_EXPIRATION_HEADER = "sq-authentication-token-expiration";
   private static final Logger LOG = Loggers.get(DefaultScannerWsClient.class);
 
+  private final Set<String> warningMessages = new HashSet<>();
+
   private final WsClient target;
   private final boolean hasCredentials;
   private final GlobalAnalysisMode globalMode;
+  private final AnalysisWarnings analysisWarnings;
 
-  public DefaultScannerWsClient(WsClient target, boolean hasCredentials, GlobalAnalysisMode globalMode) {
+  public DefaultScannerWsClient(WsClient target, boolean hasCredentials, GlobalAnalysisMode globalMode, AnalysisWarnings analysisWarnings) {
     this.target = target;
     this.hasCredentials = hasCredentials;
     this.globalMode = globalMode;
+    this.analysisWarnings = analysisWarnings;
   }
 
   /**
@@ -73,6 +87,7 @@ public class DefaultScannerWsClient implements ScannerWsClient {
     WsResponse response = target.wsConnector().call(request);
     profiler.stopDebug(format("%s %d %s", request.getMethod(), response.code(), response.requestUrl()));
     failIfUnauthorized(response);
+    checkAuthenticationWarnings(response);
     return response;
   }
 
@@ -96,7 +111,6 @@ public class DefaultScannerWsClient implements ScannerWsClient {
       // not authenticated - see https://jira.sonarsource.com/browse/SONAR-4048
       throw MessageException.of(format("Not authorized. Analyzing this project requires authentication. "
         + "Please provide a user token in %s or other credentials in %s and %s.", CoreProperties.LOGIN, CoreProperties.LOGIN, CoreProperties.PASSWORD));
-
     }
     if (code == HTTP_FORBIDDEN) {
       throw MessageException.of("You're not authorized to run analysis. Please contact the project administrator.");
@@ -112,6 +126,33 @@ public class DefaultScannerWsClient implements ScannerWsClient {
     response.failIfNotSuccessful();
   }
 
+  private void checkAuthenticationWarnings(WsResponse response) {
+    if (response.code() == HTTP_OK) {
+      response.header(SQ_TOKEN_EXPIRATION_HEADER).ifPresent(expirationDate -> {
+        if (isTokenExpiringInOneWeek(expirationDate)) {
+          addAnalysisWarning(expirationDate);
+        }
+      });
+    }
+  }
+
+  private static boolean isTokenExpiringInOneWeek(String expirationDate) {
+    ZonedDateTime localDateTime = ZonedDateTime.now(ZoneOffset.UTC);
+    ZonedDateTime headerDateTime = LocalDateTime.from(DateTimeFormatter.ofPattern(DATETIME_FORMAT)
+      .parse(expirationDate)).minusDays(7).atZone(ZoneOffset.UTC);
+    return localDateTime.isAfter(headerDateTime);
+  }
+
+  private void addAnalysisWarning(String tokenExpirationDate) {
+    String warningMessage = "The token used for this analysis will expire on: " + tokenExpirationDate;
+    if (!warningMessages.contains(warningMessage)) {
+      warningMessages.add(warningMessage);
+      LOG.warn(warningMessage);
+      LOG.warn("Analysis executed with this token after the expiration date will fail.");
+    }
+    analysisWarnings.addUnique(warningMessage + "\nAnalysis executed with this token after the expiration date will fail.");
+  }
+
   /**
    * Tries to form a short and relevant error message from the exception, to be displayed in the console.
    */
diff --git a/sonar-scanner-engine/src/main/java/org/sonar/scanner/bootstrap/ScannerWsClientProvider.java b/sonar-scanner-engine/src/main/java/org/sonar/scanner/bootstrap/ScannerWsClientProvider.java
index 8e86aa8b0b4..7a45f5cc35a 100644
--- a/sonar-scanner-engine/src/main/java/org/sonar/scanner/bootstrap/ScannerWsClientProvider.java
+++ b/sonar-scanner-engine/src/main/java/org/sonar/scanner/bootstrap/ScannerWsClientProvider.java
@@ -20,6 +20,7 @@
 package org.sonar.scanner.bootstrap;
 
 import org.sonar.api.CoreProperties;
+import org.sonar.api.notifications.AnalysisWarnings;
 import org.sonar.api.utils.System2;
 import org.sonar.batch.bootstrapper.EnvironmentInformation;
 import org.sonarqube.ws.client.HttpConnector;
@@ -37,7 +38,7 @@ public class ScannerWsClientProvider {
 
   @Bean("DefaultScannerWsClient")
   public DefaultScannerWsClient provide(ScannerProperties scannerProps, EnvironmentInformation env, GlobalAnalysisMode globalMode,
-    System2 system) {
+    System2 system, AnalysisWarnings analysisWarnings) {
     String url = defaultIfBlank(scannerProps.property("sonar.host.url"), "http://localhost:9000");
     HttpConnector.Builder connectorBuilder = HttpConnector.newBuilder();
 
@@ -58,6 +59,6 @@ public class ScannerWsClientProvider {
     }
 
     return new DefaultScannerWsClient(WsClientFactories.getDefault().newClient(connectorBuilder.build()), login != null,
-      globalMode);
+      globalMode, analysisWarnings);
   }
 }