import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
+import java.util.Map;
import java.util.Set;
import javax.annotation.CheckForNull;
import org.apache.commons.lang.StringUtils;
private void failIfUnauthorized(WsResponse response) {
int code = response.code();
+
if (code == HTTP_UNAUTHORIZED) {
+ logResponseDetailsIfDebug(response);
response.close();
if (hasCredentials) {
// credentials are not valid
}
// not authenticated - see https://jira.sonarsource.com/browse/SONAR-4048
throw MessageException.of(format("Not authorized. Analyzing this project requires authentication. " +
- "Please check the user token in the property '%s' or the credentials in the properties '%s' and '%s'.",
+ "Please check the user token in the property '%s' or the credentials in the properties '%s' and '%s'.",
ScannerWsClientProvider.TOKEN_PROPERTY, CoreProperties.LOGIN, CoreProperties.PASSWORD));
}
if (code == HTTP_FORBIDDEN) {
+ logResponseDetailsIfDebug(response);
throw MessageException.of("You're not authorized to analyze this project or the project doesn't exist on SonarQube" +
- " and you're not authorized to create it. Please contact an administrator.");
+ " and you're not authorized to create it. Please contact an administrator.");
}
if (code == HTTP_BAD_REQUEST) {
String jsonMsg = tryParseAsJsonError(response.content());
throw MessageException.of(jsonMsg);
}
}
-
// if failed, throws an HttpException
response.failIfNotSuccessful();
}
+ private static void logResponseDetailsIfDebug(WsResponse response) {
+ if (!LOG.isDebugEnabled()) {
+ return;
+ }
+ String content = response.hasContent() ? response.content() : "<no content>";
+ Map<String, List<String>> headers = response.headers();
+ LOG.debug("Error response content: {}, headers: {}", content, headers);
+ }
+
private void checkAuthenticationWarnings(WsResponse response) {
if (response.code() == HTTP_OK) {
response.header(SQ_TOKEN_EXPIRATION_HEADER).ifPresent(expirationDate -> {
LOG.warn("Analysis executed with this token will fail after the expiration date.");
}
analysisWarnings.addUnique(warningMessage + "\nAfter this date, the token can no longer be used to execute the analysis. "
- + "Please consider generating a new token and updating it in the locations where it is in use.");
+ + "Please consider generating a new token and updating it in the locations where it is in use.");
}
/**
private final AnalysisWarnings analysisWarnings = mock(AnalysisWarnings.class);
@Test
- public void log_and_profile_request_if_debug_level() {
+ public void call_whenDebugLevel_shouldLogAndProfileRequest() {
WsRequest request = newRequest();
WsResponse response = newResponse().setRequestUrl("https://local/api/issues/search");
when(wsClient.wsConnector().call(request)).thenReturn(response);
}
@Test
- public void create_error_msg_from_json() {
+ public void createErrorMessage_whenJsonError_shouldCreateErrorMsg() {
String content = "{\"errors\":[{\"msg\":\"missing scan permission\"}, {\"msg\":\"missing another permission\"}]}";
assertThat(DefaultScannerWsClient.createErrorMessage(new HttpException("url", 400, content))).isEqualTo("missing scan permission, missing another permission");
}
@Test
- public void create_error_msg_from_html() {
+ public void createErrorMessage_whenHtml_shouldCreateErrorMsg() {
String content = "<!DOCTYPE html><html>something</html>";
assertThat(DefaultScannerWsClient.createErrorMessage(new HttpException("url", 400, content))).isEqualTo("HTTP code 400");
}
@Test
- public void create_error_msg_from_long_content() {
+ public void createErrorMessage_whenLongContent_shouldCreateErrorMsg() {
String content = StringUtils.repeat("mystring", 1000);
assertThat(DefaultScannerWsClient.createErrorMessage(new HttpException("url", 400, content))).hasSize(15 + 128);
}
@Test
- public void fail_if_requires_credentials() {
+ public void call_whenUnauthorizedAndDebugEnabled_shouldLogResponseDetails() {
WsRequest request = newRequest();
- WsResponse response = newResponse().setCode(401);
+ WsResponse response = newResponse()
+ .setContent("Missing credentials")
+ .setHeader("Authorization: ", "Bearer ImNotAValidToken")
+ .setCode(403);
+
+ logTester.setLevel(LoggerLevel.DEBUG);
+
when(wsClient.wsConnector().call(request)).thenReturn(response);
- assertThatThrownBy(() -> new DefaultScannerWsClient(wsClient, false,
- new GlobalAnalysisMode(new ScannerProperties(Collections.emptyMap())), analysisWarnings).call(request))
- .isInstanceOf(MessageException.class)
- .hasMessage("Not authorized. Analyzing this project requires authentication. Please check the user token in the property 'sonar.token' " +
- "or the credentials in the properties 'sonar.login' and 'sonar.password'.");
+ DefaultScannerWsClient client = new DefaultScannerWsClient(wsClient, false,
+ new GlobalAnalysisMode(new ScannerProperties(Collections.emptyMap())), analysisWarnings);
+ assertThatThrownBy(() -> client.call(request))
+ .isInstanceOf(MessageException.class)
+ .hasMessage(
+ "You're not authorized to analyze this project or the project doesn't exist on SonarQube and you're not authorized to create it. Please contact an administrator.");
+
+ List<String> debugLogs = logTester.logs(Level.DEBUG);
+ assertThat(debugLogs).hasSize(2);
+ assertThat(debugLogs.get(1)).contains("Error response content: Missing credentials, headers: {Authorization: =[Bearer ImNotAValidToken]}");
}
@Test
- public void fail_if_credentials_are_not_valid() {
+ public void call_whenUnauthenticatedAndDebugEnabled_shouldLogResponseDetails() {
WsRequest request = newRequest();
- WsResponse response = newResponse().setCode(401);
+ WsResponse response = newResponse()
+ .setContent("Missing authentication")
+ .setHeader("X-Test-Header: ", "ImATestHeader")
+ .setCode(401);
+
+ logTester.setLevel(LoggerLevel.DEBUG);
+
+ when(wsClient.wsConnector().call(request)).thenReturn(response);
+
+ DefaultScannerWsClient client = new DefaultScannerWsClient(wsClient, false,
+ new GlobalAnalysisMode(new ScannerProperties(Collections.emptyMap())), analysisWarnings);
+ assertThatThrownBy(() -> client.call(request))
+ .isInstanceOf(MessageException.class)
+ .hasMessage("Not authorized. Analyzing this project requires authentication. Please check the user token in the property 'sonar.token' " +
+ "or the credentials in the properties 'sonar.login' and 'sonar.password'.");
+
+ List<String> debugLogs = logTester.logs(Level.DEBUG);
+ assertThat(debugLogs).hasSize(2);
+ assertThat(debugLogs.get(1)).contains("Error response content: Missing authentication, headers: {X-Test-Header: =[ImATestHeader]}");
+ }
+
+ @Test
+ public void call_whenMissingCredentials_shouldFailWithMsg() {
+ WsRequest request = newRequest();
+ WsResponse response = newResponse()
+ .setContent("Missing authentication")
+ .setCode(401);
+ when(wsClient.wsConnector().call(request)).thenReturn(response);
+
+ DefaultScannerWsClient client = new DefaultScannerWsClient(wsClient, false,
+ new GlobalAnalysisMode(new ScannerProperties(Collections.emptyMap())), analysisWarnings);
+ assertThatThrownBy(() -> client.call(request))
+ .isInstanceOf(MessageException.class)
+ .hasMessage("Not authorized. Analyzing this project requires authentication. Please check the user token in the property 'sonar.token' " +
+ "or the credentials in the properties 'sonar.login' and 'sonar.password'.");
+ }
+
+ @Test
+ public void call_whenInvalidCredentials_shouldFailWithMsg() {
+ WsRequest request = newRequest();
+ WsResponse response = newResponse()
+ .setContent("Invalid credentials")
+ .setCode(401);
when(wsClient.wsConnector().call(request)).thenReturn(response);
- assertThatThrownBy(() -> new DefaultScannerWsClient(wsClient, /* credentials are configured */true,
- new GlobalAnalysisMode(new ScannerProperties(Collections.emptyMap())), analysisWarnings).call(request))
- .isInstanceOf(MessageException.class)
- .hasMessage("Not authorized. Please check the user token in the property 'sonar.token' or the credentials in the properties 'sonar.login' and 'sonar.password'.");
+ DefaultScannerWsClient client = new DefaultScannerWsClient(wsClient, /* credentials are configured */true,
+ new GlobalAnalysisMode(new ScannerProperties(Collections.emptyMap())), analysisWarnings);
+ assertThatThrownBy(() -> client.call(request))
+ .isInstanceOf(MessageException.class)
+ .hasMessage("Not authorized. Please check the user token in the property 'sonar.token' or the credentials in the properties 'sonar.login' and 'sonar.password'.");
}
@Test
- public void fail_if_requires_permission() {
+ public void call_whenMissingPermissions_shouldFailWithMsg() {
WsRequest request = newRequest();
WsResponse response = newResponse()
+ .setContent("Unauthorized")
.setCode(403);
when(wsClient.wsConnector().call(request)).thenReturn(response);
- assertThatThrownBy(() -> new DefaultScannerWsClient(wsClient, true,
- new GlobalAnalysisMode(new ScannerProperties(Collections.emptyMap())), analysisWarnings).call(request))
- .isInstanceOf(MessageException.class)
- .hasMessage("You're not authorized to analyze this project or the project doesn't exist on SonarQube and you're not authorized to create it. Please contact an administrator.");
+ DefaultScannerWsClient client = new DefaultScannerWsClient(wsClient, true,
+ new GlobalAnalysisMode(new ScannerProperties(Collections.emptyMap())), analysisWarnings);
+ assertThatThrownBy(() -> client.call(request))
+ .isInstanceOf(MessageException.class)
+ .hasMessage(
+ "You're not authorized to analyze this project or the project doesn't exist on SonarQube and you're not authorized to create it. Please contact an administrator.");
}
@Test
- public void warnings_are_added_when_expiration_approaches() {
+ public void call_whenTokenExpirationApproaches_shouldLogWarnings() {
WsRequest request = newRequest();
var fiveDaysLatter = LocalDateTime.now().atZone(ZoneOffset.UTC).plusDays(5);
String expirationDate = DateTimeFormatter
logTester.setLevel(LoggerLevel.DEBUG);
DefaultScannerWsClient underTest = new DefaultScannerWsClient(wsClient, false, new GlobalAnalysisMode(new ScannerProperties(Collections.emptyMap())), analysisWarnings);
underTest.call(request);
- //the second call should not add the same warning twice
+ // the second call should not add the same warning twice
underTest.call(request);
// check logs
}
@Test
- public void fail_if_bad_request() {
+ public void call_whenBadRequest_shouldFailWithMessage() {
WsRequest request = newRequest();
WsResponse response = newResponse()
.setCode(400)
.setContent("{\"errors\":[{\"msg\":\"Boo! bad request! bad!\"}]}");
when(wsClient.wsConnector().call(request)).thenReturn(response);
- assertThatThrownBy(() -> new DefaultScannerWsClient(wsClient, true,
- new GlobalAnalysisMode(new ScannerProperties(Collections.emptyMap())), analysisWarnings).call(request))
- .isInstanceOf(MessageException.class)
- .hasMessage("Boo! bad request! bad!");
+ DefaultScannerWsClient client = new DefaultScannerWsClient(wsClient, true,
+ new GlobalAnalysisMode(new ScannerProperties(Collections.emptyMap())), analysisWarnings);
+ assertThatThrownBy(() -> client.call(request))
+ .isInstanceOf(MessageException.class)
+ .hasMessage("Boo! bad request! bad!");
}
private MockWsResponse newResponse() {
projects / sonarqube.git / commitdiff