-
Notifications
You must be signed in to change notification settings - Fork 70
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Azure DevOps Server support #754
Open
vinokurig
wants to merge
3
commits into
main
Choose a base branch
from
che-23306
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
146 changes: 146 additions & 0 deletions
146
...main/java/org/eclipse/che/api/factory/server/azure/devops/AzureDevOpsServerApiClient.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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); | ||
} | ||
} | ||
} |
52 changes: 52 additions & 0 deletions
52
...n/java/org/eclipse/che/api/factory/server/azure/devops/AzureDevOpsServerUserIdentity.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
+ '\'' | ||
+ '}'; | ||
} | ||
} |
35 changes: 35 additions & 0 deletions
35
...ava/org/eclipse/che/api/factory/server/azure/devops/AzureDevOpsServerUserPreferences.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 + '\'' + '}'; | ||
} | ||
} |
59 changes: 59 additions & 0 deletions
59
...in/java/org/eclipse/che/api/factory/server/azure/devops/AzureDevOpsServerUserProfile.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
+ '\'' | ||
+ '}'; | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we refactor this fuction?
For instance, move
if (OAUTH_PROVIDER_NAME.equals(params.getScmProviderName())) {
beforeif (!isValidScmServerUrl(params.getScmProviderUrl())) {
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to check if the token belongs to Azure DevOps SAAS or Server first. The
isValidScmServerUrl
function name is a bit misleading, so I renamed it.