Add Azure DevOps Server support

Author: vinokurig

wsmaster/che-core-api-factory-azure-devops/src/main/java/org/eclipse/che/api/factory/server/azure/devops/AzureDevOps.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2023 Red Hat, Inc.
+ * Copyright (c) 2012-2025 Red Hat, Inc.
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
  * which is available at https://www.eclipse.org/legal/epl-2.0/
@@ -23,6 +23,8 @@
 public class AzureDevOps {
   /** Name of this OAuth provider as found in OAuthAPI. */
   public static final String PROVIDER_NAME = "azure-devops";
+  /** Azure DevOps SAAS endpoint. */
+  public static final String SAAS_ENDPOINT = "https://dev.azure.com";
   /** Azure DevOps Service API version calls. */
   public static final String API_VERSION = "7.0";
 

wsmaster/che-core-api-factory-azure-devops/src/main/java/org/eclipse/che/api/factory/server/azure/devops/AzureDevOpsPersonalAccessTokenFetcher.java

@@ -51,7 +51,7 @@ public class AzureDevOpsPersonalAccessTokenFetcher implements PersonalAccessToke
       LoggerFactory.getLogger(AzureDevOpsPersonalAccessTokenFetcher.class);
   private static final String OAUTH_PROVIDER_NAME = "azure-devops";
   private final String cheApiEndpoint;
-  private final String azureDevOpsScmApiEndpoint;
+  private final String azureDevOpsSAASApiEndpoint;
   private final OAuthAPI oAuthAPI;
   private final String[] scopes;
 
@@ -60,12 +60,12 @@ public class AzureDevOpsPersonalAccessTokenFetcher implements PersonalAccessToke
   @Inject
   public AzureDevOpsPersonalAccessTokenFetcher(
       @Named("che.api") String cheApiEndpoint,
-      @Named("che.integration.azure.devops.scm.api_endpoint") String azureDevOpsScmApiEndpoint,
+      @Named("che.integration.azure.devops.scm.api_endpoint") String azureDevOpsSAASApiEndpoint,
       @Named("che.integration.azure.devops.application_scopes") String[] scopes,
       AzureDevOpsApiClient azureDevOpsApiClient,
       OAuthAPI oAuthAPI) {
     this.cheApiEndpoint = cheApiEndpoint;
-    this.azureDevOpsScmApiEndpoint = trimEnd(azureDevOpsScmApiEndpoint, '/');
+    this.azureDevOpsSAASApiEndpoint = trimEnd(azureDevOpsSAASApiEndpoint, '/');
     this.oAuthAPI = oAuthAPI;
     this.scopes = scopes;
     this.azureDevOpsApiClient = azureDevOpsApiClient;
@@ -88,7 +88,7 @@ private PersonalAccessToken fetchOrRefreshPersonalAccessToken(
       throws ScmUnauthorizedException, ScmCommunicationException, UnknownScmProviderException {
     OAuthToken oAuthToken;
 
-    if (!isValidScmServerUrl(scmServerUrl)) {
+    if (!isValidAzureDevOpsSAASUrl(scmServerUrl)) {
       LOG.debug("not a  valid url {} for current fetcher ", scmServerUrl);
       return null;
     }
@@ -147,7 +147,7 @@ private ScmUnauthorizedException buildScmUnauthorizedException(Subject cheSubjec
 
   @Override
   public Optional<Boolean> isValid(PersonalAccessToken personalAccessToken) {
-    if (!isValidScmServerUrl(personalAccessToken.getScmProviderUrl())) {
+    if (!isValidAzureDevOpsSAASUrl(personalAccessToken.getScmProviderUrl())) {
       LOG.debug("not a valid url {} for current fetcher ", personalAccessToken.getScmProviderUrl());
       return Optional.empty();
     }
@@ -174,9 +174,20 @@ public Optional<Boolean> isValid(PersonalAccessToken personalAccessToken) {
   @Override
   public Optional<Pair<Boolean, String>> isValid(PersonalAccessTokenParams params)
       throws ScmCommunicationException {
-    if (!isValidScmServerUrl(params.getScmProviderUrl())) {
-      LOG.debug("not a valid url {} for current fetcher ", params.getScmProviderUrl());
-      return Optional.empty();
+    if (!isValidAzureDevOpsSAASUrl(params.getScmProviderUrl())) {
+      if (OAUTH_PROVIDER_NAME.equals(params.getScmProviderName())) {
+        AzureDevOpsServerApiClient azureDevOpsServerApiClient =
+            new AzureDevOpsServerApiClient(params.getScmProviderUrl(), params.getOrganization());
+        try {
+          AzureDevOpsServerUserProfile user = azureDevOpsServerApiClient.getUser(params.getToken());
+          return Optional.of(Pair.of(Boolean.TRUE, user.getIdentity().getAccountName()));
+        } catch (ScmItemNotFoundException | ScmBadRequestException e) {
+          return Optional.empty();
+        }
+      } else {
+        LOG.debug("not a valid url {} for current fetcher ", params.getScmProviderUrl());
+        return Optional.empty();
+      }
     }
 
     try {
@@ -196,7 +207,7 @@ private String getLocalAuthenticateUrl() {
     return cheApiEndpoint + getAuthenticateUrlPath(scopes);
   }
 
-  private Boolean isValidScmServerUrl(String scmServerUrl) {
-    return azureDevOpsScmApiEndpoint.equals(trimEnd(scmServerUrl, '/'));
+  private Boolean isValidAzureDevOpsSAASUrl(String url) {
+    return azureDevOpsSAASApiEndpoint.equals(trimEnd(url, '/'));
   }
 }

wsmaster/che-core-api-factory-azure-devops/src/main/java/org/eclipse/che/api/factory/server/azure/devops/AzureDevOpsServerApiClient.java

@@ -0,0 +1,146 @@
+/*
+ * Copyright (c) 2012-2025 Red Hat, Inc.
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.api.factory.server.azure.devops;
+
+import static java.net.HttpURLConnection.HTTP_BAD_REQUEST;
+import static java.net.HttpURLConnection.HTTP_NOT_FOUND;
+import static java.net.HttpURLConnection.HTTP_NO_CONTENT;
+import static java.net.HttpURLConnection.HTTP_OK;
+import static java.nio.charset.StandardCharsets.UTF_8;
+import static java.time.Duration.ofSeconds;
+import static org.eclipse.che.commons.lang.StringUtils.trimEnd;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.common.base.Charsets;
+import com.google.common.io.CharStreams;
+import com.google.common.util.concurrent.ThreadFactoryBuilder;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.UncheckedIOException;
+import java.net.URI;
+import java.net.http.HttpClient;
+import java.net.http.HttpRequest;
+import java.net.http.HttpResponse;
+import java.time.Duration;
+import java.util.Base64;
+import java.util.concurrent.Executors;
+import java.util.function.Function;
+import org.eclipse.che.api.factory.server.scm.exception.ScmBadRequestException;
+import org.eclipse.che.api.factory.server.scm.exception.ScmCommunicationException;
+import org.eclipse.che.api.factory.server.scm.exception.ScmItemNotFoundException;
+import org.eclipse.che.commons.lang.concurrent.LoggingUncaughtExceptionHandler;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/** Azure DevOps Server API operations helper. */
+public class AzureDevOpsServerApiClient {
+
+  private static final Logger LOG = LoggerFactory.getLogger(AzureDevOpsServerApiClient.class);
+
+  private final HttpClient httpClient;
+  private final String azureDevOpsServerApiEndpoint;
+  private final String azureDevOpsServerCollection;
+  private static final Duration DEFAULT_HTTP_TIMEOUT = ofSeconds(10);
+  private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
+
+  public AzureDevOpsServerApiClient(
+      String azureDevOpsServerApiEndpoint, String azureDevOpsServerCollection) {
+    this.azureDevOpsServerApiEndpoint = trimEnd(azureDevOpsServerApiEndpoint, '/');
+    this.azureDevOpsServerCollection = azureDevOpsServerCollection;
+    this.httpClient =
+        HttpClient.newBuilder()
+            .executor(
+                Executors.newCachedThreadPool(
+                    new ThreadFactoryBuilder()
+                        .setUncaughtExceptionHandler(LoggingUncaughtExceptionHandler.getInstance())
+                        .setNameFormat(AzureDevOpsServerApiClient.class.getName() + "-%d")
+                        .setDaemon(true)
+                        .build()))
+            .connectTimeout(DEFAULT_HTTP_TIMEOUT)
+            .version(HttpClient.Version.HTTP_1_1)
+            .build();
+  }
+
+  /**
+   * Returns the user associated with the provided PAT.
+   *
+   * @param token personal access token.
+   */
+  public AzureDevOpsServerUserProfile getUser(String token)
+      throws ScmItemNotFoundException, ScmCommunicationException, ScmBadRequestException {
+    final String url =
+        String.format(
+            "%s/%s/_api/_common/GetUserProfile",
+            azureDevOpsServerApiEndpoint, azureDevOpsServerCollection);
+    return getUser(url, encodeAuthorizationHeader(token));
+  }
+
+  private static String encodeAuthorizationHeader(String token) {
+    return "Basic " + Base64.getEncoder().encodeToString((":" + token).getBytes(UTF_8));
+  }
+
+  private AzureDevOpsServerUserProfile getUser(String url, String authorizationHeader)
+      throws ScmItemNotFoundException, ScmCommunicationException, ScmBadRequestException {
+    final HttpRequest userDataRequest =
+        HttpRequest.newBuilder(URI.create(url))
+            .headers("Authorization", authorizationHeader)
+            .timeout(DEFAULT_HTTP_TIMEOUT)
+            .build();
+
+    LOG.trace("executeRequest={}", userDataRequest);
+    return executeRequest(
+        httpClient,
+        userDataRequest,
+        response -> {
+          try {
+            String result =
+                CharStreams.toString(new InputStreamReader(response.body(), Charsets.UTF_8));
+            return OBJECT_MAPPER.readValue(result, AzureDevOpsServerUserProfile.class);
+          } catch (IOException e) {
+            throw new UncheckedIOException(e);
+          }
+        });
+  }
+
+  private <T> T executeRequest(
+      HttpClient httpClient,
+      HttpRequest request,
+      Function<HttpResponse<InputStream>, T> responseConverter)
+      throws ScmBadRequestException, ScmItemNotFoundException, ScmCommunicationException {
+    try {
+      HttpResponse<InputStream> response =
+          httpClient.send(request, HttpResponse.BodyHandlers.ofInputStream());
+      LOG.trace("executeRequest={} response {}", request, response.statusCode());
+      if (response.statusCode() == HTTP_OK) {
+        return responseConverter.apply(response);
+      } else if (response.statusCode() == HTTP_NO_CONTENT) {
+        return null;
+      } else {
+        String body = CharStreams.toString(new InputStreamReader(response.body(), Charsets.UTF_8));
+        switch (response.statusCode()) {
+          case HTTP_BAD_REQUEST:
+            throw new ScmBadRequestException(body);
+          case HTTP_NOT_FOUND:
+            throw new ScmItemNotFoundException(body);
+          default:
+            throw new ScmCommunicationException(
+                "Unexpected status code " + response.statusCode() + " " + response,
+                response.statusCode(),
+                "azure-devops");
+        }
+      }
+    } catch (IOException | InterruptedException | UncheckedIOException e) {
+      throw new ScmCommunicationException(e.getMessage(), e);
+    }
+  }
+}

wsmaster/che-core-api-factory-azure-devops/src/main/java/org/eclipse/che/api/factory/server/azure/devops/AzureDevOpsServerUserIdentity.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2012-2025 Red Hat, Inc.
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.api.factory.server.azure.devops;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/** Azure DevOps Server user's identity. */
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class AzureDevOpsServerUserIdentity {
+  private String accountName;
+  private String mailAddress;
+
+  public String getAccountName() {
+    return accountName;
+  }
+
+  @JsonProperty("AccountName")
+  public void setAccountName(String accountName) {
+    this.accountName = accountName;
+  }
+
+  public String getMailAddress() {
+    return mailAddress;
+  }
+
+  @JsonProperty("MailAddress")
+  public void setMailAddress(String mailAddress) {
+    this.mailAddress = mailAddress;
+  }
+
+  @Override
+  public String toString() {
+    return "AzureDevOpsServerUserIdentity{"
+        + "accountName='"
+        + accountName
+        + '\''
+        + ", mailAddress='"
+        + mailAddress
+        + '\''
+        + '}';
+  }
+}

wsmaster/che-core-api-factory-azure-devops/src/main/java/org/eclipse/che/api/factory/server/azure/devops/AzureDevOpsServerUserPreferences.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2012-2025 Red Hat, Inc.
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.api.factory.server.azure.devops;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/** Azure DevOps Server user's preferences. */
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class AzureDevOpsServerUserPreferences {
+  private String preferredEmail;
+
+  public String getPreferredEmail() {
+    return preferredEmail;
+  }
+
+  @JsonProperty("PreferredEmail")
+  public void setPreferredEmail(String preferredEmail) {
+    this.preferredEmail = preferredEmail;
+  }
+
+  @Override
+  public String toString() {
+    return "AzureDevOpsServerUserPreferences{" + "preferredEmail='" + preferredEmail + '\'' + '}';
+  }
+}

wsmaster/che-core-api-factory-azure-devops/src/main/java/org/eclipse/che/api/factory/server/azure/devops/AzureDevOpsServerUserProfile.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2012-2025 Red Hat, Inc.
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.api.factory.server.azure.devops;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+
+/** Azure DevOps Server user's profile. */
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class AzureDevOpsServerUserProfile {
+  private AzureDevOpsServerUserIdentity identity;
+  private AzureDevOpsServerUserPreferences userPreferences;
+  private String defaultMailAddress;
+
+  public AzureDevOpsServerUserIdentity getIdentity() {
+    return identity;
+  }
+
+  public void setIdentity(AzureDevOpsServerUserIdentity identity) {
+    this.identity = identity;
+  }
+
+  public String getDefaultMailAddress() {
+    return defaultMailAddress;
+  }
+
+  public void setDefaultMailAddress(String defaultMailAddress) {
+    this.defaultMailAddress = defaultMailAddress;
+  }
+
+  public AzureDevOpsServerUserPreferences getUserPreferences() {
+    return userPreferences;
+  }
+
+  public void setUserPreferences(AzureDevOpsServerUserPreferences userPreferences) {
+    this.userPreferences = userPreferences;
+  }
+
+  @Override
+  public String toString() {
+    return "AzureDevOpsServerUserProfile{"
+        + "identity="
+        + identity
+        + ", userPreferences="
+        + userPreferences
+        + ", defaultMailAddress='"
+        + defaultMailAddress
+        + '\''
+        + '}';
+  }
+}