123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184 |
- /*
- * SonarQube
- * Copyright (C) 2009-2022 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.sonar.alm.client.azure;
-
- import com.google.common.base.Strings;
- import com.google.gson.Gson;
- import com.google.gson.GsonBuilder;
- import com.google.gson.JsonSyntaxException;
- import java.io.IOException;
- import java.net.HttpURLConnection;
- import java.nio.charset.StandardCharsets;
- import java.util.function.Function;
- import javax.annotation.Nullable;
- import okhttp3.OkHttpClient;
- import okhttp3.Request;
- import okhttp3.RequestBody;
- import okhttp3.Response;
- import okhttp3.ResponseBody;
- import org.apache.commons.codec.binary.Base64;
- import org.sonar.alm.client.TimeoutConfiguration;
- import org.sonar.api.server.ServerSide;
- import org.sonar.api.utils.log.Logger;
- import org.sonar.api.utils.log.Loggers;
- import org.sonarqube.ws.client.OkHttpClientBuilder;
-
- import static org.sonar.api.internal.apachecommons.lang.StringUtils.isBlank;
- import static org.sonar.api.internal.apachecommons.lang.StringUtils.substringBeforeLast;
-
- @ServerSide
- public class AzureDevOpsHttpClient {
-
- private static final Logger LOG = Loggers.get(AzureDevOpsHttpClient.class);
-
- public static final String API_VERSION_3 = "api-version=3.0";
-
- protected static final String GET = "GET";
- protected static final String UNABLE_TO_CONTACT_AZURE_SERVER = "Unable to contact Azure DevOps server";
-
- protected final OkHttpClient client;
-
- public AzureDevOpsHttpClient(TimeoutConfiguration timeoutConfiguration) {
- client = new OkHttpClientBuilder()
- .setConnectTimeoutMs(timeoutConfiguration.getConnectTimeout())
- .setReadTimeoutMs(timeoutConfiguration.getReadTimeout())
- .build();
- }
-
- public void checkPAT(String serverUrl, String token) {
- String url = String.format("%s/_apis/projects?%s", getTrimmedUrl(serverUrl), API_VERSION_3);
- LOG.debug(String.format("check pat : [%s]", url));
- doGet(token, url);
- }
-
- public GsonAzureProjectList getProjects(String serverUrl, String token) {
- String url = String.format("%s/_apis/projects?%s", getTrimmedUrl(serverUrl), API_VERSION_3);
- LOG.debug(String.format("get projects : [%s]", url));
- return doGet(token, url, r -> buildGson().fromJson(r.body().charStream(), GsonAzureProjectList.class));
- }
-
- public GsonAzureProject getProject(String serverUrl, String token, String projectName) {
- String url = String.format("%s/_apis/projects/%s?%s", getTrimmedUrl(serverUrl), projectName, API_VERSION_3);
- LOG.debug(String.format("get project : [%s]", url));
- return doGet(token, url, r -> buildGson().fromJson(r.body().charStream(), GsonAzureProject.class));
-
- }
-
- public GsonAzureRepoList getRepos(String serverUrl, String token, @Nullable String projectName) {
- String url;
- if (projectName != null && !projectName.isEmpty()) {
- url = String.format("%s/%s/_apis/git/repositories?%s", getTrimmedUrl(serverUrl), projectName, API_VERSION_3);
- } else {
- url = String.format("%s/_apis/git/repositories?%s", getTrimmedUrl(serverUrl), API_VERSION_3);
- }
- LOG.debug(String.format("get repos : [%s]", url));
- return doGet(token, url, r -> buildGson().fromJson(r.body().charStream(), GsonAzureRepoList.class));
- }
-
- public GsonAzureRepo getRepo(String serverUrl, String token, String projectName, String repositoryName) {
- String url = String.format("%s/%s/_apis/git/repositories/%s?%s", getTrimmedUrl(serverUrl), projectName, repositoryName, API_VERSION_3);
- LOG.debug(String.format("get repo : [%s]", url));
- return doGet(token, url, r -> buildGson().fromJson(r.body().charStream(), GsonAzureRepo.class));
- }
-
- private void doGet(String token, String url) {
- Request request = prepareRequestWithToken(token, GET, url, null);
- doCall(request);
- }
-
- protected void doCall(Request request) {
- try (Response response = client.newCall(request).execute()) {
- checkResponseIsSuccessful(response);
- } catch (IOException e) {
- throw new IllegalArgumentException(UNABLE_TO_CONTACT_AZURE_SERVER, e);
- }
- }
-
- protected <G> G doGet(String token, String url, Function<Response, G> handler) {
- Request request = prepareRequestWithToken(token, GET, url, null);
- return doCall(request, handler);
- }
-
- protected <G> G doCall(Request request, Function<Response, G> handler) {
- try (Response response = client.newCall(request).execute()) {
- checkResponseIsSuccessful(response);
- return handler.apply(response);
- } catch (JsonSyntaxException e) {
- throw new IllegalArgumentException(UNABLE_TO_CONTACT_AZURE_SERVER + ", got an unexpected response", e);
- } catch (IOException e) {
- throw new IllegalArgumentException(UNABLE_TO_CONTACT_AZURE_SERVER, e);
- }
- }
-
- protected static Request prepareRequestWithToken(String token, String method, String url, @Nullable RequestBody body) {
- return new Request.Builder()
- .method(method, body)
- .url(url)
- .addHeader("Authorization", encodeToken("accessToken:" + token))
- .build();
- }
-
- protected static void checkResponseIsSuccessful(Response response) throws IOException {
- if (!response.isSuccessful()) {
- LOG.debug(UNABLE_TO_CONTACT_AZURE_SERVER + ": {} {}", response.request().url().toString(), response.code());
- if (response.code() == HttpURLConnection.HTTP_UNAUTHORIZED) {
- throw new AzureDevopsServerException(response.code(), "Invalid personal access token");
- }
- ResponseBody responseBody = response.body();
- String body = responseBody == null ? "" : responseBody.string();
- String errorMessage = generateErrorMessage(body, UNABLE_TO_CONTACT_AZURE_SERVER);
- LOG.info(String.format("Azure API call to [%s] failed with %s http code. Azure response content : [%s]", response.request().url().toString(), response.code(), body));
- throw new AzureDevopsServerException(response.code(), errorMessage);
- }
- }
-
- protected static String generateErrorMessage(String body, String defaultMessage) {
- GsonAzureError gsonAzureError = null;
- try {
- gsonAzureError = buildGson().fromJson(body, GsonAzureError.class);
- } catch (JsonSyntaxException e) {
- // not a json payload, ignore the error
- }
- if (gsonAzureError != null && !Strings.isNullOrEmpty(gsonAzureError.message())) {
- return defaultMessage + " : " + gsonAzureError.message();
- } else {
- return defaultMessage;
- }
- }
-
- protected static String getTrimmedUrl(String rawUrl) {
- if (isBlank(rawUrl)) {
- return rawUrl;
- }
- if (rawUrl.endsWith("/")) {
- return substringBeforeLast(rawUrl, "/");
- }
- return rawUrl;
- }
-
- protected static String encodeToken(String token) {
- return String.format("BASIC %s", Base64.encodeBase64String(token.getBytes(StandardCharsets.UTF_8)));
- }
-
- protected static Gson buildGson() {
- return new GsonBuilder()
- .create();
- }
- }
|