diff --git a/CHANGELOG.md b/CHANGELOG.md index 88c0fba5..2c539dbf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,20 @@ # Changelog +# 7.0.0 + +**Major release** +**Breaking changes** + +- Fixed issues: + - Issue: [GitChange.changeType: InvalidArgumentValueException: The body of the request contains invalid Json. #96](https://github.com/hkarthik7/azure-devops-java-sdk/issues/96) + - Issue: [is there a way to add comments? #103](https://github.com/hkarthik7/azure-devops-java-sdk/issues/103) + - Issue: [client attempts to always deserlilize the response regardless if there's an error #102](https://github.com/hkarthik7/azure-devops-java-sdk/issues/102) + - Issue: [LookupService keeps the first credentails of the first succesffull call and ignores credentials from subsequent calls #101](https://github.com/hkarthik7/azure-devops-java-sdk/issues/101) +- Removed support for legacy API +- Changes in types packages +- Added support for authentication via service principal client id and secret +- Added `Comments Api` + # 6.1.3 - Added support for Pull Request Iterations in **GitApi**. diff --git a/README.md b/README.md index bc470494..bfdbdd8c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ # azure-devops-java-sdk +# :loudspeaker: Legacy Api is decommissioned in v7.0.0. :exclamation::heavy_exclamation_mark: + [![Build Status](https://dev.azure.com/harishkarthic/azure-devops-java-sdk/_apis/build/status/hkarthik7.azure-devops-java-sdk?branchName=main)](https://dev.azure.com/harishkarthic/azure-devops-java-sdk/_build/latest?definitionId=8&branchName=main) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/hkarthik7/azure-devops-java-sdk/blob/main/LICENSE) [![Documentation Status](https://readthedocs.org/projects/azure-devops-java-sdk-docs/badge/?version=latest)](https://azure-devops-java-sdk-docs.readthedocs.io/en/latest/?badge=latest) -[![Maven Central](https://img.shields.io/maven-central/v/io.github.hkarthik7/azd.svg)](https://search.maven.org/artifact/io.github.hkarthik7/azd/6.1.3/jar) +[![Maven Central](https://img.shields.io/maven-central/v/io.github.hkarthik7/azd.svg)](https://search.maven.org/artifact/io.github.hkarthik7/azd/7.0.0/jar) **azd** library provides a convenient way to manage and interact with **Azure DevOps Services** REST API with ease. This SDK offers a set of APIs and utilities with declarative syntax and provide functionalities to the significant services. @@ -33,7 +35,7 @@ To download the library and use it in your project, just add below in your pom.x io.github.hkarthik7 azd - 6.1.3 + 7.0.0 ``` @@ -43,7 +45,7 @@ To download the library and use it in your project, just add below in your pom.x io.github.hkarthik7 azd - 6.1.3 + 7.0.0 javadoc ``` @@ -54,7 +56,7 @@ To download the library and use it in your project, just add below in your pom.x io.github.hkarthik7 azd - 6.1.3 + 7.0.0 sources ``` @@ -100,6 +102,31 @@ public class Main { } ``` +**Authentication using service principal** + +To use spn authentication you should create a new app registration in Entra ID, grant Api permissions on Azure DevOps, select right scope +and grant admin consent. + +```java +public class Main { + public static void main(String[] args) { + String project = "myProject"; + String baseUrl = "https://dev.azure.com/{organization}"; + // or TFS URL + String baseUrl = "https://{server:port}/tfs/{collection}"; + + String tenantId = "tenantId"; + String clientId = "clientId"; + String clientSecret = "clientSecret"; + + AccessTokenCredential spn = new ServicePrincipalAccessTokenCredential( + baseUrl, + project, tenantId, + clientId, clientSecret); + } +} +``` + - Sample usage ```java @@ -110,6 +137,8 @@ public class Main { AzDServiceClient client = AzDService.builder().authentication(pat).buildClient(); // or AzDServiceClient client = AzDService.builder().authentication(oauth).buildClient(); + // or + AzDServiceClient client = AzDService.builder().authentication(spn).buildClient(); try { // Get the list of projects. This return a future object. diff --git a/azd/pom.xml b/azd/pom.xml index 11b6f807..64d64103 100644 --- a/azd/pom.xml +++ b/azd/pom.xml @@ -6,7 +6,7 @@ io.github.hkarthik7 azd - 6.1.3 + 7.0.0 jar azd diff --git a/azd/src/main/java/org/azd/abstractions/ClientConfiguration.java b/azd/src/main/java/org/azd/abstractions/ClientConfiguration.java index 4ba753b6..025ce6ab 100644 --- a/azd/src/main/java/org/azd/abstractions/ClientConfiguration.java +++ b/azd/src/main/java/org/azd/abstractions/ClientConfiguration.java @@ -1,14 +1,11 @@ package org.azd.abstractions; -import org.azd.abstractions.handlers.RetryHandler; - /** * Singleton class that configures Api request options. */ public class ClientConfiguration { private final static ClientConfiguration instance = new ClientConfiguration(); private static RequestOption reqOption; - private static RetryHandler retry; private ClientConfiguration() { } @@ -29,14 +26,6 @@ public RequestOption getRequestOption() { return reqOption; } - /** - * Get the retry handler object. - * @return RetryHandler. - */ - public RetryHandler getRetryHandler() { - return retry; - } - /** * Configures the request option. * @param requestOption Request option object to configure. @@ -44,12 +33,4 @@ public RetryHandler getRetryHandler() { public void configureRequestOption(RequestOption requestOption) { reqOption = requestOption; } - - /** - * Configures the retry handler options. - * @param retryHandler Retry handler object to configure. - */ - public void configureRetryHandler(RetryHandler retryHandler) { - retry = retryHandler; - } } diff --git a/azd/src/main/java/org/azd/abstractions/HttpRequestFactory.java b/azd/src/main/java/org/azd/abstractions/HttpRequestFactory.java index 879585bf..7cb56345 100644 --- a/azd/src/main/java/org/azd/abstractions/HttpRequestFactory.java +++ b/azd/src/main/java/org/azd/abstractions/HttpRequestFactory.java @@ -5,7 +5,6 @@ import org.azd.common.Constants; import org.azd.exceptions.AzDException; -import java.net.URI; import java.net.http.HttpRequest; /** diff --git a/azd/src/main/java/org/azd/abstractions/InstanceFactory.java b/azd/src/main/java/org/azd/abstractions/InstanceFactory.java index 7d7f071d..2925c9b4 100644 --- a/azd/src/main/java/org/azd/abstractions/InstanceFactory.java +++ b/azd/src/main/java/org/azd/abstractions/InstanceFactory.java @@ -1,7 +1,8 @@ package org.azd.abstractions; -import org.azd.abstractions.handlers.RequestExecutor; -import org.azd.abstractions.handlers.RetryHandler; +import org.azd.abstractions.handlers.*; +import org.azd.abstractions.pipelines.ResponsePipeline; +import org.azd.abstractions.pipelines.ResponsePipelineBuilder; import org.azd.abstractions.serializer.JsonSerializer; import org.azd.abstractions.serializer.SerializerContext; import org.azd.authentication.AccessTokenCredential; @@ -24,6 +25,10 @@ public static SerializerContext createSerializerContext() { return new JsonSerializer(); } + public static RetryHandler createRetryHandler() { + return new DefaultRetryHandler(); + } + /** * Creates an instance of HttpClient. * @return HttpClient {@link HttpClient}. @@ -46,16 +51,15 @@ public static HttpRequest createHttpRequest(AccessTokenCredential accessTokenCre } /** - * Creates an instance of response handler object. - * @param accessTokenCredential Access token credential object. - * @param requestInformation Request information object to set the request url, request body. - * @return ResponseHandler {@link ResponseHandler}. + * Creates the response pipeline with all handlers. + * @return ResponsePipeline with default response handlers. */ - public static ResponseHandler createResponseHandler(AccessTokenCredential accessTokenCredential, - RequestInformation requestInformation) { - var retryHandler = ClientConfiguration.getInstance().getRetryHandler(); - retryHandler = retryHandler == null ? new RetryHandler( - new RequestExecutor(accessTokenCredential, requestInformation)) : retryHandler; - return ResponseHandler.create(retryHandler); + public static ResponsePipeline createResponsePipeline() { + return ResponsePipelineBuilder.create() + .add(ApiResponseHandler::new) + .add(RedirectResponseHandler::new) + .add(() -> new ErrorResponseHandler(createSerializerContext())) + .add(() -> new SerializerHandler(createSerializerContext())) + .build(); } } diff --git a/azd/src/main/java/org/azd/abstractions/ResponseHandler.java b/azd/src/main/java/org/azd/abstractions/ResponseHandler.java index 4391fd24..6ba9d0de 100644 --- a/azd/src/main/java/org/azd/abstractions/ResponseHandler.java +++ b/azd/src/main/java/org/azd/abstractions/ResponseHandler.java @@ -1,28 +1,36 @@ package org.azd.abstractions; -import org.azd.abstractions.handlers.DefaultResponseHandler; -import org.azd.abstractions.handlers.RetryHandler; +import org.azd.abstractions.handlers.ResponseContext; -import java.net.http.HttpResponse; +import java.util.concurrent.CompletableFuture; /** - * Handler the Api response. + * Handles the Api response. */ public abstract class ResponseHandler { - protected static ApiResponse apiResponse; - protected final RetryHandler retryHandler; + protected ResponseHandler next; + private static ApiResponse apiResponse; - protected ResponseHandler(RetryHandler retryHandler) { - this.retryHandler = retryHandler; + /** + * Sets the next handler in pipeline. + * @param next Next handler to invoke + * @return ResponseHandler handler. + */ + public ResponseHandler setNext(ResponseHandler next) { + this.next = next; + return next; } /** - * Creates an instance of Response handler. - * @param retryHandler Retry handler to retry the request. - * @return Response handler object. + * Invokes the next handler in the pipeline + * @param context Response context object container. + * @return Result of invocation. */ - public static ResponseHandler create(RetryHandler retryHandler) { - return new DefaultResponseHandler(retryHandler); + protected CompletableFuture nextAsync(ResponseContext context) { + if (next == null) { + return CompletableFuture.completedFuture(null); + } + return next.handleAsync(context); } /** @@ -35,11 +43,16 @@ public static ApiResponse getResponse() { /** * Handles the Api response. - * @param response Http response object. - * @param requestInformation Request information object. {@link RequestInformation}. + * @param context ResponseContext object {@link ResponseContext} * @return Java type value that is passed. - * @param Type parameter. */ - public abstract T handle(HttpResponse response, RequestInformation requestInformation); + public abstract CompletableFuture handleAsync(ResponseContext context); + /** + * Sets the Api response object. + * @param response ApiResponse object to set {@link ApiResponse} + */ + public static void setResponse(ApiResponse response) { + apiResponse = response; + } } diff --git a/azd/src/main/java/org/azd/abstractions/handlers/ApiResponseHandler.java b/azd/src/main/java/org/azd/abstractions/handlers/ApiResponseHandler.java new file mode 100644 index 00000000..ba15c605 --- /dev/null +++ b/azd/src/main/java/org/azd/abstractions/handlers/ApiResponseHandler.java @@ -0,0 +1,24 @@ +package org.azd.abstractions.handlers; + +import org.azd.abstractions.ApiResponse; +import org.azd.abstractions.ResponseHandler; +import org.azd.enums.HttpStatusCode; + +import java.util.concurrent.CompletableFuture; + +public final class ApiResponseHandler extends ResponseHandler { + @Override + public CompletableFuture handleAsync(ResponseContext context) { + var response = context.response(); + + setResponse(new ApiResponse( + HttpStatusCode.from(response.statusCode()), + response.headers().map(), + response.body(), + response.request().uri().toString(), + context.request() + )); + + return nextAsync(context); + } +} diff --git a/azd/src/main/java/org/azd/abstractions/handlers/ContentType.java b/azd/src/main/java/org/azd/abstractions/handlers/ContentType.java new file mode 100644 index 00000000..940bb252 --- /dev/null +++ b/azd/src/main/java/org/azd/abstractions/handlers/ContentType.java @@ -0,0 +1,36 @@ +package org.azd.abstractions.handlers; + +import org.azd.enums.CustomHeader; +import org.azd.utils.StringUtils; + +import java.net.http.HttpResponse; +import java.util.Locale; +import java.util.Objects; + +public final class ContentType { + private final String value; + + private ContentType(String value) { + this.value = value.toLowerCase(Locale.ROOT); + } + + public static ContentType from(HttpResponse response) { + Objects.requireNonNull(response, "Response cannot be null."); + + return response.headers() + .firstValue(CustomHeader.JSON_CONTENT_TYPE.getName()) + .map(x -> new ContentType(x.split(";")[0].trim())) + .orElse(new ContentType(StringUtils.EMPTY)); + + } + + boolean isJson() { return value.equals(CustomHeader.JSON_CONTENT_TYPE.getValue()); } + boolean isText() { return value.equals(CustomHeader.TEXT_CONTENT.getValue()); } + boolean isHtml() { return value.equals(CustomHeader.HTML_CONTENT.getValue()); } + boolean isXml() { return value.equals(CustomHeader.XML_CONTENT_TYPE.getValue()); } + + @Override + public String toString() { + return value; + } +} diff --git a/azd/src/main/java/org/azd/abstractions/handlers/DefaultResponseHandler.java b/azd/src/main/java/org/azd/abstractions/handlers/DefaultResponseHandler.java deleted file mode 100644 index a4433d21..00000000 --- a/azd/src/main/java/org/azd/abstractions/handlers/DefaultResponseHandler.java +++ /dev/null @@ -1,50 +0,0 @@ -package org.azd.abstractions.handlers; - -import org.azd.abstractions.ApiResponse; -import org.azd.abstractions.RequestInformation; -import org.azd.abstractions.ResponseHandler; -import org.azd.enums.HttpStatusCode; - -import java.net.http.HttpResponse; -import java.util.OptionalLong; - -/** - * Implementation of response handler. - */ -public class DefaultResponseHandler extends ResponseHandler { - - public DefaultResponseHandler(RetryHandler handler) { - super(handler); - } - - /** - * Handles response from the API. - * @param response HttpResponse object. - * @param requestInformation Request information sent to the API. - * @return Object or any specified type. - * @param Type parameter. - */ - @Override - public T handle(HttpResponse response, RequestInformation requestInformation) { - apiResponse = new ApiResponse(HttpStatusCode.getByCode(response.statusCode()), response.headers().map(), - response.body(), response.request().uri().toString(), requestInformation); - - if (shouldRetry(response)) apiResponse = retryHandler.retry(apiResponse); - - return (T) apiResponse.getResponseBody(); - } - - /** - * Determines the Api retries. - * @param response HttpResponse object. - * @return A boolean. - * @param Type parameter. - */ - private boolean shouldRetry(HttpResponse response) { - var retry = OptionalLong.empty(); - if (response.headers() != null) { - retry = response.headers().firstValueAsLong("Retry-After"); - } - return response.statusCode() >= 500 || retry.isPresent(); - } -} diff --git a/azd/src/main/java/org/azd/abstractions/handlers/DefaultRetryHandler.java b/azd/src/main/java/org/azd/abstractions/handlers/DefaultRetryHandler.java new file mode 100644 index 00000000..ef4cc645 --- /dev/null +++ b/azd/src/main/java/org/azd/abstractions/handlers/DefaultRetryHandler.java @@ -0,0 +1,67 @@ +package org.azd.abstractions.handlers; + +import java.net.http.HttpResponse; +import java.util.OptionalLong; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.TimeUnit; + +/** + * Retries the Api call based on Retry-After header value. + */ +public class DefaultRetryHandler implements RetryHandler { + /** + * Maximum retries + */ + private static final int MAX_RETRIES = 6; + + /** + * Executes the given retryable operation. + * @param operation Function to retry + * @return Future of HttpResponse object + * @param Typed value. + */ + @Override + public CompletableFuture> executeAsync(Retryable operation) { + return retry(operation, 1); + } + + /** + * Retries the given retryable operation. + * @param operation Function to retry + * @param attempt number of attempts to retry. + * @return Future of HttpResponse object + * @param Typed value. + */ + private CompletableFuture> retry(Retryable operation, int attempt) { + return operation.run().thenCompose(response -> { + var retryAfter = response.headers().firstValueAsLong("Retry-After"); + + if (shouldRetry(response.statusCode(), retryAfter, attempt)) { + long delayMillis = retryAfter.getAsLong() * 1000; + return CompletableFuture + .runAsync(() -> { }, + CompletableFuture.delayedExecutor( + delayMillis, + TimeUnit.MILLISECONDS)) + .thenCompose(v -> retry(operation, attempt + 1)); + } + + return CompletableFuture.completedFuture(response); + }); + } + + /** + * Returns true if the status code is 429, 503 or retry after interval is present. + * @param status Http status code. + * @param retryAfter Retry after interval in seconds. + * @param attempt Number of attempts. Maximum is 6. + * @return boolean. + */ + private boolean shouldRetry(int status, OptionalLong retryAfter, int attempt) { + if (attempt >= MAX_RETRIES) { + return false; + } + return (status == 429 || status == 503) + && retryAfter.isPresent(); + } +} diff --git a/azd/src/main/java/org/azd/abstractions/handlers/ErrorResponseHandler.java b/azd/src/main/java/org/azd/abstractions/handlers/ErrorResponseHandler.java new file mode 100644 index 00000000..93955381 --- /dev/null +++ b/azd/src/main/java/org/azd/abstractions/handlers/ErrorResponseHandler.java @@ -0,0 +1,139 @@ +package org.azd.abstractions.handlers; + +import org.azd.abstractions.ResponseHandler; +import org.azd.abstractions.serializer.SerializerContext; +import org.azd.enums.ApiExceptionTypes; +import org.azd.exceptions.ApiException; +import org.azd.exceptions.AzDException; +import org.azd.helpers.StreamHelper; + +import java.io.InputStream; +import java.util.concurrent.CompletableFuture; + +public final class ErrorResponseHandler extends ResponseHandler { + + private final SerializerContext serializer; + + public ErrorResponseHandler(SerializerContext serializer) { + this.serializer = serializer; + } + + @Override + public CompletableFuture handleAsync(ResponseContext context) { + int status = context.statusCode(); + + if (status == 203) { + return CompletableFuture.failedFuture( + new AzDException( + ApiExceptionTypes.InvalidPersonalAccessTokenException.toString(), + "Personal access token passed is invalid; Please pass the valid token and try again." + ) + ); + } + + if (status < 400) { + return nextAsync(context); + } + + if (status == 401) { + return CompletableFuture.failedFuture( + new AzDException( + ApiExceptionTypes.UnAuthorizedException.toString(), + "Given token doesn't have access to resource '" + + context.request().getRequestUri() + "'." + ) + ); + } + + if (RedirectUtils.hasCallback(context)) { + return nextAsync(context); + } + + if (context.contentType().isXml()) { + try { + String error; + if (context.body() instanceof InputStream) { + error = StreamHelper.convertToString((InputStream) context.body()); + } else { + error = String.valueOf(context.body()); + } + + return CompletableFuture.failedFuture( + new AzDException(ApiExceptionTypes.UnknownError.toString(), error) + ); + } catch (AzDException e) { + return CompletableFuture.failedFuture(e); + } + } + + if (context.contentType().isJson() && context.body() instanceof String) { + + String body = context.body().toString(); + + if (body.contains("innerException")) { + try { + var error = serializer.deserialize(body, ApiException.class); + + return CompletableFuture.failedFuture( + new AzDException(error.getTypeKey(), error.getMessage()) + ); + + } catch (AzDException e) { + return CompletableFuture.failedFuture(e); + } + } + + return CompletableFuture.failedFuture(new AzDException(body)); + } + + if (context.contentType().isJson() && context.body() instanceof InputStream) { + + try { + var stream = (InputStream) context.body(); + var body = StreamHelper.convertToString(stream); + + if (body.contains("innerException")) { + try { + var error = serializer.deserialize(body, ApiException.class); + + return CompletableFuture.failedFuture( + new AzDException(error.getTypeKey(), error.getMessage()) + ); + + } catch (AzDException e) { + return CompletableFuture.failedFuture(e); + } + } + + return CompletableFuture.failedFuture(new AzDException(body)); + } catch (AzDException e) { + return CompletableFuture.failedFuture(e); + } + } + + if (context.contentType().isText() || context.contentType().isHtml()) { + + String body = context.body().toString(); + + if (body.contains("The resource cannot be found.")) { + return CompletableFuture.failedFuture( + new AzDException( + ApiExceptionTypes.InvalidOrganizationNameException.toString(), + "Server url '" + + context.request().accessTokenCredential.getOrganizationUrl() + + "' passed is invalid; Please pass the valid url and try again." + ) + ); + } + + return CompletableFuture.failedFuture(new AzDException(body)); + } + + return CompletableFuture.failedFuture( + new AzDException( + ApiExceptionTypes.UnknownError.toString(), + String.valueOf(context.body()) + ) + ); + } +} diff --git a/azd/src/main/java/org/azd/abstractions/handlers/RedirectResponseHandler.java b/azd/src/main/java/org/azd/abstractions/handlers/RedirectResponseHandler.java new file mode 100644 index 00000000..7ae51b28 --- /dev/null +++ b/azd/src/main/java/org/azd/abstractions/handlers/RedirectResponseHandler.java @@ -0,0 +1,39 @@ +package org.azd.abstractions.handlers; + +import org.azd.abstractions.ResponseHandler; +import org.azd.enums.CustomHeader; +import org.azd.exceptions.AzDException; +import org.azd.http.ClientRequest; + +import java.util.concurrent.CompletableFuture; + +public final class RedirectResponseHandler extends ResponseHandler { + @Override + public CompletableFuture handleAsync(ResponseContext context) { + + if (!RedirectUtils.hasCallback(context)) { + return nextAsync(context); + } + + var uriOpt = RedirectUtils.extractCallback(context); + + if (uriOpt.isEmpty()) { + return CompletableFuture.failedFuture( + new AzDException("Redirect detected but no callback URL found.") + ); + } + + var uri = uriOpt.get(); + + return ClientRequest.builder() + .URI(uri) + .header(CustomHeader.STREAM_ACCEPT) + .build() + .executeStreamAsync() + .thenCompose(stream -> { + context.setBody(stream); + context.setStatusCode(200); + return nextAsync(context); + }); + } +} \ No newline at end of file diff --git a/azd/src/main/java/org/azd/abstractions/handlers/RedirectUtils.java b/azd/src/main/java/org/azd/abstractions/handlers/RedirectUtils.java new file mode 100644 index 00000000..2916c24d --- /dev/null +++ b/azd/src/main/java/org/azd/abstractions/handlers/RedirectUtils.java @@ -0,0 +1,71 @@ +package org.azd.abstractions.handlers; + +import org.azd.abstractions.InstanceFactory; + +import java.net.URI; +import java.util.Map; +import java.util.Optional; + +public final class RedirectUtils { + + public static boolean isRedirectStatus(int status) { + return status == 301 || status == 302 || status == 303 + || status == 307 || status == 308; + } + + public static boolean hasCallback(ResponseContext context) { + int status = context.statusCode(); + + if (!isRedirectStatus(status) && status != 403) { + return false; + } + + if (context.response().uri() != null && status == 403) { + return true; + } + + if (context.header("Location").isPresent()) { + return true; + } + + if (context.contentType().isJson() && context.body() instanceof String) { + var body = (String) context.body(); + return body.contains("downloadUrl") || body.contains("url"); + } + + return false; + } + + public static Optional extractCallback(ResponseContext context) { + + try { + var location = context.header("Location"); + if (location.isPresent()) { + return Optional.of(URI.create(location.get())); + } + + if (context.response() != null && context.response().uri() != null) { + return Optional.of(context.response().uri()); + } + + if (context.contentType().isJson() && context.body() instanceof String) { + var body = (String) context.body(); + final var serializer = InstanceFactory.createSerializerContext(); + var map = serializer.deserialize(body, Map.class); + + if (map.containsKey("downloadUrl")) { + return Optional.of(URI.create(map.get("downloadUrl").toString())); + } + + if (map.containsKey("url")) { + return Optional.of(URI.create(map.get("url").toString())); + } + } + + return Optional.empty(); + + } catch (Exception e) { + return Optional.empty(); + } + } +} diff --git a/azd/src/main/java/org/azd/abstractions/handlers/RequestExecutor.java b/azd/src/main/java/org/azd/abstractions/handlers/RequestExecutor.java deleted file mode 100644 index ba3136a8..00000000 --- a/azd/src/main/java/org/azd/abstractions/handlers/RequestExecutor.java +++ /dev/null @@ -1,36 +0,0 @@ -package org.azd.abstractions.handlers; - -import org.azd.abstractions.ApiResponse; -import org.azd.abstractions.RequestInformation; -import org.azd.abstractions.ResponseHandler; -import org.azd.authentication.AccessTokenCredential; -import org.azd.exceptions.AzDException; -import org.azd.http.ClientRequest; - -/** - * Executes the given request. - */ -public class RequestExecutor { - private final RequestInformation reqInfo; - private final AccessTokenCredential accessTokenCredential; - - public RequestExecutor(AccessTokenCredential accessTokenCredential, - RequestInformation requestInformation) { - this.reqInfo = requestInformation; - this.accessTokenCredential = accessTokenCredential; - } - - /** - * Executes the given request and returns the Api response. - * @return ApiResponse {@link ApiResponse}. - * @throws AzDException Default exception handler. - */ - public ApiResponse execute() throws AzDException { - ClientRequest.builder(accessTokenCredential) - .request(reqInfo) - .build() - .executeStringAsync() - .join(); - return ResponseHandler.getResponse(); - } -} diff --git a/azd/src/main/java/org/azd/abstractions/handlers/ResponseContext.java b/azd/src/main/java/org/azd/abstractions/handlers/ResponseContext.java new file mode 100644 index 00000000..ffd9f249 --- /dev/null +++ b/azd/src/main/java/org/azd/abstractions/handlers/ResponseContext.java @@ -0,0 +1,62 @@ +package org.azd.abstractions.handlers; + +import org.azd.abstractions.RequestInformation; + +import java.net.http.HttpResponse; +import java.util.Optional; + +public final class ResponseContext { + private final HttpResponse response; + private final RequestInformation request; + private final Class model; + private final ContentType contentType; + private Object body; + private int statusCode; + + public ResponseContext(HttpResponse response, + RequestInformation request, + Class model) { + this.response = response; + this.request = request; + this.model = model; + this.body = response.body(); + this.statusCode = response.statusCode(); + this.contentType = ContentType.from(response); + } + + public HttpResponse response() { + return response; + } + + public RequestInformation request() { + return request; + } + + public ContentType contentType() { + return contentType; + } + public Class model() { + return model; + } + + public Object body() { + return body; + } + + public void setBody(Object body) { + this.body = body; + } + + public int statusCode() { + return statusCode; + } + + public void setStatusCode(int statusCode) { + this.statusCode = statusCode; + } + + public Optional header(String value) { + return response.headers().firstValue(value); + } +} + diff --git a/azd/src/main/java/org/azd/abstractions/handlers/ResponseHandlerFactory.java b/azd/src/main/java/org/azd/abstractions/handlers/ResponseHandlerFactory.java new file mode 100644 index 00000000..8fe464d2 --- /dev/null +++ b/azd/src/main/java/org/azd/abstractions/handlers/ResponseHandlerFactory.java @@ -0,0 +1,8 @@ +package org.azd.abstractions.handlers; + +import org.azd.abstractions.ResponseHandler; + +@FunctionalInterface +public interface ResponseHandlerFactory { + ResponseHandler create(); +} diff --git a/azd/src/main/java/org/azd/abstractions/handlers/RetryHandler.java b/azd/src/main/java/org/azd/abstractions/handlers/RetryHandler.java index b33b38f5..b6a9cc14 100644 --- a/azd/src/main/java/org/azd/abstractions/handlers/RetryHandler.java +++ b/azd/src/main/java/org/azd/abstractions/handlers/RetryHandler.java @@ -1,84 +1,8 @@ package org.azd.abstractions.handlers; -import org.azd.abstractions.ApiResponse; -import org.azd.exceptions.AzDException; +import java.net.http.HttpResponse; +import java.util.concurrent.CompletableFuture; -import java.net.http.HttpHeaders; -import java.util.OptionalLong; - -/** - * Retries the Api call based on Retry-After header value. - */ -public class RetryHandler { - private final int MAX_RETRIES = 6; - private final long RETRY_IN_MILLISECONDS = 1000; - private final RequestExecutor executor; - private int DEFAULT_MAX_RETRIES = 3; - - public RetryHandler(RequestExecutor executor) { - this.executor = executor; - } - - /** - * Retries the Api call for the given Api response object. Determines the request information and - * retries the request for maximum of 6 times. - * @param response Api response object {@link ApiResponse}. - * @return Retries Api response. {@link ApiResponse}. - * @param Type parameter. - */ - public ApiResponse retry(ApiResponse response) { - var executionCount = 1; - while (executionCount < DEFAULT_MAX_RETRIES) { - var headers = response.getResponseHeaders(); - if (retryAfterInterval(headers).isPresent()) { - try { - var delay = retryAfterInterval(headers).getAsLong() * RETRY_IN_MILLISECONDS; - Thread.sleep(delay); - executionCount++; - // Call Api - response = executor.execute(); - } catch (InterruptedException | AzDException e) { - Thread.currentThread().interrupt(); - throw new RuntimeException(e); - } - } else break; - } - return response; - } - - /** - * Get the default max retry value. - * @return Default retry value which is 6. - */ - public int getDefaultMaxRetry() { - return this.DEFAULT_MAX_RETRIES; - } - - /** - * Sets the default max retry value. - * @param defaultMaxRetry Default value to set. The value can't be more than 6. - */ - public void setDefaultMaxRetry(int defaultMaxRetry) { - if (defaultMaxRetry > MAX_RETRIES || defaultMaxRetry < 0) - throw new IllegalArgumentException("Max retry value cannot be less than 0 or greater than 6."); - this.DEFAULT_MAX_RETRIES = defaultMaxRetry; - } - - /** - * Http Headers of last request. We want to make these accessible everywhere (i.e) something that - * can be checked after every request, but we don't want to have to modify all the existing API methods - * to return the data. - *

- * We need this to be able to check if we are near any API rate limits - as creating 20+ releases in - * a short time can cause one to go over the limit and even have requests fail. - * Method to get retryAfterInterval value from response header - * - * @return Value in seconds (if it exists in header) of how long we should wait to send next request. - */ - private OptionalLong retryAfterInterval(HttpHeaders headers) { - if (headers != null) { - return headers.firstValueAsLong("Retry-After"); - } - return OptionalLong.empty(); - } +public interface RetryHandler { + CompletableFuture> executeAsync(Retryable operation); } diff --git a/azd/src/main/java/org/azd/abstractions/handlers/Retryable.java b/azd/src/main/java/org/azd/abstractions/handlers/Retryable.java new file mode 100644 index 00000000..62ec89ce --- /dev/null +++ b/azd/src/main/java/org/azd/abstractions/handlers/Retryable.java @@ -0,0 +1,8 @@ +package org.azd.abstractions.handlers; + +import java.net.http.HttpResponse; +import java.util.concurrent.CompletableFuture; + +public interface Retryable { + CompletableFuture> run(); +} diff --git a/azd/src/main/java/org/azd/abstractions/handlers/SerializerHandler.java b/azd/src/main/java/org/azd/abstractions/handlers/SerializerHandler.java new file mode 100644 index 00000000..009a38f9 --- /dev/null +++ b/azd/src/main/java/org/azd/abstractions/handlers/SerializerHandler.java @@ -0,0 +1,52 @@ +package org.azd.abstractions.handlers; + +import org.azd.abstractions.ResponseHandler; +import org.azd.abstractions.serializer.SerializerContext; +import org.azd.exceptions.AzDException; +import org.azd.helpers.StreamHelper; + +import java.io.InputStream; +import java.util.concurrent.CompletableFuture; + +public final class SerializerHandler extends ResponseHandler { + private final SerializerContext serializer; + + public SerializerHandler(SerializerContext serializer) { + this.serializer = serializer; + } + + @Override + public CompletableFuture handleAsync(ResponseContext context) { + if (context.model() == null) { + return nextAsync(context); + } + + try { + var body = context.body(); + + if (context.model().isInstance(body)) { + return nextAsync(context); + } + + if (context.contentType().isJson() && body instanceof String) { + var json = (String) context.body(); + var model = serializer.deserialize(json, context.model()); + context.setBody(model); + return nextAsync(context); + } + + if (context.contentType().isJson() && body instanceof InputStream) { + var stream = (InputStream) context.body(); + var json = StreamHelper.convertToString(stream); + var model = serializer.deserialize(json, context.model()); + context.setBody(model); + return nextAsync(context); + } + + return nextAsync(context); + + } catch (AzDException e) { + return CompletableFuture.failedFuture(e); + } + } +} diff --git a/azd/src/main/java/org/azd/abstractions/internals/ClientRequestAdapter.java b/azd/src/main/java/org/azd/abstractions/internals/ClientRequestAdapter.java index 58e2782d..57546df3 100644 --- a/azd/src/main/java/org/azd/abstractions/internals/ClientRequestAdapter.java +++ b/azd/src/main/java/org/azd/abstractions/internals/ClientRequestAdapter.java @@ -2,9 +2,10 @@ import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.RequestInformation; -import org.azd.abstractions.ResponseHandler; +import org.azd.abstractions.handlers.ResponseContext; +import org.azd.abstractions.handlers.RetryHandler; +import org.azd.abstractions.pipelines.ResponsePipeline; import org.azd.abstractions.serializer.SerializableEntity; -import org.azd.abstractions.serializer.SerializerContext; import org.azd.authentication.AccessTokenCredential; import org.azd.exceptions.AzDException; import org.azd.http.ClientRequest; @@ -13,9 +14,9 @@ import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; -import java.util.Map; import java.util.Objects; import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionException; /** * Implementation of the ClientRequest that executes or sends the request to @@ -30,14 +31,6 @@ public final class ClientRequestAdapter extends ClientRequest { * Request information with all required parameters. */ private final RequestInformation reqInfo; - /** - * Serializer context to serialize and deserialize the objects. - */ - private final SerializerContext serializer; - /** - * Response handler to handle the API response. - */ - private final ResponseHandler handler; /** * HttpClient object to send the request. */ @@ -46,133 +39,170 @@ public final class ClientRequestAdapter extends ClientRequest { * Http request object to construct the request. */ private final HttpRequest request; + private final ResponsePipeline pipeline; + private final RetryHandler retryHandler; /** * Default. + * * @param builder Client request builder object. */ public ClientRequestAdapter(ClientRequestBuilder builder) { this.reqInfo = Objects.requireNonNull(builder.request()); this.accessTokenCredential = builder.accessTokenCredential(); this.client = InstanceFactory.createHttpClient(); - this.serializer = InstanceFactory.createSerializerContext(); - this.handler = InstanceFactory.createResponseHandler(this.accessTokenCredential, this.reqInfo); this.request = InstanceFactory.createHttpRequest(this.accessTokenCredential, this.reqInfo); + this.pipeline = InstanceFactory.createResponsePipeline(); + this.retryHandler = InstanceFactory.createRetryHandler(); } /** * Executes the raw request without serialization. + * * @return String response from API. - * @throws AzDException Default API exception handler. */ @Override - public CompletableFuture executeStringAsync() throws AzDException { - return client.sendAsync(request, HttpResponse.BodyHandlers.ofString()) - .thenApplyAsync(resp -> handler.handle(resp, reqInfo)); + public CompletableFuture executeStringAsync() { + return retryHandler.executeAsync(() -> + client.sendAsync(request, HttpResponse.BodyHandlers.ofString())) + .thenCompose(resp -> { + var context = new ResponseContext(resp, reqInfo, null); + return pipeline.processAsync(context); + }); } /** * Executes the request and returns the deserialized response. + * * @param model Represents the entity or model for which the response should be deserialized to. + * @param Represents model. * @return Deserialized response from API. - * @param Represents model. - * @throws AzDException Default API exception handler. */ @Override - public CompletableFuture executeAsync(Class model) throws AzDException { - return client.sendAsync(request, HttpResponse.BodyHandlers.ofString()) - .thenApplyAsync(resp -> { - try { - var response = handler.handle(resp, reqInfo); - return serializer.deserialize(response, model); - } catch (AzDException e) { - throw new RuntimeException(e); - } - }); + public CompletableFuture executeAsync(Class model) { + return retryHandler.executeAsync(() -> + client.sendAsync(request, HttpResponse.BodyHandlers.ofString())) + .thenCompose(resp -> { + var context = new ResponseContext(resp, reqInfo, model); + return pipeline.processAsync(context); + }) + .thenApplyAsync(model::cast); + } /** * Executes the request and returns the stream response from API. + * * @return Stream response. {@link InputStream} - * @throws AzDException Default API exception handler. */ @Override - public CompletableFuture executeStreamAsync() throws AzDException { - return client.sendAsync(request, HttpResponse.BodyHandlers.ofInputStream()) - .thenApplyAsync(resp -> handler.handle(resp, reqInfo)); + public CompletableFuture executeStreamAsync() { + return retryHandler.executeAsync(() -> + client.sendAsync(request, HttpResponse.BodyHandlers.ofInputStream())) + .thenCompose(resp -> { + var context = new ResponseContext(resp, reqInfo, null); + return pipeline.processAsync(context); + }); } /** - * Executes the request and doesn't return any response. Useful for DELETE operations. - * @return Void. - * @throws AzDException Default API exception handler. + * Executes the request built by ClientRequest.Builder and doesn't return any response. This is mainly used for Api calls + * that returns 201 or any operation that doesn't return response. + * + * @return Future void. */ @Override - public CompletableFuture executePrimitiveAsync() throws AzDException { - return client.sendAsync(request, HttpResponse.BodyHandlers.ofString()) - .thenAcceptAsync(resp -> { - var response = handler.handle(resp, reqInfo); - if (!response.isEmpty()) { - try { - serializer.deserialize(response, Map.class); - } catch (AzDException e) { - throw new RuntimeException(e); - } - } + public CompletableFuture executePrimitiveAsync() { + return retryHandler.executeAsync(() -> + client.sendAsync(request, HttpResponse.BodyHandlers.ofString())) + .thenCompose(resp -> { + var context = new ResponseContext(resp, reqInfo, null); + return pipeline.processAsync(context) + .thenApply(result -> null); }); } /** * Executes the request and returns the deserialized response. + * * @param model Represents the entity or model for which the response should be deserialized to. + * @param Represents model. * @return Deserialized response from API. - * @param Represents model. * @throws AzDException Default API exception handler. */ @Override public T execute(Class model) throws AzDException { - var result = client.sendAsync(request, HttpResponse.BodyHandlers.ofString()) - .thenApplyAsync(resp -> handler.handle(resp, reqInfo)).join(); - return serializer.deserialize(result, model); - + try { + return executeAsync(model).join(); + } catch (CompletionException e) { + var cause = e.getCause(); + if (cause instanceof AzDException) { + throw (AzDException) cause; + } + throw new AzDException(cause.getMessage()); + } } /** * Executes the raw request without serialization. + * * @return String response from API. * @throws AzDException Default API exception handler. */ @Override public String executeString() throws AzDException { - return executeStringAsync().join(); + try { + return executeStringAsync().join(); + } catch (CompletionException e) { + var cause = e.getCause(); + if (cause instanceof AzDException) { + throw (AzDException) cause; + } + throw new AzDException(cause.getMessage()); + } } /** * Executes the request and returns the stream response from API. + * * @return Stream response. {@link InputStream} * @throws AzDException Default API exception handler. */ @Override public InputStream executeStream() throws AzDException { - return executeStreamAsync().join(); + try { + return executeStreamAsync().join(); + } catch (CompletionException e) { + var cause = e.getCause(); + if (cause instanceof AzDException) { + throw (AzDException) cause; + } + throw new AzDException(cause.getMessage()); + } } /** - * Executes the request and doesn't return any response. Useful for DELETE operations. - * @return Void. - * @throws AzDException Default API exception handler. + * Executes the request built by ClientRequest.Builder and doesn't return any response. This is mainly used for Api calls + * that returns 201 or any operation that doesn't return response. + * + * @return Future void. */ @Override public Void executePrimitive() throws AzDException { - var result = client.sendAsync(request, HttpResponse.BodyHandlers.ofString()) - .thenApplyAsync(resp -> handler.handle(resp, reqInfo)).join(); - - if (!result.isEmpty()) serializer.deserialize(result, Map.class); - return null; + try { + return executePrimitiveAsync().join(); + } catch (CompletionException e) { + var cause = e.getCause(); + if (cause instanceof AzDException) { + throw (AzDException) cause; + } + throw new AzDException(cause.getMessage()); + } } /** * Return the request information object. + * * @return RequestInformation {@link RequestInformation} */ @Override @@ -182,6 +212,7 @@ public RequestInformation request() { /** * Returns the access token credential object. + * * @return AccessTokenCredential {@link AccessTokenCredential} */ @Override diff --git a/azd/src/main/java/org/azd/abstractions/internals/LocationService.java b/azd/src/main/java/org/azd/abstractions/internals/LocationService.java index dfeb8d52..3b4b73aa 100644 --- a/azd/src/main/java/org/azd/abstractions/internals/LocationService.java +++ b/azd/src/main/java/org/azd/abstractions/internals/LocationService.java @@ -4,7 +4,6 @@ import org.azd.common.Constants; import org.azd.common.types.ApiLocation; import org.azd.common.types.ApiLocations; -import org.azd.exceptions.AzDException; import org.azd.http.ClientRequest; import org.azd.utils.UrlBuilder; @@ -16,12 +15,12 @@ * Determines the Api location based on location url, area and resource id. */ public final class LocationService { - private static volatile LocationService instance; private final Map> locations = new HashMap<>(); private final AccessTokenCredential accessTokenCredential; /** * Default + * * @param accessTokenCredential Access token credential object. */ private LocationService(AccessTokenCredential accessTokenCredential) { @@ -30,26 +29,21 @@ private LocationService(AccessTokenCredential accessTokenCredential) { /** * Get the instance of location service. + * * @param accessTokenCredential Access token credential object. * @return LocationService object {@link LocationService}. */ public static LocationService getInstance(AccessTokenCredential accessTokenCredential) { Objects.requireNonNull(accessTokenCredential, "Access token cannot be null."); - if (instance == null) { - synchronized (LocationService.class) { - if (instance == null) { - instance = new LocationService(accessTokenCredential); - } - } - } - return instance; + return new LocationService(accessTokenCredential); } /** * Get the location details for given url, area and location id. + * * @param locationUrl Base url of the location. For e.g, https://dev.azure.com/{organisation} - * @param area Specify the area i.e., release, git etc. - * @param locationId GUID of the location. + * @param area Specify the area i.e., release, git etc. + * @param locationId GUID of the location. * @return Api location object {@link ApiLocation}. */ public ApiLocation getLocation(String locationUrl, String area, String locationId) { @@ -59,35 +53,31 @@ public ApiLocation getLocation(String locationUrl, String area, String locationI /** * Retrieves the location details for given area and base url. This is then cached for later use. + * * @param locationUrl Base url of the location. For e.g, https://dev.azure.com/{organisation} - * @param area Specify the area i.e., release, git etc. + * @param area Specify the area i.e., release, git etc. */ private void getLocations(String locationUrl, String area) { Objects.requireNonNull(locationUrl); Objects.requireNonNull(area); if (locations.get(area) == null) { - try { - var reqUrl = UrlBuilder - .fromBaseUrl(locationUrl) - .appendPath(Constants.APIS_RELATIVE_PATH) - .appendPath(area) - .build(); + var reqUrl = UrlBuilder + .fromBaseUrl(locationUrl) + .appendPath(Constants.APIS_RELATIVE_PATH) + .appendPath(area) + .build(); - ClientRequest.builder(accessTokenCredential) - .URI(reqUrl) - .OPTIONS() - .build() - .executeAsync(ApiLocations.class) - .thenAcceptAsync(results -> { - var resourceAreas = new HashMap(); - results.locations.forEach(result -> resourceAreas.put(result.id.toLowerCase(), result)); - locations.put(area, resourceAreas); - }) - .join(); - } catch (AzDException e) { - throw new RuntimeException("An error occurred, couldn't find locations for given area " + "'" - + area + "'. Error message: " + e.getMessage()); - } + ClientRequest.builder(accessTokenCredential) + .URI(reqUrl) + .OPTIONS() + .build() + .executeAsync(ApiLocations.class) + .thenAcceptAsync(results -> { + var resourceAreas = new HashMap(); + results.locations.forEach(result -> resourceAreas.put(result.id.toLowerCase(), result)); + locations.put(area, resourceAreas); + }) + .join(); } locations.get(area); } diff --git a/azd/src/main/java/org/azd/abstractions/internals/LookUpService.java b/azd/src/main/java/org/azd/abstractions/internals/LookUpService.java index 4d1d31fd..681b1dd5 100644 --- a/azd/src/main/java/org/azd/abstractions/internals/LookUpService.java +++ b/azd/src/main/java/org/azd/abstractions/internals/LookUpService.java @@ -1,13 +1,12 @@ package org.azd.abstractions.internals; import org.azd.authentication.AccessTokenCredential; -import org.azd.common.types.LocationUrl; import org.azd.common.types.ResourceAreas; import org.azd.exceptions.AzDException; import org.azd.http.ClientRequest; +import org.azd.utils.StringUtils; -import java.util.HashMap; -import java.util.Map; +import java.util.Locale; import java.util.Objects; /** @@ -19,8 +18,6 @@ public class LookUpService { */ private final static String id = "e81700f7-3be2-46de-8624-2eb35882fcaa"; private final static String area = "location"; - private static final Map resourceAreasCache = new HashMap<>(); - private static volatile LookUpService instance; private final AccessTokenCredential accessTokenCredential; private LookUpService(AccessTokenCredential accessTokenCredential) { @@ -29,55 +26,52 @@ private LookUpService(AccessTokenCredential accessTokenCredential) { /** * Get the instance of lookup service. + * * @param accessTokenCredential Access token credential object. * @return Lookup service object {@link LookUpService}. */ public static LookUpService getInstance(AccessTokenCredential accessTokenCredential) { Objects.requireNonNull(accessTokenCredential); - if (instance == null) { - synchronized (LookUpService.class) { - if (instance == null) { - instance = new LookUpService(accessTokenCredential); - } - } - } - return instance; + return new LookUpService(accessTokenCredential); } /** * Get the resource areas for given url. + * * @param organizationUrl Organisation url. E.g., https://dev.azure.com/{organisation} * @return Resource areas object {@link ResourceAreas}. */ public ResourceAreas resourceAreas(String organizationUrl) { - try { - return ClientRequest.builder(accessTokenCredential) - .baseInstance(organizationUrl) - .area(area) - .location(id) - .build() - .executeAsync(ResourceAreas.class) - .thenApplyAsync(results -> { - results.getResourceAreas().forEach(result -> - resourceAreasCache.put(result.getId().toLowerCase(), result)); - return results; - }) - .join(); - } catch (AzDException e) { - throw new RuntimeException(e); - } + return ClientRequest.builder(accessTokenCredential) + .baseInstance(organizationUrl) + .area(area) + .location(id) + .build() + .executeAsync(ResourceAreas.class) + .join(); } /** * Get the location url for given base url and resource id. + * * @param organizationUrl Organisation url. E.g., https://dev.azure.com/{organisation} - * @param resourceId GUID of the resource such as release, git etc. + * @param resourceId GUID of the resource such as release, git etc. * @return Location url. */ - public String locationUrl(String organizationUrl, String resourceId) { + public String locationUrl(String organizationUrl, String resourceId) throws AzDException { if (resourceId == null) return organizationUrl; - if (!resourceAreasCache.containsKey(resourceId)) resourceAreas(organizationUrl); - var locationUrl = resourceAreasCache.get(resourceId); - return locationUrl == null ? organizationUrl : locationUrl.getLocationUrl(); + var resAreas = resourceAreas(organizationUrl); + + if (resAreas == null || + resAreas.getResourceAreas().size() == 0 || + StringUtils.isEmpty((String) resAreas.getResponse().getResponseBody())) + return organizationUrl; + + for (var resArea : resAreas.getResourceAreas()) + if (resArea.getId().toLowerCase(Locale.ROOT) + .equals(resourceId.toLowerCase(Locale.ROOT))) + return resArea.getLocationUrl(); + + throw new AzDException("Couldn't find information for resource " + resourceId + "from " + organizationUrl); } } diff --git a/azd/src/main/java/org/azd/abstractions/pipelines/ResponsePipeline.java b/azd/src/main/java/org/azd/abstractions/pipelines/ResponsePipeline.java new file mode 100644 index 00000000..2f89f593 --- /dev/null +++ b/azd/src/main/java/org/azd/abstractions/pipelines/ResponsePipeline.java @@ -0,0 +1,21 @@ +package org.azd.abstractions.pipelines; + +import org.azd.abstractions.ResponseHandler; +import org.azd.abstractions.handlers.ResponseContext; + +import java.util.Objects; +import java.util.concurrent.CompletableFuture; + +public final class ResponsePipeline { + private final ResponseHandler handler; + + public ResponsePipeline(ResponseHandler handler) { + Objects.requireNonNull(handler, "Response pipeline should have at least one handler."); + this.handler = handler; + } + + public CompletableFuture processAsync(ResponseContext context) { + return handler.handleAsync(context) + .thenApply(v -> (T) context.body()); + } +} diff --git a/azd/src/main/java/org/azd/abstractions/pipelines/ResponsePipelineBuilder.java b/azd/src/main/java/org/azd/abstractions/pipelines/ResponsePipelineBuilder.java new file mode 100644 index 00000000..9c8f5cf6 --- /dev/null +++ b/azd/src/main/java/org/azd/abstractions/pipelines/ResponsePipelineBuilder.java @@ -0,0 +1,33 @@ +package org.azd.abstractions.pipelines; + +import org.azd.abstractions.ResponseHandler; +import org.azd.abstractions.handlers.ResponseHandlerFactory; + +import java.util.ArrayList; +import java.util.List; + +public final class ResponsePipelineBuilder { + private final List handlerFactories = new ArrayList<>(); + + private ResponsePipelineBuilder() { } + + public static ResponsePipelineBuilder create() { + return new ResponsePipelineBuilder(); + } + public ResponsePipelineBuilder add(ResponseHandlerFactory factory) { + handlerFactories.add(factory); + return this; + } + + public ResponsePipeline build() { + ResponseHandler next = null; + + for (int i = handlerFactories.size() - 1; i >= 0; i--) { + ResponseHandler current = handlerFactories.get(i).create(); + current.setNext(next); + next = current; + } + + return new ResponsePipeline(next); + } +} diff --git a/azd/src/main/java/org/azd/abstractions/serializer/JsonSerializer.java b/azd/src/main/java/org/azd/abstractions/serializer/JsonSerializer.java index 2a2f2d66..6e7a5a5b 100644 --- a/azd/src/main/java/org/azd/abstractions/serializer/JsonSerializer.java +++ b/azd/src/main/java/org/azd/abstractions/serializer/JsonSerializer.java @@ -6,7 +6,6 @@ import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; import org.azd.enums.ApiExceptionTypes; -import org.azd.exceptions.ApiException; import org.azd.exceptions.AzDException; import org.azd.helpers.StreamHelper; @@ -66,13 +65,6 @@ public JsonNode serialize(String jsonString) throws AzDException { @Override public T deserialize(final String content, Class valueType) throws AzDException { try { - if (content.contains("innerException")) - throw new AzDException(this.readValue(content, ApiException.class).getTypeKey(), this.readValue(content, ApiException.class).getMessage()); - if (content.contains("The request is invalid.")) - throw new AzDException(); - if (content.contains("Object moved")) - throw new AzDException(ApiExceptionTypes.InvalidPersonalAccessTokenException.toString(), - "Personal access token passed is invalid; Pass the valid token and try again."); return this.readValue(content, valueType); } catch (JsonProcessingException e) { throw new AzDException(ApiExceptionTypes.ApiResponseParsingException.toString(), e.getMessage()); @@ -91,12 +83,6 @@ public T deserialize(final String content, Class valueType) throws AzDExc @Override public T deserialize(final String content, TypeReference valueType) throws AzDException { try { - if (content.contains("innerException")) - throw new AzDException(this.readValue(content, ApiException.class).getTypeKey(), this.readValue(content, ApiException.class).getMessage()); - if (content.contains("The request is invalid.")) - throw new AzDException(); - if (content.contains("Object moved")) - throw new AzDException(ApiExceptionTypes.InvalidPersonalAccessTokenException.toString(), "Personal access token passed is invalid; Pass the valid token and try again."); return this.readValue(content, valueType); } catch (JsonProcessingException e) { throw new AzDException(ApiExceptionTypes.ApiResponseParsingException.toString(), e.getMessage()); @@ -121,6 +107,22 @@ public T deserialize(InputStream content, Class valueType) throws AzDExce } } + /** + * Deserializes the json string to object of given type. + * + * @param content input stream response from API + * @return Object + * @throws AzDException Default exception handler. + */ + @Override + public Object deserialize(String content) throws AzDException { + try { + return readTree(content); + } catch (Exception e) { + throw new AzDException(ApiExceptionTypes.StringValueParsingException.name(), e.getMessage()); + } + } + /** * Deserializes the json string to given object from a file. * diff --git a/azd/src/main/java/org/azd/abstractions/serializer/SerializableCollectionEntity.java b/azd/src/main/java/org/azd/abstractions/serializer/SerializableCollectionEntity.java index b437daf9..d83e4e79 100644 --- a/azd/src/main/java/org/azd/abstractions/serializer/SerializableCollectionEntity.java +++ b/azd/src/main/java/org/azd/abstractions/serializer/SerializableCollectionEntity.java @@ -1,15 +1,10 @@ package org.azd.abstractions.serializer; import com.fasterxml.jackson.annotation.JsonIgnore; -import org.azd.authentication.AccessTokenCredential; -import org.azd.exceptions.AzDException; -import org.azd.http.ClientRequest; import java.net.URI; import java.net.URISyntaxException; -import static org.azd.helpers.Utils.isNullOrEmpty; - /** * Collection entity that provides additional functionalities such as next page, continuation token. */ diff --git a/azd/src/main/java/org/azd/abstractions/serializer/SerializerContext.java b/azd/src/main/java/org/azd/abstractions/serializer/SerializerContext.java index 78f428c0..aea5a222 100644 --- a/azd/src/main/java/org/azd/abstractions/serializer/SerializerContext.java +++ b/azd/src/main/java/org/azd/abstractions/serializer/SerializerContext.java @@ -57,6 +57,15 @@ public interface SerializerContext { */ T deserialize(InputStream content, Class valueType) throws AzDException; + /** + * Deserializes the json string to object of given type. + * + * @param content input stream response from API + * @return Object + * @throws AzDException Default exception handler. + */ + Object deserialize(String content) throws AzDException; + /** * Deserialize JSON string to a specified type. * @param src File that contains JSON string. diff --git a/azd/src/main/java/org/azd/accounts/AccountsApi.java b/azd/src/main/java/org/azd/accounts/AccountsApi.java deleted file mode 100644 index ff40e0a6..00000000 --- a/azd/src/main/java/org/azd/accounts/AccountsApi.java +++ /dev/null @@ -1,112 +0,0 @@ -package org.azd.accounts; - -import org.azd.accounts.types.Accounts; -import org.azd.accounts.types.Organizations; -import org.azd.accounts.types.Profile; -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.enums.CustomHeader; -import org.azd.enums.RequestMethod; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.AccountsDetails; -import org.azd.utils.AzDAsyncApi; - -import java.util.ArrayList; -import java.util.HashMap; - -import static org.azd.utils.RestClient.send; - -/** - * Accounts class to manage Accounts Api - */ -public class AccountsApi extends AzDAsyncApi implements AccountsDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "accounts"; - - /** - * Pass the connection object to work with Accounts Api - * - * @param connection Connection object - */ - public AccountsApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Get a list of accounts for a specific member. - * - * @param memberId Specify the member Id. This can be obtained by running getUserEntitlements() from MemberEntitlementManagementApi. - * @return Accounts object {@link Accounts} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Accounts getAccounts(String memberId) throws AzDException { - var q = new HashMap() {{ - put("memberId", memberId); - }}; - - String r = send(RequestMethod.GET, CONNECTION, AREA, null, AREA, null, - null, ApiVersion.ACCOUNTS, q, null, null); - - return MAPPER.mapJsonResponse(r, Accounts.class); - } - - /** - * Get the list of organizations that you have access to. Note that while creating and granting access to the personal - * access token select all organizations to apply the access on all available organizations. - * - * @return A list of Organization. {@link Organizations} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Organizations getOrganizations() throws AzDException { - var ids = new ArrayList<>(); - ids.add("ms.vss-features.my-organizations-data-provider"); - - var b = new HashMap() {{ - put("contributionIds", ids); - put("dataProviderContext", new HashMap() {{ - put("properties", "{}"); - }}); - }}; - - String r = send(RequestMethod.POST, CONNECTION, null, null, "Contribution", null, - "HierarchyQuery", ApiVersion.ACCOUNTS, null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, Organizations.class); - } - - /** - * Gets the logged in user profile. - * - * @return a profile object. {@link Profile} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Profile getProfile() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, AREA, null, - "/profile/profiles", "me", null, ApiVersion.PROFILE, null, null, null); - - return MAPPER.mapJsonResponse(r, Profile.class); - } - - /** - * Gets a user profile. - * - * @param id pass the user id - * @return a profile object. {@link Profile} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Profile getProfile(String id) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, AREA, null, - "/profile/profiles", id, null, ApiVersion.PROFILE, null, null, null); - - return MAPPER.mapJsonResponse(r, Profile.class); - } -} \ No newline at end of file diff --git a/azd/src/main/java/org/azd/artifacts/feedmanagement/FeedManagementRequestBuilder.java b/azd/src/main/java/org/azd/artifacts/feedmanagement/FeedManagementRequestBuilder.java index c4ccd33a..7a6c96fd 100644 --- a/azd/src/main/java/org/azd/artifacts/feedmanagement/FeedManagementRequestBuilder.java +++ b/azd/src/main/java/org/azd/artifacts/feedmanagement/FeedManagementRequestBuilder.java @@ -2,12 +2,12 @@ import org.azd.abstractions.BaseRequestBuilder; import org.azd.abstractions.QueryParameter; +import org.azd.artifacts.types.Feed; +import org.azd.artifacts.types.Feeds; import org.azd.authentication.AccessTokenCredential; import org.azd.common.ApiVersion; import org.azd.enums.FeedRole; import org.azd.exceptions.AzDException; -import org.azd.feedmanagement.types.Feed; -import org.azd.feedmanagement.types.Feeds; import java.util.concurrent.CompletableFuture; import java.util.function.Consumer; diff --git a/azd/src/main/java/org/azd/artifacts/feedmanagement/FeedPermissionsRequestBuilder.java b/azd/src/main/java/org/azd/artifacts/feedmanagement/FeedPermissionsRequestBuilder.java index ea509af6..9f322edd 100644 --- a/azd/src/main/java/org/azd/artifacts/feedmanagement/FeedPermissionsRequestBuilder.java +++ b/azd/src/main/java/org/azd/artifacts/feedmanagement/FeedPermissionsRequestBuilder.java @@ -2,10 +2,10 @@ import org.azd.abstractions.BaseRequestBuilder; import org.azd.abstractions.QueryParameter; +import org.azd.artifacts.types.FeedPermissions; import org.azd.authentication.AccessTokenCredential; import org.azd.common.ApiVersion; import org.azd.exceptions.AzDException; -import org.azd.feedmanagement.types.FeedPermissions; import java.util.Objects; import java.util.concurrent.CompletableFuture; diff --git a/azd/src/main/java/org/azd/artifacts/feedmanagement/FeedViewRequestBuilder.java b/azd/src/main/java/org/azd/artifacts/feedmanagement/FeedViewRequestBuilder.java index 1ae84cc6..9ff7aa07 100644 --- a/azd/src/main/java/org/azd/artifacts/feedmanagement/FeedViewRequestBuilder.java +++ b/azd/src/main/java/org/azd/artifacts/feedmanagement/FeedViewRequestBuilder.java @@ -1,11 +1,11 @@ package org.azd.artifacts.feedmanagement; import org.azd.abstractions.BaseRequestBuilder; +import org.azd.artifacts.types.FeedView; +import org.azd.artifacts.types.FeedViews; import org.azd.authentication.AccessTokenCredential; import org.azd.common.ApiVersion; import org.azd.exceptions.AzDException; -import org.azd.feedmanagement.types.FeedView; -import org.azd.feedmanagement.types.FeedViews; import java.util.concurrent.CompletableFuture; diff --git a/azd/src/main/java/org/azd/feedmanagement/types/Feed.java b/azd/src/main/java/org/azd/artifacts/types/Feed.java similarity index 99% rename from azd/src/main/java/org/azd/feedmanagement/types/Feed.java rename to azd/src/main/java/org/azd/artifacts/types/Feed.java index a53c8cd3..c85939a9 100644 --- a/azd/src/main/java/org/azd/feedmanagement/types/Feed.java +++ b/azd/src/main/java/org/azd/artifacts/types/Feed.java @@ -1,4 +1,4 @@ -package org.azd.feedmanagement.types; +package org.azd.artifacts.types; /** * ---------------------------------------------------------- * GENERATED FILE, should be edited to suit the purpose. diff --git a/azd/src/main/java/org/azd/feedmanagement/types/FeedPermission.java b/azd/src/main/java/org/azd/artifacts/types/FeedPermission.java similarity index 98% rename from azd/src/main/java/org/azd/feedmanagement/types/FeedPermission.java rename to azd/src/main/java/org/azd/artifacts/types/FeedPermission.java index 6c56bcbf..1be8ae05 100644 --- a/azd/src/main/java/org/azd/feedmanagement/types/FeedPermission.java +++ b/azd/src/main/java/org/azd/artifacts/types/FeedPermission.java @@ -1,4 +1,4 @@ -package org.azd.feedmanagement.types; +package org.azd.artifacts.types; /** * ---------------------------------------------------------- * GENERATED FILE, should be edited to suit the purpose. diff --git a/azd/src/main/java/org/azd/feedmanagement/types/FeedPermissions.java b/azd/src/main/java/org/azd/artifacts/types/FeedPermissions.java similarity index 94% rename from azd/src/main/java/org/azd/feedmanagement/types/FeedPermissions.java rename to azd/src/main/java/org/azd/artifacts/types/FeedPermissions.java index 682aafec..f4f80ccc 100644 --- a/azd/src/main/java/org/azd/feedmanagement/types/FeedPermissions.java +++ b/azd/src/main/java/org/azd/artifacts/types/FeedPermissions.java @@ -1,4 +1,4 @@ -package org.azd.feedmanagement.types; +package org.azd.artifacts.types; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; diff --git a/azd/src/main/java/org/azd/feedmanagement/types/FeedView.java b/azd/src/main/java/org/azd/artifacts/types/FeedView.java similarity index 98% rename from azd/src/main/java/org/azd/feedmanagement/types/FeedView.java rename to azd/src/main/java/org/azd/artifacts/types/FeedView.java index 2cbcf818..b0a3a440 100644 --- a/azd/src/main/java/org/azd/feedmanagement/types/FeedView.java +++ b/azd/src/main/java/org/azd/artifacts/types/FeedView.java @@ -1,4 +1,4 @@ -package org.azd.feedmanagement.types; +package org.azd.artifacts.types; /** * ---------------------------------------------------------- * GENERATED FILE, should be edited to suit the purpose. diff --git a/azd/src/main/java/org/azd/feedmanagement/types/FeedViews.java b/azd/src/main/java/org/azd/artifacts/types/FeedViews.java similarity index 94% rename from azd/src/main/java/org/azd/feedmanagement/types/FeedViews.java rename to azd/src/main/java/org/azd/artifacts/types/FeedViews.java index 321fe8f9..5f1a1839 100644 --- a/azd/src/main/java/org/azd/feedmanagement/types/FeedViews.java +++ b/azd/src/main/java/org/azd/artifacts/types/FeedViews.java @@ -1,4 +1,4 @@ -package org.azd.feedmanagement.types; +package org.azd.artifacts.types; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; diff --git a/azd/src/main/java/org/azd/feedmanagement/types/Feeds.java b/azd/src/main/java/org/azd/artifacts/types/Feeds.java similarity index 93% rename from azd/src/main/java/org/azd/feedmanagement/types/Feeds.java rename to azd/src/main/java/org/azd/artifacts/types/Feeds.java index 80c3b607..803aa732 100644 --- a/azd/src/main/java/org/azd/feedmanagement/types/Feeds.java +++ b/azd/src/main/java/org/azd/artifacts/types/Feeds.java @@ -1,4 +1,4 @@ -package org.azd.feedmanagement.types; +package org.azd.artifacts.types; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; diff --git a/azd/src/main/java/org/azd/feedmanagement/types/ProjectReference.java b/azd/src/main/java/org/azd/artifacts/types/ProjectReference.java similarity index 97% rename from azd/src/main/java/org/azd/feedmanagement/types/ProjectReference.java rename to azd/src/main/java/org/azd/artifacts/types/ProjectReference.java index 037aa268..b92e69bf 100644 --- a/azd/src/main/java/org/azd/feedmanagement/types/ProjectReference.java +++ b/azd/src/main/java/org/azd/artifacts/types/ProjectReference.java @@ -1,4 +1,4 @@ -package org.azd.feedmanagement.types; +package org.azd.artifacts.types; /** * ---------------------------------------------------------- * GENERATED FILE, should be edited to suit the purpose. diff --git a/azd/src/main/java/org/azd/feedmanagement/types/UpstreamSource.java b/azd/src/main/java/org/azd/artifacts/types/UpstreamSource.java similarity index 99% rename from azd/src/main/java/org/azd/feedmanagement/types/UpstreamSource.java rename to azd/src/main/java/org/azd/artifacts/types/UpstreamSource.java index f1da96ac..7b2c17da 100644 --- a/azd/src/main/java/org/azd/feedmanagement/types/UpstreamSource.java +++ b/azd/src/main/java/org/azd/artifacts/types/UpstreamSource.java @@ -1,4 +1,4 @@ -package org.azd.feedmanagement.types; +package org.azd.artifacts.types; /** * ---------------------------------------------------------- * GENERATED FILE, should be edited to suit the purpose. diff --git a/azd/src/main/java/org/azd/feedmanagement/types/UpstreamStatusDetail.java b/azd/src/main/java/org/azd/artifacts/types/UpstreamStatusDetail.java similarity index 95% rename from azd/src/main/java/org/azd/feedmanagement/types/UpstreamStatusDetail.java rename to azd/src/main/java/org/azd/artifacts/types/UpstreamStatusDetail.java index a5e4d968..dbf62088 100644 --- a/azd/src/main/java/org/azd/feedmanagement/types/UpstreamStatusDetail.java +++ b/azd/src/main/java/org/azd/artifacts/types/UpstreamStatusDetail.java @@ -1,4 +1,4 @@ -package org.azd.feedmanagement.types; +package org.azd.artifacts.types; /** * ---------------------------------------------------------- * GENERATED FILE, should be edited to suit the purpose. diff --git a/azd/src/main/java/org/azd/artifactspackagetypes/maven/MavenRequestBuilder.java b/azd/src/main/java/org/azd/artifactspackagetypes/maven/MavenRequestBuilder.java index 14eb8e64..8e312a1c 100644 --- a/azd/src/main/java/org/azd/artifactspackagetypes/maven/MavenRequestBuilder.java +++ b/azd/src/main/java/org/azd/artifactspackagetypes/maven/MavenRequestBuilder.java @@ -1,21 +1,17 @@ package org.azd.artifactspackagetypes.maven; import org.azd.abstractions.BaseRequestBuilder; -import org.azd.abstractions.ResponseHandler; import org.azd.artifactspackagetypes.ArtifactsPackageTypesRequestBuilder; import org.azd.artifactspackagetypes.types.MavenPackagesBatchRequest; +import org.azd.artifactspackagetypes.types.Package; import org.azd.artifactspackagetypes.types.PackageVersionDetails; import org.azd.authentication.AccessTokenCredential; import org.azd.common.ApiVersion; import org.azd.enums.CustomHeader; -import org.azd.enums.HttpStatusCode; import org.azd.exceptions.AzDException; import org.azd.helpers.StreamHelper; -import org.azd.http.ClientRequest; -import org.azd.maven.types.Package; import java.io.InputStream; -import java.util.Map; import java.util.Objects; import java.util.concurrent.CompletableFuture; import java.util.function.Consumer; @@ -75,37 +71,7 @@ public CompletableFuture downloadAsync(Consumer { - try { - var res = ResponseHandler.getResponse(); - var statusCode = res.getStatusCode(); - var headers = res.getResponseHeaders().firstValue("Content-Type"); - - if (headers.isPresent()) { - // Error scenarios. - if (headers.get().equals(CustomHeader.JSON_CONTENT_TYPE_UTF_8.getValue()) && statusCode != HttpStatusCode.OK) - serializer.deserialize(StreamHelper.convertToString(x), Map.class); - - // Obviously VSTS server doesn't return callback URL. - if (headers.get().equals(CustomHeader.STREAM.getValue()) && statusCode == HttpStatusCode.OK) - return x; - - // Azure DevOps Services successful redirection - return ClientRequest.builder() - .URI(res.getRequestUrl()) - .header(CustomHeader.STREAM) - .build() - .executeStreamAsync() - .join(); - } - - throw new AzDException("An error occurred while trying to download artifact. " + StreamHelper.convertToString(x)); - - } catch (AzDException e) { - throw new RuntimeException(e); - } - }); + .executeStreamAsync(); } /** @@ -238,39 +204,15 @@ public InputStream download(Consumer pathParameters) throws final var values = new MavenPathParameters(); pathParameters.accept(values); - var stream = builder() + return builder() .location("c338d4b5-d30a-47e2-95b7-f157ef558833") .serviceEndpoint("artifactId", Objects.requireNonNull(values.artifactId, "Artifact ID cannot be null.")) .serviceEndpoint("feedId", Objects.requireNonNull(values.feedId, "Feed ID cannot be null.")) .serviceEndpoint("groupId", Objects.requireNonNull(values.groupId, "Group ID cannot be null.")) .serviceEndpoint("version", Objects.requireNonNull(values.version, "Version of the artifact is mandatory.")) .serviceEndpoint("fileName", Objects.requireNonNull(values.fileName, "File name cannot be null.")) - .header(CustomHeader.STREAM) .build() .executeStream(); - - var res = ResponseHandler.getResponse(); - var statusCode = res.getStatusCode(); - var headers = res.getResponseHeaders().firstValue("Content-Type"); - - if (headers.isPresent()) { - // Error scenarios. - if (headers.get().equals(CustomHeader.JSON_CONTENT_TYPE_UTF_8.getValue()) && statusCode != HttpStatusCode.OK) - serializer.deserialize(StreamHelper.convertToString(stream), Map.class); - - // VSTS server doesn't return callback URL. - if (headers.get().equals(CustomHeader.STREAM.getValue()) && statusCode == HttpStatusCode.OK) - return stream; - - // Azure DevOps Services successful redirection - return ClientRequest.builder() - .URI(res.getRequestUrl()) - .header(CustomHeader.STREAM) - .build() - .executeStream(); - } - - throw new AzDException("An error occurred while trying to download artifact. " + StreamHelper.convertToString(stream)); } /** diff --git a/azd/src/main/java/org/azd/artifactspackagetypes/maven/PackageFromRecycleBinRequestBuilder.java b/azd/src/main/java/org/azd/artifactspackagetypes/maven/PackageFromRecycleBinRequestBuilder.java index 8ee77f71..c14d3a45 100644 --- a/azd/src/main/java/org/azd/artifactspackagetypes/maven/PackageFromRecycleBinRequestBuilder.java +++ b/azd/src/main/java/org/azd/artifactspackagetypes/maven/PackageFromRecycleBinRequestBuilder.java @@ -1,12 +1,12 @@ package org.azd.artifactspackagetypes.maven; import org.azd.abstractions.BaseRequestBuilder; +import org.azd.artifactspackagetypes.types.MavenPackageVersionDeletionState; import org.azd.artifactspackagetypes.types.MavenPackagesBatchRequest; import org.azd.artifactspackagetypes.types.MavenRecycleBinPackageVersionDetails; import org.azd.authentication.AccessTokenCredential; import org.azd.common.ApiVersion; import org.azd.exceptions.AzDException; -import org.azd.maven.types.MavenPackageVersionDeletionState; import java.util.Objects; import java.util.concurrent.CompletableFuture; diff --git a/azd/src/main/java/org/azd/artifactspackagetypes/maven/UpstreamingBehaviorRequestBuilder.java b/azd/src/main/java/org/azd/artifactspackagetypes/maven/UpstreamingBehaviorRequestBuilder.java index befc97e4..6ec4626f 100644 --- a/azd/src/main/java/org/azd/artifactspackagetypes/maven/UpstreamingBehaviorRequestBuilder.java +++ b/azd/src/main/java/org/azd/artifactspackagetypes/maven/UpstreamingBehaviorRequestBuilder.java @@ -1,10 +1,10 @@ package org.azd.artifactspackagetypes.maven; import org.azd.abstractions.BaseRequestBuilder; +import org.azd.artifactspackagetypes.types.UpstreamingBehavior; import org.azd.authentication.AccessTokenCredential; import org.azd.common.ApiVersion; import org.azd.exceptions.AzDException; -import org.azd.maven.types.UpstreamingBehavior; import java.util.Objects; import java.util.concurrent.CompletableFuture; diff --git a/azd/src/main/java/org/azd/maven/types/MavenPackageVersionDeletionState.java b/azd/src/main/java/org/azd/artifactspackagetypes/types/MavenPackageVersionDeletionState.java similarity index 96% rename from azd/src/main/java/org/azd/maven/types/MavenPackageVersionDeletionState.java rename to azd/src/main/java/org/azd/artifactspackagetypes/types/MavenPackageVersionDeletionState.java index 57b6f7a7..fe050f10 100644 --- a/azd/src/main/java/org/azd/maven/types/MavenPackageVersionDeletionState.java +++ b/azd/src/main/java/org/azd/artifactspackagetypes/types/MavenPackageVersionDeletionState.java @@ -1,4 +1,4 @@ -package org.azd.maven.types; +package org.azd.artifactspackagetypes.types; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; diff --git a/azd/src/main/java/org/azd/upack/types/Package.java b/azd/src/main/java/org/azd/artifactspackagetypes/types/Package.java similarity index 97% rename from azd/src/main/java/org/azd/upack/types/Package.java rename to azd/src/main/java/org/azd/artifactspackagetypes/types/Package.java index 39a4d2b7..6283a92d 100644 --- a/azd/src/main/java/org/azd/upack/types/Package.java +++ b/azd/src/main/java/org/azd/artifactspackagetypes/types/Package.java @@ -1,4 +1,4 @@ -package org.azd.upack.types; +package org.azd.artifactspackagetypes.types; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; diff --git a/azd/src/main/java/org/azd/maven/types/PackagingSourceType.java b/azd/src/main/java/org/azd/artifactspackagetypes/types/PackagingSourceType.java similarity index 95% rename from azd/src/main/java/org/azd/maven/types/PackagingSourceType.java rename to azd/src/main/java/org/azd/artifactspackagetypes/types/PackagingSourceType.java index 87af81bd..fdf3d5cf 100644 --- a/azd/src/main/java/org/azd/maven/types/PackagingSourceType.java +++ b/azd/src/main/java/org/azd/artifactspackagetypes/types/PackagingSourceType.java @@ -1,4 +1,4 @@ -package org.azd.maven.types; +package org.azd.artifactspackagetypes.types; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; diff --git a/azd/src/main/java/org/azd/maven/types/ReferenceLinks.java b/azd/src/main/java/org/azd/artifactspackagetypes/types/ReferenceLinks.java similarity index 92% rename from azd/src/main/java/org/azd/maven/types/ReferenceLinks.java rename to azd/src/main/java/org/azd/artifactspackagetypes/types/ReferenceLinks.java index 1d364967..c10683e5 100644 --- a/azd/src/main/java/org/azd/maven/types/ReferenceLinks.java +++ b/azd/src/main/java/org/azd/artifactspackagetypes/types/ReferenceLinks.java @@ -1,4 +1,4 @@ -package org.azd.maven.types; +package org.azd.artifactspackagetypes.types; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; diff --git a/azd/src/main/java/org/azd/upack/types/UPackPackageVersionDeletionState.java b/azd/src/main/java/org/azd/artifactspackagetypes/types/UPackPackageVersionDeletionState.java similarity index 96% rename from azd/src/main/java/org/azd/upack/types/UPackPackageVersionDeletionState.java rename to azd/src/main/java/org/azd/artifactspackagetypes/types/UPackPackageVersionDeletionState.java index b767c13a..be4e3b4a 100644 --- a/azd/src/main/java/org/azd/upack/types/UPackPackageVersionDeletionState.java +++ b/azd/src/main/java/org/azd/artifactspackagetypes/types/UPackPackageVersionDeletionState.java @@ -1,4 +1,4 @@ -package org.azd.upack.types; +package org.azd.artifactspackagetypes.types; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; diff --git a/azd/src/main/java/org/azd/maven/types/UpstreamSourceInfo.java b/azd/src/main/java/org/azd/artifactspackagetypes/types/UpstreamSourceInfo.java similarity index 97% rename from azd/src/main/java/org/azd/maven/types/UpstreamSourceInfo.java rename to azd/src/main/java/org/azd/artifactspackagetypes/types/UpstreamSourceInfo.java index c9b241ac..7f5f840a 100644 --- a/azd/src/main/java/org/azd/maven/types/UpstreamSourceInfo.java +++ b/azd/src/main/java/org/azd/artifactspackagetypes/types/UpstreamSourceInfo.java @@ -1,4 +1,4 @@ -package org.azd.maven.types; +package org.azd.artifactspackagetypes.types; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; diff --git a/azd/src/main/java/org/azd/maven/types/UpstreamingBehavior.java b/azd/src/main/java/org/azd/artifactspackagetypes/types/UpstreamingBehavior.java similarity index 95% rename from azd/src/main/java/org/azd/maven/types/UpstreamingBehavior.java rename to azd/src/main/java/org/azd/artifactspackagetypes/types/UpstreamingBehavior.java index 6a3ead9d..16604aa1 100644 --- a/azd/src/main/java/org/azd/maven/types/UpstreamingBehavior.java +++ b/azd/src/main/java/org/azd/artifactspackagetypes/types/UpstreamingBehavior.java @@ -1,4 +1,4 @@ -package org.azd.maven.types; +package org.azd.artifactspackagetypes.types; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; diff --git a/azd/src/main/java/org/azd/artifactspackagetypes/universal/UniversalPackageFromRecycleBinRequestBuilder.java b/azd/src/main/java/org/azd/artifactspackagetypes/universal/UniversalPackageFromRecycleBinRequestBuilder.java index 54b656b2..79079073 100644 --- a/azd/src/main/java/org/azd/artifactspackagetypes/universal/UniversalPackageFromRecycleBinRequestBuilder.java +++ b/azd/src/main/java/org/azd/artifactspackagetypes/universal/UniversalPackageFromRecycleBinRequestBuilder.java @@ -1,12 +1,12 @@ package org.azd.artifactspackagetypes.universal; import org.azd.abstractions.BaseRequestBuilder; +import org.azd.artifactspackagetypes.types.UPackPackageVersionDeletionState; import org.azd.artifactspackagetypes.types.UPackPackagesBatchRequest; import org.azd.artifactspackagetypes.types.UPackRecycleBinPackageVersionDetails; import org.azd.authentication.AccessTokenCredential; import org.azd.common.ApiVersion; import org.azd.exceptions.AzDException; -import org.azd.upack.types.UPackPackageVersionDeletionState; import java.util.Objects; import java.util.concurrent.CompletableFuture; diff --git a/azd/src/main/java/org/azd/artifactspackagetypes/universal/UniversalRequestBuilder.java b/azd/src/main/java/org/azd/artifactspackagetypes/universal/UniversalRequestBuilder.java index 964acb1c..ba523ea2 100644 --- a/azd/src/main/java/org/azd/artifactspackagetypes/universal/UniversalRequestBuilder.java +++ b/azd/src/main/java/org/azd/artifactspackagetypes/universal/UniversalRequestBuilder.java @@ -2,13 +2,12 @@ import org.azd.abstractions.BaseRequestBuilder; import org.azd.artifactspackagetypes.ArtifactsPackageTypesRequestBuilder; -import org.azd.artifactspackagetypes.maven.PackageFromRecycleBinRequestBuilder; +import org.azd.artifactspackagetypes.types.Package; import org.azd.artifactspackagetypes.types.PackageVersionDetails; import org.azd.artifactspackagetypes.types.UPackPackagesBatchRequest; import org.azd.authentication.AccessTokenCredential; import org.azd.common.ApiVersion; import org.azd.exceptions.AzDException; -import org.azd.upack.types.Package; import java.util.Objects; import java.util.concurrent.CompletableFuture; diff --git a/azd/src/main/java/org/azd/authentication/ServicePrincipalAccessTokenCredential.java b/azd/src/main/java/org/azd/authentication/ServicePrincipalAccessTokenCredential.java new file mode 100644 index 00000000..114e7968 --- /dev/null +++ b/azd/src/main/java/org/azd/authentication/ServicePrincipalAccessTokenCredential.java @@ -0,0 +1,148 @@ +package org.azd.authentication; + +import org.azd.abstractions.RequestInformation; +import org.azd.common.types.AccessToken; +import org.azd.enums.CustomHeader; +import org.azd.enums.RequestMethod; +import org.azd.exceptions.AzDException; +import org.azd.http.ClientRequest; + +import java.net.http.HttpRequest; +import java.nio.charset.StandardCharsets; + +/** + * Represents service principal access token modal. + * + * @see SPN authentication + */ +public class ServicePrincipalAccessTokenCredential implements AccessTokenCredential{ + /** + * Access token request base URL + */ + private static final String BASEURL = "https://login.microsoftonline.com/"; + /** + * Access token request endpoint v2.0 + */ + private static final String TOKEN_ENDPOINT = "/oauth2/v2.0/token"; + /** + * Default resource for requesting access token + */ + private static final String SCOPES = "499b84ac-1321-427f-aa17-267ca6975798/.default"; + /** + * Authentication grant type when using service principal. + */ + private static final String GRANT_TYPE = "&grant_type=client_credentials"; + + /** + * Azure DevOps organization or TFS collection url. + */ + private String organizationUrl; + /** + * Project name + */ + private String projectName; + /** + * Client Id. + */ + private final String clientId; + /** + * Client Secret. + */ + private final String clientSecret; + /** + * Tenant Id. + */ + private final String tenantId; + /** + * Represents the bearer access token + */ + private String accessToken; + + /** + * Creates a new Service Principal token credential provider object. + * + * @param organizationUrl Azure DevOps organization url. + * @param clientId Client id of registered app in Entra Id. + * @param clientSecret Client secret of registered app in Entra Id. + * @param tenantId Tenant id of the registered app in Entra Id. + */ + public ServicePrincipalAccessTokenCredential(String organizationUrl, String tenantId, + String clientId, String clientSecret) { + this(organizationUrl, null, tenantId, clientId, clientSecret); + } + + /** + * Creates a new Service Principal token credential provider object. + * + * @param organizationUrl Azure DevOps organization url. + * @param clientId Client id of registered app in Entra Id. + * @param clientSecret Client secret of registered app in Entra Id. + * @param tenantId Tenant id of the registered app in Entra Id. + */ + public ServicePrincipalAccessTokenCredential(String organizationUrl, String projectName, String tenantId, + String clientId, String clientSecret) { + this.organizationUrl = organizationUrl; + this.projectName = projectName; + this.tenantId = tenantId; + this.clientId = clientId; + this.clientSecret = clientSecret; + } + + @Override + public String getOrganizationUrl() { + return organizationUrl; + } + + @Override + public void setOrganizationUrl(String organizationUrl) { + this.organizationUrl = organizationUrl; + } + + @Override + public String getProjectName() { + return projectName; + } + + @Override + public void setProjectName(String projectName) { + this.projectName = projectName; + } + + @Override + public String getAccessToken() { + authenticate(); + return accessToken; + } + + @Override + public void setAccessToken(String accessToken) { + this.accessToken = "Bearer " + accessToken; + } + + /** + * Authenticate with given client id, tenant id & client secret and generates the access token. + */ + private void authenticate() { + var body = "client_id=" + this.clientId + + "&scope=" + SCOPES + + "&client_secret=" + this.clientSecret + + GRANT_TYPE; + + try { + var reqInfo = new RequestInformation(); + reqInfo.requestMethod = RequestMethod.POST; + reqInfo.setRequestUrl(BASEURL + this.tenantId + TOKEN_ENDPOINT); + reqInfo.requestHeaders.add(CustomHeader.URL_ENCODED); + reqInfo.body = HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8); + + var res = ClientRequest.builder() + .request(reqInfo) + .build() + .execute(AccessToken.class); + + setAccessToken(res.Token); + } catch (AzDException e) { + throw new RuntimeException(e); + } + } +} diff --git a/azd/src/main/java/org/azd/build/BuildApi.java b/azd/src/main/java/org/azd/build/BuildApi.java deleted file mode 100644 index 213e7a31..00000000 --- a/azd/src/main/java/org/azd/build/BuildApi.java +++ /dev/null @@ -1,1731 +0,0 @@ -package org.azd.build; - -import org.azd.build.types.*; -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.enums.*; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.helpers.URLHelper; -import org.azd.interfaces.BuildDetails; -import org.azd.utils.AzDAsyncApi; - -import java.io.InputStream; -import java.util.*; -import java.util.stream.Collectors; - -import static org.azd.utils.RestClient.send; - -/** - * Build class to manage build API - */ -public class BuildApi extends AzDAsyncApi implements BuildDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "build"; - private final String BUILD = "5d6898bb-45ec-463f-95f9-54d49c71752e"; - - /** - * Pass the connection object - * - * @param connection Connection object - */ - public BuildApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Deletes a build. - * - * @param buildId pass the build id to delete - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteBuild(int buildId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), null, ApiVersion.BUILD, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Gets a build - * - * @param buildId pass the build id - * @return a build object {@link Build} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Build getBuild(int buildId) throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), null, ApiVersion.BUILD, null, null, null); - - return MAPPER.mapJsonResponse(r, Build.class); - } - - /** - * Gets the changes associated with a build - * - * @param buildId pass the build id - * @return the object of build changes - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildChanges getBuildChanges(int buildId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "changes", ApiVersion.BUILD_CHANGES, null, null, null); - - return MAPPER.mapJsonResponse(r, BuildChanges.class); - } - - /** - * Gets the changes associated with a build - * - * @param buildId pass the build id - * @param top The maximum number of changes to return - * @param continuationToken pass the continuation token - * @param includeSourceChange if set to true gets the source changes - * @return the object of build changes - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildChanges getBuildChanges( - int buildId, int top, String continuationToken, boolean includeSourceChange) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("$top", top); - put("continuationToken", continuationToken); - put("includeSourceChange", includeSourceChange); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "changes", ApiVersion.BUILD_CHANGES, q, null, null); - return MAPPER.mapJsonResponse(r, BuildChanges.class); - } - - /** - * Gets an individual log file for a build. - * - * @param buildId pass the build id - * @param logId pass the log id - * @return logs associated with the build for given id - * @throws AzDException Default Api Exception handler. - */ - @Override - public String getBuildLog(int buildId, int logId) throws AzDException { - return send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "logs/" + logId, ApiVersion.BUILD_LOGS, - null, null, CustomHeader.TEXT_CONTENT); - } - - /** - * Gets an individual log file for a build. - * - * @param buildId pass the build id - * @param logId pass the log id - * @param startLine pass the line number from log which you need to fetch - * @param endLine pass till which line number you need to fetch from the log - * @return logs associated with the build for given id - * @throws AzDException Default Api Exception handler. - */ - @Override - public String getBuildLog(int buildId, int logId, long startLine, long endLine) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("startLine", startLine); - put("endLine", endLine); - }}; - - return send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "logs/" + logId, ApiVersion.BUILD_LOGS, q, - null, CustomHeader.TEXT_CONTENT); - } - - /** - * Gets the logs for a build. - * - * @param buildId pass the build id - * @return the object of build logs with id. This can be used to fetch the particular log with id - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildLogs getBuildLogs(int buildId) throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "logs", ApiVersion.BUILD_LOGS, null, null, null); - - return MAPPER.mapJsonResponse(r, BuildLogs.class); - } - - /** - * Gets the work items associated with a build. - * - * @param buildId The ID of the build. - * @return an array of work items associated with the build - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildWorkItems getBuildWorkItems(int buildId) throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "workitems", ApiVersion.BUILD_WORK_ITEMS, null, null, null); - - return MAPPER.mapJsonResponse(r, BuildWorkItems.class); - } - - /** - * Gets the work items associated with a build. - * - * @param buildId id of the build - * @param top specify how many top work items to return - * @return an array of work items associated with the build - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildWorkItems getBuildWorkItems(int buildId, int top) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("$top", top); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "workitems", ApiVersion.BUILD_WORK_ITEMS, q, null, null); - - return MAPPER.mapJsonResponse(r, BuildWorkItems.class); - } - - /** - * Gets the changes made to the repository between two given builds. - * - * @param fromBuildId The ID of the first build. - * @param toBuildId The ID of the last build. - * @param top The maximum number of changes to return. - * @return an array of changes between the builds - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildChanges getChangesBetweenBuilds(int fromBuildId, int toBuildId, int top) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("$top", top); - put("fromBuildId", fromBuildId); - put("toBuildId", toBuildId); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA, null, "changes", ApiVersion.BUILD_CHANGES, q, null, null); - - return MAPPER.mapJsonResponse(r, BuildChanges.class); - } - - /** - * Gets all the work items between two builds. - * - * @param fromBuildId The ID of the first build. - * @param toBuildId The ID of the last build. - * @param top The maximum number of changes to return. - * @return an array of workitems between the builds - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildWorkItems getWorkItemsBetweenBuilds(int fromBuildId, int toBuildId, int top) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("$top", top); - put("fromBuildId", fromBuildId); - put("toBuildId", toBuildId); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA, null, "workitems", ApiVersion.BUILD_WORK_ITEMS, q, null, null); - - return MAPPER.mapJsonResponse(r, BuildWorkItems.class); - } - - /** - * Gets a list of builds. - * - * @return a build array {@link Builds} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Builds getBuilds() throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", null, null, ApiVersion.BUILD, null, null, null); - - return MAPPER.mapJsonResponse(r, Builds.class); - } - - /** - * Gets a list of builds. - * - * @param buildIds array of build ids - * @return an array of build - * @throws AzDException Default Api Exception handler. - */ - @Override - public Builds getBuilds(int[] buildIds) throws AzDException { - - String ids = Arrays.stream(buildIds).mapToObj(String::valueOf).collect(Collectors.joining(",")); - - HashMap q = new HashMap<>() {{ - put("buildIds", ids); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", null, null, ApiVersion.BUILD, q, null, null); - - return MAPPER.mapJsonResponse(r, Builds.class); - } - - /** - * Gets a list of builds. - * - * @param top specify how many builds to retrieve - * @return an array of build - * @throws AzDException Default Api Exception handler. - */ - @Override - public Builds getBuilds(int top) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("$top", top); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", null, null, ApiVersion.BUILD, q, null, null); - - return MAPPER.mapJsonResponse(r, Builds.class); - } - - /** - * Gets a list of builds. - * - * @param top specify how many builds to retrieve - * @param branchName If specified, filters to builds that built branches that built this branch. - * @param buildNumber If specified, filters to builds that match this build number. Append * to do a prefix search. - * @param continuationToken A continuation token, returned by a previous call to this method, that can be used to return the next set of builds. - * @param definitions A comma-delimited list of definition IDs. If specified, filters to builds for these definitions. - * @param deletedFilter Indicates whether to exclude, include, or only return deleted builds. - * @param maxBuildsPerDefinition The maximum number of builds to return per definition. - * @param maxTime If specified, filters to builds that finished/started/queued before this date based on the queryOrder specified. - * @param minTime If specified, filters to builds that finished/started/queued after this date based on the queryOrder specified. - * @param properties A comma-delimited list of properties to retrieve. - * @param queryOrder The order in which builds should be returned. - * @param queues A comma-delimited list of queue IDs. If specified, filters to builds that ran against these queues. - * @param reasonFilter If specified, filters to builds that match this reason. - * @param repositoryId If specified, filters to builds that built from this repository. - * @param repositoryType If specified, filters to builds that built from repositories of this type. - * @param requestedFor If specified, filters to builds requested for the specified user. - * @param resultFilter If specified, filters to builds that match this result. - * @param statusFilter If specified, filters to builds that match this status. - * @param tagFilters A comma-delimited list of tags. If specified, filters to builds that have the specified tags. - * @return an array of build - * @throws AzDException Default Api Exception handler. - */ - @Override - public Builds getBuilds( - int top, String branchName, String buildNumber, String continuationToken, int[] definitions, - QueryDeletedOption deletedFilter, int maxBuildsPerDefinition, String maxTime, String minTime, - String[] properties, BuildQueryOrder queryOrder, int[] queues, BuildReason reasonFilter, - String repositoryId, String repositoryType, String requestedFor, BuildResult resultFilter, - BuildStatus statusFilter, String tagFilters) throws AzDException { - - String ids = (definitions != null) ? Arrays.stream(definitions).mapToObj(String::valueOf).collect(Collectors.joining(",")) : null; - String queueIds = (queues != null) ? Arrays.stream(queues).mapToObj(String::valueOf).collect(Collectors.joining(",")) : null; - - HashMap q = new HashMap<>() {{ - put("$top", top); - put("branchName", branchName); - put("buildNumber", buildNumber); - put("continuationToken", continuationToken); - put("definitions", ids); - put("deletedFilter", deletedFilter); - put("maxBuildsPerDefinition", maxBuildsPerDefinition); - put("maxTime", maxTime); - put("minTime", minTime); - put("properties", (properties != null) ? String.join(",", properties) : null); - put("queryOrder", queryOrder); - put("queues", queueIds); - put("reasonFilter", reasonFilter); - put("repositoryType", repositoryType); - put("requestedFor", requestedFor); - put("resultFilter", resultFilter); - put("repositoryId", repositoryId); - put("statusFilter", statusFilter); - put("tagFilters", tagFilters); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", null, null, ApiVersion.BUILD, q, null, null); - - return MAPPER.mapJsonResponse(r, Builds.class); - } - - /** - * Queues a build - * - * @param definitionId pass the pipeline id to queue the build - * @return a build object {@link Build} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Build queueBuild(int definitionId) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("definitionId", String.valueOf(definitionId)); - }}; - - String r = send(RequestMethod.POST, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", null, null, ApiVersion.BUILD, q, null, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, Build.class); - } - - /** - * Queues a build - * - * @param buildParameters dictionary of parameters to queue the build. - * @return a build object {@link Build} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Build queueBuild(Build buildParameters) throws AzDException { - String r = send(RequestMethod.POST, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", null, null, ApiVersion.BUILD, null, buildParameters, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, Build.class); - } - - /** - * Updates a build. - * - * @param build pass the Build object to update. {@link Build} - * @param buildId The ID of the build. - * @param retry None - * @return Build Object {@link Build} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public Build updateBuild(Build build, int buildId, boolean retry) throws AzDException { - var q = new HashMap() {{ - put("retry", retry); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), null, ApiVersion.BUILD, q, build, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, Build.class); - } - - /** - * Updates multiple builds. - * - * @param builds List of build to update. {@link Builds} - * @return Build Object {@link Build} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public Builds updateBuilds(Builds builds) throws AzDException { - String r = send(RequestMethod.PATCH, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", null, null, ApiVersion.BUILD, null, builds.getBuildResults(), CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, Builds.class); - } - - /** - * Gets controllers - * - * @return array of build controller {@link BuildControllers} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildControllers getBuildControllers() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, BUILD, null, - AREA, null, "controllers", ApiVersion.BUILD_CONTROLLERS, null, null, null); - - return MAPPER.mapJsonResponse(r, BuildControllers.class); - } - - /** - * Gets controller, optionally filtered by name - * - * @param name pass the controller name - * @return array of build controller {@link BuildControllers} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildControllers getBuildControllers(String name) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("name", name); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, null, - AREA, null, "controllers", ApiVersion.BUILD_CONTROLLERS, q, null, null); - - return MAPPER.mapJsonResponse(r, BuildControllers.class); - } - - /** - * Gets a controller - * - * @param controllerId pass the controller id - * @return build controller {@link BuildController} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildController getBuildController(int controllerId) throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, BUILD, null, - AREA + "/controllers", Integer.toString(controllerId), null, ApiVersion.BUILD_CONTROLLERS, - null, null, null); - - return MAPPER.mapJsonResponse(r, BuildController.class); - } - - /** - * Creates a new definition. - * - * @param buildDefinitionParameters json string of the build pipeline. Export the build definition from existing pipeline and edit it. - * Or get the existing build definition using getBuildDefinition(definitionId) method and call toString() method on it to - * convert the value to string and create the definition. Easiest way is to use cloneBuildDefinition() method to create - * a clone of build definition and later edit it to suit the needs. - * @return build definition {@link BuildDefinition} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildDefinition createBuildDefinition(String buildDefinitionParameters) throws AzDException { - - if (buildDefinitionParameters.isEmpty()) throw new AzDException(); - - var requestBody = MAPPER.mapJsonResponse(buildDefinitionParameters, Map.class); - - String r = send(RequestMethod.POST, CONNECTION, BUILD, CONNECTION.getProject(), - AREA, null, "definitions", ApiVersion.BUILD_DEFINITIONS, null, requestBody, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, BuildDefinition.class); - } - - /** - * Creates a new definition. - * - * @param buildDefinition Build definition object. Export the build definition from existing pipeline and edit it. - * Or get the existing build definition using getBuildDefinition(definitionId). - * @return build definition {@link BuildDefinition} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildDefinition createBuildDefinition(BuildDefinition buildDefinition, Number definitionToCloneId, - Number definitionToCloneRevision) throws AzDException { - - Objects.requireNonNull(buildDefinition); - - var q = new HashMap() {{ - put("definitionToCloneId", definitionToCloneId); - put("definitionToCloneRevision", definitionToCloneRevision); - }}; - - String r = send(RequestMethod.POST, CONNECTION, BUILD, CONNECTION.getProject(), - AREA, null, "definitions", ApiVersion.BUILD_DEFINITIONS, q, buildDefinition, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, BuildDefinition.class); - } - - /** - * Clone an existing definition/pipeline - * - * @param definitionName Name of the build definition/pipeline. E.g., WebApp-Deployment-CI - * @param definitionCloneName Name of the pipeline/definition to be created or cloned. E.g., WebApp-Deployment-CI-Copy - * @return build definition {@link BuildDefinition} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildDefinition cloneBuildDefinition(String definitionName, String definitionCloneName) throws AzDException { - // validate if the definition exists - int def; - - try { - def = getBuildDefinitions() - .getBuildDefinitions() - .stream() - .filter(x -> x.getName().equals(definitionName)) - .findFirst() - .get() - .getId(); - } catch (Exception e) { - throw new AzDException("Cannot find the definition with name '" + definitionName + "'."); - } - - if (!Integer.toString(def).isEmpty()) { - var definitionObject = getBuildDefinition(def); - definitionObject.setName(definitionCloneName); - var res = MAPPER.convertToString(definitionObject); - return createBuildDefinition(res); - } - - return null; - } - - /** - * Deletes a definition and all associated builds. - * - * @param definitionId pass the definition id - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteBuildDefinition(int definitionId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", Integer.toString(definitionId), null, ApiVersion.BUILD_DEFINITIONS, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Gets a definition - * - * @param definitionId pass the definition id - * @return build definition {@link BuildDefinition} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildDefinition getBuildDefinition(int definitionId) throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", Integer.toString(definitionId), null, ApiVersion.BUILD_DEFINITIONS, - null, null, null); - - return MAPPER.mapJsonResponse(r, BuildDefinition.class); - } - - /** - * Gets a definition, optionally at a specific revision. - * - * @param definitionId The ID of the definition. - * @param includeLatestBuilds if specified gets the details of latest build - * @param minMetricsTime If specified, indicates the date from which metrics should be included. - * @param revision The revision number to retrieve. If this is not specified, the latest version will be returned. - * @return Build definition object - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildDefinition getBuildDefinition( - int definitionId, boolean includeLatestBuilds, String minMetricsTime, int revision) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("includeLatestBuilds", includeLatestBuilds); - put("minMetricsTime", minMetricsTime); - put("revision", revision); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", Integer.toString(definitionId), null, ApiVersion.BUILD_DEFINITIONS, - q, null, null); - - return MAPPER.mapJsonResponse(r, BuildDefinition.class); - } - - /** - * Gets all revisions of a definition. - * - * @param definitionId The ID of the definition. - * @return array of build definition revisions {@link BuildDefinitionRevision} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildDefinitionRevisions getBuildDefinitionRevisions(int definitionId) throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", Integer.toString(definitionId), "revisions", - ApiVersion.BUILD_DEFINITION_REVISIONS, null, null, null); - - return MAPPER.mapJsonResponse(r, BuildDefinitionRevisions.class); - } - - /** - * Gets a list of definitions. - * - * @return build definitions {@link BuildDefinitions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildDefinitions getBuildDefinitions() throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", null, null, ApiVersion.BUILD_DEFINITIONS, - null, null, null); - - return MAPPER.mapJsonResponse(r, BuildDefinitions.class); - } - - /** - * Gets a list of definitions. - * - * @param definitionIds array of definition ids - * @return build definitions {@link BuildDefinitions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildDefinitions getBuildDefinitions(int[] definitionIds) throws AzDException { - - String ids = Arrays.stream(definitionIds).mapToObj(String::valueOf).collect(Collectors.joining(",")); - - HashMap q = new HashMap<>() {{ - put("definitionIds", ids); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", null, null, ApiVersion.BUILD_DEFINITIONS, q, null, null); - - return MAPPER.mapJsonResponse(r, BuildDefinitions.class); - } - - /** - * Gets a list of definitions. - * - * @param top definitions to retrieve - * @return build definitions {@link BuildDefinitions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildDefinitions getBuildDefinitions(int top) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("$top", top); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", null, null, ApiVersion.BUILD_DEFINITIONS, q, null, null); - - return MAPPER.mapJsonResponse(r, BuildDefinitions.class); - } - - /** - * Gets a list of definitions. - * - * @param name Name of the build definition - * @return build definitions {@link BuildDefinitions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildDefinitions getBuildDefinitions(String name) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("name", name); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", null, null, ApiVersion.BUILD_DEFINITIONS, q, null, null); - - return MAPPER.mapJsonResponse(r, BuildDefinitions.class); - } - - /** - * Gets a list of definitions. - * - * @param includeAllProperties Indicates whether the full definitions should be returned. By default, shallow representations of the definitions are returned. - * @param includeLatestBuilds Indicates whether to return the latest and latest completed builds for this definition. - * @return build definitions {@link BuildDefinitions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildDefinitions getBuildDefinitions(boolean includeAllProperties, boolean includeLatestBuilds) throws AzDException { - HashMap q = new HashMap<>() {{ - put("includeAllProperties", includeAllProperties); - put("includeLatestBuilds", includeLatestBuilds); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", null, null, ApiVersion.BUILD_DEFINITIONS, q, null, null); - - return MAPPER.mapJsonResponse(r, BuildDefinitions.class); - } - - /** - * Gets a list of definitions. - * - * @param builtAfter If specified, filters to definitions that have builds after this date. - * @param continuationToken A continuation token, returned by a previous call to this method, that can be used to return the next set of definitions. - * @param includeAllProperties Indicates whether the full definitions should be returned. By default, shallow representations of the definitions are returned. - * @param includeLatestBuilds Indicates whether to return the latest and latest completed builds for this definition. - * @param minMetricsTime If specified, indicates the date from which metrics should be included. - * @param notBuiltAfter If specified, filters to definitions that do not have builds after this date. - * @param path If specified, filters to definitions under this folder. - * @param processType If specified, filters to definitions with the given process type. - * @param queryOrder Indicates the order in which definitions should be returned. - * @param repositoryId A repository ID. If specified, filters to definitions that use this repository. - * @param repositoryType If specified, filters to definitions that have a repository of this type. - * @param taskIdFilter If specified, filters to definitions that use the specified task. - * @param yamlFilename If specified, filters to YAML definitions that match the given filename. - * @return build definitions {@link BuildDefinitions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildDefinitions getBuildDefinitions( - String builtAfter, String continuationToken, boolean includeAllProperties, - boolean includeLatestBuilds, String minMetricsTime, String notBuiltAfter, - String path, int processType, DefinitionQueryOrder queryOrder, String repositoryId, - String repositoryType, String taskIdFilter, String yamlFilename) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("builtAfter", builtAfter); - put("continuationToken", continuationToken); - put("includeAllProperties", includeAllProperties); - put("includeLatestBuilds", includeLatestBuilds); - put("minMetricsTime", minMetricsTime); - put("notBuiltAfter", notBuiltAfter); - put("path", path); - put("processType", processType); - put("queryOrder", queryOrder); - put("repositoryId", repositoryId); - put("repositoryType", repositoryType); - put("taskIdFilter", taskIdFilter); - put("yamlFilename", yamlFilename); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", null, null, ApiVersion.BUILD_DEFINITIONS, q, null, null); - - return MAPPER.mapJsonResponse(r, BuildDefinitions.class); - } - - /** - * Restores a deleted definition - * - * @param definitionId pass the build definition id - * @param deleted When false, restores a deleted definition. - * @return a {@link BuildDefinition} object - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildDefinition restoreBuildDefinition(int definitionId, boolean deleted) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("deleted", deleted); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", Integer.toString(definitionId), null, ApiVersion.BUILD_DEFINITIONS, - q, null, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, BuildDefinition.class); - } - - /** - * Updates an existing build definition. - * In order for this operation to succeed, the value of the "Revision" property of the request body must match the - * existing build definition's. It is recommended that you obtain the existing build definition by using GET, modify - * the build definition as necessary, and then submit the modified definition with PUT. - * - * @param definition Build definition object. - * @return BuildDefinition Object {@link BuildDefinition} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public BuildDefinition updateBuildDefinition(BuildDefinition definition) throws AzDException { - String r = send(RequestMethod.PUT, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", Integer.toString(definition.getId()), null, ApiVersion.BUILD_DEFINITIONS, null, - definition, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, BuildDefinition.class); - } - - /** - * Updates an existing build definition. - * In order for this operation to succeed, the value of the "Revision" property of the request body must match the - * existing build definition's. It is recommended that you obtain the existing build definition by using GET, modify - * the build definition as necessary, and then submit the modified definition with PUT. - * - * @param secretsSourceDefinitionId None - * @param secretsSourceDefinitionRevision None - * @param definition Build definition object. - * @return BuildDefinition Object {@link BuildDefinition} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public BuildDefinition updateBuildDefinition(BuildDefinition definition, - Number secretsSourceDefinitionId, - Number secretsSourceDefinitionRevision) throws AzDException { - var q = new HashMap() {{ - put("secretsSourceDefinitionId", secretsSourceDefinitionId); - put("secretsSourceDefinitionRevision", secretsSourceDefinitionRevision); - }}; - - String r = send(RequestMethod.PUT, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", Integer.toString(definition.getId()), null, ApiVersion.BUILD_DEFINITIONS, q, - definition, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, BuildDefinition.class); - } - - /** - * Creates a new folder. - * - * @param path The full path of the folder. - * @param folder Folder object with mandatory details. - * @return Folder Object {@link Folder} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public Folder createFolder(String path, Folder folder) throws AzDException { - var q = new HashMap() {{ - put("path", URLHelper.encodeSpecialWithSpace(path)); - }}; - - String r = send(RequestMethod.PUT, CONNECTION, BUILD, CONNECTION.getProject(), - AREA, null, "folders", ApiVersion.BUILD_FOLDER, q, folder, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, Folder.class); - } - - /** - * Deletes a definition folder. Definitions and their corresponding builds will also be deleted. - * - * @param path The full path to the folder. - * @throws AzDException Default Api Exception handler. - **/ - @Override - public Void deleteFolder(String path) throws AzDException { - try { - var q = new HashMap() {{ - put("path", URLHelper.encodeSpecialWithSpace(path)); - }}; - - String r = send(RequestMethod.DELETE, CONNECTION, BUILD, CONNECTION.getProject(), - AREA, null, "folders", ApiVersion.BUILD_FOLDER, q, null, null); - - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Gets a list of build definition folders. - * - * @return List of folder Object {@link Folders} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public Folders getFolders() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA, null, "folders", ApiVersion.BUILD_FOLDER, null, null, null); - - return MAPPER.mapJsonResponse(r, Folders.class); - } - - /** - * Gets a list of build definition folders. - * - * @return List of folder Object {@link Folders} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public Folders getFolders(String path, FolderQueryOrder queryOrder) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA, null, "folders/" + path, ApiVersion.BUILD_FOLDER, Map.of("queryOrder", queryOrder), null, null); - - return MAPPER.mapJsonResponse(r, Folders.class); - } - - /** - * Updates an existing folder at given existing path - * - * @param path The full path to the folder. - * @return Folder Object {@link Folder} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public Folder updateFolder(String path, Folder folder) throws AzDException { - String finalPath; - - if (!path.isEmpty() && path.equals("+\\")) finalPath = "\\" + path; - else finalPath = path; - - var q = new HashMap() {{ - put("path", URLHelper.encodeSpecialWithSpace(finalPath)); - }}; - - String r = send(RequestMethod.POST, CONNECTION, BUILD, CONNECTION.getProject(), - AREA, null, "folders", ApiVersion.BUILD_FOLDER, q, folder, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, Folder.class); - } - - /** - * Adds a tag to a build. - * - * @param buildId The ID of the build. - * @param tag The tag to add. - * @return Sting array of tags {@link BuildTags} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildTags addBuildTag(int buildId, String tag) throws AzDException { - String r = send(RequestMethod.PUT, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "tags/" + tag, ApiVersion.BUILD_TAGS, - null, null, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, BuildTags.class); - } - - /** - * Adds tags to a build. - * - * @param buildId The ID of the build. - * @param tags The tags to add. - * @return Sting array of tags {@link BuildTags} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildTags addBuildTags(int buildId, List tags) throws AzDException { - String r = send(RequestMethod.POST, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "tags", ApiVersion.BUILD_TAGS, - null, tags, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, BuildTags.class); - } - - /** - * Adds a tag to a definition. - * - * @param definitionId Id of build definition. - * @param tag The tag to add. - * @return Sting array of tags {@link BuildTags} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildTags addDefinitionTag(int definitionId, String tag) throws AzDException { - String r = send(RequestMethod.PUT, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", Integer.toString(definitionId), "tags/" + tag, ApiVersion.BUILD_TAGS, - null, null, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, BuildTags.class); - } - - /** - * Adds multiple tags to a definition. - * - * @param definitionId Id of build definition. - * @param tags The tags to add. - * @return Sting array of tags {@link BuildTags} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildTags addDefinitionTags(int definitionId, List tags) throws AzDException { - String r = send(RequestMethod.POST, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", Integer.toString(definitionId), "tags", ApiVersion.BUILD_TAGS, - null, tags, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, BuildTags.class); - } - - /** - * Removes a tag from a build. - * NOTE: This method will not work for tags with special characters. To remove tags with special characters, use the updateBuildTags method instead. - * - * @param buildId Id of the build. - * @param tag The tag to delete. - * @return Sting array of tags {@link BuildTags} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildTags deleteBuildTag(int buildId, String tag) throws AzDException { - String r = send(RequestMethod.DELETE, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "tags/" + tag, ApiVersion.BUILD_TAGS, - null, null, null); - - return MAPPER.mapJsonResponse(r, BuildTags.class); - } - - /** - * Removes a tag from a definition. - * NOTE: This method will not work for tags with special characters. To remove tags with special characters, use the updateDefinitionTags method instead. - * - * @param definitionId Id of the build definition. - * @param tag The tag to delete - * @return Sting array of tags {@link BuildTags} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildTags deleteDefinitionTag(int definitionId, String tag) throws AzDException { - String r = send(RequestMethod.DELETE, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", Integer.toString(definitionId), "tags/" + tag, ApiVersion.BUILD_TAGS, - null, null, null); - - return MAPPER.mapJsonResponse(r, BuildTags.class); - } - - /** - * Removes a tag from builds, definitions, and from the tag store - * - * @param tag The tag to delete. - * @return Sting array of tags {@link BuildTags} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildTags deleteTag(String tag) throws AzDException { - String r = send(RequestMethod.DELETE, CONNECTION, BUILD, CONNECTION.getProject(), - AREA, null, "tags/" + tag, ApiVersion.BUILD_TAGS, null, null, null); - - return MAPPER.mapJsonResponse(r, BuildTags.class); - } - - /** - * Gets the tags for a build. - * - * @param buildId The ID of the build. - * @return Sting array of tags {@link BuildTags} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildTags getBuildTags(int buildId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "tags", ApiVersion.BUILD_TAGS, null, null, null); - - return MAPPER.mapJsonResponse(r, BuildTags.class); - } - - /** - * Gets the tags for a definition. - * - * @param definitionId Id of build definition. - * @return Sting array of tags - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildTags getDefinitionTags(int definitionId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", Integer.toString(definitionId), "tags", ApiVersion.BUILD_TAGS, - null, null, null); - - return MAPPER.mapJsonResponse(r, BuildTags.class); - } - - /** - * Gets the tags for a definition. - * - * @param definitionId Id of build definition. - * @param revision The definition revision number. If not specified, uses the latest revision of the definition. - * @return Sting array of tags {@link BuildTags} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildTags getDefinitionTags(int definitionId, int revision) throws AzDException { - var q = new HashMap() {{ - put("revision", revision); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", Integer.toString(definitionId), "tags", ApiVersion.BUILD_TAGS, q, null, null); - - return MAPPER.mapJsonResponse(r, BuildTags.class); - } - - /** - * Gets a list of all build tags in the project. - * - * @return Sting array of tags {@link BuildTags} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildTags getTags() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA, null, "tags", ApiVersion.BUILD_TAGS, null, null, null); - - return MAPPER.mapJsonResponse(r, BuildTags.class); - } - - /** - * Adds/Removes tags from a build. - * - * @param buildId The ID of the build. - * @param tags The tags to update. - * @param toRemove If true removes the tags. Use this to remove tags that has special characters. - * @return Sting array of tags {@link BuildTags} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildTags updateBuildTags(int buildId, List tags, boolean toRemove) throws AzDException { - - var tagValue = toRemove ? "tagsToRemove" : "tagsToAdd"; - - var body = new HashMap() {{ - put(tagValue, tags); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "tags", ApiVersion.BUILD_TAGS, - null, body, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, BuildTags.class); - } - - /** - * Adds/Removes tags from a build. - * - * @param definitionId The Id of the build definition. - * @param tags The tags to update. - * @param toRemove If true removes the tags. Use this to remove tags that has special characters. - * @return Sting array of tags {@link BuildTags} - * @throws AzDException Default Api Exception handler. - */ - @Override - public BuildTags updateDefinitionTags(int definitionId, List tags, boolean toRemove) throws AzDException { - var tagValue = toRemove ? "tagsToRemove" : "tagsToAdd"; - - var body = new HashMap() {{ - put(tagValue, tags); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", Integer.toString(definitionId), "tags", ApiVersion.BUILD_TAGS, - null, body, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, BuildTags.class); - } - - /** - * Converts a definition to YAML. - * - * @param definitionId The ID of the definition. - * @return Yaml build object {@link YamlBuild} - * @throws AzDException Default Api Exception handler. - */ - @Override - public YamlBuild getYaml(int definitionId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", Integer.toString(definitionId), "yaml", ApiVersion.BUILD_YAML, - null, null, null); - - return MAPPER.mapJsonResponse(r, YamlBuild.class); - } - - /** - * Converts a definition to YAML, optionally at a specific revision. - * - * @param definitionId The ID of the definition. - * @param includeLatestBuilds if true includes latest builds - * @param minMetricsTime If specified, indicates the date from which metrics should be included. - * @param propertyFilters A comma-delimited list of properties to include in the results. - * @param revision The revision number to retrieve. If this is not specified, the latest version will be returned. - * @return Yaml build object {@link YamlBuild} - * @throws AzDException Default Api Exception handler. - */ - @Override - public YamlBuild getYaml(int definitionId, boolean includeLatestBuilds, String minMetricsTime, - String[] propertyFilters, Number revision) throws AzDException { - var q = new HashMap() {{ - put("includeLatestBuilds", includeLatestBuilds); - put("minMetricsTime", minMetricsTime); - put("propertyFilters", String.join(",", propertyFilters)); - put("revision", revision); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/definitions", Integer.toString(definitionId), "yaml", ApiVersion.BUILD_YAML, - q, null, null); - - return MAPPER.mapJsonResponse(r, YamlBuild.class); - } - - /** - * Update a build stage. - * - * @param buildId Id of the build to update the stage. - * @param stageReferenceName Name of the stage to update. - * @param forceRetryAllJobs if true forcefully retries all jobs. - * @param state state to update. - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void updateBuildStage(int buildId, String stageReferenceName, boolean forceRetryAllJobs, StageUpdateType state) throws AzDException { - try { - var body = new HashMap() {{ - put("forceRetryAllJobs", forceRetryAllJobs); - put("state", state.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", buildId + "/stages/" + stageReferenceName, null, ApiVersion.BUILD_STAGE, - null, body, CustomHeader.JSON_CONTENT_TYPE); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Gets the contents of a file in the given source code repository. - * - * @param providerName The name of the source provider. E.g., Github - * @param serviceEndpointId If specified, the ID of the service endpoint to query. Can only be omitted for providers - * that do not use service endpoints, e.g. TFVC or TFGit. - * @param repositoryName If specified, the vendor-specific identifier or the name of the repository to get branches. - * Can only be omitted for providers that do not support multiple repositories. - * @param branchName The identifier of the commit or branch from which a file's contents are retrieved. - * @param path The path to the file to retrieve, relative to the root of the repository. - * @return Contents of the file given String. {@link String} - * @throws AzDException Default Api Exception handler. - */ - @Override - public String getFileContents(String providerName, String serviceEndpointId, String repositoryName, String branchName, String path) - throws AzDException { - var q = new HashMap() {{ - put("serviceEndpointId", serviceEndpointId); - put("repository", repositoryName); - put("commitOrBranch", branchName); - put("path", path); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - "sourceProviders", null, providerName + "/filecontents", ApiVersion.BUILD_SOURCE_PROVIDERS, - q, null, CustomHeader.TEXT_CONTENT); - - // Look for all the keys as genuine response can also contain any key in the content. - if (!r.isEmpty() && r.contains("innerException") && r.contains("$id") && r.contains("eventId") && r.contains("typeName")) - MAPPER.mapJsonResponse(r, Map.class); - - return r; - } - - /** - * Gets the contents of a directory in the given source code repository. - * - * @param providerName The name of the source provider. E.g., Github - * @param serviceEndpointId If specified, the ID of the service endpoint to query. Can only be omitted for providers - * that do not use service endpoints, e.g. TFVC or TFGit. - * @param repositoryName If specified, the vendor-specific identifier or the name of the repository to get branches. - * Can only be omitted for providers that do not support multiple repositories. - * @param branchName The identifier of the commit or branch from which a file's contents are retrieved. - * @param path The path to the file to retrieve, relative to the root of the repository. - * @return SourceRepositoryItems {@link SourceRepositoryItems} - * @throws AzDException Default Api Exception handler. - */ - @Override - public SourceRepositoryItems getPathContents(String providerName, String serviceEndpointId, String repositoryName, String branchName, String path) - throws AzDException { - var q = new HashMap() {{ - put("serviceEndpointId", serviceEndpointId); - put("repository", repositoryName); - put("commitOrBranch", branchName); - put("path", path); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - "sourceProviders", null, providerName + "/pathcontents", ApiVersion.BUILD_SOURCE_PROVIDERS, - q, null, null); - - return MAPPER.mapJsonResponse(r, SourceRepositoryItems.class); - } - - /** - * Gets a pull request object from source provider. - * - * @param providerName The name of the source provider. - * @param pullRequestId Vendor-specific id of the pull request. - * @param repositoryName Vendor-specific identifier or the name of the repository that contains the pull request. - * @param serviceEndpointId If specified, the ID of the service endpoint to query. - * Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit. - * @return SourceProviderPullRequest {@link SourceProviderPullRequest} - * @throws AzDException Default Api Exception handler. - */ - @Override - public SourceProviderPullRequest getPullRequest(String providerName, String pullRequestId, String repositoryName, String serviceEndpointId) - throws AzDException { - var q = new HashMap() {{ - put("serviceEndpointId", serviceEndpointId); - put("repositoryId", repositoryName); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - "sourceProviders", null, providerName + "/pullrequests/" + pullRequestId, ApiVersion.BUILD_SOURCE_PROVIDERS, - q, null, null); - - return MAPPER.mapJsonResponse(r, SourceProviderPullRequest.class); - } - - /** - * Get a list of source providers and their capabilities. - * - * @return SourceProviderAttributes {@link SourceProviderAttributes} - * @throws AzDException Default Api Exception handler. - */ - @Override - public SourceProviderAttributes getSourceProviders() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - "sourceProviders", null, null, ApiVersion.BUILD_SOURCE_PROVIDERS, - null, null, null); - - return MAPPER.mapJsonResponse(r, SourceProviderAttributes.class); - } - - /** - * Gets a list of branches for the given source code repository. - * - * @param providerName The name of the source provider. - * @param serviceEndpointId If specified, the ID of the service endpoint to query. - * Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit. - * @param repositoryName The vendor-specific identifier or the name of the repository to get branches. - * Can only be omitted for providers that do not support multiple repositories. - * @return SourceProvideBranches {@link SourceProviderBranches} - * @throws AzDException Default Api Exception handler. - */ - @Override - public SourceProviderBranches getBranches(String providerName, String serviceEndpointId, String repositoryName) throws AzDException { - var q = new HashMap() {{ - put("serviceEndpointId", serviceEndpointId); - put("repository", repositoryName); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - "sourceProviders", null, providerName + "/branches", ApiVersion.BUILD_SOURCE_PROVIDERS, - q, null, null); - - return MAPPER.mapJsonResponse(r, SourceProviderBranches.class); - } - - /** - * Gets a list of branches for the given source code repository. - * - * @param providerName The name of the source provider. - * @param serviceEndpointId If specified, the ID of the service endpoint to query. - * Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit. - * @param repositoryName The vendor-specific identifier or the name of the repository to get branches. - * Can only be omitted for providers that do not support multiple repositories. - * @param branchName If supplied, the name of the branch to check for specifically. - * @return SourceProvideBranches {@link SourceProviderBranches} - * @throws AzDException Default Api Exception handler. - */ - @Override - public SourceProviderBranches getBranches(String providerName, String serviceEndpointId, String repositoryName, String branchName) throws AzDException { - var q = new HashMap() {{ - put("serviceEndpointId", serviceEndpointId); - put("repository", repositoryName); - put("branchName", branchName); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - "sourceProviders", null, providerName + "/branches", ApiVersion.BUILD_SOURCE_PROVIDERS, - q, null, null); - - return MAPPER.mapJsonResponse(r, SourceProviderBranches.class); - } - - /** - * Gets a list of source code repositories. - * - * @param providerName The name of the source provider. - * @param serviceEndpointId If specified, the ID of the service endpoint to query. - * Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit. - * @return SourceRepositories {@link SourceRepositories} - * @throws AzDException Default Api Exception handler. - */ - @Override - public SourceRepositories getRepositories(String providerName, String serviceEndpointId) throws AzDException { - var q = new HashMap() {{ - put("serviceEndpointId", serviceEndpointId); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - "sourceProviders", null, providerName + "/repositories", ApiVersion.BUILD_SOURCE_PROVIDERS, - q, null, null); - - return MAPPER.mapJsonResponse(r, SourceRepositories.class); - } - - /** - * Gets a list of source code repositories. - * - * @param providerName The name of the source provider. - * @param serviceEndpointId If specified, the ID of the service endpoint to query. - * Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit. - * @param repositoryName If specified, the vendor-specific identifier or the name of a single repository to get. - * @return SourceRepositories {@link SourceRepositories} - * @throws AzDException Default Api Exception handler. - */ - @Override - public SourceRepositories getRepositories(String providerName, String serviceEndpointId, String repositoryName) throws AzDException { - var q = new HashMap() {{ - put("serviceEndpointId", serviceEndpointId); - put("repository", repositoryName); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - "sourceProviders", null, providerName + "/repositories", ApiVersion.BUILD_SOURCE_PROVIDERS, - q, null, null); - - return MAPPER.mapJsonResponse(r, SourceRepositories.class); - } - - /** - * Gets a list of source code repositories. - * - * @param providerName The name of the source provider. - * @param serviceEndpointId If specified, the ID of the service endpoint to query. - * Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit. - * @param repositoryName If specified, the vendor-specific identifier or the name of a single repository to get. - * @param continuationToken When paging results, this is a continuation token, returned by a previous call to - * this method, that can be used to return the next set of repositories. - * @param pageResults If set to true, this will limit the set of results and will return a continuation token to continue the query. - * @param resultSet 'top' for the repositories most relevant for the endpoint. If not set, all repositories are returned. Ignored if 'repository' is set. - * @return SourceRepositories {@link SourceRepositories} - * @throws AzDException Default Api Exception handler. - */ - @Override - public SourceRepositories getRepositories(String providerName, String serviceEndpointId, String repositoryName, String continuationToken, - boolean pageResults, SourceProviderResultSet resultSet) throws AzDException { - var q = new HashMap() {{ - put("serviceEndpointId", serviceEndpointId); - put("repository", repositoryName); - put("resultSet", resultSet.toString().toLowerCase()); - put("pageResults", pageResults); - put("continuationToken", continuationToken); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - "sourceProviders", null, providerName + "/repositories", ApiVersion.BUILD_SOURCE_PROVIDERS, - q, null, null); - - return MAPPER.mapJsonResponse(r, SourceRepositories.class); - } - - /** - * Gets a list of webhooks installed in the given source code repository. - * - * @param providerName The name of the source provider. - * @param serviceEndpointId If specified, the ID of the service endpoint to query. - * Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit. - * @param repositoryName If specified, the vendor-specific identifier or the name of the repository to get webhooks. - * Can only be omitted for providers that do not support multiple repositories. - * @return RepositoryWebhooks {@link RepositoryWebhooks} - * @throws AzDException Default Api Exception handler. - */ - @Override - public RepositoryWebhooks getWebHooks(String providerName, String serviceEndpointId, String repositoryName) throws AzDException { - var q = new HashMap() {{ - put("serviceEndpointId", serviceEndpointId); - put("repository", repositoryName); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - "sourceProviders", null, providerName + "/webhooks", ApiVersion.BUILD_SOURCE_PROVIDERS, - q, null, null); - - return MAPPER.mapJsonResponse(r, RepositoryWebhooks.class); - } - - /** - * Recreates the webhooks for the specified triggers in the given source code repository. - * - * @param providerName The name of the source provider. - * @param serviceEndpointId If specified, the ID of the service endpoint to query. - * Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit. - * @param repositoryName If specified, the vendor-specific identifier or the name of the repository to get webhooks. - * Can only be omitted for providers that do not support multiple repositories. - * @param triggerTypes The types of triggers to restore webhooks for. - * @return Void; successful operation - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void restoreWebHooks(String providerName, String serviceEndpointId, String repositoryName, List triggerTypes) throws AzDException { - var q = new HashMap() {{ - put("serviceEndpointId", serviceEndpointId); - put("repository", repositoryName); - }}; - - try { - String r = send(RequestMethod.POST, CONNECTION, BUILD, CONNECTION.getProject(), - "sourceProviders", null, providerName + "/webhooks", ApiVersion.BUILD_SOURCE_PROVIDERS, - q, triggerTypes, CustomHeader.JSON_CONTENT_TYPE); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Gets details for a build. - * - * @param buildId Id of the build. use getBuilds() to list all the builds. - * @return a timeline object. {@link Timeline} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Timeline getTimeline(int buildId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "timeline", ApiVersion.BUILD_TIMELINE, - null, null, null); - - return MAPPER.mapJsonResponse(r, Timeline.class); - } - - /** - * Gets details for a build. - * - * @param buildId Id of the build. use getBuilds() to list all the builds. - * @param timelineId Id of the build timeline. - * @return a timeline object. {@link Timeline} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Timeline getTimeline(int buildId, String timelineId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "timeline/" + timelineId, ApiVersion.BUILD_TIMELINE, - null, null, null); - - return MAPPER.mapJsonResponse(r, Timeline.class); - } - - /** - * Gets details for a build. - * - * @param buildId Id of the build. use getBuilds() to list all the builds. - * @param timelineId Id of the build timeline. - * @param changeId Timeline change id. - * @param planId Timeline plan id. This value can be null if unknown. - * @return a timeline object. {@link Timeline} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Timeline getTimeline(int buildId, String timelineId, int changeId, String planId) throws AzDException { - var q = new HashMap() {{ - put("changeId", changeId); - put("planId", planId); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "timeline/" + timelineId, ApiVersion.BUILD_TIMELINE, - q, null, null); - - return MAPPER.mapJsonResponse(r, Timeline.class); - } - - /** - * Associates an artifact with a build. - * - * @param buildId The ID of the build. - * @param artifact Build artifact to associate. - * @return BuildArtifact Object {@link BuildArtifact} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public BuildArtifact createArtifact(int buildId, BuildArtifact artifact) throws AzDException { - String r = send(RequestMethod.POST, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "artifacts", ApiVersion.BUILD_ARTIFACTS, - null, artifact, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, BuildArtifact.class); - } - - /** - * Gets a specific artifact for a build. - * - * @param buildId The ID of the build. - * @param artifactName The name of the artifact. - * @return BuildArtifact Object {@link BuildArtifact} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public BuildArtifact getArtifact(int buildId, String artifactName) throws AzDException { - var q = new HashMap() {{ - put("artifactName", artifactName); - }}; - - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "artifacts", ApiVersion.BUILD_ARTIFACTS, - q, null, null); - - return MAPPER.mapJsonResponse(r, BuildArtifact.class); - } - - /** - * Gets a specific artifact for a build as a zip file. - * - * @param buildId The ID of the build. - * @param artifactName The name of the artifact. - * @return Input stream response of artifact - * @throws AzDException Default Api Exception handler. - **/ - @Override - public InputStream getArtifactAsZip(int buildId, String artifactName) throws AzDException { - var q = new HashMap() {{ - put("artifactName", artifactName); - }}; - - return send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "artifacts", ApiVersion.BUILD_ARTIFACTS, - q, null, CustomHeader.STREAM_ZIP_ACCEPT, false); - } - - /** - * Gets a file from the build. Returns the file contents as InputStream and {@link org.azd.helpers.StreamHelper} - * can be used to download the file. - * - * @param buildId The ID of the build. - * @param artifactName The name of the artifact. - * @return Input stream response of artifact - * @throws AzDException Default Api Exception handler. - **/ - @Override - public InputStream getArtifactFile(int buildId, String artifactName, String fileId, String fileName) throws AzDException { - var q = new HashMap() {{ - put("artifactName", artifactName); - put("fileId", fileId); - put("fileName", fileName); - }}; - - return send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "artifacts", ApiVersion.BUILD_ARTIFACTS, - q, null, CustomHeader.STREAM_ACCEPT, false); - } - - /** - * Gets all artifacts for a build. - * - * @param buildId The ID of the build. - * @return BuildArtifact Object {@link BuildArtifact} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public BuildArtifacts getArtifacts(int buildId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "artifacts", ApiVersion.BUILD_ARTIFACTS, - null, null, null); - - return MAPPER.mapJsonResponse(r, BuildArtifacts.class); - } - - /** - * Gets the list of attachments of a specific type that are associated with a build. - * - * @param buildId The ID of the build. - * @param type The type of attachment. - * @return Attachment Object {@link Attachment} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public Attachments getAttachments(int buildId, String type) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, BUILD, CONNECTION.getProject(), - AREA + "/builds", Integer.toString(buildId), "attachments/" + type, ApiVersion.BUILD_ATTACHMENTS, - null, null, null); - - return MAPPER.mapJsonResponse(r, Attachments.class); - } -} \ No newline at end of file diff --git a/azd/src/main/java/org/azd/common/ApiVersion.java b/azd/src/main/java/org/azd/common/ApiVersion.java index 2f22f980..e02b71b6 100644 --- a/azd/src/main/java/org/azd/common/ApiVersion.java +++ b/azd/src/main/java/org/azd/common/ApiVersion.java @@ -80,6 +80,7 @@ public abstract class ApiVersion { public static final String WIKI_PAGES = "7.2-preview.1"; public static final String WORK = "7.2-preview.1"; public static final String WORK_CAPACITY = "7.2-preview.3"; + public static final String WORK_ITEM_TRACKING_COMMENTS = "7.2-preview.4"; public static final String WORK_ITEM_MIGRATE = "7.2-preview.1"; public static final String WORK_ITEM_TAGS = "7.2-preview.1"; public static final String WORK_ITEM_TRACKING = "7.2-preview.3"; diff --git a/azd/src/main/java/org/azd/common/types/AccessToken.java b/azd/src/main/java/org/azd/common/types/AccessToken.java new file mode 100644 index 00000000..f99532ac --- /dev/null +++ b/azd/src/main/java/org/azd/common/types/AccessToken.java @@ -0,0 +1,64 @@ +package org.azd.common.types; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonProperty; +import org.azd.abstractions.serializer.SerializableEntity; + +/** + * Represents the access token result object + */ +@JsonIgnoreProperties(ignoreUnknown = true) +public class AccessToken extends SerializableEntity { + /** + * Type of token + */ + @JsonProperty("token_type") + public String TokenType; + /** + * Token expiration + */ + @JsonProperty("expires_in") + public int ExpiresIn; + /** + * Token extended expiration + */ + @JsonProperty("ext_expires_in") + public int ExtExpiresIn; + /** + * Access token + */ + @JsonProperty("access_token") + public String Token; + + public String getTokenType() { + return TokenType; + } + + public void setTokenType(String tokenType) { + TokenType = tokenType; + } + + public int getExpiresIn() { + return ExpiresIn; + } + + public void setExpiresIn(int expiresIn) { + ExpiresIn = expiresIn; + } + + public int getExtExpiresIn() { + return ExtExpiresIn; + } + + public void setExtExpiresIn(int extExpiresIn) { + ExtExpiresIn = extExpiresIn; + } + + public String getToken() { + return Token; + } + + public void setToken(String token) { + Token = token; + } +} diff --git a/azd/src/main/java/org/azd/configurations/ClientConfigurationRequestBuilder.java b/azd/src/main/java/org/azd/configurations/ClientConfigurationRequestBuilder.java index 3b0f6d08..91ad28c3 100644 --- a/azd/src/main/java/org/azd/configurations/ClientConfigurationRequestBuilder.java +++ b/azd/src/main/java/org/azd/configurations/ClientConfigurationRequestBuilder.java @@ -1,6 +1,5 @@ package org.azd.configurations; -import org.azd.abstractions.ClientConfiguration; import org.azd.abstractions.proxy.ProxyConfiguration; import org.azd.abstractions.proxy.ProxyProvider; @@ -28,15 +27,4 @@ public void proxy(ProxyConfiguration proxyConfiguration) { Objects.requireNonNull(proxyConfiguration, "Proxy configuration cannot be null."); ProxyProvider.configure(proxyConfiguration); } - - /** - * Sets the maximum retries for retrying the request if "Retry-After" header is found in the response headers. - * Default retries is set to 3 and maximum value can be set to 6. - * - * @param maxRetry Maximum retry value. - */ - public void setMaxRetry(int maxRetry) { - var retryHandler = ClientConfiguration.getInstance().getRetryHandler(); - retryHandler.setDefaultMaxRetry(maxRetry); - } } diff --git a/azd/src/main/java/org/azd/connection/Connection.java b/azd/src/main/java/org/azd/connection/Connection.java deleted file mode 100644 index fd65b829..00000000 --- a/azd/src/main/java/org/azd/connection/Connection.java +++ /dev/null @@ -1,205 +0,0 @@ -package org.azd.connection; - -import org.azd.exceptions.AzDException; -import org.azd.helpers.URLHelper; -import org.azd.oauth.OAuthApi; -import org.azd.oauth.types.AuthorizedToken; - -/** - * The factory class which sets the default parameters to use this library. - *

- * To call the Azure DevOps services REST API organization name and personal access token are - * mandatory. Setting these parameters as default helps to work with this library on ease. - *

- */ -@Deprecated(since = "v6.0; This is deprecated; Please use AzDClientApi which uses Personal access token and OAuth2.0 authentication.") -public class Connection { - private static final TokenRefreshedHandler defaultTokenRefreshedHandler = newToken -> { - }; - private String organization; - private String project; - private String personalAccessToken; - private String appSecret; - private String appCallBackURL; - private AuthorizedToken oauthToken = null; - private TokenRefreshedHandler tokenRefreshedHandler = defaultTokenRefreshedHandler; - - /** - * default with no parameters - */ - public Connection() { - } - - /** - * Instantiates the class with organization name, project name and personal access token - * - * @param organization pass the organization name - * @param project provide the project name - * @param personalAccessToken pass the personal access token - */ - private Connection(String organization, String project, String personalAccessToken, AuthorizedToken oauthToken, String appSecret, String appCallBackURL, TokenRefreshedHandler tokenRefreshedHandler) { - this.organization = organization; - this.project = URLHelper.encodeSpace(project); - this.personalAccessToken = personalAccessToken; - this.oauthToken = oauthToken; - this.appSecret = appSecret; - this.appCallBackURL = appCallBackURL; - this.tokenRefreshedHandler = tokenRefreshedHandler != null ? tokenRefreshedHandler : defaultTokenRefreshedHandler; - } - - /** - * Instantiates the class with organization name and personal access token. - * Use this method if you don't want to specify the devops project - * - * @param organization pass the organization name - * @param personalAccessToken pass the personal access token - */ - public Connection(String organization, String personalAccessToken) { - this(organization, null, personalAccessToken, null, null, null, null); - } - - /** - * Instantiates the class with organization name, project name and personal access token. - * Use this method if you want to specify the devops project - * - * @param organization pass the organization name - * @param project provide the project name - * @param personalAccessToken pass the personal access token - */ - public Connection(String organization, String project, String personalAccessToken) { - this(organization, project, personalAccessToken, null, null, null, null); - } - - /** - * Instantiates the class with organization name and oauth access token. - * Use this method if you don't want to specify the devops project and you don't want to be notified on oauth token refreshing - * - * @param organization pass the organization name - * @param oauthToken pass the oauth access token - * @param appSecret pass the app/client secret. It is used to refresh the oauth access token - * @param appCallBackURL pass the app/client callBackURL (declared in the app). It is used to refresh the oauth access token - */ - public Connection(String organization, AuthorizedToken oauthToken, String appSecret, String appCallBackURL) { - this(organization, null, null, oauthToken, appSecret, appCallBackURL, null); - } - - /** - * Instantiates the class with organization name, project name and oauth access token. - * Use this method if you want to specify the devops project and you want to be notified on oauth token refreshing - * - * @param organization pass the organization name - * @param project provide the project name - * @param oauthToken pass the oauth access token - * @param appSecret pass the app/client secret. It is used to refresh the oauth access token - * @param appCallBackURL pass the app/client callBackURL (declared in the app). It is used to refresh the oauth access token - * @param tokenRefreshedHandler pass the handler to be called on oauth token refresh - */ - public Connection(String organization, String project, AuthorizedToken oauthToken, String appSecret, String appCallBackURL, TokenRefreshedHandler tokenRefreshedHandler) { - this(organization, project, null, oauthToken, appSecret, appCallBackURL, tokenRefreshedHandler); - } - - /** - * Instantiates the class with organization name and oauth access token. - * Use this method if you don't want to specify the devops project but you want to be notified on oauth token refreshing - * - * @param organization pass the organization name - * @param oauthToken pass the oauth access token - * @param appSecret pass the app/client secret. It is used to refresh the oauth access token - * @param appCallBackURL pass the app/client callBackURL (declared in the app). It is used to refresh the oauth access token - * @param tokenRefreshedHandler pass the handler to be called on oauth token refresh - */ - public Connection(String organization, AuthorizedToken oauthToken, String appSecret, String appCallBackURL, TokenRefreshedHandler tokenRefreshedHandler) { - this(organization, null, null, oauthToken, appSecret, appCallBackURL, tokenRefreshedHandler); - } - - /** - * Instantiates the class with organization name, project name and oauth access token. - * Use this method if you want to specify the devops project and you don't want to be notified on oauth token refreshing - * - * @param organization pass the organization name - * @param project provide the project name - * @param oauthToken pass the oauth access token - * @param appSecret pass the app/client secret. It is used to refresh the oauth access token - * @param appCallBackURL pass the app/client callBackURL (declared in the app). It is used to refresh the oauth access token - */ - public Connection(String organization, String project, AuthorizedToken oauthToken, String appSecret, String appCallBackURL) { - this(organization, project, null, oauthToken, appSecret, appCallBackURL, null); - } - - /** - * Get the default organization name - * - * @return organization name - */ - public String getOrganization() { - return this.organization; - } - - /** - * Set the organization name to default - * - * @param organization pass the organization name - */ - public void setOrganization(String organization) { - this.organization = organization; - } - - /** - * Get the default Project name - * - * @return project name - */ - public String getProject() { - return this.project; - } - - /** - * Set the project name to default - * - * @param project pass the project name - */ - public void setProject(String project) { - this.project = URLHelper.encodeSpace(project); - } - - /** - * Get the personal access token - * - * @return the personal access token - * @throws AzDException Default Api Exception handler. - */ - public String getPersonalAccessToken() throws AzDException { - if (oauthToken != null) { - if (OAuthApi.hasTokenExpired(oauthToken)) { - setOauthToken(OAuthApi.getRefreshToken(appSecret, oauthToken.getRefreshToken(), appCallBackURL)); - } - return oauthToken.getAccessToken(); - } - return this.personalAccessToken; - } - - /** - * Set the personal access token - * - * @param personalAccessToken pass the personal access token - */ - public void setPersonalAccessToken(String personalAccessToken) { - this.oauthToken = null; - this.personalAccessToken = personalAccessToken; - } - - /** - * Set the oauth access token - * - * @param oauthToken pass the oauth access token - */ - public void setOauthToken(AuthorizedToken oauthToken) { - this.oauthToken = oauthToken; - tokenRefreshedHandler.tokenRefreshed(oauthToken); - } - - public interface TokenRefreshedHandler { - void tokenRefreshed(AuthorizedToken newToken); - } - -} diff --git a/azd/src/main/java/org/azd/core/CoreApi.java b/azd/src/main/java/org/azd/core/CoreApi.java deleted file mode 100644 index 3a007543..00000000 --- a/azd/src/main/java/org/azd/core/CoreApi.java +++ /dev/null @@ -1,446 +0,0 @@ -package org.azd.core; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.core.types.*; -import org.azd.enums.CustomHeader; -import org.azd.enums.FeatureManagement; -import org.azd.enums.ProjectState; -import org.azd.enums.RequestMethod; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.CoreDetails; -import org.azd.utils.AzDAsyncApi; - -import java.util.HashMap; -import java.util.LinkedHashMap; -import java.util.Map; -import java.util.Optional; - -import static org.azd.utils.RestClient.send; - -/** - * Core class to manage core API - */ -public class CoreApi extends AzDAsyncApi implements CoreDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String CORE = "79134c72-4a58-4b42-976c-04e7115f32bf"; - private final String AREA = "projects"; - - /** - * Pass the connection object to work with Core Api - * - * @param connection Connection object - */ - public CoreApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Get a list of processes. - * - * @return a list of processes {@link Processes} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Processes getProcesses() throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, CORE, null, - "process/processes", null, null, ApiVersion.CORE, null, null, null); - - return MAPPER.mapJsonResponse(r, Processes.class); - } - - /** - * Creates a default scrum project - * - * @param projectName pass the project name - * @param description pass the description for the project - * @return object with link to the project - * @throws AzDException Default Api Exception handler. - */ - @Override - public OperationReference createProject(String projectName, String description) throws AzDException { - - LinkedHashMap h = new LinkedHashMap<>() {{ - put("name", projectName); - put("description", description); - put("capabilities", new LinkedHashMap() {{ - put("versioncontrol", new LinkedHashMap() {{ - put("sourceControlType", "Git"); - }}); - put("processTemplate", new LinkedHashMap() {{ - put("templateTypeId", "6b724908-ef14-45cf-84f8-768b5384da45"); - }}); - }}); - }}; - - String r = send(RequestMethod.POST, CONNECTION, CORE, null, - AREA, null, null, ApiVersion.PROJECT, null, h, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, OperationReference.class); - } - - /** - * Creates a project for given process id - * - * @param projectName pass the project name - * @param description project description - * @param sourceControlType type of version control - * @param templateTypeId pass the process id. Run getProcesses to get the list of process id - * @return object with link to the project - * @throws AzDException Default Api Exception handler. - */ - @Override - public OperationReference createProject(String projectName, String description, String sourceControlType, - String templateTypeId) throws AzDException { - - LinkedHashMap h = new LinkedHashMap<>() {{ - put("name", projectName); - put("description", description); - put("capabilities", new LinkedHashMap() {{ - put("versioncontrol", new LinkedHashMap() {{ - put("sourceControlType", sourceControlType); - }}); - put("processTemplate", new LinkedHashMap() {{ - put("templateTypeId", templateTypeId); - }}); - }}); - }}; - - String r = send(RequestMethod.POST, CONNECTION, CORE, null, - AREA, null, null, ApiVersion.PROJECT, null, h, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, OperationReference.class); - } - - /** - * Queues a project to be deleted. - *

- * You should pass the project id to delete it. Passing the project name - * won't delete. To get the project id run getProject() with projectName - * and get the Id. - *

- * - * @param projectId pass the project id - * @return object of deleted project with url - * @throws AzDException Default Api Exception handler. - */ - @Override - public OperationReference deleteProject(String projectId) throws AzDException { - - String r = send(RequestMethod.DELETE, CONNECTION, CORE, null, - AREA, projectId, null, ApiVersion.PROJECT, null, null, null); - - return MAPPER.mapJsonResponse(r, OperationReference.class); - } - - /** - * Get project with the specified id or name - * - * @param projectName pass the project name or id - * @return project object {@link Project} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Project getProject(String projectName) throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, CORE, null, - AREA, projectName, null, ApiVersion.PROJECT, null, null, null); - - return MAPPER.mapJsonResponse(r, Project.class); - } - - /** - * Get project with the specified id or name with optional parameters - * - * @param projectName pass the project name or id - * @param includeCapabilities Include capabilities (such as source control) in the team project result (default: false). - * @param includeHistory Search within renamed projects (that had such name in the past). - * @return project object {@link Project} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Project getProject(String projectName, boolean includeCapabilities, boolean includeHistory) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("includeCapabilities", includeCapabilities); - put("includeHistory", includeHistory); - }}; - - String r = send(RequestMethod.GET, CONNECTION, CORE, null, - AREA, projectName, null, ApiVersion.PROJECT, q, null, null); - - return MAPPER.mapJsonResponse(r, Project.class); - } - - /** - * Get a collection of team project properties. - * - * @param projectId provide the project guid not the project name - * @return ProjectProperties {@link ProjectProperties} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ProjectProperties getProjectProperties(String projectId) throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, CORE, null, - AREA, projectId, "properties", ApiVersion.PROJECT_PROPERTIES, null, null, null); - - return MAPPER.mapJsonResponse(r, ProjectProperties.class); - } - - /** - * Get all projects in the organization that the authenticated user has access to. - * - * @return array of projects {@link Projects} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Projects getProjects() throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, CORE, null, - AREA, null, null, ApiVersion.PROJECT, null, null, null); - - return MAPPER.mapJsonResponse(r, Projects.class); - } - - /** - * Get all projects in the organization that the authenticated user has access to. - * - * @param skip specify how many projects to skip - * @param top specify the number projects to retrieve - * @param continuationToken specify the next value to retrieve - * @param getDefaultTeamImageUrl if true gets the default team image url - * @param stateFilter allowed values are [all, createPending, deleted, deleting, new, unchanged, wellFormed] - * @return array of projects {@link Projects} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Projects getProjects(Integer skip, Integer top, Number continuationToken, - Boolean getDefaultTeamImageUrl, ProjectState stateFilter) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("$skip", skip); - put("$top", top); - put("continuationToken", continuationToken); - put("getDefaultTeamImageUrl", getDefaultTeamImageUrl); - put("stateFilter", stateFilter); - }}; - - String r = send(RequestMethod.GET, CONNECTION, CORE, null, - AREA, null, null, ApiVersion.PROJECT, q, null, null); - - return MAPPER.mapJsonResponse(r, Projects.class); - } - - /** - * Update an existing project's name, abbreviation, description, or restore a project. - * - * @param projectId pass the project id - * @param projectParameters HashMap of project parameters to be updated. - *

Refer "https://docs.microsoft.com/en-us/rest/api/azure/devops/core/projects/update?view=azure-devops-rest-6.1"

- * @return an object or team project with url - * @throws AzDException Default Api Exception handler. - */ - @Override - public OperationReference updateProject(String projectId, Project projectParameters) throws AzDException { - - String r = send(RequestMethod.PATCH, CONNECTION, CORE, null, - AREA, projectId, null, ApiVersion.PROJECT, null, projectParameters, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, OperationReference.class); - } - - /** - * Create a team in a team project. - * - * @param projectName project name or GUID - * @param teamName pass the team name - * @return returns web api object - * @throws AzDException Default Api Exception handler. - */ - @Override - public WebApiTeam createTeam(String projectName, String teamName) throws AzDException { - - HashMap h = new HashMap<>() {{ - put("name", teamName); - }}; - - String r = send(RequestMethod.POST, CONNECTION, CORE, null, - AREA, projectName, "teams", ApiVersion.PROJECT_TEAMS, null, h, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, WebApiTeam.class); - } - - /** - * Delete a team. - * - * @param projectName pass the project name or id - * @param teamName pass the team name - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteTeam(String projectName, String teamName) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, CORE, null, - AREA, projectName, "teams/" + teamName, ApiVersion.PROJECT_TEAMS, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Get a specific team. - * - * @param projectName pass the project name or id - * @param teamName pass the team name - * @return team object - * @throws AzDException Default Api Exception handler. - */ - @Override - public WebApiTeam getTeam(String projectName, String teamName) throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, CORE, null, - AREA, projectName, "teams/" + teamName, ApiVersion.PROJECT_TEAMS, null, null, null); - - return MAPPER.mapJsonResponse(r, WebApiTeam.class); - } - - /** - * Get a specific team. - * - * @param projectName pass the project name or id - * @param teamName pass the team name - * @param expandIdentity if true gets the identity object - * @return team object - * @throws AzDException Default Api Exception handler. - */ - @Override - public WebApiTeam getTeam(String projectName, String teamName, boolean expandIdentity) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("$expandIdentity", expandIdentity); - }}; - - String r = send(RequestMethod.GET, CONNECTION, CORE, null, - AREA, projectName, "teams/" + teamName, ApiVersion.PROJECT_TEAMS, q, null, null); - - return MAPPER.mapJsonResponse(r, WebApiTeam.class); - } - - /** - * Get a list of all teams. - * - * @return array of team - * @throws AzDException Default Api Exception handler. - */ - @Override - public WebApiTeams getTeams() throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, CORE, null, - "teams", null, null, ApiVersion.PROJECT_TEAMS, null, null, null); - return MAPPER.mapJsonResponse(r, WebApiTeams.class); - } - - /** - * Get a list of all teams. - * - * @param expandIdentity if true gets the identity object - * @param mine if true gets the team to which user has access to - * @param skip pass to skip number of teams - * @param top pass to retrieve number of teams - * @return array of team - * @throws AzDException Default Api Exception handler. - */ - @Override - public WebApiTeams getTeams(boolean expandIdentity, boolean mine, int skip, int top) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("$expandIdentity", expandIdentity); - put("$mine", mine); - put("$skip", skip); - put("$top", top); - }}; - - String r = send(RequestMethod.GET, CONNECTION, CORE, null, - "teams", null, null, ApiVersion.PROJECT_TEAMS, q, null, null); - - return MAPPER.mapJsonResponse(r, WebApiTeams.class); - } - - /** - * Update a team's name and/or description. - * - * @param projectName The name or ID (GUID) of the team project containing the team to update. - * @param teamName The name or ID of the team to update. - * @param description provide the description for your team to update - * @return team object {@link WebApiTeam} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WebApiTeam updateTeams(String projectName, String teamName, String description) throws AzDException { - - HashMap h = new HashMap<>() {{ - put("name", teamName); - put("description", description); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, CORE, null, - AREA, projectName, "teams/" + teamName, ApiVersion.PROJECT_TEAMS, null, h, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, WebApiTeam.class); - } - - /** - * Call un-published API feature to fetch project service feature state. - * See {@link FeatureManagement} for current list of features. - * Besides an 'enabled' and 'disabled' state, there is also an undefined state, hence the Optional return wrapper - * - * @param projectId project identifier - * @param feature FeatureManagement enum type for which to return state - * @return Optional wrapped boolean, empty if state is undefined - * @throws AzDException Default Api Exception handler - */ - @Override - public Optional getFeatureState(String projectId, FeatureManagement feature) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, null, null, - "FeatureManagement/FeatureStates/host/project", projectId, feature.getFeatureId(), ApiVersion.FEATURE_MANAGEMENT, - null, null, null); - - return MAPPER.mapJsonResponse(r, ProjectFeature.class).getStateAsBoolean(); - } - - /** - * Set project feature state for project service - * See {@link FeatureManagement} for list of features - * - * @param projectId project identifier - * @param feature enum value for feature to enable or disable - * @param state enable or disable feature - * @return object containing feature id and state - * @throws AzDException Default Api Exception handler - */ - @Override - public ProjectFeature featureToggle(String projectId, FeatureManagement feature, boolean state) throws AzDException { - LinkedHashMap b = new LinkedHashMap<>() {{ - put("featureId", feature.getFeatureId()); - put("scope", new LinkedHashMap<>() {{ - put("settingScope", "project"); - put("userScoped", false); - }}); - put("state", state ? 1 : 0); - }}; - String r = send(RequestMethod.PATCH, CONNECTION, null, null, - "FeatureManagement/FeatureStates/host/project", projectId, feature.getFeatureId(), ApiVersion.FEATURE_MANAGEMENT, - null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, ProjectFeature.class); - } -} \ No newline at end of file diff --git a/azd/src/main/java/org/azd/core/projects/ProjectsRequestBuilder.java b/azd/src/main/java/org/azd/core/projects/ProjectsRequestBuilder.java index dd381e81..339c518a 100644 --- a/azd/src/main/java/org/azd/core/projects/ProjectsRequestBuilder.java +++ b/azd/src/main/java/org/azd/core/projects/ProjectsRequestBuilder.java @@ -127,6 +127,9 @@ public CompletableFuture getAsync(String projectId, Consumer getAsync() throws AzDException { + if(accessTokenCredential.getProjectName() == null || accessTokenCredential.getProjectName().isEmpty()) { + throw new AzDException("Project name is null or empty."); + } return builder() .serviceEndpoint("projectId", accessTokenCredential.getProjectName()) .build() @@ -261,6 +264,10 @@ public Project get(String projectId, Consumer requestConfi * @throws AzDException Default Api Exception handler. */ public Project get() throws AzDException { + if(accessTokenCredential.getProjectName() == null || accessTokenCredential.getProjectName().isEmpty()) { + throw new AzDException("Project name is null or empty."); + } + return builder() .serviceEndpoint("projectId", accessTokenCredential.getProjectName()) .build() diff --git a/azd/src/main/java/org/azd/distributedtask/DistributedTaskApi.java b/azd/src/main/java/org/azd/distributedtask/DistributedTaskApi.java deleted file mode 100644 index 3ac6aece..00000000 --- a/azd/src/main/java/org/azd/distributedtask/DistributedTaskApi.java +++ /dev/null @@ -1,846 +0,0 @@ -package org.azd.distributedtask; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.core.CoreApi; -import org.azd.distributedtask.types.*; -import org.azd.enums.*; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.DistributedTaskDetails; -import org.azd.release.types.ProjectReference; -import org.azd.utils.AzDAsyncApi; - -import java.util.*; - -import static org.azd.utils.RestClient.send; - -/** - * DistributedTaskApi class to manage Agents, Deployment groups, Environments and Variable groups API - */ -public class DistributedTaskApi extends AzDAsyncApi implements DistributedTaskDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "distributedtask"; - private final String DISTRIBUTEDTASK = "a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd"; - - /** - * Pass the connection object - * - * @param connection Connection object - */ - public DistributedTaskApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Delete an agent. - * - * @param poolId The pool ID to remove the agent from - * @param agentId The agent ID to remove - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteAgent(int poolId, int agentId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, DISTRIBUTEDTASK, null, - AREA + "/pools", poolId + "/agents/" + agentId, null, ApiVersion.DISTRIBUTED_TASK, - null, null, null); - - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Get information about an agent. - * - * @param poolId The agent pool containing the agent - * @param agentId The agent ID to get information about - * @return A TaskAgent object {@link TaskAgent} - * @throws AzDException Default Api Exception handler. - */ - @Override - public TaskAgent getAgent(int poolId, int agentId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, null, - AREA + "/pools", poolId + "/agents/" + agentId, null, ApiVersion.DISTRIBUTED_TASK, - null, null, null); - - return MAPPER.mapJsonResponse(r, TaskAgent.class); - } - - /** - * Get information about an agent. - * - * @param poolId The agent pool containing the agent - * @param agentId The agent ID to get information about - * @param includeAssignedRequest Whether to include details about the agent's current work - * @param includeCapabilities Whether to include the agent's capabilities in the response - * @param includeLastCompletedRequest Whether to include details about the agents' most recent completed work - * @param propertyFilters Filter which custom properties will be returned - * @return A TaskAgent object {@link TaskAgent} - * @throws AzDException Default Api Exception handler. - */ - @Override - public TaskAgent getAgent(int poolId, int agentId, boolean includeAssignedRequest, boolean includeCapabilities, - boolean includeLastCompletedRequest, String[] propertyFilters) throws AzDException { - var q = new HashMap() {{ - put("includeAssignedRequest", includeAssignedRequest); - put("includeCapabilities", includeCapabilities); - put("includeLastCompletedRequest", includeLastCompletedRequest); - put("propertyFilters", String.join(",", propertyFilters)); - }}; - - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, null, - AREA + "/pools", poolId + "/agents/" + agentId, null, ApiVersion.DISTRIBUTED_TASK, q, null, null); - - return MAPPER.mapJsonResponse(r, TaskAgent.class); - } - - /** - * Get a list of agents. - * - * @param poolId The agent pool containing the agents - * @return TaskAgents object {@link TaskAgents} - * @throws AzDException Default Api Exception handler. - */ - @Override - public TaskAgents getAgents(int poolId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, null, - AREA + "/pools", poolId + "/agents", null, ApiVersion.DISTRIBUTED_TASK, null, null, null); - - return MAPPER.mapJsonResponse(r, TaskAgents.class); - } - - /** - * Get a list of agents. - * - * @param poolId The agent pool containing the agents - * @param agentName Filter on agent name - * @param demands Filter by demands the agents can satisfy - * @param includeAssignedRequest Whether to include details about the agents' current work - * @param includeCapabilities Whether to include the agents' capabilities in the response - * @param includeLastCompletedRequest Whether to include details about the agents' most recent completed work - * @param propertyFilters Filter which custom properties will be returned - * @return TaskAgents object {@link TaskAgents} - * @throws AzDException Default Api Exception handler. - */ - @Override - public TaskAgents getAgents(int poolId, String agentName, String[] demands, boolean includeAssignedRequest, - boolean includeCapabilities, boolean includeLastCompletedRequest, String[] propertyFilters) - throws AzDException { - var q = new HashMap() {{ - put("agentName", agentName); - put("demands", String.join(",", demands)); - put("includeAssignedRequest", includeAssignedRequest); - put("includeCapabilities", includeCapabilities); - put("includeLastCompletedRequest", includeLastCompletedRequest); - put("propertyFilters", String.join(",", propertyFilters)); - }}; - - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, null, - AREA + "/pools", poolId + "/agents", null, ApiVersion.DISTRIBUTED_TASK, q, null, null); - - return MAPPER.mapJsonResponse(r, TaskAgents.class); - } - - /** - * Update agent details. - * - * @param poolId The agent pool to use - * @param agentId The agent to update - * @param requestBody Map of request body. - *

- * Visit https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/agents/update?view=azure-devops-rest-7.1#request-body for more details. - *

- * @return A TaskAgent object {@link TaskAgent} - * @throws AzDException Default Api Exception handler. - */ - @Override - public TaskAgent updateAgent(int poolId, int agentId, TaskAgent requestBody) throws AzDException { - String r = send(RequestMethod.PATCH, CONNECTION, DISTRIBUTEDTASK, null, - AREA + "/pools", poolId + "/agents/" + agentId, null, ApiVersion.DISTRIBUTED_TASK, - null, requestBody, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, TaskAgent.class); - } - - /** - * Create a deployment group. - * - * @param name Name of the deployment group. - * @param description Description of the deployment group. - * @return Deployment group object {@link DeploymentGroup} - * @throws AzDException Default Api Exception handler. - */ - @Override - public DeploymentGroup addDeploymentGroup(String name, String description) throws AzDException { - var requestBody = new HashMap() {{ - put("name", name); - put("description", description); - }}; - - String r = send(RequestMethod.POST, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/deploymentgroups", null, null, ApiVersion.DISTRIBUTED_TASK, - null, requestBody, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, DeploymentGroup.class); - } - - /** - * Create a deployment group. - * - * @param name Name of the deployment group. - * @param description Description of the deployment group. - * @param poolId Identifier of the deployment pool in which deployment agents are registered. - * @return Deployment group object {@link DeploymentGroup} - * @throws AzDException Default Api Exception handler. - */ - @Override - public DeploymentGroup addDeploymentGroup(String name, String description, int poolId) throws AzDException { - var requestBody = new HashMap() {{ - put("name", name); - put("description", description); - put("poolId", poolId); - }}; - - String r = send(RequestMethod.POST, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/deploymentgroups", null, null, ApiVersion.DISTRIBUTED_TASK, - null, requestBody, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, DeploymentGroup.class); - } - - /** - * Delete a deployment group. - * - * @param deploymentGroupId ID of the deployment group to be deleted. - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteDeploymentGroup(int deploymentGroupId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/deploymentgroups", Integer.toString(deploymentGroupId), null, ApiVersion.DISTRIBUTED_TASK, null, null, null); - - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Get a deployment group by its ID. - * - * @param deploymentGroupId ID of the deployment group to be deleted. - * @return Deployment group object {@link DeploymentGroup} - * @throws AzDException Default Api Exception handler. - */ - @Override - public DeploymentGroup getDeploymentGroup(int deploymentGroupId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/deploymentgroups", Integer.toString(deploymentGroupId), null, ApiVersion.DISTRIBUTED_TASK, null, null, null); - - return MAPPER.mapJsonResponse(r, DeploymentGroup.class); - } - - /** - * Get a deployment group by its ID. - * - * @param deploymentGroupId ID of the deployment group to be deleted. - * @param expand Include these additional details in the returned object. - * @param actionFilter Get the deployment group only if this action can be performed on it. - * @return Deployment group object {@link DeploymentGroup} - * @throws AzDException Default Api Exception handler. - */ - @Override - public DeploymentGroup getDeploymentGroup(int deploymentGroupId, DeploymentGroupExpands expand, DeploymentGroupActionFilter actionFilter) - throws AzDException { - var q = new HashMap() {{ - put("$expand", expand.toString().toLowerCase()); - put("actionFilter", actionFilter.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/deploymentgroups", Integer.toString(deploymentGroupId), null, ApiVersion.DISTRIBUTED_TASK, q, null, null); - - return MAPPER.mapJsonResponse(r, DeploymentGroup.class); - } - - /** - * Get a list of deployment groups by name or IDs. - * - * @return Deployment groups object {@link DeploymentGroups} - * @throws AzDException Default Api Exception handler. - */ - @Override - public DeploymentGroups getDeploymentGroups() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/deploymentgroups", null, null, ApiVersion.DISTRIBUTED_TASK, null, null, null); - - return MAPPER.mapJsonResponse(r, DeploymentGroups.class); - } - - /** - * Get a list of deployment groups by name or IDs. - * - * @param top Maximum number of deployment groups to return. Default is 1000. - * @return Deployment groups object {@link DeploymentGroups} - * @throws AzDException Default Api Exception handler. - */ - @Override - public DeploymentGroups getDeploymentGroups(int top) throws AzDException { - var q = new HashMap() {{ - put("$top", top); - }}; - - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/deploymentgroups", null, null, ApiVersion.DISTRIBUTED_TASK, q, null, null); - - return MAPPER.mapJsonResponse(r, DeploymentGroups.class); - } - - /** - * Get a list of deployment groups by name or IDs. - * - * @param ids Array of Id of deployment groups. - * @return Deployment groups object {@link DeploymentGroups} - * @throws AzDException Default Api Exception handler. - */ - @Override - public DeploymentGroups getDeploymentGroups(int[] ids) throws AzDException { - var q = new HashMap() {{ - put("ids", intArrayToString(ids)); - }}; - - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/deploymentgroups", null, null, ApiVersion.DISTRIBUTED_TASK, q, null, null); - - return MAPPER.mapJsonResponse(r, DeploymentGroups.class); - } - - /** - * Get a list of deployment groups by name or IDs. - * - * @param name Name of the deployment group. - * @return Deployment groups object {@link DeploymentGroups} - * @throws AzDException Default Api Exception handler. - */ - @Override - public DeploymentGroups getDeploymentGroups(String name) throws AzDException { - var q = new HashMap() {{ - put("name", name); - }}; - - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/deploymentgroups", null, null, ApiVersion.DISTRIBUTED_TASK, q, null, null); - - return MAPPER.mapJsonResponse(r, DeploymentGroups.class); - } - - /** - * Get a list of deployment groups by name or IDs. - * - * @param expand Include these additional details in the returned objects. {@link DeploymentGroupExpands} - * @return Deployment groups object {@link DeploymentGroups} - * @throws AzDException Default Api Exception handler. - */ - @Override - public DeploymentGroups getDeploymentGroups(DeploymentGroupExpands expand) throws AzDException { - var q = new HashMap() {{ - put("$expand", expand.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/deploymentgroups", null, null, ApiVersion.DISTRIBUTED_TASK, q, null, null); - - return MAPPER.mapJsonResponse(r, DeploymentGroups.class); - } - - /** - * Get a list of deployment groups by name or IDs. - * - * @param expand Include these additional details in the returned objects. {@link DeploymentGroupExpands} - * @param top Maximum number of deployment groups to return. Default is 1000. - * @param actionFilter Get only deployment groups on which this action can be performed. {@link DeploymentGroupActionFilter} - * @param continuationToken Get deployment groups with names greater than this continuationToken lexicographically. - * @param ids Comma separated list of IDs of the deployment groups. - * @param name Name of the deployment group. - * @return Deployment groups object {@link DeploymentGroups} - * @throws AzDException Default Api Exception handler. - */ - @Override - public DeploymentGroups getDeploymentGroups(DeploymentGroupExpands expand, int top, DeploymentGroupActionFilter actionFilter, - String continuationToken, int[] ids, String name) throws AzDException { - var q = new HashMap() {{ - put("$expand", expand.toString().toLowerCase()); - put("$top", top); - put("actionFilter", actionFilter.toString().toLowerCase()); - put("continuationToken", continuationToken); - put("ids", intArrayToString(ids)); - put("name", name); - }}; - - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/deploymentgroups", null, null, ApiVersion.DISTRIBUTED_TASK, q, null, null); - - return MAPPER.mapJsonResponse(r, DeploymentGroups.class); - } - - /** - * Update a deployment group. - * - * @param deploymentGroupId ID of the deployment group. - * @param name Name of the deployment group. - * @param description Description of the deployment group. - * @return Deployment group object {@link DeploymentGroup} - * @throws AzDException Default Api Exception handler. - */ - @Override - public DeploymentGroup updateDeploymentGroup(int deploymentGroupId, String name, String description) throws AzDException { - var requestBody = new HashMap() {{ - put("name", name); - put("description", description); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/deploymentgroups", Integer.toString(deploymentGroupId), null, ApiVersion.DISTRIBUTED_TASK, - null, requestBody, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, DeploymentGroup.class); - } - - /** - * Create an environment. - * - * @param name Name of the environment. - * @param description Description of the environment. - * @return Environment instance {@link EnvironmentInstance} - * @throws AzDException Default Api Exception handler. - */ - @Override - public EnvironmentInstance addEnvironment(String name, String description) throws AzDException { - var requestBody = new HashMap() {{ - put("name", name); - put("description", description); - }}; - - String r = send(RequestMethod.POST, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/environments", null, null, ApiVersion.DISTRIBUTED_TASK, null, requestBody, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, EnvironmentInstance.class); - } - - /** - * Delete the specified environment. - * - * @param environmentId ID of the environment. - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteEnvironment(int environmentId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/environments", Integer.toString(environmentId), null, ApiVersion.DISTRIBUTED_TASK, null, null, null); - - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Get an environment by its ID. - * - * @param environmentId ID of the environment. - * @return Environment instance {@link EnvironmentInstance} - * @throws AzDException Default Api Exception handler. - */ - @Override - public EnvironmentInstance getEnvironment(int environmentId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/environments", Integer.toString(environmentId), null, ApiVersion.DISTRIBUTED_TASK, - null, null, null); - - return MAPPER.mapJsonResponse(r, EnvironmentInstance.class); - } - - /** - * Get an environment by its ID. - * - * @param environmentId ID of the environment. - * @param expands Include these additional details in the returned objects. {@link EnvironmentExpands} - * @return Environment instance {@link EnvironmentInstance} - * @throws AzDException Default Api Exception handler. - */ - @Override - public EnvironmentInstance getEnvironment(int environmentId, EnvironmentExpands expands) throws AzDException { - var q = new HashMap() {{ - put("expands", expands.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/environments", Integer.toString(environmentId), null, ApiVersion.DISTRIBUTED_TASK, q, null, null); - - return MAPPER.mapJsonResponse(r, EnvironmentInstance.class); - } - - /** - * Get all environments. - * - * @return Environment instances array {@link EnvironmentInstances} - * @throws AzDException Default Api Exception handler. - */ - @Override - public EnvironmentInstances getEnvironments() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/environments", null, null, ApiVersion.DISTRIBUTED_TASK, null, null, null); - - return MAPPER.mapJsonResponse(r, EnvironmentInstances.class); - } - - /** - * Get all environments. - * - * @param top Top environments to list - * @return Environment instances array {@link EnvironmentInstances} - * @throws AzDException Default Api Exception handler. - */ - @Override - public EnvironmentInstances getEnvironments(int top) throws AzDException { - var q = new HashMap() {{ - put("$top", top); - }}; - - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/environments", null, null, ApiVersion.DISTRIBUTED_TASK, q, null, null); - - return MAPPER.mapJsonResponse(r, EnvironmentInstances.class); - } - - /** - * Get all environments. - * - * @param name Name of the environment. - * @return Environment instances array {@link EnvironmentInstances} - * @throws AzDException Default Api Exception handler. - */ - @Override - public EnvironmentInstances getEnvironments(String name) throws AzDException { - var q = new HashMap() {{ - put("name", name); - }}; - - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/environments", null, null, ApiVersion.DISTRIBUTED_TASK, q, null, null); - - return MAPPER.mapJsonResponse(r, EnvironmentInstances.class); - } - - /** - * Get all environments. - * - * @param top Top environments to list. - * @param continuationToken Get the list of environments paginated. - * @param name Name of the environment. - * @return Environment instances array {@link EnvironmentInstances} - * @throws AzDException Default Api Exception handler. - */ - @Override - public EnvironmentInstances getEnvironments(int top, String continuationToken, String name) throws AzDException { - var q = new HashMap() {{ - put("$top", top); - put("continuationToken", continuationToken); - put("name", name); - }}; - - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/environments", null, null, ApiVersion.DISTRIBUTED_TASK, q, null, null); - - return MAPPER.mapJsonResponse(r, EnvironmentInstances.class); - } - - /** - * Update the specified environment. - * - * @param environmentId ID of the environment. - * @param name Name of the environment. - * @param description Description of the environment. - * @return Environment instance {@link EnvironmentInstance} - * @throws AzDException Default Api Exception handler. - */ - @Override - public EnvironmentInstance updateEnvironment(int environmentId, String name, String description) throws AzDException { - var requestBody = new HashMap() {{ - put("name", name); - put("description", description); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/environments", Integer.toString(environmentId), null, ApiVersion.DISTRIBUTED_TASK, - null, requestBody, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, EnvironmentInstance.class); - } - - /** - * Add a variable group. - * - * @param variableGroupDefinition Variable group definition {@link VariableGroupDefinition} - * @return Variable group {@link VariableGroup} - * @throws AzDException Default Api Exception handler. - */ - @Override - public VariableGroup addVariableGroup(VariableGroupDefinition variableGroupDefinition) - throws AzDException { - var ref = new VariableGroupProjectReference(); - ref.setName(variableGroupDefinition.getName()); - ref.setDescription(variableGroupDefinition.getDescription()); - ref.setProjectReference(variableGroupDefinition.getProjectReference()); - - List o = new ArrayList<>(); - o.add(ref); - - var requestBody = new HashMap() {{ - put("variableGroupProjectReferences", o); - put("name", variableGroupDefinition.getName()); - put("description", variableGroupDefinition.getDescription()); - put("type", variableGroupDefinition.getType()); - put("variables", variableGroupDefinition.getVariables()); - put("providerData", variableGroupDefinition.getProviderData()); - }}; - - String r = send(RequestMethod.POST, CONNECTION, DISTRIBUTEDTASK, null, - AREA + "/variablegroups", null, null, ApiVersion.VARIABLE_GROUPS, null, requestBody, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, VariableGroup.class); - } - - /** - * Add a variable group. - * - * @param name Name of the variable group. - * @param description Description for the variable group. - * @param variables Map of variables to add. - * @return Variable group {@link VariableGroup} - * @throws AzDException Default Api Exception handler. - */ - @Override - public VariableGroup addVariableGroup(String name, String description, VariableGroupMap variables) throws AzDException { - var definition = new VariableGroupDefinition(); - var projectReference = new ProjectReference(); - var core = new CoreApi(CONNECTION); - var project = core.getProject(CONNECTION.getProject()); - - projectReference.setName(project.getName()); - projectReference.setId(project.getId()); - - definition.setName(name); - definition.setDescription(description); - definition.setVariables(variables.get()); - definition.setProjectReference(projectReference); - definition.setType(VariableGroupType.Vsts); - - return addVariableGroup(definition); - } - - /** - * Delete a variable group - * - * @param variableGroupId Id of the variable group. - * @param projectIds String array of project ids. - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteVariableGroup(int variableGroupId, String[] projectIds) throws AzDException { - try { - var q = new HashMap() {{ - put("projectIds", String.join(",", projectIds)); - }}; - - String r = send(RequestMethod.DELETE, CONNECTION, DISTRIBUTEDTASK, null, - AREA + "/variablegroups", Integer.toString(variableGroupId), null, ApiVersion.VARIABLE_GROUPS, q, null, null); - - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Get a variable group. - * - * @param variableGroupId Id of the variable group. - * @return Variable group {@link VariableGroup} - * @throws AzDException Default Api Exception handler. - */ - @Override - public VariableGroup getVariableGroup(int variableGroupId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/variablegroups", Integer.toString(variableGroupId), null, ApiVersion.VARIABLE_GROUPS, null, null, null); - - return MAPPER.mapJsonResponse(r, VariableGroup.class); - } - - /** - * Get variable groups. - * - * @return Variable groups object {@link VariableGroups} - * @throws AzDException Default Api Exception handler. - */ - @Override - public VariableGroups getVariableGroups() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/variablegroups", null, null, ApiVersion.VARIABLE_GROUPS, null, null, null); - - return MAPPER.mapJsonResponse(r, VariableGroups.class); - } - - /** - * Get variable groups. - * - * @param top Number of variable groups to get. - * @return Variable groups object {@link VariableGroups} - * @throws AzDException Default Api Exception handler. - */ - @Override - public VariableGroups getVariableGroups(int top) throws AzDException { - var q = new HashMap() {{ - put("$top", top); - }}; - - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/variablegroups", null, null, ApiVersion.VARIABLE_GROUPS, q, null, null); - - return MAPPER.mapJsonResponse(r, VariableGroups.class); - } - - /** - * Get variable groups. - * - * @param groupName Name of variable group. - * @return Variable groups object {@link VariableGroups} - * @throws AzDException Default Api Exception handler. - */ - @Override - public VariableGroups getVariableGroups(String groupName) throws AzDException { - var q = new HashMap() {{ - put("groupName", groupName); - }}; - - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/variablegroups", null, null, ApiVersion.VARIABLE_GROUPS, q, null, null); - - return MAPPER.mapJsonResponse(r, VariableGroups.class); - } - - /** - * Get variable groups. - * - * @param top Number of variable groups to get. - * @param actionFilter Action filter for the variable group. It specifies the action which can be performed on the variable groups. {@link VariableGroupActionFilter} - * @param continuationToken Gets the variable groups after the continuation token provided. - * @param groupName Name of variable group. - * @param queryOrder Gets the results in the defined order. Default is 'IdDescending'. {@link VariableGroupQueryOrder} - * @return Variable groups object {@link VariableGroups} - * @throws AzDException Default Api Exception handler. - */ - @Override - public VariableGroups getVariableGroups(int top, VariableGroupActionFilter actionFilter, int continuationToken, String groupName, - VariableGroupQueryOrder queryOrder) throws AzDException { - var q = new HashMap() {{ - put("$top", top); - put("actionFilter", actionFilter.toString().toLowerCase()); - put("continuationToken", continuationToken); - put("groupName", groupName); - put("queryOrder", queryOrder.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, DISTRIBUTEDTASK, CONNECTION.getProject(), - AREA + "/variablegroups", null, null, ApiVersion.VARIABLE_GROUPS, q, null, null); - - return MAPPER.mapJsonResponse(r, VariableGroups.class); - } - - /** - * Update a variable group. - * - * @param groupId Id of the variable group to update. - * @param name Sets name of the variable group. - * @param description Sets description of the variable group. - * @param variables Sets variables contained in the variable group. - * @return Variable group {@link VariableGroup} - * @throws AzDException Default Api Exception handler. - */ - @Override - public VariableGroup updateVariableGroup(int groupId, String name, String description, VariableGroupMap variables) throws AzDException { - var definition = new VariableGroupDefinition(); - var projectReference = new ProjectReference(); - var core = new CoreApi(CONNECTION); - var project = core.getProject(CONNECTION.getProject()); - - projectReference.setName(project.getName()); - projectReference.setId(project.getId()); - - definition.setName(name); - definition.setDescription(description); - definition.setVariables(variables.get()); - definition.setProjectReference(projectReference); - definition.setType(VariableGroupType.Vsts); - - return updateVariableGroup(groupId, definition); - } - - /** - * Update a variable group. - * - * @param groupId Id of the variable group to update. - * @param variableGroupDefinition Variable group definition {@link VariableGroupDefinition} - * @return Variable group {@link VariableGroup} - * @throws AzDException Default Api Exception handler. - */ - @Override - public VariableGroup updateVariableGroup(int groupId, VariableGroupDefinition variableGroupDefinition) throws AzDException { - var ref = new VariableGroupProjectReference(); - ref.setName(variableGroupDefinition.getName()); - ref.setDescription(variableGroupDefinition.getDescription()); - ref.setProjectReference(variableGroupDefinition.getProjectReference()); - - List o = new ArrayList<>(); - o.add(ref); - - var requestBody = new HashMap() {{ - put("variableGroupProjectReferences", o); - put("name", variableGroupDefinition.getName()); - put("description", variableGroupDefinition.getDescription()); - put("type", variableGroupDefinition.getType()); - put("variables", variableGroupDefinition.getVariables()); - put("providerData", variableGroupDefinition.getProviderData()); - }}; - - String r = send(RequestMethod.PUT, CONNECTION, DISTRIBUTEDTASK, null, - AREA + "/variablegroups", Integer.toString(groupId), null, ApiVersion.VARIABLE_GROUPS, - null, requestBody, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, VariableGroup.class); - } - - /** - * Helper method to convert integer array to string. - * - * @param i integer array - * @return {@link String} - */ - private String intArrayToString(int[] i) { - var r = Arrays.stream(i).mapToObj(String::valueOf).toArray(String[]::new); - return String.join(",", r); - } -} \ No newline at end of file diff --git a/azd/src/main/java/org/azd/distributedtask/types/VariableGroupLibrary.java b/azd/src/main/java/org/azd/distributedtask/types/VariableGroupLibrary.java index 0d8c5bd4..0422a34f 100644 --- a/azd/src/main/java/org/azd/distributedtask/types/VariableGroupLibrary.java +++ b/azd/src/main/java/org/azd/distributedtask/types/VariableGroupLibrary.java @@ -3,8 +3,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import org.azd.abstractions.serializer.SerializableEntity; -import org.azd.enums.VariableValue; -import org.azd.release.types.ConfigurationVariableValue; import java.util.List; import java.util.Map; diff --git a/azd/src/main/java/org/azd/enums/ApiExceptionTypes.java b/azd/src/main/java/org/azd/enums/ApiExceptionTypes.java index accb674b..0080fca9 100644 --- a/azd/src/main/java/org/azd/enums/ApiExceptionTypes.java +++ b/azd/src/main/java/org/azd/enums/ApiExceptionTypes.java @@ -28,5 +28,13 @@ public enum ApiExceptionTypes { /** * This type will be thrown if the given argument is invalid. */ - InvalidArgumentException + InvalidArgumentException, + /** + * This type will be thrown if the given token doesn't have access to requested resource. + */ + UnAuthorizedException, + /** + * This type is for unhandled responses. + */ + UnknownError, } diff --git a/azd/src/main/java/org/azd/enums/AssignmentSource.java b/azd/src/main/java/org/azd/enums/AssignmentSource.java index 4e17b797..aca6165e 100644 --- a/azd/src/main/java/org/azd/enums/AssignmentSource.java +++ b/azd/src/main/java/org/azd/enums/AssignmentSource.java @@ -7,7 +7,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import org.azd.abstractions.serializer.SerializableEntity; /** * Assignment Source of the License (e.g. Group, Unknown etc. diff --git a/azd/src/main/java/org/azd/enums/CommentExpandOptions.java b/azd/src/main/java/org/azd/enums/CommentExpandOptions.java new file mode 100644 index 00000000..e2c018ad --- /dev/null +++ b/azd/src/main/java/org/azd/enums/CommentExpandOptions.java @@ -0,0 +1,22 @@ +package org.azd.enums; + +/** + * Specifies the additional data retrieval options for work item comments. + */ +public enum CommentExpandOptions { + none, + /** + * Include comment reactions. + */ + reactions, + /** + * Include the rendered text (html) in addition to MD text. + */ + renderedText, + /** + * If specified, then ONLY rendered text (html) will be returned, w/o markdown. + * Supposed to be used internally from data provides for optimization purposes. + */ + renderedTextOnly, + all +} diff --git a/azd/src/main/java/org/azd/enums/CommentFormat.java b/azd/src/main/java/org/azd/enums/CommentFormat.java new file mode 100644 index 00000000..14f84ec9 --- /dev/null +++ b/azd/src/main/java/org/azd/enums/CommentFormat.java @@ -0,0 +1,16 @@ +package org.azd.enums; + +/* +---------------------------------------------------------- + GENERATED FILE, should be edited to suit the purpose. +---------------------------------------------------------- +*/ + + +/** + * Represents the possible types for the comment format. +**/ +public enum CommentFormat { + markdown, + html +} diff --git a/azd/src/main/java/org/azd/enums/CommentReactionType.java b/azd/src/main/java/org/azd/enums/CommentReactionType.java new file mode 100644 index 00000000..b92c01a3 --- /dev/null +++ b/azd/src/main/java/org/azd/enums/CommentReactionType.java @@ -0,0 +1,20 @@ +package org.azd.enums; + +/* +---------------------------------------------------------- + GENERATED FILE, should be edited to suit the purpose. +---------------------------------------------------------- +*/ + + +/** + * Type of the reaction. +**/ +public enum CommentReactionType { + like, + dislike, + heart, + hooray, + smile, + confused +} diff --git a/azd/src/main/java/org/azd/enums/CommentSortOrder.java b/azd/src/main/java/org/azd/enums/CommentSortOrder.java new file mode 100644 index 00000000..71c375c6 --- /dev/null +++ b/azd/src/main/java/org/azd/enums/CommentSortOrder.java @@ -0,0 +1,16 @@ +package org.azd.enums; + +/** + * Order in which the comments should be returned. + */ +public enum CommentSortOrder { + /** + * + * The results will be sorted in Ascending order. + */ + asc, + /** + * The results will be sorted in Descending order. + */ + desc +} diff --git a/azd/src/main/java/org/azd/enums/ConfigurationType.java b/azd/src/main/java/org/azd/enums/ConfigurationType.java index 15410963..0f5d1b12 100644 --- a/azd/src/main/java/org/azd/enums/ConfigurationType.java +++ b/azd/src/main/java/org/azd/enums/ConfigurationType.java @@ -7,7 +7,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import org.azd.abstractions.serializer.SerializableEntity; /** * Type of configuration. diff --git a/azd/src/main/java/org/azd/enums/CustomHeader.java b/azd/src/main/java/org/azd/enums/CustomHeader.java index c9867c45..9571e5cb 100644 --- a/azd/src/main/java/org/azd/enums/CustomHeader.java +++ b/azd/src/main/java/org/azd/enums/CustomHeader.java @@ -29,6 +29,11 @@ public enum CustomHeader { * "Accept", "text/plain" */ TEXT_CONTENT(CustomHeader.JSON.name, "text/plain"), + /** + * To accept the plain text response + * "Accept", "text/plain" + */ + HTML_CONTENT(CustomHeader.JSON_CONTENT_TYPE.name, "text/html"), /** * Json content type applicable for most of the post request. * "Content-Type", "application/json" diff --git a/azd/src/main/java/org/azd/enums/GroupLicensingRuleStatus.java b/azd/src/main/java/org/azd/enums/GroupLicensingRuleStatus.java index 6bf169c7..1bc0fdac 100644 --- a/azd/src/main/java/org/azd/enums/GroupLicensingRuleStatus.java +++ b/azd/src/main/java/org/azd/enums/GroupLicensingRuleStatus.java @@ -7,7 +7,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import org.azd.abstractions.serializer.SerializableEntity; /** * Licensing Source (e.g. Account. MSDN etc.) diff --git a/azd/src/main/java/org/azd/enums/HttpStatusCode.java b/azd/src/main/java/org/azd/enums/HttpStatusCode.java index a66fe78b..9a5bb5c4 100644 --- a/azd/src/main/java/org/azd/enums/HttpStatusCode.java +++ b/azd/src/main/java/org/azd/enums/HttpStatusCode.java @@ -78,13 +78,13 @@ public String getMessage() { return message; } - public static HttpStatusCode getByCode(int code) { + public static HttpStatusCode from(int code) { for (HttpStatusCode status : values()) { if (status.getCode() == code) { return status; } } - return null; + return HttpStatusCode.INTERNAL_SERVER_ERROR; } } diff --git a/azd/src/main/java/org/azd/enums/InputFilterOperator.java b/azd/src/main/java/org/azd/enums/InputFilterOperator.java index 8390ac45..09083844 100644 --- a/azd/src/main/java/org/azd/enums/InputFilterOperator.java +++ b/azd/src/main/java/org/azd/enums/InputFilterOperator.java @@ -7,7 +7,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import org.azd.abstractions.serializer.SerializableEntity; /** * The class to represent a collection of REST reference links. diff --git a/azd/src/main/java/org/azd/enums/ProjectPermissionInherited.java b/azd/src/main/java/org/azd/enums/ProjectPermissionInherited.java index b4411c50..aa9010ae 100644 --- a/azd/src/main/java/org/azd/enums/ProjectPermissionInherited.java +++ b/azd/src/main/java/org/azd/enums/ProjectPermissionInherited.java @@ -7,7 +7,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import org.azd.abstractions.serializer.SerializableEntity; /** * RuleOption [ApplyGroupRule/TestApplyGroupRule] - specifies if the rules defined in group entitlement should be diff --git a/azd/src/main/java/org/azd/enums/RuleOption.java b/azd/src/main/java/org/azd/enums/RuleOption.java index 49eff77b..eb53e697 100644 --- a/azd/src/main/java/org/azd/enums/RuleOption.java +++ b/azd/src/main/java/org/azd/enums/RuleOption.java @@ -7,7 +7,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import org.azd.abstractions.serializer.SerializableEntity; /** * RuleOption [ApplyGroupRule/TestApplyGroupRule] - specifies if the rules defined in group entitlement should be diff --git a/azd/src/main/java/org/azd/enums/TreeNodeStructureType.java b/azd/src/main/java/org/azd/enums/TreeNodeStructureType.java index 3687a58f..7727e5cd 100644 --- a/azd/src/main/java/org/azd/enums/TreeNodeStructureType.java +++ b/azd/src/main/java/org/azd/enums/TreeNodeStructureType.java @@ -7,7 +7,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import org.azd.abstractions.serializer.SerializableEntity; /** * Node structure type. diff --git a/azd/src/main/java/org/azd/enums/TreeStructureGroup.java b/azd/src/main/java/org/azd/enums/TreeStructureGroup.java index 57a52147..514a6653 100644 --- a/azd/src/main/java/org/azd/enums/TreeStructureGroup.java +++ b/azd/src/main/java/org/azd/enums/TreeStructureGroup.java @@ -7,7 +7,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import org.azd.abstractions.serializer.SerializableEntity; /** * Structure group of the classification node, area or iteration. diff --git a/azd/src/main/java/org/azd/enums/VersionControlChangeType.java b/azd/src/main/java/org/azd/enums/VersionControlChangeType.java index f148f93f..d3059f3b 100644 --- a/azd/src/main/java/org/azd/enums/VersionControlChangeType.java +++ b/azd/src/main/java/org/azd/enums/VersionControlChangeType.java @@ -5,9 +5,9 @@ * ---------------------------------------------------------- **/ +import com.fasterxml.jackson.annotation.JsonFormat; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonFormat; /** * None diff --git a/azd/src/main/java/org/azd/extensionmanagement/ExtensionManagementApi.java b/azd/src/main/java/org/azd/extensionmanagement/ExtensionManagementApi.java deleted file mode 100644 index e60a122e..00000000 --- a/azd/src/main/java/org/azd/extensionmanagement/ExtensionManagementApi.java +++ /dev/null @@ -1,201 +0,0 @@ -package org.azd.extensionmanagement; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.enums.CustomHeader; -import org.azd.enums.ExtensionStateFlags; -import org.azd.enums.RequestMethod; -import org.azd.exceptions.AzDException; -import org.azd.extensionmanagement.types.InstalledExtension; -import org.azd.extensionmanagement.types.InstalledExtensions; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.ExtensionManagementDetails; -import org.azd.utils.AzDAsyncApi; - -import java.util.HashMap; -import java.util.Map; - -import static org.azd.utils.RestClient.send; - -/** - * ExtensionManagementApi class to manage installed extensions API - */ -public class ExtensionManagementApi extends AzDAsyncApi implements ExtensionManagementDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "extensionmanagement"; - private final String EXTENSIONMANAGEMENT = "6c2b0933-3600-42ae-bf8b-93d4f7e83594"; - - /** - * Pass the connection object to work with Member Entitlement Management Api - * - * @param connection Connection object - */ - public ExtensionManagementApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Get an installed extension by its publisher and extension id. - * - * @param extensionId Id of the extension. Example: "sonarqube". - * @param publisherId Id of the publisher. Example: "sonarsource". - * @return InstalledExtension {@link InstalledExtension} - * @throws AzDException Default Api Exception handler. - */ - @Override - public InstalledExtension getExtension(String extensionId, String publisherId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, EXTENSIONMANAGEMENT, null, - AREA + "/installedextensions", extensionId + "/" + publisherId, null, - ApiVersion.EXTENSION_MANAGEMENT, null, null, null); - - return MAPPER.mapJsonResponse(r, InstalledExtension.class); - } - - /** - * Get an installed extension by its publisher and extension id. - * - * @param extensionId Id of the extension. Example: "sonarqube". - * @param publisherId Id of the publisher. Example: "sonarsource". - * @param assetTypes type of asset - * @return InstalledExtension {@link InstalledExtension} - * @throws AzDException Default Api Exception handler. - */ - @Override - public InstalledExtension getExtension(String extensionId, String publisherId, String[] assetTypes) - throws AzDException { - var q = new HashMap() {{ - put("assetTypes", String.join(",", assetTypes)); - }}; - String r = send(RequestMethod.GET, CONNECTION, EXTENSIONMANAGEMENT, null, - AREA + "/installedextensions", extensionId + "/" + publisherId, null, - ApiVersion.EXTENSION_MANAGEMENT, q, null, null); - - return MAPPER.mapJsonResponse(r, InstalledExtension.class); - } - - /** - * List the installed extensions - * - * @return InstalledExtensions {@link InstalledExtensions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public InstalledExtensions getExtensions() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, EXTENSIONMANAGEMENT, null, - AREA + "/installedextensions", null, null, ApiVersion.EXTENSION_MANAGEMENT, - null, null, null); - - return MAPPER.mapJsonResponse(r, InstalledExtensions.class); - } - - /** - * Install the specified extension - * - * @param extensionId Id of the extension. Example: "sonarqube". - * @param publisherId Id of the publisher. Example: "sonarsource". - * @param version if null latest version will be selected - * @return InstalledExtension {@link InstalledExtension} - * @throws AzDException Default Api Exception handler. - */ - @Override - public InstalledExtension installExtension(String publisherId, String extensionId, String version) - throws AzDException { - String id = publisherId + "/" + extensionId; - - if (version != null) { - id += "/" + version; - } - - String r = send(RequestMethod.POST, CONNECTION, EXTENSIONMANAGEMENT, null, - AREA + "/installedextensionsbyname", id, null, ApiVersion.EXTENSION_MANAGEMENT, - null, null, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, InstalledExtension.class); - } - - /** - * Uninstall the specified extension - * - * @param extensionId Id of the extension. Example: "sonarqube". - * @param publisherId Id of the publisher. Example: "sonarsource". - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void uninstallExtension(String publisherId, String extensionId) throws AzDException { - try { - String id = publisherId + "/" + extensionId; - - String r = send(RequestMethod.DELETE, CONNECTION, EXTENSIONMANAGEMENT, null, - AREA + "/installedextensionsbyname", id, null, ApiVersion.EXTENSION_MANAGEMENT, - null, null, null); - - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Uninstall the specified extension - * - * @param extensionId Id of the extension. Example: "sonarqube". - * @param publisherId Id of the publisher. Example: "sonarsource". - * @param reason reason for uninstall - * @param reasonCode reason code for uninstall - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void uninstallExtension(String publisherId, String extensionId, String reason, String reasonCode) - throws AzDException { - try { - String id = publisherId + "/" + extensionId; - var q = new HashMap() {{ - put("reason", reason); - put("reasonCode", reasonCode); - }}; - - String r = send(RequestMethod.DELETE, CONNECTION, EXTENSIONMANAGEMENT, null, - AREA + "/installedextensionsbyname", id, null, ApiVersion.EXTENSION_MANAGEMENT, - q, null, null); - - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Enable/disable an extension - * - * @param extensionId Id of the extension. Example: "sonarqube". - * @param publisherId Id of the publisher. Example: "sonarsource". - * @param extensionState If none extension will be enabled. {@link ExtensionStateFlags} - * @return InstalledExtension {@link InstalledExtension} - * @throws AzDException Default Api Exception handler. - */ - @Override - public InstalledExtension updateExtension(String publisherId, String extensionId, ExtensionStateFlags extensionState) - throws AzDException { - var body = new HashMap() {{ - put("publisherId", publisherId); - put("extensionId", extensionId); - put("installState", new HashMap() {{ - put("flags", extensionState.toString().toLowerCase()); - }}); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, EXTENSIONMANAGEMENT, null, - AREA + "/installedextensions", null, null, ApiVersion.EXTENSION_MANAGEMENT, - null, body, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, InstalledExtension.class); - } -} \ No newline at end of file diff --git a/azd/src/main/java/org/azd/feedmanagement/FeedManagementApi.java b/azd/src/main/java/org/azd/feedmanagement/FeedManagementApi.java deleted file mode 100644 index a258948d..00000000 --- a/azd/src/main/java/org/azd/feedmanagement/FeedManagementApi.java +++ /dev/null @@ -1,407 +0,0 @@ -package org.azd.feedmanagement; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.enums.*; -import org.azd.exceptions.AzDException; -import org.azd.feedmanagement.types.*; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.FeedManagementDetails; -import org.azd.utils.AzDAsyncApi; - -import java.util.HashMap; -import java.util.Map; - -import static org.azd.utils.RestClient.send; - -/** - * Feed Management class to manage Artifacts API - */ -public class FeedManagementApi extends AzDAsyncApi implements FeedManagementDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "packaging"; - private final String PACKAGING = "7ab4e64e-c4d8-4f50-ae73-5ef2e21642a5"; - - /** - * Pass the connection object to work with Feed Management Api - * - * @param connection Connection object - */ - public FeedManagementApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Create a feed, a container for various package types. - *

- * Feeds can be created in a project if the project parameter is included when instantiating the class. - * This can be done by injecting the instance of AzDDefaultParameters with project name. - * If the project parameter is omitted, the feed will not be associated with a project - * and will be created at the organization level. - *

- * - * @param name Provide the name of the feed - * @param description Provide the description for the feed - * @param badgesEnabled Enable or disable the badge in the feed. Default to false. - * @param hideDeletedPackageVersions Hides the deleted package version. Default to true. - * @return Feed object {@link Feed} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Feed createFeed( - String name, String description, boolean badgesEnabled, - boolean hideDeletedPackageVersions) throws AzDException { - - HashMap requestBody = new HashMap<>() {{ - put("name", name); - put("description", description); - put("badgesEnabled", badgesEnabled); - put("hideDeletedPackageVersions", hideDeletedPackageVersions); - }}; - - String r = send(RequestMethod.POST, CONNECTION, PACKAGING, - CONNECTION.getProject() != null ? CONNECTION.getProject() : null, - AREA, null, "feeds", ApiVersion.FEEDS, null, requestBody, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, Feed.class); - } - - /** - * Create a new view on the referenced feed. - *

- * The project parameter must be supplied if the feed was created in a project. - *

- * - * @param feedName provide the name or id of the feed - * @param name name of the feed view - * @param feedViewType type of the feed view. Allowed values are [implicit and release] - * @param visibility visibility of the view. Allowed values are [aadTenant, collection, organization, private] - * @return Feed view object {@link FeedView} - * @throws AzDException Default Api Exception handler. - */ - @Override - public FeedView createFeedView(String feedName, String name, - FeedViewType feedViewType, FeedVisibility visibility) throws AzDException { - - HashMap requestBody = new HashMap<>() {{ - put("name", name); - put("type", feedViewType.toString().toLowerCase()); - put("visibility", visibility.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.POST, CONNECTION, PACKAGING, - CONNECTION.getProject() != null ? CONNECTION.getProject() : null, - AREA + "/feeds", feedName, "views", ApiVersion.FEEDS, null, requestBody, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, FeedView.class); - } - - /** - * Remove a feed and all its packages. The feed moves to the recycle bin and is reversible. - *

- * The project parameter must be supplied if the feed was created in a project. - * If the feed is not associated with any project, omit the project parameter from the request. - *

- * - * @param feedId Name or Id of the feed. - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteFeed(String feedId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, PACKAGING, - CONNECTION.getProject() != null ? CONNECTION.getProject() : null, - AREA + "/feeds", feedId, null, ApiVersion.FEEDS, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Delete a feed view. - *

- * The project parameter must be supplied if the feed was created in a project. - *

- * - * @param feedId Name or Id of the feed - * @param feedViewId Id of the feed view - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteFeedView(String feedId, String feedViewId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, PACKAGING, - CONNECTION.getProject() != null ? CONNECTION.getProject() : null, - AREA + "/feeds", feedId, "views/" + feedViewId, ApiVersion.FEEDS, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Get the settings for a specific feed. - *

- * The project parameter must be supplied if the feed was created in a project. - * If the feed is not associated with any project, omit the project parameter from the request. - *

- * - * @param feedName Name of id of the feed - * @return Feed {@link Feed} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Feed getFeed(String feedName) throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, PACKAGING, - CONNECTION.getProject() != null ? CONNECTION.getProject() : null, - AREA + "/Feeds", feedName, null, ApiVersion.FEEDS, null, null, null); - - return MAPPER.mapJsonResponse(r, Feed.class); - } - - /** - * Get the settings for a specific feed. - *

- * The project parameter must be supplied if the feed was created in a project. - * If the feed is not associated with any project, omit the project parameter from the request. - *

- * - * @param feedName Name of id of the feed - * @param includeDeletedUpstreams Include upstreams that have been deleted in the response. - * @return Feed {@link Feed} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Feed getFeed(String feedName, boolean includeDeletedUpstreams) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("includeDeletedUpstreams", includeDeletedUpstreams); - }}; - - String r = send(RequestMethod.GET, CONNECTION, PACKAGING, - CONNECTION.getProject() != null ? CONNECTION.getProject() : null, - AREA + "/Feeds", feedName, null, ApiVersion.FEEDS, q, null, null); - - return MAPPER.mapJsonResponse(r, Feed.class); - } - - /** - * Get the permissions for a feed. - *

- * The project parameter must be supplied if the feed was created in a project. - * If the feed is not associated with any project, omit the project parameter from the request. - *

- * - * @param feedName Name or Id of the feed. - * @return Feed Permissions {@link FeedPermissions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public FeedPermissions getFeedPermissions(String feedName) throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, PACKAGING, - CONNECTION.getProject() != null ? CONNECTION.getProject() : null, - AREA + "/Feeds", feedName, "permissions", ApiVersion.FEEDS, null, null, null); - - return MAPPER.mapJsonResponse(r, FeedPermissions.class); - } - - /** - * Get the permissions for a feed. - *

- * The project parameter must be supplied if the feed was created in a project. - * If the feed is not associated with any project, omit the project parameter from the request. - *

- * - * @param feedName Name or Id of the feed. - * @param excludeInheritedPermissions True to only return explicitly set permissions on the feed. Default is false. - * @param identityDescriptor Filter permissions to the provided identity. - * @param includeDeletedFeeds If includeDeletedFeeds is true, then feedId must be specified by name and not by Guid. - * @param includeIds True to include user Ids in the response. Default is false. - * @return Feed Permissions {@link FeedPermissions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public FeedPermissions getFeedPermissions( - String feedName, boolean excludeInheritedPermissions, String identityDescriptor, - boolean includeDeletedFeeds, boolean includeIds) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("excludeInheritedPermissions", excludeInheritedPermissions); - put("identityDescriptor", identityDescriptor); - put("includeDeletedFeeds", includeDeletedFeeds); - put("includeIds", includeIds); - }}; - - String r = send(RequestMethod.GET, CONNECTION, PACKAGING, - CONNECTION.getProject() != null ? CONNECTION.getProject() : null, - AREA + "/Feeds", feedName, "permissions", ApiVersion.FEEDS, q, null, null); - - return MAPPER.mapJsonResponse(r, FeedPermissions.class); - } - - /** - * Get a view by Id. - *

- * The project parameter must be supplied if the feed was created in a project. - *

- * - * @param feedName Name or Id of the feed. - * @param feedViewId Name or Id of the view. - * @return feed view {@link FeedView} - * @throws AzDException Default Api Exception handler. - */ - @Override - public FeedView getFeedView(String feedName, String feedViewId) throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, PACKAGING, - CONNECTION.getProject() != null ? CONNECTION.getProject() : null, - AREA + "/Feeds", feedName, "views/" + feedViewId, ApiVersion.FEEDS, null, null, null); - - return MAPPER.mapJsonResponse(r, FeedView.class); - } - - /** - * Get all views for a feed. - *

- * The project parameter must be supplied if the feed was created in a project. - *

- * - * @param feedName Name or Id of the feed. - * @return array feed views {@link FeedView} - * @throws AzDException Default Api Exception handler. - */ - @Override - public FeedViews getFeedViews(String feedName) throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, PACKAGING, - CONNECTION.getProject() != null ? CONNECTION.getProject() : null, - AREA + "/Feeds", feedName, "views", ApiVersion.FEEDS, null, null, null); - - return MAPPER.mapJsonResponse(r, FeedViews.class); - } - - /** - * Get all feeds in an account where you have the provided role access. - *

- * If the project parameter is present, gets all feeds in the given project. - * If omitted, gets all feeds in the organization. - *

- * - * @return array of feeds {@link Feeds} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Feeds getFeeds() throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, PACKAGING, - CONNECTION.getProject() != null ? CONNECTION.getProject() : null, - AREA, null, "Feeds", ApiVersion.FEEDS, null, null, null); - - return MAPPER.mapJsonResponse(r, Feeds.class); - } - - /** - * Get all feeds in an account where you have the provided role access. - *

- * If the project parameter is present, gets all feeds in the given project. - * If omitted, gets all feeds in the organization. - *

- * - * @param feedRole Filter by this role, either Administrator(4), Contributor(3), or Reader(2) level permissions. - * @param includeDeletedUpstreams Include upstreams that have been deleted in the response. - * @param includeUrls Resolve names if true - * @return array of feeds {@link Feeds} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Feeds getFeeds( - FeedRole feedRole, boolean includeDeletedUpstreams, - boolean includeUrls) throws AzDException { - - HashMap q = new HashMap<>() {{ - put("feedRole", feedRole); - put("includeDeletedUpstreams", includeDeletedUpstreams); - put("includeUrls", includeUrls); - }}; - - String r = send(RequestMethod.GET, CONNECTION, PACKAGING, - CONNECTION.getProject() != null ? CONNECTION.getProject() : null, - AREA, null, "Feeds", ApiVersion.FEEDS, q, null, null); - - return MAPPER.mapJsonResponse(r, Feeds.class); - } - - /** - * Update the permissions on a feed. - *

- * The project parameter must be supplied if the feed was created in a project. - * If the feed is not associated with any project, omit the project parameter from the request. - *

- * - * @param feedPermissions List of feed permissions to update the permissions for. - * @return array of feed permissions {@link FeedPermissions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public FeedPermissions setFeedPermissions(String feedId, FeedPermissions feedPermissions) throws AzDException { - String r = send(RequestMethod.PATCH, CONNECTION, PACKAGING, - CONNECTION.getProject() != null ? CONNECTION.getProject() : null, - AREA + "/Feeds", feedId, "permissions", ApiVersion.FEEDS, null, - feedPermissions.getFeedPermission(), CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, FeedPermissions.class); - } - - /** - * Change the attributes of a feed. - *

- * The project parameter must be supplied if the feed was created in a project. - * If the feed is not associated with any project, omit the project parameter from the request. - *

- * - * @param feedId Name or Id of the feed. - * @param feed Feed object to update the settings for - * @return feed {@link Feed} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Feed updateFeed(String feedId, Feed feed) throws AzDException { - String r = send(RequestMethod.PATCH, CONNECTION, PACKAGING, - CONNECTION.getProject() != null ? CONNECTION.getProject() : null, - AREA + "/Feeds", feedId, null, ApiVersion.FEEDS, null, feed, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, Feed.class); - } - - /** - * Update a view. - *

- * The project parameter must be supplied if the feed was created in a project. - *

- * - * @param feedName Name or Id of the feed. - * @param feedViewName Name or Id of the view. - * @param feedView Feed view object to update the settings for. - * @return the updated feed view {@link FeedView} - * @throws AzDException Default Api Exception handler. - */ - @Override - public FeedView updateFeedView(String feedName, String feedViewName, FeedView feedView) - throws AzDException { - String r = send(RequestMethod.PATCH, CONNECTION, PACKAGING, - CONNECTION.getProject() != null ? CONNECTION.getProject() : null, - AREA + "/Feeds", feedName, "views/" + feedViewName, ApiVersion.FEEDS, null, - feedView, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, FeedView.class); - } -} \ No newline at end of file diff --git a/azd/src/main/java/org/azd/git/GitApi.java b/azd/src/main/java/org/azd/git/GitApi.java deleted file mode 100644 index dc411c62..00000000 --- a/azd/src/main/java/org/azd/git/GitApi.java +++ /dev/null @@ -1,2106 +0,0 @@ -package org.azd.git; - -import org.azd.common.ApiVersion; -import org.azd.common.types.JsonPatchDocument; -import org.azd.connection.Connection; -import org.azd.enums.*; -import org.azd.exceptions.AzDException; -import org.azd.git.types.*; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.GitDetails; -import org.azd.utils.AzDAsyncApi; - -import java.io.InputStream; -import java.net.http.HttpRequest; -import java.net.http.HttpResponse; -import java.text.MessageFormat; -import java.util.*; -import java.util.concurrent.TimeUnit; - -import static org.azd.utils.RestClient.send; - -/** - * GIT class to manage git API - */ -public class GitApi extends AzDAsyncApi implements GitDetails { - - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "git"; - private final String GIT = "4e080c62-fa21-4fbc-8fef-2a10a2b38049"; - - /** - * Pass the connection object to work with Git Api - * - * @param connection Connection object - */ - public GitApi(Connection connection) { - CONNECTION = connection; - } - - /** - * Create a git repository in a team project. - * - * @param repositoryName Name of the repository - * @param projectId id of the project - * @return git repository object {@link GitRepository} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitRepository createRepository(String repositoryName, String projectId) throws AzDException { - LinkedHashMap h = new LinkedHashMap<>() {{ - put("name", repositoryName); - put("project", new LinkedHashMap() {{ - put("id", projectId); - }}); - }}; - String r = send(RequestMethod.POST, CONNECTION, GIT, projectId, AREA, null, "repositories", ApiVersion.GIT, - null, h, CustomHeader.JSON_CONTENT_TYPE); - return MAPPER.mapJsonResponse(r, GitRepository.class); - } - - /** - * Delete a git repository - * - * @param repositoryId pass the repository id - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteRepository(String repositoryId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, null, ApiVersion.GIT, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Destroy (hard delete) a soft-deleted Git repository. - * - * @param repositoryId pass the repository id - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteRepositoryFromRecycleBin(String repositoryId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, GIT, CONNECTION.getProject(), - AREA + "/recycleBin/repositories", repositoryId, null, ApiVersion.GIT_RECYCLE_BIN_REPOSITORIES, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Retrieve deleted git repositories. - * - * @return Git deleted repository object - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitDeletedRepositories getDeletedRepositories() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA, null, "deletedrepositories", - ApiVersion.GIT_RECYCLE_BIN_REPOSITORIES, null, null, null); - - return MAPPER.mapJsonResponse(r, GitDeletedRepositories.class); - } - - /** - * Retrieve soft-deleted git repositories from the recycle bin. - * - * @return array of git deleted recycle bin repositories - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitDeletedRepositories getRecycleBinRepositories() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA, null, - "recycleBin/repositories", ApiVersion.GIT_RECYCLE_BIN_REPOSITORIES - , null, null, null); - - return MAPPER.mapJsonResponse(r, GitDeletedRepositories.class); - } - - /** - * Retrieve a git repository. - * - * @param repositoryName pass the repository name - * @return git repository object - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitRepository getRepository(String repositoryName) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, null, ApiVersion.GIT, null, null, null); - - return MAPPER.mapJsonResponse(r, GitRepository.class); - } - - /** - * Retrieve git repositories. - * - * @return array of git repositories - * @throws AzDException Default Api Exception handler. - */ - @Override - public Repositories getRepositories() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA, null, "repositories", - ApiVersion.GIT, null, null, null); - - return MAPPER.mapJsonResponse(r, Repositories.class); - } - - /** - * Retrieve git repositories. - * - * @param includeHidden If true then includes hidden repositories. - * @return array of git repositories - * @throws AzDException Default Api Exception handler. - */ - @Override - public Repositories getRepositories(boolean includeHidden) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA, null, "repositories", - ApiVersion.GIT, Map.of("includeHidden", includeHidden), null, null); - - return MAPPER.mapJsonResponse(r, Repositories.class); - } - - /** - * Retrieve git repositories. - * - * @param includeAllUrls If true then includes all remote URLs. - * @param includeLinks Set this value to true to include reference links. - * @return array of git repositories - * @throws AzDException Default Api Exception handler. - */ - @Override - public Repositories getRepositories(boolean includeLinks, boolean includeAllUrls) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA, null, "repositories", - ApiVersion.GIT, Map.of("includeLinks", includeLinks, "includeAllUrls", includeAllUrls), null, null); - - return MAPPER.mapJsonResponse(r, Repositories.class); - } - - /** - * Retrieve git repositories. - * - * @param includeHidden If true then includes hidden repositories. - * @param includeAllUrls If true then includes all remote URLs. - * @param includeLinks Set this value to true to include reference links. - * @return array of git repositories - * @throws AzDException Default Api Exception handler. - */ - @Override - public Repositories getRepositories(boolean includeAllUrls, boolean includeLinks, boolean includeHidden) throws AzDException { - var q = new HashMap() {{ - put("includeAllUrls", includeAllUrls); - put("includeLinks", includeLinks); - put("includeHidden", includeHidden); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA, null, "repositories", - ApiVersion.GIT, q, null, null); - - return MAPPER.mapJsonResponse(r, Repositories.class); - } - - /** - * Recover a soft-deleted Git repository. Recently deleted repositories go - * into a soft-delete state for a period of time before they are hard - * deleted and become unrecoverable. - * - * @param repositoryId pass the repository id - * @param deleted Setting to false will undo earlier deletion and restore the repository. - * @return object of git repository {@link GitRepository} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitRepository restoreRepositoryFromRecycleBin(String repositoryId, boolean deleted) throws AzDException { - HashMap h = new HashMap<>() {{ - put("deleted", deleted); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, GIT, CONNECTION.getProject(), - AREA + "/recycleBin/repositories", repositoryId, null, ApiVersion.GIT_RECYCLE_BIN_REPOSITORIES, null, h, null); - - return MAPPER.mapJsonResponse(r, GitRepository.class); - } - - /** - * Updates the Git repository with either a new repo name or a new default branch. - * - * @param repositoryId provide the repository id - * @param repositoryName pass the repository name to rename - * @param defaultBranchName pass the default branch name to set - * @return repository object - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitRepository updateRepository(String repositoryId, String repositoryName, String defaultBranchName) - throws AzDException { - HashMap h = new HashMap<>() {{ - put("name", repositoryName); - put("defaultBranch", "refs/heads/" + defaultBranchName); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, null, ApiVersion.GIT, null, h, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GitRepository.class); - } - - /** - * Create a pull request. - * - * @param repositoryId The repository ID of the pull request's target branch. - * @param sourceRefName The name of the source branch of the pull request. - * @param targetRefName The name of the target branch of the pull request. - * @param title The title of the pull request. - * @param description The description of the pull request. - * @param reviewers A list of reviewers on the pull request along with the state of their votes. - * @return an object of git pull request {@link GitPullRequest} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitPullRequest createPullRequest(String repositoryId, String sourceRefName, String targetRefName, String title, - String description, String[] reviewers) throws AzDException { - List o = new ArrayList<>(); - - for (String reviewer : reviewers) { - HashMap id = new HashMap<>() {{ - put("id", reviewer); - }}; - o.add(id); - } - - HashMap h = new HashMap<>() {{ - put("sourceRefName", sourceRefName); - put("targetRefName", targetRefName); - put("title", title); - put("description", description); - put("reviewers", o); - }}; - - String r = send(RequestMethod.POST, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, "pullrequests", ApiVersion.GIT, null, h, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GitPullRequest.class); - } - - /** - * Create a pull request and optionally make it a draft. You can specify - * only the source branch name such as develop and target branch name such - * as master. - * - * @param repositoryId The repository ID of the pull request's target branch. - * @param sourceRefName The name of the source branch of the pull request. - * @param targetRefName The name of the target branch of the pull request. - * @param title The title of the pull request. - * @param description The description of the pull request. - * @param isDraft if set to true the pull request will be in draft mode. - * @return an object of git pull request {@link GitPullRequest} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitPullRequest createPullRequest(String repositoryId, String sourceRefName, String targetRefName, String title, - String description, boolean isDraft) throws AzDException { - String referenceHead = "refs/heads/"; - var sourceBranch = sourceRefName.contains(referenceHead) ? sourceRefName : referenceHead + sourceRefName; - var targetBranch = targetRefName.contains(referenceHead) ? targetRefName : referenceHead + targetRefName; - - var b = new HashMap() {{ - put("sourceRefName", sourceBranch); - put("targetRefName", targetBranch); - put("title", title); - put("description", description); - put("isDraft", isDraft); - }}; - - String r = send(RequestMethod.POST, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, "pullrequests", ApiVersion.GIT, null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GitPullRequest.class); - } - - /** - * Create a pull request. - * - * @param gitPullRequest a {@link GitPullRequest} object. - * @return an object of git pull request {@link GitPullRequest} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitPullRequest createPullRequest(GitPullRequest gitPullRequest) throws AzDException { - if (gitPullRequest == null) throw new AzDException("Request body cannot be null or empty"); - - if (!gitPullRequest.getSourceRefName().isEmpty() && !gitPullRequest.getTargetRefName().isEmpty()) { - String referenceHead = "refs/heads/"; - if (!gitPullRequest.getSourceRefName().contains(referenceHead)) - gitPullRequest.setSourceRefName(referenceHead + gitPullRequest.getSourceRefName()); - if (!gitPullRequest.getTargetRefName().contains(referenceHead)) - gitPullRequest.setTargetRefName(referenceHead + gitPullRequest.getTargetRefName()); - } - - String r = send(RequestMethod.POST, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - gitPullRequest.getRepository().getId(), "pullrequests", ApiVersion.GIT, null, gitPullRequest, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GitPullRequest.class); - } - - /** - * Retrieve a pull request. - * - * @param repositoryName The repository name of the pull request's target branch. - * @param pullRequestId The ID of the pull request to retrieve. - * @return {@link GitPullRequest} object - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitPullRequest getPullRequest(String repositoryName, int pullRequestId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "pullrequests/" + pullRequestId, ApiVersion.GIT, null, null, null); - - return MAPPER.mapJsonResponse(r, GitPullRequest.class); - } - - /** - * Retrieve a pull request. - * - * @param repositoryName The repository name of the pull request's target branch. - * @param pullRequestId The ID of the pull request to retrieve. - * @param includeCommits If true, the pull request will be returned with the associated commits. - * @return {@link GitPullRequest} object - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitPullRequest getPullRequest(String repositoryName, int pullRequestId, boolean includeCommits) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "pullrequests/" + pullRequestId, ApiVersion.GIT, Map.of("includeCommits", includeCommits), - null, null); - - return MAPPER.mapJsonResponse(r, GitPullRequest.class); - } - - /** - * Retrieve a pull request. - * - * @param repositoryName The repository name of the pull request's target branch. - * @param pullRequestId The ID of the pull request to retrieve. - * @param includeCommits If true, the pull request will be returned with the associated commits. - * @param includeWorkItemRefs If true, the pull request will be returned with the associated work item references. - * @return {@link GitPullRequest} object - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitPullRequest getPullRequest(String repositoryName, int pullRequestId, boolean includeCommits, - boolean includeWorkItemRefs) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "pullrequests/" + pullRequestId, ApiVersion.GIT, - Map.of("includeCommits", includeCommits, "includeWorkItemRefs", includeWorkItemRefs), null, null); - - return MAPPER.mapJsonResponse(r, GitPullRequest.class); - } - - /** - * Retrieve a pull request. - * - * @param pullRequestId The ID of the pull request to retrieve. - * @return {@link GitPullRequest} object - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitPullRequest getPullRequestById(int pullRequestId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/pullrequests", - Integer.toString(pullRequestId), null, ApiVersion.GIT, null, null, null); - - return MAPPER.mapJsonResponse(r, GitPullRequest.class); - } - - /** - * Retrieve all pull requests from a repository - * - * @param repositoryName specify the repository name - * @return {@link PullRequests} object - * @throws AzDException Default Api Exception handler. - */ - @Override - public PullRequests getPullRequests(String repositoryName) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "pullrequests", ApiVersion.GIT, null, null, null); - - return MAPPER.mapJsonResponse(r, PullRequests.class); - } - - /** - * Retrieve all pull requests from a repository - * - * @param repositoryName specify the repository name - * @param top The number of pull requests to retrieve. - * @return {@link PullRequests} object - * @throws AzDException Default Api Exception handler. - */ - @Override - public PullRequests getPullRequests(String repositoryName, int top) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "pullrequests", ApiVersion.GIT, Map.of("$top", top), null, null); - - return MAPPER.mapJsonResponse(r, PullRequests.class); - } - - /** - * Retrieve all pull requests from a repository - * - * @param repositoryName specify the repository name - * @param top The number of pull requests to retrieve. - * @param skip The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100. - * @return {@link PullRequests} object - * @throws AzDException Default Api Exception handler. - */ - @Override - public PullRequests getPullRequests(String repositoryName, int top, int skip) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "pullrequests", ApiVersion.GIT, Map.of("$top", top, "$skip", skip), null, null); - - return MAPPER.mapJsonResponse(r, PullRequests.class); - } - - /** - * Retrieve all pull requests from a repository - * - * @param repositoryName specify the repository name - * @param top The number of pull requests to retrieve. - * @param skip The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100. - * @param creatorId If set, search for pull requests that were created by this identity. - * @return {@link PullRequests} object - * @throws AzDException Default Api Exception handler. - */ - @Override - public PullRequests getPullRequests(String repositoryName, int top, int skip, String creatorId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "pullrequests", ApiVersion.GIT, - Map.of("$top", top, "$skip", skip, "searchCriteria.creatorId", creatorId), null, null); - - return MAPPER.mapJsonResponse(r, PullRequests.class); - } - - /** - * Retrieve all pull requests from a repository - * - * @param repositoryName specify the repository name - * @param includeLinks Whether to include the _links field on the shallow references. - * @return {@link PullRequests} object - * @throws AzDException Default Api Exception handler. - */ - @Override - public PullRequests getPullRequests(String repositoryName, boolean includeLinks) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "pullrequests", ApiVersion.GIT, - Map.of("searchCriteria.includeLinks", includeLinks), null, null); - - return MAPPER.mapJsonResponse(r, PullRequests.class); - } - - /** - * Retrieve all pull requests from a repository - * - * @param repositoryName specify the repository name - * @param status If set, search for pull requests that are in this state. Defaults to Active if unset. - * @return {@link PullRequests} object - * @throws AzDException Default Api Exception handler. - */ - @Override - public PullRequests getPullRequests(String repositoryName, PullRequestStatus status) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "pullrequests", ApiVersion.GIT, - Map.of("searchCriteria.status", status), null, null); - - return MAPPER.mapJsonResponse(r, PullRequests.class); - } - - /** - * Retrieve all pull requests from a repository - * - * @param repositoryName specify the repository name - * @param gitPullRequestQueryParameters Property bag of query parameters pertaining to the pull requests. - * @return {@link PullRequests} object - * @throws AzDException Default Api Exception handler. - */ - @Override - public PullRequests getPullRequests(String repositoryName, GitPullRequestQueryParameters gitPullRequestQueryParameters) - throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "pullrequests", ApiVersion.GIT, - gitPullRequestQueryParameters != null - ? gitPullRequestQueryParameters.get() - : new GitPullRequestQueryParameters().get(), - null, null); - - return MAPPER.mapJsonResponse(r, PullRequests.class); - } - - /** - * Gets all pull requests from a project. To get the pull requests from - * non-default project you have to call setProject method from {@link Connection}. - * - * @return {@link PullRequests} object - * @throws AzDException Default Api Exception handler. - */ - @Override - public PullRequests getPullRequestsByProject() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA, null, "pullrequests", - ApiVersion.GIT, null, null, null); - - return MAPPER.mapJsonResponse(r, PullRequests.class); - } - - /** - * Gets all pull requests from a project. To get the pull requests from - * non-default project you have to call setProject method from {@link Connection}. - * - * @param top The number of pull requests to retrieve. - * @return {@link PullRequests} PullRequest - * @throws AzDException Default Api Exception handler. - */ - @Override - public PullRequests getPullRequestsByProject(int top) throws AzDException { - var q = new HashMap() {{ - put("$top", top); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA, null, "pullrequests", - ApiVersion.GIT, q, null, null); - - return MAPPER.mapJsonResponse(r, PullRequests.class); - } - - /** - * Gets all pull requests from a project. To get the pull requests from - * non-default project you have to call setProject method from {@link Connection}. - * - * @param status If set, search for pull requests that are in this state. Defaults to Active if unset. - * @return {@link PullRequests} PullRequest - * @throws AzDException Default Api Exception handler. - */ - @Override - public PullRequests getPullRequestsByProject(PullRequestStatus status) throws AzDException { - var q = new HashMap() {{ - put("searchCriteria.status", status.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA, null, "pullrequests", - ApiVersion.GIT, q, null, null); - - return MAPPER.mapJsonResponse(r, PullRequests.class); - } - - /** - * Update a pull request - *

- * These are the properties that can be updated with the API: - * Status - * Title - * Description (up to 4000 characters) - * CompletionOptions - * MergeOptions - * AutoCompleteSetBy.Id - * TargetRefName (when the PR retargeting feature is enabled) - * Attempting to update other properties outside of this list will either cause the server - * to throw an InvalidArgumentValueException, or to silently ignore the update. - *

- * - * @param pullRequestId ID of the pull request to update. - * @param repositoryId The repository ID of the pull request's target branch. - * @return GitPullRequest Object {@link GitPullRequest} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitPullRequest updatePullRequest(String repositoryId, int pullRequestId, Object body) throws AzDException { - String r = send(RequestMethod.PATCH, CONNECTION, GIT, CONNECTION.getProject(), - "git/repositories", repositoryId + "/pullrequests/" + pullRequestId, null, ApiVersion.GIT, - null, body, CustomHeader.JSON_CONTENT_TYPE); - return MAPPER.mapJsonResponse(r, GitPullRequest.class); - } - - /** - * Gets all pull requests from a project. To get the pull requests from - * non-default project you have to call setProject method from {@link Connection}. - * - * @param skip The number of pull requests to ignore. For example, to - * retrieve results 101-150, set top to 50 and skip to 100. - * @param top The number of pull requests to retrieve. - * @param creatorId If set, search for pull requests that were created by this identity. - * @param includeLinks Whether to include the _links field on the shallow references - * @param repositoryId If set, search for pull requests whose target branch is in this repository. - * @param reviewerId If set, search for pull requests that have this identity as a reviewer. - * @param sourceRefName If set, search for pull requests from this branch. - * @param sourceRepositoryId If set, search for pull requests whose source branch is in this repository. - * @param status If set, search for pull requests that are in this state. Defaults to Active if unset. - * @param targetRefName If set, search for pull requests into this branch. - * @return {@link PullRequests} PullRequest - * @throws AzDException Default Api Exception handler. - */ - @Override - public PullRequests getPullRequestsByProject(int skip, int top, String creatorId, boolean includeLinks, - String repositoryId, String reviewerId, String sourceRefName, String sourceRepositoryId, - PullRequestStatus status, String targetRefName) throws AzDException { - var q = new HashMap() {{ - put("$skip", skip); - put("$top", top); - put("searchCriteria.creatorId", creatorId); - put("searchCriteria.includeLinks", includeLinks); - put("searchCriteria.repositoryId", repositoryId); - put("searchCriteria.reviewerId", reviewerId); - put("searchCriteria.sourceRefName", sourceRefName); - put("searchCriteria.sourceRepositoryId", sourceRepositoryId); - put("searchCriteria.status", status.toString().toLowerCase()); - put("searchCriteria.targetRefName", targetRefName); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA, null, "pullrequests", - ApiVersion.GIT, q, null, null); - - return MAPPER.mapJsonResponse(r, PullRequests.class); - } - - /** - * Get a specific branch from a repository. - * - * @param repositoryName The name of the repository. - * @param branchName The name of the branch. - * @return The branch as a {@link GitRef} object. - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitRef getBranch(String repositoryName, String branchName) throws AzDException { - var q = new HashMap() {{ - put("filter", "heads/" + branchName); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "refs", ApiVersion.GIT, q, null, null); - - List gitRefs = MAPPER.mapJsonResponse(r, GitRefs.class).getRefs(); - - return gitRefs != null && !gitRefs.isEmpty() ? gitRefs.get(0) : null; - } - - /** - * Get the branches from a repository. - * - * @param repositoryName The name of the repository. - * @return The {@link GitRefs} with the branches. - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitRefs getBranches(String repositoryName) throws AzDException { - // Query only for refs/heads branches. - var q = new HashMap() {{ - put("filter", "heads"); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "refs", ApiVersion.GIT, q, null, null); - - return MAPPER.mapJsonResponse(r, GitRefs.class); - } - - /** - * Lock or Unlock a branch with repository name and branch name. - * - * @param repositoryName The name or ID of the repository. - * @param branchName The name of the branch to lock/unlock - * @param isLocked true to lock the branch and false to unlock. - * @return GitRef {@link GitRef} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitRef updateBranchLock(String repositoryName, String branchName, boolean isLocked) throws AzDException { - var q = new HashMap() {{ - put("filter", "heads/" + branchName); - }}; - - var b = new HashMap() {{ - put("isLocked", isLocked); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "refs", ApiVersion.GIT, q, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GitRef.class); - } - - /** - * Retrieve a list of work items associated with a pull request. - * - * @param pullRequestId ID of the pull request. - * @param repositoryName ID or name of the repository. - * @return ResourceRefs {@link ResourceRefs} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ResourceRefs getPullRequestWorkItems(int pullRequestId, String repositoryName) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "pullRequests/" + pullRequestId + "/workitems", ApiVersion.GIT_WORK_ITEMS, null, null, null); - - return MAPPER.mapJsonResponse(r, ResourceRefs.class); - } - - /** - * Create a label for a specified pull request. The only required field is - * the name of the new label. - * - * @param repositoryName The repository name of the pull request’s target branch. - * @param pullRequestId ID of the pull request. - * @param labelName tag/label name - * @return WebApi tag object {@link WebApiTagDefinition} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WebApiTagDefinition createPullRequestLabel(String repositoryName, int pullRequestId, String labelName) - throws AzDException { - var b = new HashMap() {{ - put("name", labelName); - }}; - - String r = send(RequestMethod.POST, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "pullrequests/" + pullRequestId + "/labels", ApiVersion.GIT_PULL_REQUEST_LABELS, null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, WebApiTagDefinition.class); - } - - /** - * Removes a label from the set of those assigned to the pull request. - * - * @param repositoryName The repository name of the pull request’s target branch. - * @param pullRequestId ID of the pull request. - * @param labelName tag/label name - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deletePullRequestLabel(String repositoryName, int pullRequestId, String labelName) throws AzDException { - try { - String resource = "pullrequests/" + pullRequestId + "/labels/" + labelName; - String r = send(RequestMethod.DELETE, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, resource, ApiVersion.GIT_PULL_REQUEST_LABELS, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Retrieves a single label that has been assigned to a pull request. - * - * @param repositoryName The repository name of the pull request’s target branch. - * @param pullRequestId ID of the pull request. - * @param labelName tag/label name - * @return WebApi tag object {@link WebApiTagDefinition} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WebApiTagDefinition getPullRequestLabel(String repositoryName, int pullRequestId, String labelName) - throws AzDException { - String resource = "pullrequests/" + pullRequestId + "/labels/" + labelName; - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, resource, ApiVersion.GIT_PULL_REQUEST_LABELS, null, null, null); - - return MAPPER.mapJsonResponse(r, WebApiTagDefinition.class); - } - - /** - * Get all the labels assigned to a pull request. - * - * @param repositoryName The repository name of the pull request’s target branch. - * @param pullRequestId ID of the pull request. - * @return List of WebApi tag object {@link WebApiTagDefinitions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WebApiTagDefinitions getPullRequestLabels(String repositoryName, int pullRequestId) throws AzDException { - String resource = "pullrequests/" + pullRequestId + "/labels"; - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, resource, ApiVersion.GIT_PULL_REQUEST_LABELS, null, null, null); - - return MAPPER.mapJsonResponse(r, WebApiTagDefinitions.class); - } - - /** - * Add a reviewer to a pull request or cast a vote. - * - * @param pullRequestId ID of the pull request. - * @param repositoryName The repository name of the pull request's target branch. - * @param reviewerId ID of the reviewer. - * @param vote Vote on a pull request: 10 - approved 5 - approved with - * suggestions 0 - no vote -5 - waiting for author -10 - rejected - * @param isRequired Indicates if this is a required reviewer for this pull request. - * @return PullRequestReviewer {@link IdentityRefWithVote} - * @throws AzDException Default Api Exception handler. - */ - @Override - public IdentityRefWithVote createPullRequestReviewer(int pullRequestId, String repositoryName, String reviewerId, - int vote, boolean isRequired) throws AzDException { - var b = new HashMap() {{ - put("vote", vote); - put("id", reviewerId); - }}; - - String id = repositoryName + "/pullrequests/" + pullRequestId + "/reviewers/" + reviewerId; - - String r = send(RequestMethod.PUT, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", id, null, - ApiVersion.GIT_PULL_REQUEST_REVIEWERS, null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, IdentityRefWithVote.class); - } - - /** - * Remove a reviewer from a pull request. - * - * @param pullRequestId ID of the pull request. - * @param repositoryName The repository name of the pull request's target branch. - * @param reviewerId ID of the reviewer. - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deletePullRequestReviewer(int pullRequestId, String repositoryName, String reviewerId) - throws AzDException { - try { - String id = repositoryName + "/pullrequests/" + pullRequestId + "/reviewers/" + reviewerId; - - String r = send(RequestMethod.DELETE, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", id, - null, ApiVersion.GIT_PULL_REQUEST_REVIEWERS, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Retrieve information about a particular reviewer on a pull request - * - * @param pullRequestId ID of the pull request. - * @param repositoryName The repository name of the pull request's target branch. - * @param reviewerId ID of the reviewer. - * @return PullRequestReviewer {@link IdentityRefWithVote} - * @throws AzDException Default Api Exception handler. - */ - @Override - public IdentityRefWithVote getPullRequestReviewer(int pullRequestId, String repositoryName, String reviewerId) - throws AzDException { - String id = repositoryName + "/pullrequests/" + pullRequestId + "/reviewers/" + reviewerId; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", id, null, - ApiVersion.GIT_PULL_REQUEST_REVIEWERS, null, null, null); - - return MAPPER.mapJsonResponse(r, IdentityRefWithVote.class); - } - - /** - * Retrieve the reviewers for a pull request - * - * @param pullRequestId ID of the pull request. - * @param repositoryName The repository name of the pull request's target branch. - * @return List of PullRequestReviewer {@link PullRequestReviewers} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PullRequestReviewers getPullRequestReviewers(int pullRequestId, String repositoryName) throws AzDException { - String id = repositoryName + "/pullrequests/" + pullRequestId + "/reviewers"; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", id, null, - ApiVersion.GIT_PULL_REQUEST_REVIEWERS, null, null, null); - - return MAPPER.mapJsonResponse(r, PullRequestReviewers.class); - } - - /** - * Edit a reviewer entry. These fields are patchable: isFlagged, hasDeclined - * - * @param pullRequestId ID of the pull request. - * @param repositoryName The repository name of the pull request's target branch. - * @param reviewerId ID of the reviewer. - * @param isFlagged Indicates if this reviewer is flagged for attention on this pull request. - * @param hasDeclined Indicates if this reviewer has declined to review this pull request. - * @return PullRequestReviewer {@link IdentityRefWithVote} - * @throws AzDException Default Api Exception handler. - */ - @Override - public IdentityRefWithVote updatePullRequestReviewer(int pullRequestId, String repositoryName, String reviewerId, - boolean isFlagged, boolean hasDeclined) throws AzDException { - var b = new HashMap() {{ - put("isFlagged", isFlagged); - put("hasDeclined", hasDeclined); - }}; - - String id = repositoryName + "/pullrequests/" + pullRequestId + "/reviewers/" + reviewerId; - - String r = send(RequestMethod.PATCH, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", id, null, - ApiVersion.GIT_PULL_REQUEST_REVIEWERS, null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, IdentityRefWithVote.class); - } - - /** - * Create an annotated tag. - * - * @param repositoryName Name of the repository. - * @param tagName The name of the annotated tag. - * @param objectId The objectId (Sha1Id) of the tag. - * @param message The tagging Message. - * @return A Git annotated tag object {@link GitAnnotatedTag}. - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitAnnotatedTag createAnnotatedTag(String repositoryName, String tagName, String objectId, String message) - throws AzDException { - var b = new HashMap() {{ - put("name", tagName); - put("taggedObject", new HashMap() {{ - put("objectId", objectId); - }}); - put("message", message); - }}; - - String r = send(RequestMethod.POST, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "annotatedtags", ApiVersion.GIT_ANNOTATED_TAGS, null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GitAnnotatedTag.class); - } - - /** - * Get an annotated tag. - * - * @param repositoryName Name of the repository. - * @param objectId ObjectId (Sha1Id) of tag to get. - * @return A Git annotated tag object {@link GitAnnotatedTag}. - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitAnnotatedTag getAnnotatedTag(String repositoryName, String objectId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "annotatedtags/" + objectId, ApiVersion.GIT_ANNOTATED_TAGS, null, null, null); - - return MAPPER.mapJsonResponse(r, GitAnnotatedTag.class); - } - - /** - * Retrieve a particular commit. - * - * @param repositoryName Name of the repository. - * @param commitId The id of the commit. - * @return Git commit object {@link GitCommit} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitCommit getCommit(String repositoryName, String commitId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "commits/" + commitId, ApiVersion.GIT, null, null, null); - - return MAPPER.mapJsonResponse(r, GitCommit.class); - } - - /** - * Retrieve a particular commit. - * - * @param repositoryName Name of the repository. - * @param commitId The id of the commit. - * @param changeCount The number of changes to include in the result. - * @return Git commit object {@link GitCommit} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitCommit getCommit(String repositoryName, String commitId, int changeCount) throws AzDException { - var q = new HashMap() {{ - put("changeCount", changeCount); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "commits/" + commitId, ApiVersion.GIT, q, null, null); - - return MAPPER.mapJsonResponse(r, GitCommit.class); - } - - /** - * Retrieve changes for a particular commit. - * - * @param repositoryName Name of the repository. - * @param commitId The id of the commit. - * @return Git commit changes object {@link GitCommitChanges} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitCommitChanges getChanges(String repositoryName, String commitId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "commits/" + commitId + "/changes", ApiVersion.GIT_COMMIT_CHANGES, null, null, null); - - return MAPPER.mapJsonResponse(r, GitCommitChanges.class); - } - - /** - * Retrieve changes for a particular commit. - * - * @param repositoryName Name of the repository. - * @param commitId The id of the commit. - * @param top The maximum number of changes to return. - * @param skip The number of changes to skip. - * @return Git commit changes object {@link GitCommitChanges} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitCommitChanges getChanges(String repositoryName, String commitId, int top, int skip) throws AzDException { - var q = new HashMap() {{ - put("top", top); - put("skip", skip); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "commits/" + commitId + "/changes", ApiVersion.GIT_COMMIT_CHANGES, q, null, null); - - return MAPPER.mapJsonResponse(r, GitCommitChanges.class); - } - - /** - * Retrieve git commits for a project. - * - * @param repositoryName Name of the repository. - * @return Array Git commit object {@link GitCommits} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitCommits getCommits(String repositoryName) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "commits", ApiVersion.GIT, null, null, null); - - return MAPPER.mapJsonResponse(r, GitCommits.class); - } - - /** - * Retrieve git commits for a project. - * - * @param repositoryName Name of the repository. - * @param top Maximum number of entries to retrieve - * @return Array Git commit object {@link GitCommits} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitCommits getCommits(String repositoryName, int top) throws AzDException { - var q = new HashMap() {{ - put("top", top); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "commits", ApiVersion.GIT, q, null, null); - - return MAPPER.mapJsonResponse(r, GitCommits.class); - } - - /** - * Retrieve git commits for a project. - * - * @param repositoryName Name of the repository. - * @param ids If provided, specifies the exact commit ids of the commits to - * fetch. May not be combined with other parameters. - * @return Array Git commit object {@link GitCommits} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitCommits getCommits(String repositoryName, List ids) throws AzDException { - var q = new HashMap() {{ - put("ids", String.join(",", ids)); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "commits", ApiVersion.GIT, q, null, null); - - return MAPPER.mapJsonResponse(r, GitCommits.class); - } - - /** - * Retrieve git commits for a project. - * - * @param repositoryName Name of the repository. - * @param top Maximum number of entries to retrieve. - * @param skip Number of entries to skip. - * @param author Alias or display name of the author. - * @param version Version string identifier (name of tag/branch, SHA1 of - * commit). - * @param versionOptions Version options - Specify additional modifiers to version (e.g - * Previous). - * @param versionType Version type (branch, tag, or commit). Determines how Id is - * interpreted. - * @param excludeDeletes Only applies when an itemPath is specified. This determines - * whether to exclude delete entries of the specified path. - * @param fromCommitId If provided, a lower bound for filtering commits - * alphabetically. - * @param toCommitId If provided, an upper bound for filtering commits - * alphabetically - * @param fromDate If provided, only include history entries created after this - * date (string). - * @param toDate If provided, only include history entries created before this - * date (string) - * @param historyMode What Git history mode should be used. This only applies to the - * search criteria when Ids = null and an itemPath is specified. - * @param ids If provided, specifies the exact commit ids of the commits to - * fetch. May not be combined with other parameters. - * @param includeLinks Whether to include the _links field on the shallow references - * @param includePushData Whether to include the push information - * @param includeUserImageUrl Whether to include the image Url for committers and authors - * @param includeWorkItems Whether to include linked work items - * @param itemPath Path of item to search under - * @param showOldestCommitsFirst If enabled, this option will ignore the itemVersion and - * compareVersion parameters. - * @param user Alias or display name of the committer - * @param itemVersion Version string identifier (name of tag/branch, SHA1 of commit) - * @param itemVersionOptions Version options - Specify additional modifiers to version (e.g - * Previous) - * @param itemVersionType Version type (branch, tag, or commit). Determines how Id is - * interpreted - * @return Array Git commit object {@link GitCommits} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitCommits getCommits(String repositoryName, int top, int skip, String author, String version, - GitVersionOptions versionOptions, GitVersionType versionType, boolean excludeDeletes, String fromCommitId, - String toCommitId, String fromDate, String toDate, GitHistoryMode historyMode, List ids, - boolean includeLinks, boolean includePushData, boolean includeUserImageUrl, boolean includeWorkItems, - String itemPath, boolean showOldestCommitsFirst, String user, String itemVersion, - GitVersionOptions itemVersionOptions, GitVersionType itemVersionType) throws AzDException { - var q = new HashMap() {{ - put("$top", top); - put("$skip", skip); - put("author", author); - put("compareVersion.version", version); - put("compareVersion.versionOptions", versionOptions.toString().toLowerCase()); - put("compareVersion.versionType", versionType.toString().toLowerCase()); - put("excludeDeletes", excludeDeletes); - put("fromCommitId", fromCommitId); - put("fromDate", fromDate); - put("historyMode", historyMode.toString().toLowerCase()); - put("ids", String.join(",", ids)); - put("includeLinks", includeLinks); - put("includePushData", includePushData); - put("includeUserImageUrl", includeUserImageUrl); - put("itemPath", itemPath); - put("itemVersion.version", itemVersion); - put("itemVersion.versionOptions", itemVersionOptions.toString().toLowerCase()); - put("itemVersion.versionType", itemVersionType.toString().toLowerCase()); - put("showOldestCommitsFirst", showOldestCommitsFirst); - put("toCommitId", toCommitId); - put("toDate", toDate); - put("user", user); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "commits", ApiVersion.GIT, q, null, null); - - return MAPPER.mapJsonResponse(r, GitCommits.class); - } - - /** - * Retrieve a list of commits associated with a particular push. - * - * @param repositoryName Name of the repository. - * @param pushId The id of the push. - * @return Array Git commit object {@link GitCommits} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitCommits getPushCommits(String repositoryName, int pushId) throws AzDException { - var q = new HashMap() {{ - put("pushId", pushId); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "commits", ApiVersion.GIT, q, null, null); - - return MAPPER.mapJsonResponse(r, GitCommits.class); - } - - /** - * Retrieve a list of commits associated with a particular push. - * - * @param repositoryName Name of the repository. - * @param pushId The id of the push. - * @param includeLinks Set to false to avoid including REST Url links for resources. - * Defaults to true. - * @param top The maximum number of commits to return ("get the top x - * commits"). - * @param skip The number of commits to skip. - * @return Array Git commit object {@link GitCommits} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitCommits getPushCommits(String repositoryName, int pushId, boolean includeLinks, int top, int skip) - throws AzDException { - var q = new HashMap() {{ - put("pushId", pushId); - put("top", top); - put("skip", skip); - put("includeLinks", includeLinks); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "commits", ApiVersion.GIT, q, null, null); - - return MAPPER.mapJsonResponse(r, GitCommits.class); - } - - /** - * Retrieve git commits for a project matching the search criteria. - * - * @param repositoryId The name or ID of the repository. - * @param gitCommitsBatch request body {@link GitCommitsBatch}. - * @return GitCommitRefs object {@link GitCommitRefs}. - * @throws AzDException Default Api exception handler. - */ - @Override - public GitCommitRefs getCommitsBatch(String repositoryId, GitCommitsBatch gitCommitsBatch) throws AzDException { -// var valuesToRemove = new ArrayList(); -// if (gitCommitsBatch.getSkip() == 0) valuesToRemove.add("$skip"); -// if (gitCommitsBatch.getTop() == 0) valuesToRemove.add("$top"); -// -// var b = ModelBuilder.build(gitCommitsBatch, valuesToRemove); - - String r = send(RequestMethod.POST, CONNECTION, GIT, CONNECTION.getProject(), - "git/repositories", repositoryId, "commitsbatch", ApiVersion.GIT, null, - gitCommitsBatch, CustomHeader.JSON_CONTENT_TYPE); - return MAPPER.mapJsonResponse(r, GitCommitRefs.class); - } - - /** - * Queries the provided repository for its refs and returns them. - * - * @param repositoryName Name of the repository. - * @return Array Git ref object {@link GitRefs} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitRefs getRefs(String repositoryName) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), - AREA + "/repositories", repositoryName, "refs", ApiVersion.GIT, null, null, null); - - return MAPPER.mapJsonResponse(r, GitRefs.class); - } - - /** - * Queries the provided repository for its refs and returns them. - * - * @param repositoryName Name of the repository. - * @param filter A filter to apply to the refs (starts with). - * @return Array Git ref object {@link GitRefs} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitRefs getRefs(String repositoryName, String filter) throws AzDException { - var q = new HashMap() {{ - put("filter", filter); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), - AREA + "/repositories", repositoryName, "refs", ApiVersion.GIT, q, null, null); - - return MAPPER.mapJsonResponse(r, GitRefs.class); - } - - /** - * Creating, updating, or deleting git ref. - * - * @param repositoryName Name of the repository. - * @param refName The ref to create, update, or delete. - * @param oldObjectId The old object id of the ref.(SHA) - * @param newObjectId The new object id of the ref.(SHA) - * @return Array Git update result object {@link GitRefUpdateResults} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitRefUpdateResult updateRef(String repositoryName, String refName, String oldObjectId, String newObjectId) throws AzDException { - var b = new ArrayList(); - var h = new HashMap() {{ - put("name", refName); - put("oldObjectId", oldObjectId); - put("newObjectId", newObjectId); - }}; - - b.add(h); - - String r = send(RequestMethod.POST, CONNECTION, GIT, CONNECTION.getProject(), - AREA + "/repositories", repositoryName, "refs", ApiVersion.GIT, null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GitRefUpdateResults.class).getGitRefUpdateResults().get(0); - } - - /** - * Creates a new tag in the repository that points to the supplied ref. - * - * @param repositoryName Name of the repository. - * @param tagName The name of the tag. - * @param ref Create tag using commit SHA, another tag name, or branch name - * @return Git update result object {@link GitRefUpdateResult} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitRefUpdateResult createTag(String repositoryName, String tagName, String ref) throws AzDException { - if (ref.matches("^[a-fA-F0-9]{40}$")) { - return updateRef(repositoryName, "refs/tags/" + tagName, "0000000000000000000000000000000000000000", ref); - } - - String objectId; - GitRefs refs = getRefs(repositoryName, "tags/" + ref); - if (!refs.getRefs().isEmpty()) { - objectId = refs.getRefs().get(0).getObjectId(); - return updateRef(repositoryName, "refs/tags/" + tagName, "0000000000000000000000000000000000000000", objectId); - } - - refs = getRefs(repositoryName, "heads/" + ref); - if (!refs.getRefs().isEmpty()) { - objectId = refs.getRefs().get(0).getObjectId(); - return updateRef(repositoryName, "refs/tags/" + tagName, "0000000000000000000000000000000000000000", objectId); - } - - throw new AzDException(ApiExceptionTypes.InvalidArgumentException.name(), MessageFormat.format("Could not find ref {0}", ref)); - } - - /** - * Deletes a tag of a repository with given name. - * - * @param repositoryName Name of the repository. - * @param tagName The name of the tag. - * @return Array Git update result object {@link GitRefUpdateResults} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GitRefUpdateResult deleteTag(String repositoryName, String tagName) throws AzDException { - GitRefs refs = getRefs(repositoryName, "tags/" + tagName); - if (refs.getRefs().isEmpty()) { - throw new AzDException(ApiExceptionTypes.InvalidArgumentException.name(), MessageFormat.format( - "Tag {0} does not exist in repository {1}", tagName, repositoryName)); - } - String tagObjectId = refs.getRefs().get(0).getObjectId(); - - return updateRef(repositoryName, "refs/tags/" + tagName, tagObjectId, "0000000000000000000000000000000000000000"); - } - - /** - * Get a single blob. - * - * @param repositoryId The name or ID of the repository. - * @param sha1 SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint. - * @return GitBlobRef Object {@link GitBlobRef} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitBlobRef getBlob(String repositoryId, String sha1) throws AzDException { - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, "blobs/" + sha1, ApiVersion.GIT_BLOBS, null, null, null); - - return MAPPER.mapJsonResponse(r, GitBlobRef.class); - } - - /** - * Get a single blob. - * - * @param repositoryId The name or ID of the repository. - * @param sha1 SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint. - * @param fileName Provide a fileName to use for a download. - * @param resolveLfs If true, try to resolve a blob to its LFS contents, if it's an LFS pointer file. Only compatible with octet-stream Accept headers or $format types - * @return GitBlobRef Object {@link GitBlobRef} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitBlobRef getBlob(String repositoryId, String sha1, String fileName, boolean resolveLfs) throws AzDException { - var q = new HashMap() {{ - put("$format", GitBlobRefFormat.JSON.name()); - put("fileName", fileName); - put("resolveLfs", resolveLfs); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, "blobs/" + sha1, ApiVersion.GIT_BLOBS, q, null, null); - - return MAPPER.mapJsonResponse(r, GitBlobRef.class); - } - - /** - * Get a single blob content. - * - * @param repositoryId The name or ID of the repository. - * @param sha1 SHA1 hash of the file. You can get the SHA1 of a file using the getItems() method. - * @param download If true, download the text. You can use {@link org.azd.helpers.StreamHelper} to download the file. - * @param fileName Provide a fileName to use for a download. - * @param resolveLfs If true, try to resolve a blob to its LFS contents, if it's an LFS pointer file. Only compatible with octet-stream Accept headers or $format types - * @return String contents of the file. - * @throws AzDException Default Api Exception handler. - **/ - @Override - public String getBlobContent(String repositoryId, String sha1, boolean download, String fileName, boolean resolveLfs) throws AzDException { - var q = new HashMap() {{ - put("$format", GitBlobRefFormat.TEXT.name()); - put("download", download); - put("fileName", fileName); - put("resolveLfs", resolveLfs); - }}; - - return send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, "blobs/" + sha1, ApiVersion.GIT_BLOBS, q, null, null); - } - - /** - * Get a single blob as zip of input stream. Use {@link org.azd.helpers.StreamHelper} to download the file. - * - * @param repositoryId The name or ID of the repository. - * @param sha1 SHA1 hash of the file. You can get the SHA1 of a file using the getItems() method. - * @param download If true, download the text. You can use {@link org.azd.helpers.StreamHelper} to download the file. - * @param fileName Provide a fileName to use for a download. - * @param resolveLfs If true, try to resolve a blob to its LFS contents, if it's an LFS pointer file. Only compatible with octet-stream Accept headers or $format types - * @return Input stream for zip download. This gets the stream of a single file. - * @throws AzDException Default Api Exception handler. - **/ - @Override - public InputStream getBlobContentAsZip(String repositoryId, String sha1, boolean download, String fileName, boolean resolveLfs) throws AzDException { - var q = new HashMap() {{ - put("$format", GitBlobRefFormat.ZIP.name()); - put("download", download); - put("fileName", fileName); - put("resolveLfs", resolveLfs); - }}; - - return send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, "blobs/" + sha1, ApiVersion.GIT_BLOBS, q, null, null, false); - } - - /** - * Get a single blob content as input stream. Use {@link org.azd.helpers.StreamHelper} to download the file. - * - * @param repositoryId The name or ID of the repository. - * @param sha1 SHA1 hash of the file. You can get the SHA1 of a file using the getItems() method. - * @param download If true, download the text. You can use {@link org.azd.helpers.StreamHelper} to download the file. - * @param fileName Provide a fileName to use for a download. - * @param resolveLfs If true, try to resolve a blob to its LFS contents, if it's an LFS pointer file. Only compatible with octet-stream Accept headers or $format types - * @return Input stream for zip download. This gets the stream of a single file. - * @throws AzDException Default Api Exception handler. - **/ - @Override - public InputStream getBlobContentAsStream(String repositoryId, String sha1, boolean download, String fileName, boolean resolveLfs) throws AzDException { - var q = new HashMap() {{ - put("$format", GitBlobRefFormat.OCTET_STREAM.name()); - put("download", download); - put("fileName", fileName); - put("resolveLfs", resolveLfs); - }}; - - return send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, "blobs/" + sha1, ApiVersion.GIT_BLOBS, q, null, null, false); - } - - /** - * Gets one or more blobs in a zip file download. - * - * @param repositoryId The name or ID of the repository. - * @throws AzDException Default Api Exception handler. - **/ - @Override - public InputStream getBlobsZip(String repositoryId, List sha1) throws AzDException { - return send(null, RequestMethod.POST, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, "blobs", ApiVersion.GIT_BLOBS, null, - HttpRequest.BodyPublishers.ofString(MAPPER.convertToString(sha1)), - HttpResponse.BodyHandlers.ofInputStream(), - Map.of("Stream_Zip", CustomHeader.STREAM_ZIP_ACCEPT, "Content_Type", CustomHeader.JSON_CONTENT_TYPE), - false) - .thenApplyAsync(HttpResponse::body) - .join(); - } - - /** - * Gets one or more blobs in a zip file download. - * - * @param repositoryId The name or ID of the repository. - * @param fileName Name of the file. - * @throws AzDException Default Api Exception handler. - **/ - @Override - public InputStream getBlobsZip(String repositoryId, String fileName, List sha1) throws AzDException { - return send(null, RequestMethod.POST, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, "blobs", ApiVersion.GIT_BLOBS, Map.of("filename", fileName), - HttpRequest.BodyPublishers.ofString(MAPPER.convertToString(sha1)), - HttpResponse.BodyHandlers.ofInputStream(), - Map.of("Stream_Zip", CustomHeader.STREAM_ZIP_ACCEPT, "Content_Type", CustomHeader.JSON_CONTENT_TYPE), - false) - .thenApplyAsync(HttpResponse::body) - .join(); - } - - /** - * Get Item Metadata and/or Content for a collection of items. - * - * @param repositoryName The name or ID of the repository. - * @return GitItem Object {@link GitItem} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitItems getItems(String repositoryName) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "items", ApiVersion.GIT_ITEMS, null, null, null); - - return MAPPER.mapJsonResponse(r, GitItems.class); - } - - /** - * Get Item Metadata and/or Content for a collection of items. - * - * @param repositoryName The name or ID of the repository. - * @param recursionType The recursion level of this request. The default is 'none', no recursion. - * @return GitItem Object {@link GitItem} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitItems getItems(String repositoryName, VersionControlRecursionType recursionType) throws AzDException { - var q = new HashMap() {{ - put("recursionLevel", recursionType.name()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "items", ApiVersion.GIT_ITEMS, q, null, null); - - return MAPPER.mapJsonResponse(r, GitItems.class); - } - - /** - * Get Item Metadata and/or Content for a collection of items. - * - * @param repositoryName The name or ID of the repository. - * @param includeContentMetadata Set to true to include content metadata. Default is false. - * @param includeLinks Set to true to include links to items. Default is false. - * @param latestProcessedChange Set to true to include the latest changes. Default is false. - * @param recursionType The recursion level of this request. The default is 'none', no recursion. - * @param scopePath The path scope. The default is null. - * @return GitItem Object {@link GitItem} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitItems getItems(String repositoryName, boolean includeContentMetadata, boolean includeLinks, - boolean latestProcessedChange, VersionControlRecursionType recursionType, - String scopePath) throws AzDException { - var q = new HashMap() {{ - put("recursionLevel", recursionType.getValue()); - put("includeContentMetadata", includeContentMetadata); - put("includeLinks", includeLinks); - put("latestProcessedChange", latestProcessedChange); - }}; - - if (scopePath != null) q.put("scopePath", scopePath); - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "items", ApiVersion.GIT_ITEMS, q, null, null); - - return MAPPER.mapJsonResponse(r, GitItems.class); - } - - /** - * Get Item Metadata and/or Content for a collection of items. - * - * @param repositoryName The name or ID of the repository. - * @param includeContentMetadata Set to true to include content metadata. Default is false. - * @param includeLinks Set to true to include links to items. Default is false. - * @param latestProcessedChange Set to true to include the latest changes. Default is false. - * @param recursionType The recursion level of this request. The default is 'none', no recursion. - * @param scopePath The path scope. The default is null. - * @param version Version string identifier (name of tag/branch, SHA1 of commit) - * @param versionOptions Version options - Specify additional modifiers to version (e.g Previous) - * @param versionType Version type (branch, tag, or commit). Determines how Id is interpreted - * @return GitItem Object {@link GitItem} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitItems getItems(String repositoryName, boolean includeContentMetadata, boolean includeLinks, - boolean latestProcessedChange, VersionControlRecursionType recursionType, - String scopePath, String version, GitVersionOptions versionOptions, - GitVersionType versionType) throws AzDException { - var q = new HashMap() {{ - put("recursionLevel", recursionType.getValue()); - put("includeContentMetadata", includeContentMetadata); - put("includeLinks", includeLinks); - put("latestProcessedChange", latestProcessedChange); - put("versionOptions", versionOptions); - put("versionType", versionType); - put("version", version); - }}; - - if (scopePath != null) q.put("scopePath", scopePath); - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "items", ApiVersion.GIT_ITEMS, q, null, null); - - return MAPPER.mapJsonResponse(r, GitItems.class); - } - - /** - * Request that another repository's refs be fetched into this one. It syncs two existing forks. - * - * @param repositoryName The name or ID of the repository. - * @param sourceCollectionId Team Project Collection ID of the collection for the repository. - * @param sourceProjectId Team Project ID of the project for the repository. - * @param sourceRepositoryId ID of the repository. - * @param includeLinks Set to true to include links to items. Default is false. - * @return GitForkSyncRequest Object {@link GitForkSyncRequest} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitForkSyncRequest createForkSyncRequest(String repositoryName, String sourceCollectionId, String sourceProjectId, - String sourceRepositoryId, Boolean includeLinks) throws AzDException { - - var q = new HashMap() {{ - put("includeLinks", includeLinks); - }}; - var b = new HashMap() {{ - put("source", new HashMap() {{ - put("collectionId", sourceCollectionId); - put("projectId", sourceProjectId); - put("repositoryId", sourceRepositoryId); - }}); - }}; - - String r = send(RequestMethod.POST, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "forkSyncRequests", ApiVersion.GIT_FORK, q, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GitForkSyncRequest.class); - } - - - /** - * Request that another repository's refs be fetched into this one. It syncs two existing forks. - * - * @param repositoryName The name or ID of the repository. - * @param collectionId Team Project Collection ID of the collection for the repository. - * @param projectId Team Project ID of the project for the repository. - * @param repositoryId ID of the repository. - * @param sourceRef The source ref to copy. For example, refs/heads/main. - * @param targetRef The target ref to update. For example, refs/heads/main. - * @param includeLinks Set to true to include links to items. Default is false. - * @return GitForkSyncRequest Object {@link GitForkSyncRequest} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitForkSyncRequest createForkSyncRequest(String repositoryName, String collectionId, String projectId, - String repositoryId, String sourceRef, String targetRef, - Boolean includeLinks) throws AzDException { - - var q = new HashMap() {{ - put("includeLinks", includeLinks); - }}; - - var b = new HashMap() {{ - put("source", new HashMap() {{ - put("collectionId", collectionId); - put("projectId", projectId); - put("repositoryId", repositoryId); - }}); - put("sourceToTargetRefs", new HashMap() {{ - put("sourceRef", sourceRef); - put("targetRef", targetRef); - }}); - }}; - - String r = send(RequestMethod.POST, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "forkSyncRequests", ApiVersion.GIT_FORK, q, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GitForkSyncRequest.class); - } - - /** - * Get a specific fork sync operation's details. - * - * @param repositoryName The name or ID of the repository. - * @param OperationId OperationId of the sync request. - * @param includeLinks Set to true to include links to items. Default is false. - * @return GitForkSyncRequest Object {@link GitForkSyncRequest} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitForkSyncRequest getForkSyncRequest(String repositoryName, int OperationId, boolean includeLinks) - throws AzDException { - - var q = new HashMap() {{ - put("includeLinks", includeLinks); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "forkSyncRequests/" + OperationId, ApiVersion.GIT_FORK, q, CustomHeader.JSON_CONTENT_TYPE, null); - - return MAPPER.mapJsonResponse(r, GitForkSyncRequest.class); - } - - /** - * Retrieve all requested fork sync operations on this repository. - * - * @param repositoryName The name or ID of the repository. - * @param includeLinks Set to true to include links to items. Default is false. - * @param includeAbandoned Set to true to include abandoned requests. Default is false. - * @return GitForkSyncRequests Object {@link GitForkSyncRequests} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitForkSyncRequests getForkSyncRequests(String repositoryName, boolean includeLinks, boolean includeAbandoned) - throws AzDException { - var q = new HashMap() {{ - put("includeLinks", includeLinks); - put("includeAbandoned", includeAbandoned); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "forkSyncRequests", ApiVersion.GIT_FORK, q, null, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GitForkSyncRequests.class); - } - - /** - * Retrieve all forks of a repository in the collection. - * - * @param repositoryName The name or ID of the repository. - * @param collectionId Team project collection ID. - * @param includeLinks Set to true to include links to items. Default is false. - * @return GitRepositoryRefs Object {@link GitRepositoryRefs} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitRepositoryRefs getForks(String repositoryName, String collectionId, boolean includeLinks) throws AzDException { - - var q = new HashMap() {{ - put("includeLinks", includeLinks); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryName, "forks/" + collectionId, ApiVersion.GIT_FORK, q, null, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GitRepositoryRefs.class); - } - - /** - * Push changes to the repository. - * - * @param repositoryId The name or ID of the repository. - * @return GitPush Object {@link GitPush} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitPush createPush(String repositoryId, GitPush gitPush) throws AzDException { - String r = send(RequestMethod.POST, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, "pushes", ApiVersion.GIT_PUSH, null, gitPush, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GitPush.class); - } - - /** - * Retrieves a particular push. - * - * @param pushId ID of the push. - * @param repositoryId The name or ID of the repository. - * @return GitPush Object {@link GitPush} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitPush getPush(String repositoryId, int pushId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, "pushes/" + pushId, ApiVersion.GIT_PUSH, null, null, null); - - return MAPPER.mapJsonResponse(r, GitPush.class); - } - - /** - * Retrieves a particular push. - * - * @param pushId ID of the push. - * @param repositoryId The name or ID of the repository. - * @param includeCommits The number of commits to include in the result. - * @return GitPush Object {@link GitPush} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitPush getPush(String repositoryId, int pushId, int includeCommits) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, "pushes/" + pushId, ApiVersion.GIT_PUSH, Map.of("includeCommits", includeCommits), null, null); - - return MAPPER.mapJsonResponse(r, GitPush.class); - } - - /** - * Retrieves a particular push. - * - * @param pushId ID of the push. - * @param repositoryId The name or ID of the repository. - * @param includeRefUpdates If true, include the list of refs that were updated by the push. - * @return GitPush Object {@link GitPush} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitPush getPush(String repositoryId, int pushId, boolean includeRefUpdates) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, "pushes/" + pushId, ApiVersion.GIT_PUSH, Map.of("includeRefUpdates", includeRefUpdates), null, null); - - return MAPPER.mapJsonResponse(r, GitPush.class); - } - - /** - * Retrieves a particular push. - * - * @param pushId ID of the push. - * @param repositoryId The name or ID of the repository. - * @param includeCommits The number of commits to include in the result. - * @param includeRefUpdates If true, include the list of refs that were updated by the push. - * @return GitPush Object {@link GitPush} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitPush getPush(String repositoryId, int pushId, int includeCommits, boolean includeRefUpdates) throws AzDException { - var q = new HashMap() {{ - put("includeCommits", includeCommits); - put("includeRefUpdates", includeRefUpdates); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, "pushes/" + pushId, ApiVersion.GIT_PUSH, q, null, null); - - return MAPPER.mapJsonResponse(r, GitPush.class); - } - - /** - * Retrieves pushes associated with the specified repository. - * - * @param repositoryId The name or ID of the repository. - * @return GitPush Object {@link GitPush} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitPushes getPushes(String repositoryId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, "pushes", ApiVersion.GIT_PUSH, null, null, null); - - return MAPPER.mapJsonResponse(r, GitPushes.class); - } - - /** - * Create a pull request status. - * The only required field for the status is Context.Name that uniquely identifies the status. - * Note that you can specify iterationId in the request body to post the status on the iteration. - * - * @param pullRequestId ID of the pull request. - * @param repositoryId The repository ID of the pull request’s target branch. - * @param gitPullRequestStatus Request body to create a new pull request status. - * @return GitStatus Object {@link GitStatus} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitStatus createPullRequestStatus(int pullRequestId, String repositoryId, GitStatus gitPullRequestStatus) throws AzDException { - var resource = "pullRequests/" + pullRequestId + "/statuses"; - String r = send(RequestMethod.POST, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, resource, ApiVersion.GIT, null, gitPullRequestStatus, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GitStatus.class); - } - - /** - * Delete pull request status. You can remove multiple statuses in one call by using Update operation. - * - * @param pullRequestId ID of the pull request. - * @param repositoryId The repository ID of the pull request’s target branch. - * @param statusId ID of the pull request status. - * @throws AzDException Default Api Exception handler. - **/ - @Override - public Void deletePullRequestStatus(int pullRequestId, String repositoryId, int statusId) throws AzDException { - try { - var resource = "pullRequests/" + pullRequestId + "/statuses/" + statusId; - String r = send(RequestMethod.DELETE, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, resource, ApiVersion.GIT, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Get the specific pull request status by ID. The status ID is unique within the pull request across all iterations. - * - * @param pullRequestId ID of the pull request. - * @param repositoryId The repository ID of the pull request’s target branch. - * @param statusId ID of the pull request status. - * @return GitStatus Object {@link GitStatus} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitStatus getPullRequestStatus(int pullRequestId, String repositoryId, int statusId) throws AzDException { - var resource = "pullRequests/" + pullRequestId + "/statuses/" + statusId; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, resource, ApiVersion.GIT, null, null, null); - - return MAPPER.mapJsonResponse(r, GitStatus.class); - } - - /** - * Get all the statuses associated with a pull request. - * - * @param pullRequestId ID of the pull request. - * @param repositoryId The repository ID of the pull request’s target branch. - * @return GitStatuses Object {@link GitStatuses} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitStatuses getPullRequestStatuses(int pullRequestId, String repositoryId) throws AzDException { - var resource = "pullRequests/" + pullRequestId + "/statuses"; - - String r = send(RequestMethod.GET, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, resource, ApiVersion.GIT, null, null, null); - - return MAPPER.mapJsonResponse(r, GitStatuses.class); - } - - /** - * Update pull request statuses collection. The only supported operation type is remove. - * This operation allows to delete multiple statuses in one call. - * The path of the remove operation should refer to the ID of the pull request status. - * For example path="/1" refers to the pull request status with ID 1. - * - * @param pullRequestId ID of the pull request. - * @param repositoryId The repository ID of the pull request’s target branch. - * @param propertiesToUpdate Collection of properties to update. - * E.g., [ - * { - * "op": "remove", - * "path": "/1", - * "from": null, - * "value": null - * }, - * { - * "op": "remove", - * "path": "/2", - * "from": null, - * "value": null - * } - * ] - * @throws AzDException Default Api Exception handler. - **/ - @Override - public Void updatePullRequestStatuses(int pullRequestId, String repositoryId, List propertiesToUpdate) throws AzDException { - try { - var resource = "pullRequests/" + pullRequestId + "/statuses"; - String r = send(RequestMethod.PATCH, CONNECTION, GIT, CONNECTION.getProject(), AREA + "/repositories", - repositoryId, resource, ApiVersion.GIT, null, propertiesToUpdate, CustomHeader.JSON_PATCH); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Create a fork of a parent repository - * - * @param repositoryName The name or ID of the repository. - * @param projectId The project id of the target repository - * @param parentProjectId Project id of the parent repository from which the fork operation has to initiate. - * @param parentRepositoryId Id of the parent repository - * @return GitRepository Object {@link GitRepository} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitRepository createForkRepository(String repositoryName, String projectId, String parentProjectId, - String parentRepositoryId) throws AzDException { - Map b = new HashMap<>() {{ - put("name", repositoryName); - put("project", new HashMap() {{ - put("id", projectId); - }}); - put("parentRepository", new HashMap() {{ - put("id", parentRepositoryId); - put("project", new HashMap() {{ - put("id", parentProjectId); - }}); - }}); - }}; - String r = send(RequestMethod.POST, CONNECTION, GIT, projectId, AREA, null, "repositories", ApiVersion.GIT, - null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GitRepository.class); - } - - /** - * Create a fork of a parent repository syncing only the provided refs - * - * @param repositoryName The name or ID of the repository. - * @param projectId The project id of the target repository - * @param parentProjectId Project id of the parent repository from which the fork operation has to initiate. - * @param parentRepositoryId Id of the parent repository - * @param sourceBranch Provide the name of branch to create a fork request. - * @return GitRepository Object {@link GitRepository} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitRepository createForkRepository(String repositoryName, String projectId, String parentProjectId, - String parentRepositoryId, String sourceBranch) throws AzDException { - - var q = new HashMap() {{ - put("sourceRef", "refs/heads/" + sourceBranch); - }}; - - Map b = new HashMap<>() {{ - put("name", repositoryName); - put("project", new HashMap() {{ - put("id", projectId); - }}); - put("parentRepository", new HashMap() {{ - put("id", parentRepositoryId); - put("project", new HashMap() {{ - put("id", parentProjectId); - }}); - }}); - }}; - String r = send(RequestMethod.POST, CONNECTION, GIT, projectId, AREA, null, "repositories", ApiVersion.GIT, - q, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GitRepository.class); - } - - /** - * Create a fork of a parent repository syncing only the provided refs with wait for operation completion - * - * @param repositoryName The name or ID of the repository. - * @param projectId The project id of the target repository - * @param parentProjectId Project id of the parent repository from which the fork operation has to initiate. - * @param parentRepositoryId Id of the parent repository - * @param sourceBranch Provide the name of branch to create a fork request. - * @param checkTimes Polling interval to wait for operation to complete. - * @return GitRepository Object {@link GitRepository} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public GitRepository createForkRepositoryWithComplete(String repositoryName, String projectId, String parentProjectId, String parentRepositoryId, - String sourceBranch, int checkTimes) throws AzDException { - GitRepository gitRepository = createForkRepository(repositoryName, projectId, parentProjectId, parentRepositoryId, sourceBranch); - GitForkSyncRequest gitForkSyncRequest = getForkSyncRequests(repositoryName, true, true).getForkSyncRequest().get(0); - int operationId = gitForkSyncRequest.getOperationId(); - - for (int i = 0; i < checkTimes; i++) { - gitForkSyncRequest = getForkSyncRequest(repositoryName, operationId, true); - if (gitForkSyncRequest.getStatus() == GitAsyncOperationStatus.COMPLETED) { - return gitRepository; - } - try { - TimeUnit.MILLISECONDS.sleep(500); - } catch (InterruptedException e) { - throw new AzDException("Error while waiting for fork sync request to complete"); - } - } - - throw new AzDException("Fork sync request did not complete in time : " + gitForkSyncRequest.getStatus()); - } - -} diff --git a/azd/src/main/java/org/azd/git/types/GitChange.java b/azd/src/main/java/org/azd/git/types/GitChange.java index 666fbc6c..c0a73b80 100644 --- a/azd/src/main/java/org/azd/git/types/GitChange.java +++ b/azd/src/main/java/org/azd/git/types/GitChange.java @@ -8,14 +8,14 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.annotation.JsonSerialize; import org.azd.abstractions.serializer.SerializableEntity; -import org.azd.abstractions.serializer.VersionControlChangeTypeDeserializer; import org.azd.enums.VersionControlChangeType; import java.util.List; /** - * None + * Represents GitChange object **/ @JsonIgnoreProperties(ignoreUnknown = true) public class GitChange extends SerializableEntity { @@ -29,6 +29,7 @@ public class GitChange extends SerializableEntity { **/ @JsonProperty("changeType") @JsonDeserialize(using = VersionControlChangeTypeDeserializer.class) + @JsonSerialize(using = VersionControlChangeTypeSerializer.class) private List changeType; /** * Current version. diff --git a/azd/src/main/java/org/azd/git/types/PolicyConfiguration.java b/azd/src/main/java/org/azd/git/types/PolicyConfiguration.java index d572274d..dc372892 100644 --- a/azd/src/main/java/org/azd/git/types/PolicyConfiguration.java +++ b/azd/src/main/java/org/azd/git/types/PolicyConfiguration.java @@ -13,8 +13,6 @@ import org.azd.common.types.Author; import org.azd.policy.types.PolicyTypeRef; -import java.util.Objects; - /** * The full policy configuration with settings. diff --git a/azd/src/main/java/org/azd/abstractions/serializer/VersionControlChangeTypeDeserializer.java b/azd/src/main/java/org/azd/git/types/VersionControlChangeTypeDeserializer.java similarity index 92% rename from azd/src/main/java/org/azd/abstractions/serializer/VersionControlChangeTypeDeserializer.java rename to azd/src/main/java/org/azd/git/types/VersionControlChangeTypeDeserializer.java index b9b39c6e..d3d731c7 100644 --- a/azd/src/main/java/org/azd/abstractions/serializer/VersionControlChangeTypeDeserializer.java +++ b/azd/src/main/java/org/azd/git/types/VersionControlChangeTypeDeserializer.java @@ -1,4 +1,4 @@ -package org.azd.abstractions.serializer; +package org.azd.git.types; import com.fasterxml.jackson.core.JsonParser; import com.fasterxml.jackson.core.JsonProcessingException; @@ -10,6 +10,9 @@ import java.util.ArrayList; import java.util.List; +/** + * Custom deserializer for multi value Git change type + */ public class VersionControlChangeTypeDeserializer extends JsonDeserializer> { @Override diff --git a/azd/src/main/java/org/azd/git/types/VersionControlChangeTypeSerializer.java b/azd/src/main/java/org/azd/git/types/VersionControlChangeTypeSerializer.java new file mode 100644 index 00000000..99f4aea5 --- /dev/null +++ b/azd/src/main/java/org/azd/git/types/VersionControlChangeTypeSerializer.java @@ -0,0 +1,46 @@ +package org.azd.git.types; + +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.core.JsonGenerator; +import com.fasterxml.jackson.databind.JsonSerializer; +import com.fasterxml.jackson.databind.SerializerProvider; +import org.azd.enums.VersionControlChangeType; + +import java.io.IOException; +import java.util.List; +import java.util.stream.Collectors; + +/** + * Custom serializer for multi value Git change type + */ +public class VersionControlChangeTypeSerializer extends JsonSerializer> { + @Override + public void serialize(List value, + JsonGenerator gen, + SerializerProvider serializers) throws IOException { + + if (value == null || value.isEmpty()) { + gen.writeString(""); + return; + } + + var res = value.stream() + .map(VersionControlChangeTypeSerializer::getJsonName) + .collect(Collectors.joining(", ")); + + gen.writeString(res); + } + + private static String getJsonName(VersionControlChangeType type) { + try { + var field = VersionControlChangeType.class.getField(type.name()); + var annotation = field.getAnnotation(JsonProperty.class); + if (annotation != null) { + return annotation.value(); + } + } catch (Exception ignored) {} + + return type.name().toLowerCase(); + } +} + diff --git a/azd/src/main/java/org/azd/graph/GraphApi.java b/azd/src/main/java/org/azd/graph/GraphApi.java deleted file mode 100644 index e61a36c5..00000000 --- a/azd/src/main/java/org/azd/graph/GraphApi.java +++ /dev/null @@ -1,360 +0,0 @@ -package org.azd.graph; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.enums.CustomHeader; -import org.azd.enums.RequestMethod; -import org.azd.exceptions.AzDException; -import org.azd.graph.types.*; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.GraphDetails; -import org.azd.utils.AzDAsyncApi; - -import java.util.ArrayList; -import java.util.HashMap; -import java.util.Map; - -import static org.azd.utils.RestClient.send; - -/** - * GraphApi class to manage graph users and groups - */ -public class GraphApi extends AzDAsyncApi implements GraphDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "graph"; - private final String GRAPH = "bb1e7ec9-e901-4b68-999a-de7012b920f8"; - - /** - * Pass the connection object to work with Graph Api - * - * @param connection Connection object - */ - public GraphApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Materialize an existing AAD or MSA user into the VSTS account. - * NOTE: Created users are not active in an account unless they have been explicitly - * assigned a parent group at creation time or have signed in and been autolicensed through AAD group memberships. - * Adding a user to an account is required before the user can be added to VSTS groups or assigned an asset. - * Create a new user using the principal name as a reference to an existing user from an external AD or AAD backed provider. - * If the user to be added corresponds to a user that was previously deleted, then that user will be restored. - * - * @param emailId provide the user principal name (email address) of the user to be added. - * @param userDescriptor provide the user descriptor for reference - * @return GraphUser {@link GraphUser} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GraphUser createUser(String emailId, String userDescriptor) throws AzDException { - var b = new HashMap() {{ - put("principalName", emailId); - }}; - - String r = send(RequestMethod.POST, CONNECTION, GRAPH, null, - AREA, null, "users/" + userDescriptor, ApiVersion.GRAPH, null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GraphUser.class); - } - - /** - * Materialize an existing AAD or MSA user into the VSTS account. Add the newly created user as a member of an existing VSTS group - * by providing the group descriptor. - * - * @param emailId provide the user principal name (email address) of the user to be added. - * @param groupDescriptor provide the group descriptor. - * @return GraphUser {@link GraphUser} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GraphUser addUserToGroup(String emailId, String groupDescriptor) throws AzDException { - var b = new HashMap() {{ - put("principalName", emailId); - }}; - - var q = new HashMap() {{ - put("groupDescriptors", groupDescriptor); - }}; - - String r = send(RequestMethod.POST, CONNECTION, GRAPH, null, - AREA, null, "users", ApiVersion.GRAPH, q, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GraphUser.class); - } - - /** - * Disables a user. The user will still be visible, but membership checks for the user will return false. - * - * @param userDescriptor The descriptor of the user to delete. - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteUser(String userDescriptor) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, GRAPH, null, - AREA, null, "users/" + userDescriptor, ApiVersion.GRAPH, null, null, null); - - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Get a user by its descriptor. - * - * @param userDescriptor The descriptor of the desired user. - * @return GraphUser {@link GraphUser} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GraphUser getUser(String userDescriptor) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GRAPH, null, - AREA, null, "users/" + userDescriptor, ApiVersion.GRAPH, null, null, null); - - return MAPPER.mapJsonResponse(r, GraphUser.class); - } - - /** - * Get a list of all users in a given scope. - * - * @return GraphUsers {@link GraphUsers} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GraphUsers getUsers() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GRAPH, null, - AREA, null, "users", ApiVersion.GRAPH, null, null, null); - - return MAPPER.mapJsonResponse(r, GraphUsers.class); - } - - /** - * Get a list of all users in a given scope. - * Since the list of users may be large, results are returned in pages of users. - * If there are more results than can be returned in a single page, the result set will - * contain a continuation token for retrieval of the next set of results. - * - * @param continuationToken An opaque data blob that allows the next page of data to resume immediately - * after where the previous page ended. The only reliable way to know if there is more data left is the - * presence of a continuation token. - * @param scopeDescriptor Specify a non-default scope (collection, project) to search for users. - * @param subjectTypes String array of user subject subtypes to reduce the retrieved - * results, e.g. msa’, ‘aad’, ‘svc’ (service identity), ‘imp’ (imported identity), etc. - * @return GraphUsers {@link GraphUsers} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GraphUsers getUsers(String continuationToken, String scopeDescriptor, String subjectTypes) throws AzDException { - var q = new HashMap() {{ - put("subjectTypes", String.join(",", subjectTypes)); - put("continuationToken", continuationToken); - put("scopeDescriptor", scopeDescriptor); - }}; - - String r = send(RequestMethod.GET, CONNECTION, GRAPH, null, - AREA, null, "users", ApiVersion.GRAPH, q, null, null); - - return MAPPER.mapJsonResponse(r, GraphUsers.class); - } - - /** - * Get a group by its descriptor. The group will be returned even if it has been deleted from the account or has had all its memberships deleted. - * - * @param groupDescriptor The descriptor of the desired graph group. - * @return GraphGroup {@link GraphGroup} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GraphGroup getGroup(String groupDescriptor) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GRAPH, null, - AREA, null, "groups/" + groupDescriptor, ApiVersion.GRAPH, null, null, null); - - return MAPPER.mapJsonResponse(r, GraphGroup.class); - } - - /** - * Gets a list of all groups in the current scope (usually organization or account). - * - * @return GraphGroups {@link GraphGroups} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GraphGroups getGroups() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GRAPH, null, - AREA, null, "groups", ApiVersion.GRAPH, null, null, null); - - return MAPPER.mapJsonResponse(r, GraphGroups.class); - } - - /** - * get subjects (users, groups) that are a member of the specified group - * - * @param groupDescriptor The descriptor of the container group - * @return GraphMemberships {@link GraphMemberships} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GraphMemberships getGroupMembersOf(String groupDescriptor) throws AzDException { - var q = new HashMap() {{ - put("direction", "down"); - }}; - String r = send(RequestMethod.GET, CONNECTION, GRAPH, null, - AREA, null, "memberships/" + groupDescriptor, ApiVersion.GRAPH, q, null, null); - - return MAPPER.mapJsonResponse(r, GraphMemberships.class); - } - - /** - * get groups that the specified subject (user, group) belongs to - * - * @param subjectDescriptor The descriptor of the subject (either user or group) that belongs to a container - * @return GraphMemberships {@link GraphMemberships} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GraphMemberships getMemberOfGroups(String subjectDescriptor) throws AzDException { - var q = new HashMap() {{ - put("direction", "up"); - }}; - String r = send(RequestMethod.GET, CONNECTION, GRAPH, null, - AREA, null, "memberships/" + subjectDescriptor, ApiVersion.GRAPH, q, null, null); - - return MAPPER.mapJsonResponse(r, GraphMemberships.class); - } - - /** - * add a membership relation between a subject (user or group) and a container (group) - *

- * a more general case that allows nested groups - * - * @param subjectDescriptor The descriptor of the subject to add to the container - * @param groupDescriptor The descriptor of the container to which to add the subject - * @return GraphMembership {@link GraphMembership} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GraphMembership addMembership(String subjectDescriptor, String groupDescriptor) throws AzDException { - String r = send(RequestMethod.PUT, CONNECTION, GRAPH, null, - AREA, null, "memberships/" + subjectDescriptor + "/" + groupDescriptor, ApiVersion.GRAPH, null, null, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GraphMembership.class); - } - - /** - * remove a membership relation between a subject (user or group) and a container (group) - * - * @param subjectDescriptor The descriptor of the subject to remove from the container - * @param groupDescriptor The descriptor of the container to which to remove the subject - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void removeMembership(String subjectDescriptor, String groupDescriptor) throws AzDException { - String r = send(RequestMethod.DELETE, CONNECTION, GRAPH, null, - AREA, null, "memberships/" + subjectDescriptor + "/" + groupDescriptor, ApiVersion.GRAPH, null, null, null); - - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - return null; - } - - /** - * create a local group at the collection level - * - * @param displayName The name of the group - * @param description A generally more verbose description of the group - * @return GraphMembership {@link GraphMembership} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GraphMembership createGroup(String displayName, String description) throws AzDException { - return createGroup(displayName, description, null); - } - - /** - * create a local group at the project level - * - * @param displayName The name of the group - * @param description A generally more verbose description of the group - * @return GraphMembership {@link GraphMembership} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GraphMembership createGroup(String displayName, String description, String projectDescriptor) throws AzDException { - var q = new HashMap() {{ - if (projectDescriptor != null) put("scopeDescriptor", projectDescriptor); - }}; - var b = new HashMap() {{ - put("displayName", displayName); - put("description", description); - }}; - String r = send(RequestMethod.POST, CONNECTION, GRAPH, null, - AREA, null, "groups", ApiVersion.GRAPH, q, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, GraphMembership.class); - } - - /** - * Removes an Azure DevOps group from all of its parent groups. - *

- * The group will still be visible, but membership checks for the group, and all descendants which derive membership through it, will return false. - * - * @param groupDescriptor The descriptor of the target group to remove - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteGroup(String groupDescriptor) throws AzDException { - String r = send(RequestMethod.DELETE, CONNECTION, GRAPH, null, - AREA, null, "groups/" + groupDescriptor, ApiVersion.GRAPH, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - return null; - } - - /** - * Resolve a storage key to a descriptor - *

- * Refer to REST API documentation on descriptors - * - * @param storageKey A GUID representation of a user or group - * @return GraphDescriptor {@link GraphDescriptor} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GraphDescriptor getDescriptor(String storageKey) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, GRAPH, null, - AREA, null, "descriptors/" + storageKey, ApiVersion.GRAPH, null, null, null); - - return MAPPER.mapJsonResponse(r, GraphDescriptor.class); - } - - /** - * resolve descriptors to subjects - *

- * Refer to REST API documentation on storage keys - * - * @param descriptors user and group descriptor strings - * @return SubjectLookupResponse {@link SubjectLookupResponse} - * @throws AzDException Default Api Exception handler. - */ - @Override - public SubjectLookupResponse subjectLookup(String... descriptors) throws AzDException { - var b = new HashMap() {{ - put("lookupKeys", new ArrayList<>() {{ - for (String descriptor : descriptors) { - add(new HashMap() {{ - put("descriptor", descriptor); - }}); - } - }}); - }}; - String r = send(RequestMethod.POST, CONNECTION, GRAPH, null, - AREA, null, "subjectlookup", ApiVersion.GRAPH, null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, SubjectLookupResponse.class); - } -} diff --git a/azd/src/main/java/org/azd/graph/serviceprincipals/ServicePrincipalsRequestBuilder.java b/azd/src/main/java/org/azd/graph/serviceprincipals/ServicePrincipalsRequestBuilder.java index 9a25e414..8d2351e5 100644 --- a/azd/src/main/java/org/azd/graph/serviceprincipals/ServicePrincipalsRequestBuilder.java +++ b/azd/src/main/java/org/azd/graph/serviceprincipals/ServicePrincipalsRequestBuilder.java @@ -5,8 +5,8 @@ import org.azd.authentication.AccessTokenCredential; import org.azd.common.ApiVersion; import org.azd.exceptions.AzDException; -import org.azd.graph.types.GraphServicePrincipalCreationContext; import org.azd.graph.types.GraphServicePrincipal; +import org.azd.graph.types.GraphServicePrincipalCreationContext; import org.azd.graph.types.GraphServicePrincipalOriginIdCreationContext; import org.azd.graph.types.GraphServicePrincipals; diff --git a/azd/src/main/java/org/azd/helpers/HelpersRequestBuilder.java b/azd/src/main/java/org/azd/helpers/HelpersRequestBuilder.java index 71e3a61b..a2132336 100644 --- a/azd/src/main/java/org/azd/helpers/HelpersRequestBuilder.java +++ b/azd/src/main/java/org/azd/helpers/HelpersRequestBuilder.java @@ -3,6 +3,7 @@ import org.azd.abstractions.BaseRequestBuilder; import org.azd.authentication.AccessTokenCredential; import org.azd.common.ResourceId; +import org.azd.exceptions.AzDException; import org.azd.helpers.artifactspackagetypes.ArtifactsPackageTypesHelpersRequestBuilder; import org.azd.helpers.build.BuildHelpersRequestBuilder; import org.azd.helpers.featuremanagement.FeatureManagementHelpersRequestBuilder; @@ -123,6 +124,10 @@ public WorkItemTrackingHelpersRequestBuilder workItemTracking() { */ private String getLocationUrl(String resourceId) { var builder = new LocationsBaseRequestBuilder(organizationUrl, accessTokenCredential); - return builder.getUrl(resourceId); + try { + return builder.getUrl(resourceId); + } catch (AzDException e) { + throw new RuntimeException(e); + } } } diff --git a/azd/src/main/java/org/azd/helpers/artifactspackagetypes/ArtifactsPackageTypesHelpersRequestBuilder.java b/azd/src/main/java/org/azd/helpers/artifactspackagetypes/ArtifactsPackageTypesHelpersRequestBuilder.java index 63ee6ba0..6f22f473 100644 --- a/azd/src/main/java/org/azd/helpers/artifactspackagetypes/ArtifactsPackageTypesHelpersRequestBuilder.java +++ b/azd/src/main/java/org/azd/helpers/artifactspackagetypes/ArtifactsPackageTypesHelpersRequestBuilder.java @@ -1,21 +1,11 @@ package org.azd.helpers.artifactspackagetypes; -import org.azd.abstractions.internals.LocationService; import org.azd.artifactspackagetypes.ArtifactsPackageTypesRequestBuilder; import org.azd.authentication.AccessTokenCredential; -import org.azd.common.ApiVersion; -import org.azd.common.Constants; -import org.azd.enums.Instance; -import org.azd.enums.RequestMethod; import org.azd.exceptions.AzDException; import org.azd.utils.PathBuilder; import java.io.InputStream; -import java.net.http.HttpRequest; -import java.net.http.HttpResponse; -import java.util.Map; - -import static org.azd.utils.RestClient.send; /** * Helper request builder that combines multiple Apis to create logical helper methods for ease of use. diff --git a/azd/src/main/java/org/azd/helpers/release/ReleaseHelpersRequestBuilder.java b/azd/src/main/java/org/azd/helpers/release/ReleaseHelpersRequestBuilder.java index 116e2178..edf70d5e 100644 --- a/azd/src/main/java/org/azd/helpers/release/ReleaseHelpersRequestBuilder.java +++ b/azd/src/main/java/org/azd/helpers/release/ReleaseHelpersRequestBuilder.java @@ -2,7 +2,6 @@ import org.azd.authentication.AccessTokenCredential; import org.azd.enums.EnvironmentStatus; -import org.azd.enums.ReleaseEnvironmentStatus; import org.azd.exceptions.AzDException; import org.azd.release.ReleaseBaseRequestBuilder; import org.azd.release.types.ReleaseEnvironment; diff --git a/azd/src/main/java/org/azd/http/ClientRequest.java b/azd/src/main/java/org/azd/http/ClientRequest.java index b5348aa6..b3bc4ffa 100644 --- a/azd/src/main/java/org/azd/http/ClientRequest.java +++ b/azd/src/main/java/org/azd/http/ClientRequest.java @@ -59,35 +59,31 @@ public static ClientRequest.Builder builder() { * * @param model Represents the entity or model for which the response should be deserialized to. * @return Deserialized POJO model of future object. - * @throws AzDException Default Api exception handler. */ - public abstract CompletableFuture executeAsync(Class model) throws AzDException; + public abstract CompletableFuture executeAsync(Class model); /** * Executes the request built by ClientRequest.Builder and returns the response. * * @return Future string object. - * @throws AzDException Default Api exception handler. */ - public abstract CompletableFuture executeStringAsync() throws AzDException; + public abstract CompletableFuture executeStringAsync(); /** * Executes the request built by ClientRequest.Builder and return the input stream of object. If this is meant to be * a zip file or any kind of stream, use {@link org.azd.helpers.StreamHelper} to download or convert the contents. * * @return Input stream object. - * @throws AzDException Default Api exception handler. */ - public abstract CompletableFuture executeStreamAsync() throws AzDException; + public abstract CompletableFuture executeStreamAsync(); /** * Executes the request built by ClientRequest.Builder and doesn't return any response. This is mainly used for Api calls * that returns 201 or any operation that doesn't return response. * * @return Future void. - * @throws AzDException Default Api exception handler. */ - public abstract CompletableFuture executePrimitiveAsync() throws AzDException; + public abstract CompletableFuture executePrimitiveAsync(); /** * Executes the request built by ClientRequest.Builder and returns the response. diff --git a/azd/src/main/java/org/azd/interfaces/AccountsDetails.java b/azd/src/main/java/org/azd/interfaces/AccountsDetails.java deleted file mode 100644 index 783dc5de..00000000 --- a/azd/src/main/java/org/azd/interfaces/AccountsDetails.java +++ /dev/null @@ -1,16 +0,0 @@ -package org.azd.interfaces; - -import org.azd.accounts.types.Accounts; -import org.azd.accounts.types.Organizations; -import org.azd.accounts.types.Profile; -import org.azd.exceptions.AzDException; - -public interface AccountsDetails { - Accounts getAccounts(String memberId) throws AzDException; - - Organizations getOrganizations() throws AzDException; - - Profile getProfile() throws AzDException; - - Profile getProfile(String id) throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/AzDClient.java b/azd/src/main/java/org/azd/interfaces/AzDClient.java deleted file mode 100644 index 1b8d9704..00000000 --- a/azd/src/main/java/org/azd/interfaces/AzDClient.java +++ /dev/null @@ -1,82 +0,0 @@ -package org.azd.interfaces; - -import org.azd.accounts.AccountsApi; -import org.azd.build.BuildApi; -import org.azd.connection.Connection; -import org.azd.core.CoreApi; -import org.azd.distributedtask.DistributedTaskApi; -import org.azd.extensionmanagement.ExtensionManagementApi; -import org.azd.feedmanagement.FeedManagementApi; -import org.azd.git.GitApi; -import org.azd.graph.GraphApi; -import org.azd.maven.MavenApi; -import org.azd.memberentitlementmanagement.MemberEntitlementManagementApi; -import org.azd.oauth.OAuthApi; -import org.azd.oauth.types.AuthorizedToken; -import org.azd.pipelines.PipelinesApi; -import org.azd.policy.PolicyApi; -import org.azd.release.ReleaseApi; -import org.azd.security.SecurityApi; -import org.azd.serviceendpoint.ServiceEndpointApi; -import org.azd.servicehooks.ServiceHooksApi; -import org.azd.test.TestApi; -import org.azd.upack.UPackApi; -import org.azd.wiki.WikiApi; -import org.azd.work.WorkApi; -import org.azd.workitemtracking.WorkItemTrackingApi; - -public interface AzDClient { - AccountsDetails getAccountsApi(); - - BuildDetails getBuildApi(); - - CoreDetails getCoreApi(); - - DistributedTaskDetails getDistributedTaskApi(); - - FeedManagementDetails getFeedManagementApi(); - - GitDetails getGitApi(); - - GraphDetails getGraphApi(); - - MavenDetails getMavenApi(); - - MemberEntitlementManagementDetails getMemberEntitlementManagementApi(); - - ReleaseDetails getReleaseApi(); - - ServiceHooksDetails getServiceHooksApi(); - - WikiDetails getWikiApi(); - - WorkDetails getWorkApi(); - - WorkItemTrackingDetails getWorkItemTrackingApi(); - - OAuthApi getOAuth(); - - ServiceEndpointDetails getServiceEndpointApi(); - - ExtensionManagementDetails getExtensionManagementApi(); - - PolicyDetails getPolicyApi(); - - PipelinesDetails getPipelinesApi(); - - UpackDetails getUPackApi(); - - SecurityDetails getSecurityApi(); - - TestDetails getTestApi(); - - void setProject(String project); - - String getOrganization(); - - void setOrganization(String org); - - void setOauthToken(AuthorizedToken token); - - Connection getConnection(); -} diff --git a/azd/src/main/java/org/azd/interfaces/BuildDetails.java b/azd/src/main/java/org/azd/interfaces/BuildDetails.java deleted file mode 100644 index 0066e13c..00000000 --- a/azd/src/main/java/org/azd/interfaces/BuildDetails.java +++ /dev/null @@ -1,181 +0,0 @@ -package org.azd.interfaces; - -import org.azd.build.types.*; -import org.azd.enums.*; -import org.azd.exceptions.AzDException; - -import java.io.InputStream; -import java.util.List; - -public interface BuildDetails { - Void deleteBuild(int buildId) throws AzDException; - - Build getBuild(int buildId) throws AzDException; - - BuildChanges getBuildChanges(int buildId) throws AzDException; - - BuildChanges getBuildChanges( - int buildId, int top, String continuationToken, boolean includeSourceChange) throws AzDException; - - String getBuildLog(int buildId, int logId) throws AzDException; - - String getBuildLog(int buildId, int logId, long startLine, long endLine) throws AzDException; - - BuildLogs getBuildLogs(int buildId) throws AzDException; - - BuildWorkItems getBuildWorkItems(int buildId) throws AzDException; - - BuildWorkItems getBuildWorkItems(int buildId, int top) throws AzDException; - - BuildChanges getChangesBetweenBuilds(int fromBuildId, int toBuildId, int top) throws AzDException; - - BuildWorkItems getWorkItemsBetweenBuilds(int fromBuildId, int toBuildId, int top) throws AzDException; - - Builds getBuilds() throws AzDException; - - Builds getBuilds(int[] buildIds) throws AzDException; - - Builds getBuilds(int top) throws AzDException; - - Builds getBuilds( - int top, String branchName, String buildNumber, String continuationToken, int[] definitions, - QueryDeletedOption deletedFilter, int maxBuildsPerDefinition, String maxTime, String minTime, - String[] properties, BuildQueryOrder queryOrder, int[] queues, BuildReason reasonFilter, - String repositoryId, String repositoryType, String requestedFor, BuildResult resultFilter, - BuildStatus statusFilter, String tagFilters) throws AzDException; - - Build queueBuild(int definitionId) throws AzDException; - - Build queueBuild(Build buildParameters) throws AzDException; - - Build updateBuild(Build build, int buildId, boolean retry) throws AzDException; - - Builds updateBuilds(Builds builds) throws AzDException; - - BuildControllers getBuildControllers() throws AzDException; - - BuildControllers getBuildControllers(String name) throws AzDException; - - BuildController getBuildController(int controllerId) throws AzDException; - - BuildDefinition createBuildDefinition(String buildDefinitionParameters) throws AzDException; - - BuildDefinition createBuildDefinition(BuildDefinition buildDefinition, Number definitionToCloneId, Number definitionToCloneRevision) throws AzDException; - - BuildDefinition cloneBuildDefinition(String definitionName, String definitionCloneName) throws AzDException; - - Void deleteBuildDefinition(int definitionId) throws AzDException; - - BuildDefinition getBuildDefinition(int definitionId) throws AzDException; - - BuildDefinition getBuildDefinition( - int definitionId, boolean includeLatestBuilds, String minMetricsTime, int revision) throws AzDException; - - BuildDefinitionRevisions getBuildDefinitionRevisions(int definitionId) throws AzDException; - - BuildDefinitions getBuildDefinitions() throws AzDException; - - BuildDefinitions getBuildDefinitions(int[] definitionIds) throws AzDException; - - BuildDefinitions getBuildDefinitions(int top) throws AzDException; - - BuildDefinitions getBuildDefinitions(String name) throws AzDException; - - BuildDefinitions getBuildDefinitions(boolean includeAllProperties, boolean includeLatestBuilds) throws AzDException; - - BuildDefinitions getBuildDefinitions( - String builtAfter, String continuationToken, boolean includeAllProperties, - boolean includeLatestBuilds, String minMetricsTime, String notBuiltAfter, - String path, int processType, DefinitionQueryOrder queryOrder, String repositoryId, - String repositoryType, String taskIdFilter, String yamlFilename) throws AzDException; - - BuildDefinition restoreBuildDefinition(int definitionId, boolean deleted) throws AzDException; - - BuildDefinition updateBuildDefinition(BuildDefinition definition) throws AzDException; - - BuildDefinition updateBuildDefinition(BuildDefinition definition, Number secretsSourceDefinitionId, - Number secretsSourceDefinitionRevision) throws AzDException; - - Folder createFolder(String path, Folder folder) throws AzDException; - - Void deleteFolder(String path) throws AzDException; - - Folders getFolders() throws AzDException; - - Folders getFolders(String path, FolderQueryOrder queryOrder) throws AzDException; - - Folder updateFolder(String path, Folder folder) throws AzDException; - - BuildTags addBuildTag(int buildId, String tag) throws AzDException; - - BuildTags addBuildTags(int buildId, List tags) throws AzDException; - - BuildTags addDefinitionTag(int definitionId, String tag) throws AzDException; - - BuildTags addDefinitionTags(int definitionId, List tags) throws AzDException; - - BuildTags deleteBuildTag(int buildId, String tag) throws AzDException; - - BuildTags deleteDefinitionTag(int definitionId, String tag) throws AzDException; - - BuildTags deleteTag(String tag) throws AzDException; - - BuildTags getBuildTags(int buildId) throws AzDException; - - BuildTags getDefinitionTags(int definitionId) throws AzDException; - - BuildTags getDefinitionTags(int definitionId, int revision) throws AzDException; - - BuildTags getTags() throws AzDException; - - BuildTags updateBuildTags(int buildId, List tags, boolean toRemove) throws AzDException; - - BuildTags updateDefinitionTags(int definitionId, List tags, boolean toRemove) throws AzDException; - - YamlBuild getYaml(int definitionId) throws AzDException; - - YamlBuild getYaml(int definitionId, boolean includeLatestBuilds, String minMetricsTime, - String[] propertyFilters, Number revision) throws AzDException; - - Void updateBuildStage(int buildId, String stageReferenceName, boolean forceRetryAllJobs, StageUpdateType state) throws AzDException; - - String getFileContents(String providerName, String serviceEndpointId, String repositoryName, String branchName, String path) throws AzDException; - - SourceRepositoryItems getPathContents(String providerName, String serviceEndpointId, String repositoryName, String branchName, String filePath) throws AzDException; - - SourceProviderPullRequest getPullRequest(String providerName, String pullRequestId, String repositoryName, String serviceEndpointId) throws AzDException; - - SourceProviderAttributes getSourceProviders() throws AzDException; - - SourceProviderBranches getBranches(String providerName, String serviceEndpointId, String repositoryName) throws AzDException; - - SourceProviderBranches getBranches(String providerName, String serviceEndpointId, String repositoryName, String branchName) throws AzDException; - - SourceRepositories getRepositories(String providerName, String serviceEndpointId) throws AzDException; - - SourceRepositories getRepositories(String providerName, String serviceEndpointId, String repositoryName) throws AzDException; - - SourceRepositories getRepositories(String providerName, String serviceEndpointId, String repositoryName, String continuationToken, boolean pageResults, SourceProviderResultSet resultSet) throws AzDException; - - RepositoryWebhooks getWebHooks(String providerName, String serviceEndpointId, String repositoryName) throws AzDException; - - Void restoreWebHooks(String providerName, String serviceEndpointId, String repositoryName, List triggerTypes) throws AzDException; - - Timeline getTimeline(int buildId) throws AzDException; - - Timeline getTimeline(int buildId, String timelineId) throws AzDException; - - Timeline getTimeline(int buildId, String timelineId, int changeId, String planId) throws AzDException; - - BuildArtifact createArtifact(int buildId, BuildArtifact artifact) throws AzDException; - - BuildArtifact getArtifact(int buildId, String artifactName) throws AzDException; - - InputStream getArtifactAsZip(int buildId, String artifactName) throws AzDException; - - InputStream getArtifactFile(int buildId, String artifactName, String fileId, String fileName) throws AzDException; - - BuildArtifacts getArtifacts(int buildId) throws AzDException; - - Attachments getAttachments(int buildId, String type) throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/CoreDetails.java b/azd/src/main/java/org/azd/interfaces/CoreDetails.java deleted file mode 100644 index f2acbf67..00000000 --- a/azd/src/main/java/org/azd/interfaces/CoreDetails.java +++ /dev/null @@ -1,50 +0,0 @@ -package org.azd.interfaces; - -import org.azd.core.types.*; -import org.azd.enums.FeatureManagement; -import org.azd.enums.ProjectState; -import org.azd.exceptions.AzDException; - -import java.util.Optional; - -public interface CoreDetails { - Processes getProcesses() throws AzDException; - - OperationReference createProject(String projectName, String description) throws AzDException; - - OperationReference createProject(String projectName, String description, String sourceControlType, - String templateTypeId) throws AzDException; - - OperationReference deleteProject(String projectId) throws AzDException; - - Project getProject(String projectName) throws AzDException; - - Project getProject(String projectName, boolean includeCapabilities, boolean includeHistory) throws AzDException; - - ProjectProperties getProjectProperties(String projectId) throws AzDException; - - Projects getProjects() throws AzDException; - - Projects getProjects(Integer skip, Integer top, Number continuationToken, - Boolean getDefaultTeamImageUrl, ProjectState stateFilter) throws AzDException; - - OperationReference updateProject(String projectId, Project projectParameters) throws AzDException; - - WebApiTeam createTeam(String projectName, String teamName) throws AzDException; - - Void deleteTeam(String projectName, String teamName) throws AzDException; - - WebApiTeam getTeam(String projectName, String teamName) throws AzDException; - - WebApiTeam getTeam(String projectName, String teamName, boolean expandIdentity) throws AzDException; - - WebApiTeams getTeams() throws AzDException; - - WebApiTeams getTeams(boolean expandIdentity, boolean mine, int skip, int top) throws AzDException; - - WebApiTeam updateTeams(String projectName, String teamName, String description) throws AzDException; - - Optional getFeatureState(String projectId, FeatureManagement feature) throws AzDException; - - ProjectFeature featureToggle(String projectId, FeatureManagement feature, boolean state) throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/DistributedTaskDetails.java b/azd/src/main/java/org/azd/interfaces/DistributedTaskDetails.java deleted file mode 100644 index c6ae3354..00000000 --- a/azd/src/main/java/org/azd/interfaces/DistributedTaskDetails.java +++ /dev/null @@ -1,87 +0,0 @@ -package org.azd.interfaces; - -import org.azd.distributedtask.types.*; -import org.azd.enums.*; -import org.azd.exceptions.AzDException; - -public interface DistributedTaskDetails { - Void deleteAgent(int poolId, int agentId) throws AzDException; - - TaskAgent getAgent(int poolId, int agentId) throws AzDException; - - TaskAgent getAgent(int poolId, int agentId, boolean includeAssignedRequest, boolean includeCapabilities, - boolean includeLastCompletedRequest, String[] propertyFilters) throws AzDException; - - TaskAgents getAgents(int poolId) throws AzDException; - - TaskAgents getAgents(int poolId, String agentName, String[] demands, boolean includeAssignedRequest, boolean includeCapabilities, - boolean includeLastCompletedRequest, String[] propertyFilters) throws AzDException; - - TaskAgent updateAgent(int poolId, int agentId, TaskAgent requestBody) throws AzDException; - - DeploymentGroup addDeploymentGroup(String name, String description) throws AzDException; - - DeploymentGroup addDeploymentGroup(String name, String description, int poolId) throws AzDException; - - Void deleteDeploymentGroup(int deploymentGroupId) throws AzDException; - - DeploymentGroup getDeploymentGroup(int deploymentGroupId) throws AzDException; - - DeploymentGroup getDeploymentGroup(int deploymentGroupId, DeploymentGroupExpands expand, DeploymentGroupActionFilter actionFilter) - throws AzDException; - - DeploymentGroups getDeploymentGroups() throws AzDException; - - DeploymentGroups getDeploymentGroups(int top) throws AzDException; - - DeploymentGroups getDeploymentGroups(int[] ids) throws AzDException; - - DeploymentGroups getDeploymentGroups(String name) throws AzDException; - - DeploymentGroups getDeploymentGroups(DeploymentGroupExpands expand) throws AzDException; - - DeploymentGroups getDeploymentGroups(DeploymentGroupExpands expand, int top, DeploymentGroupActionFilter actionFilter, - String continuationToken, int[] ids, String name) - throws AzDException; - - DeploymentGroup updateDeploymentGroup(int deploymentGroupId, String name, String description) throws AzDException; - - EnvironmentInstance addEnvironment(String name, String description) throws AzDException; - - Void deleteEnvironment(int environmentId) throws AzDException; - - EnvironmentInstance getEnvironment(int environmentId) throws AzDException; - - EnvironmentInstance getEnvironment(int environmentId, EnvironmentExpands expands) throws AzDException; - - EnvironmentInstances getEnvironments() throws AzDException; - - EnvironmentInstances getEnvironments(int top) throws AzDException; - - EnvironmentInstances getEnvironments(String name) throws AzDException; - - EnvironmentInstances getEnvironments(int top, String continuationToken, String name) throws AzDException; - - EnvironmentInstance updateEnvironment(int environmentId, String name, String description) throws AzDException; - - VariableGroup addVariableGroup(VariableGroupDefinition variableGroupDefinition) throws AzDException; - - VariableGroup addVariableGroup(String name, String description, VariableGroupMap variables) throws AzDException; - - Void deleteVariableGroup(int variableGroupId, String[] projectIds) throws AzDException; - - VariableGroup getVariableGroup(int variableGroupId) throws AzDException; - - VariableGroups getVariableGroups() throws AzDException; - - VariableGroups getVariableGroups(int top) throws AzDException; - - VariableGroups getVariableGroups(String groupName) throws AzDException; - - VariableGroups getVariableGroups(int top, VariableGroupActionFilter actionFilter, int continuationToken, - String groupName, VariableGroupQueryOrder queryOrder) throws AzDException; - - VariableGroup updateVariableGroup(int groupId, String name, String description, VariableGroupMap variables) throws AzDException; - - VariableGroup updateVariableGroup(int groupId, VariableGroupDefinition variableGroupDefinition) throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/ExtensionManagementDetails.java b/azd/src/main/java/org/azd/interfaces/ExtensionManagementDetails.java deleted file mode 100644 index 287c46dd..00000000 --- a/azd/src/main/java/org/azd/interfaces/ExtensionManagementDetails.java +++ /dev/null @@ -1,23 +0,0 @@ -package org.azd.interfaces; - -import org.azd.enums.ExtensionStateFlags; -import org.azd.exceptions.AzDException; -import org.azd.extensionmanagement.types.InstalledExtension; -import org.azd.extensionmanagement.types.InstalledExtensions; - -public interface ExtensionManagementDetails { - InstalledExtension getExtension(String extensionId, String publisherId) throws AzDException; - - InstalledExtension getExtension(String extensionId, String publisherId, String[] assetTypes) throws AzDException; - - InstalledExtensions getExtensions() throws AzDException; - - InstalledExtension installExtension(String publisherId, String extensionId, String version) throws AzDException; - - Void uninstallExtension(String publisherId, String extensionId) throws AzDException; - - Void uninstallExtension(String publisherId, String extensionId, String reason, String reasonCode) throws AzDException; - - InstalledExtension updateExtension(String publisherId, String extensionId, ExtensionStateFlags extensionState) - throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/FeedManagementDetails.java b/azd/src/main/java/org/azd/interfaces/FeedManagementDetails.java deleted file mode 100644 index 04481bbf..00000000 --- a/azd/src/main/java/org/azd/interfaces/FeedManagementDetails.java +++ /dev/null @@ -1,45 +0,0 @@ -package org.azd.interfaces; - -import org.azd.enums.FeedRole; -import org.azd.enums.FeedViewType; -import org.azd.enums.FeedVisibility; -import org.azd.exceptions.AzDException; -import org.azd.feedmanagement.types.*; - -public interface FeedManagementDetails { - Feed createFeed( - String name, String description, boolean badgesEnabled, - boolean hideDeletedPackageVersions) throws AzDException; - - FeedView createFeedView(String feedName, String name, FeedViewType feedViewType, FeedVisibility visibility) throws AzDException; - - Void deleteFeed(String feedId) throws AzDException; - - Void deleteFeedView(String feedId, String feedViewId) throws AzDException; - - Feed getFeed(String feedName) throws AzDException; - - Feed getFeed(String feedName, boolean includeDeletedUpstreams) throws AzDException; - - FeedPermissions getFeedPermissions(String feedName) throws AzDException; - - FeedPermissions getFeedPermissions( - String feedName, boolean excludeInheritedPermissions, String identityDescriptor, - boolean includeDeletedFeeds, boolean includeIds) throws AzDException; - - FeedView getFeedView(String feedName, String feedViewId) throws AzDException; - - FeedViews getFeedViews(String feedName) throws AzDException; - - Feeds getFeeds() throws AzDException; - - Feeds getFeeds( - FeedRole feedRole, boolean includeDeletedUpstreams, - boolean includeUrls) throws AzDException; - - FeedPermissions setFeedPermissions(String feedId, FeedPermissions feedPermissions) throws AzDException; - - Feed updateFeed(String feedId, Feed feed) throws AzDException; - - FeedView updateFeedView(String feedName, String feedViewName, FeedView feedView) throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/GitDetails.java b/azd/src/main/java/org/azd/interfaces/GitDetails.java deleted file mode 100644 index 25fac3b3..00000000 --- a/azd/src/main/java/org/azd/interfaces/GitDetails.java +++ /dev/null @@ -1,222 +0,0 @@ -package org.azd.interfaces; - -import org.azd.common.types.JsonPatchDocument; -import org.azd.enums.*; -import org.azd.exceptions.AzDException; -import org.azd.git.types.*; - -import java.io.InputStream; -import java.util.List; - -public interface GitDetails { - - GitRepository createRepository(String repositoryName, String projectId) throws AzDException; - - Void deleteRepository(String repositoryId) throws AzDException; - - Void deleteRepositoryFromRecycleBin(String repositoryId) throws AzDException; - - GitDeletedRepositories getDeletedRepositories() throws AzDException; - - GitDeletedRepositories getRecycleBinRepositories() throws AzDException; - - GitRepository getRepository(String repositoryName) throws AzDException; - - Repositories getRepositories() throws AzDException; - - Repositories getRepositories(boolean includeHidden) throws AzDException; - - Repositories getRepositories(boolean includeLinks, boolean includeAllUrls) throws AzDException; - - Repositories getRepositories(boolean includeAllUrls, boolean includeLinks, boolean includeHidden) throws AzDException; - - GitRepository restoreRepositoryFromRecycleBin(String repositoryId, boolean deleted) throws AzDException; - - GitRepository updateRepository(String repositoryId, String repositoryName, String defaultBranchName) - throws AzDException; - - GitPullRequest createPullRequest(String repositoryId, String sourceRefName, String targetRefName, String title, - String description, String[] reviewers) throws AzDException; - - GitPullRequest createPullRequest(String repositoryId, String sourceRefName, String targetRefName, String title, - String description, boolean isDraft) throws AzDException; - - GitPullRequest createPullRequest(GitPullRequest gitPullRequest) throws AzDException; - - GitPullRequest getPullRequest(String repositoryName, int pullRequestId) throws AzDException; - - GitPullRequest getPullRequest(String repositoryName, int pullRequestId, boolean includeCommits) throws AzDException; - - GitPullRequest getPullRequest(String repositoryName, int pullRequestId, boolean includeCommits, boolean includeWorkItemRefs) - throws AzDException; - - GitPullRequest getPullRequestById(int pullRequestId) throws AzDException; - - PullRequests getPullRequests(String repositoryName) throws AzDException; - - PullRequests getPullRequests(String repositoryName, int top) throws AzDException; - - PullRequests getPullRequests(String repositoryName, int top, int skip) throws AzDException; - - PullRequests getPullRequests(String repositoryName, int top, int skip, String creatorId) - throws AzDException; - - PullRequests getPullRequests(String repositoryName, boolean includeLinks) throws AzDException; - - PullRequests getPullRequests(String repositoryName, PullRequestStatus status) throws AzDException; - - PullRequests getPullRequests(String repositoryName, GitPullRequestQueryParameters gitPullRequestQueryParameters) - throws AzDException; - - PullRequests getPullRequestsByProject() throws AzDException; - - PullRequests getPullRequestsByProject(int top) throws AzDException; - - PullRequests getPullRequestsByProject(PullRequestStatus status) throws AzDException; - - GitPullRequest updatePullRequest(String repositoryId, int pullRequestId, Object body) throws AzDException; - - PullRequests getPullRequestsByProject(int skip, int top, String creatorId, boolean includeLinks, - String repositoryId, String reviewerId, String sourceRefName, String sourceRepositoryId, - PullRequestStatus status, String targetRefName) throws AzDException; - - GitRef getBranch(String repositoryName, String branchName) throws AzDException; - - GitRefs getBranches(String repositoryName) throws AzDException; - - GitRef updateBranchLock(String repositoryName, String branchName, boolean isLocked) throws AzDException; - - ResourceRefs getPullRequestWorkItems(int pullRequestId, String repositoryName) throws AzDException; - - WebApiTagDefinition createPullRequestLabel(String repositoryName, int pullRequestId, String labelName) - throws AzDException; - - Void deletePullRequestLabel(String repositoryName, int pullRequestId, String labelName) throws AzDException; - - WebApiTagDefinition getPullRequestLabel(String repositoryName, int pullRequestId, String labelName) - throws AzDException; - - WebApiTagDefinitions getPullRequestLabels(String repositoryName, int pullRequestId) throws AzDException; - - IdentityRefWithVote createPullRequestReviewer(int pullRequestId, String repositoryId, String reviewerId, int vote, - boolean isRequired) throws AzDException; - - Void deletePullRequestReviewer(int pullRequestId, String repositoryId, String reviewerId) throws AzDException; - - IdentityRefWithVote getPullRequestReviewer(int pullRequestId, String repositoryId, String reviewerId) - throws AzDException; - - PullRequestReviewers getPullRequestReviewers(int pullRequestId, String repositoryId) throws AzDException; - - IdentityRefWithVote updatePullRequestReviewer(int pullRequestId, String repositoryId, String reviewerId, - boolean isFlagged, boolean hasDeclined) throws AzDException; - - GitAnnotatedTag createAnnotatedTag(String repositoryName, String tagName, String objectId, String message) - throws AzDException; - - GitAnnotatedTag getAnnotatedTag(String repositoryName, String objectId) throws AzDException; - - GitCommit getCommit(String repositoryName, String commitId) throws AzDException; - - GitCommit getCommit(String repositoryName, String commitId, int changeCount) throws AzDException; - - GitCommitChanges getChanges(String repositoryName, String commitId) throws AzDException; - - GitCommitChanges getChanges(String repositoryName, String commitId, int top, int skip) throws AzDException; - - GitCommits getCommits(String repositoryName) throws AzDException; - - GitCommits getCommits(String repositoryName, int top) throws AzDException; - - GitCommits getCommits(String repositoryName, List ids) throws AzDException; - - GitCommits getCommits(String repositoryName, int top, int skip, String author, String version, - GitVersionOptions versionOptions, GitVersionType versionType, boolean excludeDeletes, String fromCommitId, - String toCommitId, String fromDate, String toDate, GitHistoryMode historyMode, List ids, - boolean includeLinks, boolean includePushData, boolean includeUserImageUrl, boolean includeWorkItems, - String itemPath, boolean showOldestCommitsFirst, String user, String itemVersion, - GitVersionOptions itemVersionOptions, GitVersionType itemVersionType) throws AzDException; - - GitCommits getPushCommits(String repositoryName, int pushId) throws AzDException; - - GitCommits getPushCommits(String repositoryName, int pushId, boolean includeLinks, int top, int skip) - throws AzDException; - - GitCommitRefs getCommitsBatch(String repositoryId, GitCommitsBatch gitCommitsBatch) throws AzDException; - - GitRefs getRefs(String repositoryName) throws AzDException; - - GitRefs getRefs(String repositoryName, String filter) throws AzDException; - - GitRefUpdateResult updateRef(String repositoryName, String refName, String oldObjectId, String newObjectId) throws AzDException; - - GitRefUpdateResult createTag(String repositoryName, String tagName, String ref) throws AzDException; - - GitRefUpdateResult deleteTag(String repositoryName, String tagName) throws AzDException; - - - GitBlobRef getBlob(String repositoryId, String sha1) throws AzDException; - - GitBlobRef getBlob(String repositoryId, String sha1, String fileName, boolean resolveLfs) throws AzDException; - - String getBlobContent(String repositoryId, String sha1, boolean download, String fileName, boolean resolveLfs) throws AzDException; - - InputStream getBlobContentAsZip(String repositoryId, String sha1, boolean download, String fileName, boolean resolveLfs) throws AzDException; - - InputStream getBlobContentAsStream(String repositoryId, String sha1, boolean download, String fileName, boolean resolveLfs) throws AzDException; - - InputStream getBlobsZip(String repositoryId, List sha1) throws AzDException; - - InputStream getBlobsZip(String repositoryId, String fileName, List sha1) throws AzDException; - - GitItems getItems(String repositoryName) throws AzDException; - - GitItems getItems(String repositoryName, VersionControlRecursionType recursionType) throws AzDException; - - GitItems getItems(String repositoryName, boolean includeContentMetadata, boolean includeLinks, boolean latestProcessedChange, - VersionControlRecursionType recursionType, String scopePath) throws AzDException; - - GitItems getItems(String repositoryName, boolean includeContentMetadata, boolean includeLinks, boolean latestProcessedChange, - VersionControlRecursionType recursionType, String scopePath, String version, - GitVersionOptions versionOptions, GitVersionType versionType) throws AzDException; - - GitForkSyncRequest createForkSyncRequest(String repositoryName, String sourceCollectionId, String sourceProjectId, String sourceRepositoryId, - Boolean includeLinks) throws AzDException; - - GitForkSyncRequest createForkSyncRequest(String repositoryName, String collectionId, String projectId, String repositoryId, - String sourceRef, String targetRef, Boolean includeLinks) throws AzDException; - - GitRepository createForkRepository(String repositoryName, String projectId, String parentProjectId, String parentRepositoryId) throws AzDException; - - GitRepository createForkRepository(String repositoryName, String projectId, String parentProjectId, String parentRepositoryId, String sourceBranch) throws AzDException; - - GitRepository createForkRepositoryWithComplete(String repositoryName, String projectId, String parentProjectId, String parentRepositoryId, String sourceBranch, int checkTimes) throws AzDException; - - GitForkSyncRequest getForkSyncRequest(String repositoryName, int OperationId, boolean includeLinks) throws AzDException; - - GitForkSyncRequests getForkSyncRequests(String repositoryName, boolean includeLinks, boolean includeAbandoned) throws AzDException; - - GitRepositoryRefs getForks(String repositoryName, String collectionId, boolean includeLinks) throws AzDException; - - GitPush createPush(String repositoryId, GitPush gitPush) throws AzDException; - - GitPush getPush(String repositoryId, int pushId) throws AzDException; - - GitPush getPush(String repositoryId, int pushId, int includeCommits) throws AzDException; - - GitPush getPush(String repositoryId, int pushId, boolean includeRefUpdates) throws AzDException; - - GitPush getPush(String repositoryId, int pushId, int includeCommits, boolean includeRefUpdates) throws AzDException; - - GitPushes getPushes(String repositoryId) throws AzDException; - - GitStatus createPullRequestStatus(int pullRequestId, String repositoryId, GitStatus gitPullRequestStatus) throws AzDException; - - Void deletePullRequestStatus(int pullRequestId, String repositoryId, int statusId) throws AzDException; - - GitStatus getPullRequestStatus(int pullRequestId, String repositoryId, int statusId) throws AzDException; - - GitStatuses getPullRequestStatuses(int pullRequestId, String repositoryId) throws AzDException; - - Void updatePullRequestStatuses(int pullRequestId, String repositoryId, List propertiesToUpdate) throws AzDException; -} \ No newline at end of file diff --git a/azd/src/main/java/org/azd/interfaces/GraphDetails.java b/azd/src/main/java/org/azd/interfaces/GraphDetails.java deleted file mode 100644 index 3d11c383..00000000 --- a/azd/src/main/java/org/azd/interfaces/GraphDetails.java +++ /dev/null @@ -1,40 +0,0 @@ -package org.azd.interfaces; - -import org.azd.exceptions.AzDException; -import org.azd.graph.types.*; - -public interface GraphDetails { - GraphUser createUser(String emailId, String userDescriptor) throws AzDException; - - GraphUser addUserToGroup(String emailId, String groupDescriptor) throws AzDException; - - Void deleteUser(String userDescriptor) throws AzDException; - - GraphUser getUser(String userDescriptor) throws AzDException; - - GraphUsers getUsers() throws AzDException; - - GraphUsers getUsers(String continuationToken, String scopeDescriptor, String subjectTypes) throws AzDException; - - GraphGroup getGroup(String groupDescriptor) throws AzDException; - - GraphGroups getGroups() throws AzDException; - - GraphMemberships getGroupMembersOf(String groupDescriptor) throws AzDException; - - GraphMemberships getMemberOfGroups(String subjectDescriptor) throws AzDException; - - GraphMembership addMembership(String subjectDescriptor, String groupDescriptor) throws AzDException; - - Void removeMembership(String subjectDescriptor, String groupDescriptor) throws AzDException; - - GraphMembership createGroup(String displayName, String description) throws AzDException; - - GraphMembership createGroup(String displayName, String description, String projectDescriptor) throws AzDException; - - Void deleteGroup(String groupDescriptor) throws AzDException; - - GraphDescriptor getDescriptor(String storageKey) throws AzDException; - - SubjectLookupResponse subjectLookup(String... descriptors) throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/MavenDetails.java b/azd/src/main/java/org/azd/interfaces/MavenDetails.java deleted file mode 100644 index aef33f0c..00000000 --- a/azd/src/main/java/org/azd/interfaces/MavenDetails.java +++ /dev/null @@ -1,61 +0,0 @@ -package org.azd.interfaces; - -import org.azd.enums.PackagePromote; -import org.azd.enums.PackagesBatchOperation; -import org.azd.exceptions.AzDException; -import org.azd.maven.types.MavenPackageVersionDeletionState; -import org.azd.maven.types.Package; -import org.azd.maven.types.UpstreamingBehavior; - -import java.io.InputStream; -import java.util.List; -import java.util.Map; - -public interface MavenDetails { - Package getPackageVersion(String feedId, String groupId, String artifactId, String version) throws AzDException; - - Package getPackageVersion(String feedId, String groupId, String artifactId, String version, boolean showDeleted) - throws AzDException; - - MavenPackageVersionDeletionState getPackageVersionFromRecycleBin(String feedId, String groupId, - String artifactId, - String version) throws AzDException; - - UpstreamingBehavior getUpstreamingBehavior(String feedId, String groupId, String artifactId) - throws AzDException; - - InputStream downloadPackage(String feedId, String groupId, String artifactId, String version, String fileName) throws AzDException; - - void updatePackageVersion(String feedId, String groupId, String artifactId, String version, - PackagePromote promote) throws AzDException; - - void updatePackageVersion(String feedId, String groupId, String artifactId, String version, - String promote) throws AzDException; - - void updatePackageVersions(String feedId, String viewId, PackagesBatchOperation operation, List> packages) - throws AzDException; - - void updateRecycleBinPackages(String feedId, PackagesBatchOperation operation, List> packages) - throws AzDException; - - void deletePackageVersion(String feedId, String groupId, String artifactId, - String version) throws AzDException; - - void deletePackageVersionFromRecycleBin(String feedId, String groupId, String artifactId, String version) - throws AzDException; - - void restorePackageVersionFromRecycleBin(String feedId, String groupId, - String artifactId, String version) - throws AzDException; - - void setUpstreamingBehavior(String feedId, String groupId, String artifactId) - throws AzDException; - - void setUpstreamingBehavior(String feedId, String groupId, String artifactId, String upstreamingBehavior) - throws AzDException; - - void clearUpstreamingBehavior(String feedId, String groupId, String artifactId) throws AzDException; - - void uploadPackage(String feedId, String groupId, String artifactId, String version, String fileName, InputStream content) throws AzDException; - -} diff --git a/azd/src/main/java/org/azd/interfaces/MemberEntitlementManagementDetails.java b/azd/src/main/java/org/azd/interfaces/MemberEntitlementManagementDetails.java deleted file mode 100644 index 728f2eea..00000000 --- a/azd/src/main/java/org/azd/interfaces/MemberEntitlementManagementDetails.java +++ /dev/null @@ -1,37 +0,0 @@ -package org.azd.interfaces; - -import org.azd.enums.AccountLicenseType; -import org.azd.enums.GroupType; -import org.azd.enums.LicensingSource; -import org.azd.exceptions.AzDException; -import org.azd.memberentitlementmanagement.types.*; - -import java.util.List; - -public interface MemberEntitlementManagementDetails { - GroupEntitlements getGroupEntitlements() throws AzDException; - - GroupEntitlement getGroupEntitlement(String groupId) throws AzDException; - - UsersSummary getUserEntitlementSummary() throws AzDException; - - PagedGraphMemberList getMembers(String groupId) throws AzDException; - - PagedGraphMemberList getMembers(String groupId, int maxResults, String pagingToken) throws AzDException; - - Void removeMemberFromGroup(String groupId, String memberId) throws AzDException; - - UserEntitlementsResponse addUserEntitlement(AccountLicenseType accountLicenseType, String emailId, GroupType groupType, String projectId) - throws AzDException; - - Void deleteUserEntitlement(String userId) throws AzDException; - - UserEntitlement getUserEntitlement(String userId) throws AzDException; - - PagedGraphMemberList getUserEntitlements() throws AzDException; - - UserEntitlementsResponse updateUserEntitlement(String userId, List requestBody) throws AzDException; - - UserEntitlementsResponse updateUserEntitlement(String userId, AccountLicenseType accountLicenseType, LicensingSource licensingSource) - throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/PipelinesDetails.java b/azd/src/main/java/org/azd/interfaces/PipelinesDetails.java deleted file mode 100644 index a020bc96..00000000 --- a/azd/src/main/java/org/azd/interfaces/PipelinesDetails.java +++ /dev/null @@ -1,43 +0,0 @@ -package org.azd.interfaces; - -import org.azd.enums.PipelinesExpandOptions; -import org.azd.exceptions.AzDException; -import org.azd.pipelines.types.*; - -import java.util.Map; - -public interface PipelinesDetails { - PipelinesArtifact getArtifacts(int pipelineId, int runId, String artifactName) throws AzDException; - - PipelinesArtifact getArtifacts(int pipelineId, int runId, String artifactName, - PipelinesExpandOptions expandOptions) throws AzDException; - - PipelineLog getPipelineLog(int pipelineId, int runId, int logId) throws AzDException; - - PipelineLog getPipelineLog(int pipelineId, int runId, int logId, PipelinesExpandOptions expandOptions) throws AzDException; - - LogCollection getPipelineLogs(int pipelineId, int runId) throws AzDException; - - LogCollection getPipelineLogs(int pipelineId, int runId, PipelinesExpandOptions expandOptions) throws AzDException; - - Pipeline createPipeline(String name, String folder, String pathOfYamlFile, String repositoryId, String repositoryName) - throws AzDException; - - Pipeline getPipeline(int pipelineId) throws AzDException; - - Pipeline getPipeline(int pipelineId, String pipelineVersion) throws AzDException; - - Pipelines getPipelines() throws AzDException; - - PreviewRun previewPipeline(int pipelineId, boolean previewRun) throws AzDException; - - PreviewRun previewPipeline(int pipelineId, boolean previewRun, String yamlOverride) throws AzDException; - - PipelineRun getPipelineRun(int pipelineId, int runId) throws AzDException; - - PipelineRuns getPipelineRuns(int pipelineId) throws AzDException; - - PipelineRun runPipeline(int pipelineId) throws AzDException; - - PipelineRun runPipeline(int pipelineId, Map pipelineRunParameters) throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/PolicyDetails.java b/azd/src/main/java/org/azd/interfaces/PolicyDetails.java deleted file mode 100644 index 752aad74..00000000 --- a/azd/src/main/java/org/azd/interfaces/PolicyDetails.java +++ /dev/null @@ -1,28 +0,0 @@ -package org.azd.interfaces; - -import org.azd.exceptions.AzDException; -import org.azd.policy.types.PolicyConfiguration; -import org.azd.policy.types.PolicyConfigurations; -import org.azd.policy.types.PolicyType; -import org.azd.policy.types.PolicyTypes; - -import java.util.Map; - -public interface PolicyDetails { - PolicyConfiguration createPolicyConfiguration(String typeId, boolean isEnabled, boolean isBlocking, Map settings) throws AzDException; - - Void deletePolicyConfiguration(int configurationId) throws AzDException; - - PolicyConfiguration getPolicyConfiguration(int configurationId) throws AzDException; - - PolicyConfigurations getPolicyConfigurations() throws AzDException; - - PolicyConfigurations getPolicyConfigurations(int top, String continuationToken, String policyType) throws AzDException; - - PolicyConfiguration updatePolicyConfiguration(int configurationId, String typeId, boolean isEnabled, boolean isBlocking, Map settings) - throws AzDException; - - PolicyType getPolicyType(String typeId) throws AzDException; - - PolicyTypes getPolicyTypes() throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/ReleaseDetails.java b/azd/src/main/java/org/azd/interfaces/ReleaseDetails.java deleted file mode 100644 index da6f72ce..00000000 --- a/azd/src/main/java/org/azd/interfaces/ReleaseDetails.java +++ /dev/null @@ -1,107 +0,0 @@ -package org.azd.interfaces; - -import org.azd.distributedtask.types.VariableGroupMap; -import org.azd.enums.*; -import org.azd.exceptions.AzDException; -import org.azd.release.types.*; - -public interface ReleaseDetails { - Release createRelease(int releaseDefinitionId, String description, String artifactAlias, - String artifactId, String artifactName, - boolean isDraft) throws AzDException; - - Release getRelease(int releaseId) throws AzDException; - - Release getRelease(int releaseId, SingleReleaseExpands expand) throws AzDException; - - Release getRelease(int releaseId, SingleReleaseExpands expand, - ReleaseApprovalFilters approvalFilters, String[] propertyFilters, - int topGateRecords) throws AzDException; - - ReleaseEnvironment getReleaseEnvironment(int releaseId, int environmentId) throws AzDException; - - ReleaseEnvironment getReleaseEnvironment(int releaseId, int environmentId, SingleReleaseExpands expand) - throws AzDException; - - Releases getReleases() throws AzDException; - - Releases getReleases(ReleaseExpands expand) throws AzDException; - - Releases getReleases(int definitionId) throws AzDException; - - Releases getReleases(ReleaseExpands expand, int top) throws AzDException; - - Releases getReleases(String[] releaseIdFilter) throws AzDException; - - Releases getReleases(ReleaseExpands expand, String artifactVersionId) throws AzDException; - - Releases getReleases(ReleaseExpands expand, int top, String artifactTypeId, - String artifactVersionId, int continuationToken, String createdBy, - int definitionEnvironmentId, int definitionId, int environmentStatusFilter, - boolean isDeleted, String maxCreatedTime, String minCreatedTime, - String path, String[] propertyFilters, ReleaseQueryOrder queryOrder, - String[] releaseIdFilter, String searchText, String sourceBranchFilter, - String sourceId, ReleaseStatus statusFilter, String[] tagFilter) throws AzDException; - - ReleaseDefinition createReleaseDefinition(String releaseDefinitionParameters) throws AzDException; - - Void deleteReleaseDefinition(int definitionId) throws AzDException; - - Void deleteReleaseDefinition(int definitionId, String comment, boolean forceDelete) throws AzDException; - - ReleaseDefinition getReleaseDefinition(int definitionId) throws AzDException; - - ReleaseDefinitionRevisions getReleaseDefinitionHistory(int definitionId) throws AzDException; - - ReleaseDefinitions getReleaseDefinitions() throws AzDException; - - ReleaseDefinitions getReleaseDefinitions(ReleaseDefinitionExpands expands) throws AzDException; - - ReleaseDefinitions getReleaseDefinitions(int top) throws AzDException; - - ReleaseDefinitions getReleaseDefinitions(String artifactSourceId) throws AzDException; - - ReleaseDefinitions getReleaseDefinitions(int[] definitionIdFilter) throws AzDException; - - ReleaseDefinitions getReleaseDefinitions(ReleaseDefinitionExpands expands, int top, String artifactSourceId, - String artifactType, String continuationToken, int[] definitionIdFilter, - boolean isDeleted, boolean isExactNameMatch, String path, - String[] propertyFilters, ReleaseDefinitionQueryOrder queryOrder, - String searchText, boolean searchTextContainsFolderName, String[] tagFilter) throws AzDException; - - ReleaseDefinition updateReleaseDefinition(ReleaseDefinition releaseDefinition) throws AzDException; - - Void deleteRelease(int releaseId) throws AzDException; - - Release updateRelease(int releaseId, Release release) throws AzDException; - - ReleaseEnvironment updateReleaseEnvironment(int releaseId, int environmentId, String comment, - String scheduledDeploymentTime, ReleaseEnvironmentStatus status, VariableGroupMap variables) - throws AzDException; - - Release updateReleaseResource(int releaseId, String comment, boolean keepForever, - String[] manualEnvironments, ReleaseStatus status, String name) - throws AzDException; - - ReleaseEnvironment queueRelease(int releaseId, String environmentName) throws AzDException; - - Release abandonRelease(int releaseId) throws AzDException; - - ReleaseApprovals getReleaseApprovals() throws AzDException; - - ReleaseApprovals getReleaseApprovals(int[] releaseIdsFilter) throws AzDException; - - ReleaseApprovals getReleaseApprovals(String assignedToFilter, int continuationToken, boolean includeMyGroupApprovals, - ReleaseQueryOrder queryOrder, int[] releaseIdsFilter, ReleaseApprovalStatus statusFilter, - int top, ReleaseApprovalType typeFilter) throws AzDException; - - ReleaseApproval updateApproval(int approvalId, ReleaseApprovalStatus status, String comments) throws AzDException; - - ManualIntervention getManualIntervention(int releaseId, int manualInterventionId) throws AzDException; - - ManualInterventions getManualInterventions(int releaseId) throws AzDException; - - ManualIntervention updateManualIntervention(int releaseId, int manualInterventionId, String comment, ManualInterventionStatus status) - throws AzDException; - -} diff --git a/azd/src/main/java/org/azd/interfaces/SecurityDetails.java b/azd/src/main/java/org/azd/interfaces/SecurityDetails.java deleted file mode 100644 index cc275f25..00000000 --- a/azd/src/main/java/org/azd/interfaces/SecurityDetails.java +++ /dev/null @@ -1,28 +0,0 @@ -package org.azd.interfaces; - -import org.azd.exceptions.AzDException; -import org.azd.security.types.*; - -public interface SecurityDetails { - SecurityNamespaces getNamespaces() throws AzDException; - - SecurityNamespaces getNamespaces(boolean localOnly) throws AzDException; - - SecurityNamespace getNamespace(String namespaceId) throws AzDException; - - ACLs getAccessControlLists(String namespaceId) throws AzDException; - - ACLs getAccessControlLists(String namespaceId, String[] descriptors, String token, boolean includeExtendedInfo, boolean recurse) throws AzDException; - - Identities getIdentities(String[] descriptors, String[] identityIds, String[] subjectDescriptors, String filterValue, String queryMembership, String searchFilter) throws AzDException; - - Identities getIdentitiesFromSubjectDescriptors(String... subjectDescriptors) throws AzDException; - - ACEs setAccessControlEntries(String namespaceId, ACEs payload) throws AzDException; - - Void removeAccessControlEntries(String namespaceId, String[] descriptors, String[] tokens) throws AzDException; - - Void setAccessControlList(String namespaceId, ACLs payload) throws AzDException; - - Void removeAccessControlLists(String namespaceId, boolean recurse, String[] tokens) throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/ServiceEndpointDetails.java b/azd/src/main/java/org/azd/interfaces/ServiceEndpointDetails.java deleted file mode 100644 index 12d86cd5..00000000 --- a/azd/src/main/java/org/azd/interfaces/ServiceEndpointDetails.java +++ /dev/null @@ -1,36 +0,0 @@ -package org.azd.interfaces; - -import org.azd.enums.ServiceEndpointActionFilter; -import org.azd.exceptions.AzDException; -import org.azd.serviceendpoint.types.ServiceEndpoint; -import org.azd.serviceendpoint.types.ServiceEndpoints; - -import java.util.Map; - -public interface ServiceEndpointDetails { - ServiceEndpoint createServiceEndpoint(String endpointName, String endpointType, Map requestBody) throws AzDException; - - ServiceEndpoint createAzureRMServiceEndpoint(String endpointName, String servicePrincipalId, - String servicePrincipalKey, String tenantId, String subscriptionId, - String subscriptionName) throws AzDException; - - ServiceEndpoint getServiceEndpoint(String endpointId) throws AzDException; - - ServiceEndpoint getServiceEndpoint(String endpointId, ServiceEndpointActionFilter actionFilter) throws AzDException; - - ServiceEndpoints getServiceEndpoints() throws AzDException; - - Void deleteServiceEndpoint(String endpointId, String[] projectIds) throws AzDException; - - Void deleteServiceEndpoint(String endpointId, String[] projectIds, boolean deep) throws AzDException; - - ServiceEndpoints getServiceEndpointsByNames(String[] endpointNames) throws AzDException; - - ServiceEndpoints getServiceEndpointsByNames(String[] endpointNames, String[] authSchemes, - boolean includeDetails, boolean includeFailed, - String owner, String type) throws AzDException; - - Void shareServiceEndpoint(String endpointId, String projectName, String connectionName) throws AzDException; - - ServiceEndpoint updateServiceEndpoint(String endpointId, Map serviceEndpoint) throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/ServiceHooksDetails.java b/azd/src/main/java/org/azd/interfaces/ServiceHooksDetails.java deleted file mode 100644 index 5d563a84..00000000 --- a/azd/src/main/java/org/azd/interfaces/ServiceHooksDetails.java +++ /dev/null @@ -1,20 +0,0 @@ -package org.azd.interfaces; - -import org.azd.exceptions.AzDException; -import org.azd.servicehooks.types.ServiceHooks; -import org.azd.servicehooks.types.ServiceHooksSubscription; -import org.azd.servicehooks.types.ServiceHooksSubscriptions; - -public interface ServiceHooksDetails { - ServiceHooksSubscription getSubscription(String subscriptionId) throws AzDException; - - ServiceHooksSubscriptions getSubscriptions() throws AzDException; - - ServiceHooksSubscriptions getSubscriptions(String consumerActionId, String consumerId, - String eventType, String publisherId) throws AzDException; - - Void deleteSubscription(String subscriptionId) throws AzDException; - - ServiceHooksSubscription createSubscription(ServiceHooks serviceHooks) - throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/TestDetails.java b/azd/src/main/java/org/azd/interfaces/TestDetails.java deleted file mode 100644 index 1b02be02..00000000 --- a/azd/src/main/java/org/azd/interfaces/TestDetails.java +++ /dev/null @@ -1,43 +0,0 @@ -package org.azd.interfaces; - -import org.azd.enums.TestRunPublishContext; -import org.azd.enums.TestRunState; -import org.azd.exceptions.AzDException; -import org.azd.test.types.*; - -public interface TestDetails { - TestRun createTestRun(RunCreateModel runCreateModel) throws AzDException; - - TestRun getTestRunById(int runId) throws AzDException; - - TestRuns getTestRuns() throws AzDException; - - TestRuns getTestRuns(int top) throws AzDException; - - TestRuns getTestRuns(String buildUri) throws AzDException; - - TestRuns getTestRuns(int skip, int top, boolean automated, String buildUri, boolean includeRunDetails, String owner, - int planId, String tmiRunId) throws AzDException; - - TestRunStatistic getTestRunStatistics(int runId) throws AzDException; - - Void deleteTestRun(int runId) throws AzDException; - - TestRuns queryTestRuns(String maxLastUpdatedDate, String minLastUpdatedDate) throws AzDException; - - TestRuns queryTestRuns(String maxLastUpdatedDate, String minLastUpdatedDate, int top) throws AzDException; - - TestRuns queryTestRuns(String maxLastUpdatedDate, String minLastUpdatedDate, String[] buildIds) throws AzDException; - - TestRuns queryTestRuns(String maxLastUpdatedDate, String minLastUpdatedDate, TestRunState testRunState) throws AzDException; - - TestRuns queryTestRuns(String maxLastUpdatedDate, String minLastUpdatedDate, String branchName, String[] buildDefIds, - String continuationToken, boolean isAutomated, - String[] planIds, TestRunPublishContext publishContext, String[] releaseDefIds, - String[] releaseEnvDefIds, String[] releaseEnvIds, String[] releaseIds, - String runTitle) throws AzDException; - - TestRun updateTestRun(int runId, TestRun testRun) throws AzDException; - - TestCaseResults updateTestResults(int runId, TestCaseResults testCaseResults) throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/UpackDetails.java b/azd/src/main/java/org/azd/interfaces/UpackDetails.java deleted file mode 100644 index 265c74b5..00000000 --- a/azd/src/main/java/org/azd/interfaces/UpackDetails.java +++ /dev/null @@ -1,42 +0,0 @@ -package org.azd.interfaces; - -import org.azd.enums.PackagePromote; -import org.azd.enums.PackagesBatchOperation; -import org.azd.exceptions.AzDException; -import org.azd.upack.types.Package; -import org.azd.upack.types.UPackPackageVersionDeletionState; - -import java.util.List; -import java.util.Map; - -public interface UpackDetails { - Package getPackageVersion(String feedId, String packageName, String version) throws AzDException; - - Package getPackageVersion(String feedId, String packageName, String version, boolean showDeleted) - throws AzDException; - - UPackPackageVersionDeletionState getPackageVersionFromRecycleBin(String feedId, String packageName, - String version) throws AzDException; - - // String downloadPackage(String feedId, String packageName, - // String version, String fileName) - // throws AzDException; - - void updatePackageVersion(String feedId, String packageName, String version, PackagePromote promote) - throws AzDException; - - void updatePackageVersion(String feedId, String packageName, String version, String promote) - throws AzDException; - - void updatePackageVersions(String feedId, String viewId, PackagesBatchOperation operation, - List> packages) throws AzDException; - - void updateRecycleBinPackages(String feedId, PackagesBatchOperation operation, - List> packages) throws AzDException; - - void deletePackageVersion(String feedId, String packageName, String version) throws AzDException; - - void deletePackageVersionFromRecycleBin(String feedId, String packageName, String version) throws AzDException; - - void restorePackageVersionFromRecycleBin(String feedId, String packageName, String version) throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/WikiDetails.java b/azd/src/main/java/org/azd/interfaces/WikiDetails.java deleted file mode 100644 index 8a00d847..00000000 --- a/azd/src/main/java/org/azd/interfaces/WikiDetails.java +++ /dev/null @@ -1,65 +0,0 @@ -package org.azd.interfaces; - -import org.azd.enums.GitVersionOptions; -import org.azd.enums.GitVersionType; -import org.azd.enums.VersionControlRecursionType; -import org.azd.exceptions.AzDException; -import org.azd.wiki.types.*; - -import java.io.InputStream; - -public interface WikiDetails { - - WikiV2 createWiki(WikiCreateParameters wikiCreateParameters) throws AzDException; - - WikiV2 deleteWiki(String wikiIdentifier) throws AzDException; - - WikiV2 getWiki(String wikiIdentifier) throws AzDException; - - WikiV2Pages getWikis() throws AzDException; - - WikiAttachment createWikiAttachment(String wikiIdentifier, String name, InputStream content) throws AzDException; - - WikiAttachment createWikiAttachment(String wikiIdentifier, String name, String version, - GitVersionType versionType, GitVersionOptions versionOptions, InputStream content) throws AzDException; - - WikiPageMove createPageMove(String wikiIdentifier, String comment, WikiPageMoveParameters pageMoveParameters) throws AzDException; - - WikiPageMove createPageMove(String wikiIdentifier, String comment, String version, - GitVersionType versionType, GitVersionOptions versionOptions, WikiPageMoveParameters pageMoveParameters) throws AzDException; - - WikiPageDetail getPageStats(String wikiIdentifier, int pageId, int pageViewsForDays) throws AzDException; - - WikiPage createOrUpdateWikiPage(String wikiIdentifier, String path, String comment, String eTagVersion, String content) throws AzDException; - - WikiPage createOrUpdateWikiPage(String wikiIdentifier, String path, String comment, String eTagVersion, String version, - GitVersionType versionType, GitVersionOptions versionOptions, String content) throws AzDException; - - WikiPage deleteWikiPage(String wikiIdentifier, String path, String comment) throws AzDException; - - WikiPage deleteWikiPage(String wikiIdentifier, String path, String comment, String version, - GitVersionType versionType, GitVersionOptions versionOptions) throws AzDException; - - WikiPage deleteWikiPageById(String id, String wikiIdentifier, String path, String comment, String version, - GitVersionType versionType, GitVersionOptions versionOptions) throws AzDException; - - WikiPage getWikiPage(String wikiIdentifier) throws AzDException; - - WikiPage getWikiPage(String wikiIdentifier, boolean includeContent, String path, VersionControlRecursionType recursionLevel, - String comment, String version, - GitVersionType versionType, GitVersionOptions versionOptions) throws AzDException; - - WikiPage getWikiPage(String wikiIdentifier, boolean includeContent, String path, VersionControlRecursionType recursionLevel) - throws AzDException; - - WikiPage getWikiPageById(String id, String wikiIdentifier) throws AzDException; - - WikiPage getWikiPageById(String id, String wikiIdentifier, boolean includeContent, - VersionControlRecursionType recursionLevel) throws AzDException; - - String getWikiPageContent(String id, String wikiIdentifier) throws AzDException; - - InputStream getWikiPageAsZip(String id, String wikiIdentifier) throws AzDException; - - WikiPage updateWikiPage(String id, String wikiIdentifier, String comment, String eTagVersion, String content) throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/WorkDetails.java b/azd/src/main/java/org/azd/interfaces/WorkDetails.java deleted file mode 100644 index a503db57..00000000 --- a/azd/src/main/java/org/azd/interfaces/WorkDetails.java +++ /dev/null @@ -1,31 +0,0 @@ -package org.azd.interfaces; - -import org.azd.enums.IterationsTimeFrame; -import org.azd.exceptions.AzDException; -import org.azd.work.types.*; - -import java.util.List; - - -public interface WorkDetails { - TeamSettingsIterations getTeamSettingsIterations(String teamName) throws AzDException; - - TeamSettingsIterations getTeamSettingsIterations(String teamName, IterationsTimeFrame timeFrame) throws AzDException; - - IterationWorkItems getTeamIterationWorkItems(String teamName, String iterationId) throws AzDException; - - TeamSettingsIteration getTeamSettingsIteration(String teamName, String iterationId) throws AzDException; - - Void deleteTeamSettingsIteration(String teamName, String iterationId) throws AzDException; - - TeamCapacity getTotalTeamCapacity(String iterationId, String teamName) throws AzDException; - - TeamMemberCapacityIdentityRef getTeamMemberCapacity(String iterationId, String teamName, String teamMemberId) - throws AzDException; - - TeamMemberCapacityIdentityRefs updateTeamMembersCapacity(String iterationId, String teamName, - List teamMembersCapacity) throws AzDException; - - TeamMemberCapacityIdentityRef updateTeamMemberCapacity(String iterationId, String teamName, String teamMemberId, - TeamMemberCapacityIdentityRef teamMemberCapacity) throws AzDException; -} diff --git a/azd/src/main/java/org/azd/interfaces/WorkItemTrackingDetails.java b/azd/src/main/java/org/azd/interfaces/WorkItemTrackingDetails.java deleted file mode 100644 index 19c427ec..00000000 --- a/azd/src/main/java/org/azd/interfaces/WorkItemTrackingDetails.java +++ /dev/null @@ -1,142 +0,0 @@ -package org.azd.interfaces; - -import org.azd.enums.*; -import org.azd.exceptions.AzDException; -import org.azd.workitemtracking.types.*; - -import java.io.InputStream; -import java.util.List; -import java.util.Map; - -public interface WorkItemTrackingDetails { - WorkItem createWorkItem(String workItemType, WorkItemOperation operation, String title) - throws AzDException; - - WorkItem createWorkItem(String workItemType, WorkItemOperation operation, String title, String description, - String[] tags) throws AzDException; - - WorkItem createWorkItem(String workItemType, String title, String description, - Map additionalFields) throws AzDException; - - WorkItemDelete deleteWorkItem(int id) throws AzDException; - - Void deleteWorkItem(int id, boolean destroy) throws AzDException; - - WorkItem getWorkItem(int id) throws AzDException; - - WorkItem getWorkItem(int id, WorkItemExpand expand) throws AzDException; - - WorkItem getWorkItem(int id, WorkItemExpand expand, String asOf) throws AzDException; - - WorkItem getWorkItem(int id, WorkItemExpand expand, String[] fields) throws AzDException; - - WorkItem getWorkItem(int id, WorkItemExpand expand, String[] fields, String asOf) - throws AzDException; - - WorkItemList getWorkItems(int[] ids) throws AzDException; - - WorkItemList getWorkItems(int[] ids, WorkItemExpand expand) throws AzDException; - - WorkItemList getWorkItems(int[] ids, WorkItemExpand expand, String asOf) throws AzDException; - - WorkItemList getWorkItems(int[] ids, WorkItemExpand expand, String[] fields) - throws AzDException; - - WorkItemList getWorkItems(int[] ids, WorkItemExpand expand, String[] fields, String asOf, - WorkItemErrorPolicy errorPolicy) throws AzDException; - - WorkItemList getWorkItemRevisions(int workItemId) throws AzDException; - - WorkItemList getWorkItemRevisions(int workItemId, WorkItemExpand expand) throws AzDException; - - WorkItemList getWorkItemRevisions(int workItemId, WorkItemExpand expand, int top, int skip) - throws AzDException; - - WorkItem getWorkItemRevision(int workItemId, int revisionNumber) throws AzDException; - - WorkItem getWorkItemRevision(int workItemId, int revisionNumber, WorkItemExpand expand) - throws AzDException; - - WorkItemQueryResult queryByWiql(String team, String query) throws AzDException; - - WorkItemQueryResult queryByWiql(String team, String query, int top, boolean timePrecision) - throws AzDException; - - Void removeWorkItemFromRecycleBin(int id) throws AzDException; - - WorkItemDeleteReference getWorkItemFromRecycleBin(int id) throws AzDException; - - WorkItemDeleteShallowReferences getDeletedWorkItemsFromRecycleBin() throws AzDException; - - WorkItemDeleteReferences getDeletedWorkItemsFromRecycleBin(int[] ids) throws AzDException; - - WorkItemDeleteReference restoreWorkItemFromRecycleBin(int id) throws AzDException; - - WorkItem updateWorkItem(int workItemId, Map fieldsToUpdate) - throws AzDException; - - WorkItem updateWorkItem(int workItemId, Map fieldsToUpdate, WorkItemOperation operation) - throws AzDException; - - WorkItem updateWorkItem(int workItemId, WorkItemExpand expand, boolean bypassRules, boolean suppressNotifications, - boolean validateOnly, Map fieldsToUpdate) throws AzDException; - - WorkItem updateWorkItem(int workItemId, WorkItemExpand expand, boolean bypassRules, boolean suppressNotifications, - boolean validateOnly, Map fieldsToUpdate, WorkItemOperation operation) throws AzDException; - - WorkItem addHyperLinks(int workItemId, Map hyperlinksMap) throws AzDException; - - WorkItem removeHyperLinks(int workItemId, List urls) throws AzDException; - - WorkItemTypes getWorkItemTypes() throws AzDException; - - WorkItemType getWorkItemType(String workItemTypeName) throws AzDException; - - AttachmentReference createAttachment(String fileName, AttachmentUploadType uploadType, String teamAreaPath, String contents) throws AzDException; - - String getAttachment(String id, String fileName) throws AzDException; - - AttachmentReference createAttachment(String fileName, AttachmentUploadType uploadType, String teamAreaPath, InputStream contentStream) throws AzDException; - - InputStream getAttachmentContent(String id, String fileName, boolean download) throws AzDException; - - InputStream getAttachmentAsZip(String id, String fileName, boolean download) throws AzDException; - - WorkItem addWorkItemAttachment(int workItemId, Map fieldsToUpdate) throws AzDException; - - WorkItem removeWorkItemAttachment(int workItemId, List attachmentUrl) throws AzDException; - - AccountRecentActivityWorkItems getMyWorkRecentActivity() throws AzDException; - - WorkItemFieldTypes getWorkItemFields() throws AzDException; - - WorkItemFieldTypes getWorkItemFields(GetFieldsExpand expand) throws AzDException; - - WorkItemField getWorkItemField(String fieldNameOrRefName) throws AzDException; - - WorkItemField createWorkItemField(WorkItemField workItemField) throws AzDException; - - Void deleteWorkItemField(String fieldNameOrRefName) throws AzDException; - - WorkItemField updateWorkItemField(String fieldNameOrRefName, boolean isDeleted) throws AzDException; - - ProcessMigrationResultModel migrateProjectProcess(String processId) throws AzDException; - - QueryHierarchyItem createQuery(String query, QueryHierarchyItem queryHierarchyItem) throws AzDException; - - QueryHierarchyItems getQueries() throws AzDException; - - QueryHierarchyItems getQueries(int depth, QueryExpand expand, boolean includeDeleted) throws AzDException; - - QueryHierarchyItem getQuery(String query) throws AzDException; - - QueryHierarchyItem getQuery(String query, int depth, QueryExpand expand, boolean includeDeleted, boolean useIsoDateFormat) throws AzDException; - - Void deleteQuery(String query) throws AzDException; - - QueryHierarchyItems getQueryBatches(QueryErrorPolicy errorPolicy, QueryExpand expand, String[] ids) throws AzDException; - - QueryHierarchyItemsResult searchQuery(String filter) throws AzDException; - - QueryHierarchyItemsResult searchQuery(String filter, QueryExpand expand, boolean includeDeleted, int top) throws AzDException; -} diff --git a/azd/src/main/java/org/azd/locations/LocationsBaseRequestBuilder.java b/azd/src/main/java/org/azd/locations/LocationsBaseRequestBuilder.java index e47624b3..8bf869d5 100644 --- a/azd/src/main/java/org/azd/locations/LocationsBaseRequestBuilder.java +++ b/azd/src/main/java/org/azd/locations/LocationsBaseRequestBuilder.java @@ -40,7 +40,7 @@ public ResourceAreaRequestBuilder resourceArea() { * @param resourceId Pass the resource id. E.g., ResourceId.BUILD * @return Location URL for specific Api. */ - public String getUrl(String resourceId) { + public String getUrl(String resourceId) throws AzDException { return LookUpService.getInstance(accessTokenCredential) .locationUrl(organizationUrl, resourceId); } @@ -50,7 +50,7 @@ public String getUrl(String resourceId) { * @param resourceId Pass the resource id. E.g., ResourceId.BUILD * @return Location URL for specific Api. */ - public CompletableFuture getUrlAsync(String resourceId) { + public CompletableFuture getUrlAsync(String resourceId) throws AzDException { return CompletableFuture.completedFuture(getUrl(resourceId)); } diff --git a/azd/src/main/java/org/azd/maven/MavenApi.java b/azd/src/main/java/org/azd/maven/MavenApi.java deleted file mode 100644 index e0ebc56f..00000000 --- a/azd/src/main/java/org/azd/maven/MavenApi.java +++ /dev/null @@ -1,498 +0,0 @@ -package org.azd.maven; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.enums.*; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.helpers.StreamHelper; -import org.azd.interfaces.MavenDetails; -import org.azd.maven.types.MavenPackageVersionDeletionState; -import org.azd.maven.types.Package; -import org.azd.maven.types.UpstreamingBehavior; -import org.azd.utils.AzDAsyncApi; - -import java.io.InputStream; -import java.net.URI; -import java.net.http.HttpRequest; -import java.net.http.HttpResponse; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import static org.azd.utils.RestClient.send; - -/** - * MavenApi class to manage maven artifact package api - */ -public class MavenApi extends AzDAsyncApi implements MavenDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "packaging"; - private final String MAVEN = "6f7f8c07-ff36-473c-bcf3-bd6cc9b6c066"; - private final String PACKAGES_RELATIVE_PATH = "_packaging"; - - /** - * Pass the connection object to work with Maven Package Api - * - * @param connection Connection object - */ - public MavenApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Get information about a package version. - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param groupId Group ID of the package. Example: "com.example". - * @param artifactId Artifact ID of the package. Example: "app". - * @param version Version of the package. Example: "1.0.0". - * @return Package {@link Package} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Package getPackageVersion(String feedId, String groupId, String artifactId, String version) - throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, MAVEN, CONNECTION.getProject(), - AREA + "/feeds", feedId, - "maven/groups/" + groupId + "/artifacts/" + artifactId + "/versions/" + version, - ApiVersion.MAVEN, null, null, null); - - return MAPPER.mapJsonResponse(r, Package.class); - } - - /** - * Get information about a package version. - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param groupId Group ID of the package. Example: "com.example". - * @param artifactId Artifact ID of the package. Example: "app". - * @param version Version of the package. Example: "1.0.0". - * @param showDeleted True to show information for deleted versions - * @return Package {@link Package} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Package getPackageVersion(String feedId, String groupId, String artifactId, String version, - boolean showDeleted) throws AzDException { - HashMap q = new HashMap<>() { - { - put("showDeleted", showDeleted); - } - }; - String r = send(RequestMethod.GET, CONNECTION, MAVEN, CONNECTION.getProject(), - AREA + "/feeds", feedId, - "maven/groups/" + groupId + "/artifacts/" + artifactId + "/versions/" + version, - ApiVersion.MAVEN, q, null, null); - - return MAPPER.mapJsonResponse(r, Package.class); - } - - /** - * Get information about a package version in the recycle bin. - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param groupId Group ID of the package. Example: "com.example". - * @param artifactId Artifact ID of the package. Example: "app". - * @param version Version of the package. Example: "1.0.0". - * @return MavenPackageVersionDeletionState - * {@link MavenPackageVersionDeletionState} - * @throws AzDException Default Api Exception handler. - */ - @Override - public MavenPackageVersionDeletionState getPackageVersionFromRecycleBin(String feedId, String groupId, - String artifactId, String version) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, MAVEN, CONNECTION.getProject(), - AREA + "/feeds", feedId, - "maven/RecycleBin/groups/" + groupId + "/artifacts/" + artifactId + "/versions/" + version, - ApiVersion.MAVEN, null, null, null); - - return MAPPER.mapJsonResponse(r, MavenPackageVersionDeletionState.class); - } - - /** - * Get the upstreaming behavior of a package within the context of a feed - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param groupId Group ID of the package. Example: "com.example". - * @param artifactId Artifact ID of the package. Example: "app". - * @return UpstreamingBehavior - * {@link UpstreamingBehavior} - * @throws AzDException Default Api Exception handler. - */ - @Override - public UpstreamingBehavior getUpstreamingBehavior(String feedId, String groupId, String artifactId) - throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, MAVEN, CONNECTION.getProject(), - AREA + "/feeds", feedId, "maven/groups/" + groupId + "/artifacts/" + artifactId + "/upstreaming", - ApiVersion.MAVEN, null, null, null); - return MAPPER.mapJsonResponse(r, UpstreamingBehavior.class); - } - - /** - * Fulfills Maven package file download requests by either returning the URL - * of - * the requested package file or, in the case of Azure DevOps Server (OnPrem), - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param groupId Group ID of the package. Example: "com.example". - * @param artifactId Artifact ID of the package. Example: "app". - * @param version Version of the package. Example: "1.0.0". - * @param fileName File name to download. Example: "app-1.0.0.jar". - * @return Package content. - * @throws AzDException Default Api Exception handler. - */ - @Override - public InputStream downloadPackage(String feedId, String groupId, String artifactId, String version, String fileName) throws AzDException { - var callbackUri = send(null, RequestMethod.GET, CONNECTION, MAVEN, CONNECTION.getProject(), - AREA + "/feeds", feedId, - "maven/" + groupId + "/" + artifactId + "/" + version + "/" + fileName + "/content", - ApiVersion.MAVEN, null, null, null, true) - .thenApplyAsync(HttpResponse::uri) - .thenApplyAsync(URI::toString) - .join(); - - int statusCode = send(callbackUri, RequestMethod.GET, null, null, null, - null, null, null, null, null, null, null, true) - .thenApplyAsync(HttpResponse::statusCode) - .join(); - - var res = send(callbackUri, RequestMethod.GET, null, null, null, - null, null, null, null, null, null, null, true) - .thenApplyAsync(HttpResponse::body) - .join(); - - if (statusCode != 200) - MAPPER.mapJsonResponse(StreamHelper.convertToString(res), Map.class); - - return res; - } - - /** - * Delete a package version from the feed and move it to the feed's recycle bin. - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param groupId Group ID of the package. Example: "com.example". - * @param artifactId Artifact ID of the package. Example: "app". - * @param version Version of the package. Example: "1.0.0". - * @throws AzDException Default Api Exception handler. - */ - @Override - public void deletePackageVersion(String feedId, String groupId, String artifactId, String version) - throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, MAVEN, CONNECTION.getProject(), - AREA + "/feeds", feedId, - "maven/groups/" + groupId + "/artifacts/" + artifactId + "/versions/" + version, - ApiVersion.MAVEN, null, null, null); - if (!r.isEmpty()) - MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - - } - - /** - * Permanently delete a package from a feed's recycle bin. - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param groupId Group ID of the package. Example: "com.example". - * @param artifactId Artifact ID of the package. Example: "app". - * @param version Version of the package. Example: "1.0.0". - * @throws AzDException Default Api Exception handler. - */ - @Override - public void deletePackageVersionFromRecycleBin(String feedId, String groupId, String artifactId, String version) - throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, MAVEN, CONNECTION.getProject(), - AREA + "/feeds", feedId, - "maven/RecycleBin/groups/" + groupId + "/artifacts/" + artifactId + "/versions/" + version, - ApiVersion.MAVEN, null, null, null); - if (!r.isEmpty()) - MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - } - - /** - * Set mutable state on a package version.(eg. prelease, release) - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param groupId Group ID of the package. Example: "com.example". - * @param artifactId Artifact ID of the package. Example: "app". - * @param version Version of the package. Example: "1.0.0". - * @param promote State of the package. Example: "prelease". - * {@link PackagePromote} - * @throws AzDException Default Api Exception handler. - */ - @Override - public void updatePackageVersion(String feedId, String groupId, String artifactId, String version, PackagePromote promote) - throws AzDException { - updatePackageVersion(feedId, groupId, artifactId, version, promote.toString().toLowerCase()); - } - - /** - * Set mutable state on a package version.(eg. prelease, release) - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param groupId Group ID of the package. Example: "com.example". - * @param artifactId Artifact ID of the package. Example: "app". - * @param version Version of the package. Example: "1.0.0". - * @param promote State of the package. Example: "prelease". - * @throws AzDException Default Api Exception handler. - */ - @Override - public void updatePackageVersion(String feedId, String groupId, String artifactId, String version, String promote) - throws AzDException { - - var req = new HashMap() {{ - put("op", PackageOperation.ADD.toString()); - put("path", "/views/-"); - put("value", promote); // "promote package type" - }}; - - var body = new HashMap() {{ - put("views", req); - }}; - - try { - String r = send(RequestMethod.PATCH, CONNECTION, MAVEN, CONNECTION.getProject(), - AREA + "/feeds", feedId, - "maven/groups/" + groupId + "/artifacts/" + artifactId + "/versions/" + version, ApiVersion.MAVEN, - null, - body, CustomHeader.JSON_CONTENT_TYPE); - if (!r.isEmpty()) - MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - } - - /** - * Update several packages from a single feed in a single request. The updates - * to the packages do not happen atomically. - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param viewId Name of ID the view, packages need to be promoted to. - * @param operation Type of operation that needs to be performed on packages. - * supports only PROMOTE or DELETE. - * {@link PackagesBatchOperation}. - * @param packages Identifies a particular Maven package versions - * @throws AzDException Default Api Exception handler. - */ - @Override - public void updatePackageVersions(String feedId, String viewId, PackagesBatchOperation operation, - List> packages) - throws AzDException { - var req = new HashMap(); - try { - if (operation == PackagesBatchOperation.PROMOTE) { - req.put("data", Map.of("viewId", viewId)); - } - req.put("operation", operation.toString().toLowerCase()); - - List l = new ArrayList(); - for (var pkg : packages) { - l.add(Map.of("group", pkg.get("group"), "artifact", pkg.get("artifact"), "version", - pkg.get("version"))); - } - req.put("packages", l); - - String r = send(RequestMethod.POST, CONNECTION, MAVEN, CONNECTION.getProject(), - AREA + "/feeds", feedId, "maven/packagesbatch", ApiVersion.MAVEN, null, req, CustomHeader.JSON_CONTENT_TYPE); - if (!r.isEmpty()) - MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - } - - /** - * Restore a package version from the recycle bin to its associated feed. - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param groupId Group ID of the package. Example: "com.example". - * @param artifactId Artifact ID of the package. Example: "app". - * @param version Version of the package. Example: "1.0.0". - * @throws AzDException Default Api Exception handler. - */ - @Override - public void restorePackageVersionFromRecycleBin(String feedId, String groupId, String artifactId, String version) - throws AzDException { - try { - String r = send(RequestMethod.PATCH, CONNECTION, MAVEN, CONNECTION.getProject(), - AREA + "/feeds", feedId, - "maven/RecycleBin/groups/" + groupId + "/artifacts/" + artifactId + "/versions/" + version, - ApiVersion.MAVEN, null, Map.of("deleted", "false"), CustomHeader.JSON_CONTENT_TYPE); - if (!r.isEmpty()) - MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - } - - /** - * Set the upstreaming behavior of a (scoped) package. - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param groupId Group ID of the package. Example: "com.example". - * @param artifactId Artifact ID of the package. Example: "app". - * @throws AzDException Default Api Exception handler. - */ - @Override - public void setUpstreamingBehavior(String feedId, String groupId, String artifactId) - throws AzDException { - setUpstreamingBehavior(feedId, groupId, artifactId, "allowExternalVersions"); - } - - /** - * Set the upstreaming behavior of a (scoped) package. - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param groupId Group ID of the package. Example: "com.example". - * @param artifactId Artifact ID of the package. Example: "app". - * @throws AzDException Default Api Exception handler. - */ - @Override - public void setUpstreamingBehavior(String feedId, String groupId, String artifactId, String upstreamingBehavior) - throws AzDException { - - var req = new HashMap(); - try { - req.put("versionsFromExternalUpstreams", upstreamingBehavior); - - String r = send(RequestMethod.PATCH, CONNECTION, MAVEN, CONNECTION.getProject(), - AREA + "/feeds", feedId, - "maven/groups/" + groupId + "/artifacts/" + artifactId + "/upstreaming", - ApiVersion.MAVEN, null, req, CustomHeader.JSON_CONTENT_TYPE); - if (!r.isEmpty()) - MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - } - - /** - * To clear the upstream behavior of a (scoped) package. - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param groupId Group ID of the package. Example: "com.example". - * @param artifactId Artifact ID of the package. Example: "app". - * @throws AzDException Default Api Exception handler. - */ - @Override - public void clearUpstreamingBehavior(String feedId, String groupId, String artifactId) throws AzDException { - var req = new HashMap(); - try { - req.put("versionsFromExternalUpstreams", "auto"); - - String r = send(RequestMethod.PATCH, CONNECTION, MAVEN, CONNECTION.getProject(), - AREA + "/feeds", feedId, - "maven/groups/" + groupId + "/artifacts/" + artifactId + "/upstreaming", - ApiVersion.MAVEN, null, req, CustomHeader.JSON_CONTENT_TYPE); - if (!r.isEmpty()) - MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - } - - /** - * Delete or restore several package versions from the recycle bin. - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param operation Type of operation that needs to be performed on - * packages. Recycle Bin supports only - * PERMANENTDELETE or - * RESTORETOFEED. {@link PackagesBatchOperation} - * @param packages Identifies a particular Maven package versions - * @throws AzDException Default Api Exception handler. - */ - @Override - public void updateRecycleBinPackages(String feedId, PackagesBatchOperation operation, - List> packages) - throws AzDException { - var req = new HashMap(); - try { - req.put("data", null); - req.put("operation", operation.toString().toLowerCase()); - - List l = new ArrayList(); - for (var pkg : packages) { - l.add(Map.of("group", pkg.get("group"), "artifact", pkg.get("artifact"), "version", - pkg.get("version"))); - } - req.put("packages", l); - - String r = send(RequestMethod.POST, CONNECTION, MAVEN, CONNECTION.getProject(), - AREA + "/feeds", feedId, "maven/RecycleBin/packagesbatch", ApiVersion.MAVEN, null, req, CustomHeader.JSON_CONTENT_TYPE); - if (!r.isEmpty()) - MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - } - - /** - * Fulfills Maven package file upload requests by either returning the URL - * of - * the requested package file or, in the case of Azure DevOps Server (OnPrem), - * - * @param feedId Name or ID of the feed. Example: "mavenfeed". - * @param groupId Group ID of the package. Example: "com.example". - * @param artifactId Artifact ID of the package. Example: "app". - * @param version Version of the package. Example: "1.0.0". - * @param fileName File name to upoad. Must include artifactId Example: "app-1.0.0.jar". - * @param content Inputstream for the package file. - * @throws AzDException Default Api Exception handler. - */ - @Override - public void uploadPackage(String feedId, String groupId, String artifactId, String version, String fileName, InputStream content) - throws AzDException { - try { - String pathSeparator = "/"; - - String baseInstance = Instance.BASE_INSTANCE.setSubdomain("pkgs"); // This returns https://pkgs.dev.azure.com - StringBuilder stringBuilder = new StringBuilder(baseInstance); - - stringBuilder.append(CONNECTION.getOrganization()); - if (CONNECTION.getProject() != null) { - stringBuilder.append(pathSeparator).append(CONNECTION.getProject()); - } - - stringBuilder.append(pathSeparator + PACKAGES_RELATIVE_PATH); - - if (feedId != null) { - stringBuilder.append(pathSeparator).append(feedId); - } - - String area = "maven" + pathSeparator + "v1"; - stringBuilder.append(pathSeparator).append(area); - - String resource = groupId + pathSeparator + artifactId + pathSeparator + version + pathSeparator + fileName; - if (resource != null) { - stringBuilder.append(pathSeparator).append(resource); - } - - String requestUrl = stringBuilder.toString(); - - var t = send(requestUrl, RequestMethod.PUT, CONNECTION, null, null, - null, null, null, ApiVersion.MAVEN, null, HttpRequest.BodyPublishers.ofInputStream(() -> content), - HttpResponse.BodyHandlers.ofString(), null, false); - - String r = t.thenApplyAsync(HttpResponse::body).join(); - if (!r.isEmpty()) // if the response is not empty, then the upload was not successful - MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - } -} diff --git a/azd/src/main/java/org/azd/maven/types/Package.java b/azd/src/main/java/org/azd/maven/types/Package.java deleted file mode 100644 index 10a8b976..00000000 --- a/azd/src/main/java/org/azd/maven/types/Package.java +++ /dev/null @@ -1,107 +0,0 @@ -package org.azd.maven.types; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; -import org.azd.abstractions.serializer.SerializableEntity; - -import java.util.List; - -/** - * Package version metadata for a Maven package - */ -@JsonIgnoreProperties(ignoreUnknown = true) -public class Package extends SerializableEntity { - /** - * Related REST links. - */ - @JsonProperty("_links") - private ReferenceLinks _links; - /** - * If and when the package was deleted. - */ - @JsonProperty("deletedDate") - private String deletedDate; - /** - * Package Id. - */ - @JsonProperty("id") - private String id; - /** - * The display name of the package. - */ - @JsonProperty("name") - private String name; - /** - * If and when the package was permanently deleted. - */ - @JsonProperty("permanentlyDeletedDate") - private String permanentlyDeletedDate; - /** - * The history of upstream sources for this package. The first source in the - * list is the immediate source from which this package was saved. - */ - @JsonProperty("sourceChain") - private List sourceChain; - /** - * The version of the package. - */ - @JsonProperty("version") - private String version; - - public ReferenceLinks get_links() { - return _links; - } - - public void set_links(ReferenceLinks _links) { - this._links = _links; - } - - public String getDeletedDate() { - return deletedDate; - } - - public void setDeletedDate(String deletedDate) { - this.deletedDate = deletedDate; - } - - public String getId() { - return id; - } - - public void setId(String id) { - this.id = id; - } - - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } - - public String getPermanentlyDeletedDate() { - return permanentlyDeletedDate; - } - - public void setPermanentlyDeletedDate(String permanentlyDeletedDate) { - this.permanentlyDeletedDate = permanentlyDeletedDate; - } - - public List getsourceChain() { - return sourceChain; - } - - public void setsourceChain(List sourceChain) { - this.sourceChain = sourceChain; - } - - public String getVersion() { - return version; - } - - public void setVersion(String version) { - this.version = version; - } - -} diff --git a/azd/src/main/java/org/azd/memberentitlementmanagement/MemberEntitlementManagementApi.java b/azd/src/main/java/org/azd/memberentitlementmanagement/MemberEntitlementManagementApi.java deleted file mode 100644 index b87c1f63..00000000 --- a/azd/src/main/java/org/azd/memberentitlementmanagement/MemberEntitlementManagementApi.java +++ /dev/null @@ -1,278 +0,0 @@ -package org.azd.memberentitlementmanagement; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.enums.*; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.MemberEntitlementManagementDetails; -import org.azd.memberentitlementmanagement.types.*; -import org.azd.utils.AzDAsyncApi; - -import java.util.HashMap; -import java.util.LinkedHashMap; -import java.util.List; -import java.util.Map; - -import static org.azd.utils.RestClient.send; - -/** - * MemberEntitlementManagementApi class to manage groups and user entitlements API - */ -public class MemberEntitlementManagementApi extends AzDAsyncApi implements MemberEntitlementManagementDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String GROUP_AREA = "groupentitlements"; - private final String USER_AREA = "userentitlements"; - private final String MEMBERENTITLEMENTMANAGEMENT = "68ddce18-2501-45f1-a17b-7931a9922690"; - - /** - * Pass the connection object to work with Member Entitlement Management Api - * - * @param connection Connection object - */ - public MemberEntitlementManagementApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Get the group entitlements for an account. - * - * @return GroupEntitlements {@link GroupEntitlements} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GroupEntitlements getGroupEntitlements() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, MEMBERENTITLEMENTMANAGEMENT, null, - GROUP_AREA, null, null, ApiVersion.MEMBERSHIP_ENTITLEMENT_MANAGEMENT, null, null, null); - - return MAPPER.mapJsonResponse(r, GroupEntitlements.class); - } - - /** - * Get a group entitlement. If the group entitlement does not exist, returns null. - * - * @param groupId ID of the group. - * @return GroupEntitlement {@link GroupEntitlement} - * @throws AzDException Default Api Exception handler. - */ - @Override - public GroupEntitlement getGroupEntitlement(String groupId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, MEMBERENTITLEMENTMANAGEMENT, null, - GROUP_AREA, groupId, null, ApiVersion.MEMBERSHIP_ENTITLEMENT_MANAGEMENT, null, null, null); - - return MAPPER.mapJsonResponse(r, GroupEntitlement.class); - } - - /** - * Get summary of Licenses, Extension, Projects, Groups and their assignments in the collection. - * - * @return UsersSummary {@link UsersSummary} - * @throws AzDException Default Api Exception handler. - */ - @Override - public UsersSummary getUserEntitlementSummary() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, MEMBERENTITLEMENTMANAGEMENT, null, - "userentitlementsummary", null, null, ApiVersion.MEMBERSHIP_ENTITLEMENT_MANAGEMENT, null, null, null); - - return MAPPER.mapJsonResponse(r, UsersSummary.class); - } - - /** - * Get direct members of a Group. - * - * @param groupId Id of the Group. - * @return PagedGraphMemberList {@link PagedGraphMemberList} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PagedGraphMemberList getMembers(String groupId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, MEMBERENTITLEMENTMANAGEMENT, null, - GROUP_AREA, groupId, "members", ApiVersion.MEMBERSHIP_ENTITLEMENT_MANAGEMENT, null, null, null); - - return MAPPER.mapJsonResponse(r, PagedGraphMemberList.class); - } - - /** - * Get direct members of a Group. - * - * @param groupId Id of the Group. - * @param maxResults Maximum number of results to retrieve. - * @param pagingToken Paging Token from the previous page fetched. - * If the 'pagingToken' is null, the results would be fetched from the beginning of the Members List. - * @return PagedGraphMemberList {@link PagedGraphMemberList} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PagedGraphMemberList getMembers(String groupId, int maxResults, String pagingToken) throws AzDException { - var q = new HashMap() {{ - put("maxResults", maxResults); - put("pagingToken", pagingToken); - }}; - - String r = send(RequestMethod.GET, CONNECTION, MEMBERENTITLEMENTMANAGEMENT, null, - GROUP_AREA, groupId, "members", ApiVersion.MEMBERSHIP_ENTITLEMENT_MANAGEMENT, q, null, null); - - return MAPPER.mapJsonResponse(r, PagedGraphMemberList.class); - } - - /** - * Remove a member from a Group. - * - * @param groupId Id of the group. - * @param memberId Id of the group. - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void removeMemberFromGroup(String groupId, String memberId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, MEMBERENTITLEMENTMANAGEMENT, null, - GROUP_AREA, groupId, "members/" + memberId, - ApiVersion.MEMBERSHIP_ENTITLEMENT_MANAGEMENT, null, null, null); - - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Add a user, assign license and make them a member of a project group in an account. - * - * @param accountLicenseType Type of Accounts License (e.g. Express, Stakeholder etc.) {@link AccountLicenseType} - * @param emailId Email address of the user. - * @param groupType Type of the group. (e.g. Project Administrator, Project Contributor, etc.) {@link GroupType} - * @param projectId Id of the project. Get the project id by running getProjects() or getProject("projectName") from CoreApi. - * @return UserEntitlementsResponse {@link UserEntitlementsResponse} - * @throws AzDException Default Api Exception handler. - */ - @Override - public UserEntitlementsResponse addUserEntitlement(AccountLicenseType accountLicenseType, String emailId, GroupType groupType, String projectId) - throws AzDException { - - var projectEntitlement = new LinkedHashMap() {{ - put("group", new LinkedHashMap() {{ - put("groupType", groupType.toString().toLowerCase()); - }}); - put("projectRef", new LinkedHashMap() {{ - put("id", projectId); - }}); - }}; - - var body = new LinkedHashMap() {{ - put("accessLevel", new LinkedHashMap() {{ - put("accountLicenseType", accountLicenseType.toString().toLowerCase()); - }}); - put("user", new LinkedHashMap() {{ - put("principalName", emailId); - put("subjectKind", "user"); - }}); - put("projectEntitlements", List.of(projectEntitlement)); - }}; - - String r = send(RequestMethod.POST, CONNECTION, MEMBERENTITLEMENTMANAGEMENT, null, - USER_AREA, null, null, ApiVersion.USER_ENTITLEMENTS, null, body, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, UserEntitlementsResponse.class); - } - - /** - * Delete a user from the account. - * The delete operation includes unassigning Extensions and Licenses and removing the user from all project memberships. - * The user would continue to have access to the account if she is member of an AAD group, that is added directly to the account. - * - * @param userId userId ID of the user. Run getUserEntitlements() to get a list of users and get the user id. - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteUserEntitlement(String userId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, MEMBERENTITLEMENTMANAGEMENT, null, - USER_AREA, userId, null, - ApiVersion.USER_ENTITLEMENTS, null, null, null); - - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Get User Entitlement for a user. - * - * @param userId userId ID of the user. Run getUserEntitlements() to get a list of users and get the user id. - * @return UserEntitlement {@link UserEntitlement} - * @throws AzDException Default Api Exception handler. - */ - @Override - public UserEntitlement getUserEntitlement(String userId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, MEMBERENTITLEMENTMANAGEMENT, null, - USER_AREA, userId, null, ApiVersion.USER_ENTITLEMENTS, null, null, null); - - return MAPPER.mapJsonResponse(r, UserEntitlement.class); - } - - /** - * Get a list of users/members entitlements. - * - * @return PagedGraphMemberList {@link PagedGraphMemberList} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PagedGraphMemberList getUserEntitlements() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, MEMBERENTITLEMENTMANAGEMENT, null, - USER_AREA, null, null, ApiVersion.USER_ENTITLEMENTS, null, null, null); - - return MAPPER.mapJsonResponse(r, PagedGraphMemberList.class); - } - - /** - * Edit the entitlements (License, Extensions, Projects, Teams etc) for a user. Pass a list of items that you want to edit for a user. - * - * @param userId ID of the user. Run getUserEntitlements() to get a list of users and get the user id. - * @return UserEntitlementsResponse {@link UserEntitlementsResponse} - * @throws AzDException Default Api Exception handler. - */ - @Override - public UserEntitlementsResponse updateUserEntitlement(String userId, List requestBody) throws AzDException { - String r = send(RequestMethod.PATCH, CONNECTION, MEMBERENTITLEMENTMANAGEMENT, null, - USER_AREA, userId, null, ApiVersion.USER_ENTITLEMENTS, null, requestBody, CustomHeader.JSON_PATCH); - - return MAPPER.mapJsonResponse(r, UserEntitlementsResponse.class); - } - - /** - * Edit the entitlements License for a user. Set the license account type and license source type for a user. - * - * @param userId ID of the user. Run getUserEntitlements() to get a list of users and get the user id. - * @param accountLicenseType Type of Accounts License (e.g. Express, Stakeholder etc.) {@link AccountLicenseType} - * @param licensingSource Licensing Source (e.g. Accounts. MSDN etc.) {@link LicensingSource} - * @return UserEntitlementsResponse {@link UserEntitlementsResponse} - * @throws AzDException Default Api Exception handler. - */ - @Override - public UserEntitlementsResponse updateUserEntitlement(String userId, AccountLicenseType accountLicenseType, LicensingSource licensingSource) - throws AzDException { - var pos = new LinkedHashMap() {{ - put("from", ""); - put("op", "replace"); - put("path", "/accessLevel"); - put("value", new LinkedHashMap() {{ - put("accountLicenseType", accountLicenseType.toString().toLowerCase()); - put("licensingSource", licensingSource.toString().toLowerCase()); - }}); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, MEMBERENTITLEMENTMANAGEMENT, null, - USER_AREA, userId, null, ApiVersion.USER_ENTITLEMENTS, null, List.of(pos), CustomHeader.JSON_PATCH); - - return MAPPER.mapJsonResponse(r, UserEntitlementsResponse.class); - } -} diff --git a/azd/src/main/java/org/azd/oauth/OAuthAccessTokenBuilder.java b/azd/src/main/java/org/azd/oauth/OAuthAccessTokenBuilder.java index 1e9dd251..a50f22fa 100644 --- a/azd/src/main/java/org/azd/oauth/OAuthAccessTokenBuilder.java +++ b/azd/src/main/java/org/azd/oauth/OAuthAccessTokenBuilder.java @@ -1,13 +1,17 @@ package org.azd.oauth; +import org.azd.abstractions.RequestInformation; import org.azd.enums.CustomHeader; import org.azd.enums.Instance; +import org.azd.enums.RequestMethod; import org.azd.exceptions.AzDException; import org.azd.helpers.URLHelper; import org.azd.http.ClientRequest; import org.azd.oauth.types.AuthorizationEndpoint; import org.azd.oauth.types.AuthorizedToken; +import java.net.http.HttpRequest; +import java.nio.charset.StandardCharsets; import java.util.Objects; /** @@ -125,10 +129,14 @@ public boolean hasTokenExpired(AuthorizedToken authorizedToken) { } private ClientRequest builder(String requestUrl, String body) { + var reqInfo = new RequestInformation(); + reqInfo.requestMethod = RequestMethod.POST; + reqInfo.setRequestUrl(requestUrl); + reqInfo.requestHeaders.add(CustomHeader.URL_ENCODED); + reqInfo.body = HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8); + return ClientRequest.builder() - .URI(requestUrl) - .header(CustomHeader.URL_ENCODED) - .POST(body) + .request(reqInfo) .build(); } } diff --git a/azd/src/main/java/org/azd/oauth/OAuthApi.java b/azd/src/main/java/org/azd/oauth/OAuthApi.java deleted file mode 100644 index 4c31b00c..00000000 --- a/azd/src/main/java/org/azd/oauth/OAuthApi.java +++ /dev/null @@ -1,80 +0,0 @@ -package org.azd.oauth; - -import org.azd.enums.VsoScope; -import org.azd.exceptions.AzDException; -import org.azd.oauth.types.AuthorizationEndpoint; -import org.azd.oauth.types.AuthorizedToken; - -import java.util.List; - -/** - * OAuth Api class to authorize access to REST API - */ -public class OAuthApi { - private static OAuthAccessTokenBuilder OAUTH; - - /** - * Default constructor - */ - public OAuthApi() { - OAUTH = new OAuthAccessTokenBuilder(); - } - - /** - * Generate the authorization endpoint with client id, state, scope and redirection url. - * - * @param clientId The ID assigned to your app when it was registered - * @param state Can be any value. Typically, a generated string value that correlates the callback with its associated authorization request. - * @param scope Scopes registered with the app. Space separated. - * @param redirectUrl Callback URL for your app. Must exactly match the URL registered with the app. - * @return The authorization endpoint to authorize your app - * @see Scopes - */ - public static String getAuthorizationEndpoint(String clientId, String state, List scope, String redirectUrl) { - var authorizationEndpoint = new AuthorizationEndpoint(); - authorizationEndpoint.clientId = clientId; - authorizationEndpoint.scope = scope; - authorizationEndpoint.redirectUrl = redirectUrl; - authorizationEndpoint.state = state; - - return OAUTH.buildAuthorizationEndpoint(authorizationEndpoint); - } - - - /** - * Now you use the authorization code to request an access token for the user. - * Your service must make a service-to-service HTTP request to Azure DevOps Services. - * - * @param appSecret URL encoded client secret acquired when the app was registered - * @param authCode URL encoded "code" provided via the code query parameter to your callback URL - * @param callbackUrl callback URL registered with the app - * @return AuthorizedToken object {@link AuthorizedToken} - * @throws AzDException Default Api Exception handler. - */ - public static AuthorizedToken getAccessToken(String appSecret, String authCode, String callbackUrl) throws AzDException { - return OAUTH.getAccessToken(appSecret, authCode, callbackUrl); - } - - /** - * If a user's access token expires, you can use the refresh token that they acquired in the authorization flow to get a new access token. - * - * @param appSecret URL encoded client secret acquired when the app was registered - * @param authCode URL encoded "code" provided via the code query parameter to your callback URL - * @param callbackUrl callback URL registered with the app - * @return AuthorizedToken object {@link AuthorizedToken} - * @throws AzDException Default Api Exception handler. - */ - public static AuthorizedToken getRefreshToken(String appSecret, String authCode, String callbackUrl) throws AzDException { - return OAUTH.getRefreshToken(appSecret, authCode, callbackUrl); - } - - /** - * Check if the access token has expired. - * - * @param authorizedToken authorized token object {@link AuthorizedToken} - * @return True if the token has expired. {@link Boolean} - */ - public static boolean hasTokenExpired(AuthorizedToken authorizedToken) { - return OAUTH.hasTokenExpired(authorizedToken); - } -} diff --git a/azd/src/main/java/org/azd/pipelines/PipelinesApi.java b/azd/src/main/java/org/azd/pipelines/PipelinesApi.java deleted file mode 100644 index 3dd4c452..00000000 --- a/azd/src/main/java/org/azd/pipelines/PipelinesApi.java +++ /dev/null @@ -1,353 +0,0 @@ -package org.azd.pipelines; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.enums.CustomHeader; -import org.azd.enums.PipelinesExpandOptions; -import org.azd.enums.RequestMethod; -import org.azd.exceptions.AzDException; -import org.azd.git.GitApi; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.PipelinesDetails; -import org.azd.pipelines.types.*; -import org.azd.utils.AzDAsyncApi; - -import java.util.HashMap; -import java.util.Map; - -import static org.azd.utils.RestClient.send; - -/** - * PipelinesApi class to manage Pipelines API - */ -public class PipelinesApi extends AzDAsyncApi implements PipelinesDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "pipelines"; - private final String PIPELINES = "2e0bf237-8973-4ec9-a581-9c3d679d1776"; - - /** - * Pass the connection object to work with Pipelines Api - * - * @param connection Connection object - */ - public PipelinesApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Get a specific artifact from a pipeline run - * - * @param pipelineId ID of the pipeline. - * @param runId ID of the run of that pipeline. - * @param artifactName Name of the artifact. - * @return PipelinesArtifact object {@link PipelinesArtifact} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PipelinesArtifact getArtifacts(int pipelineId, int runId, String artifactName) throws AzDException { - var q = new HashMap() {{ - put("artifactName", artifactName); - }}; - - String r = send(RequestMethod.GET, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, Integer.toString(pipelineId), "runs/" + runId + "/artifacts", ApiVersion.PIPELINES, q, null, null); - - return MAPPER.mapJsonResponse(r, PipelinesArtifact.class); - } - - /** - * Get a specific artifact from a pipeline run - * - * @param pipelineId ID of the pipeline. - * @param runId ID of the run of that pipeline. - * @param artifactName Name of the artifact. - * @param expandOptions Expand options. Default is None. {@link PipelinesExpandOptions} - * @return PipelinesArtifact object {@link PipelinesArtifact} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PipelinesArtifact getArtifacts(int pipelineId, int runId, String artifactName, PipelinesExpandOptions expandOptions) - throws AzDException { - var q = new HashMap() {{ - put("artifactName", artifactName); - put("$expand", expandOptions.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, Integer.toString(pipelineId), "runs/" + runId + "/artifacts", ApiVersion.PIPELINES, q, null, null); - - return MAPPER.mapJsonResponse(r, PipelinesArtifact.class); - } - - /** - * Get a specific log from a pipeline run - * - * @param pipelineId ID of the pipeline. - * @param runId ID of the run of that pipeline. - * @param logId ID of the log. - * @return PipelineLog object {@link PipelineLog} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PipelineLog getPipelineLog(int pipelineId, int runId, int logId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, Integer.toString(pipelineId), "runs/" + runId + "/logs/" + logId, ApiVersion.PIPELINES, null, null, null); - - return MAPPER.mapJsonResponse(r, PipelineLog.class); - } - - /** - * Get a specific log from a pipeline run - * - * @param pipelineId ID of the pipeline. - * @param runId ID of the run of that pipeline. - * @param logId ID of the log. - * @param expandOptions Expand options. Default is None. {@link PipelinesExpandOptions} - * @return PipelineLog object {@link PipelineLog} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PipelineLog getPipelineLog(int pipelineId, int runId, int logId, PipelinesExpandOptions expandOptions) throws AzDException { - var q = new HashMap() {{ - put("$expand", expandOptions.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, Integer.toString(pipelineId), "runs/" + runId + "/logs/" + logId, ApiVersion.PIPELINES, q, null, null); - - return MAPPER.mapJsonResponse(r, PipelineLog.class); - } - - /** - * Get a list of logs from a pipeline run. - * - * @param pipelineId ID of the pipeline. - * @param runId ID of the run of that pipeline. - * @return LogCollection object {@link LogCollection} - * @throws AzDException Default Api Exception handler. - */ - @Override - public LogCollection getPipelineLogs(int pipelineId, int runId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, Integer.toString(pipelineId), "runs/" + runId + "/logs", ApiVersion.PIPELINES, null, null, null); - - return MAPPER.mapJsonResponse(r, LogCollection.class); - } - - /** - * Get a list of logs from a pipeline run. - * - * @param pipelineId ID of the pipeline. - * @param runId ID of the run of that pipeline. - * @param expandOptions Expand options. Default is None. {@link PipelinesExpandOptions} - * @return LogCollection object {@link LogCollection} - * @throws AzDException Default Api Exception handler. - */ - @Override - public LogCollection getPipelineLogs(int pipelineId, int runId, PipelinesExpandOptions expandOptions) throws AzDException { - var q = new HashMap() {{ - put("$expand", expandOptions.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, Integer.toString(pipelineId), "runs/" + runId + "/logs", ApiVersion.PIPELINES, q, null, null); - - return MAPPER.mapJsonResponse(r, LogCollection.class); - } - - /** - * Create a pipeline. - * - * @param name Name of the pipeline. - * @param folder Folder of the pipeline. - * @param pathOfYamlFile Path of azure-pipelines.yaml file in the repository. - * @param repositoryId Id of the repository - * @param repositoryName Name of the repository - * @return Pipeline object {@link Pipeline} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Pipeline createPipeline(String name, String folder, String pathOfYamlFile, String repositoryId, String repositoryName) throws AzDException { - - var body = new HashMap() {{ - put("name", name); - put("folder", folder); - put("configuration", new HashMap<>() {{ - put("type", "yaml"); - put("path", pathOfYamlFile); - put("repository", new HashMap<>() {{ - put("id", repositoryId); - put("name", repositoryName); - put("type", "azureReposGit"); - }}); - }}); - }}; - - String r = send(RequestMethod.POST, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, null, null, ApiVersion.PIPELINES, null, body, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, Pipeline.class); - } - - /** - * Gets a pipeline, optionally at the specified version - * - * @param pipelineId The pipeline ID - * @return Pipeline object {@link Pipeline} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Pipeline getPipeline(int pipelineId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, Integer.toString(pipelineId), null, ApiVersion.PIPELINES, null, null, null); - - return MAPPER.mapJsonResponse(r, Pipeline.class); - } - - /** - * Gets a pipeline, optionally at the specified version - * - * @param pipelineId The pipeline ID - * @param pipelineVersion The pipeline version - * @return Pipeline object {@link Pipeline} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Pipeline getPipeline(int pipelineId, String pipelineVersion) throws AzDException { - var q = new HashMap() {{ - put("pipelineVersion", pipelineVersion); - }}; - - String r = send(RequestMethod.GET, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, Integer.toString(pipelineId), null, ApiVersion.PIPELINES, q, null, null); - - return MAPPER.mapJsonResponse(r, Pipeline.class); - } - - /** - * Get a list of pipelines. - * - * @return Pipelines {@link Pipelines} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Pipelines getPipelines() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, null, null, ApiVersion.PIPELINES, null, null, null); - - return MAPPER.mapJsonResponse(r, Pipelines.class); - } - - /** - * Queues a dry run of the pipeline and returns an object containing the final yaml. - * - * @param pipelineId The pipeline ID. - * @param previewRun If true, don't actually create a new run. Instead, return the final YAML document after parsing templates. - * @return PreviewRun object {@link PreviewRun} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PreviewRun previewPipeline(int pipelineId, boolean previewRun) throws AzDException { - var body = new HashMap() {{ - put("previewRun", previewRun); - }}; - - String r = send(RequestMethod.POST, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, Integer.toString(pipelineId), "preview", ApiVersion.PIPELINES, null, body, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, PreviewRun.class); - } - - /** - * Queues a dry run of the pipeline and returns an object containing the final yaml. - * - * @param pipelineId The pipeline ID. - * @param previewRun If true, don't actually create a new run. Instead, return the final YAML document after parsing templates. - * @param yamlOverride If you use the preview run option, you may optionally supply different YAML. - * This allows you to preview the final YAML document without committing a changed file. - * @return PreviewRun object {@link PreviewRun} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PreviewRun previewPipeline(int pipelineId, boolean previewRun, String yamlOverride) throws AzDException { - var body = new HashMap() {{ - put("previewRun", previewRun); - put("yamlOverride", yamlOverride); - }}; - - String r = send(RequestMethod.POST, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, Integer.toString(pipelineId), "preview", ApiVersion.PIPELINES, null, body, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, PreviewRun.class); - } - - /** - * Gets a run for a particular pipeline. - * - * @param pipelineId The pipeline id - * @param runId The run id - * @return Pipeline run object {@link PipelineRun} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PipelineRun getPipelineRun(int pipelineId, int runId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, Integer.toString(pipelineId), "runs/" + runId, ApiVersion.PIPELINES, null, null, null); - - return MAPPER.mapJsonResponse(r, PipelineRun.class); - } - - /** - * Gets top 10000 runs for a particular pipeline. - * - * @param pipelineId The pipeline id - * @return a list of pipeline run object {@link PipelineRuns} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PipelineRuns getPipelineRuns(int pipelineId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, Integer.toString(pipelineId), "runs", ApiVersion.PIPELINES, null, null, null); - - return MAPPER.mapJsonResponse(r, PipelineRuns.class); - } - - /** - * Runs a pipeline. - * - * @param pipelineId The pipeline id - * @return a pipeline run object {@link PipelineRun} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PipelineRun runPipeline(int pipelineId) throws AzDException { - var body = new HashMap() {{ - put("resources", "{}"); - }}; - - String r = send(RequestMethod.POST, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, Integer.toString(pipelineId), "runs", ApiVersion.PIPELINES, null, body, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, PipelineRun.class); - } - - /** - * Runs a pipeline. - * - * @param pipelineId The pipeline id - * @param pipelineRunParameters a map of request parameters. - * @return a pipeline run object {@link PipelineRun} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PipelineRun runPipeline(int pipelineId, Map pipelineRunParameters) throws AzDException { - String r = send(RequestMethod.POST, CONNECTION, PIPELINES, CONNECTION.getProject(), - AREA, Integer.toString(pipelineId), "runs", ApiVersion.PIPELINES, null, pipelineRunParameters, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, PipelineRun.class); - } -} diff --git a/azd/src/main/java/org/azd/pipelines/types/CreatePipelineConfigurationParameters.java b/azd/src/main/java/org/azd/pipelines/types/CreatePipelineConfigurationParameters.java index eb1cffec..b395e0d0 100644 --- a/azd/src/main/java/org/azd/pipelines/types/CreatePipelineConfigurationParameters.java +++ b/azd/src/main/java/org/azd/pipelines/types/CreatePipelineConfigurationParameters.java @@ -7,7 +7,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import org.azd.abstractions.serializer.SerializableEntity; import org.azd.enums.ConfigurationType; /** diff --git a/azd/src/main/java/org/azd/pipelines/types/CreatePipelineParameters.java b/azd/src/main/java/org/azd/pipelines/types/CreatePipelineParameters.java index ad8ea98e..b3b643b8 100644 --- a/azd/src/main/java/org/azd/pipelines/types/CreatePipelineParameters.java +++ b/azd/src/main/java/org/azd/pipelines/types/CreatePipelineParameters.java @@ -7,7 +7,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import org.azd.abstractions.serializer.SerializableEntity; /** * Parameters to create a pipeline. diff --git a/azd/src/main/java/org/azd/pipelines/types/Pipeline.java b/azd/src/main/java/org/azd/pipelines/types/Pipeline.java index e307bc69..a76e18c3 100644 --- a/azd/src/main/java/org/azd/pipelines/types/Pipeline.java +++ b/azd/src/main/java/org/azd/pipelines/types/Pipeline.java @@ -4,8 +4,6 @@ import com.fasterxml.jackson.annotation.JsonProperty; import org.azd.abstractions.serializer.SerializableEntity; -import java.util.Objects; - /** * Definition of a pipeline. */ diff --git a/azd/src/main/java/org/azd/policy/PolicyApi.java b/azd/src/main/java/org/azd/policy/PolicyApi.java deleted file mode 100644 index e984afa4..00000000 --- a/azd/src/main/java/org/azd/policy/PolicyApi.java +++ /dev/null @@ -1,206 +0,0 @@ -package org.azd.policy; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.enums.CustomHeader; -import org.azd.enums.RequestMethod; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.PolicyDetails; -import org.azd.policy.types.PolicyConfiguration; -import org.azd.policy.types.PolicyConfigurations; -import org.azd.policy.types.PolicyType; -import org.azd.policy.types.PolicyTypes; -import org.azd.utils.AzDAsyncApi; - -import java.util.HashMap; -import java.util.LinkedHashMap; -import java.util.Map; - -import static org.azd.utils.RestClient.send; - -/** - * PolicyApi class to manage Policy API - */ -public class PolicyApi extends AzDAsyncApi implements PolicyDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "policy"; - private final String POLICY = "fb13a388-40dd-4a04-b530-013a739c72ef"; - - /** - * Pass the connection object to work with Policy Api - * - * @param connection Connection object - */ - public PolicyApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Create a policy configuration of a given policy type. - * - * @param typeId Guid of the policy type. - * @param isEnabled If set to true the policy will be enabled. - * @param isBlocking If set to true direct commit will be blocked to the branch specified. - * @param settings A Map of user specified settings. - * Check https://docs.microsoft.com/en-us/rest/api/azure/devops/policy/configurations/create?view=azure-devops-rest-6.1#examples - * for more examples and how to configure the policy. - * @return PolicyConfiguration object {@link PolicyConfiguration} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PolicyConfiguration createPolicyConfiguration(String typeId, boolean isEnabled, boolean isBlocking, Map settings) throws AzDException { - LinkedHashMap h = new LinkedHashMap<>() {{ - put("isEnabled", isEnabled); - put("isBlocking", isBlocking); - put("type", new LinkedHashMap() {{ - put("id", typeId); - }}); - put("settings", settings); - }}; - - String r = send(RequestMethod.POST, CONNECTION, POLICY, CONNECTION.getProject(), - AREA + "/configurations", null, null, ApiVersion.POLICY, null, h, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, PolicyConfiguration.class); - } - - /** - * Delete a policy configuration by its ID. - * - * @param configurationId ID of the policy configuration to delete. - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deletePolicyConfiguration(int configurationId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, POLICY, CONNECTION.getProject(), - AREA + "/configurations", Integer.toString(configurationId), null, ApiVersion.POLICY, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Get a policy configuration by its ID. - * - * @param configurationId ID of the policy configuration - * @return PolicyConfiguration object {@link PolicyConfiguration} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PolicyConfiguration getPolicyConfiguration(int configurationId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, POLICY, CONNECTION.getProject(), - AREA + "/configurations", Integer.toString(configurationId), null, ApiVersion.POLICY, null, null, null); - - return MAPPER.mapJsonResponse(r, PolicyConfiguration.class); - } - - /** - * Get a list of policy configurations in a project. - * - * @return PolicyConfigurations object {@link PolicyConfigurations} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PolicyConfigurations getPolicyConfigurations() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, POLICY, CONNECTION.getProject(), - AREA + "/configurations", null, null, ApiVersion.POLICY, null, null, null); - - return MAPPER.mapJsonResponse(r, PolicyConfigurations.class); - } - - /** - * Get a list of policy configurations in a project. - * - * @param top Maximum number of policies to return. - * @param continuationToken The continuation token used for pagination. - * @param policyType Filter returned policies to only this type - * @return PolicyConfigurations object {@link PolicyConfigurations} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PolicyConfigurations getPolicyConfigurations(int top, String continuationToken, String policyType) throws AzDException { - var q = new HashMap() {{ - put("$top", top); - put("continuationToken", continuationToken); - put("policyType", policyType); - }}; - - String r = send(RequestMethod.GET, CONNECTION, POLICY, CONNECTION.getProject(), - AREA + "/configurations", null, null, ApiVersion.POLICY, null, null, null); - - return MAPPER.mapJsonResponse(r, PolicyConfigurations.class); - } - - /** - * Update a policy configuration by its ID. - * - * @param configurationId ID of the existing policy configuration to be updated. - * @param typeId Guid of the configuration policy type. - * @param isEnabled If set to true the policy will be enabled. - * @param isBlocking If set to true direct commit will be blocked to the branch specified. - * @param settings A Map of user specified settings. - * Check https://docs.microsoft.com/en-us/rest/api/azure/devops/policy/configurations/update?view=azure-devops-rest-6.1#examples - * for more examples and how to configure the policy. - * @return PolicyConfiguration object {@link PolicyConfiguration} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PolicyConfiguration updatePolicyConfiguration(int configurationId, String typeId, boolean isEnabled, boolean isBlocking, Map settings) - throws AzDException { - String id; - - if (typeId.isEmpty()) id = getPolicyConfiguration(configurationId).getType().getId(); - else id = typeId; - - LinkedHashMap h = new LinkedHashMap<>() {{ - put("isEnabled", isEnabled); - put("isBlocking", isBlocking); - put("type", new LinkedHashMap() {{ - put("id", id); - }}); - put("settings", settings); - }}; - - String r = send(RequestMethod.PUT, CONNECTION, POLICY, CONNECTION.getProject(), - AREA + "/configurations", Integer.toString(configurationId), null, ApiVersion.POLICY, null, h, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, PolicyConfiguration.class); - } - - /** - * Retrieve a specific policy type by ID. - * - * @param typeId Guid of the configuration policy type. - * @return PolicyType object {@link PolicyType} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PolicyType getPolicyType(String typeId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, POLICY, CONNECTION.getProject(), - AREA + "/types", typeId, null, ApiVersion.POLICY, null, null, null); - - return MAPPER.mapJsonResponse(r, PolicyType.class); - } - - /** - * Retrieve all available policy types. - * - * @return PolicyTypes object {@link PolicyTypes} - * @throws AzDException Default Api Exception handler. - */ - @Override - public PolicyTypes getPolicyTypes() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, POLICY, CONNECTION.getProject(), - AREA + "/types", null, null, ApiVersion.POLICY, null, null, null); - - return MAPPER.mapJsonResponse(r, PolicyTypes.class); - } -} diff --git a/azd/src/main/java/org/azd/policy/types/PolicyConfiguration.java b/azd/src/main/java/org/azd/policy/types/PolicyConfiguration.java index 2f131fc1..ae888850 100644 --- a/azd/src/main/java/org/azd/policy/types/PolicyConfiguration.java +++ b/azd/src/main/java/org/azd/policy/types/PolicyConfiguration.java @@ -2,7 +2,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.databind.JsonNode; import org.azd.abstractions.serializer.SerializableEntity; import org.azd.common.types.Author; diff --git a/azd/src/main/java/org/azd/release/ReleaseApi.java b/azd/src/main/java/org/azd/release/ReleaseApi.java deleted file mode 100644 index c38a0169..00000000 --- a/azd/src/main/java/org/azd/release/ReleaseApi.java +++ /dev/null @@ -1,944 +0,0 @@ -package org.azd.release; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.distributedtask.types.VariableGroupMap; -import org.azd.enums.*; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.ReleaseDetails; -import org.azd.release.types.*; -import org.azd.utils.AzDAsyncApi; - -import java.util.*; - -import static org.azd.utils.RestClient.send; - -/** - * Release Api to manage releases service - */ -public class ReleaseApi extends AzDAsyncApi implements ReleaseDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "release/releases"; - private final String RELEASE = "efc2f575-36ef-48e9-b672-0c6fb4a48ac5"; - - /** - * Pass the connection object to work with Release Api - * - * @param connection Connection object - */ - public ReleaseApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Create a release. - * - * @param releaseDefinitionId pass definition Id to create a release. - * @param description pass description to create a release. - * @param artifactAlias build pipeline alias name. Run getBuilds() from BuildApi to get the build alias name and build number. - * @param artifactId pass the build id. - * @param artifactName pass the build pipeline name - * @param isDraft creates the release as draft if set to false - * @return Release {@link Release} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Release createRelease(int releaseDefinitionId, String description, String artifactAlias, - String artifactId, String artifactName, - boolean isDraft) throws AzDException { - - var artifacts = new LinkedHashMap() {{ - put("alias", artifactAlias); - put("instanceReference", new LinkedHashMap() {{ - put("id", artifactId); - put("name", artifactName); - }}); - }}; - - var h = new LinkedHashMap() {{ - put("definitionId", Integer.toString(releaseDefinitionId)); - put("description", description); - put("artifacts", List.of(artifacts)); - put("isDraft", isDraft); - put("reason", "none"); - put("manualEnvironments", null); - }}; - - String r = send(RequestMethod.POST, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, null, null, ApiVersion.RELEASES, null, h, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, Release.class); - } - - /** - * Get a Release - * - * @param releaseId pass the release id - * @return Release {@link Release} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Release getRelease(int releaseId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, Integer.toString(releaseId), null, ApiVersion.RELEASES, null, null, null); - - return MAPPER.mapJsonResponse(r, Release.class); - } - - /** - * Gets a Release - * - * @param releaseId pass the release id - * @param expand field to expand in the result. {@link SingleReleaseExpands} - * @return Release {@link Release} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Release getRelease(int releaseId, SingleReleaseExpands expand) throws AzDException { - var q = new HashMap() {{ - put("$expand", expand.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, Integer.toString(releaseId), null, ApiVersion.RELEASES, q, null, null); - - return MAPPER.mapJsonResponse(r, Release.class); - } - - /** - * Gets a Release - * - * @param releaseId pass the release id - * @param expand field to expand in the result. {@link SingleReleaseExpands} - * @param approvalFilters A filter which would allow fetching approval steps selectively based on whether it is automated, or manual. - * This would also decide whether we should fetch pre and post approval snapshots. Assumes All by default - * @param propertyFilters A comma-delimited list of extended properties to be retrieved. - * If set, the returned Release will contain values for the specified property Ids (if they exist). - * If not set, properties will not be included. - * @param topGateRecords Number of release gate records to get. Default is 5. - * @return Release {@link Release} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Release getRelease(int releaseId, SingleReleaseExpands expand, - ReleaseApprovalFilters approvalFilters, String[] propertyFilters, - int topGateRecords) throws AzDException { - var q = new HashMap() {{ - put("approvalFilters", approvalFilters); - put("propertyFilters", String.join(",", propertyFilters)); - put("$expand", expand.toString().toLowerCase()); - put("$topGateRecords", topGateRecords); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, Integer.toString(releaseId), null, ApiVersion.RELEASES, q, null, null); - - return MAPPER.mapJsonResponse(r, Release.class); - } - - /** - * Get a release environment. - * - * @param releaseId pass the release id - * @param environmentId Id of the release environment. - * @return Release Environment {@link ReleaseEnvironment} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ReleaseEnvironment getReleaseEnvironment(int releaseId, int environmentId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, Integer.toString(releaseId), "environments/" + environmentId, - ApiVersion.RELEASE_ENVIRONMENT, null, null, null); - - return MAPPER.mapJsonResponse(r, ReleaseEnvironment.class); - } - - /** - * Get a release environment. - * - * @param releaseId pass the release id - * @param environmentId Id of the release environment. - * @param expand Release expands {@link SingleReleaseExpands} - * @return Release Environment {@link ReleaseEnvironment} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ReleaseEnvironment getReleaseEnvironment(int releaseId, int environmentId, - SingleReleaseExpands expand) throws AzDException { - var q = new HashMap() {{ - put("$expand", expand.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, Integer.toString(releaseId), "environments/" + environmentId, - ApiVersion.RELEASE_ENVIRONMENT, q, null, null); - - return MAPPER.mapJsonResponse(r, ReleaseEnvironment.class); - } - - /** - * Get a list of releases - * - * @return Releases {@link Releases} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Releases getReleases() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, null, null, ApiVersion.RELEASES, null, null, null); - - return MAPPER.mapJsonResponse(r, Releases.class); - } - - /** - * Get a list of releases - * - * @param expand The property that should be expanded in the list of releases. {@link ReleaseExpands} - * @return Releases {@link Releases} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Releases getReleases(ReleaseExpands expand) throws AzDException { - var q = new HashMap() {{ - put("$expand", expand.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, null, null, ApiVersion.RELEASES, q, null, null); - - return MAPPER.mapJsonResponse(r, Releases.class); - } - - /** - * Get a list of releases - * - * @param definitionId pass the release definition id - * @return Releases {@link Releases} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Releases getReleases(int definitionId) throws AzDException { - var q = new HashMap() {{ - put("definitionId", definitionId); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, null, null, ApiVersion.RELEASES, q, null, null); - - return MAPPER.mapJsonResponse(r, Releases.class); - } - - /** - * Get a list of releases - * - * @param expand The property that should be expanded in the list of releases. {@link ReleaseExpands} - * @param top Number of releases to get. Default is 50. - * @return Releases {@link Releases} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Releases getReleases(ReleaseExpands expand, int top) throws AzDException { - var q = new HashMap() {{ - put("$expand", expand.toString().toLowerCase()); - put("$top", top); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, null, null, ApiVersion.RELEASES, q, null, null); - - return MAPPER.mapJsonResponse(r, Releases.class); - } - - /** - * Get a list of releases - * - * @param releaseIdFilter A comma-delimited list of releases Ids. Only releases with these Ids will be returned. - * @return Releases {@link Releases} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Releases getReleases(String[] releaseIdFilter) throws AzDException { - var q = new HashMap() {{ - put("releaseIdFilter", String.join(",", releaseIdFilter)); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, null, null, ApiVersion.RELEASES, q, null, null); - - return MAPPER.mapJsonResponse(r, Releases.class); - } - - /** - * Get a list of releases - * - * @param expand The property that should be expanded in the list of releases. {@link ReleaseExpands} - * @param artifactVersionId Releases with given artifactVersionId will be returned. E.g. in case of Build artifactType, it is buildId. - * @return Releases {@link Releases} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Releases getReleases(ReleaseExpands expand, String artifactVersionId) throws AzDException { - var q = new HashMap() {{ - put("$expand", expand.toString().toLowerCase()); - put("artifactVersionId", artifactVersionId); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, null, null, ApiVersion.RELEASES, q, null, null); - - return MAPPER.mapJsonResponse(r, Releases.class); - } - - /** - * Get a list of releases - * - * @param expand The property that should be expanded in the list of releases. {@link ReleaseExpands} - * @param top Number of releases to get. Default is 50. - * @param artifactTypeId Releases with given artifactTypeId will be returned. - * Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild. - * @param artifactVersionId Releases with given artifactVersionId will be returned. E.g. in case of Build artifactType, it is buildId. - * @param continuationToken Gets the releases after the continuation token provided. - * @param createdBy Releases created by this user. - * @param definitionEnvironmentId pass the release definition environment id - * @param definitionId Releases from this release definition Id. - * @param environmentStatusFilter environment status filter - * @param isDeleted Gets the soft deleted releases, if true. - * @param maxCreatedTime Releases that were created before this time. - * @param minCreatedTime Releases that were created after this time. - * @param path Releases under this folder path will be returned - * @param propertyFilters A comma-delimited list of extended properties to be retrieved. - * If set, the returned Releases will contain values for the specified property Ids (if they exist). - * If not set, properties will not be included. Note that this will not filter out any Release from - * results irrespective of whether it has property set or not. - * @param queryOrder Gets the results in the defined order of created date for releases. Default is descending. - * @param releaseIdFilter A comma-delimited list of releases Ids. Only releases with these Ids will be returned. - * @param searchText Releases with names containing searchText. - * @param sourceBranchFilter Releases with given sourceBranchFilter will be returned. - * @param sourceId Unique identifier of the artifact used. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, - * for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be - * {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. TeamCity, - * BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json - * https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions. - * @param statusFilter Releases that have the status from {@link ReleaseStatus}. - * @param tagFilter A comma-delimited list of tags. Only releases with these tags will be returned. - * @return Releases {@link Releases} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Releases getReleases(ReleaseExpands expand, int top, String artifactTypeId, String artifactVersionId, - int continuationToken, String createdBy, int definitionEnvironmentId, int definitionId, - int environmentStatusFilter, boolean isDeleted, String maxCreatedTime, String minCreatedTime, - String path, String[] propertyFilters, ReleaseQueryOrder queryOrder, String[] releaseIdFilter, - String searchText, String sourceBranchFilter, String sourceId, ReleaseStatus statusFilter, - String[] tagFilter) throws AzDException { - var q = new HashMap() {{ - put("definitionId", definitionId); - put("definitionEnvironmentId", definitionEnvironmentId); - put("searchText", searchText); - put("createdBy", createdBy); - put("statusFilter", statusFilter); - put("environmentStatusFilter", environmentStatusFilter); - put("minCreatedTime", minCreatedTime); - put("maxCreatedTime", maxCreatedTime); - put("queryOrder", queryOrder.toString().toLowerCase()); - put("$top", top); - put("continuationToken", continuationToken); - put("artifactTypeId", artifactTypeId); - put("sourceId", sourceId); - put("artifactVersionId", artifactVersionId); - put("sourceBranchFilter", sourceBranchFilter); - put("isDeleted", isDeleted); - put("$expand", expand.toString().toLowerCase()); - put("tagFilter", String.join(",", tagFilter)); - put("propertyFilters", String.join(",", propertyFilters)); - put("path", path); - put("releaseIdFilter", String.join(",", releaseIdFilter)); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, null, null, ApiVersion.RELEASES, q, null, null); - - return MAPPER.mapJsonResponse(r, Releases.class); - } - - /** - * Create a release definition - * - * @param releaseDefinitionParameters Pass the release definition parameter as string. It is easy to export - * json result from an existing pipeline and edit it. - * @return ReleaseDefinition {@link ReleaseDefinition} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ReleaseDefinition createReleaseDefinition(String releaseDefinitionParameters) throws AzDException { - - var body = MAPPER.mapJsonResponse(releaseDefinitionParameters, HashMap.class); - - String r = send(RequestMethod.POST, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "definitions"), null, null, ApiVersion.RELEASE_DEFINITION, - null, body, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, ReleaseDefinition.class); - } - - /** - * Delete a release definition. - * - * @param definitionId Id of the release definition/pipeline. - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteReleaseDefinition(int definitionId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "definitions"), Integer.toString(definitionId), - null, ApiVersion.RELEASE_DEFINITION, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Delete a release definition. - * - * @param definitionId Id of the release definition/pipeline. - * @param comment Comment for deleting a release definition. - * @param forceDelete 'true' to automatically cancel any in-progress release deployments - * and proceed with release definition deletion . Default is 'false'. - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteReleaseDefinition(int definitionId, String comment, boolean forceDelete) throws AzDException { - try { - var q = new HashMap() {{ - put("comment", comment); - put("forceDelete", forceDelete); - }}; - - String r = send(RequestMethod.DELETE, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "definitions"), Integer.toString(definitionId), - null, ApiVersion.RELEASE_DEFINITION, q, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Get a release definition. - * - * @param definitionId Id of the release definition/pipeline. - * @return ReleaseDefinition {@link ReleaseDefinition} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ReleaseDefinition getReleaseDefinition(int definitionId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "definitions"), Integer.toString(definitionId), - null, ApiVersion.RELEASE_DEFINITION, null, null, null); - - return MAPPER.mapJsonResponse(r, ReleaseDefinition.class); - } - - /** - * Get revision history for a release definition - * - * @param definitionId Id of the release definition/pipeline. - * @return ReleaseDefinitionRevisions {@link ReleaseDefinitionRevisions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ReleaseDefinitionRevisions getReleaseDefinitionHistory(int definitionId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "definitions"), Integer.toString(definitionId), - "revisions", ApiVersion.RELEASE_DEFINITION_HISTORY, null, null, null); - - return MAPPER.mapJsonResponse(r, ReleaseDefinitionRevisions.class); - } - - /** - * Get a list of release definitions. - * - * @return ReleaseDefinitions {@link ReleaseDefinitions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ReleaseDefinitions getReleaseDefinitions() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "definitions"), null, - null, ApiVersion.RELEASE_DEFINITION, null, null, null); - - return MAPPER.mapJsonResponse(r, ReleaseDefinitions.class); - } - - /** - * Get a list of release definitions. - * - * @param expands The properties that should be expanded in the list of Release definitions. {@link ReleaseDefinitionExpands} - * @return ReleaseDefinition Object {@link ReleaseDefinition} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public ReleaseDefinitions getReleaseDefinitions(ReleaseDefinitionExpands expands) throws AzDException { - var q = new HashMap() {{ - put("$expand", expands.name()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "definitions"), null, - null, ApiVersion.RELEASE_DEFINITION, q, null, null); - - return MAPPER.mapJsonResponse(r, ReleaseDefinitions.class); - } - - /** - * Get a list of release definitions. - * - * @param top Number of release definitions to get. - * @return ReleaseDefinition Object {@link ReleaseDefinition} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public ReleaseDefinitions getReleaseDefinitions(int top) throws AzDException { - var q = new HashMap() {{ - put("$top", top); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "definitions"), null, - null, ApiVersion.RELEASE_DEFINITION, q, null, null); - - return MAPPER.mapJsonResponse(r, ReleaseDefinitions.class); - } - - /** - * Get a list of release definitions. - * - * @param artifactSourceId Release definitions with given artifactSourceId will be - * returned. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be - * {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be - * {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. - * For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' - * inside vss-extension.json at https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions. - * @return ReleaseDefinition Object {@link ReleaseDefinition} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public ReleaseDefinitions getReleaseDefinitions(String artifactSourceId) throws AzDException { - var q = new HashMap() {{ - put("artifactSourceId", artifactSourceId); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "definitions"), null, - null, ApiVersion.RELEASE_DEFINITION, q, null, null); - - return MAPPER.mapJsonResponse(r, ReleaseDefinitions.class); - } - - /** - * Get a list of release definitions. - * - * @param definitionIdFilter A comma-delimited list of release definitions to retrieve. - * @return ReleaseDefinition Object {@link ReleaseDefinition} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public ReleaseDefinitions getReleaseDefinitions(int[] definitionIdFilter) throws AzDException { - var q = new HashMap() {{ - put("definitionIdFilter", intArrayToString(definitionIdFilter)); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "definitions"), null, - null, ApiVersion.RELEASE_DEFINITION, q, null, null); - - return MAPPER.mapJsonResponse(r, ReleaseDefinitions.class); - } - - /** - * Get a list of release definitions. - * - * @param expands The properties that should be expanded in the list of Release definitions. - * @param top Number of release definitions to get. - * @param artifactSourceId Release definitions with given artifactSourceId will be returned. e.g. - * For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be - * {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be - * {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. - * TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json at - * https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions. - * @param artifactType Release definitions with given artifactType will be returned. Values can be - * Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild. - * @param continuationToken Gets the release definitions after the continuation token provided. - * @param definitionIdFilter A comma-delimited list of release definitions to retrieve. - * @param isDeleted 'true' to get release definitions that has been deleted. Default is 'false' - * @param isExactNameMatch 'true'to gets the release definitions with exact match as specified in searchText. Default is 'false'. - * @param path Gets the release definitions under the specified path. - * @param propertyFilters A comma-delimited list of extended properties to be retrieved. - * If set, the returned Release Definitions will contain values for the specified property Ids - * (if they exist). If not set, properties will not be included. Note that this will not filter out - * any Release Definition from results irrespective of whether it has property set or not. - * @param queryOrder Gets the results in the defined order. Default is 'IdAscending'. - * @param searchText Get release definitions with names containing searchText. - * @param searchTextContainsFolderName 'true' to get the release definitions under the folder with name as - * specified in searchText. Default is 'false'. - * @param tagFilter A comma-delimited list of tags. Only release definitions with these tags will be returned. - * @return ReleaseDefinition Object {@link ReleaseDefinition} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public ReleaseDefinitions getReleaseDefinitions(ReleaseDefinitionExpands expands, int top, - String artifactSourceId, String artifactType, - String continuationToken, int[] definitionIdFilter, - boolean isDeleted, boolean isExactNameMatch, String path, - String[] propertyFilters, ReleaseDefinitionQueryOrder queryOrder, - String searchText, boolean searchTextContainsFolderName, - String[] tagFilter) throws AzDException { - var q = new HashMap() {{ - put("$expand", expands.name()); - put("$top", top); - put("artifactSourceId", artifactSourceId); - put("artifactType", artifactType); - put("continuationToken", continuationToken); - put("definitionIdFilter", intArrayToString(definitionIdFilter)); - put("isDeleted", isDeleted); - put("isExactNameMatch", isExactNameMatch); - put("path", path); - put("propertyFilters", String.join(",", propertyFilters)); - put("queryOrder", queryOrder.name()); - put("searchText", searchText); - put("searchTextContainsFolderName", searchTextContainsFolderName); - put("tagFilter", String.join(",", tagFilter)); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "definitions"), null, - null, ApiVersion.RELEASE_DEFINITION, q, null, null); - - return MAPPER.mapJsonResponse(r, ReleaseDefinitions.class); - } - - /** - * Update a release definition. - * - * @param releaseDefinition Pass the release definition {@link ReleaseDefinition} object. You can get it by running - * either getReleaseDefinitions() or getReleaseDefinition(int definitionId) - * @return a ReleaseDefinition {@link ReleaseDefinition} object. - * @throws AzDException Default Api exception handler. - */ - @Override - public ReleaseDefinition updateReleaseDefinition(ReleaseDefinition releaseDefinition) throws AzDException { - String r = send(RequestMethod.PUT, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "definitions"), null, - null, ApiVersion.RELEASE_DEFINITION, null, releaseDefinition, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, ReleaseDefinition.class); - } - - /** - * Delete a release using release id. - * - * @param releaseId Release id to delete - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteRelease(int releaseId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, Integer.toString(releaseId), null, ApiVersion.RELEASES, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Update a complete release object. - * - * @param releaseId Id of the release to update. - * @param release Release object to update - * @return a release object {@link Release} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Release updateRelease(int releaseId, Release release) throws AzDException { - String r = send(RequestMethod.PUT, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, Integer.toString(releaseId), null, ApiVersion.RELEASES, null, release, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, Release.class); - } - - /** - * Update the status of a release environment. - * - * @param releaseId Id of the release to update. - * @param environmentId Id of the stage or environment to update. - * @param comment Gets or sets comment. - * @param scheduledDeploymentTime Gets or sets scheduled deployment time. - * @param status Gets or sets status of environment. - * @param variables Sets list of environment variables to be overridden at deployment time. - * @return ReleaseEnvironment object {@link ReleaseEnvironment} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ReleaseEnvironment updateReleaseEnvironment(int releaseId, int environmentId, String comment, - String scheduledDeploymentTime, ReleaseEnvironmentStatus status, VariableGroupMap variables) - throws AzDException { - var b = new HashMap() {{ - put("comment", comment); - put("scheduledDeploymentTime", scheduledDeploymentTime); - put("status", status.toString().toLowerCase()); - }}; - - if (variables != null) b.put("variables", variables.get()); - - String r = send(RequestMethod.PATCH, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, Integer.toString(releaseId), "environments/" + environmentId, ApiVersion.RELEASE_ENVIRONMENT, - null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, ReleaseEnvironment.class); - } - - /** - * Update few properties of a release. - * - * @param releaseId Id of the release to update. - * @param comment Sets comment for release. - * @param keepForever Set 'true' to exclude the release from retention policies. - * @param manualEnvironments Sets list of manual environments. - * @param status Sets status of the release. - * @param name Sets name of the release. - * @return A release object {@link Release} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Release updateReleaseResource(int releaseId, String comment, boolean keepForever, String[] manualEnvironments, - ReleaseStatus status, String name) throws AzDException { - var b = new HashMap() {{ - put("comment", comment); - put("keepForever", keepForever); - put("status", status.toString().toLowerCase()); - put("manualEnvironments", manualEnvironments); - put("name", name); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, Integer.toString(releaseId), null, ApiVersion.RELEASES, null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, Release.class); - } - - /** - * Queue a release pipeline with release id and environment or stage name. - * - * @param releaseId Id of the release - * @param environmentName Stage name or environment name - * @return Release Environment object {@link ReleaseEnvironment} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ReleaseEnvironment queueRelease(int releaseId, String environmentName) throws AzDException { - var release = getRelease(releaseId); - boolean environment = release - .getEnvironments() - .stream() - .anyMatch(x -> x.getName().equals(environmentName)); - - if (environment) { - int environmentId = release - .getEnvironments() - .stream() - .filter(x -> x.getName().equals(environmentName)) - .findFirst() - .get() - .getId(); - - return updateReleaseEnvironment(releaseId, environmentId, null, null, - ReleaseEnvironmentStatus.INPROGRESS, null); - } - - throw new AzDException("NoSuchElementException", "Given environment name '" + environmentName + "' doesn't exist."); - } - - /** - * Abandon a release. - * - * @param releaseId Id of the release - * @return A release object {@link Release} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Release abandonRelease(int releaseId) throws AzDException { - return updateReleaseResource(releaseId, null, false, null, ReleaseStatus.ABANDONED, null); - } - - /** - * Get a list of approvals - * - * @return List of release approvals {@link ReleaseApprovals} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ReleaseApprovals getReleaseApprovals() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "approvals"), null, null, ApiVersion.RELEASE, null, null, null); - - return MAPPER.mapJsonResponse(r, ReleaseApprovals.class); - } - - /** - * Get a list of approvals - * - * @param releaseIdsFilter array of release ids to filter the approvals - * @return List of release approvals {@link ReleaseApprovals} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ReleaseApprovals getReleaseApprovals(int[] releaseIdsFilter) throws AzDException { - var q = new HashMap() {{ - put("releaseIdsFilter", String.join(",", intArrayToString(releaseIdsFilter))); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "approvals"), null, null, ApiVersion.RELEASE, q, null, null); - - return MAPPER.mapJsonResponse(r, ReleaseApprovals.class); - } - - /** - * Get a list of approvals - * - * @param assignedToFilter Approvals assigned to this user. - * @param continuationToken Gets the approvals after the continuation token provided. - * @param includeMyGroupApprovals 'true' to include my group approvals. Default is 'false'. - * @param queryOrder Gets the results in the defined order of created approvals. Default is 'descending'. - * @param releaseIdsFilter Approvals for release id(s) mentioned in the filter. - * Multiple releases can be mentioned by separating them with ',' e.g. releaseIdsFilter=1,2,3,4. - * @param statusFilter Approvals with this status. Default is 'pending'. - * @param top Number of approvals to get. Default is 50. - * @param typeFilter Approval with this type. - * @return List of release approvals {@link ReleaseApprovals} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ReleaseApprovals getReleaseApprovals(String assignedToFilter, int continuationToken, boolean includeMyGroupApprovals, - ReleaseQueryOrder queryOrder, int[] releaseIdsFilter, ReleaseApprovalStatus statusFilter, - int top, ReleaseApprovalType typeFilter) throws AzDException { - var q = new HashMap() {{ - put("assignedToFilter", assignedToFilter); - put("continuationToken", continuationToken); - put("includeMyGroupApprovals", includeMyGroupApprovals); - put("queryOrder", queryOrder.toString().toLowerCase()); - put("releaseIdsFilter", String.join(",", intArrayToString(releaseIdsFilter))); - put("statusFilter", statusFilter); - put("top", top); - put("typeFilter", typeFilter.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "approvals"), null, null, ApiVersion.RELEASE, q, null, null); - - return MAPPER.mapJsonResponse(r, ReleaseApprovals.class); - } - - /** - * Update status of an approval - * - * @param approvalId Id of the approval. - * @param status Gets or sets the status of the approval. - * @param comments Gets or sets comments for approval. - * @return release approval object {@link ReleaseApproval} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ReleaseApproval updateApproval(int approvalId, ReleaseApprovalStatus status, String comments) throws AzDException { - var body = new HashMap() {{ - put("status", status.toString().toLowerCase()); - put("comments", comments); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA.replace("releases", "approvals"), Integer.toString(approvalId), null, ApiVersion.RELEASE, null, body, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, ReleaseApproval.class); - } - - /** - * Get manual intervention for a given release and manual intervention id. - * - * @param releaseId Id of the manual intervention. - * @param manualInterventionId Id of the release. - * @return manual intervention object {@link ManualIntervention} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ManualIntervention getManualIntervention(int releaseId, int manualInterventionId) throws AzDException { - String id = releaseId + "/manualinterventions/" + manualInterventionId; - - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, id, null, ApiVersion.RELEASE_MANUAL_INTERVENTION, null, null, null); - - return MAPPER.mapJsonResponse(r, ManualIntervention.class); - } - - /** - * List all manual interventions for a given release. - * - * @param releaseId Id of the release. - * @return list of manual intervention object {@link ManualInterventions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ManualInterventions getManualInterventions(int releaseId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, Integer.toString(releaseId), null, ApiVersion.RELEASE_MANUAL_INTERVENTION, null, null, null); - - return MAPPER.mapJsonResponse(r, ManualInterventions.class); - } - - /** - * Update manual intervention. - * - * @param releaseId Id of the release. - * @param manualInterventionId Id of the manual intervention. - * @param comment Sets the comment for manual intervention update. - * @param status Sets the status of the manual intervention. - * @return manual intervention object {@link ManualIntervention} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ManualIntervention updateManualIntervention(int releaseId, int manualInterventionId, String comment, ManualInterventionStatus status) - throws AzDException { - var body = new HashMap() {{ - put("status", status.toString().toLowerCase()); - put("comment", comment); - }}; - - String id = releaseId + "/manualinterventions/" + manualInterventionId; - - String r = send(RequestMethod.PATCH, CONNECTION, RELEASE, CONNECTION.getProject(), - AREA, id, null, ApiVersion.RELEASE_MANUAL_INTERVENTION, null, body, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, ManualIntervention.class); - } - - /** - * Helper method to convert integer array to string. - * - * @param i integer array - * @return {@link String} - */ - private String intArrayToString(int[] i) { - var r = Arrays.stream(i).mapToObj(String::valueOf).toArray(String[]::new); - return String.join(",", r); - } -} diff --git a/azd/src/main/java/org/azd/release/approvals/ApprovalsRequestBuilder.java b/azd/src/main/java/org/azd/release/approvals/ApprovalsRequestBuilder.java index 30154c65..0ecfe4d0 100644 --- a/azd/src/main/java/org/azd/release/approvals/ApprovalsRequestBuilder.java +++ b/azd/src/main/java/org/azd/release/approvals/ApprovalsRequestBuilder.java @@ -8,10 +8,8 @@ import org.azd.enums.ApprovalType; import org.azd.enums.ReleaseQueryOrder; import org.azd.exceptions.AzDException; -import org.azd.release.definitions.DefinitionsRequestBuilder; import org.azd.release.types.ReleaseApproval; import org.azd.release.types.ReleaseApprovals; -import org.azd.release.types.ReleaseEnvironment; import java.util.concurrent.CompletableFuture; import java.util.function.Consumer; diff --git a/azd/src/main/java/org/azd/security/SecurityApi.java b/azd/src/main/java/org/azd/security/SecurityApi.java deleted file mode 100644 index f9c9b1bb..00000000 --- a/azd/src/main/java/org/azd/security/SecurityApi.java +++ /dev/null @@ -1,291 +0,0 @@ -package org.azd.security; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.enums.ApiExceptionTypes; -import org.azd.enums.CustomHeader; -import org.azd.enums.RequestMethod; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.helpers.URLHelper; -import org.azd.helpers.Utils; -import org.azd.interfaces.SecurityDetails; -import org.azd.security.types.*; -import org.azd.utils.AzDAsyncApi; - -import java.util.Arrays; -import java.util.HashMap; -import java.util.LinkedHashMap; -import java.util.List; -import java.util.stream.Collectors; - -import static org.azd.utils.RestClient.send; - -public class SecurityApi extends AzDAsyncApi implements SecurityDetails { - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String SECURITY = "2e426be0-da4d-48c4-9178-978da8562255"; - private final String IDENTITY = "fc3682be-3d6c-427a-87c8-e527b16a1d05"; - private final String AREA_NAMESPACE = "securitynamespaces"; - private final String AREA_ACL = "accesscontrollists"; - private final String AREA_ACE = "accesscontrolentries"; - private final String AREA_IDENTITIES = "identities"; - - /** - * Pass the connection object to work with Security Api - * - * @param connection Connection object - */ - public SecurityApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * return all security namespaces, remote and local - *

- * Security namespaces are used to store access control lists (ACLs) on tokens. - * - * @return SecurityNamespaces {@link SecurityNamespaces} - * @throws AzDException Default Api Exception handler. - */ - @Override - public SecurityNamespaces getNamespaces() throws AzDException { - return getNamespaces(false); - } - - /** - * return all security namespaces, remote and local - *

- * Local vs. remote - *

    - *
  • Security namespaces may have their data mastered in one microservice, but still be visible in other microservices.
    • - *
  • If a security namespace's data is mastered in microservice X, it is said to be local to that microservice. Otherwise, it is said to be remote.
    • - *
- * - * @param localOnly whether to include only local or all namespaces - * @return SecurityNamespaces {@link SecurityNamespaces} - * @throws AzDException Default Api Exception handler. - */ - @Override - public SecurityNamespaces getNamespaces(boolean localOnly) throws AzDException { - LinkedHashMap q = new LinkedHashMap<>() {{ - put("localOnly", localOnly); - }}; - - String r = send(RequestMethod.GET, CONNECTION, SECURITY, null, - AREA_NAMESPACE, null, null, ApiVersion.SECURITY, q, null, null); - - return MAPPER.mapJsonResponse(r, SecurityNamespaces.class); - } - - /** - * return a namespace with the specific identifier - * - * @param namespaceId namespace identifier - * @return SecurityNamespace {@link SecurityNamespace} - * @throws AzDException Default Api Exception handler. - */ - @Override - public SecurityNamespace getNamespace(String namespaceId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, SECURITY, null, - AREA_NAMESPACE, namespaceId, null, ApiVersion.SECURITY, null, null, null); - - SecurityNamespaces securityNamespaces = MAPPER.mapJsonResponse(r, SecurityNamespaces.class); - return securityNamespaces.getSecurityNamespaces().get(0); - } - - /** - * Return a list of access control lists for the specified security namespace and token. - * All ACLs in the security namespace will be retrieved if no optional parameters are provided. - * - * @param namespaceId identifier of namespace - * @return ACLs {@link ACLs} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ACLs getAccessControlLists(String namespaceId) throws AzDException { - return getAccessControlLists(namespaceId, null, null, false, false); - } - - /** - * Return a list of access control lists for the specified security namespace and token. All ACLs in the security namespace will be retrieved if no optional parameters are provided. - * - * @param namespaceId identifier of namespace - * @param descriptors An optional filter string containing a list of identity descriptors separated by ',' whose ACEs should be retrieved. If this is left null, entire ACLs will be returned. - * @param token Security token. See Security namespace and permission reference for Azure DevOps - * @param includeExtendedInfo If true, populate the extended information properties for the access control entries contained in the returned lists. - * @param recurse If true and this is a hierarchical namespace, return child ACLs of the specified token. - * @return ACLs {@link ACLs} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ACLs getAccessControlLists(String namespaceId, String[] descriptors, String token, - boolean includeExtendedInfo, boolean recurse) throws AzDException { - HashMap q = new HashMap<>() {{ - if (descriptors != null && descriptors.length > 0) { - put("descriptors", Utils.toEncodedString(descriptors)); - } - if (token != null) { - put("token", URLHelper.encodeSpecialWithSpace(token)); - } - put("includeExtendedInfo", includeExtendedInfo); - put("recurse", recurse); - }}; - String r = send(RequestMethod.GET, CONNECTION, SECURITY, null, - AREA_ACL, namespaceId, null, ApiVersion.SECURITY, q, null, null); - - return MAPPER.mapJsonResponse(r, ACLs.class); - } - - /** - * Resolve legacy identity information for use with older APIs such as the Security APIs - * - * @param descriptors A list of identity descriptors to resolve - * @param identityIds A list of storage keys to resolve - * @param subjectDescriptors list of subject descriptors to resolve - * @param filterValue The search value, as specified by the searchFilter. - * @param queryMembership The membership information to include with the identities. Values can be - * None for no membership data or Direct to include the groups that the - * identity is a member of and the identities that are a member of this identity (groups only) - * @param searchFilter The type of search to perform. Values can be AccountName (domain\alias), - * DisplayName, MailAddress, General (display name, account name, or unique name), - * or LocalGroupName (only search Azure Devops groups). - * @return Identities {@link Identities} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Identities getIdentities(String[] descriptors, String[] identityIds, String[] subjectDescriptors, - String filterValue, String queryMembership, String searchFilter) throws AzDException { - LinkedHashMap q = new LinkedHashMap<>() {{ - if (descriptors != null && descriptors.length > 0) { - put("descriptors", Arrays.stream(descriptors) - .filter(x -> x != null && !x.isBlank()) - .map(URLHelper::encodeSpecialWithSpace) - .collect(Collectors.joining(","))); - } - if (identityIds != null && identityIds.length > 0) { - put("identityIds", Arrays.stream(identityIds) - .filter(x -> x != null && !x.isBlank()) - .map(URLHelper::encodeSpecialWithSpace) - .collect(Collectors.joining(","))); - } - if (subjectDescriptors != null && subjectDescriptors.length > 0) { - put("subjectDescriptors", Arrays.stream(subjectDescriptors) - .filter(x -> x != null && !x.isBlank()) - .map(URLHelper::encodeSpecialWithSpace) - .collect(Collectors.joining(","))); - } - if (filterValue != null) put("filterValue", URLHelper.encodeSpecialWithSpace(filterValue)); - if (validIdentityQueryMembership(queryMembership)) - put("queryMembership", URLHelper.encodeSpecialWithSpace(queryMembership)); - if (validIdentitySearchFilter(searchFilter)) - put("searchFilter", URLHelper.encodeSpecialWithSpace(searchFilter)); - }}; - String r = send(RequestMethod.GET, CONNECTION, IDENTITY, null, - AREA_IDENTITIES, null, null, ApiVersion.IDENTITY, q, null, null); - return MAPPER.mapJsonResponse(r, Identities.class); - } - - /** - * see {@link SecurityApi#getIdentities(String[], String[], String[], String, String, String)} - * shortcut to provide var args list of subjectDescriptors only - * - * @param subjectDescriptors list of subject descriptors to resolve - * @return Identities {@link Identities} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Identities getIdentitiesFromSubjectDescriptors(String... subjectDescriptors) throws AzDException { - return getIdentities(null, null, subjectDescriptors, null, null, null); - } - - /** - * Add or update ACEs in the ACL for the provided token. The request body contains the target token, a list of ACEs and a optional merge parameter. - * In the case of a collision (by identity descriptor) with an existing ACE in the ACL, the "merge" parameter determines the behavior. - * If set, the existing ACE has its allow and deny merged with the incoming ACE's allow and deny. If unset, the existing ACE is displaced. - * - * @param namespaceId Security namespace identifier. - * @param payload An array of {@link ACEs}. Class for encapsulating the allowed and denied permissions for a given IdentityDescriptor. - * @return ACEs {@link ACEs} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ACEs setAccessControlEntries(String namespaceId, ACEs payload) throws AzDException { - String r = send(RequestMethod.POST, CONNECTION, SECURITY, null, - AREA_ACE, namespaceId, null, ApiVersion.SECURITY, null, payload, CustomHeader.JSON_CONTENT_TYPE); - return MAPPER.mapJsonResponse(r, ACEs.class); - } - - /** - * Remove the specified ACEs from the ACL belonging to the specified token. - * - * @param namespaceId Security namespace identifier. - * @param descriptors A list of identity descriptors whose entries should be removed. - * @param tokens A list of tokens whose ACL should be modified. - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void removeAccessControlEntries(String namespaceId, String[] descriptors, String[] tokens) throws AzDException { - if (tokens == null || tokens.length == 0) - throw new AzDException(ApiExceptionTypes.InvalidArgumentException.name(), "Tokens list must not be empty."); - - if (descriptors == null || descriptors.length == 0) - throw new AzDException(ApiExceptionTypes.InvalidArgumentException.name(), "Descriptors list must not be empty."); - - HashMap q = new HashMap<>() {{ - put("tokens", Utils.toEncodedString(tokens)); - put("descriptors", Utils.toEncodedString(descriptors)); - }}; - - String r = send(RequestMethod.DELETE, CONNECTION, SECURITY, null, - AREA_ACE, namespaceId, null, ApiVersion.SECURITY, q, null, null); - return null; - } - - /** - * Create or update one or more access control lists. All data that currently exists for the ACLs supplied will be overwritten. - * - * @param namespaceId Security namespace identifier. - * @param payload ACLs {@link ACLs} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void setAccessControlList(String namespaceId, ACLs payload) throws AzDException { - String r = send(RequestMethod.POST, CONNECTION, SECURITY, null, - AREA_ACL, namespaceId, null, ApiVersion.SECURITY, null, payload, CustomHeader.JSON_CONTENT_TYPE); - return null; - } - - /** - * Remove access control lists under the specified security namespace. - * - * @param namespaceId Security namespace identifier. - * @param recurse If true and this is a hierarchical namespace, also remove child ACLs of the specified tokens. - * @param tokens One or more comma-separated security tokens - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void removeAccessControlLists(String namespaceId, boolean recurse, String[] tokens) throws AzDException { - if (tokens == null || tokens.length == 0) { - throw new AzDException(ApiExceptionTypes.InvalidArgumentException.name(), "Tokens list must not be empty."); - } - HashMap q = new HashMap<>() {{ - put("tokens", Arrays.stream(tokens) - .filter(x -> x != null && !x.isBlank()) - .map(URLHelper::encodeSpecialWithSpace) - .collect(Collectors.joining(","))); - put("recurse", recurse); - }}; - String r = send(RequestMethod.DELETE, CONNECTION, SECURITY, null, - AREA_ACL, namespaceId, null, ApiVersion.SECURITY, q, null, null); - return null; - } - - private boolean validIdentityQueryMembership(String queryMembership) { - return queryMembership != null && List.of("none", "direct").contains(queryMembership.toLowerCase()); - } - - private boolean validIdentitySearchFilter(String searchFilter) { - return searchFilter != null && List.of("accountname", "displayname", "mailaddress", "general", "localgroupname").contains(searchFilter.toLowerCase()); - } -} diff --git a/azd/src/main/java/org/azd/security/SecurityRequestBuilder.java b/azd/src/main/java/org/azd/security/SecurityRequestBuilder.java index 2f85205b..61987058 100644 --- a/azd/src/main/java/org/azd/security/SecurityRequestBuilder.java +++ b/azd/src/main/java/org/azd/security/SecurityRequestBuilder.java @@ -2,6 +2,7 @@ import org.azd.abstractions.BaseRequestBuilder; import org.azd.authentication.AccessTokenCredential; +import org.azd.exceptions.AzDException; import org.azd.locations.LocationsBaseRequestBuilder; import org.azd.security.accesscontrolentries.AccessControlEntriesRequestBuilder; import org.azd.security.accesscontrollists.AccessControlListsRequestBuilder; @@ -56,7 +57,12 @@ public SecurityNamespacesRequestBuilder securityNamespaces() { */ public IdentitiesRequestBuilder identities() { var location = new LocationsBaseRequestBuilder(organizationUrl, accessTokenCredential); - var url = location.getUrl("fc3682be-3d6c-427a-87c8-e527b16a1d05"); + String url; + try { + url = location.getUrl("fc3682be-3d6c-427a-87c8-e527b16a1d05"); + } catch (AzDException e) { + throw new RuntimeException(e); + } return new IdentitiesRequestBuilder(url, accessTokenCredential); } } diff --git a/azd/src/main/java/org/azd/serviceclient/BaseServiceClient.java b/azd/src/main/java/org/azd/serviceclient/BaseServiceClient.java index e9425f93..0e343f0b 100644 --- a/azd/src/main/java/org/azd/serviceclient/BaseServiceClient.java +++ b/azd/src/main/java/org/azd/serviceclient/BaseServiceClient.java @@ -10,6 +10,7 @@ import org.azd.configurations.ClientConfigurationRequestBuilder; import org.azd.core.CoreRequestBuilder; import org.azd.distributedtask.DistributedTaskRequestBuilder; +import org.azd.exceptions.AzDException; import org.azd.extensionmanagement.ExtensionManagementRequestBuilder; import org.azd.featuremanagement.FeatureManagementRequestBuilder; import org.azd.git.GitBaseRequestBuilder; @@ -372,6 +373,10 @@ public AccessTokenCredential accessTokenCredential() { private String getLocationUrl(String resourceId) { if (resourceId == null || resourceId.isEmpty()) throw new IllegalArgumentException("Resource Id cannot be empty."); - return locations().getUrl(resourceId); + try { + return locations().getUrl(resourceId); + } catch (AzDException e) { + throw new RuntimeException(e); + } } } diff --git a/azd/src/main/java/org/azd/serviceendpoint/ServiceEndpointApi.java b/azd/src/main/java/org/azd/serviceendpoint/ServiceEndpointApi.java deleted file mode 100644 index f96af801..00000000 --- a/azd/src/main/java/org/azd/serviceendpoint/ServiceEndpointApi.java +++ /dev/null @@ -1,310 +0,0 @@ -package org.azd.serviceendpoint; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.core.CoreApi; -import org.azd.enums.CustomHeader; -import org.azd.enums.RequestMethod; -import org.azd.enums.ServiceEndpointActionFilter; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.ServiceEndpointDetails; -import org.azd.serviceendpoint.types.ServiceEndpoint; -import org.azd.serviceendpoint.types.ServiceEndpoints; -import org.azd.utils.AzDAsyncApi; - -import java.util.*; - -import static org.azd.utils.RestClient.send; - -/** - * Service Endpoint Api to manage service endpoint service - */ -public class ServiceEndpointApi extends AzDAsyncApi implements ServiceEndpointDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "serviceendpoint"; - private final String SERVICE_ENDPOINT = "1814ab31-2f4f-4a9f-8761-f4d77dc5a5d7"; - private final CoreApi CORE; - - - /** - * Pass the connection object to work with Service endpoint Api - * - * @param connection Connection object - */ - public ServiceEndpointApi(Connection connection) { - this.CONNECTION = connection; - CORE = new CoreApi(CONNECTION); - } - - /** - * Creates a new service endpoint - * - * @param endpointName Friendly name of the endpoint - * @param endpointType Type of the endpoint - * @param requestBody Request body to create a service endpoint. - * Reference - * @return ServiceEndpoint {@link ServiceEndpoint} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ServiceEndpoint createServiceEndpoint(String endpointName, String endpointType, Map requestBody) throws AzDException { - requestBody.put("name", endpointName); - requestBody.put("type", endpointType); - - String r = send(RequestMethod.POST, CONNECTION, SERVICE_ENDPOINT, null, - AREA + "/endpoints", null, null, ApiVersion.SERVICE_ENDPOINTS, null, requestBody, CustomHeader.JSON_CONTENT_TYPE); - return MAPPER.mapJsonResponse(r, ServiceEndpoint.class); - } - - /** - * A helper method to create Azure RM service endpoint - * - * @param endpointName Friendly name of the endpoint - * @param servicePrincipalId service principal Id - * @param servicePrincipalKey service principal key - * @param tenantId Tenant Id - * @param subscriptionId subscription Id - * @param subscriptionName subscription name - * @return ServiceEndpoint {@link ServiceEndpoint} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ServiceEndpoint createAzureRMServiceEndpoint(String endpointName, String servicePrincipalId, String servicePrincipalKey, - String tenantId, String subscriptionId, - String subscriptionName) throws AzDException { - var project = CORE.getProject(CONNECTION.getProject()); - - var ref = new LinkedHashMap() {{ - put("projectReference", new LinkedHashMap() {{ - put("id", project.getId()); - put("name", project.getName()); - }}); - put("name", endpointName); - }}; - - var lRef = List.of(ref); - - var body = new LinkedHashMap() {{ - put("authorization", new LinkedHashMap() {{ - put("parameters", new LinkedHashMap() {{ - put("tenantid", tenantId); - put("serviceprincipalid", servicePrincipalId); - put("authenticationType", "spnKey"); - put("serviceprincipalkey", servicePrincipalKey); - }}); - put("scheme", "ServicePrincipal"); - }}); - put("data", new LinkedHashMap() {{ - put("subscriptionId", subscriptionId); - put("subscriptionName", subscriptionName); - put("environment", "AzureCloud"); - put("scopeLevel", "Subscription"); - put("creationMode", "Manual"); - }}); - put("url", "https://management.azure.com/"); - put("isShared", false); - put("isReady", true); - put("serviceEndpointProjectReferences", lRef); - }}; - - return createServiceEndpoint(endpointName, "azurerm", body); - } - - /** - * Get the service endpoint details. - * - * @param endpointId Id of the service endpoint. - * @return ServiceEndpoint {@link ServiceEndpoint} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ServiceEndpoint getServiceEndpoint(String endpointId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, SERVICE_ENDPOINT, CONNECTION.getProject(), - AREA + "/endpoints", endpointId, null, ApiVersion.SERVICE_ENDPOINTS, null, null, null); - return MAPPER.mapJsonResponse(r, ServiceEndpoint.class); - } - - /** - * Get the service endpoint details. - * - * @param endpointId Id of the service endpoint. - * @param actionFilter Action filter for the service connection. It specifies the action which can be performed on the service connection. - * @return ServiceEndpoint {@link ServiceEndpoint} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ServiceEndpoint getServiceEndpoint(String endpointId, ServiceEndpointActionFilter actionFilter) throws AzDException { - var q = new HashMap() {{ - put("actionFilter", actionFilter.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, SERVICE_ENDPOINT, CONNECTION.getProject(), - AREA + "/endpoints", endpointId, null, ApiVersion.SERVICE_ENDPOINTS, q, null, null); - return MAPPER.mapJsonResponse(r, ServiceEndpoint.class); - } - - /** - * Get the service endpoints. - * - * @return ServiceEndpoints {@link ServiceEndpoints} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ServiceEndpoints getServiceEndpoints() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, SERVICE_ENDPOINT, CONNECTION.getProject(), - AREA + "/endpoints", null, null, ApiVersion.SERVICE_ENDPOINTS, null, null, null); - return MAPPER.mapJsonResponse(r, ServiceEndpoints.class); - } - - /** - * Delete a service endpoint - * - * @param endpointId Endpoint Id of endpoint to delete - * @param projectIds project Ids from which endpoint needs to be deleted - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteServiceEndpoint(String endpointId, String[] projectIds) throws AzDException { - try { - var q = new HashMap() {{ - put("projectIds", String.join(",", projectIds)); - }}; - - String r = send(RequestMethod.DELETE, CONNECTION, SERVICE_ENDPOINT, CONNECTION.getProject(), - AREA + "/endpoints", endpointId, null, ApiVersion.SERVICE_ENDPOINTS, q, null, null); - - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Delete a service endpoint - * - * @param endpointId Endpoint Id of endpoint to delete - * @param projectIds project Ids from which endpoint needs to be deleted - * @param deep delete the spn created by endpoint - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteServiceEndpoint(String endpointId, String[] projectIds, boolean deep) throws AzDException { - try { - var q = new HashMap() {{ - put("projectIds", String.join(",", projectIds)); - put("deep", deep); - }}; - - String r = send(RequestMethod.DELETE, CONNECTION, SERVICE_ENDPOINT, CONNECTION.getProject(), - AREA + "/endpoints", endpointId, null, ApiVersion.SERVICE_ENDPOINTS, q, null, null); - - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Get the service endpoints by name. - * - * @param endpointNames Names of the service endpoints. - * @return ServiceEndpoint {@link ServiceEndpoint} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ServiceEndpoints getServiceEndpointsByNames(String[] endpointNames) throws AzDException { - var q = new HashMap() {{ - put("endpointNames", String.join(",", endpointNames)); - }}; - - String r = send(RequestMethod.GET, CONNECTION, SERVICE_ENDPOINT, CONNECTION.getProject(), - AREA + "/endpoints", null, null, ApiVersion.SERVICE_ENDPOINTS, q, null, null); - return MAPPER.mapJsonResponse(r, ServiceEndpoints.class); - } - - /** - * Get the service endpoints by name. - * - * @param endpointNames Names of the service endpoints. - * @param authSchemes Authorization schemes used for service endpoints. - * @param includeDetails Flag to include more details for service endpoints. - * This is for internal use only and the flag will be treated as false for all other requests - * @param includeFailed Failed flag for service endpoints. - * @param owner Owner for service endpoints. - * @param type Type of the service endpoints. - * @return ServiceEndpoint {@link ServiceEndpoint} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ServiceEndpoints getServiceEndpointsByNames(String[] endpointNames, String[] authSchemes, boolean includeDetails, - boolean includeFailed, String owner, String type) throws AzDException { - var q = new HashMap() {{ - put("endpointNames", String.join(",", endpointNames)); - put("type", type); - put("authSchemes", String.join(",", authSchemes)); - put("owner", owner); - put("includeFailed", includeFailed); - put("includeDetails", includeDetails); - }}; - - String r = send(RequestMethod.GET, CONNECTION, SERVICE_ENDPOINT, CONNECTION.getProject(), - AREA + "/endpoints", null, null, ApiVersion.SERVICE_ENDPOINTS, q, null, null); - return MAPPER.mapJsonResponse(r, ServiceEndpoints.class); - } - - /** - * Share service endpoint across projects - * - * @param endpointId Endpoint Id of the endpoint to share - * @param projectName Provide the project name to which the service endpoint connection to be shared - * @param connectionName Name of the connection - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void shareServiceEndpoint(String endpointId, String projectName, String connectionName) throws AzDException { - try { - var project = CORE.getProject(projectName); - - var body = new LinkedHashMap() {{ - put("projectReference", new LinkedHashMap() {{ - put("id", project.getId()); - put("name", project.getName()); - }}); - put("name", connectionName); - }}; - - var ref = new ArrayList<>(); - ref.add(body); - - String r = send(RequestMethod.PATCH, CONNECTION, SERVICE_ENDPOINT, CONNECTION.getProject(), - AREA + "/endpoints", endpointId, null, ApiVersion.SERVICE_ENDPOINTS, null, ref, CustomHeader.JSON_CONTENT_TYPE); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Update the service endpoint - * - * @param endpointId Endpoint Id of the endpoint to update - * @param requestBody Request body to update the service endpoint - * Reference: https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/update-service-endpoint?view=azure-devops-rest-6.1#update-service-endpoint - * @return ServiceEndpoint {@link ServiceEndpoint} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ServiceEndpoint updateServiceEndpoint(String endpointId, Map requestBody) throws AzDException { - String r = send(RequestMethod.PUT, CONNECTION, SERVICE_ENDPOINT, CONNECTION.getProject(), - AREA + "/endpoints", endpointId, null, ApiVersion.SERVICE_ENDPOINTS, null, requestBody, CustomHeader.JSON_CONTENT_TYPE); - return MAPPER.mapJsonResponse(r, ServiceEndpoint.class); - } -} diff --git a/azd/src/main/java/org/azd/serviceendpoint/types/ServiceEndpoint.java b/azd/src/main/java/org/azd/serviceendpoint/types/ServiceEndpoint.java index fd6c3cc0..94915bf7 100644 --- a/azd/src/main/java/org/azd/serviceendpoint/types/ServiceEndpoint.java +++ b/azd/src/main/java/org/azd/serviceendpoint/types/ServiceEndpoint.java @@ -2,7 +2,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import java.lang.Object; import org.azd.abstractions.serializer.SerializableEntity; import org.azd.common.types.Author; diff --git a/azd/src/main/java/org/azd/servicehooks/ServiceHooksApi.java b/azd/src/main/java/org/azd/servicehooks/ServiceHooksApi.java deleted file mode 100644 index 051a9d98..00000000 --- a/azd/src/main/java/org/azd/servicehooks/ServiceHooksApi.java +++ /dev/null @@ -1,142 +0,0 @@ -package org.azd.servicehooks; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.enums.CustomHeader; -import org.azd.enums.RequestMethod; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.ServiceHooksDetails; -import org.azd.servicehooks.types.ServiceHooks; -import org.azd.servicehooks.types.ServiceHooksSubscription; -import org.azd.servicehooks.types.ServiceHooksSubscriptions; -import org.azd.utils.AzDAsyncApi; - -import java.util.HashMap; -import java.util.LinkedHashMap; -import java.util.Map; - -import static org.azd.utils.RestClient.send; - -/** - * Service Hooks Api to manage service hooks service - */ -public class ServiceHooksApi extends AzDAsyncApi implements ServiceHooksDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "hooks"; - - - /** - * Pass the connection object to work with Service hooks Api - * - * @param connection Connection object - */ - public ServiceHooksApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Get a specific service hooks subscription. - * - * @param subscriptionId ID for a subscription. - * @return ServiceHooksSubscription {@link ServiceHooksSubscription} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ServiceHooksSubscription getSubscription(String subscriptionId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, null, null, - AREA + "/subscriptions", subscriptionId, null, ApiVersion.SERVICE_HOOKS, null, null, null); - - return MAPPER.mapJsonResponse(r, ServiceHooksSubscription.class); - } - - /** - * Get a list of subscriptions. - * - * @return ServiceHooksSubscriptions {@link ServiceHooksSubscriptions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ServiceHooksSubscriptions getSubscriptions() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, null, null, - AREA + "/subscriptions", null, null, ApiVersion.SERVICE_HOOKS, null, null, null); - - return MAPPER.mapJsonResponse(r, ServiceHooksSubscriptions.class); - } - - /** - * Get a list of subscriptions. - * - * @param consumerActionId ID for a consumerActionId. - * @param consumerId ID for a consumer. - * @param eventType The event type to filter on (if any). - * @param publisherId ID for a subscription. - * @return ServiceHooksSubscriptions {@link ServiceHooksSubscriptions} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ServiceHooksSubscriptions getSubscriptions(String consumerActionId, String consumerId, String eventType, String publisherId) - throws AzDException { - var q = new HashMap() {{ - put("publisherId", publisherId); - put("eventType", eventType); - put("consumerId", consumerId); - put("consumerActionId", consumerActionId); - }}; - - String r = send(RequestMethod.GET, CONNECTION, null, null, - AREA + "/subscriptions", null, null, ApiVersion.SERVICE_HOOKS, q, null, null); - - return MAPPER.mapJsonResponse(r, ServiceHooksSubscriptions.class); - } - - /** - * Delete a specific service hooks subscription. - * - * @param subscriptionId ID for a subscription. - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteSubscription(String subscriptionId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, null, null, - AREA + "/subscriptions", subscriptionId, null, ApiVersion.SERVICE_HOOKS, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Create a subscription. - * - * @param serviceHooks service hooks object {@link ServiceHooks} - * Reference: https://docs.microsoft.com/en-us/azure/devops/service-hooks/events?view=azure-devops#workitem.created - * @return ServiceHooksSubscription {@link ServiceHooksSubscription} - * @throws AzDException Default Api Exception handler. - */ - @Override - public ServiceHooksSubscription createSubscription(ServiceHooks serviceHooks) - throws AzDException { - - var requestBody = new LinkedHashMap() {{ - put("publisherId", serviceHooks.getPublisherId()); - put("eventType", serviceHooks.getEventType()); - put("resourceVersion", serviceHooks.getResourceVersion()); - put("consumerId", serviceHooks.getConsumerId()); - put("consumerActionId", serviceHooks.getConsumerActionId()); - put("publisherInputs", serviceHooks.getPublisherInputs()); - put("consumerInputs", serviceHooks.getConsumerInputs()); - }}; - - String r = send(RequestMethod.POST, CONNECTION, null, null, - AREA + "/subscriptions", null, null, ApiVersion.SERVICE_HOOKS, null, requestBody, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, ServiceHooksSubscription.class); - } -} diff --git a/azd/src/main/java/org/azd/servicehooks/types/ServiceHooksSubscription.java b/azd/src/main/java/org/azd/servicehooks/types/ServiceHooksSubscription.java index e0a81269..c91a1807 100644 --- a/azd/src/main/java/org/azd/servicehooks/types/ServiceHooksSubscription.java +++ b/azd/src/main/java/org/azd/servicehooks/types/ServiceHooksSubscription.java @@ -2,7 +2,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import java.lang.Object; import org.azd.abstractions.serializer.SerializableEntity; import org.azd.common.types.Author; import org.azd.enums.SubscriptionStatus; diff --git a/azd/src/main/java/org/azd/test/TestApi.java b/azd/src/main/java/org/azd/test/TestApi.java deleted file mode 100644 index 71cdad22..00000000 --- a/azd/src/main/java/org/azd/test/TestApi.java +++ /dev/null @@ -1,352 +0,0 @@ -package org.azd.test; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.enums.CustomHeader; -import org.azd.enums.RequestMethod; -import org.azd.enums.TestRunPublishContext; -import org.azd.enums.TestRunState; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.TestDetails; -import org.azd.test.types.*; - -import java.util.HashMap; -import java.util.Map; - -import static org.azd.common.ResourceId.TEST; -import static org.azd.utils.RestClient.send; - -public class TestApi implements TestDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "test"; - - - /** - * Pass the connection object to work with Service hooks Api - * - * @param connection Connection object - */ - public TestApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Create new test run. - * - * @return TestRun Object {@link TestRun} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TestRun createTestRun(RunCreateModel runCreateModel) throws AzDException { - String r = send(RequestMethod.POST, CONNECTION, TEST, CONNECTION.getProject(), - AREA + "/runs", null, null, ApiVersion.TEST_RUNS, null, runCreateModel, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, TestRun.class); - } - - /** - * Get a test run by its ID. - * - * @param runId ID of the run to get. - * @return TestRun Object {@link TestRun} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TestRun getTestRunById(int runId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, TEST, CONNECTION.getProject(), - AREA + "/runs", String.valueOf(runId), null, ApiVersion.TEST_RUNS, null, null, null); - - return MAPPER.mapJsonResponse(r, TestRun.class); - } - - /** - * Get a list of test runs. - * - * @return TestRun Object {@link TestRun} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TestRuns getTestRuns() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, TEST, CONNECTION.getProject(), - AREA + "/runs", null, null, ApiVersion.TEST_RUNS, null, null, null); - - return MAPPER.mapJsonResponse(r, TestRuns.class); - } - - /** - * Get a list of test runs. - * - * @param top Number of test runs to return. - * @return TestRun Object {@link TestRun} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TestRuns getTestRuns(int top) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, TEST, CONNECTION.getProject(), - AREA + "/runs", null, null, ApiVersion.TEST_RUNS, Map.of("$top", top), null, null); - - return MAPPER.mapJsonResponse(r, TestRuns.class); - } - - /** - * Get a list of test runs. - * - * @param buildUri URI of the build that the runs used. - * @return TestRun Object {@link TestRun} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TestRuns getTestRuns(String buildUri) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, TEST, CONNECTION.getProject(), - AREA + "/runs", null, null, ApiVersion.TEST_RUNS, Map.of("buildUri", buildUri), null, null); - - return MAPPER.mapJsonResponse(r, TestRuns.class); - } - - /** - * Get a list of test runs. - * - * @param skip Number of test runs to skip. - * @param top Number of test runs to return. - * @param automated If true, only returns automated runs. - * @param buildUri URI of the build that the runs used. - * @param includeRunDetails If true, include all the properties of the runs. - * @param owner Team foundation ID of the owner of the runs. - * @param planId ID of the test plan that the runs are a part of. - * @param tmiRunId None - * @return TestRun Object {@link TestRun} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TestRuns getTestRuns(int skip, int top, boolean automated, String buildUri, boolean includeRunDetails, - String owner, int planId, String tmiRunId) throws AzDException { - var q = new HashMap() {{ - put("$skip", skip); - put("$top", top); - put("automated", automated); - put("buildUri", buildUri); - put("includeRunDetails", includeRunDetails); - put("owner", owner); - put("planId", planId); - put("tmiRunId", tmiRunId); - }}; - - String r = send(RequestMethod.GET, CONNECTION, TEST, CONNECTION.getProject(), - AREA + "/runs", null, null, ApiVersion.TEST_RUNS, q, null, null); - - return MAPPER.mapJsonResponse(r, TestRuns.class); - } - - /** - * Get test run statistics , used when we want to get summary of a run by outcome. - * - * @param runId ID of the run to get. - * @return TestRunStatistic Object {@link TestRunStatistic} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TestRunStatistic getTestRunStatistics(int runId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, TEST, CONNECTION.getProject(), - AREA + "/runs", Integer.toString(runId), "Statistics", ApiVersion.TEST_RUNS, null, null, null); - - return MAPPER.mapJsonResponse(r, TestRunStatistic.class); - } - - /** - * Delete a test run by its ID. - * - * @param runId ID of the run to delete. - * @throws AzDException Default Api Exception handler. - **/ - @Override - public Void deleteTestRun(int runId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, TEST, CONNECTION.getProject(), - AREA + "/runs", Integer.toString(runId), null, ApiVersion.TEST_RUNS, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Query Test Runs based on filters. Mandatory fields are minLastUpdatedDate and maxLastUpdatedDate. - * - * @param maxLastUpdatedDate Maximum Last Modified Date of run to be queried (Mandatory, difference between min and max date can be atmost 7 days). - * @param minLastUpdatedDate Minimum Last Modified Date of run to be queried (Mandatory). - * @return TestRuns Object {@link TestRuns} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TestRuns queryTestRuns(String maxLastUpdatedDate, String minLastUpdatedDate) throws AzDException { - var q = new HashMap() {{ - put("maxLastUpdatedDate", maxLastUpdatedDate); - put("minLastUpdatedDate", minLastUpdatedDate); - }}; - - String r = send(RequestMethod.GET, CONNECTION, TEST, CONNECTION.getProject(), - AREA + "/runs", null, null, ApiVersion.TEST_RUNS, q, null, null); - - return MAPPER.mapJsonResponse(r, TestRuns.class); - } - - /** - * Query Test Runs based on filters. Mandatory fields are minLastUpdatedDate and maxLastUpdatedDate. - * - * @param maxLastUpdatedDate Maximum Last Modified Date of run to be queried (Mandatory, difference between min and max date can be atmost 7 days). - * @param minLastUpdatedDate Minimum Last Modified Date of run to be queried (Mandatory). - * @param top Number of runs to be queried. Limit is 100. - * @return TestRuns Object {@link TestRuns} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TestRuns queryTestRuns(String maxLastUpdatedDate, String minLastUpdatedDate, int top) throws AzDException { - var q = new HashMap() {{ - put("maxLastUpdatedDate", maxLastUpdatedDate); - put("minLastUpdatedDate", minLastUpdatedDate); - put("$top", top); - }}; - - String r = send(RequestMethod.GET, CONNECTION, TEST, CONNECTION.getProject(), - AREA + "/runs", null, null, ApiVersion.TEST_RUNS, q, null, null); - - return MAPPER.mapJsonResponse(r, TestRuns.class); - } - - /** - * Query Test Runs based on filters. Mandatory fields are minLastUpdatedDate and maxLastUpdatedDate. - * - * @param maxLastUpdatedDate Maximum Last Modified Date of run to be queried (Mandatory, difference between min and max date can be atmost 7 days). - * @param minLastUpdatedDate Minimum Last Modified Date of run to be queried (Mandatory). - * @param buildIds Build Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10). - * @return TestRuns Object {@link TestRuns} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TestRuns queryTestRuns(String maxLastUpdatedDate, String minLastUpdatedDate, String[] buildIds) throws AzDException { - var q = new HashMap() {{ - put("maxLastUpdatedDate", maxLastUpdatedDate); - put("minLastUpdatedDate", minLastUpdatedDate); - }}; - - if (buildIds.length > 0) q.put("buildIds", String.join(",", buildIds)); - - String r = send(RequestMethod.GET, CONNECTION, TEST, CONNECTION.getProject(), - AREA + "/runs", null, null, ApiVersion.TEST_RUNS, q, null, null); - - return MAPPER.mapJsonResponse(r, TestRuns.class); - } - - /** - * Query Test Runs based on filters. Mandatory fields are minLastUpdatedDate and maxLastUpdatedDate. - * - * @param maxLastUpdatedDate Maximum Last Modified Date of run to be queried (Mandatory, difference between min and max date can be atmost 7 days). - * @param minLastUpdatedDate Minimum Last Modified Date of run to be queried (Mandatory). - * @param testRunState Current state of the Runs to be queried. - * @return TestRuns Object {@link TestRuns} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TestRuns queryTestRuns(String maxLastUpdatedDate, String minLastUpdatedDate, TestRunState testRunState) throws AzDException { - var q = new HashMap() {{ - put("maxLastUpdatedDate", maxLastUpdatedDate); - put("minLastUpdatedDate", minLastUpdatedDate); - put("state", testRunState); - }}; - - String r = send(RequestMethod.GET, CONNECTION, TEST, CONNECTION.getProject(), - AREA + "/runs", null, null, ApiVersion.TEST_RUNS, q, null, null); - - return MAPPER.mapJsonResponse(r, TestRuns.class); - } - - /** - * Query Test Runs based on filters. Mandatory fields are minLastUpdatedDate and maxLastUpdatedDate. - * - * @param maxLastUpdatedDate Maximum Last Modified Date of run to be queried (Mandatory, difference between min and max date can be atmost 7 days). - * @param minLastUpdatedDate Minimum Last Modified Date of run to be queried (Mandatory). - * @param branchName Source Branch name of the Runs to be queried. - * @param buildDefIds Build Definition Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10). - * @param continuationToken continuationToken received from previous batch or null for first batch. - * It is not supposed to be created (or altered, if received from last batch) by user. - * @param isAutomated Automation type of the Runs to be queried. - * @param planIds Plan Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10). - * @param publishContext PublishContext of the Runs to be queried. - * @param releaseDefIds Release Definition Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10). - * @param releaseEnvDefIds Release Environment Definition Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10). - * @param releaseEnvIds Release Environment Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10). - * @param releaseIds Release Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10). - * @param runTitle Run Title of the Runs to be queried. - * @return TestRuns Object {@link TestRuns} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TestRuns queryTestRuns(String maxLastUpdatedDate, String minLastUpdatedDate, String branchName, - String[] buildDefIds, String continuationToken, boolean isAutomated, - String[] planIds, TestRunPublishContext publishContext, String[] releaseDefIds, - String[] releaseEnvDefIds, String[] releaseEnvIds, String[] releaseIds, - String runTitle) throws AzDException { - var q = new HashMap() {{ - put("maxLastUpdatedDate", maxLastUpdatedDate); - put("minLastUpdatedDate", minLastUpdatedDate); - put("isAutomated", isAutomated); - put("publishContext", publishContext); - }}; - - if (branchName != null) q.put("branchName", branchName); - if (buildDefIds.length > 0) q.put("buildDefIds", buildDefIds); - if (continuationToken != null) q.put("continuationToken", continuationToken); - if (planIds.length > 0) q.put("branchName", branchName); - if (releaseEnvDefIds.length > 0) q.put("releaseEnvDefIds", String.join(",", releaseEnvDefIds)); - if (releaseEnvIds.length > 0) q.put("releaseEnvIds", String.join(",", releaseEnvIds)); - if (releaseDefIds.length > 0) q.put("releaseDefIds", releaseDefIds); - if (releaseIds.length > 0) q.put("releaseIds", releaseIds); - if (runTitle != null) q.put("runTitle", runTitle); - - - String r = send(RequestMethod.GET, CONNECTION, TEST, CONNECTION.getProject(), - AREA + "/runs", null, null, ApiVersion.TEST_RUNS, q, null, null); - - return MAPPER.mapJsonResponse(r, TestRuns.class); - } - - /** - * Update test run by its ID. - * - * @param runId ID of the run to update. - * @param testRun {@link TestRun} object. - * @return TestRun Object {@link TestRun} - * @throws AzDException Default Api exception handler. - */ - @Override - public TestRun updateTestRun(int runId, TestRun testRun) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, TEST, CONNECTION.getProject(), - AREA + "/runs", String.valueOf(runId), null, ApiVersion.TEST_RUNS, null, testRun, - CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, TestRun.class); - } - - /** - * Update test case results by run ID. - * - * @param runId ID of the run to update. - * @param testCaseResults {@link TestCaseResults} object. - * @return TestCaseResults Object {@link TestCaseResults} - * @throws AzDException Default Api exception handler. - */ - @Override - public TestCaseResults updateTestResults(int runId, TestCaseResults testCaseResults) throws AzDException { - String r = send(RequestMethod.PATCH, CONNECTION, TEST, CONNECTION.getProject(), - AREA + "/runs", String.valueOf(runId), "results", ApiVersion.TEST_RUNS, null, testCaseResults.getResults(), - CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, TestCaseResults.class); - } -} diff --git a/azd/src/main/java/org/azd/upack/UPackApi.java b/azd/src/main/java/org/azd/upack/UPackApi.java deleted file mode 100644 index 3a30d562..00000000 --- a/azd/src/main/java/org/azd/upack/UPackApi.java +++ /dev/null @@ -1,286 +0,0 @@ -package org.azd.upack; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.enums.*; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.UpackDetails; -import org.azd.upack.types.Package; -import org.azd.upack.types.UPackPackageVersionDeletionState; -import org.azd.utils.AzDAsyncApi; - -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import static org.azd.utils.RestClient.send; - -/** - * UpackApi class to manage Universal Package artifact package api - */ -public class UPackApi extends AzDAsyncApi implements UpackDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "packaging"; - private final String UPACK = "d397749b-f115-4027-b6dd-77a65dd10d21"; - - /** - * Pass the connection object to work with Universal Package Api - * - * @param connection Connection object - */ - public UPackApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Show information about a package version. - * - * @param feedId Name or ID of the feed. Example: "ufeed". - * @param packageName Name of the package. Example: "upackage". - * @param version Version of the package. Example: "1.0.0". - * @return Package {@link Package} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Package getPackageVersion(String feedId, String packageName, String version) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, UPACK, CONNECTION.getProject(), AREA + "/feeds", feedId, - "upack/packages/" + packageName + "/versions/" + version, ApiVersion.UPACK, null, null, null); - - return MAPPER.mapJsonResponse(r, Package.class); - } - - /** - * Show information about a package version. - * - * @param feedId Name or ID of the feed. Example: "ufeed". - * @param packageName Name of the package. Example: "upackage". - * @param version Version of the package. Example: "1.0.0". - * @param showDeleted True to show information for deleted versions - * @return Package {@link Package} - * @throws AzDException Default Api Exception handler. - */ - @Override - public Package getPackageVersion(String feedId, String packageName, String version, boolean showDeleted) - throws AzDException { - HashMap q = new HashMap<>() { - { - put("showDeleted", showDeleted); - } - }; - String r = send(RequestMethod.GET, CONNECTION, UPACK, CONNECTION.getProject(), AREA + "/feeds", feedId, - "upack/packages/" + packageName + "/versions/" + version, ApiVersion.UPACK, q, null, null); - - return MAPPER.mapJsonResponse(r, Package.class); - } - - /** - * Get information about a package version in the recycle bin. - * - * @param feedId Name or ID of the feed. Example: "ufeed". - * @param packageName Name of the package. Example: "upackage". - * @param version Version of the package. Example: "1.0.0". - * @return UPackPackageVersionDeletionState - * {@link UPackPackageVersionDeletionState} - * @throws AzDException Default Api Exception handler. - */ - @Override - public UPackPackageVersionDeletionState getPackageVersionFromRecycleBin(String feedId, String packageName, - String version) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, UPACK, CONNECTION.getProject(), AREA + "/feeds", feedId, - "upack/RecycleBin/packages/" + packageName + "/versions/" + version, ApiVersion.UPACK, null, null, null); - - return MAPPER.mapJsonResponse(r, UPackPackageVersionDeletionState.class); - } - - - /** - * Delete a package version from the feed and move it to the feed's recycle - * bin. - * - * @param feedId Name or ID of the feed. Example: "ufeed". - * @param packageName Name of the package. Example: "upackage". - * @param version Version of the package. Example: "1.0.0". - * @throws AzDException Default Api Exception handler. - */ - @Override - public void deletePackageVersion(String feedId, String packageName, String version) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, UPACK, CONNECTION.getProject(), AREA + "/feeds", feedId, - "upack/packages/" + packageName + "/versions/" + version, ApiVersion.UPACK, null, null, null); - if (!r.isEmpty()) - MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - - } - - /** - * Permanently delete a package from a feed's recycle bin. - * - * @param feedId Name or ID of the feed. Example: "ufeed". - * @param packageName Name of the package. Example: "upackage". - * @param version Version of the package. Example: "1.0.0". - * @throws AzDException Default Api Exception handler. - */ - @Override - public void deletePackageVersionFromRecycleBin(String feedId, String packageName, String version) - throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, UPACK, CONNECTION.getProject(), AREA + "/feeds", feedId, - "upack/RecycleBin/packages/" + packageName + "/versions/" + version, ApiVersion.UPACK, null, null, null); - if (!r.isEmpty()) - MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - } - - /** - * Update information for a package version. (eg. prelease, release) - * - * @param feedId Name or ID of the feed. Example: "ufeed". - * @param packageName Name of the package. Example: "upackage". - * @param version Version of the package. Example: "1.0.0" - * @param promote State of the package. Example: "prelease". {@link - * PackagePromote} - * @throws AzDException Default Api Exception handler. - */ - @Override - public void updatePackageVersion(String feedId, String packageName, String version, PackagePromote promote) - throws AzDException { - updatePackageVersion(feedId, packageName, version, promote.toString().toLowerCase()); - } - - /** - * Update information for a package version. (eg. prelease, release) - * - * @param feedId Name or ID of the feed. Example: "ufeed". - * @param packageName Name of the package. Example: "upackage". - * @param version Version of the package. Example: "1.0.0" - * @param promote State of the package. Example: "prelease". - * @throws AzDException Default Api Exception handler. - */ - @Override - public void updatePackageVersion(String feedId, String packageName, String version, String promote) - throws AzDException { - - var req = new HashMap() {{ - put("op", PackageOperation.ADD.toString()); - put("path", "/views/-"); - put("value", promote.toString()); // "prmote package type" - }}; - - var body = new HashMap() {{ - put("views", req); - }}; - - try { - String r = send(RequestMethod.PATCH, CONNECTION, UPACK, CONNECTION.getProject(), AREA + "/feeds", feedId, - "upack/packages/" + packageName + "/versions/" + version, ApiVersion.UPACK, null, body, CustomHeader.JSON_CONTENT_TYPE); - if (!r.isEmpty()) - MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - } - - /** - * Update several packages from a single feed in a single request. The updates - * to the packages do not happen atomically. - * - * @param feedId Name or ID of the feed. Example: "ufeed". - * @param viewId Name of ID the view, packages need to be promoted to. - * @param operation Type of operation that needs to be performed on packages. - * supports only PROMOTE or DELETE. - * {@link PackagesBatchOperation}. - * @param packages Identifies a particular Universal package version. - * @throws AzDException Default Api Exception handler. - */ - @Override - public void updatePackageVersions(String feedId, String viewId, PackagesBatchOperation operation, - List> packages) throws AzDException { - var req = new HashMap(); - try { - if (operation == PackagesBatchOperation.PROMOTE) { - req.put("data", Map.of("viewId", viewId)); - } - req.put("operation", operation.toString().toLowerCase()); - - List l = new ArrayList(); - for (var pkg : packages) { - l.add(Map.of("id", pkg.get("id"), "version", pkg.get("version"))); - } - req.put("packages", l); - - String r = send(RequestMethod.POST, CONNECTION, UPACK, CONNECTION.getProject(), AREA + "/feeds", feedId, - "upack/packagesbatch", ApiVersion.UPACK, null, req, CustomHeader.JSON_CONTENT_TYPE); - if (!r.isEmpty()) { - MAPPER.mapJsonResponse(r, Map.class); - } - } catch (AzDException e) { - throw e; - } - } - - /** - * Restore a package version from the recycle bin to its associated feed. - * - * @param feedId Name or ID of the feed. Example: "ufeed". - * @param packageName Name of the package. Example: "upackage". - * @param version Version of the package. Example: "1.0.0" - * @throws AzDException Default Api Exception handler. - */ - @Override - public void restorePackageVersionFromRecycleBin(String feedId, String packageName, String version) - throws AzDException { - try { - String r = send(RequestMethod.PATCH, CONNECTION, UPACK, CONNECTION.getProject(), - AREA + "/feeds", feedId, "upack/RecycleBin/packages/" + packageName + "/versions/" + version, - ApiVersion.UPACK, null, Map.of("deleted", "false"), null); - if (!r.isEmpty()) - MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - } - - /** - * Delete or restore several package versions from the recycle bin. - * - * @param feedId Name or ID of the feed. Example: "upack". - * @param operation Type of operation that needs to be performed on packages. - * Recycle Bin supports only PERMANENTDELETE or RESTORETOFEED. - * {@link PackagesBatchOperation} - * @param packages Identifies a particular Universal package versions - * @throws AzDException Default Api Exception handler. - */ - @Override - public void updateRecycleBinPackages(String feedId, PackagesBatchOperation operation, - List> packages) throws AzDException { - var req = new HashMap(); - try { - req.put("data", null); - req.put("operation", operation.toString().toLowerCase()); - - List l = new ArrayList(); - for (var pkg : packages) { - l.add(Map.of("id", pkg.get("id"), "version", pkg.get("version"))); - } - req.put("packages", l); - - String r = send(RequestMethod.POST, CONNECTION, UPACK, CONNECTION.getProject(), AREA + "/feeds", feedId, - "upack/RecycleBin/packagesbatch", ApiVersion.UPACK, null, req, CustomHeader.JSON_CONTENT_TYPE); - if (!r.isEmpty()) - MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - } -} diff --git a/azd/src/main/java/org/azd/upack/types/ReferenceLinks.java b/azd/src/main/java/org/azd/upack/types/ReferenceLinks.java deleted file mode 100644 index cb845d36..00000000 --- a/azd/src/main/java/org/azd/upack/types/ReferenceLinks.java +++ /dev/null @@ -1,26 +0,0 @@ -package org.azd.upack.types; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; -import org.azd.abstractions.serializer.SerializableEntity; - -/** - * The class to represent a collection of REST reference links. - */ -@JsonIgnoreProperties(ignoreUnknown = true) -public class ReferenceLinks extends SerializableEntity { - /** - * Related REST links. - */ - @JsonProperty("links") - private Object links; - - public Object getLinks() { - return links; - } - - public void setLinks(Object links) { - this.links = links; - } - -} diff --git a/azd/src/main/java/org/azd/utils/AzDAsyncApi.java b/azd/src/main/java/org/azd/utils/AzDAsyncApi.java deleted file mode 100644 index 4af358b6..00000000 --- a/azd/src/main/java/org/azd/utils/AzDAsyncApi.java +++ /dev/null @@ -1,13 +0,0 @@ -package org.azd.utils; - -import java.util.concurrent.CompletableFuture; - -@Deprecated(since = "v6.0") -public abstract class AzDAsyncApi { - public AzDAsyncApi() { - } - - public CompletableFuture createAsync(T o) { - return CompletableFuture.supplyAsync(() -> o); - } -} diff --git a/azd/src/main/java/org/azd/utils/AzDClientApi.java b/azd/src/main/java/org/azd/utils/AzDClientApi.java deleted file mode 100644 index f41c147c..00000000 --- a/azd/src/main/java/org/azd/utils/AzDClientApi.java +++ /dev/null @@ -1,319 +0,0 @@ -package org.azd.utils; - -import org.azd.accounts.AccountsApi; -import org.azd.build.BuildApi; -import org.azd.connection.Connection; -import org.azd.core.CoreApi; -import org.azd.distributedtask.DistributedTaskApi; -import org.azd.extensionmanagement.ExtensionManagementApi; -import org.azd.feedmanagement.FeedManagementApi; -import org.azd.git.GitApi; -import org.azd.graph.GraphApi; -import org.azd.helpers.URLHelper; -import org.azd.interfaces.*; -import org.azd.maven.MavenApi; -import org.azd.memberentitlementmanagement.MemberEntitlementManagementApi; -import org.azd.oauth.OAuthApi; -import org.azd.oauth.types.AuthorizedToken; -import org.azd.pipelines.PipelinesApi; -import org.azd.policy.PolicyApi; -import org.azd.release.ReleaseApi; -import org.azd.security.SecurityApi; -import org.azd.serviceendpoint.ServiceEndpointApi; -import org.azd.servicehooks.ServiceHooksApi; -import org.azd.test.TestApi; -import org.azd.upack.UPackApi; -import org.azd.wiki.WikiApi; -import org.azd.work.WorkApi; -import org.azd.workitemtracking.WorkItemTrackingApi; - -/** - * AzDClientApi class to easily call VSTS REST Api with the connection parameters - */ -public class AzDClientApi implements AzDClient { - - /** - * Instance of connection object - */ - private final Connection CONNECTION; - - /** - * Pass the VSTS organization name and personal access token to create a connection object - * - * @param connection Connection object {@link Connection} - */ - public AzDClientApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Pass the VSTS organization name and personal access token to create a connection object - * - * @param organizationName VSTS/Azure DevOps services organization name - * @param personalAccessToken Personal access token - */ - public AzDClientApi(String organizationName, String personalAccessToken) { - this.CONNECTION = new Connection(organizationName, personalAccessToken); - } - - /** - * Pass the VSTS organization name, project name and personal access token to create a connection object - * - * @param organizationName VSTS/Azure DevOps services organization name - * @param projectName project name - * @param personalAccessToken Personal access token - */ - public AzDClientApi(String organizationName, String projectName, String personalAccessToken) { - this.CONNECTION = new Connection(organizationName, projectName, personalAccessToken); - } - - public void setProject(String project) { - if (this.CONNECTION != null) { - this.CONNECTION.setProject(URLHelper.encodeSpace(project)); - } - } - - public String getOrganization() { - if (this.CONNECTION != null) { - return this.CONNECTION.getOrganization(); - } - return null; - } - - public void setOrganization(String org) { - if (this.CONNECTION != null) { - this.CONNECTION.setOrganization(org); - } - } - - public void setOauthToken(AuthorizedToken token) { - if (this.CONNECTION != null) { - this.CONNECTION.setOauthToken(token); - } - } - - public Connection getConnection() { - return this.CONNECTION; - } - - /** - * Returns an instance of AccountsApi - * - * @return an instance of AccountsApi {@link AccountsApi} - */ - @Override - public AccountsDetails getAccountsApi() { - return new AccountsApi(CONNECTION); - } - - /** - * Returns an instance of Build Api - * - * @return instance of BuildApi {@link BuildApi} - */ - @Override - public BuildDetails getBuildApi() { - return new BuildApi(CONNECTION); - } - - /** - * Returns an instance of Core Api - * - * @return instance of CoreApi {@link CoreApi} - */ - @Override - public CoreDetails getCoreApi() { - return new CoreApi(CONNECTION); - } - - /** - * Returns an instance of DistributedTask Api - * - * @return instance of DistributedTaskApi {@link DistributedTaskApi} - */ - - @Override - public DistributedTaskDetails getDistributedTaskApi() { - return new DistributedTaskApi(CONNECTION); - } - - /** - * Returns an instance of FeedManagement Api - * - * @return instance of Feed management Api {@link FeedManagementApi} - */ - @Override - public FeedManagementDetails getFeedManagementApi() { - return new FeedManagementApi(CONNECTION); - } - - /** - * Returns an instance of Git Api - * - * @return instance of Git Api {@link GitApi} - */ - @Override - public GitDetails getGitApi() { - return new GitApi(CONNECTION); - } - - /** - * Returns an instance of GraphApi - * - * @return instance of Graph Api {@link GraphApi} - */ - @Override - public GraphDetails getGraphApi() { - return new GraphApi(CONNECTION); - } - - /** - * Returns an instance of Maven Api - * - * @return instance of Maven Api {@link MavenApi} - */ - @Override - public MavenDetails getMavenApi() { - return new MavenApi(CONNECTION); - } - - /** - * Returns an instance of Member Entitlement management Api - * - * @return instance of Member Entitle management Api {@link MemberEntitlementManagementApi} - */ - @Override - public MemberEntitlementManagementDetails getMemberEntitlementManagementApi() { - return new MemberEntitlementManagementApi(CONNECTION); - } - - /** - * Returns an instance of Release Api - * - * @return instance of Release Api {@link ReleaseApi} - */ - @Override - public ReleaseDetails getReleaseApi() { - return new ReleaseApi(CONNECTION); - } - - /** - * Returns an instance of Service Hooks Api - * - * @return instance of Service Hooks Api {@link ServiceHooksApi} - */ - @Override - public ServiceHooksDetails getServiceHooksApi() { - return new ServiceHooksApi(CONNECTION); - } - - /** - * Returns an instance of WikiApi - * - * @return instance of Wiki Api {@link WikiApi} - */ - @Override - public WikiDetails getWikiApi() { - return new WikiApi(CONNECTION); - } - - /** - * Returns an instance of Work Api - * - * @return instance of Work Api {@link WorkApi} - */ - @Override - public WorkDetails getWorkApi() { - return new WorkApi(CONNECTION); - } - - /** - * Returns an instance of Work item tracking Api - * - * @return instance of work item tracking Api {@link WorkItemTrackingApi} - */ - @Override - public WorkItemTrackingDetails getWorkItemTrackingApi() { - return new WorkItemTrackingApi(CONNECTION); - } - - /** - * Returns an instance of OAuth Api - * - * @return instance of OAuth Api {@link OAuthApi} - */ - @Override - public OAuthApi getOAuth() { - return new OAuthApi(); - } - - /** - * Returns an instance of Service endpoint Api - * - * @return instance of ServiceEndpointApi {@link ServiceEndpointApi} - */ - @Override - public ServiceEndpointDetails getServiceEndpointApi() { - return new ServiceEndpointApi(CONNECTION); - } - - /** - * Returns an instance of Extension management Api - * - * @return instance of ExtensionManagementApi {@link ExtensionManagementApi} - */ - @Override - public ExtensionManagementDetails getExtensionManagementApi() { - return new ExtensionManagementApi(CONNECTION); - } - - /** - * Returns an instance of Policy Api - * - * @return instance of PolicyApi {@link PolicyApi} - */ - @Override - public PolicyDetails getPolicyApi() { - return new PolicyApi(CONNECTION); - } - - /** - * Returns an instance of Pipelines Api - * - * @return instance of PipelinesApi {@link PipelinesApi} - */ - @Override - public PipelinesDetails getPipelinesApi() { - return new PipelinesApi(CONNECTION); - } - - /** - * Returns an instance of Universal Package Api - * - * @return instance of UPackApi {@link UPackApi} - */ - @Override - public UpackDetails getUPackApi() { - return new UPackApi(CONNECTION); - } - - /** - * Returns an instance of security api - * - * @return instance of securityApi {@link SecurityApi} - */ - @Override - public SecurityDetails getSecurityApi() { - return new SecurityApi(CONNECTION); - } - - /** - * Returns an instance of Test api - * - * @return instance of TestApi {@link TestApi} - */ - @Override - public TestDetails getTestApi() { - return new TestApi(CONNECTION); - } -} \ No newline at end of file diff --git a/azd/src/main/java/org/azd/utils/BaseRestClient.java b/azd/src/main/java/org/azd/utils/BaseRestClient.java deleted file mode 100644 index 3c85a293..00000000 --- a/azd/src/main/java/org/azd/utils/BaseRestClient.java +++ /dev/null @@ -1,240 +0,0 @@ -package org.azd.utils; - -import org.azd.enums.CustomHeader; -import org.azd.enums.RequestMethod; -import org.azd.exceptions.AzDException; - -import java.net.URI; -import java.net.http.HttpClient; -import java.net.http.HttpRequest; -import java.net.http.HttpResponse; -import java.util.Base64; -import java.util.concurrent.CompletableFuture; - -/** - * BaseRestClient that encapsulates the logic for managing request and response for REST API. - */ -@Deprecated(since = "v6.0") -public abstract class BaseRestClient { - private static final String AUTHORIZATION = "Authorization"; - private static final HttpClient HTTP_CLIENT = HttpClient.newHttpClient(); - private static HttpClient.Redirect REDIRECT_POLICY = HttpClient.Redirect.NORMAL; - private static final HttpClient CLIENT = HttpClient.newBuilder().followRedirects(REDIRECT_POLICY).build(); - - /** - * Encodes the personal access token to base 64 - * - * @param token pass the personal access token - * @return Encoded string of personal access token for basic authentication - */ - private static String encodePersonalAccessToken(String token) { - return "Basic " + - Base64.getEncoder().encodeToString(("" + ":" + token).getBytes()); - } - - /** - * Http request builder - * - * @param requestUrl request url - * @param token personal access token - * @return HttpRequest object to build - */ - private static HttpRequest.Builder build(String requestUrl, String token) { - var req = HttpRequest - .newBuilder() - .uri(URI.create(requestUrl)); - - if (token == null) - return req; - - return req.setHeader(AUTHORIZATION, encodePersonalAccessToken(token)); - } - - /** - * Response from API for the given request - * - * @param r pass the Http request object - * @param handler HttpResponse body handler - * @param callback If true client will be built with redirect policy - * @return String response from API - */ - private static CompletableFuture> request(HttpRequest r, HttpResponse.BodyHandler handler, - boolean callback) { - if (callback) return CLIENT.sendAsync(r, handler); - return HTTP_CLIENT.sendAsync(r, handler); - } - - /** - * Get the current redirect policy. - * - * @return HttpClient.Redirect policy. - */ - public static HttpClient.Redirect getRedirectPolicy() { - return REDIRECT_POLICY; - } - - /** - * Set the current redirect policy. - * - * @param redirectPolicy HttpClient.Redirect policy. - */ - public static void setRedirectPolicy(HttpClient.Redirect redirectPolicy) { - REDIRECT_POLICY = redirectPolicy; - } - - /** - * Sends a GET request to REST API with basic authentication - * - * @param requestUrl pass the request url - * @param token pass the personal access token - * @param handler HttpResponse body handler - * @param contentType specify the content type - * @param callback If true client will be built with redirect policy - * @return response string from the API - */ - public static CompletableFuture> get(String requestUrl, String token, HttpResponse.BodyHandler handler, - CustomHeader contentType, boolean callback) { - return request(build(requestUrl, token).GET().header(contentType.getName(), contentType.getValue()).build(), - handler, callback); - } - - /** - * Sends a POST request to REST API with oauth authentication, content length of the request and request body - * - * @param requestUrl pass the request url - * @param token pass the personal access token - * @param publisher BodyPublisher with request body - * @param handler HttpResponse body handlers - * @param contentType Content type for setting headers - * @param callback If true client will be built with redirect policy - * @return response string from the API if any - * @throws AzDException throws user friendly error message with error code from API - */ - public static CompletableFuture> post(String requestUrl, String token, HttpRequest.BodyPublisher publisher, - HttpResponse.BodyHandler handler, CustomHeader contentType, - boolean callback) throws AzDException { - return request( - build(requestUrl, token) - .POST(publisher) - .header(contentType.getName(), contentType.getValue()) - .build(), handler, callback); - } - - /** - * Sends a PATCH request to REST API with basic authentication and request body - * - * @param requestUrl pass the request url - * @param token pass the personal access token - * @param publisher BodyPublisher with request body - * @param handler HttpResponse body handlers - * @param contentType Content type for setting headers - * @param callback If true client will be built with redirect policy - * @return response string from the API if any - * @throws AzDException throws user friendly error message with error code from API - */ - public static CompletableFuture> patch(String requestUrl, String token, HttpRequest.BodyPublisher publisher, - HttpResponse.BodyHandler handler, CustomHeader contentType, - boolean callback) throws AzDException { - return request( - build(requestUrl, token) - .method(RequestMethod.PATCH.name(), publisher) - .header(contentType.getName(), contentType.getValue()) - .build(), handler, callback); - } - - /** - * Sends a PUT request to REST API with basic authentication and request body - * - * @param requestUrl pass the request url - * @param token pass the personal access token - * @param publisher BodyPublisher with request body - * @param handler HttpResponse body handlers - * @param contentType Content type for setting headers - * @param callback If true client will be built with redirect policy - * @return response string from the API if any - * @throws AzDException throws user friendly error message with error code from API - */ - public static CompletableFuture> put(String requestUrl, String token, HttpRequest.BodyPublisher publisher, - HttpResponse.BodyHandler handler, CustomHeader contentType, - boolean callback) throws AzDException { - return request( - build(requestUrl, token) - .PUT(publisher) - .header(contentType.getName(), contentType.getValue()) - .build(), handler, callback); - } - - /** - * Sends a DELETE request to REST API with basic authentication - * - * @param requestUrl pass the request url - * @param token pass the personal access token - * @return response string from the API if any - */ - public static CompletableFuture> delete(String requestUrl, String token, HttpResponse.BodyHandler handler) { - return request(build(requestUrl, token).DELETE().build(), handler, false); - } - - /** - * Manages the request method and response from REST API. - * - * @param requestMethod Type of request to send. Such as GET, POST, PUT, PATCH and DELETE. - * @param requestUrl Request url to call the Api. - * @param token Personal access token. - * @param publisher HttpRequest body publisher type - * @param handler HttpResponse body type - * @param contentType Custom headers for sending the request - * @param callback If true default redirect policy will be applied - * @return Completable future object. - * @throws AzDException Default Api exception handler. - */ - public static CompletableFuture> response(RequestMethod requestMethod, String requestUrl, - String token, HttpRequest.BodyPublisher publisher, - HttpResponse.BodyHandler handler, - CustomHeader contentType, - boolean callback) throws AzDException { - contentType = contentType == null ? CustomHeader.JSON : contentType; - - switch (requestMethod) { - case GET: - return get(requestUrl, token, handler, contentType, callback); - case POST: - return post(requestUrl, token, publisher, handler, contentType, callback); - case PATCH: - return patch(requestUrl, token, publisher, handler, contentType, callback); - case PUT: - return put(requestUrl, token, publisher, handler, contentType, callback); - case DELETE: - return delete(requestUrl, token, handler); - default: - return null; - } - } - - /** - * Helper method to create the request with request url and access token. - * - * @param requestUrl Pass the request url. - * @param token Pass the access token. Base64 encoding will be taken care when building the request. - * @return HttpRequest builder object. - */ - protected static HttpRequest.Builder getBuilder(String requestUrl, String token) { - return build(requestUrl, token); - } - - /** - * Helper method to get the response based on built http request. - * - * @param r Http request object. - * @param handler Handlers for accepting the response content as. Example string or input stream etc. - * @param callback If true follows redirects. - * @param Generic response type object. - * @return generic type of future of http response. - */ - protected static CompletableFuture> getResponse(HttpRequest r, HttpResponse.BodyHandler handler, - boolean callback) { - if (callback) return CLIENT.sendAsync(r, handler); - return HTTP_CLIENT.sendAsync(r, handler); - } - -} diff --git a/azd/src/main/java/org/azd/utils/ModelBuilder.java b/azd/src/main/java/org/azd/utils/ModelBuilder.java deleted file mode 100644 index 69abe4a2..00000000 --- a/azd/src/main/java/org/azd/utils/ModelBuilder.java +++ /dev/null @@ -1,56 +0,0 @@ -package org.azd.utils; - -import org.azd.enums.ApiExceptionTypes; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; - -import java.util.LinkedHashMap; -import java.util.List; -import java.util.Map; - -/** - * Helper class to construct the request body dynamically by removing non-assigned values in a type. - */ -@Deprecated(since = "v6.0") -public class ModelBuilder { - /** - * Instance of mapper for unmarshalling the request body. - */ - private static final JsonMapper MAPPER = new JsonMapper(); - - /** - * Build method to construct the request body based on given object. - * - * @param model request body. - * @param valuesToRemove Specify the values to remove from request body if it was assigned by default. - * @return a Map. - * @throws AzDException Default exception handler. - */ - public static Map build(Object model, List valuesToRemove) throws AzDException { - - if (model == null) - throw new AzDException(ApiExceptionTypes.InvalidArgumentException.name(), "Request body cannot be null"); - Map definedModel = MAPPER.mapJsonResponse(MAPPER.convertToString(model), Map.class); - - var result = new LinkedHashMap(); - for (var key : definedModel.keySet()) { - if (definedModel.get(key) != null) { - result.put(key, definedModel.get(key)); - } - } - return removeKeys(result, valuesToRemove); - } - - /** - * Internal method to remove the user specified keys and values from a map. - * - * @param map Input map object. - * @param valuesToRemove Specify the values to remove from the map. - * @return a Map with removed default values. - */ - private static Map removeKeys(Map map, List valuesToRemove) { - if (valuesToRemove == null) return map; - valuesToRemove.forEach(key -> map.remove(key, map.get(key))); - return map; - } -} diff --git a/azd/src/main/java/org/azd/utils/RestClient.java b/azd/src/main/java/org/azd/utils/RestClient.java deleted file mode 100644 index a6275cc0..00000000 --- a/azd/src/main/java/org/azd/utils/RestClient.java +++ /dev/null @@ -1,323 +0,0 @@ -package org.azd.utils; - -import org.azd.connection.Connection; -import org.azd.enums.ApiExceptionTypes; -import org.azd.enums.CustomHeader; -import org.azd.enums.RequestMethod; -import org.azd.exceptions.AzDException; - -import java.io.InputStream; -import java.net.http.HttpHeaders; -import java.net.http.HttpRequest; -import java.net.http.HttpResponse; -import java.util.Map; -import java.util.OptionalLong; -import java.util.concurrent.CompletableFuture; - -import static org.azd.utils.RestClientProvider.buildRequestUrl; - -/** - * RestClient to call Azure DevOps REST API. - */ -@Deprecated(since = "v6.0") -public abstract class RestClient { - - /** - * Http Headers of last request. We want to make these accessible everywhere (i.e) something that - * can be checked after every request, but we don't want to have to modify all the existing API methods - * to return the data. - *

- * We need this to be able to check if we are near any API rate limits - as creating 20+ releases in - * a short time can cause one to go over the limit and even have requests fail. - */ - static HttpHeaders headersFromLastRequest = null; - - /** - * Method to get retryAfterInterval value from response header - * - * @return Value in seconds (if it exists in header) of how long we should wait to send next request. - */ - static OptionalLong retryAfterInterval() { - if (headersFromLastRequest != null) { - return headersFromLastRequest.firstValueAsLong("Retry-After"); - } - return OptionalLong.empty(); - } - - /** - * Request the Azure DevOps REST API and builds the request url dynamically based on resource id and endpoints passed - * - * @param requestMethod type of request GET, POST, PATCH, DELETE {@link RequestMethod} - * @param connection name of the organization - * @param resourceId pass the resource id. - * @param project name of the project - * @param area resource area - * @param id resource id - * @param resource resource area endpoint - * @param apiVersion api version - * @param queryString query string to append the url - * @param requestBody Api payload for post, patch and put methods - * @param contentType Type of content to request and accept as; Default is "Accept", "application/json" - * @return String response from Api - * @throws AzDException Default Api exception handler - */ - public static String send( - RequestMethod requestMethod, - Connection connection, - String resourceId, - String project, - String area, - String id, - String resource, - String apiVersion, - Map queryString, - Object requestBody, - CustomHeader contentType) throws AzDException { - String requestUrl = buildRequestUrl(connection.getOrganization(), resourceId, project, area, id, resource, apiVersion, queryString); - - if (contentType == null) contentType = CustomHeader.JSON; - - HttpResponse response = RestClientProvider.response(requestMethod, requestUrl, connection.getPersonalAccessToken(), - HttpRequest.BodyPublishers.ofString(RestClientProvider.MAPPER.convertToString(requestBody)), - HttpResponse.BodyHandlers.ofString(), - contentType, false) - .join(); - - headersFromLastRequest = response.headers(); - - return response.body(); - } - - /** - * Request the Azure DevOps REST API and builds the request url dynamically based on resource id and endpoints passed - * - * @param requestMethod type of request GET, POST, PATCH, DELETE {@link RequestMethod} - * @param connection name of the organization - * @param resourceId pass the resource id. - * @param project name of the project - * @param area resource area - * @param id resource id - * @param resource resource area endpoint - * @param apiVersion api version - * @param queryString query string to append the url - * @param contentStream API payload as stream - * @param contentType Type of content to request and accept as; Default is "Content-Type", "application/octet-stream" - * @param callback If true default redirect policy will be applied. The redirect policy can be controlled - * in BaseRestClient class. - * @return InputStream from API - * @throws AzDException Default Api exception handler - */ - public static InputStream send( - RequestMethod requestMethod, - Connection connection, - String resourceId, - String project, - String area, - String id, - String resource, - String apiVersion, - Map queryString, - InputStream contentStream, - CustomHeader contentType, - boolean callback) throws AzDException { - String requestUrl = buildRequestUrl(connection.getOrganization(), resourceId, project, area, id, resource, apiVersion, queryString); - - if (contentType == null) contentType = CustomHeader.STREAM; - - return RestClientProvider.response(requestMethod, requestUrl, connection.getPersonalAccessToken(), - HttpRequest.BodyPublishers.ofInputStream(() -> contentStream), - HttpResponse.BodyHandlers.ofInputStream(), contentType, callback) - .thenApplyAsync(HttpResponse::body) - .join(); - } - - /** - * Mediator for BaseRestClient and other Api implementations. - * - * @param requestUrl Pass the request url if any. Note that if the url is passed only this will be considered for Api call. - * @param requestMethod type of request GET, POST, PATCH, DELETE {@link RequestMethod} - * @param connection name of the organization - * @param resourceId pass the resource id. - * @param project name of the project - * @param area resource area - * @param id resource id - * @param resource resource area endpoint - * @param apiVersion api version - * @param queryString query string to append the url - * @param contentStream API payload as stream - * @param contentType Type of content to request and accept as; Default is "Content-Type", "application/octet-stream" - * @param callback If true default redirect policy will be applied. The redirect policy can be controlled - * @return A Future of Http response stream. - * @throws AzDException Default Api exception handler. - */ - public static CompletableFuture> send( - String requestUrl, - RequestMethod requestMethod, - Connection connection, - String resourceId, - String project, - String area, - String id, - String resource, - String apiVersion, - Map queryString, - InputStream contentStream, - CustomHeader contentType, - boolean callback) throws AzDException { - if (requestUrl == null) - requestUrl = buildRequestUrl(connection.getOrganization(), resourceId, project, area, id, resource, apiVersion, queryString); - - if (contentType == null) contentType = CustomHeader.STREAM; - - if (connection != null) - return RestClientProvider.response(requestMethod, requestUrl, connection.getPersonalAccessToken(), - HttpRequest.BodyPublishers.ofInputStream(() -> contentStream), - HttpResponse.BodyHandlers.ofInputStream(), contentType, callback); - - return RestClientProvider.response(requestMethod, requestUrl, null, - HttpRequest.BodyPublishers.ofInputStream(() -> contentStream), - HttpResponse.BodyHandlers.ofInputStream(), contentType, callback); - } - - /** - * Mediator for BaseRestClient and other Api implementations. - * - * @param requestUrl Pass the request url if any. Note that if the url is passed only this will be considered for Api call. - * @param requestMethod type of request GET, POST, PATCH, DELETE {@link RequestMethod} - * @param requestBody API payload - * @param contentType Type of content to request and accept as; Default is "Accept", "application/json" - * @param callback If true default redirect policy will be applied. The redirect policy can be controlled - * @return String response from Api - * @throws AzDException Default Api exception handler - */ - public static String send( - String requestUrl, - RequestMethod requestMethod, - Object requestBody, - CustomHeader contentType, - boolean callback) throws AzDException { - if (contentType == null) contentType = CustomHeader.JSON; - - var response = RestClientProvider.response(requestMethod, requestUrl, null, - HttpRequest.BodyPublishers.ofString(RestClientProvider.MAPPER.convertToString(requestBody)), - HttpResponse.BodyHandlers.ofString(), contentType, callback) - .join(); - - headersFromLastRequest = response.headers(); - - return response.body(); - } - - /** - * Mediator for BaseRestClient and other Api implementations. - * - * @param requestUrl Pass the request url if any. Note that if the url is passed only this will be considered for Api call. - * @param connection Connection object to determine the mandatory details for calling the Api. - * @param requestMethod type of request GET, POST, PATCH, DELETE {@link RequestMethod} - * @param requestBody API payload - * @param contentType Type of content to request and accept as; Default is "Accept", "application/json" - * @param callback If true default redirect policy will be applied. The redirect policy can be controlled - * @return String response from Api - * @throws AzDException Default Api exception handler - */ - public static String send( - String requestUrl, - Connection connection, - RequestMethod requestMethod, - Object requestBody, - CustomHeader contentType, - boolean callback) throws AzDException { - if (contentType == null) contentType = CustomHeader.JSON; - - var response = RestClientProvider.response(requestMethod, requestUrl, connection.getPersonalAccessToken(), - HttpRequest.BodyPublishers.ofString(RestClientProvider.MAPPER.convertToString(requestBody)), - HttpResponse.BodyHandlers.ofString(), contentType, callback) - .join(); - - headersFromLastRequest = response.headers(); - - return response.body(); - } - - /** - * Helper method and a mediator for calling Azure DevOps REST Api. - * - * @param requestUrl Pass the request url if any. Note that if the url is passed only this will be considered for Api call. - * @param requestMethod type of request GET, POST, PATCH, DELETE {@link RequestMethod} - * @param connection name of the organization - * @param resourceId pass the resource id. - * @param project name of the project - * @param area resource area - * @param id resource id - * @param resource resource area endpoint - * @param apiVersion api version - * @param queryString query string to append the url - * @param publisher HttpRequest body publisher type - * @param handler HttpResponse body type - * @param headerMap Map of request headers. - * @param callback If true default redirect policy will be applied - * @param Type name that is been returned. - * @return Generic type can be String or Stream response from Api. - * @throws AzDException Default Api exception handler. - */ - public static CompletableFuture> send( - String requestUrl, - RequestMethod requestMethod, - Connection connection, - String resourceId, - String project, - String area, - String id, - String resource, - String apiVersion, - Map queryString, - HttpRequest.BodyPublisher publisher, - HttpResponse.BodyHandler handler, - Map headerMap, - boolean callback) throws AzDException { - if (requestUrl == null) - requestUrl = buildRequestUrl(connection.getOrganization(), resourceId, project, area, id, resource, apiVersion, queryString); - - if (headerMap == null) headerMap = Map.of("Accept", CustomHeader.JSON); - - HttpRequest.Builder builder; - - if (connection != null) { - builder = RestClientProvider.getBuilder(requestUrl, connection.getPersonalAccessToken()); - for (var key : headerMap.keySet()) { - // This can only be used when there are no restricted content headers, such as Content-Length. - builder.header(headerMap.get(key).getName(), headerMap.get(key).getValue()); - } - - if (requestMethod == RequestMethod.GET) - return RestClientProvider.getResponse(builder.GET().build(), handler, callback); - if (requestMethod == RequestMethod.POST) - return RestClientProvider.getResponse(builder.POST(publisher).build(), handler, callback); - if (requestMethod == RequestMethod.PATCH) - return RestClientProvider.getResponse(builder.method(RequestMethod.PATCH.name(), publisher).build(), handler, callback); - if (requestMethod == RequestMethod.PUT) - return RestClientProvider.getResponse(builder.PUT(publisher).build(), handler, callback); - if (requestMethod == RequestMethod.DELETE) - return RestClientProvider.getResponse(builder.DELETE().build(), handler, callback); - } - - throw new AzDException(ApiExceptionTypes.InvalidArgumentException.name(), "Connection object cannot be null."); - } - - /** - * Metadata class to retrieve the response headers. - */ - public static final class Metadata { - public static String getResponseHeader(String value) { - return RestClient.headersFromLastRequest.firstValue(value).orElse(null); - } - - public static HttpHeaders getResponseHeaders() { - return RestClient.headersFromLastRequest; - } - - public OptionalLong getRetryAfterInterval() { - return RestClient.retryAfterInterval(); - } - } -} diff --git a/azd/src/main/java/org/azd/utils/RestClientProvider.java b/azd/src/main/java/org/azd/utils/RestClientProvider.java deleted file mode 100644 index 7c0c7ea1..00000000 --- a/azd/src/main/java/org/azd/utils/RestClientProvider.java +++ /dev/null @@ -1,124 +0,0 @@ -package org.azd.utils; - -import org.azd.common.types.LocationUrl; -import org.azd.enums.ApiExceptionTypes; -import org.azd.enums.Instance; -import org.azd.enums.RequestMethod; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; - -import java.net.http.HttpResponse; -import java.util.Map; - -@Deprecated(since = "v6.0") -public final class RestClientProvider extends BaseRestClient { - protected static final JsonMapper MAPPER = new JsonMapper(); - private static final String API_RELATIVE_PATH = "_apis"; - private static final String API_PREVIEW_INDICATOR = "?api-preview="; - private static final String API_VERSION_INDICATOR = "?api-version="; - - /** - * Gets the resource area url based on resource id passed for the organization - * - * @param resourceID pass the resource id - * @param organizationName pass the organization name - * @return resource area url - * @throws AzDException throws user understandable error message with error code from API - */ - private static String getLocationUrl(String resourceID, String organizationName) throws AzDException { - - String INSTANCE = Instance.BASE_INSTANCE.getInstance(); - INSTANCE = INSTANCE.replaceAll("/$", "") + "/"; - - if (resourceID == null) return (INSTANCE + organizationName); - - // Manage Accounts Api when the resource id is accounts. Accounts Api resource id doesn't return the desired location url. - if (resourceID.equals("accounts")) return Instance.ACCOUNT_INSTANCE.getInstance(); - - String url = new StringBuilder().append(INSTANCE) - .append(organizationName) - .append("/" + API_RELATIVE_PATH + "/resourceAreas/") - .append(resourceID) - .append(API_PREVIEW_INDICATOR) - .append("5.0-preview.1") - .toString(); - - try { - var response = response(RequestMethod.GET, url, null, null, - HttpResponse.BodyHandlers.ofString(), null, false) - .thenApplyAsync(HttpResponse::body) - .join(); - - String r = MAPPER.mapJsonResponse(response, LocationUrl.class).getLocationUrl(); - return r.replaceAll("/$", ""); - } catch (Exception e) { - throw new AzDException(ApiExceptionTypes.InvalidOrganizationNameException.name(), - "Couldn't find the organization name '" + organizationName + "' in instance '" + INSTANCE + "'."); - } - } - - /** - * Builds the request url dynamically for the passed service, resource and area - * - * @param organizationName pass the Azure DevOps organization name - * @param resourceId pass the resource id - * @param project pass the project name - * @param area area of the REST API e.g., Release - * @param id id of any entity to pass in - * @param resource pass the resource entity e.g., Releases - * @param apiVersion pass the API version - * @param queryString pass the query string to form the url - * @return resource area url - * @throws AzDException throws user understandable error message with error code from API - */ - protected static String buildRequestUrl( - String organizationName, - String resourceId, - String project, - String area, - String id, - String resource, - String apiVersion, - Map queryString) throws AzDException { - // build the request url to dynamically serve the API requests - - String pathSeparator = "/"; - StringBuilder stringBuilder = new StringBuilder(); - stringBuilder.append((getLocationUrl(resourceId, organizationName))); - - if (project != null) { - stringBuilder.append(pathSeparator).append(project); - } - - stringBuilder.append(pathSeparator + API_RELATIVE_PATH); - - if (area != null) { - stringBuilder.append(pathSeparator).append(area); - } - if (id != null) { - stringBuilder.append(pathSeparator).append(id); - } - if (resource != null) { - stringBuilder.append(pathSeparator).append(resource); - } - stringBuilder.append(API_VERSION_INDICATOR).append(apiVersion); - if (queryString != null) { - for (var key : queryString.keySet()) { - stringBuilder.append(getQueryString(key, queryString.get(key))); - } - } - - return stringBuilder.toString(); - } - - /** - * Helps to create a query string from given key and value - * - * @param key pass the key of the HashMap - * @param value pass the value of the HasMap - * @return query string - */ - private static String getQueryString(String key, Object value) { - return "&" + key + "=" + value; - } -} diff --git a/azd/src/main/java/org/azd/wiki/WikiApi.java b/azd/src/main/java/org/azd/wiki/WikiApi.java deleted file mode 100644 index d52857bb..00000000 --- a/azd/src/main/java/org/azd/wiki/WikiApi.java +++ /dev/null @@ -1,679 +0,0 @@ -package org.azd.wiki; - -import org.azd.common.ApiVersion; -import org.azd.common.ResourceId; -import org.azd.connection.Connection; -import org.azd.enums.*; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.helpers.StreamHelper; -import org.azd.helpers.URLHelper; -import org.azd.interfaces.WikiDetails; -import org.azd.utils.AzDAsyncApi; -import org.azd.wiki.types.*; - -import java.io.InputStream; -import java.net.http.HttpHeaders; -import java.net.http.HttpRequest; -import java.net.http.HttpResponse; -import java.util.HashMap; -import java.util.Map; - -import static org.azd.utils.RestClient.send; - -/** - * Wiki class to manage Wiki API - */ -public class WikiApi extends AzDAsyncApi implements WikiDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "wiki/wikis"; - private final String WIKI = "bf7d82a0-8aa5-4613-94ef-6172a5ea01f3"; - - /** - * Pass the connection object to work with Work Api - * - * @param connection Connection object - */ - public WikiApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Creates the wiki resource. - * - * @param wikiCreateParameters {@link WikiCreateParameters} helps to create code wiki and project wiki. Use the constructor - * parameter to create respective wikis. - * @return WikiV2 object {@link WikiV2} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WikiV2 createWiki(WikiCreateParameters wikiCreateParameters) throws AzDException { - if (wikiCreateParameters.getProjectId() == null) throw new AzDException("Project id cannot be empty."); - - String r = send(RequestMethod.POST, CONNECTION, WIKI, wikiCreateParameters.getProjectId(), - AREA, null, null, ApiVersion.WIKI, null, wikiCreateParameters, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, WikiV2.class); - } - - /** - * Deletes the wiki corresponding to the wiki ID or wiki name provided. - * - * @param wikiIdentifier Wiki ID or wiki name. - * @return WikiV2 {@link WikiV2} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WikiV2 deleteWiki(String wikiIdentifier) throws AzDException { - String r = send(RequestMethod.DELETE, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, null, ApiVersion.WIKI, null, null, null); - - return MAPPER.mapJsonResponse(r, WikiV2.class); - } - - /** - * Gets the wiki corresponding to the wiki ID or wiki name provided. - * - * @param wikiIdentifier Wiki ID or wiki name. - * @return WikiV2 {@link WikiV2} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WikiV2 getWiki(String wikiIdentifier) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, null, ApiVersion.WIKI, null, null, null); - - return MAPPER.mapJsonResponse(r, WikiV2.class); - } - - /** - * Gets all wikis in a project or collection. - * - * @return WikiV2s {@link WikiV2Pages} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WikiV2Pages getWikis() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, null, null, ApiVersion.WIKI, null, null, null); - - return MAPPER.mapJsonResponse(r, WikiV2Pages.class); - } - - /** - * Creates an attachment in the wiki. - * - * @param wikiIdentifier Wiki ID or wiki name. - * @param name Wiki attachment name. - * @return WikiAttachment Object {@link WikiAttachment} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WikiAttachment createWikiAttachment(String wikiIdentifier, String name, InputStream content) throws AzDException { - var q = new HashMap() {{ - put("name", name != null ? URLHelper.encodeSpecialWithSpace(name) : null); - }}; - - // Wiki attachment Api accepts only encoded String values. - var body = StreamHelper.convertStreamToBase64(content); - - var r = send(null, RequestMethod.PUT, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "attachments", ApiVersion.WIKI_ATTACHMENTS, - q, HttpRequest.BodyPublishers.ofString(body), HttpResponse.BodyHandlers.ofString(), Map.of("Stream", CustomHeader.STREAM), false); - - var result = MAPPER.mapJsonResponse(r.thenApplyAsync(HttpResponse::body).join(), WikiAttachment.class); - - // Version tag of the attachment is set in headers and this is required for editing wiki pages. - var eTag = getValueFromHeader(r.thenApplyAsync(HttpResponse::headers).join(), "etag"); - if (eTag != null) result.seteTag(eTag); - - return result; - } - - /** - * Creates an attachment in the wiki. - * - * @param wikiIdentifier Wiki ID or wiki name. - * @param name Wiki attachment name. - * @param version Version string identifier (name of tag/branch, SHA1 of commit) - * @param versionOptions Version options - Specify additional modifiers to version (e.g Previous) - * @param versionType Version type (branch, tag, or commit). Determines how Id is interpreted - * @return WikiAttachment Object {@link WikiAttachment} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WikiAttachment createWikiAttachment(String wikiIdentifier, String name, String version, - GitVersionType versionType, GitVersionOptions versionOptions, InputStream content) throws AzDException { - var q = new HashMap() {{ - put("name", name != null ? URLHelper.encodeSpecialWithSpace(name) : null); - put("version", version); - put("versionType", versionType.name()); - put("versionOptions", versionOptions.name()); - }}; - - // Wiki attachment Api accepts only encoded String values. - var body = StreamHelper.convertStreamToBase64(content); - - var r = send(null, RequestMethod.PUT, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "attachments", ApiVersion.WIKI_ATTACHMENTS, - q, HttpRequest.BodyPublishers.ofString(body), HttpResponse.BodyHandlers.ofString(), Map.of("Stream", CustomHeader.STREAM), false); - - var result = MAPPER.mapJsonResponse(r.thenApplyAsync(HttpResponse::body).join(), WikiAttachment.class); - - // Version tag of the attachment is set in headers and this is required for editing wiki pages. - var eTag = getValueFromHeader(r.thenApplyAsync(HttpResponse::headers).join(), "etag"); - if (eTag != null) result.seteTag(eTag); - - return result; - } - - /** - * Creates a page move operation that updates the path and order of the page as provided in the parameters. - * - * @param wikiIdentifier Wiki ID or wiki name. - * @param comment Comment that is to be associated with this page move. - * @return WikiPageMove Object {@link WikiPageMove} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WikiPageMove createPageMove(String wikiIdentifier, String comment, WikiPageMoveParameters pageMoveParameters) throws AzDException { - var q = new HashMap() {{ - put("comment", comment != null ? URLHelper.encodeSpecialWithSpace(comment) : null); - }}; - - var r = send(null, RequestMethod.POST, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "pagemoves", ApiVersion.WIKI_ATTACHMENTS, - q, HttpRequest.BodyPublishers.ofString(MAPPER.convertToString(pageMoveParameters)), - HttpResponse.BodyHandlers.ofString(), Map.of("Content-Type", CustomHeader.JSON_CONTENT_TYPE), false); - - var result = MAPPER.mapJsonResponse(r.thenApplyAsync(HttpResponse::body).join(), WikiPageMove.class); - - // Version tag of the attachment is set in headers and this is required for editing wiki pages. - var eTag = getValueFromHeader(r.thenApplyAsync(HttpResponse::headers).join(), "etag"); - if (eTag != null) result.seteTag(eTag); - - return result; - } - - /** - * Creates a page move operation that updates the path and order of the page as provided in the parameters. - * - * @param wikiIdentifier Wiki ID or wiki name. - * @param comment Comment that is to be associated with this page move. - * @param version Version string identifier (name of tag/branch, SHA1 of commit) - * @param versionOptions Version options - Specify additional modifiers to version (e.g Previous) - * @param versionType Version type (branch, tag, or commit). Determines how Id is interpreted - * @return WikiPageMove Object {@link WikiPageMove} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WikiPageMove createPageMove(String wikiIdentifier, String comment, String version, - GitVersionType versionType, GitVersionOptions versionOptions, - WikiPageMoveParameters pageMoveParameters) throws AzDException { - var q = new HashMap() {{ - put("comment", comment); - put("version", version); - put("versionType", versionType.name()); - put("versionOptions", versionOptions.name()); - }}; - - var r = send(null, RequestMethod.POST, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "pagemoves", ApiVersion.WIKI_ATTACHMENTS, - q, HttpRequest.BodyPublishers.ofString(MAPPER.convertToString(pageMoveParameters)), - HttpResponse.BodyHandlers.ofString(), Map.of("Content-Type", CustomHeader.JSON_CONTENT_TYPE), false); - - var result = MAPPER.mapJsonResponse(r.thenApplyAsync(HttpResponse::body).join(), WikiPageMove.class); - - // Version tag of the attachment is set in headers and this is required for editing wiki pages. - var eTag = getValueFromHeader(r.thenApplyAsync(HttpResponse::headers).join(), "etag"); - if (eTag != null) result.seteTag(eTag); - - return result; - } - - /** - * Returns page detail corresponding to Page ID. - * - * @param pageId Wiki page ID. - * @param wikiIdentifier Wiki ID or wiki name. - * @return WikiPageDetail Object {@link WikiPageDetail} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WikiPageDetail getPageStats(String wikiIdentifier, int pageId, int pageViewsForDays) throws AzDException { - var q = new HashMap() {{ - put("pageViewsForDays", pageViewsForDays); - }}; - - var r = send(RequestMethod.POST, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "pages/" + pageId + "/stats", ApiVersion.WIKI_ATTACHMENTS, - q, null, CustomHeader.JSON); - - return MAPPER.mapJsonResponse(r, WikiPageDetail.class); - } - - /** - * Creates or edits a wiki page. - * - * @param wikiIdentifier Wiki ID or wiki name. - * @param path Wiki page path. - * @param comment Comment to be associated with the page operation. - * @return WikiPage Object {@link WikiPage} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WikiPage createOrUpdateWikiPage(String wikiIdentifier, String path, String comment, String eTagVersion, String content) throws AzDException { - var q = new HashMap() {{ - put("path", path); - put("comment", comment != null ? URLHelper.encodeSpecialWithSpace(comment) : null); - }}; - - var headers = new HashMap() {{ - put("Content-Type", CustomHeader.JSON_CONTENT_TYPE); - }}; - - if (eTagVersion != null) { - CustomHeader.CUSTOM_HEADER.setCustomHeaders("If-Match", eTagVersion); - headers.put("If-Match", CustomHeader.CUSTOM_HEADER); - } - - var r = send(null, RequestMethod.PUT, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "pages", ApiVersion.WIKI_ATTACHMENTS, - q, HttpRequest.BodyPublishers.ofString(MAPPER.convertToString(Map.of("content", content))), - HttpResponse.BodyHandlers.ofString(), headers, false); - - var result = MAPPER.mapJsonResponse(r.thenApplyAsync(HttpResponse::body).join(), WikiPage.class); - - // Version tag of the attachment is set in headers and this is required for editing wiki pages. - // etag value is returned in both create and update operations. - var eTag = getValueFromHeader(r.thenApplyAsync(HttpResponse::headers).join(), "etag"); - if (eTag != null) result.seteTag(eTag); - - return result; - } - - /** - * Creates or edits a wiki page. - * - * @param wikiIdentifier Wiki ID or wiki name. - * @param path Wiki page path. - * @param comment Comment to be associated with the page operation. - * @param version Version string identifier (name of tag/branch, SHA1 of commit) - * @param versionOptions Version options - Specify additional modifiers to version (e.g Previous) - * @param versionType Version type (branch, tag, or commit). Determines how Id is interpreted - * @return WikiPage Object {@link WikiPage} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WikiPage createOrUpdateWikiPage(String wikiIdentifier, String path, String comment, String eTagVersion, String version, - GitVersionType versionType, GitVersionOptions versionOptions, - String content) throws AzDException { - var q = new HashMap() {{ - put("path", path); - put("comment", comment != null ? URLHelper.encodeSpecialWithSpace(comment) : null); - put("version", version); - put("versionType", versionType.name()); - put("versionOptions", versionOptions.name()); - }}; - - var headers = new HashMap() {{ - put("Content-Type", CustomHeader.JSON_CONTENT_TYPE); - }}; - - if (eTagVersion != null) { - CustomHeader.CUSTOM_HEADER.setCustomHeaders("If-Match", eTagVersion); - headers.put("If-Match", CustomHeader.CUSTOM_HEADER); - } - - var r = send(null, RequestMethod.PUT, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "pages", ApiVersion.WIKI_ATTACHMENTS, - q, HttpRequest.BodyPublishers.ofString(MAPPER.convertToString(Map.of("content", content))), - HttpResponse.BodyHandlers.ofString(), headers, false); - - var result = MAPPER.mapJsonResponse(r.thenApplyAsync(HttpResponse::body).join(), WikiPage.class); - - // Version tag of the attachment is set in headers and this is required for editing wiki pages. - // etag value is returned in both create and update operations. - var eTag = getValueFromHeader(r.thenApplyAsync(HttpResponse::headers).join(), "etag"); - if (eTag != null) result.seteTag(eTag); - - return result; - } - - /** - * Deletes a wiki page. - * - * @param wikiIdentifier Wiki ID or wiki name. - * @param path Wiki page path. - * @param comment Comment to be associated with this page delete. - * @return WikiPage Object {@link WikiPage} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WikiPage deleteWikiPage(String wikiIdentifier, String path, String comment) throws AzDException { - var q = new HashMap() {{ - put("path", path); - put("comment", comment != null ? URLHelper.encodeSpecialWithSpace(comment) : null); - }}; - - var r = send(null, RequestMethod.DELETE, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "pages", ApiVersion.WIKI_ATTACHMENTS, q, null, - HttpResponse.BodyHandlers.ofString(), Map.of("Content-Type", CustomHeader.JSON_CONTENT_TYPE), false); - - var result = MAPPER.mapJsonResponse(r.thenApplyAsync(HttpResponse::body).join(), WikiPage.class); - - // Version tag of the attachment is set in headers and this is required for editing wiki pages. - // etag value is returned in both create and update operations. - var eTag = getValueFromHeader(r.thenApplyAsync(HttpResponse::headers).join(), "etag"); - if (eTag != null) result.seteTag(eTag); - - return result; - } - - /** - * Deletes a wiki page. - * - * @param wikiIdentifier Wiki ID or wiki name. - * @param path Wiki page path. - * @param comment Comment to be associated with this page delete. - * @param version Version string identifier (name of tag/branch, SHA1 of commit) - * @param versionOptions Version options - Specify additional modifiers to version (e.g Previous) - * @param versionType Version type (branch, tag, or commit). Determines how Id is interpreted - * @return WikiPage Object {@link WikiPage} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WikiPage deleteWikiPage(String wikiIdentifier, String path, String comment, String version, - GitVersionType versionType, GitVersionOptions versionOptions) throws AzDException { - var q = new HashMap() {{ - put("path", path); - put("comment", comment != null ? URLHelper.encodeSpecialWithSpace(comment) : null); - put("version", version); - put("versionType", versionType.name()); - put("versionOptions", versionOptions.name()); - }}; - - var r = send(null, RequestMethod.DELETE, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "pages", ApiVersion.WIKI_ATTACHMENTS, q, null, - HttpResponse.BodyHandlers.ofString(), Map.of("Content-Type", CustomHeader.JSON_CONTENT_TYPE), false); - - var result = MAPPER.mapJsonResponse(r.thenApplyAsync(HttpResponse::body).join(), WikiPage.class); - - // Version tag of the attachment is set in headers and this is required for editing wiki pages. - // etag value is returned in both create and update operations. - var eTag = getValueFromHeader(r.thenApplyAsync(HttpResponse::headers).join(), "etag"); - if (eTag != null) result.seteTag(eTag); - - return result; - } - - /** - * Deletes a wiki page. - * - * @param id Wiki page ID. - * @param wikiIdentifier Wiki ID or wiki name. - * @param comment Comment to be associated with this page delete. - * @return WikiPage Object {@link WikiPage} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WikiPage deleteWikiPageById(String id, String wikiIdentifier, String path, String comment, String version, - GitVersionType versionType, GitVersionOptions versionOptions) throws AzDException { - var q = new HashMap() {{ - put("path", path); - put("comment", comment != null ? URLHelper.encodeSpecialWithSpace(comment) : null); - }}; - - var r = send(null, RequestMethod.DELETE, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "pages/" + id, ApiVersion.WIKI_ATTACHMENTS, q, null, - HttpResponse.BodyHandlers.ofString(), Map.of("Content-Type", CustomHeader.JSON_CONTENT_TYPE), false); - - var result = MAPPER.mapJsonResponse(r.thenApplyAsync(HttpResponse::body).join(), WikiPage.class); - - // Version tag of the attachment is set in headers and this is required for editing wiki pages. - // etag value is returned in both create and update operations. - var eTag = getValueFromHeader(r.thenApplyAsync(HttpResponse::headers).join(), "etag"); - if (eTag != null) result.seteTag(eTag); - - return result; - } - - /** - * Gets metadata of the wiki page for the provided path. - * - * @param wikiIdentifier Wiki ID or wiki name. - * @return WikiPage Object {@link WikiPage} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WikiPage getWikiPage(String wikiIdentifier) throws AzDException { - - var r = send(null, RequestMethod.GET, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "pages", ApiVersion.WIKI_ATTACHMENTS, null, null, - HttpResponse.BodyHandlers.ofString(), null, false); - - var result = MAPPER.mapJsonResponse(r.thenApplyAsync(HttpResponse::body).join(), WikiPage.class); - - // Version tag of the attachment is set in headers and this is required for editing wiki pages. - // etag value is returned in both create and update operations. - var eTag = getValueFromHeader(r.thenApplyAsync(HttpResponse::headers).join(), "etag"); - if (eTag != null) result.seteTag(eTag); - - return result; - } - - /** - * Gets metadata of the wiki page for the provided path. - * - * @param wikiIdentifier Wiki ID or wiki name. - * @param includeContent True to include the content of the page in the response for Json content type. Defaults to false (Optional) - * @param path Wiki page path. - * @param recursionLevel Recursion level for subpages retrieval. Defaults to None (Optional). - * @param version Version string identifier (name of tag/branch, SHA1 of commit) - * @param versionOptions Version options - Specify additional modifiers to version (e.g Previous) - * @param versionType Version type (branch, tag, or commit). Determines how Id is interpreted - * @return WikiPage Object {@link WikiPage} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WikiPage getWikiPage(String wikiIdentifier, boolean includeContent, String path, - VersionControlRecursionType recursionLevel, String comment, String version, - GitVersionType versionType, GitVersionOptions versionOptions) throws AzDException { - var q = new HashMap() {{ - put("path", path); - put("includeContent", includeContent); - put("comment", comment != null ? URLHelper.encodeSpecialWithSpace(comment) : null); - put("recursionLevel", recursionLevel.name()); - put("version", version); - put("versionType", versionType.name()); - put("versionOptions", versionOptions.name()); - }}; - - var r = send(null, RequestMethod.GET, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "pages", ApiVersion.WIKI_ATTACHMENTS, q, null, - HttpResponse.BodyHandlers.ofString(), null, false); - - var result = MAPPER.mapJsonResponse(r.thenApplyAsync(HttpResponse::body).join(), WikiPage.class); - - // Version tag of the attachment is set in headers and this is required for editing wiki pages. - // etag value is returned in both create and update operations. - var eTag = getValueFromHeader(r.thenApplyAsync(HttpResponse::headers).join(), "etag"); - if (eTag != null) result.seteTag(eTag); - - return result; - } - - /** - * Gets metadata of the wiki page for the provided path. - * - * @param wikiIdentifier Wiki ID or wiki name. - * @param includeContent True to include the content of the page in the response for Json content type. Defaults to false (Optional) - * @param path Wiki page path. - * @param recursionLevel Recursion level for subpages retrieval. Defaults to None (Optional). - * @return WikiPage Object {@link WikiPage} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WikiPage getWikiPage(String wikiIdentifier, boolean includeContent, String path, - VersionControlRecursionType recursionLevel) throws AzDException { - var q = new HashMap(); - if (includeContent) q.put("includeContent", true); - if (path != null) q.put("path", URLHelper.encodeSpecialWithSpace(path)); - if (recursionLevel != null) q.put("recursionLevel", recursionLevel.name()); - - var r = send(null, RequestMethod.GET, CONNECTION, ResourceId.WIKI, CONNECTION.getProject(), - "wiki/wikis", wikiIdentifier, "pages", ApiVersion.WIKI_ATTACHMENTS, q, null, - HttpResponse.BodyHandlers.ofString(), null, false); - - var result = MAPPER.mapJsonResponse(r.thenApplyAsync(HttpResponse::body).join(), WikiPage.class); - - var eTag = getValueFromHeader(r.thenApplyAsync(HttpResponse::headers).join(), "etag"); - if (eTag != null) result.seteTag(eTag); - - return result; - } - - /** - * Gets metadata of the wiki page for the provided page id. - * - * @param id Wiki page ID. - * @param wikiIdentifier Wiki ID or wiki name.. - * @return WikiPage Object {@link WikiPage} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WikiPage getWikiPageById(String id, String wikiIdentifier) throws AzDException { - var r = send(null, RequestMethod.GET, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "pages/" + id, ApiVersion.WIKI_ATTACHMENTS, null, null, - HttpResponse.BodyHandlers.ofString(), null, false); - - var result = MAPPER.mapJsonResponse(r.thenApplyAsync(HttpResponse::body).join(), WikiPage.class); - - // Version tag of the attachment is set in headers and this is required for editing wiki pages. - // etag value is returned in both create and update operations. - var eTag = getValueFromHeader(r.thenApplyAsync(HttpResponse::headers).join(), "etag"); - if (eTag != null) result.seteTag(eTag); - - return result; - } - - /** - * Gets metadata of the wiki page for the provided page id. - * - * @param id Wiki page ID. - * @param wikiIdentifier Wiki ID or wiki name.. - * @param includeContent True to include the content of the page in the response for Json content type. Defaults to false (Optional) - * @param recursionLevel Recursion level for subpages retrieval. Defaults to None (Optional). - * @return WikiPage Object {@link WikiPage} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WikiPage getWikiPageById(String id, String wikiIdentifier, boolean includeContent, - VersionControlRecursionType recursionLevel) throws AzDException { - var q = new HashMap() {{ - put("includeContent", includeContent); - put("recursionLevel", recursionLevel.name()); - }}; - - var r = send(null, RequestMethod.GET, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "pages/" + id, ApiVersion.WIKI_ATTACHMENTS, q, null, - HttpResponse.BodyHandlers.ofString(), null, false); - - var result = MAPPER.mapJsonResponse(r.thenApplyAsync(HttpResponse::body).join(), WikiPage.class); - - // Version tag of the attachment is set in headers and this is required for editing wiki pages. - // etag value is returned in both create and update operations. - var eTag = getValueFromHeader(r.thenApplyAsync(HttpResponse::headers).join(), "etag"); - if (eTag != null) result.seteTag(eTag); - - return result; - } - - /** - * Gets content of the wiki page for the provided page id. - * - * @param id Wiki page ID. - * @param wikiIdentifier Wiki ID or wiki name.. - * @return WikiPage Object {@link WikiPage} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public String getWikiPageContent(String id, String wikiIdentifier) throws AzDException { - - var r = send(null, RequestMethod.GET, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "pages/" + id, ApiVersion.WIKI_ATTACHMENTS, null, null, - HttpResponse.BodyHandlers.ofString(), Map.of("Content-Type", CustomHeader.TEXT_CONTENT), false); - - return r.thenApplyAsync(HttpResponse::body).join(); - } - - /** - * Gets content of the wiki page as zip file for the provided page id. - * - * @param id Wiki page ID. - * @param wikiIdentifier Wiki ID or wiki name.. - * @return WikiPage Object {@link WikiPage} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public InputStream getWikiPageAsZip(String id, String wikiIdentifier) throws AzDException { - var r = send(null, RequestMethod.GET, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "pages/" + id, ApiVersion.WIKI_ATTACHMENTS, null, null, - HttpResponse.BodyHandlers.ofInputStream(), Map.of("Stream-Zip", CustomHeader.STREAM_ZIP_ACCEPT), false); - - return r.thenApplyAsync(HttpResponse::body).join(); - } - - /** - * Edits a wiki page. - * - * @param id Wiki page ID. - * @param wikiIdentifier Wiki ID or wiki name. - * @param comment Comment to be associated with the page operation. - * @return WikiPage Object {@link WikiPage} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WikiPage updateWikiPage(String id, String wikiIdentifier, String comment, String eTagVersion, String content) throws AzDException { - var q = new HashMap() {{ - put("comment", comment != null ? URLHelper.encodeSpecialWithSpace(comment) : null); - }}; - - CustomHeader.CUSTOM_HEADER.setCustomHeaders("If-Match", eTagVersion); - - var headers = new HashMap() {{ - put("Content-Type", CustomHeader.JSON_CONTENT_TYPE); - put("If-Match", CustomHeader.CUSTOM_HEADER); - }}; - - var r = send(null, RequestMethod.PATCH, CONNECTION, WIKI, CONNECTION.getProject(), - AREA, wikiIdentifier, "pages/" + id, ApiVersion.WIKI_ATTACHMENTS, q, - HttpRequest.BodyPublishers.ofString(MAPPER.convertToString(Map.of("content", content))), - HttpResponse.BodyHandlers.ofString(), headers, false); - - var result = MAPPER.mapJsonResponse(r.thenApplyAsync(HttpResponse::body).join(), WikiPage.class); - - // Version tag of the attachment is set in headers and this is required for editing wiki pages. - // etag value is returned in both create and update operations. - var eTag = getValueFromHeader(r.thenApplyAsync(HttpResponse::headers).join(), "etag"); - if (eTag != null) result.seteTag(eTag); - - return result; - } - - /** - * Helper method to inject the header value in json response. - * - * @param headers HttpHeaders object - * @param keyName Name of the header value to inject - */ - private String getValueFromHeader(HttpHeaders headers, String keyName) { - if (headers.firstValue(keyName).isPresent()) - return headers.firstValue(keyName).get().replaceAll("\"", ""); - return null; - } -} diff --git a/azd/src/main/java/org/azd/work/WorkApi.java b/azd/src/main/java/org/azd/work/WorkApi.java deleted file mode 100644 index 4366a853..00000000 --- a/azd/src/main/java/org/azd/work/WorkApi.java +++ /dev/null @@ -1,218 +0,0 @@ -package org.azd.work; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.enums.CustomHeader; -import org.azd.enums.IterationsTimeFrame; -import org.azd.enums.RequestMethod; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.WorkDetails; -import org.azd.utils.AzDAsyncApi; -import org.azd.work.types.*; - -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import static org.azd.helpers.URLHelper.encodeSpace; -import static org.azd.helpers.URLHelper.encodeSpecialWithSpace; -import static org.azd.utils.RestClient.send; - -/** - * Work class to manage work API - */ -public class WorkApi extends AzDAsyncApi implements WorkDetails { - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "work"; - private final String WORK = "1d4f49f9-02b9-4e26-b826-2cdb6195f2a9"; - - /** - * Pass the connection object to work with Work Api - * - * @param connection Connection object - */ - public WorkApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Get a team's iterations - * - * @param teamName Team ID or team name - * @return {@link TeamSettingsIterations} - * @throws AzDException Default Api Exception handler. - */ - @Override - public TeamSettingsIterations getTeamSettingsIterations(String teamName) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, WORK, - (CONNECTION.getProject() + "/" + encodeSpace(teamName)), - AREA, null, "teamsettings/iterations", ApiVersion.WORK, null, null, null); - - return MAPPER.mapJsonResponse(r, TeamSettingsIterations.class); - } - - /** - * Get a team's iterations using timeframe filter - * - * @param teamName Team ID or team name - * @param timeFrame A filter for which iterations are returned based on relative time. - * Only 'Current' is supported currently. {@link IterationsTimeFrame} - * @return {@link TeamSettingsIterations} - * @throws AzDException Default Api Exception handler. - */ - @Override - public TeamSettingsIterations getTeamSettingsIterations(String teamName, IterationsTimeFrame timeFrame) throws AzDException { - - var q = new HashMap() {{ - put("$timeframe", timeFrame.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, WORK, - (CONNECTION.getProject() + "/" + encodeSpace(teamName)), - AREA, null, "teamsettings/iterations", ApiVersion.WORK, q, null, null); - - return MAPPER.mapJsonResponse(r, TeamSettingsIterations.class); - } - - /** - * Get work items for iteration - * - * @param teamName Team ID or team name - * @param iterationId ID of the iteration - * @return {@link TeamSettingsIterations} - * @throws AzDException Default Api Exception handler. - */ - @Override - public IterationWorkItems getTeamIterationWorkItems(String teamName, String iterationId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, WORK, - (CONNECTION.getProject() + "/" + encodeSpace(teamName)), - AREA + "/teamsettings/iterations", iterationId, "workitems", ApiVersion.WORK, null, null, null); - - return MAPPER.mapJsonResponse(r, IterationWorkItems.class); - } - - /** - * Get team's iteration by iterationId - * - * @param teamName ID of the iteration - * @param iterationId Team ID or team name - * @return {@link TeamSettingsIterations} - * @throws AzDException Default Api Exception handler. - */ - @Override - public TeamSettingsIteration getTeamSettingsIteration(String teamName, String iterationId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, WORK, - (CONNECTION.getProject() + "/" + encodeSpace(teamName)), - AREA + "/teamsettings/iterations", iterationId, null, ApiVersion.WORK, null, null, null); - - return MAPPER.mapJsonResponse(r, TeamSettingsIteration.class); - } - - /** - * Delete a team's iteration by iterationId - * - * @param teamName Team ID or team name - * @param iterationId ID of the iteration - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteTeamSettingsIteration(String teamName, String iterationId) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, WORK, - (CONNECTION.getProject() + "/" + encodeSpace(teamName)), - AREA + "/teamsettings/iterations", iterationId, null, ApiVersion.WORK, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Get a team's capacity including total capacity and days off - * - * @param iterationId Pass the iteration id. - * @param teamName The name of the Azure DevOps organization. - * @return TeamCapacity Object {@link TeamCapacity} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TeamCapacity getTotalTeamCapacity(String iterationId, String teamName) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, WORK, - (CONNECTION.getProject() + "/" + encodeSpecialWithSpace(teamName)), - AREA + "/teamsettings/iterations", iterationId, "capacities", ApiVersion.WORK_CAPACITY, - null, null, null); - - return MAPPER.mapJsonResponse(r, TeamCapacity.class); - } - - /** - * Get a team member's capacity - * - * @param iterationId Pass the team iteration id. - * @param teamMemberId Id of the team member. - * @param teamName Name of Azure DevOps team. - * @return TeamMemberCapacityIdentityRef Object {@link TeamMemberCapacityIdentityRef} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TeamMemberCapacityIdentityRef getTeamMemberCapacity(String iterationId, String teamName, - String teamMemberId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, WORK, - (CONNECTION.getProject() + "/" + encodeSpecialWithSpace(teamName)), - AREA + "/teamsettings/iterations", iterationId, "capacities/" + teamMemberId, ApiVersion.WORK_CAPACITY, - null, null, null); - - return MAPPER.mapJsonResponse(r, TeamMemberCapacityIdentityRef.class); - } - - /** - * Replace a team's capacity - * - * @param iterationId Pass the team iteration id. - * @param teamName Name or id of the Azure DevOps team. - * @param teamMembersCapacity A list of team members capacity to update. - * @return TeamMemberCapacityIdentityRef Object {@link TeamMemberCapacityIdentityRef} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TeamMemberCapacityIdentityRefs updateTeamMembersCapacity(String iterationId, String teamName, - List teamMembersCapacity) throws AzDException { - String r = send(RequestMethod.PUT, CONNECTION, WORK, - (CONNECTION.getProject() + "/" + encodeSpecialWithSpace(teamName)), - AREA + "/teamsettings/iterations", iterationId, "capacities", ApiVersion.WORK_CAPACITY, - null, teamMembersCapacity, CustomHeader.JSON_CONTENT_TYPE); - return MAPPER.mapJsonResponse(r, TeamMemberCapacityIdentityRefs.class); - } - - /** - * Update a team member's capacity - * - * @param iterationId Pass the team iteration id. - * @param teamMemberId Id of the team member. - * @param teamName Name of id of the Azure DevOps team. - * @param teamMemberCapacity Team member capacity object to update. You can only pass the list of activities and optionally days off. - * @return TeamMemberCapacityIdentityRef Object {@link TeamMemberCapacityIdentityRef} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public TeamMemberCapacityIdentityRef updateTeamMemberCapacity(String iterationId, String teamName, String teamMemberId, - TeamMemberCapacityIdentityRef teamMemberCapacity) throws AzDException { - var body = new HashMap() {{ - put("activities", teamMemberCapacity.getActivities()); - put("daysOff", teamMemberCapacity.getDaysOff()); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, WORK, - (CONNECTION.getProject() + "/" + encodeSpecialWithSpace(teamName)), - AREA + "/teamsettings/iterations", iterationId, "capacities/" + teamMemberId, ApiVersion.WORK_CAPACITY, - null, body, CustomHeader.JSON_CONTENT_TYPE); - return MAPPER.mapJsonResponse(r, TeamMemberCapacityIdentityRef.class); - } - -} diff --git a/azd/src/main/java/org/azd/workitemtracking/WorkItemTrackingApi.java b/azd/src/main/java/org/azd/workitemtracking/WorkItemTrackingApi.java deleted file mode 100644 index 7697efe4..00000000 --- a/azd/src/main/java/org/azd/workitemtracking/WorkItemTrackingApi.java +++ /dev/null @@ -1,1423 +0,0 @@ -package org.azd.workitemtracking; - -import org.azd.common.ApiVersion; -import org.azd.connection.Connection; -import org.azd.enums.*; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.helpers.StreamHelper; -import org.azd.helpers.URLHelper; -import org.azd.interfaces.WorkItemTrackingDetails; -import org.azd.utils.AzDAsyncApi; -import org.azd.utils.ModelBuilder; -import org.azd.workitemtracking.types.*; - -import java.io.InputStream; -import java.text.MessageFormat; -import java.util.*; -import java.util.Map.Entry; - -import static org.azd.helpers.URLHelper.encodeSpace; -import static org.azd.utils.RestClient.send; - -/** - * WorkItem Tracking class to manage work items API - */ -public class WorkItemTrackingApi extends AzDAsyncApi implements WorkItemTrackingDetails { - - /** - * Connection object - */ - private final Connection CONNECTION; - private final JsonMapper MAPPER = new JsonMapper(); - private final String AREA = "wit"; - private final String WIT = "5264459e-e5e0-4bd8-b118-0985e68a4ec5"; - - /** - * Pass the connection object to work with WorkItem Tracking Api - * - * @param connection Connection object - */ - public WorkItemTrackingApi(Connection connection) { - this.CONNECTION = connection; - } - - /** - * Creates a single work item. - * - * @param workItemType The work item type of the work item to create. e.g., "user story", "bug", "task" - * @param operation The patch operation {@link WorkItemOperation} - * @param title The title for the work item - * @return {@link WorkItem} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItem createWorkItem(String workItemType, - WorkItemOperation operation, - String title) throws AzDException { - var req = new HashMap() {{ - put("op", operation.toString().toLowerCase()); - put("path", "/fields/System.Title"); - put("from", null); - put("value", title); - }}; - - String r = send(RequestMethod.POST, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", null, "$" + encodeSpace(workItemType), ApiVersion.WORK_ITEM_TRACKING, - null, List.of(req), CustomHeader.JSON_PATCH); - - return MAPPER.mapJsonResponse(r, WorkItem.class); - } - - /** - * Creates a single work item. - * - * @param workItemType The work item type of the work item to create. e.g., "user story", "bug", "task" - * @param operation The patch operation {@link WorkItemOperation} - * @param title The title for the work item - * @param description Description for the work item - * @param tags Tags for the work item - * @return {@link WorkItem} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItem createWorkItem(String workItemType, - WorkItemOperation operation, String title, - String description, String[] tags) throws AzDException { - var t = new HashMap() {{ - put("op", operation.toString().toLowerCase()); - put("path", "/fields/System.Title"); - put("from", null); - put("value", title); - }}; - - var d = new HashMap() {{ - put("op", operation.toString().toLowerCase()); - put("path", "/fields/System.Description"); - put("from", null); - put("value", description); - }}; - - var tt = new HashMap() {{ - put("op", operation.toString().toLowerCase()); - put("path", "/fields/System.Tags"); - put("from", null); - put("value", String.join(",", tags)); - }}; - - var req = new ArrayList<>(); - req.add(t); - req.add(d); - req.add(tt); - - String r = send(RequestMethod.POST, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", null, "$" + encodeSpace(workItemType), ApiVersion.WORK_ITEM_TRACKING, - null, req, CustomHeader.JSON_PATCH); - - return MAPPER.mapJsonResponse(r, WorkItem.class); - } - - /** - * Creates a single work item optionally with additional fields. - * - * @param workItemType The work item type of the work item to create. e.g., "user story", "bug", "task" - * @param title The title for the work item - * @param description Description for the work item - * @param additionalFields Provide the additional fields as a HashMap to create the work item. - * This requires the internal fields to be specified. E.g., System.Tags, System.AreaPath, System.State, System.Reason etc., - * @return {@link WorkItem} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItem createWorkItem(String workItemType, String title, String description, Map additionalFields) - throws AzDException { - var req = new ArrayList<>(); - - var t = new HashMap() {{ - put("op", "add"); - put("path", "/fields/System.Title"); - put("from", null); - put("value", title); - }}; - - var d = new HashMap() {{ - put("op", "add"); - put("path", "/fields/System.Description"); - put("from", null); - put("value", description); - }}; - - req.add(t); - req.add(d); - - for (var key : additionalFields.keySet()) { - var i = new HashMap() {{ - put("op", "add"); - put("path", "/fields/" + key); - put("from", null); - put("value", additionalFields.get(key)); - }}; - - req.add(i); - } - - String r = send(RequestMethod.POST, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", null, "$" + encodeSpace(workItemType), ApiVersion.WORK_ITEM_TRACKING, - null, req, CustomHeader.JSON_PATCH); - - return MAPPER.mapJsonResponse(r, WorkItem.class); - } - - /** - * Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. - * - * @param id ID of the work item to be deleted - * @return {@link WorkItemDelete} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItemDelete deleteWorkItem(int id) throws AzDException { - String r = send(RequestMethod.DELETE, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", String.valueOf(id), null, ApiVersion.WORK_ITEM_TRACKING, null, null, null); - - return MAPPER.mapJsonResponse(r, WorkItemDelete.class); - } - - /** - * Deletes the specified work item permanently if the destroy parameter has been set to true, - * WARNING: If the destroy parameter is set to true, work items deleted by this command will - * NOT go to recycle-bin and there is no way to restore/recover them after deletion. - * It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution. - * - * @param id ID of the work item to be deleted - * @param destroy Optional parameter, if set to true, the work item is deleted permanently. - * Please note: the destroy action is PERMANENT and cannot be undone. - * @throws AzDException Default Api Exception handler. - */ - @Override - public Void deleteWorkItem(int id, boolean destroy) throws AzDException { - try { - var q = new HashMap() {{ - put("destroy", destroy); - }}; - - String r = send(RequestMethod.DELETE, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", String.valueOf(id), null, ApiVersion.WORK_ITEM_TRACKING, q, null, null); - - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Returns a single work item. - * - * @param id The work item id - * @return WorkItem {@link WorkItem} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItem getWorkItem(int id) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", Integer.toString(id), null, ApiVersion.WORK_ITEM_TRACKING, null, null, null); - - return MAPPER.mapJsonResponse(r, WorkItem.class); - } - - /** - * Returns a single work item. - * - * @param id The work item id - * @param expand The expand parameters for work item attributes. - * Possible options are { None, Relations, Fields, Links, All }. {@link WorkItemExpand} - * @return WorkItem {@link WorkItem} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItem getWorkItem(int id, WorkItemExpand expand) throws AzDException { - var q = new HashMap() {{ - put("$expand", expand.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", Integer.toString(id), null, ApiVersion.WORK_ITEM_TRACKING, q, null, null); - - return MAPPER.mapJsonResponse(r, WorkItem.class); - } - - /** - * Returns a single work item. - * - * @param id The work item id - * @param expand The expand parameters for work item attributes. - * Possible options are { None, Relations, Fields, Links, All }. {@link WorkItemExpand} - * @param asOf AsOf UTC date time string - * @return WorkItem {@link WorkItem} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItem getWorkItem(int id, WorkItemExpand expand, String asOf) throws AzDException { - var q = new HashMap() {{ - put("asOf", asOf); - put("$expand", expand.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", Integer.toString(id), null, ApiVersion.WORK_ITEM_TRACKING, q, null, null); - - return MAPPER.mapJsonResponse(r, WorkItem.class); - } - - /** - * Returns a single work item. - * - * @param id The work item id - * @param expand The expand parameters for work item attributes. - * Possible options are { None, Relations, Fields, Links, All }. {@link WorkItemExpand} - * @param fields Comma-separated list of requested fields - * @return WorkItem {@link WorkItem} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItem getWorkItem(int id, WorkItemExpand expand, String[] fields) throws AzDException { - var q = new HashMap() {{ - put("fields", String.join(",", fields)); - put("$expand", expand.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", Integer.toString(id), null, ApiVersion.WORK_ITEM_TRACKING, q, null, null); - - return MAPPER.mapJsonResponse(r, WorkItem.class); - } - - /** - * Returns a single work item. - * - * @param id The work item id - * @param expand The expand parameters for work item attributes. - * Possible options are { None, Relations, Fields, Links, All }. {@link WorkItemExpand} - * @param fields Comma-separated list of requested fields - * @param asOf AsOf UTC date time string - * @return WorkItem {@link WorkItem} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItem getWorkItem(int id, WorkItemExpand expand, String[] fields, String asOf) throws AzDException { - var q = new HashMap() {{ - put("fields", String.join(",", fields)); - put("asOf", asOf); - put("$expand", expand.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", Integer.toString(id), null, ApiVersion.WORK_ITEM_TRACKING, q, null, null); - - return MAPPER.mapJsonResponse(r, WorkItem.class); - } - - /** - * Returns a list of work items (Maximum 200) - * - * @param ids Integer array of requested work item ids. (Maximum 200 ids allowed). - * @return {@link WorkItemList} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItemList getWorkItems(int[] ids) throws AzDException { - var q = new HashMap() {{ - put("ids", intArrayToString(ids)); - }}; - - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", null, null, ApiVersion.WORK_ITEM_TRACKING, q, null, null); - - return MAPPER.mapJsonResponse(r, WorkItemList.class); - } - - /** - * Returns a list of work items (Maximum 200) - * - * @param ids Integer array of requested work item ids. (Maximum 200 ids allowed). - * @param expand The expand parameters for work item attributes. - * Possible options are { None, Relations, Fields, Links, All }. {@link WorkItemExpand} - * @return {@link WorkItemList} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItemList getWorkItems(int[] ids, WorkItemExpand expand) throws AzDException { - var q = new HashMap() {{ - put("ids", intArrayToString(ids)); - put("$expand", expand.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", null, null, ApiVersion.WORK_ITEM_TRACKING, q, null, null); - - return MAPPER.mapJsonResponse(r, WorkItemList.class); - } - - /** - * Returns a list of work items (Maximum 200) - * - * @param ids Integer array of requested work item ids. (Maximum 200 ids allowed). - * @param expand The expand parameters for work item attributes. - * Possible options are { None, Relations, Fields, Links, All }. {@link WorkItemExpand} - * @param asOf AsOf UTC date time string - * @return {@link WorkItemList} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItemList getWorkItems(int[] ids, WorkItemExpand expand, String asOf) throws AzDException { - var q = new HashMap() {{ - put("ids", intArrayToString(ids)); - put("$expand", expand.toString().toLowerCase()); - put("fields", asOf); - }}; - - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", null, null, ApiVersion.WORK_ITEM_TRACKING, q, null, null); - - return MAPPER.mapJsonResponse(r, WorkItemList.class); - } - - /** - * Returns a list of work items (Maximum 200) - * - * @param ids Integer array of requested work item ids. (Maximum 200 ids allowed). - * @param expand The expand parameters for work item attributes. - * Possible options are { None, Relations, Fields, Links, All }. {@link WorkItemExpand} - * @param fields Comma-separated list of requested fields - * @return {@link WorkItemList} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItemList getWorkItems(int[] ids, WorkItemExpand expand, String[] fields) throws AzDException { - var q = new HashMap() {{ - put("ids", intArrayToString(ids)); - put("$expand", expand.toString().toLowerCase()); - put("fields", String.join(",", fields)); - }}; - - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", null, null, ApiVersion.WORK_ITEM_TRACKING, q, null, null); - - return MAPPER.mapJsonResponse(r, WorkItemList.class); - } - - /** - * Returns a list of work items (Maximum 200) - * - * @param ids Integer array of requested work item ids. (Maximum 200 ids allowed). - * @param expand The expand parameters for work item attributes. - * Possible options are { None, Relations, Fields, Links, All }. {@link WorkItemExpand} - * @param fields Comma-separated list of requested fields - * @param asOf AsOf UTC date time string - * @param errorPolicy The flag to control error policy in a bulk get work items request. - * Possible options are {Fail, Omit}. {@link WorkItemErrorPolicy} - * @return {@link WorkItemList} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItemList getWorkItems(int[] ids, WorkItemExpand expand, String[] fields, String asOf, WorkItemErrorPolicy errorPolicy) - throws AzDException { - var q = new HashMap() {{ - put("ids", intArrayToString(ids)); - put("$expand", expand.toString().toLowerCase()); - put("asOf", asOf); - put("fields", String.join(",", fields)); - put("errorPolicy", errorPolicy.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", null, null, ApiVersion.WORK_ITEM_TRACKING, q, null, null); - - return MAPPER.mapJsonResponse(r, WorkItemList.class); - } - - /** - * Returns the list of fully hydrated work item revisions. - * - * @param workItemId The id of the work item - * @return {@link WorkItemList} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItemList getWorkItemRevisions(int workItemId) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", Integer.toString(workItemId), "revisions", ApiVersion.WORK_ITEM_TRACKING, null, null, null); - - return MAPPER.mapJsonResponse(r, WorkItemList.class); - } - - /** - * Returns the list of fully hydrated work item revisions. - * - * @param workItemId The id of the work item - * @param expand The expand parameters for work item attributes. - * Possible options are { None, Relations, Fields, Links, All }. {@link WorkItemExpand} - * @return {@link WorkItemList} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItemList getWorkItemRevisions(int workItemId, WorkItemExpand expand) throws AzDException { - var q = new HashMap() {{ - put("$expand", expand.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", Integer.toString(workItemId), "revisions", ApiVersion.WORK_ITEM_TRACKING, q, null, null); - - return MAPPER.mapJsonResponse(r, WorkItemList.class); - } - - /** - * Returns the list of fully hydrated work item revisions, paged. - * - * @param workItemId The id of the work item - * @param expand The expand parameters for work item attributes. - * Possible options are { None, Relations, Fields, Links, All }. {@link WorkItemExpand} - * @param top Specify top pages to list - * @param skip Specify to skip pages - * @return {@link WorkItemList} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItemList getWorkItemRevisions(int workItemId, WorkItemExpand expand, int top, int skip) throws AzDException { - var q = new HashMap() {{ - put("$expand", expand.toString().toLowerCase()); - put("$top", top); - put("$skip", skip); - }}; - - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", Integer.toString(workItemId), "revisions", ApiVersion.WORK_ITEM_TRACKING, q, null, null); - - return MAPPER.mapJsonResponse(r, WorkItemList.class); - } - - /** - * Returns a fully hydrated work item for the requested revision - * - * @param workItemId The id of the work item - * @param revisionNumber The work item revision number - * @return {@link WorkItem} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItem getWorkItemRevision(int workItemId, int revisionNumber) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", Integer.toString(workItemId), "revisions/" + revisionNumber, - ApiVersion.WORK_ITEM_TRACKING, null, null, null); - - return MAPPER.mapJsonResponse(r, WorkItem.class); - } - - /** - * Returns a fully hydrated work item for the requested revision - * - * @param workItemId The id of the work item - * @param revisionNumber The work item revision number - * @param expand The expand parameters for work item attributes. - * Possible options are { None, Relations, Fields, Links, All }. {@link WorkItemExpand} - * @return {@link WorkItem} - * @throws AzDException Default Api Exception handler. - */ - @Override - public WorkItem getWorkItemRevision(int workItemId, int revisionNumber, WorkItemExpand expand) throws AzDException { - var q = new HashMap() {{ - put("$expand", expand.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/workitems", Integer.toString(workItemId), "revisions/" + revisionNumber, - ApiVersion.WORK_ITEM_TRACKING, q, null, null); - - return MAPPER.mapJsonResponse(r, WorkItem.class); - } - - /** - * Gets the results of the query given its WIQL. - * - * @param team Team ID or team name - * @param query Specify the query to list the work items. E.g., "Select * From WorkItems Where [System.WorkItemType] = 'User Story'" - * @return WorkItemQueryResult {@link WorkItemQueryResult} - * @throws AzDException Handles errors from REST API and validates passed arguments - */ - @Override - public WorkItemQueryResult queryByWiql(String team, String query) throws AzDException { - var body = new HashMap() {{ - put("query", query); - }}; - - String r = send(RequestMethod.POST, CONNECTION, WIT, CONNECTION.getProject() + "/" + encodeSpace(team), - AREA, null, "wiql", ApiVersion.WIT_WIQL, null, body, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, WorkItemQueryResult.class); - } - - /** - * Gets the results of the query given its WIQL. - * - * @param team Team ID or team name - * @param query Specify the query to list the work items. E.g., "Select * From WorkItems Where [System.WorkItemType] = 'User Story'" - * @param top The max number of results to return. - * @param timePrecision The max number of results to return. - * @return WorkItemQueryResult {@link WorkItemQueryResult} - * @throws AzDException Handles errors from REST API and validates passed arguments - */ - @Override - public WorkItemQueryResult queryByWiql(String team, String query, int top, boolean timePrecision) throws AzDException { - var body = new HashMap() {{ - put("query", query); - }}; - - var q = new HashMap() {{ - put("$top", top); - put("timePrecision", timePrecision); - }}; - - String r = send(RequestMethod.POST, CONNECTION, WIT, CONNECTION.getProject() + "/" + encodeSpace(team), - AREA, null, "wiql", ApiVersion.WIT_WIQL, q, body, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(r, WorkItemQueryResult.class); - } - - /** - * Destroys the specified work item permanently from the Recycle Bin. This action can not be undone. - * - * @param id ID of the work item to be destroyed permanently - * @throws AzDException Handles errors from REST API and validates passed arguments - */ - @Override - public Void removeWorkItemFromRecycleBin(int id) throws AzDException { - try { - String r = send(RequestMethod.DELETE, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/recyclebin", Integer.toString(id), null, ApiVersion.WIT_RECYCLE_BIN, null, null, null); - if (!r.isEmpty()) MAPPER.mapJsonResponse(r, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Gets a deleted work item from Recycle Bin. - * - * @param id ID of the work item to be returned - * @return WorkItemDeleteReference {@link WorkItemDeleteReference} - * @throws AzDException Handles errors from REST API and validates passed arguments - */ - @Override - public WorkItemDeleteReference getWorkItemFromRecycleBin(int id) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/recyclebin", Integer.toString(id), null, ApiVersion.WIT_RECYCLE_BIN, null, null, null); - - return MAPPER.mapJsonResponse(r, WorkItemDeleteReference.class); - } - - /** - * Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin. - * - * @return WorkItemDeleteShallowReferences {@link WorkItemDeleteShallowReferences} - * @throws AzDException Handles errors from REST API and validates passed arguments - */ - @Override - public WorkItemDeleteShallowReferences getDeletedWorkItemsFromRecycleBin() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/recyclebin", null, null, ApiVersion.WIT_RECYCLE_BIN, null, null, null); - - return MAPPER.mapJsonResponse(r, WorkItemDeleteShallowReferences.class); - } - - /** - * Gets the work items from the recycle bin, whose IDs have been specified in the parameters - * - * @param ids array of workitem ids - * @return WorkItemDeleteReferences {@link WorkItemDeleteReferences} - * @throws AzDException Handles errors from REST API and validates passed arguments - */ - @Override - public WorkItemDeleteReferences getDeletedWorkItemsFromRecycleBin(int[] ids) throws AzDException { - var q = new HashMap() {{ - put("ids", intArrayToString(ids)); - }}; - - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/recyclebin", null, null, ApiVersion.WIT_RECYCLE_BIN, q, null, null); - - return MAPPER.mapJsonResponse(r, WorkItemDeleteReferences.class); - } - - /** - * Restores the deleted work item from Recycle Bin. - * - * @param id ID of the work item to be restored - * @return WorkItemDeleteReference {@link WorkItemDeleteReference} - * @throws AzDException Handles errors from REST API and validates passed arguments - */ - @Override - public WorkItemDeleteReference restoreWorkItemFromRecycleBin(int id) throws AzDException { - var b = new HashMap() {{ - put("isDeleted", false); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, WIT, CONNECTION.getProject(), - AREA + "/recyclebin", Integer.toString(id), null, ApiVersion.WIT_RECYCLE_BIN, null, b, null); - - return MAPPER.mapJsonResponse(r, WorkItemDeleteReference.class); - } - - /** - * Update a single work item with the internal field names. - * - * @param workItemId The id of the work item to update - * @param fieldsToUpdate HashMap of internal field names to update. E.g., System.Title, System.Description etc and it's associated values. - * @return The updated {@link WorkItem}. - * @throws AzDException Handles errors from REST API and validates passed arguments. - */ - @Override - public WorkItem updateWorkItem(int workItemId, Map fieldsToUpdate) - throws AzDException { - return updateWorkItem(workItemId, fieldsToUpdate, WorkItemOperation.ADD); - } - - /** - * Update a single work item with the internal field names. - * - * @param workItemId The id of the work item to update - * @param fieldsToUpdate HashMap of internal field names to update. E.g., System.Title, System.Description etc and it's associated values. - * @param operation The {@link WorkItemOperation}. - * @return WorkItem {@link WorkItem} - * @throws AzDException Handles errors from REST API and validates passed arguments. - */ - @Override - public WorkItem updateWorkItem(int workItemId, Map fieldsToUpdate, WorkItemOperation operation) - throws AzDException { - - var req = new ArrayList<>(); - - for (var key : fieldsToUpdate.keySet()) { - var i = new HashMap() {{ - put("op", operation.name().toLowerCase()); - put("path", "/fields/" + key); - put("from", null); - if (operation != WorkItemOperation.REMOVE) { - put("value", fieldsToUpdate.get(key)); - } - }}; - req.add(i); - } - - String r = send(RequestMethod.PATCH, CONNECTION, WIT, CONNECTION.getProject(), AREA + "/workitems", - Integer.toString(workItemId), null, ApiVersion.WORK_ITEM_TRACKING, null, req, - CustomHeader.JSON_PATCH); - - return MAPPER.mapJsonResponse(r, WorkItem.class); - } - - /** - * Update a single work item with the internal field names. The operation type that will be used is {@link WorkItemOperation#ADD}. - * - * @param workItemId The id of the work item to update - * @param expand The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }. {@link WorkItemExpand} - * @param bypassRules Do not enforce the work item type rules on this update - * @param suppressNotifications Do not fire any notifications for this change - * @param validateOnly Indicate if you only want to validate the changes without saving the work item - * @param fieldsToUpdate HashMap of internal field names to update. E.g., System.Title, System.Description etc and it's associated values. - * @return WorkItemDeleteReference {@link WorkItemDeleteReference} - * @throws AzDException Handles errors from REST API and validates passed arguments. - */ - @Override - public WorkItem updateWorkItem(int workItemId, WorkItemExpand expand, boolean bypassRules, - boolean suppressNotifications, boolean validateOnly, Map fieldsToUpdate) - throws AzDException { - - return updateWorkItem(workItemId, expand, bypassRules, suppressNotifications, validateOnly, fieldsToUpdate, - WorkItemOperation.ADD); - } - - /** - * Update a single work item with the internal field names. - * - * @param workItemId The id of the work item to update - * @param expand The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }. {@link WorkItemExpand} - * @param bypassRules Do not enforce the work item type rules on this update - * @param suppressNotifications Do not fire any notifications for this change - * @param validateOnly Indicate if you only want to validate the changes without saving the work item - * @param fieldsToUpdate HashMap of internal field names to update. E.g., System.Title, System.Description etc and it's associated values. - * @param operation The {@link WorkItemOperation}. - * @return WorkItem {@link WorkItem} - * @throws AzDException Handles errors from REST API and validates passed arguments. - */ - @Override - public WorkItem updateWorkItem(int workItemId, WorkItemExpand expand, boolean bypassRules, - boolean suppressNotifications, boolean validateOnly, Map fieldsToUpdate, - WorkItemOperation operation) throws AzDException { - - var req = new ArrayList<>(); - - for (var key : fieldsToUpdate.keySet()) { - var i = new HashMap() {{ - put("op", operation.name().toLowerCase()); - put("path", "/fields/" + key); - put("from", null); - if (operation != WorkItemOperation.REMOVE) { - put("value", fieldsToUpdate.get(key)); - } - }}; - req.add(i); - } - - var q = new HashMap() {{ - put("validateOnly", validateOnly); - put("bypassRules", bypassRules); - put("suppressNotifications", suppressNotifications); - put("$expand", expand.toString().toLowerCase()); - }}; - - String r = send(RequestMethod.PATCH, CONNECTION, WIT, CONNECTION.getProject(), AREA + "/workitems", - Integer.toString(workItemId), null, ApiVersion.WORK_ITEM_TRACKING, q, req, - CustomHeader.JSON_PATCH); - - return MAPPER.mapJsonResponse(r, WorkItem.class); - } - - /** - * Create hyperlinks for the given work item. - * - * @param workItemId The work item's ID. - * @param hyperlinksMap A {@link Map} that each entry represents a hyperlink. The key is the hyperlink URL and - * the value is its comment. If a comment is not desired then the value can either be null (if its supported by the map) or an empty string. - * @return The updated {@link WorkItem}. - * @throws AzDException Handles errors from REST API and validates passed arguments. - */ - @Override - public WorkItem addHyperLinks(int workItemId, Map hyperlinksMap) - throws AzDException { - - List reqBody = new ArrayList<>(); - - for (Entry hyperlinkEntry : hyperlinksMap.entrySet()) { - String url = hyperlinkEntry.getKey(); - String comment = hyperlinkEntry.getValue(); - - Map attributesMap = null; - if (comment != null && !comment.isEmpty()) { - attributesMap = new HashMap<>(); - attributesMap.put("comment", comment); - } - - Map hyperlinkMap = new HashMap<>(); - hyperlinkMap.put("rel", "Hyperlink"); - hyperlinkMap.put("url", url); - if (attributesMap != null) { - hyperlinkMap.put("attributes", attributesMap); - } - - Map reqBodyMap = new HashMap<>(); - reqBodyMap.put("op", WorkItemOperation.ADD.name().toLowerCase()); - reqBodyMap.put("path", "/relations/-"); - reqBodyMap.put("value", hyperlinkMap); - - reqBody.add(reqBodyMap); - } - - String reply = send(RequestMethod.PATCH, CONNECTION, WIT, CONNECTION.getProject(), AREA + "/workitems", - Integer.toString(workItemId), null, ApiVersion.WORK_ITEM_TRACKING, null, reqBody, - CustomHeader.JSON_PATCH); - - return MAPPER.mapJsonResponse(reply, WorkItem.class); - } - - /** - * Remove hyperlinks for the given work item. - *

- * Note: All hyperlinks must exist in order to be removed. Even if one doesn't then an {@link AzDException} is thrown. - *

- * - * @param workItemId The work item's ID. - * @param urls A {@link List} with the URL of the hyperlinks. - * @return The updated {@link WorkItem}. - * @throws AzDException Handles errors from REST API and validates passed arguments. - */ - @Override - public WorkItem removeHyperLinks(int workItemId, List urls) throws AzDException { - - List reqBody = new ArrayList<>(); - - List relations = getWorkItem(workItemId, WorkItemExpand.RELATIONS).getRelations(); - - for (String url : urls) { - int hyperlinkRelationNumber = -1; - for (int i = 0; i < relations.size(); i++) { - WorkItemRelations workItemRelations = relations.get(i); - if (!workItemRelations.getRel().equals("Hyperlink")) { - continue; - } - if (workItemRelations.getUrl().equals(url)) { - hyperlinkRelationNumber = i; - break; - } - } - - if (hyperlinkRelationNumber == -1) { - throw new AzDException(MessageFormat.format( - "Unable to remove hyperlink ''{0}'' from work item with ID ''{1}'': The hyperlink doesn't exist.", - url, hyperlinkRelationNumber)); - } - - Map reqBodyMap = new HashMap<>(); - reqBodyMap.put("op", WorkItemOperation.REMOVE.name().toLowerCase()); - reqBodyMap.put("path", "/relations/" + hyperlinkRelationNumber); - - reqBody.add(reqBodyMap); - } - - String reply = send(RequestMethod.PATCH, CONNECTION, WIT, CONNECTION.getProject(), AREA + "/workitems", - Integer.toString(workItemId), null, ApiVersion.WORK_ITEM_TRACKING, null, reqBody, - CustomHeader.JSON_PATCH); - - return MAPPER.mapJsonResponse(reply, WorkItem.class); - } - - /** - * Returns the list of work item types - * - * @return list of Work Item type {@link WorkItemTypes} - * @throws AzDException Handles errors from REST API and validates passed arguments - */ - @Override - public WorkItemTypes getWorkItemTypes() throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), AREA, null, "workitemtypes", - ApiVersion.WORK_ITEM_TYPES, null, null, null); - - return MAPPER.mapJsonResponse(r, WorkItemTypes.class); - } - - /** - * Returns a work item type definition. - * - * @param workItemTypeName provide the work item type name. e.g., Bug or user story etc. - * @return work item type {@link WorkItemType} - * @throws AzDException Handles errors from REST API and validates passed arguments - */ - @Override - public WorkItemType getWorkItemType(String workItemTypeName) throws AzDException { - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), AREA, null, - "workitemtypes/" + workItemTypeName, ApiVersion.WORK_ITEM_TYPES, null, null, null); - - return MAPPER.mapJsonResponse(r, WorkItemType.class); - } - - /** - * @deprecated This method is deprecated as of version 5.0.0. Please use createAttachment() - * with content stream for working with work item attachment API. - */ - @Override - @Deprecated - public AttachmentReference createAttachment(String fileName, AttachmentUploadType uploadType, - String teamAreaPath, String contents) throws AzDException { - var q = new HashMap() {{ - put("fileName", fileName); - put("uploadType", uploadType.toString().toLowerCase()); - put("areaPath", teamAreaPath); - - }}; - - String r = send(RequestMethod.POST, CONNECTION, WIT, CONNECTION.getProject(), AREA, null, - "attachments", ApiVersion.WORK_ITEM_ATTACHMENT, q, contents, CustomHeader.STREAM); - - return MAPPER.mapJsonResponse(r, AttachmentReference.class); - } - - /** - * Uploads an attachment. - * - * @param fileName The name of the file - * @param uploadType Attachment upload type: Simple or Chunked. {@link AttachmentUploadType} - * @param teamAreaPath Target project Area Path - * @param contentStream Stream to upload. Payload to create the attachment. - * @return AttachmentReference {@link AttachmentReference} - * @throws AzDException Handles errors from REST API and validates passed arguments - */ - @Override - public AttachmentReference createAttachment(String fileName, AttachmentUploadType uploadType, - String teamAreaPath, InputStream contentStream) throws AzDException { - var q = new HashMap() {{ - put("fileName", fileName); - put("uploadType", uploadType.toString().toLowerCase()); - put("areaPath", teamAreaPath); - - }}; - - var response = send(RequestMethod.POST, CONNECTION, WIT, CONNECTION.getProject(), AREA, null, - "attachments", ApiVersion.WORK_ITEM_ATTACHMENT, q, contentStream, CustomHeader.STREAM, false); - - String r = StreamHelper.convertToString(response); - - return MAPPER.mapJsonResponse(r, AttachmentReference.class); - } - - /** - * Downloads an attachment. - * - * @param id Attachment ID - * @param fileName Name of the file - * @param download If set to true always download attachment - * @return Stream of the attachment content. Use {@link StreamHelper} to download the attachment contents to a file. - * @throws AzDException Handles errors from REST API and validates passed arguments - */ - @Override - public InputStream getAttachmentContent(String id, String fileName, boolean download) throws AzDException { - var q = new HashMap() {{ - put("fileName", fileName); - put("download", download); - }}; - - return send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), AREA + "/attachments", id, - null, ApiVersion.WORK_ITEM_ATTACHMENT, q, null, CustomHeader.STREAM, false); - } - - /** - * Downloads an attachment as a zip file. - * - * @param id Attachment ID - * @param fileName Name of the file - * @param download If set to true always download attachment - * @return Stream of the attachment content. Use {@link StreamHelper} to download the attachment contents to a file. - * @throws AzDException Handles errors from REST API and validates passed arguments - */ - @Override - public InputStream getAttachmentAsZip(String id, String fileName, boolean download) throws AzDException { - var q = new HashMap() {{ - put("fileName", fileName); - put("download", download); - }}; - - return send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), AREA + "/attachments", id, - null, ApiVersion.WORK_ITEM_ATTACHMENT, q, null, CustomHeader.STREAM_ZIP, false); - } - - /** - * @deprecated This method is deprecated as of version 5.0.0. Please use getAttachmentContent() or getAttachmentAsZip() - * for working with work item attachment API. - */ - @Override - @Deprecated - public String getAttachment(String id, String fileName) throws AzDException { - var q = new HashMap() {{ - put("fileName", fileName); - }}; - - String r = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), AREA + "/attachments", id, - null, ApiVersion.WORK_ITEM_ATTACHMENT, q, null, CustomHeader.JSON); - - return r; - } - - /** - * Add an attachment to a work item. Pass the url of the attachment and comments as a Map to add the attachment to work item. Note - * that the attachment should already be created using createAttachment method. - * - * @param workItemId Id of the work item. - * @param fieldsToUpdate Map of url and comments. - * {@code - * var attachments = new HashMap() {{ - * put("https://url/of/attachment", "This is a comment"); - * }}; - * } - * @return The work item object. WorkItem {@link WorkItem} - * @throws AzDException Handles errors from REST API and validates passed arguments. - */ - @Override - public WorkItem addWorkItemAttachment(int workItemId, Map fieldsToUpdate) throws AzDException { - List reqBody = new ArrayList<>(); - - for (Entry entry : fieldsToUpdate.entrySet()) { - String url = entry.getKey(); - String comment = entry.getValue(); - - Map attributesMap = null; - if (comment != null && !comment.isEmpty()) { - attributesMap = new HashMap<>(); - attributesMap.put("comment", comment); - } - - Map attachment = new HashMap<>(); - attachment.put("rel", "AttachedFile"); - attachment.put("url", url); - if (attributesMap != null) { - attachment.put("attributes", attributesMap); - } - - Map reqBodyMap = new HashMap<>(); - reqBodyMap.put("op", WorkItemOperation.ADD.name().toLowerCase()); - reqBodyMap.put("path", "/relations/-"); - reqBodyMap.put("value", attachment); - - reqBody.add(reqBodyMap); - } - - String res = send(RequestMethod.PATCH, CONNECTION, WIT, CONNECTION.getProject(), AREA + "/workitems", - Integer.toString(workItemId), null, ApiVersion.WORK_ITEM_TRACKING, null, reqBody, - CustomHeader.JSON_PATCH); - - return MAPPER.mapJsonResponse(res, WorkItem.class); - } - - /** - * Removes the attachment from a work item. Pass the list of attachment url to be removed. - * - * @param workItemId ID of the work item. - * @param attachmentUrl List of attachment url. - * @return The work item object. WorkItem {@link WorkItem} - * @throws AzDException Handles errors from REST API and validates passed arguments. - */ - @Override - public WorkItem removeWorkItemAttachment(int workItemId, List attachmentUrl) throws AzDException { - if (attachmentUrl.size() == 0) { - throw new AzDException("The attachment url list cannot be null. Please validate the argument before passing"); - } - - List reqBody = new ArrayList<>(); - - var relations = getWorkItem(workItemId, WorkItemExpand.RELATIONS).getRelations(); - - for (String url : attachmentUrl) { - int attachmentRelationNumber = -1; - - for (int i = 0; i < relations.size(); i++) { - if (relations.get(i).getUrl().equals(url)) { - attachmentRelationNumber = i; - - Map reqBodyMap = new HashMap<>(); - reqBodyMap.put("op", WorkItemOperation.REMOVE.name().toLowerCase()); - reqBodyMap.put("path", "/relations/" + attachmentRelationNumber); - - reqBody.add(reqBodyMap); - } - } - - if (attachmentRelationNumber == -1) { - throw new AzDException(ApiExceptionTypes.InvalidArgumentException.name(), MessageFormat.format( - "Unable to remove the attachment ''{0}'' from work item with ID ''{1}'': The attachment doesn't exist.", - url, workItemId)); - } - } - - - String res = send(RequestMethod.PATCH, CONNECTION, WIT, CONNECTION.getProject(), AREA + "/workitems", - Integer.toString(workItemId), null, ApiVersion.WORK_ITEM_TRACKING, null, reqBody, - CustomHeader.JSON_PATCH); - - return MAPPER.mapJsonResponse(res, WorkItem.class); - } - - @Override - public AccountRecentActivityWorkItems getMyWorkRecentActivity() throws AzDException { - String res = send(RequestMethod.GET, CONNECTION, null, null, "work/accountmyworkrecentactivity", - null, null, ApiVersion.WORK_ITEM_TYPES, null, null, null); - - return MAPPER.mapJsonResponse(res, AccountRecentActivityWorkItems.class); - } - - /** - * Returns information for all fields. The project ID/name parameter is optional. - * - * @return WorkItemField Object {@link WorkItemFieldTypes} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WorkItemFieldTypes getWorkItemFields() throws AzDException { - String res = send(RequestMethod.GET, CONNECTION, null, null, AREA, - null, "fields", ApiVersion.WORK_ITEM_TYPES, null, null, null); - - return MAPPER.mapJsonResponse(res, WorkItemFieldTypes.class); - } - - /** - * Returns information for all fields. The project ID/name parameter is optional. - * - * @param expand Use ExtensionFields to include extension fields, otherwise exclude them. Unless the feature flag for this parameter is enabled, extension fields are always included. - * @return WorkItemFieldTypes Object {@link WorkItemFieldTypes} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WorkItemFieldTypes getWorkItemFields(GetFieldsExpand expand) throws AzDException { - var q = new HashMap() {{ - put("$expand", expand.name().toLowerCase()); - }}; - - String res = send(RequestMethod.GET, CONNECTION, null, null, AREA, - null, "fields", ApiVersion.WORK_ITEM_TYPES, q, null, null); - - return MAPPER.mapJsonResponse(res, WorkItemFieldTypes.class); - } - - /** - * Gets information on a specific field. - * - * @param fieldNameOrRefName Field simple name or reference name - * @return WorkItemField Object {@link WorkItemField} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WorkItemField getWorkItemField(String fieldNameOrRefName) throws AzDException { - String res = send(RequestMethod.GET, CONNECTION, null, null, AREA, - null, "fields/" + URLHelper.encodeSpecialWithSpace(fieldNameOrRefName), ApiVersion.WORK_ITEM_TYPES, null, null, null); - - return MAPPER.mapJsonResponse(res, WorkItemField.class); - } - - /** - * Create a new field. - * - * @param workItemField WorkItemField object to create a new work item - * @return WorkItemField Object {@link WorkItemField} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WorkItemField createWorkItemField(WorkItemField workItemField) throws AzDException { - String res = send(RequestMethod.POST, CONNECTION, null, null, AREA, - null, "fields", ApiVersion.WORK_ITEM_TYPES, null, workItemField, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(res, WorkItemField.class); - } - - /** - * Deletes the field. To undelete a filed, see "Update Field" API. - * - * @param fieldNameOrRefName Field simple name or reference name - * @throws AzDException Default Api Exception handler. - **/ - @Override - public Void deleteWorkItemField(String fieldNameOrRefName) throws AzDException { - try { - String res = send(RequestMethod.DELETE, CONNECTION, null, null, AREA, - null, "fields/" + URLHelper.encodeSpecialWithSpace(fieldNameOrRefName), ApiVersion.WORK_ITEM_TYPES, - null, null, null); - - if (!res.isEmpty()) MAPPER.mapJsonResponse(res, Map.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Update a field. - * - * @param fieldNameOrRefName Name/reference name of the field to be updated - * @return WorkItemField Object {@link WorkItemField} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public WorkItemField updateWorkItemField(String fieldNameOrRefName, boolean isDeleted) throws AzDException { - var b = new UpdateWorkItemField() {{ - setDeleted(isDeleted); - }}; - - String res = send(RequestMethod.PATCH, CONNECTION, null, null, AREA, - null, "fields/" + URLHelper.encodeSpecialWithSpace(fieldNameOrRefName), ApiVersion.WORK_ITEM_TYPES, null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(res, WorkItemField.class); - } - - /** - * Migrates a project to a different process within the same OOB type. - * For example, you can only migrate a project from agile/custom-agile to agile/custom-agile. - * - * @return ProcessMigrationResultModel Object {@link ProcessMigrationResultModel} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public ProcessMigrationResultModel migrateProjectProcess(String processId) throws AzDException { - var b = new ProcessIdModel() {{ - setTypeId(processId); - }}; - - String res = send(RequestMethod.POST, CONNECTION, WIT, CONNECTION.getProject(), AREA, - null, "projectprocessmigration", ApiVersion.WORK_ITEM_MIGRATE, null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(res, ProcessMigrationResultModel.class); - } - - /** - * Creates a query, or moves a query. - * - * @param queryHierarchyItem Query Hierarchy item object. - * @return QueryHierarchyItem Object {@link QueryHierarchyItem} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public QueryHierarchyItem createQuery(String query, QueryHierarchyItem queryHierarchyItem) throws AzDException { - var body = ModelBuilder.build(queryHierarchyItem, null); - - String res = send(RequestMethod.POST, CONNECTION, WIT, CONNECTION.getProject(), AREA, - null, "queries/" + URLHelper.encodeSpecialWithSpace(query), ApiVersion.WIT_WIQL, null, body, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(res, QueryHierarchyItem.class); - } - - /** - * Gets the root queries and their children - * - * @return A list of QueryHierarchyItem Object {@link QueryHierarchyItems} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public QueryHierarchyItems getQueries() throws AzDException { - String res = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), AREA, - null, "queries", ApiVersion.WIT_WIQL, null, null, null); - - return MAPPER.mapJsonResponse(res, QueryHierarchyItems.class); - } - - /** - * Gets the root queries and their children - * - * @param depth In the folder of queries, return child queries and folders to this depth. - * @param expand Include the query string (wiql), clauses, query result columns, and sort options in the results. - * @param includeDeleted Include deleted queries and folders - * @return A list of QueryHierarchyItem Object {@link QueryHierarchyItems} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public QueryHierarchyItems getQueries(int depth, QueryExpand expand, boolean includeDeleted) throws AzDException { - var q = new HashMap() {{ - put("$depth", depth); - put("$expand", expand.name().toLowerCase()); - put("$includeDeleted", includeDeleted); - }}; - - String res = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), AREA, - null, "queries", ApiVersion.WIT_WIQL, q, null, null); - - return MAPPER.mapJsonResponse(res, QueryHierarchyItems.class); - } - - /** - * Retrieves an individual query and its children - * - * @param query ID or path of the query. - * @return QueryHierarchyItem Object {@link QueryHierarchyItem} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public QueryHierarchyItem getQuery(String query) throws AzDException { - String res = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), AREA, - null, "queries/" + URLHelper.encodeSpecialWithSpace(query), ApiVersion.WIT_WIQL, null, null, null); - - return MAPPER.mapJsonResponse(res, QueryHierarchyItem.class); - } - - /** - * Retrieves an individual query and its children - * - * @param query ID or path of the query. - * @param depth In the folder of queries, return child queries and folders to this depth. - * @param expand Include the query string (wiql), clauses, query result columns, and sort options in the results. - * @param includeDeleted Include deleted queries and folders - * @param useIsoDateFormat DateTime query clauses will be formatted using a ISO 8601 compliant format - * @return QueryHierarchyItem Object {@link QueryHierarchyItem} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public QueryHierarchyItem getQuery(String query, int depth, QueryExpand expand, boolean includeDeleted, boolean useIsoDateFormat) throws AzDException { - var q = new HashMap() {{ - put("$depth", depth); - put("$expand", expand.name().toLowerCase()); - put("$includeDeleted", includeDeleted); - put("$useIsoDateFormat", useIsoDateFormat); - }}; - - String res = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), AREA, - null, "queries/" + URLHelper.encodeSpecialWithSpace(query), ApiVersion.WIT_WIQL, q, null, null); - - return MAPPER.mapJsonResponse(res, QueryHierarchyItem.class); - } - - /** - * Delete a query or a folder. This deletes any permission change on the deleted query or folder and any of its - * descendants if it is a folder. It is important to note that the deleted permission changes cannot be - * recovered upon undeleting the query or folder. - * - * @param query ID or path of the query or folder to delete. - * @throws AzDException Default Api Exception handler. - **/ - @Override - public Void deleteQuery(String query) throws AzDException { - try { - String res = send(RequestMethod.DELETE, CONNECTION, WIT, CONNECTION.getProject(), AREA, - null, "queries/" + URLHelper.encodeSpecialWithSpace(query), ApiVersion.WIT_WIQL, null, null, null); - - if (!res.isEmpty()) MAPPER.mapJsonResponse(res, QueryHierarchyItem.class); - } catch (AzDException e) { - throw e; - } - return null; - } - - /** - * Gets a list of queries by ids (Maximum 1000) - * - * @param errorPolicy The flag to control error policy in a query batch request. Possible options are { Fail, Omit }. - * @param expand The expand parameters for queries. Possible options are { None, Wiql, Clauses, All, Minimal } - * @param ids The requested query ids - * @return QueryHierarchyItem Object {@link QueryHierarchyItem} - * @throws AzDException Default Api Exception handler. - **/ - @Override - public QueryHierarchyItems getQueryBatches(QueryErrorPolicy errorPolicy, QueryExpand expand, String[] ids) throws AzDException { - var b = new HashMap() {{ - put("errorPolicy", errorPolicy.name().toLowerCase()); - put("$expand", expand.name().toLowerCase()); - put("ids", ids); - }}; - - String res = send(RequestMethod.POST, CONNECTION, WIT, CONNECTION.getProject(), AREA, - null, "queriesbatch", ApiVersion.WIT_QUERY_BATCH, null, b, CustomHeader.JSON_CONTENT_TYPE); - - return MAPPER.mapJsonResponse(res, QueryHierarchyItems.class); - } - - @Override - public QueryHierarchyItemsResult searchQuery(String filter) throws AzDException { - var q = new HashMap() {{ - put("$filter", filter); - }}; - - String res = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), AREA, - null, "queries", ApiVersion.WIT_WIQL, q, null, null); - - return MAPPER.mapJsonResponse(res, QueryHierarchyItemsResult.class); - } - - @Override - public QueryHierarchyItemsResult searchQuery(String filter, QueryExpand expand, boolean includeDeleted, int top) throws AzDException { - var q = new HashMap() {{ - put("$filter", filter); - put("$includeDeleted", includeDeleted); - put("$top", top); - }}; - - String res = send(RequestMethod.GET, CONNECTION, WIT, CONNECTION.getProject(), AREA, - null, "queries", ApiVersion.WIT_WIQL, q, null, null); - - return MAPPER.mapJsonResponse(res, QueryHierarchyItemsResult.class); - } - - /** - * Helper method to convert integer array to string. - * - * @param i integer array - * @return {@link String} - */ - private String intArrayToString(int[] i) { - var r = Arrays.stream(i).mapToObj(String::valueOf).toArray(String[]::new); - return String.join(",", r); - } -} \ No newline at end of file diff --git a/azd/src/main/java/org/azd/workitemtracking/WorkItemTrackingRequestBuilder.java b/azd/src/main/java/org/azd/workitemtracking/WorkItemTrackingRequestBuilder.java index cc6f5419..0a54147b 100644 --- a/azd/src/main/java/org/azd/workitemtracking/WorkItemTrackingRequestBuilder.java +++ b/azd/src/main/java/org/azd/workitemtracking/WorkItemTrackingRequestBuilder.java @@ -4,6 +4,7 @@ import org.azd.authentication.AccessTokenCredential; import org.azd.workitemtracking.attachments.WorkItemTrackingAttachmentsRequestBuilder; import org.azd.workitemtracking.classificationnodes.ClassificationNodesRequestBuilder; +import org.azd.workitemtracking.comments.CommentsRequestBuilder; import org.azd.workitemtracking.fields.FieldsRequestBuilder; import org.azd.workitemtracking.projectprocessmigration.ProjectProcessMigrationBuilder; import org.azd.workitemtracking.queries.QueriesRequestBuilder; @@ -56,6 +57,15 @@ public ClassificationNodesRequestBuilder classificationNodes() { return new ClassificationNodesRequestBuilder(organizationUrl, accessTokenCredential); } + /** + * Provides functionality to work with Work item comments Api. + * + * @return CommentsRequestBuilder {@link CommentsRequestBuilder} + */ + public CommentsRequestBuilder comments() { + return new CommentsRequestBuilder(organizationUrl, accessTokenCredential); + } + /** * Provides functionality to work with Work item fields Api. * diff --git a/azd/src/main/java/org/azd/workitemtracking/comments/CommentsRequestBuilder.java b/azd/src/main/java/org/azd/workitemtracking/comments/CommentsRequestBuilder.java new file mode 100644 index 00000000..6acf6dcc --- /dev/null +++ b/azd/src/main/java/org/azd/workitemtracking/comments/CommentsRequestBuilder.java @@ -0,0 +1,429 @@ +package org.azd.workitemtracking.comments; + +import org.azd.abstractions.BaseRequestBuilder; +import org.azd.abstractions.QueryParameter; +import org.azd.authentication.AccessTokenCredential; +import org.azd.common.ApiVersion; +import org.azd.enums.CommentExpandOptions; +import org.azd.enums.CommentFormat; +import org.azd.enums.CommentSortOrder; +import org.azd.exceptions.AzDException; +import org.azd.workitemtracking.types.Comment; +import org.azd.workitemtracking.types.CommentList; + +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.function.Consumer; + +public class CommentsRequestBuilder extends BaseRequestBuilder { + public CommentsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential) { + super(organizationUrl, accessTokenCredential, "wit", "608aac0a-32e1-4493-a863-b9cf4566d257", ApiVersion.WORK_ITEM_TRACKING_COMMENTS); + } + + /** + * Add a comment on a work item. + * @param comment Text of the comment. + * @param workItemId Id of a work item. + * @return Comment Object {@link Comment} + * @throws AzDException Default Api Exception handler. + **/ + public CompletableFuture addAsync(String comment, int workItemId) throws AzDException { + return builder() + .POST(Map.of("text", comment)) + .serviceEndpoint("workItemId", workItemId) + .build() + .executeAsync(Comment.class); + } + + /** + * Add a comment on a work item. + * @param comment Text of the comment. + * @param workItemId Id of a work item. + * @param format Format of a work item comment (Markdown or Html). + * @return Comment Object {@link Comment} + * @throws AzDException Default Api Exception handler. + **/ + public CompletableFuture addAsync(String comment, int workItemId, CommentFormat format) throws AzDException { + return builder() + .POST(Map.of("text", comment)) + .serviceEndpoint("workItemId", workItemId) + .query("format", format) + .build() + .executeAsync(Comment.class); + } + + /** + * Returns a work item comment. + * @param commentId Id of the comment. + * @param workItemId Id of a work item. + * @return Comment Object {@link Comment} + * @throws AzDException Default Api Exception handler. + **/ + public CompletableFuture getAsync(int commentId, int workItemId) throws AzDException { + return builder() + .serviceEndpoint("commentId", commentId) + .serviceEndpoint("workItemId", workItemId) + .build() + .executeAsync(Comment.class); + } + + /** + * Returns a work item comment. + * @param commentId Id of the comment. + * @param workItemId Id of a work item. + * @param requestConfiguration Represents the query parameters. + * @return Comment Object {@link Comment} + * @throws AzDException Default Api Exception handler. + **/ + public CompletableFuture getAsync(int commentId, int workItemId, + Consumer requestConfiguration) throws AzDException { + return builder() + .serviceEndpoint("commentId", commentId) + .serviceEndpoint("workItemId", workItemId) + .query(RequestConfiguration::new, requestConfiguration, q -> q.queryParameters) + .build() + .executeAsync(Comment.class); + } + + /** + * Returns a list of work item comments, pageable. + * @param workItemId Id of a work item. + * @return List of Comment Object {@link CommentList} + * @throws AzDException Default Api Exception handler. + **/ + public CompletableFuture listAsync(int workItemId) throws AzDException { + return builder() + .serviceEndpoint("workItemId", workItemId) + .build() + .executeAsync(CommentList.class); + } + + /** + * Returns a list of work item comments, pageable. + * @param workItemId Id of a work item. + * @param requestConfiguration Represents the query parameters. + * @return List of Comment Object {@link CommentList} + * @throws AzDException Default Api Exception handler. + **/ + public CompletableFuture listAsync(int workItemId, + Consumer requestConfiguration) throws AzDException { + return builder() + .serviceEndpoint("workItemId", workItemId) + .query(ListRequestConfiguration::new, requestConfiguration, q -> q.queryParameters) + .build() + .executeAsync(CommentList.class); + } + + /** + * Returns a list of work item comments by ids. + * @param workItemId Id of a work item. + * @param requestConfiguration Represents the query parameters. + * @return List of Comment Object {@link CommentList} + * @throws AzDException Default Api Exception handler. + **/ + public CompletableFuture listBatchAsync(int workItemId, + Consumer requestConfiguration) throws AzDException { + return builder() + .serviceEndpoint("workItemId", workItemId) + .query(ListBatchRequestConfiguration::new, requestConfiguration, q -> q.queryParameters) + .build() + .executeAsync(CommentList.class); + } + + /** + * Delete a comment on a work item. + * @param commentId Id of the comment. + * @param workItemId Id of a work item. + * @throws AzDException Default Api Exception handler. + **/ + public CompletableFuture deleteAsync(int commentId, int workItemId) throws AzDException { + return builder() + .DELETE() + .serviceEndpoint("commentId", commentId) + .serviceEndpoint("workItemId", workItemId) + .build() + .executePrimitiveAsync(); + } + + /** + * Update a comment on a work item. + * @param comment Text of the comment. + * @param workItemId Id of a work item. + * @return Comment Object {@link Comment} + * @throws AzDException Default Api Exception handler. + **/ + public CompletableFuture updateAsync(String comment, int workItemId) throws AzDException { + return builder() + .PATCH(Map.of("text", comment)) + .serviceEndpoint("workItemId", workItemId) + .build() + .executeAsync(Comment.class); + } + + /** + * Update a comment on a work item. + * @param comment Text of the comment. + * @param workItemId Id of a work item. + * @param format Format of a work item comment (Markdown or Html). + * @return Comment Object {@link Comment} + * @throws AzDException Default Api Exception handler. + **/ + public CompletableFuture updateAsync(String comment, int workItemId, CommentFormat format) throws AzDException { + return builder() + .PATCH(Map.of("text", comment)) + .serviceEndpoint("workItemId", workItemId) + .query("format", format) + .build() + .executeAsync(Comment.class); + } + + /** + * Add a comment on a work item. + * @param comment Text of the comment. + * @param workItemId Id of a work item. + * @return Comment Object {@link Comment} + * @throws AzDException Default Api Exception handler. + **/ + public Comment add(String comment, int workItemId) throws AzDException { + return builder() + .POST(Map.of("text", comment)) + .serviceEndpoint("workItemId", workItemId) + .build() + .execute(Comment.class); + } + + /** + * Add a comment on a work item. + * @param comment Text of the comment. + * @param workItemId Id of a work item. + * @param format Format of a work item comment (Markdown or Html). + * @return Comment Object {@link Comment} + * @throws AzDException Default Api Exception handler. + **/ + public Comment add(String comment, int workItemId, CommentFormat format) throws AzDException { + return builder() + .POST(Map.of("text", comment)) + .serviceEndpoint("workItemId", workItemId) + .query("format", format) + .build() + .execute(Comment.class); + } + + /** + * Returns a work item comment. + * @param commentId Id of the comment. + * @param workItemId Id of a work item. + * @return Comment Object {@link Comment} + * @throws AzDException Default Api Exception handler. + **/ + public Comment get(int commentId, int workItemId) throws AzDException { + return builder() + .serviceEndpoint("commentId", commentId) + .serviceEndpoint("workItemId", workItemId) + .build() + .execute(Comment.class); + } + + /** + * Returns a work item comment. + * @param commentId Id of the comment. + * @param workItemId Id of a work item. + * @param requestConfiguration Represents the query parameters. + * @return Comment Object {@link Comment} + * @throws AzDException Default Api Exception handler. + **/ + public Comment get(int commentId, int workItemId, + Consumer requestConfiguration) throws AzDException { + return builder() + .serviceEndpoint("commentId", commentId) + .serviceEndpoint("workItemId", workItemId) + .query(RequestConfiguration::new, requestConfiguration, q -> q.queryParameters) + .build() + .execute(Comment.class); + } + + /** + * Returns a list of work item comments, pageable. + * @param workItemId Id of a work item. + * @return List of Comment Object {@link CommentList} + * @throws AzDException Default Api Exception handler. + **/ + public CommentList list(int workItemId) throws AzDException { + return builder() + .serviceEndpoint("workItemId", workItemId) + .build() + .execute(CommentList.class); + } + + /** + * Returns a list of work item comments, pageable. + * @param workItemId Id of a work item. + * @param requestConfiguration Represents the query parameters. + * @return List of Comment Object {@link CommentList} + * @throws AzDException Default Api Exception handler. + **/ + public CommentList list(int workItemId, + Consumer requestConfiguration) throws AzDException { + return builder() + .serviceEndpoint("workItemId", workItemId) + .query(ListRequestConfiguration::new, requestConfiguration, q -> q.queryParameters) + .build() + .execute(CommentList.class); + } + + /** + * Returns a list of work item comments by ids. + * @param workItemId Id of a work item. + * @param requestConfiguration Represents the query parameters. + * @return List of Comment Object {@link CommentList} + * @throws AzDException Default Api Exception handler. + **/ + public CommentList listBatch(int workItemId, + Consumer requestConfiguration) throws AzDException { + return builder() + .serviceEndpoint("workItemId", workItemId) + .query(ListBatchRequestConfiguration::new, requestConfiguration, q -> q.queryParameters) + .build() + .execute(CommentList.class); + } + + /** + * Delete a comment on a work item. + * @param commentId Id of the comment. + * @param workItemId Id of a work item. + * @throws AzDException Default Api Exception handler. + **/ + public Void delete(int commentId, int workItemId) throws AzDException { + return builder() + .DELETE() + .serviceEndpoint("commentId", commentId) + .serviceEndpoint("workItemId", workItemId) + .build() + .executePrimitive(); + } + + /** + * Update a comment on a work item. + * @param comment Text of the comment. + * @param commentId Id of the comment. + * @param workItemId Id of a work item. + * @return Comment Object {@link Comment} + * @throws AzDException Default Api Exception handler. + **/ + public Comment update(String comment, int commentId, int workItemId) throws AzDException { + return builder() + .PATCH(Map.of("text", comment)) + .serviceEndpoint("commentId", commentId) + .serviceEndpoint("workItemId", workItemId) + .build() + .execute(Comment.class); + } + + /** + * Update a comment on a work item. + * @param comment Text of the comment. + * @param commentId Id of the comment. + * @param workItemId Id of a work item. + * @param format Format of a work item comment (Markdown or Html). + * @return Comment Object {@link Comment} + * @throws AzDException Default Api Exception handler. + **/ + public Comment update(String comment, int commentId, int workItemId, CommentFormat format) throws AzDException { + return builder() + .PATCH(Map.of("text", comment)) + .serviceEndpoint("commentId", commentId) + .serviceEndpoint("workItemId", workItemId) + .query("format", format) + .build() + .execute(Comment.class); + } + + /** + * Represents the query parameters. + */ + public static class GetQueryParameters { + /** + * Specifies the additional data retrieval options for work item comments. + */ + @QueryParameter(name = "$expand") + public CommentExpandOptions expand; + /** + * Specify if the deleted comment should be retrieved. + */ + @QueryParameter(name = "includeDeleted") + public Boolean includeDeleted; + } + + /** + * Request configuration object for the query parameters. + */ + public static class RequestConfiguration { + public GetQueryParameters queryParameters = new GetQueryParameters(); + } + + /** + * Represents the list query parameters. + */ + public static class ListQueryParameters { + /** + * Specifies the additional data retrieval options for work item comments. + */ + @QueryParameter(name = "$expand") + public CommentExpandOptions expand; + /** + * Max number of comments to return. + */ + @QueryParameter(name = "$top") + public Integer top; + /** + * Used to query for the next page of comments. + */ + @QueryParameter(name = "continuationToken") + public String continuationToken; + /** + * Order in which the comments should be returned. + */ + @QueryParameter(name = "order") + public CommentSortOrder order; + /** + * Specify if the deleted comment should be retrieved. + */ + @QueryParameter(name = "includeDeleted") + public Boolean includeDeleted; + } + + /** + * Request configuration object for the query parameters. + */ + public static class ListRequestConfiguration { + public ListQueryParameters queryParameters = new ListQueryParameters(); + } + + /** + * Represents the list query parameters. + */ + public static class ListBatchQueryParameters { + /** + * Specifies the additional data retrieval options for work item comments. + */ + @QueryParameter(name = "$expand") + public CommentExpandOptions expand; + /** + * Comma-separated list of comment ids to return. + */ + @QueryParameter(name = "ids") + public Integer[] ids; + /** + * Specify if the deleted comment should be retrieved. + */ + @QueryParameter(name = "includeDeleted") + public Boolean includeDeleted; + } + + /** + * Request configuration object for the query parameters. + */ + public static class ListBatchRequestConfiguration { + public ListBatchQueryParameters queryParameters = new ListBatchQueryParameters(); + } +} diff --git a/azd/src/main/java/org/azd/workitemtracking/types/Comment.java b/azd/src/main/java/org/azd/workitemtracking/types/Comment.java new file mode 100644 index 00000000..19f193e2 --- /dev/null +++ b/azd/src/main/java/org/azd/workitemtracking/types/Comment.java @@ -0,0 +1,177 @@ +package org.azd.workitemtracking.types; + +/* +---------------------------------------------------------- + GENERATED FILE, should be edited to suit the purpose. +---------------------------------------------------------- +*/ + + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonProperty; +import org.azd.abstractions.serializer.SerializableEntity; +import org.azd.common.types.Author; +import org.azd.enums.CommentFormat; + +import java.util.List; + + +/** + * Comment on a Work Item. +**/ +@JsonIgnoreProperties(ignoreUnknown = true) +public class Comment extends SerializableEntity { + /** + * Link references to related REST resources. + **/ + @JsonProperty("_links") + private Object _links; + /** + * org.azd.common.types.Author of the creator of the comment. + **/ + @JsonProperty("createdBy") + private Author createdBy; + /** + * The creation date of the comment. + **/ + @JsonProperty("createdDate") + private String createdDate; + /** + * Effective Date/time value for adding the comment. Can be optionally different from CreatedDate. + **/ + @JsonProperty("createdOnBehalfDate") + private String createdOnBehalfDate; + /** + * Identity on whose behalf this comment has been added. Can be optionally different from CreatedBy. + **/ + @JsonProperty("createdOnBehalfOf") + private Author createdOnBehalfOf; + /** + * Represents the possible types for the comment format. + **/ + @JsonProperty("format") + private CommentFormat format; + /** + * The id assigned to the comment. + **/ + @JsonProperty("id") + private int id; + /** + * Indicates if the comment has been deleted. + **/ + @JsonProperty("isDeleted") + private boolean isDeleted; + /** + * The mentions of the comment. + **/ + @JsonProperty("mentions") + private List mentions; + /** + * Author of the user who last modified the comment. + **/ + @JsonProperty("modifiedBy") + private Author modifiedBy; + /** + * The last modification date of the comment. + **/ + @JsonProperty("modifiedDate") + private String modifiedDate; + /** + * The reactions of the comment. + **/ + @JsonProperty("reactions") + private List reactions; + /** + * The text of the comment in HTML format. + **/ + @JsonProperty("renderedText") + private String renderedText; + /** + * The text of the comment. + **/ + @JsonProperty("text") + private String text; + /** + * REST URL for the resource. + **/ + @JsonProperty("url") + private String url; + /** + * The current version of the comment. + **/ + @JsonProperty("version") + private int version; + /** + * The id of the work item this comment belongs to. + **/ + @JsonProperty("workItemId") + private int workItemId; + + public Object get_links() { return _links; } + + public void set_links(Object _links) { this._links = _links; } + + public Author getCreatedBy() { return createdBy; } + + public void setCreatedBy(Author createdBy) { this.createdBy = createdBy; } + + public String getCreatedDate() { return createdDate; } + + public void setCreatedDate(String createdDate) { this.createdDate = createdDate; } + + public String getCreatedOnBehalfDate() { return createdOnBehalfDate; } + + public void setCreatedOnBehalfDate(String createdOnBehalfDate) { this.createdOnBehalfDate = createdOnBehalfDate; } + + public Author getCreatedOnBehalfOf() { return createdOnBehalfOf; } + + public void setCreatedOnBehalfOf(Author createdOnBehalfOf) { this.createdOnBehalfOf = createdOnBehalfOf; } + + public CommentFormat getFormat() { return format; } + + public void setFormat(CommentFormat format) { this.format = format; } + + public int getId() { return id; } + + public void setId(int id) { this.id = id; } + + public Boolean getIsDeleted() { return isDeleted; } + + public void setIsDeleted(Boolean isDeleted) { this.isDeleted = isDeleted; } + + public List getMentions() { return mentions; } + + public void setMentions(List mentions) { this.mentions = mentions; } + + public Author getModifiedBy() { return modifiedBy; } + + public void setModifiedBy(Author modifiedBy) { this.modifiedBy = modifiedBy; } + + public String getModifiedDate() { return modifiedDate; } + + public void setModifiedDate(String modifiedDate) { this.modifiedDate = modifiedDate; } + + public List getReactions() { return reactions; } + + public void setReactions(List reactions) { this.reactions = reactions; } + + public String getRenderedText() { return renderedText; } + + public void setRenderedText(String renderedText) { this.renderedText = renderedText; } + + public String getText() { return text; } + + public void setText(String text) { this.text = text; } + + public String getUrl() { return url; } + + public void setUrl(String url) { this.url = url; } + + public int getVersion() { return version; } + + public void setVersion(int version) { this.version = version; } + + public int getWorkItemId() { return workItemId; } + + public void setWorkItemId(int workItemId) { this.workItemId = workItemId; } +} diff --git a/azd/src/main/java/org/azd/workitemtracking/types/CommentCreate.java b/azd/src/main/java/org/azd/workitemtracking/types/CommentCreate.java new file mode 100644 index 00000000..7586d089 --- /dev/null +++ b/azd/src/main/java/org/azd/workitemtracking/types/CommentCreate.java @@ -0,0 +1,29 @@ +package org.azd.workitemtracking.types; + +/* +---------------------------------------------------------- + GENERATED FILE, should be edited to suit the purpose. +---------------------------------------------------------- +*/ + + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonProperty; +import org.azd.abstractions.serializer.SerializableEntity; + + +/** + * Represents a request to create a work item comment. +**/ +@JsonIgnoreProperties(ignoreUnknown = true) +public class CommentCreate extends SerializableEntity { + /** + * The text of the comment. + **/ + @JsonProperty("text") + private String text; + + public String getText() { return text; } + + public void setText(String text) { this.text = text; } +} diff --git a/azd/src/main/java/org/azd/workitemtracking/types/CommentList.java b/azd/src/main/java/org/azd/workitemtracking/types/CommentList.java new file mode 100644 index 00000000..75affe14 --- /dev/null +++ b/azd/src/main/java/org/azd/workitemtracking/types/CommentList.java @@ -0,0 +1,85 @@ +package org.azd.workitemtracking.types; + +/* +---------------------------------------------------------- + GENERATED FILE, should be edited to suit the purpose. +---------------------------------------------------------- +*/ + + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonProperty; +import org.azd.abstractions.serializer.SerializableEntity; + +import java.util.List; + + +/** + * Represents a list of work item comments. +**/ +@JsonIgnoreProperties(ignoreUnknown = true) +public class CommentList extends SerializableEntity { + /** + * Link references to related REST resources. + **/ + @JsonProperty("_links") + private Object _links; + /** + * List of comments in the current batch. + **/ + @JsonProperty("comments") + private List comments; + /** + * A string token that can be used to retrieving next page of comments if available. Otherwise null. + **/ + @JsonProperty("continuationToken") + private String continuationToken; + /** + * The count of comments in the current batch. + **/ + @JsonProperty("count") + private int count; + /** + * Uri to the next page of comments if it is available. Otherwise null. + **/ + @JsonProperty("nextPage") + private String nextPage; + /** + * Total count of comments on a work item. + **/ + @JsonProperty("totalCount") + private int totalCount; + /** + * REST URL for the resource. + **/ + @JsonProperty("url") + private String url; + + public Object get_links() { return _links; } + + public void set_links(Object _links) { this._links = _links; } + + public List getComments() { return comments; } + + public void setComments(List comments) { this.comments = comments; } + + public String getContinuationToken() { return continuationToken; } + + public void setContinuationToken(String continuationToken) { this.continuationToken = continuationToken; } + + public int getCount() { return count; } + + public void setCount(int count) { this.count = count; } + + public String getNextPage() { return nextPage; } + + public void setNextPage(String nextPage) { this.nextPage = nextPage; } + + public int getTotalCount() { return totalCount; } + + public void setTotalCount(int totalCount) { this.totalCount = totalCount; } + + public String getUrl() { return url; } + + public void setUrl(String url) { this.url = url; } +} diff --git a/azd/src/main/java/org/azd/workitemtracking/types/CommentMention.java b/azd/src/main/java/org/azd/workitemtracking/types/CommentMention.java new file mode 100644 index 00000000..e082d246 --- /dev/null +++ b/azd/src/main/java/org/azd/workitemtracking/types/CommentMention.java @@ -0,0 +1,74 @@ +package org.azd.workitemtracking.types; + +/* +---------------------------------------------------------- + GENERATED FILE, should be edited to suit the purpose. +---------------------------------------------------------- +*/ + + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonProperty; +import org.azd.abstractions.serializer.SerializableEntity; + + +/** + * +**/ +@JsonIgnoreProperties(ignoreUnknown = true) +public class CommentMention extends SerializableEntity { + /** + * Link references to related REST resources. + **/ + @JsonProperty("_links") + private Object _links; + /** + * The artifact portion of the parsed text. (i.e. the work item's id) + **/ + @JsonProperty("artifactId") + private String artifactId; + /** + * The type the parser assigned to the mention. (i.e. person, work item, etc) + **/ + @JsonProperty("artifactType") + private String artifactType; + /** + * The comment id of the mention. + **/ + @JsonProperty("commentId") + private int commentId; + /** + * The resolved target of the mention. An example of this could be a user's tfid + **/ + @JsonProperty("targetId") + private String targetId; + /** + * REST URL for the resource. + **/ + @JsonProperty("url") + private String url; + + public Object get_links() { return _links; } + + public void set_links(Object _links) { this._links = _links; } + + public String getArtifactId() { return artifactId; } + + public void setArtifactId(String artifactId) { this.artifactId = artifactId; } + + public String getArtifactType() { return artifactType; } + + public void setArtifactType(String artifactType) { this.artifactType = artifactType; } + + public int getCommentId() { return commentId; } + + public void setCommentId(int commentId) { this.commentId = commentId; } + + public String getTargetId() { return targetId; } + + public void setTargetId(String targetId) { this.targetId = targetId; } + + public String getUrl() { return url; } + + public void setUrl(String url) { this.url = url; } +} diff --git a/azd/src/main/java/org/azd/workitemtracking/types/CommentReaction.java b/azd/src/main/java/org/azd/workitemtracking/types/CommentReaction.java new file mode 100644 index 00000000..be7f5bd5 --- /dev/null +++ b/azd/src/main/java/org/azd/workitemtracking/types/CommentReaction.java @@ -0,0 +1,75 @@ +package org.azd.workitemtracking.types; + +/* +---------------------------------------------------------- + GENERATED FILE, should be edited to suit the purpose. +---------------------------------------------------------- +*/ + + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonProperty; +import org.azd.abstractions.serializer.SerializableEntity; +import org.azd.enums.CommentReactionType; + + +/** + * Contains information about work item comment reaction for a particular reaction type. +**/ +@JsonIgnoreProperties(ignoreUnknown = true) +public class CommentReaction extends SerializableEntity { + /** + * Link references to related REST resources. + **/ + @JsonProperty("_links") + private Object _links; + /** + * The id of the comment this reaction belongs to. + **/ + @JsonProperty("commentId") + private int commentId; + /** + * Total number of reactions for the CommentReactionType. + **/ + @JsonProperty("count") + private int count; + /** + * Flag to indicate if the current user has engaged on this particular EngagementType (e.g. if they liked the associated comment). + **/ + @JsonProperty("isCurrentUserEngaged") + private boolean isCurrentUserEngaged; + /** + * Type of the reaction. + **/ + @JsonProperty("type") + private CommentReactionType type; + /** + * REST URL for the resource. + **/ + @JsonProperty("url") + private String url; + + public Object get_links() { return _links; } + + public void set_links(Object _links) { this._links = _links; } + + public int getCommentId() { return commentId; } + + public void setCommentId(int commentId) { this.commentId = commentId; } + + public int getCount() { return count; } + + public void setCount(int count) { this.count = count; } + + public Boolean getIsCurrentUserEngaged() { return isCurrentUserEngaged; } + + public void setIsCurrentUserEngaged(Boolean isCurrentUserEngaged) { this.isCurrentUserEngaged = isCurrentUserEngaged; } + + public CommentReactionType getType() { return type; } + + public void setType(CommentReactionType type) { this.type = type; } + + public String getUrl() { return url; } + + public void setUrl(String url) { this.url = url; } +} diff --git a/azd/src/main/java/org/azd/workitemtracking/types/WorkItemBatchGetRequest.java b/azd/src/main/java/org/azd/workitemtracking/types/WorkItemBatchGetRequest.java index d998e0e8..51171d0d 100644 --- a/azd/src/main/java/org/azd/workitemtracking/types/WorkItemBatchGetRequest.java +++ b/azd/src/main/java/org/azd/workitemtracking/types/WorkItemBatchGetRequest.java @@ -7,7 +7,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import org.azd.abstractions.serializer.SerializableEntity; import org.azd.enums.WorkItemErrorPolicy; import org.azd.enums.WorkItemExpand; diff --git a/azd/src/main/java/org/azd/workitemtracking/types/WorkItemDeleteBatchRequest.java b/azd/src/main/java/org/azd/workitemtracking/types/WorkItemDeleteBatchRequest.java index 65cb89f6..7f062b75 100644 --- a/azd/src/main/java/org/azd/workitemtracking/types/WorkItemDeleteBatchRequest.java +++ b/azd/src/main/java/org/azd/workitemtracking/types/WorkItemDeleteBatchRequest.java @@ -7,7 +7,6 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonProperty; -import org.azd.abstractions.serializer.SerializableEntity; import java.util.List; diff --git a/azd/src/test/java/org/azd/MockParameters.java b/azd/src/test/java/org/azd/MockParameters.java new file mode 100644 index 00000000..342e65c5 --- /dev/null +++ b/azd/src/test/java/org/azd/MockParameters.java @@ -0,0 +1,61 @@ +package org.azd; + +import org.azd.abstractions.serializer.SerializableEntity; + +public class MockParameters extends SerializableEntity { + private String o; + private String t; + private String p; + private String ti; + private String c; + private String cs; + + public String getTI() { + return ti; + } + + public void setTI(String ti) { + this.ti = ti; + } + + + public String getO() { + return o; + } + + public void setO(String o) { + this.o = o; + } + + public String getT() { + return t; + } + + public void setT(String t) { + this.t = t; + } + + public String getP() { + return p; + } + + public void setP(String p) { + this.p = p; + } + + public String getC() { + return c; + } + + public void setC(String c) { + this.c = c; + } + + public String getCs() { + return cs; + } + + public void setCs(String cs) { + this.cs = cs; + } +} diff --git a/azd/src/test/java/org/azd/legacy/AccountsApiTest.java b/azd/src/test/java/org/azd/legacy/AccountsApiTest.java deleted file mode 100644 index eadf6d08..00000000 --- a/azd/src/test/java/org/azd/legacy/AccountsApiTest.java +++ /dev/null @@ -1,50 +0,0 @@ -package org.azd.legacy; - -import org.azd.abstractions.InstanceFactory; -import org.azd.abstractions.serializer.SerializerContext; -import org.azd.exceptions.AzDException; -import org.azd.interfaces.AccountsDetails; -import org.azd.interfaces.AzDClient; -import org.azd.utils.AzDClientApi; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; - -public class AccountsApiTest { - private static final SerializerContext serializer = InstanceFactory.createSerializerContext(); - private static AccountsDetails a; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = serializer.deserialize(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - AzDClient webApi = new AzDClientApi(organization, project, token); - a = webApi.getAccountsApi(); - } - - @Test - public void shouldGetAccounts() throws AzDException { - var id = a.getProfile().getId(); - a.getAccounts(id); - } - - @Test - public void shouldGetAllAccessibleOrganizations() throws AzDException { - a.getOrganizations(); - } - - @Test - public void shouldGetAUserProfile() throws AzDException { - a.getProfile(); - } - - @Test - public void shouldGetAUserProfileWithId() throws AzDException { - a.getProfile(a.getProfile().getId()); - } -} diff --git a/azd/src/test/java/org/azd/legacy/BuildApiTest.java b/azd/src/test/java/org/azd/legacy/BuildApiTest.java deleted file mode 100644 index bc673b6a..00000000 --- a/azd/src/test/java/org/azd/legacy/BuildApiTest.java +++ /dev/null @@ -1,398 +0,0 @@ -package org.azd.legacy; - -import org.azd.abstractions.InstanceFactory; -import org.azd.abstractions.serializer.SerializerContext; -import org.azd.build.types.BuildDefinition; -import org.azd.build.types.Folder; -import org.azd.enums.QueuePriority; -import org.azd.exceptions.AzDException; -import org.azd.helpers.StreamHelper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.BuildDetails; -import org.azd.utils.AzDClientApi; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; -import java.util.List; - -public class BuildApiTest { - private static final SerializerContext serializer = InstanceFactory.createSerializerContext(); - private static BuildDetails b; - private static int buildId; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = serializer.deserialize(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - AzDClient webApi = new AzDClientApi(organization, project, token); - b = webApi.getBuildApi(); - buildId = b.getBuilds(1).getBuildResults().stream().findFirst().get().getId(); - } - - @Test(expected = AzDException.class) - public void shouldDeleteABuild() throws AzDException { - b.deleteBuild(122); - } - - @Test - public void shouldGetABuild() throws AzDException { - b.getBuild(buildId); - } - - @Test - public void shouldReturnABuildChanges() throws AzDException { - b.getBuildChanges(buildId); - } - - @Test - public void shouldReturnABuildChangesWithOptionalParameters() throws AzDException { - b.getBuildChanges(buildId, 10, "1", true); - } - - @Test - public void shouldReturnABuildLog() throws AzDException { - b.getBuildLog(50, 3); - } - - @Test - public void shouldReturnABuildLogWithOptionalParameters() throws AzDException { - b.getBuildLog(127, 3, 3, 6); - } - - @Test - public void shouldReturnBuildLogs() throws AzDException { - b.getBuildLogs(buildId); - } - - @Test - public void shouldReturnBuildWorkItems() throws AzDException { - b.getBuildWorkItems(buildId); - } - - @Test - public void shouldReturnBuildWorkItemsWithOptionalParameters() throws AzDException { - b.getBuildWorkItems(buildId, 10); - } - - @Test - public void shouldReturnChangesBetweenBuilds() throws AzDException { - b.getChangesBetweenBuilds(buildId, buildId, 10); - } - - @Test - public void shouldReturnWorkItemsBetweenBuilds() throws AzDException { - b.getWorkItemsBetweenBuilds(buildId, buildId, 10); - } - - @Test - public void shouldReturnBuilds() throws AzDException { - b.getBuilds(); - } - - @Test - public void shouldReturnBuildsContinuationToken() throws AzDException { -// b.getBuilds().getContinuationToken(); - b.getBuilds(); - } - - @Test - public void shouldReturnBuildsWithArrayOfBuildIds() throws AzDException { - var builds = b.getBuilds().getBuildResults().stream() - .mapToInt(x -> x.getId()) - .limit(2) - .toArray(); - b.getBuilds(builds); - } - - @Test - public void shouldReturnTopTwoBuilds() throws AzDException { - b.getBuilds(2); - } - - @Test - public void shouldQueueTheBuild() throws AzDException { - b.queueBuild(22); - } - - @Test - public void shouldReturnListOfBuildController() throws AzDException { - b.getBuildControllers(); - } - - @Test(expected = AzDException.class) - public void shouldReturnABuildController() throws AzDException { - // should throw an exception if build controller doesn't exists - b.getBuildController(25); - } - - @Test(expected = AzDException.class) - public void shouldCreateBuildDefinition() throws AzDException { - b.createBuildDefinition(""); - } - - @Test - public void shouldDeleteABuildDefinition() throws AzDException { - b.deleteBuildDefinition(13); - } - - @Test - public void shouldReturnBuildDefinition() throws AzDException { - b.getBuildDefinition(b.getBuildDefinitions().getBuildDefinitions().stream().findFirst().get().getId()); - } - - @Test - public void shouldReturnBuildDefinitionWithOptionalParameters() throws AzDException { - b.getBuildDefinition(b.getBuildDefinitions().getBuildDefinitions().stream().findFirst().get().getId(), true, null, 2); - } - - @Test - public void shouldReturnBuildDefinitionRevisions() throws AzDException { - b.getBuildDefinitionRevisions(b.getBuildDefinitions().getBuildDefinitions().stream().findFirst().get().getId()); - } - - @Test - public void shouldReturnBuildDefinitions() throws AzDException { - b.getBuildDefinitions(); - } - - @Test - public void shouldReturnBuildDefinitionsWithIds() throws AzDException { - var defs = b.getBuildDefinitions().getBuildDefinitions().stream() - .mapToInt(BuildDefinition::getId) - .limit(2) - .toArray(); - b.getBuildDefinitions(defs); - } - - @Test - public void shouldReturnTopTwoBuildDefinitions() throws AzDException { - b.getBuildDefinitions(2); - } - - @Test - public void shouldReturnBuildDefinitionsWithName() throws AzDException { - b.getBuildDefinitions(b.getBuildDefinitions().getBuildDefinitions().stream().findFirst().get().getName()); - } - - @Test(expected = AzDException.class) - public void shouldRestoreBuildDefinition() throws AzDException { - b.restoreBuildDefinition(126, false); - - } - - @Test - public void shouldAddABuildTag() throws AzDException { - b.addBuildTag(buildId, "Demo"); - } - - @Test - public void shouldAddBuildTags() throws AzDException { - b.addBuildTags(buildId, List.of("Demo", "CI", "Test")); - } - - @Test - public void shouldAddADefinitionTag() throws AzDException { - b.addDefinitionTag(22, "TestDefinition"); - } - - @Test - public void shouldAddDefinitionTags() throws AzDException { - b.addDefinitionTags(22, List.of("TestDefinition", "DemoDefinition")); - } - - @Test - public void shouldDeleteABuildTag() throws AzDException { - b.deleteBuildTag(buildId, "Test"); - } - - @Test - public void shouldDeleteADefinitionTag() throws AzDException { - b.deleteDefinitionTag(22, "DemoDefinition"); - } - - @Test - public void shouldDeleteATag() throws AzDException { - b.deleteTag("DemoDefinition"); - } - - @Test - public void shouldGetBuildTags() throws AzDException { - b.getBuildTags(buildId); - } - - @Test - public void shouldGetDefinitionTags() throws AzDException { - b.getDefinitionTags(22); - } - - @Test - public void shouldGetTags() throws AzDException { - b.getTags(); - } - - @Test - public void shouldUpdateBuildTags() throws AzDException { - b.updateBuildTags(buildId, List.of("Demo", "CI", "Test"), false); - } - - @Test - public void shouldUpdateDefinitionTags() throws AzDException { - b.updateDefinitionTags(22, List.of("TestDefinition", "DemoDefinition"), false); - } - - @Test - public void shouldGetYamlBuildForADefinition() throws AzDException { - b.getYaml(22).getYaml(); - } - - @Test(expected = AzDException.class) - public void shouldGetSourceProvidersFileContents() throws AzDException { - b.getFileContents("Github", "a7054ra9-0a34-46ac-bfdf-b8a1da865tdfd6", - "hkarthik7/PSDB", "master", "LICENSE"); - } - - @Test(expected = AzDException.class) - public void shouldGetSourceProvidersPathContents() throws AzDException { - b.getPathContents("Github", "a7054ra9-0a34-46ac-bfdf-b8a1da865tdfd6", - "hkarthik7/PSDB", "master", "/"); - } - - @Test(expected = AzDException.class) - public void shouldGetSourceProvidersPullRequest() throws AzDException { - b.getPullRequest("Github", "2", - "hkarthik7/PSDB", "a7054ra9-0a34-46ac-bfdf-b8a1da865tdfd6"); - } - - @Test - public void shouldGetSourceProviders() throws AzDException { - b.getSourceProviders(); - } - - @Test(expected = AzDException.class) - public void shouldGetSourceProvidersBranches() throws AzDException { - b.getBranches("Github", "a7054ra9-0a34-46ac-bfdf-b8a1da865tdfd6", "hkarthik7/PSDB"); - } - - @Test(expected = AzDException.class) - public void shouldGetSourceProvidersRepositories() throws AzDException { - b.getRepositories("Github", "a7054ra9-0a34-46ac-bfdf-b8a1da865tdfd6"); - } - - @Test(expected = AzDException.class) - public void shouldGetSourceProvidersWebhooks() throws AzDException { - b.getWebHooks("Github", "a7054ra9-0a34-46ac-bfdf-b8a1da865tdfd6", "hkarthik7/PSDB"); - } - - @Test() - public void shouldGetBuildTimelines() throws AzDException { - b.getTimeline(buildId); - } - - @Test() - public void shouldGetBuildTimelinesWithTimelineId() throws AzDException { - var timeline = b.getTimeline(buildId); - b.getTimeline(buildId, timeline.getId()); - } - - @Test() - public void shouldGetBuildTimelinesWithChangeAndPlanId() throws AzDException { - var timeline = b.getTimeline(buildId); - b.getTimeline(buildId, timeline.getId(), timeline.getChangeId(), null); - } - - @Test - public void shouldCreateBuildArtifact() throws AzDException { - try { - var artifact = b.getArtifact(1629, "Test"); - b.createArtifact(176, artifact); - } catch (AzDException e) { - } - } - - @Test - public void shouldGetABuildArtifact() throws AzDException { - try { - b.getArtifact(1593, "drop").getResource(); - } catch (AzDException e) { - } - } - - @Test - public void shouldGetBuildArtifactAsZip() throws AzDException { - try { - var res = b.getArtifactAsZip(1593, "drop"); - StreamHelper.download("drop.zip", res); - } catch (AzDException e) { - } - } - - @Test - public void shouldGetABuildArtifacts() throws AzDException { - try { - b.getArtifacts(1593); - } catch (AzDException e) { - } - } - - @Test() - public void shouldUpdateABuild() throws AzDException { - var build = b.getBuild(buildId); - build.setTags(new String[]{"Demo"}); - // Set retry to true only when previous attempt of a build has failed and if retry is true build object - // should be set to null. - // b.updateBuild(null, build.getId(), true); - b.updateBuild(build, build.getId(), false); - } - - @Test() - public void shouldUpdateMultipleBuilds() throws AzDException { - var builds = b.getBuilds(2); - for (var build : builds.getBuildResults()) { - build.setPriority(QueuePriority.LOW); - } - b.updateBuilds(builds); - } - - @Test() - public void shouldUpdateBuildDefinition() throws AzDException { - var def = b.getBuildDefinition(23); - def.setDescription("Demo CI for azd project"); - b.updateBuildDefinition(def); - } - - @Test() - public void shouldCreateFolder() throws AzDException { - try { - var folder = new Folder(); - folder.setDescription("New demo folder"); - folder.setPath("\\Demo-Folder\\sub-demo"); - b.createFolder(folder.getPath(), folder); - } catch (AzDException e) { - } - } - - @Test() - public void shouldDeleteAFolder() throws AzDException { - try { - b.deleteFolder("\\Demo-Folder\\sub-demo"); - } catch (AzDException e) { - } - } - - @Test() - public void shouldGetAListOfFolders() throws AzDException { - b.getFolders(); - } - - @Test() - public void shouldUpdateFolder() throws AzDException { - var folder = b.getFolders().getFolders().get(1); - folder.setDescription("Demo folder for azd project"); - b.updateFolder(folder.getPath(), folder); - } -} diff --git a/azd/src/test/java/org/azd/legacy/ConnectionTest.java b/azd/src/test/java/org/azd/legacy/ConnectionTest.java deleted file mode 100644 index 3ded5e16..00000000 --- a/azd/src/test/java/org/azd/legacy/ConnectionTest.java +++ /dev/null @@ -1,47 +0,0 @@ -package org.azd.legacy; - -import org.azd.connection.Connection; -import org.junit.Test; - -import static org.junit.Assert.assertNull; -import static org.junit.Assert.assertSame; - -@Deprecated(since = "v6.0") -public class ConnectionTest { - - @Test - public void shouldReturnOrganisation() { - // Given - String organization = "Test"; - String token = "myPersonalAccessToken"; - - // When - Connection defaultParameters = new Connection(organization, token); - - // Then(assert and act) - assertSame(defaultParameters.getOrganization(), organization); - } - - @Test - public void shouldSetDifferentOrganization() { - // Given - String organization = "Test"; - String token = "myPersonalAccessToken"; - - // When - Connection defaultParameters = new Connection(organization, token); - defaultParameters.setOrganization("Check"); - - // Then(assert and act) - assertSame("Check", defaultParameters.getOrganization()); - } - - @Test - public void shouldReturnNull() { - // When - Connection defaultParameters = new Connection(); - - // Then(assert and act) - assertNull(defaultParameters.getOrganization()); - } -} \ No newline at end of file diff --git a/azd/src/test/java/org/azd/legacy/CoreApiTest.java b/azd/src/test/java/org/azd/legacy/CoreApiTest.java deleted file mode 100644 index 20a0ef4a..00000000 --- a/azd/src/test/java/org/azd/legacy/CoreApiTest.java +++ /dev/null @@ -1,161 +0,0 @@ -package org.azd.legacy; - -import org.azd.abstractions.InstanceFactory; -import org.azd.abstractions.serializer.SerializerContext; -import org.azd.core.types.Project; -import org.azd.core.types.ProjectFeature; -import org.azd.core.types.WebApiTeam; -import org.azd.enums.FeatureManagement; -import org.azd.exceptions.AzDException; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.CoreDetails; -import org.azd.utils.AzDClientApi; -import org.junit.Assume; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; -import java.util.Optional; - -public class CoreApiTest { - private static final SerializerContext serializer = InstanceFactory.createSerializerContext(); - private static AzDClient webApi; - private static CoreDetails c; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = serializer.deserialize(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - c = webApi.getCoreApi(); - } - - @Test - public void shouldReturnListOfProcess() throws AzDException { - c.getProcesses(); - } - - @Test(expected = AzDException.class) - public void shouldCreateDefaultProject() throws AzDException { - // project already exists error - c.createProject("my-awesome-project", "This is my new awesome project"); - } - - @Test - public void shouldCreateProjectWithAdditionalParameters() throws AzDException { - try { - c.createProject("my-New-awesome-project", "My new awesome project", "Git", "b8a3a935-7e91-48b8-a94c-606d37c3e9f2"); - } catch (AzDException e) { - // Ignore project already exists error. - } - } - - @Test - public void shouldGetAProject() throws AzDException { - c.getProject(c.getProjects().getProjects().get(0).getName()); - } - - @Test - public void shouldGetAProjectWithOptionalParameters() throws AzDException { - c.getProject(c.getProjects().getProjects().get(0).getName(), true, true); - } - - @Test - public void shouldDeleteAProject() throws AzDException { - Project project = null; - try { - project = c.getProject("my-New-awesome-project"); - } catch (AzDException e) { - } - - if (project != null) { - c.deleteProject(project.getId()); - } - } - - @Test - public void shouldGetProjectProperties() throws AzDException { - var projectId = c.getProject("azure-devops-java-sdk").getId(); - c.getProjectProperties(projectId).getValue(); - } - - @Test - public void shouldReturnAllProjects() throws AzDException { - c.getProjects(); - } - - @Test - public void shouldCreateAProjectTeam() throws AzDException { - WebApiTeam team = null; - try { - team = c.getTeam("my-awesome-project", "myNewTeam"); - } catch (AzDException e) { - } - - if (team == null) { - c.createTeam("my-awesome-project", "myNewTeam"); - } - } - - @Test - public void shouldDeleteAProjectTeam() throws AzDException { - WebApiTeam team = null; - try { - team = c.getTeam("my-awesome-project", "myNewTeam"); - } catch (AzDException e) { - } - - if (team != null) { - c.deleteTeam(c.getProject("my-awesome-project").getId(), "myNewTeam"); - } - } - - @Test - public void shouldGetAProjectTeam() throws AzDException { - try { - c.getTeam("my-awesome-project", "myTeam"); - } catch (AzDException e) { - } - } - - @Test - public void shouldGetAProjectTeamWithOptionalParameters() throws AzDException { - try { - c.getTeam(c.getProject("my-awesome-project").getId(), "myTeam", true); - } catch (AzDException e) { - } - } - - @Test - public void shouldGetAllProjectTeams() throws AzDException { - c.getTeams(); - } - - @Test - public void shouldUpdateProjectTeams() throws AzDException { - c.updateTeams(c.getProject("my-awesome-project").getId(), "myTeam", "Description for my super team"); - } - - @Test - public void shouldReadProjectFeatures() throws AzDException { - Project project = c.getProject("my-awesome-project"); - Assume.assumeNotNull(project); - for (FeatureManagement value : FeatureManagement.values()) { - try { - Optional featureState = c.getFeatureState(project.getId(), value); - } catch (Exception ignored) {} - } - } - - @Test - public void shouldToggleFeature() throws AzDException { - Project project = c.getProject("my-awesome-project"); - Assume.assumeNotNull(project); - ProjectFeature projectFeature = c.featureToggle(project.getId(), FeatureManagement.TEST_PLANS, false); -// System.out.println("Feature: " + projectFeature); - } -} diff --git a/azd/src/test/java/org/azd/legacy/DistributedTaskApiTest.java b/azd/src/test/java/org/azd/legacy/DistributedTaskApiTest.java deleted file mode 100644 index fb1e96b7..00000000 --- a/azd/src/test/java/org/azd/legacy/DistributedTaskApiTest.java +++ /dev/null @@ -1,183 +0,0 @@ -package org.azd.legacy; - -import org.azd.abstractions.InstanceFactory; -import org.azd.abstractions.serializer.SerializerContext; -import org.azd.distributedtask.types.VariableGroupDefinition; -import org.azd.distributedtask.types.VariableGroupMap; -import org.azd.enums.VariableGroupType; -import org.azd.enums.VariableValue; -import org.azd.exceptions.AzDException; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.CoreDetails; -import org.azd.interfaces.DistributedTaskDetails; -import org.azd.release.types.ProjectReference; -import org.azd.utils.AzDClientApi; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; - -public class DistributedTaskApiTest { - private static final SerializerContext SERIALIZER = InstanceFactory.createSerializerContext(); - private static AzDClient webApi; - private static DistributedTaskDetails d; - private static CoreDetails c; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = SERIALIZER.deserialize(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - d = webApi.getDistributedTaskApi(); - c = webApi.getCoreApi(); - } - - @Test - public void shouldGetAnAgentInAPool() throws AzDException { - d.getAgent(9, 8); - } - - @Test - public void shouldGetAllAgentsInAPool() throws AzDException { - d.getAgents(9); - } - - @Test(expected = AzDException.class) - public void shouldAddADeploymentGroup() throws AzDException { - d.addDeploymentGroup("myDeploymentGroup", "Deployments to test VMs"); - } - - @Test - public void shouldGetAllDeploymentGroups() throws AzDException { - d.getDeploymentGroups(); - } - - @Test - public void shouldGetADeploymentGroup() throws AzDException { - d.getDeploymentGroup(2944); - } - - @Test - public void shouldDeleteADeploymentGroup() throws AzDException { - // create a new deployment group - try { - var deploymentGroup = d.addDeploymentGroup("newDeploymentGroup", "New Deployment group"); - d.deleteDeploymentGroup(deploymentGroup.getId()); - } catch (AzDException e) { - } - } - - @Test - public void shouldUpdateADeploymentGroup() throws AzDException { - // create a new deployment group, update it and delete it. - var deploymentGroup = d.getDeploymentGroup(2947); - d.updateDeploymentGroup(deploymentGroup.getId(), deploymentGroup.getName(), "Description for new deployment group"); - } - - @Test(expected = AzDException.class) - public void shouldAddANewEnvironment() throws AzDException { - d.addEnvironment("newEnvironment", "New testing environment"); - } - - @Test - public void shouldGetAnEnvironment() throws AzDException { - d.getEnvironment(1); - } - - @Test - public void shouldReturnListOfEnvironments() throws AzDException { - d.getEnvironments(); - } - - @Test - public void shouldDeleteAnEnvironment() throws AzDException { - var env = d.addEnvironment("EnvironmentToDelete", "Environment created for testing deletion functionality"); - d.deleteEnvironment(env.getId()); - } - - @Test - public void shouldUpdateAnEnvironment() throws AzDException { - d.updateEnvironment(4, "EnvironmentToUpdate", "Environment created for testing update functionality"); - } - - @Test - public void shouldAddANewVariableGroup() throws AzDException { - try { - var variableGroupDefinition = new VariableGroupDefinition(); - var projectReference = new ProjectReference(); - - var project = c.getProject("azure-devops-java-sdk"); - - projectReference.setName(project.getName()); - projectReference.setId(project.getId()); - - var variables = new VariableGroupMap() {{ - put("userName", "testUser"); - put("passCode", "2255"); - put("details", "Test Value", VariableValue.IS_SECRET); - }}; - - variableGroupDefinition.setName("testGroup"); - variableGroupDefinition.setDescription("This is a test variable group"); - variableGroupDefinition.setType(VariableGroupType.Vsts); - variableGroupDefinition.setVariables(variables.get()); - variableGroupDefinition.setProjectReference(projectReference); - - d.addVariableGroup(variableGroupDefinition); - } catch (AzDException e) { - } - } - - @Test - public void shouldAddANewVariableGroupToDefaultProject() throws AzDException { - try { - var vMap = new VariableGroupMap() {{ - put("userName", "testUser"); - put("passCode", "2255"); - put("details", "Test Value", VariableValue.IS_SECRET); - }}; - - d.addVariableGroup("test", "test group", vMap); - } catch (AzDException e) { - } - } - - @Test - public void shouldGetVariableGroups() throws AzDException { - d.getVariableGroups(); - } - - @Test - public void shouldDeleteAVariableGroup() throws AzDException { - var variables = new VariableGroupMap() {{ - put("userName", "testUser"); - }}; - - var projectId = c.getProject("azure-devops-java-sdk").getId(); - - var group = d.addVariableGroup("newVariableGroup", "Meant for testing deletion functionality", variables); - - d.deleteVariableGroup(group.getId(), new String[]{projectId}); - } - - @Test - public void shouldUpdateAVariableGroup() throws AzDException { - var variablesToUpdate = new VariableGroupMap() {{ - put("userName", "testUser"); - put("password", "testUser", VariableValue.IS_SECRET); - put("details", "Test Value", VariableValue.IS_READONLY); - }}; - - var group = d.getVariableGroups("testGroupNew") - .getVariableGroups() - .stream() - .findFirst() - .get(); - - d.updateVariableGroup(group.getId(), group.getName(), group.getDescription(), variablesToUpdate); - } -} diff --git a/azd/src/test/java/org/azd/legacy/ExtensionManagementApiTest.java b/azd/src/test/java/org/azd/legacy/ExtensionManagementApiTest.java deleted file mode 100644 index 1bd9b02d..00000000 --- a/azd/src/test/java/org/azd/legacy/ExtensionManagementApiTest.java +++ /dev/null @@ -1,51 +0,0 @@ -package org.azd.legacy; - -import org.azd.enums.ExtensionStateFlags; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.ExtensionManagementDetails; -import org.azd.utils.AzDClientApi; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; - -public class ExtensionManagementApiTest { - private static final JsonMapper MAPPER = new JsonMapper(); - private static AzDClient webApi; - private static ExtensionManagementDetails e; - - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - e = webApi.getExtensionManagementApi(); - } - - @Test - public void shouldReturnListOfExtensions() throws AzDException { - e.getExtensions(); - } - - @Test(expected = AzDException.class) - public void shouldInstallExtension() throws AzDException { - e.installExtension("publisherId", "extensionId", null); - } - - @Test - public void shouldUnInstallExtension() throws AzDException { - e.uninstallExtension("publisherId", "extensionId"); - } - - @Test(expected = AzDException.class) - public void shouldUpdateExtension() throws AzDException { - e.updateExtension("publisherId", "extensionId", ExtensionStateFlags.NONE); - } -} diff --git a/azd/src/test/java/org/azd/legacy/FeedManagementApiTest.java b/azd/src/test/java/org/azd/legacy/FeedManagementApiTest.java deleted file mode 100644 index d4485425..00000000 --- a/azd/src/test/java/org/azd/legacy/FeedManagementApiTest.java +++ /dev/null @@ -1,132 +0,0 @@ -package org.azd.legacy; - -import org.azd.abstractions.InstanceFactory; -import org.azd.abstractions.serializer.SerializerContext; -import org.azd.enums.FeedRole; -import org.azd.enums.FeedViewType; -import org.azd.enums.FeedVisibility; -import org.azd.exceptions.AzDException; -import org.azd.feedmanagement.types.Feed; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.FeedManagementDetails; -import org.azd.utils.AzDClientApi; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; -import java.util.UUID; - -public class FeedManagementApiTest { - - private static final SerializerContext serializer = InstanceFactory.createSerializerContext(); - private static FeedManagementDetails f; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = serializer.deserialize(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - AzDClient webApi = new AzDClientApi(organization, project, token); - f = webApi.getFeedManagementApi(); - } - - @Test(expected = AzDException.class) - public void shouldCreateAFeed() throws AzDException { - f.createFeed("myFeed", "My Test Feed", false, true); - } - - @Test(expected = AzDException.class) - public void shouldCreateAFeedView() throws AzDException { - f.createFeedView("myFeed", "TestFeedView", FeedViewType.RELEASE, FeedVisibility.ORGANIZATION); - } - - @Test(expected = AzDException.class) - public void shouldDeleteAFeedView() throws AzDException { - f.deleteFeedView("myFeed", "TestFeedView"); - } - - @Test(expected = AzDException.class) - public void shouldDeleteAFeed() throws AzDException { - f.deleteFeed("myFeed"); - } - - @Test - public void shouldGetAFeed() throws AzDException { - f.getFeed("newTestFeed"); - } - - @Test(expected = AzDException.class) - public void shouldGetAFeedWithQueryParameters() throws AzDException { - f.getFeed("myFeed", false); - } - - @Test - public void shouldGetAFeedPermissions() throws AzDException { - f.getFeedPermissions("TestFeed"); - } - - @Test - public void shouldGetAFeedPermissionsWithQueryParameters() throws AzDException { - f.getFeedPermissions("TestFeed", true, "", true, true); - } - - @Test - public void shouldGetAFeedView() throws AzDException { - f.getFeedView("TestFeed", "myView"); - } - - @Test - public void shouldGetFeedViews() throws AzDException { - f.getFeedViews("TestFeed"); - } - - @Test - public void shouldGetFeeds() throws AzDException { - f.getFeeds(); - } - - @Test - public void shouldGetFeedsWithQueryParameters() throws AzDException { - f.getFeeds(FeedRole.ADMINISTRATOR, true, true); - } - - @Test - public void shouldSetFeedPermissions() throws AzDException { - var feedPermissions = f.getFeedPermissions("TestFeed"); - f.setFeedPermissions("TestFeed", feedPermissions); - } - - @Test - public void shouldUpdateAFeed() throws AzDException { - var feed = f.getFeed("TestFeed"); - feed.setBadgesEnabled(false); - f.updateFeed(feed.getId(), feed); - } - - @Test - public void shouldUpdateAFeedView() throws AzDException { - var feedView = f.getFeedView("TestFeed", "myView"); - feedView.setVisibility(FeedVisibility.PRIVATE); - f.updateFeedView("TestFeed", feedView.getName(), feedView); - } - - @Test - public void shouldCreateAndUpdateAFeed() throws AzDException { - String feedName = "MyTestFeed-" + UUID.randomUUID(); - try { - f.createFeed(feedName, "this is a new feed", true, true); - Thread.sleep(2000l); // to allow for feed creation - } catch (AzDException e) { - // ignore feed already exists - } catch (InterruptedException e) { - // ignore wait interrupt - } - Feed feed = f.getFeed(feedName); -// f.updateFeed(feed.getId(), feedName, true, "my description", true, false); - - f.deleteFeed(feed.getId()); - } -} \ No newline at end of file diff --git a/azd/src/test/java/org/azd/legacy/GitApiTest.java b/azd/src/test/java/org/azd/legacy/GitApiTest.java deleted file mode 100644 index cf7f67c9..00000000 --- a/azd/src/test/java/org/azd/legacy/GitApiTest.java +++ /dev/null @@ -1,483 +0,0 @@ -package org.azd.legacy; - -import org.azd.common.types.JsonPatchDocument; -import org.azd.enums.*; -import org.azd.exceptions.AzDException; -import org.azd.git.types.*; -import org.azd.helpers.JsonMapper; -import org.azd.helpers.StreamHelper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.GitDetails; -import org.azd.utils.AzDClientApi; -import org.azd.wiki.types.GitVersionDescriptor; -import org.junit.Before; -import org.junit.Ignore; -import org.junit.Test; - -import java.io.File; -import java.util.List; -import java.util.stream.Collectors; - -import static org.junit.Assert.assertTrue; - -public class GitApiTest { - - private static final JsonMapper MAPPER = new JsonMapper(); - private static AzDClient webApi; - private static GitDetails g; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - g = webApi.getGitApi(); - } - - @Test(expected = AzDException.class) - public void shouldCreateANewRepository() throws AzDException { - g.createRepository("testRepository", "00000000-0000-0000-0000-000000000000"); - } - - @Test(expected = AzDException.class) - public void shouldDeleteRepository() throws AzDException { - g.deleteRepository("00000000-0000-0000-0000-000000000000"); - } - - @Test(expected = AzDException.class) - public void shouldDeleteRepositoryFromRecycleBin() throws AzDException { - g.deleteRepositoryFromRecycleBin("00000000-0000-0000-0000-000000000000"); - } - - @Test - public void shouldGetDeletedGitRepositories() throws AzDException { - g.getDeletedRepositories(); - } - - @Test - public void shouldGetRecycleBinRepositories() throws AzDException { - g.getRecycleBinRepositories(); - } - - @Test - public void shouldGetRepository() throws AzDException { - g.getRepository("testRepository"); - } - - @Test - public void shouldGetRepositories() throws AzDException { - g.getRepositories(); - } - - @Test - public void shouldGetHiddenRepositories() throws AzDException { - g.getRepositories(true); - } - - @Test - public void shouldGetRepositoriesWithLinksAndUrls() throws AzDException { - g.getRepositories(true, true); - } - - @Test - public void shouldGetRepositoriesForGivenQueryParameters() throws AzDException { - g.getRepositories(true, true, true).getRepositories().get(0).getValidRemoteUrls(); - } - - @Test(expected = AzDException.class) - public void shouldRestoreRepositoryFromRecycleBin() throws AzDException { - g.restoreRepositoryFromRecycleBin("00000000-0000-0000-0000-000000000000", false); - } - - @Test(expected = AzDException.class) - public void shouldUpdateRepository() throws AzDException { - g.updateRepository(g.getRepository("newName").getId(), "newRepo", "main"); - } - - @Test(expected = AzDException.class) - public void shouldCreateANewPullRequest() throws AzDException { - g.createPullRequest(g.getRepositories().getRepositories().stream().findFirst().get().getId(), - "refs/heads/develop", "refs/heads/master", "New feature", "Adding new feature", - new String[]{"d6245f20-2af8-44f4-9451-8107cb2767db"}); - } - - // failing the test intentionally. If not this will create many pull - // requests on each run. - // To pass the test remove (expected = AzDException.class) and replace - // targetRefName: master with main. - @Test(expected = AzDException.class) - public void shouldCreateANewPullRequestAsDraft() throws AzDException { - var repoId = g.getRepository("testRepository").getId(); - g.createPullRequest(repoId, "develop", "master", "New feature", "Adding new feature", true); - } - - @Test - public void shouldRetrieveAPullRequest() throws AzDException { - g.getPullRequest(g.getRepository("testRepository").getName(), 3); - } - - @Test - public void shouldRetrieveAPullRequestById() throws AzDException { - g.getPullRequestById(2); - } - - @Test - public void shouldRetrieveAllPullRequestsFromARepository() throws AzDException { - g.getPullRequests(g.getRepositories().getRepositories().stream().findFirst().get().getName()); - } - - @Test - public void shouldGetPullRequestsByProject() throws AzDException { - g.getPullRequestsByProject().getPullRequests(); - } - - @Test - public void shouldGetTopTenPullRequestsByProject() throws AzDException { - g.getPullRequestsByProject(10); - } - - @Test - public void shouldGetPullRequestsByProjectWithCompletedStatus() throws AzDException { - g.getPullRequestsByProject(PullRequestStatus.COMPLETED).getPullRequests(); - } - - @Test - public void shouldgetBranch() throws AzDException { - g.getBranch("testRepository", "develop"); - } - - @Test - public void shouldgetBranches() throws AzDException { - g.getBranches("testRepository"); - } - - @Test - public void shouldLockABranch() throws AzDException { - g.updateBranchLock("testRepository", "develop", true); - } - - @Test - public void shouldUnLockABranch() throws AzDException { - g.updateBranchLock("testRepository", "develop", false); - } - - @Test - public void shouldGetPullRequestWorkItems() throws AzDException { - var pr = g.getPullRequestById(4); - g.getPullRequestWorkItems(pr.getPullRequestId(), pr.getRepository().getName()); - } - - @Test - public void shouldCreateAPullRequestLabel() throws AzDException { - g.createPullRequestLabel("testRepository", 7, "DevOps"); - } - - @Test - public void shouldGetAPullRequestLabel() throws AzDException { - g.getPullRequestLabel("testRepository", 7, "azd"); - } - - @Test - public void shouldGetPullRequestLabels() throws AzDException { - g.getPullRequestLabels("testRepository", 7); - } - - @Test - public void shouldDeleteAPullRequestLabels() throws AzDException { - WebApiTagDefinition label = null; - - try { - label = g.getPullRequestLabel("testRepository", 7, "DevOps"); - } catch (AzDException ignored) { - } - - if (label.getUrl().isEmpty()) { - g.createPullRequestLabel("testRepository", 7, "DevOps"); - } - g.deletePullRequestLabel("testRepository", 7, "DevOps"); - } - - @Test - public void shouldCreateAPullRequestReviewer() throws AzDException { - g.createPullRequestReviewer(8, "testRepository", "0e5f1643-a006-67e7-bdb9-20f45e698f9f", 0, false); - } - - @Test(expected = AzDException.class) - public void shouldDeleteAPullRequestReviewer() throws AzDException { - g.deletePullRequestReviewer(8, "testRepository", "id"); - } - - @Test - public void shouldGetAPullRequestReviewer() throws AzDException { - g.getPullRequestReviewer(8, "testRepository", "10bb49f0-c425-6735-b8de-71ecf84728d6"); - } - - @Test - public void shouldGetPullRequestReviewers() throws AzDException { - g.getPullRequestReviewers(8, "testRepository"); - } - - @Test - public void shouldUpdateAPullRequestReviewer() throws AzDException { - var pr = g.getPullRequestReviewers(8, "testRepository").getPullRequestReviewers() - .get(1); - g.updatePullRequestReviewer(8, "testRepository", pr.getId(), true, false); - } - - @Test(expected = AzDException.class) - public void shouldCreateAnAnnotatedTag() throws AzDException { - g.createAnnotatedTag("testRepository", "annotatedTestTag", "83764e57d4b290766046da65b1c7c4afe8b71a92", - "Annotated Tag for testing"); - } - - @Test - public void shouldGetAnAnnotatedTag() throws AzDException { - g.getAnnotatedTag("testRepository", "d993d67b34ea8365defbee2945755d5a7d3185f4"); - } - - @Test - public void shouldGetCommitsFromARepository() throws AzDException { - g.getCommits("testRepository").getCommits(); - } - - @Test - public void shouldGetACommitsFromTheRepository() throws AzDException { - var commitId = g.getCommits("testRepository").getCommits().stream().findFirst().get().getCommitId(); - g.getCommit("testRepository", commitId); - } - - @Test - public void shouldGetCommitsBatch() throws AzDException { - var repoId = g.getRepository("testRepository").getId(); - - var itemVersion = new GitVersionDescriptor(); - itemVersion.version = "test"; - itemVersion.versionOptions = GitVersionOptions.NONE; - itemVersion.versionType = GitVersionType.BRANCH; - - var compareVersion = new GitVersionDescriptor(); - compareVersion.version = "main"; - compareVersion.versionOptions = GitVersionOptions.NONE; - compareVersion.versionType = GitVersionType.BRANCH; - - var gitCommitsBatch = new GitCommitsBatch(); - gitCommitsBatch.itemVersion = itemVersion; - gitCommitsBatch.compareVersion = compareVersion; - gitCommitsBatch.includeWorkItems = true; - - g.getCommitsBatch(repoId, gitCommitsBatch); - } - - @Test - public void shouldGetRefs() throws AzDException { - g.getRefs("testRepository"); - } - - @Test - public void shouldGetRefsWithQueryParameters() throws AzDException { - g.getRefs("testRepository", "heads/"); - } - - @Test - public void shouldUpdateRefs() throws AzDException { - g.updateRef("testRepository", "refs/heads/test2", "0000000000000000000000000000000000000000", "0000000000000000000000000000000000000000"); - } - - @Test - public void shouldCreateTag() throws AzDException { - g.createTag("testRepository", "createTestTag", "main"); - } - - @Test - public void shouldDeleteTag() throws AzDException { - g.deleteTag("testRepository", "createTestTag"); - } - - @Test - public void shouldGetABlob() throws AzDException { - var repoId = g.getRepository("testRepository").getId(); - var items = g.getItems(repoId, VersionControlRecursionType.FULL).getItems(); - var sha1 = items.stream() - .filter(x -> x.getGitObjectType() == GitObjectType.BLOB && x.getPath().equals("/Test.txt")) - .map(GitItem::getObjectId) - .findFirst() - .get(); - - g.getBlob(repoId, sha1, "test.txt", false); - } - - @Test - public void shouldGetABlobContent() throws AzDException { - var repoId = g.getRepository("testRepository").getId(); - var items = g.getItems(repoId, VersionControlRecursionType.FULL).getItems(); - var sha1 = items.stream() - .filter(x -> x.getGitObjectType() == GitObjectType.BLOB && x.getPath().equals("/Test.txt")) - .map(GitItem::getObjectId) - .findFirst() - .get(); - - g.getBlobContent(repoId, sha1, true, "test.txt", false); - } - - @Test - public void shouldGetABlobContentAsZip() throws AzDException { - var repoId = g.getRepository("testRepository").getId(); - var items = g.getItems(repoId, VersionControlRecursionType.FULL).getItems(); - var sha1 = items.stream() - .filter(x -> x.getGitObjectType() == GitObjectType.BLOB && x.getPath().equals("/Test.txt")) - .map(GitItem::getObjectId) - .findFirst() - .get(); - - var res = g.getBlobContentAsZip(repoId, sha1, true, "test.txt", false); - StreamHelper.download("blob.zip", res); - } - - @Test - public void shouldGetABlobContentAsStream() throws AzDException { - var repoId = g.getRepository("testRepository").getId(); - var items = g.getItems(repoId, VersionControlRecursionType.FULL).getItems(); - var sha1 = items.stream() - .filter(x -> x.getGitObjectType() == GitObjectType.BLOB && x.getPath().equals("/Test.txt")) - .map(GitItem::getObjectId) - .findFirst() - .get(); - - var res = g.getBlobContentAsStream(repoId, sha1, true, "test.txt", false); - StreamHelper.convertToString(res); -// StreamHelper.download("test.txt", res); - } - - @Test - public void shouldGetBlobsAsZip() throws AzDException { - var repoId = g.getRepository("testRepository").getId(); - var items = g.getItems(repoId, VersionControlRecursionType.FULL).getItems(); - var sha1 = items.stream() - .filter(x -> x.getGitObjectType() == GitObjectType.BLOB) - .map(GitItem::getObjectId) - .collect(Collectors.toList()); - var res = g.getBlobsZip(repoId, sha1); - StreamHelper.download("blobs.zip", res); - } - - @Test - public void shouldGetAllItems() throws AzDException { - g.getItems("testRepository", VersionControlRecursionType.FULL).getItems(); - } - - @Test - public void shouldGetAllItemsWithQueryParameters() throws AzDException { - g.getItems("testRepository", true, true, false, - VersionControlRecursionType.ONE_LEVEL_PLUS_NESTED_EMPTY_FOLDERS, "/docs").getItems(); - } - - @Test(expected = AzDException.class) - public void shouldCreateForkSyncRequest() throws AzDException { - g.createForkSyncRequest("testRepository", "00000000-0000-0000-0000-000000000000", "00000000-0000-0000-0000-000000000000", "00000000-0000-0000-0000-000000000000", true); - } - - @Test(expected = AzDException.class) - public void shouldCreateForkRepository() throws AzDException { - g.createForkRepository("testRepository", "00000000-0000-0000-0000-000000000000", "00000000-0000-0000-0000-000000000000", "00000000-0000-0000-0000-000000000000"); - } - - @Test(expected = AzDException.class) - public void shouldCreateForkRepositoryWithComplete() throws AzDException { - g.createForkRepositoryWithComplete("testRepository", "00000000-0000-0000-0000-000000000000", "00000000-0000-0000-0000-000000000000", "00000000-0000-0000-0000-000000000000", "main", 5); - } - - @Test - public void shouldGetForkSyncRequest() throws AzDException { - var r = g.getForkSyncRequests("testRepository", true, false); - if (r.getForkSyncRequest().size() > 0) { - var operationId = r.getForkSyncRequest().get(0).getOperationId(); - var res = g.getForkSyncRequest("testRepository", operationId, false); - assertTrue(res.getStatus() == GitAsyncOperationStatus.COMPLETED); - } - } - - @Test - public void shouldGetForkSyncRequests() throws AzDException { - g.getForkSyncRequests("testRepository", true, true); - } - - @Test - public void shouldGetForks() throws AzDException { - g.getForks("testRepository", "00000000-0000-0000-0000-000000000000", true); - } - - @Test - public void shouldGetGitPushes() throws AzDException { - var repo = g.getRepository("testRepository"); - g.getPushes(repo.getId()); - } - - @Test - public void shouldGetGitPullRequestStatuses() throws AzDException { - var repo = g.getRepository("testRepository"); - var pullRequestId = 8; - g.getPullRequestStatuses(pullRequestId, repo.getId()); - } - - @Test(expected = AzDException.class) - public void shouldCreateAGitPullRequestStatus() throws AzDException { - var repo = g.getRepository("testRepository"); - var pullRequestId = 0; - var gitPullRequestStatus = new GitStatus(); - gitPullRequestStatus.setContext(new GitStatusContext() {{ - setName("testStatus"); - }}); - g.createPullRequestStatus(pullRequestId, repo.getId(), gitPullRequestStatus); - } - - @Test - public void shouldGetGitPullRequestStatus() throws AzDException { - var repo = g.getRepository("testRepository"); - var pullRequestId = 8; - var status = g.getPullRequestStatuses(pullRequestId, repo.getId()).getStatuses().get(0); - g.getPullRequestStatus(pullRequestId, repo.getId(), status.getId()); - } - - @Test - @Ignore - public void shouldDeleteGitPullRequestStatus() throws AzDException { - var repo = g.getRepository("testRepository"); - var pullRequestId = 8; - // Create a new status - var gitPullRequestStatus = new GitStatus(); - gitPullRequestStatus.setContext(new GitStatusContext() {{ - setName("testStatus"); - }}); - var newStatus = g.createPullRequestStatus(pullRequestId, repo.getId(), gitPullRequestStatus); - - // remove - g.deletePullRequestStatus(pullRequestId, repo.getId(), newStatus.getId()); - } - - @Test - @Ignore - public void shouldUpdateGitPullRequestStatus() throws AzDException { - var repo = g.getRepository("testRepository"); - var pullRequestId = 8; - // Create a new status - var gitPullRequestStatus = new GitStatus(); - gitPullRequestStatus.setContext(new GitStatusContext() {{ - setName("testStatus"); - }}); - var newStatus = g.createPullRequestStatus(pullRequestId, repo.getId(), gitPullRequestStatus); - - // update (Update operation only supports removal of the pull request statuses) - var propertiesToUpdate = new JsonPatchDocument() {{ - setFrom(null); - setValue(null); - setOperation(PatchOperation.REMOVE); - setPath("/" + newStatus.getId()); - }}; - - g.updatePullRequestStatuses(pullRequestId, repo.getId(), List.of(propertiesToUpdate)); - } -} diff --git a/azd/src/test/java/org/azd/legacy/GraphApiTest.java b/azd/src/test/java/org/azd/legacy/GraphApiTest.java deleted file mode 100644 index 1a401b95..00000000 --- a/azd/src/test/java/org/azd/legacy/GraphApiTest.java +++ /dev/null @@ -1,170 +0,0 @@ -package org.azd.legacy; - -import org.azd.exceptions.AzDException; -import org.azd.graph.types.GraphGroup; -import org.azd.graph.types.GraphMembership; -import org.azd.graph.types.GraphMemberships; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.GraphDetails; -import org.azd.utils.AzDClientApi; -import org.junit.Before; -import org.junit.Ignore; -import org.junit.Test; - -import java.io.File; -import java.util.stream.Collectors; - -import static org.junit.Assert.*; -import static org.junit.Assume.assumeFalse; -import static org.junit.Assume.assumeTrue; - -public class GraphApiTest { - private static final JsonMapper MAPPER = new JsonMapper(); - private static AzDClient webApi; - private static GraphDetails g; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - g = webApi.getGraphApi(); - } - - @Test - public void shouldGetGraphUsers() throws AzDException { - g.getUsers().getUsers(); - } - - @Test - public void shouldGetAGraphUser() throws AzDException { - var user = g.getUsers().getUsers().stream().findFirst().get(); - var descriptor = user.getDescriptor(); - assertEquals(descriptor, g.getUser(descriptor).getDescriptor()); - } - - @Test - public void shouldCreateAGraphUser() throws AzDException { - var user = g.getUsers().getUsers().stream().findFirst().get(); - var descriptor = user.getDescriptor(); - var emailId = "test@gmail.com"; - g.createUser(emailId, descriptor); - } - - @Test - public void shouldGetGraphGroups() throws AzDException { - var group = g.getGroups().getGraphGroups().stream().filter(x -> x.getDisplayName().equals("Contributors")).findFirst().get(); - var expectedValue = "Contributors"; - assertEquals(expectedValue, group.getDisplayName()); - } - - @Test - public void shouldGetAGraphGroup() throws AzDException { - var group = g.getGroups().getGraphGroups().stream().filter(x -> x.getDisplayName().equals("Contributors")).findFirst().get(); - g.getGroup(group.getDescriptor()); - } - - @Test - public void shouldAddAUserToGroup() throws AzDException { - var group = g.getGroups().getGraphGroups().stream().filter(x -> x.getDisplayName().equals("Contributors")).findFirst().get(); - var emailId = "test@gmail.com"; - g.addUserToGroup(emailId, group.getDescriptor()); - } - - @Test - public void shouldDeleteAUser() throws AzDException { - var user = g.getUser("msa.YWE3YWY5MzQtYzcxMi03ODliLWJkMDEtZmRhMWQ4NjEzN2Rh"); - g.deleteUser(user.getDescriptor()); - } - - @Test - public void shouldGetMembersInGroup() throws AzDException { - var group = g.getGroups().getGraphGroups().stream().filter(x -> x.getDisplayName().equals("Contributors")).findFirst().get(); - GraphMemberships groupMembers = g.getGroupMembersOf(group.getDescriptor()); - assertFalse(groupMembers.getGraphMemberships().isEmpty()); - } - - @Test - public void shouldGetGroupsForUser() throws AzDException { - var user = g.getUsers().getUsers().stream().findAny().get(); - GraphMemberships memberGroups = g.getMemberOfGroups(user.getDescriptor()); - assertFalse(memberGroups.getGraphMemberships().isEmpty()); - } - - @Test - public void shouldGetBiDirectionalMemberRelationship() throws AzDException { - var group = g.getGroups().getGraphGroups().stream().filter(x -> x.getDisplayName().equals("Contributors")).findFirst().get(); - GraphMemberships groupMembers = g.getGroupMembersOf(group.getDescriptor()); - var userMembership = groupMembers.getGraphMemberships().stream().filter(g -> g.get_links().getMember().getHref().toLowerCase().contains("/graph/users/")).findAny(); - assumeTrue(userMembership.isPresent()); - var user = g.getUser(userMembership.get().getMemberDescriptor()); - GraphMemberships memberGroups = g.getMemberOfGroups(user.getDescriptor()); - assertTrue(memberGroups.getGraphMemberships().stream().anyMatch(g -> g.getContainerDescriptor().equals(group.getDescriptor()))); - } - - @Test - @Ignore - public void shouldAddSubjectToGroup() throws AzDException { - try { - var group = g.getGroups().getGraphGroups().stream().filter(x -> x.getDisplayName().equals("Contributors")).findFirst().get(); - var groupMembers = g.getGroupMembersOf(group.getDescriptor()).getGraphMemberships().stream().map(GraphMembership::getMemberDescriptor).collect(Collectors.toList()); - var allUsers = g.getUsers(); - var userNotInGroup = allUsers.getUsers().stream().filter(u -> !groupMembers.contains(u.getDescriptor())).findAny(); -// assumeTrue(userNotInGroup.isPresent()); -// GraphMembership graphMembership = g.addMembership(userNotInGroup.get().getDescriptor(), group.getDescriptor()); -// assertTrue(g.getGroupMembersOf(group.getDescriptor()).getGraphMemberships().stream().anyMatch(x -> x.getMemberDescriptor().equals(userNotInGroup.get().getDescriptor()))); -// System.out.println("Added " + userNotInGroup.get().getDescriptor() + " to " + group.getDescriptor()); - g.addMembership(userNotInGroup.get().getDescriptor(), group.getDescriptor()); - } catch (AzDException e) { - } - } - - @Test - public void removeSubjectFromGroup() throws AzDException { - var subjDesc = "svc.ZDNhMjJkYTUtNDljMC00OTQ5LTk4Y2MtZDM4ZmQzNzBkZmYzOkJ1aWxkOjgwYjQ4NjI2LTBiMjAtNGMyZi04NGE3LWQ2ZGEzMWVlMzQ2OQ"; - var group = g.getGroups().getGraphGroups().stream().filter(x -> x.getDisplayName().equals("Contributors")).findFirst().get(); -// var groupDesc = "vssgp.Uy0xLTktMTU1MTM3NDI0NS0zOTI3OTgxMTY4LTIzMDM3Mzk1Ny0yNzIwNTg1NjYxLTMyMTM5NDc3NzAtMS0yMTM0NTMyMjg3LTMwNTc4NTM3NjctMjU1MTY0NTQyMi02NzAyNTM2ODQ"; - g.removeMembership(subjDesc, group.getDescriptor()); - } - - @Test - public void shouldNotAddGroupToSelf() throws AzDException { - var group = g.getGroups().getGraphGroups().stream().filter(x -> x.getDisplayName().endsWith("Project Valid Users")).findFirst().get(); - assertNotNull(group); - g.addMembership(group.getDescriptor(), group.getDescriptor()); - var groupMembers = g.getGroupMembersOf(group.getDescriptor()); - assertFalse(groupMembers.getGraphMemberships().stream().anyMatch(x -> x.getMemberDescriptor().equals(group.getDescriptor()))); - } - - @Test - public void shouldAllowGroupInGroup() throws AzDException { - var group = g.getGroups().getGraphGroups().stream().filter(x -> x.getDisplayName().endsWith("Project Collection Administrators")).findFirst().get(); - var subject = g.getGroups().getGraphGroups().stream().filter(x -> x.getDisplayName().endsWith("Project-Scoped Users")).findFirst().get(); - var groupMembers = g.getGroupMembersOf(group.getDescriptor()); - assumeFalse(groupMembers.getGraphMemberships().stream().anyMatch(x -> x.getMemberDescriptor().equals(subject.getDescriptor()))); - g.addMembership(subject.getDescriptor(), group.getDescriptor()); - groupMembers = g.getGroupMembersOf(group.getDescriptor()); - assertTrue(groupMembers.getGraphMemberships().stream().anyMatch(x -> x.getMemberDescriptor().equals(subject.getDescriptor()))); - g.removeMembership(subject.getDescriptor(), group.getDescriptor()); - } - - @Test - public void shouldCreateGroup() throws AzDException { - var groupName = "my-new-org-group"; - GraphMembership group = g.createGroup(groupName, "this is a local org group"); - group.toString(); - } - - @Test - public void shouldRemoveGroup() throws AzDException { - var groupName = "my-new-org-group"; - GraphGroup graphGroup = g.getGroups().getGraphGroups().stream().filter(x -> x.getDisplayName().endsWith(groupName)).findAny().get(); - g.deleteGroup(graphGroup.getDescriptor()); - } - -} diff --git a/azd/src/test/java/org/azd/legacy/GraphCoreResolutionTest.java b/azd/src/test/java/org/azd/legacy/GraphCoreResolutionTest.java deleted file mode 100644 index 61c0ee7a..00000000 --- a/azd/src/test/java/org/azd/legacy/GraphCoreResolutionTest.java +++ /dev/null @@ -1,72 +0,0 @@ -package org.azd.legacy; - -import org.azd.exceptions.AzDException; -import org.azd.graph.types.GraphMembership; -import org.azd.graph.types.SubjectLookupResponse; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.CoreDetails; -import org.azd.interfaces.GraphDetails; -import org.azd.utils.AzDClientApi; -import org.junit.Before; -import org.junit.Ignore; -import org.junit.Test; - -import java.io.File; -import java.util.stream.Collectors; - -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertTrue; -import static org.junit.Assume.assumeFalse; - -/** - * additional tests for graph api which require other (Core) API components - * to perform object lookups - */ -@Ignore -public class GraphCoreResolutionTest { - private static final JsonMapper MAPPER = new JsonMapper(); - private static AzDClient webApi; - private static GraphDetails g; - private static CoreDetails c; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - g = webApi.getGraphApi(); - c = webApi.getCoreApi(); - } - - @Test - public void shouldResolveDescriptorForProject() throws AzDException { - var p = c.getProjects().getProjects().stream().findAny().get(); - var d = g.getDescriptor(p.getId()); - System.out.println(p.getName()); - System.out.println(d.getValue()); - } - - @Test - public void shouldLookupMultipleSubjects() throws AzDException { - var group = g.getGroups().getGraphGroups().stream().filter(x -> x.getDisplayName().equals("Contributors")).findAny().get(); - var members = g.getGroupMembersOf(group.getDescriptor()).getGraphMemberships(); - SubjectLookupResponse subjectLookupResponse = g.subjectLookup(members.stream().map(GraphMembership::getMemberDescriptor).collect(Collectors.toList()).toArray(new String[0])); - assertEquals(members.size(), subjectLookupResponse.getValue().size()); - } - - @Test - public void shouldCreateProjectGroup() throws AzDException { - var groupName = "my-new-group"; - var p = c.getProjects().getProjects().stream().filter(x -> x.getName().equals("My-Project")).findAny().get(); - var p_descriptor = g.getDescriptor(p.getId()).getValue(); - assumeFalse(g.getGroups().getGraphGroups().stream().anyMatch(x -> x.getDisplayName().endsWith(groupName))); - GraphMembership group = g.createGroup(groupName, "description for " + groupName, p_descriptor); - assertTrue(g.getGroups().getGraphGroups().stream().anyMatch(x -> x.getDisplayName().endsWith(groupName))); - } - -} diff --git a/azd/src/test/java/org/azd/legacy/MavenApiTest.java b/azd/src/test/java/org/azd/legacy/MavenApiTest.java deleted file mode 100644 index 8097121c..00000000 --- a/azd/src/test/java/org/azd/legacy/MavenApiTest.java +++ /dev/null @@ -1,296 +0,0 @@ -package org.azd.legacy; - -import org.azd.enums.PackagePromote; -import org.azd.enums.PackagesBatchOperation; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.helpers.StreamHelper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.FeedManagementDetails; -import org.azd.interfaces.MavenDetails; -import org.azd.maven.types.MavenPackageVersionDeletionState; -import org.azd.maven.types.Package; -import org.azd.maven.types.UpstreamingBehavior; -import org.azd.utils.AzDClientApi; -import org.junit.AfterClass; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.concurrent.TimeUnit; - -import static org.junit.Assert.*; - -public class MavenApiTest { - - private static final JsonMapper MAPPER = new JsonMapper(); - private static final String FEED = "maven-feed"; - private static final String TEST1_GROUP = "org.jack.click"; - private static final String TEST1_ARTIFACT = "ClickJack"; - private static final String TEST1_VERSION = "1.5.1"; - private static final String TEST2_GROUP = "org.tester.maven"; - private static final String TEST2_ARTIFACT = "MavenTester"; - private static final String TEST2_VERSION = "1.1.0"; - // Recycle bin Package - private static final String TEST3_GROUP = "org.HelloWorld"; - private static final String TEST3_ARTIFACT = "HelloWorld"; - private static final String TEST3_VERSION = "1.0.0"; - private static AzDClient webApi; - private static MavenDetails mvn; - private static FeedManagementDetails feed; - - @AfterClass - public static void restorePackage() { - try { - List packages = new ArrayList<>(); - - Map p1 = new HashMap<>(); - p1.put("group", TEST1_GROUP); - p1.put("artifact", TEST1_ARTIFACT); - p1.put("version", TEST1_VERSION); - packages.add(p1); - - Map p2 = new HashMap<>(); - p2.put("group", TEST2_GROUP); - p2.put("artifact", TEST2_ARTIFACT); - p2.put("version", TEST2_VERSION); - packages.add(p2); - - mvn.updateRecycleBinPackages(FEED, PackagesBatchOperation.RESTORETOFEED, packages); - } catch (Exception e) { - } - } - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - mvn = webApi.getMavenApi(); - feed = webApi.getFeedManagementApi(); - } - - @Test - public void shouldGetPackageVersion() throws AzDException { - System.out.println("Maven API TEST : getPackageVersion"); - Package testPackage = mvn.getPackageVersion(FEED, TEST1_GROUP, TEST1_ARTIFACT, TEST1_VERSION); - assertEquals(TEST1_GROUP + ":" + TEST1_ARTIFACT, testPackage.getName()); - assertEquals(TEST1_VERSION, testPackage.getVersion()); - System.out.println("Maven API TEST : getPackageVersion - OK"); - } - - @Test - public void shouldGetPackageVersionWithQueryParameters() throws AzDException { - System.out.println("Maven API TEST : getPackageVersion with query parameters"); - Package testPackage = mvn.getPackageVersion(FEED, TEST1_GROUP, TEST1_ARTIFACT, TEST1_VERSION, true); - assertEquals(TEST1_GROUP + ":" + TEST1_ARTIFACT, testPackage.getName()); - assertEquals(TEST1_VERSION, testPackage.getVersion()); - System.out.println("Maven API TEST : getPackageVersion with query parameters - OK"); - } - - @Test - public void shouldGetUpstreamingBehavior() throws AzDException { - System.out.println("Maven API TEST : getUpstreamingBehavior"); - UpstreamingBehavior behavior = mvn.getUpstreamingBehavior(FEED, TEST1_GROUP, TEST1_ARTIFACT); - assertTrue(behavior.getVersionsFromExternalUpstreams().equals("allowExternalVersions") || behavior.getVersionsFromExternalUpstreams().equals("auto")); - System.out.println("Maven API TEST : getUpstreamingBehavior - OK"); - } - - @Test - public void shouldSetUpstreamingBehavior() throws AzDException { - System.out.println("Maven API TEST : setUpstreamingBehavior"); - mvn.setUpstreamingBehavior(FEED, TEST1_GROUP, TEST1_ARTIFACT); - System.out.println("Maven API TEST : setUpstreamingBehavior - OK"); - } - - @Test - public void shouldClearUpstreamingBehavior() throws AzDException { - System.out.println("Maven API TEST : clearUpstreamingBehavior"); - mvn.clearUpstreamingBehavior(FEED, TEST1_GROUP, TEST1_ARTIFACT); - System.out.println("Maven API TEST : clearUpstreamingBehavior - OK"); - } - - @Test - public void shouldUpdatePackageVersion() throws AzDException { - System.out.println("Maven API TEST : updatePackageVersion"); - mvn.updatePackageVersion(FEED, TEST1_GROUP, TEST1_ARTIFACT, TEST1_VERSION, "Release"); - mvn.updatePackageVersion(FEED, TEST1_GROUP, TEST1_ARTIFACT, TEST1_VERSION, PackagePromote.PRERELEASE); - System.out.println("Maven API TEST : updatePackageVersion - OK"); - } - - @Test - public void shouldDeleteRestorePackageVersion() throws AzDException, InterruptedException { - System.out.println("Maven API TEST : deletePackageVersion"); - mvn.deletePackageVersion(FEED, TEST1_GROUP, TEST1_ARTIFACT, TEST1_VERSION); - TimeUnit.SECONDS.sleep(5); - System.out.println("Maven API TEST : deletePackageVersion - OK"); - - System.out.println("Maven API TEST : restorePackageVersionFromRecycleBin"); - mvn.restorePackageVersionFromRecycleBin(FEED, TEST1_GROUP, TEST1_ARTIFACT, TEST1_VERSION); - TimeUnit.SECONDS.sleep(5); - System.out.println("Maven API TEST : restorePackageVersionFromRecycleBin - OK"); - } - - @Test - public void shouldGetPackageVersionFromRecycleBin() throws AzDException { - System.out.println("Maven API TEST : shouldGetPackageVersionFromRecycleBin"); - try { - mvn.getPackageVersionFromRecycleBin(FEED, TEST3_GROUP, TEST3_ARTIFACT, TEST3_VERSION); - } catch(AzDException e) { } - System.out.println("Maven API TEST : shouldGetPackageVersionFromRecycleBin - OK"); - } - - @Test - public void shouldDownloadPackage() throws AzDException { - var feedId = feed.getFeed(FEED).getId(); - var responseStream = mvn.downloadPackage(feedId, TEST1_GROUP, TEST1_ARTIFACT, TEST1_VERSION, "ClickJack-1.5.1.jar"); - StreamHelper.download("ClickJack-1.5.1.jar", responseStream); - System.out.println("Maven API TEST : shouldDownloadPackage - OK"); - } - - @Test - public void shouldUploadPackage() throws AzDException { - var feedId = feed.getFeed(FEED).getId(); - var uploadVersion = TEST1_VERSION.substring(0, TEST1_VERSION.lastIndexOf(".")) + "." + (Integer.parseInt(TEST1_VERSION.substring(TEST1_VERSION.lastIndexOf(".") + 1)) + 1); - String uploadFileName = TEST1_ARTIFACT+"-"+uploadVersion+".jar"; - - var responseStream = mvn.downloadPackage(feedId, TEST1_GROUP, TEST1_ARTIFACT, TEST1_VERSION, "ClickJack-1.5.1.jar"); - StreamHelper.download(uploadFileName, responseStream); - - var content = StreamHelper.convertToStream(new File(uploadFileName)); - try{ - Package testPackage = mvn.getPackageVersion(FEED, TEST1_GROUP, TEST1_ARTIFACT, uploadVersion); - } catch(AzDException e){ // package not found - System.out.println("Maven API TEST : shouldUploadPackage"); - mvn.uploadPackage(FEED, TEST1_GROUP, TEST1_ARTIFACT, uploadVersion, uploadFileName, content); - System.out.println("Maven API TEST : shouldUploadPackage - OK"); - } - } - - @Test - public void shouldUpdatePackageVersions() throws AzDException, InterruptedException { - System.out.println("Maven API TEST : updatePackageVersions"); - List packages = new ArrayList<>(); - - Map p1 = new HashMap<>(); - p1.put("group", TEST1_GROUP); - p1.put("artifact", TEST1_ARTIFACT); - p1.put("version", TEST1_VERSION); - packages.add(p1); - - Map p2 = new HashMap<>(); - p2.put("group", TEST2_GROUP); - p2.put("artifact", TEST2_ARTIFACT); - p2.put("version", TEST2_VERSION); - packages.add(p2); - - try { - mvn.updatePackageVersions(FEED, "Release", PackagesBatchOperation.PROMOTE, packages); - mvn.updatePackageVersions(FEED, "Release", PackagesBatchOperation.DELETE, packages); - TimeUnit.SECONDS.sleep(3); - System.out.println("Maven API TEST : updatePackageVersions - OK"); - - System.out.println("Maven API TEST : updateRecycleBinPackages"); - mvn.updateRecycleBinPackages(FEED, PackagesBatchOperation.RESTORETOFEED, packages); - TimeUnit.SECONDS.sleep(3); - System.out.println("Maven API TEST : updateRecycleBinPackages - OK"); - } catch (AzDException ignored) {} - } - - @Test(expected = AzDException.class) // cannot be undone test - public void shouldDeletePackageVersionFromRecycleBin() throws AzDException { - System.out.println("Maven API TEST : deletePackageVersionFromRecycleBin"); - mvn.deletePackageVersionFromRecycleBin(FEED, TEST1_GROUP, TEST1_ARTIFACT, "0.0.0"); // cant not be undone - System.out.println("Maven API TEST : deletePackageVersionFromRecycleBin - OK"); - } - - // It should be test last. - public void shouldAllMavenFunction() throws AzDException, InterruptedException { - System.out.println("Maven API TEST : Integration Testing"); - - // 1. Single Package - // 1-1 GetPackageVersion - System.out.println("Maven API TEST : GetPackageVersion"); - Package testPackage = mvn.getPackageVersion(FEED, TEST1_GROUP, TEST1_ARTIFACT, TEST1_VERSION); - assertEquals(TEST1_GROUP + ":" + TEST1_ARTIFACT, testPackage.getName()); - assertEquals(TEST1_VERSION, testPackage.getVersion()); - System.out.println("Maven API TEST : GetPackageVersion - OK"); - - // 1-2. UpstreamingBehavior - System.out.println("Maven API TEST : UpstreamingBehavior"); - mvn.setUpstreamingBehavior(FEED, TEST1_GROUP, TEST1_ARTIFACT); - UpstreamingBehavior behavior = mvn.getUpstreamingBehavior(FEED, TEST1_GROUP, TEST1_ARTIFACT); - assertEquals(behavior.getVersionsFromExternalUpstreams(), "allowExternalVersions"); - - mvn.clearUpstreamingBehavior(FEED, TEST1_GROUP, TEST1_ARTIFACT); - behavior = mvn.getUpstreamingBehavior(FEED, TEST1_GROUP, TEST1_ARTIFACT); - assertEquals(behavior.getVersionsFromExternalUpstreams(), "auto"); - System.out.println("Maven API TEST : UpstreamingBehavior - OK"); - - // 1-3 Update Package Version - System.out.println("Maven API TEST : UpdatePackageVersion"); - mvn.updatePackageVersion(FEED, TEST1_GROUP, TEST1_ARTIFACT, TEST1_VERSION, "Release"); - System.out.println("Maven API TEST : UpdatePackageVersion - OK"); - - - // 1-4. DeletePackageVersion - System.out.println("Maven API TEST : DeletePackageVersion"); - mvn.deletePackageVersion(FEED, TEST1_GROUP, TEST1_ARTIFACT, TEST1_VERSION); - System.out.println("Maven API TEST : DeletePackageVersion - OK"); - - // 1-5. GetPackageVersions with deleted package - TimeUnit.SECONDS.sleep(3); - System.out.println("Maven API TEST : getPackageVersion with query parameters"); - testPackage = mvn.getPackageVersion(FEED, TEST1_GROUP, TEST1_ARTIFACT, TEST1_VERSION, true); - assertNotNull(testPackage.getDeletedDate()); - System.out.println("Maven API TEST : getPackageVersion with query parameters - OK"); - - // 1-6 GetPackageVersionFromRecycleBin - System.out.println("Maven API TEST : GetPackageVersionFromRecycleBin"); - MavenPackageVersionDeletionState testDeletePackage = mvn.getPackageVersionFromRecycleBin(FEED, TEST1_GROUP, TEST1_ARTIFACT, TEST1_VERSION); - assertNotNull(testDeletePackage.getDeletedDate()); - assertEquals(TEST1_ARTIFACT, testDeletePackage.getArtifactId()); - assertEquals(TEST1_VERSION, testDeletePackage.getVersion()); - System.out.println("Maven API TEST : GetPackageVersionFromRecycleBin - OK"); - - // 1-7 restorePackageVersionFromRecycleBin - mvn.restorePackageVersionFromRecycleBin(FEED, TEST1_GROUP, TEST1_ARTIFACT, TEST1_VERSION); - - - // 2. Multiple Packages - // 2-1. UpdatePackageVersions - - List packages = new ArrayList<>(); - - Map p1 = new HashMap<>(); - p1.put("group", TEST1_GROUP); - p1.put("artifact", TEST1_ARTIFACT); - p1.put("version", TEST1_VERSION); - packages.add(p1); - - Map p2 = new HashMap<>(); - p2.put("group", TEST2_GROUP); - p2.put("artifact", TEST2_ARTIFACT); - p2.put("version", TEST2_VERSION); - packages.add(p2); - - mvn.updatePackageVersions(FEED, "Release", PackagesBatchOperation.PROMOTE, packages); - mvn.updatePackageVersions(FEED, "Release", PackagesBatchOperation.DELETE, packages); - System.out.println("Maven API TEST : UpdatePackageVersions - OK"); - - // 2-2. UpdateRecycleBinPackages - System.out.println("Maven API TEST : UpdateRecycleBinPackages"); - mvn.updateRecycleBinPackages(FEED, PackagesBatchOperation.RESTORETOFEED, packages); - System.out.println("Maven API TEST : UpdateRecycleBinPackages - OK"); - - System.out.println("Maven API TEST : Integration Testing - OK"); - } -} \ No newline at end of file diff --git a/azd/src/test/java/org/azd/legacy/MemberEntitlementManagementApiTest.java b/azd/src/test/java/org/azd/legacy/MemberEntitlementManagementApiTest.java deleted file mode 100644 index f264fd2b..00000000 --- a/azd/src/test/java/org/azd/legacy/MemberEntitlementManagementApiTest.java +++ /dev/null @@ -1,81 +0,0 @@ -package org.azd.legacy; - -import org.azd.enums.AccountLicenseType; -import org.azd.enums.GroupType; -import org.azd.enums.LicensingSource; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.CoreDetails; -import org.azd.interfaces.MemberEntitlementManagementDetails; -import org.azd.utils.AzDClientApi; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; - -public class MemberEntitlementManagementApiTest { - private static final JsonMapper MAPPER = new JsonMapper(); - private static AzDClient webApi; - private static MemberEntitlementManagementDetails mem; - private static CoreDetails c; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - mem = webApi.getMemberEntitlementManagementApi(); - c = webApi.getCoreApi(); - } - - @Test - public void shouldGetGroupEntitlements() throws AzDException { - mem.getGroupEntitlements(); - } - - @Test(expected = AzDException.class) - public void shouldGetGroupEntitlement() throws AzDException { - mem.getGroupEntitlement("0000-000000-0000-0000-0000"); - } - - @Test - public void shouldGetUsersEntitlementSummary() throws AzDException { - mem.getUserEntitlementSummary(); - } - - @Test - public void shouldAddUserEntitlement() throws AzDException { - var p = c.getProject("azure-devops-java-sdk"); - mem.addUserEntitlement(AccountLicenseType.EXPRESS, - "test@xmail.com", GroupType.PROJECT_CONTRIBUTOR, p.getId()); - } - - @Test - public void shouldGetUsersEntitlements() throws AzDException { - mem.getUserEntitlements(); - } - - @Test - public void shouldUpdateUsersEntitlement() throws AzDException { - var userId = mem.getUserEntitlements().getUsers().stream() - .filter(x -> x.getUser().getDisplayName().equals("test@xmail.com")) - .findFirst().get().getId(); - - mem.updateUserEntitlement(userId, AccountLicenseType.STAKEHOLDER, LicensingSource.ACCOUNT); - } - - @Test(expected = AzDException.class) - public void shouldDeleteUsersEntitlement() throws AzDException { -// var userId = mem.getUserEntitlements().getMembers().stream() -// .filter(x -> x.getUser().getDisplayName().equals("test@xmail.com")) -// .findFirst().get().getId(); - // Muting it as it is clashing with other tests - mem.deleteUserEntitlement("0000-00000-00000-000000-000000"); - } - -} diff --git a/azd/src/test/java/org/azd/legacy/MockParameters.java b/azd/src/test/java/org/azd/legacy/MockParameters.java deleted file mode 100644 index 9c773b5e..00000000 --- a/azd/src/test/java/org/azd/legacy/MockParameters.java +++ /dev/null @@ -1,31 +0,0 @@ -package org.azd.legacy; - -public class MockParameters { - private String o; - private String t; - private String p; - - public String getO() { - return o; - } - - public void setO(String o) { - this.o = o; - } - - public String getT() { - return t; - } - - public void setT(String t) { - this.t = t; - } - - public String getP() { - return p; - } - - public void setP(String p) { - this.p = p; - } -} diff --git a/azd/src/test/java/org/azd/legacy/PipelinesTest.java b/azd/src/test/java/org/azd/legacy/PipelinesTest.java deleted file mode 100644 index 874d25d3..00000000 --- a/azd/src/test/java/org/azd/legacy/PipelinesTest.java +++ /dev/null @@ -1,84 +0,0 @@ -package org.azd.legacy; - -import org.azd.enums.PipelinesExpandOptions; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.GitDetails; -import org.azd.interfaces.PipelinesDetails; -import org.azd.utils.AzDClientApi; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; - -public class PipelinesTest { - private static final JsonMapper MAPPER = new JsonMapper(); - private static AzDClient webApi; - private static GitDetails g; - private static PipelinesDetails p; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - p = webApi.getPipelinesApi(); - g = webApi.getGitApi(); - } - - @Test - public void shouldGetArtifacts() throws AzDException { - p.getArtifacts(8, 661, "drop"); - } - - @Test - public void shouldGetArtifactsWithContentsExpanded() throws AzDException { -// String url = p.getArtifacts(8, 531, "drop", PipelinesArtifactExpandOptions.SIGNEDCONTENT).getSignedContent().getUrl(); -// new FileOutputStream("drop.zip").getChannel().transferFrom(Channels.newChannel( -// new URL(url).openStream()), 0, Long.MAX_VALUE); - p.getArtifacts(8, 661, "drop", PipelinesExpandOptions.SIGNEDCONTENT); - } - - @Test - public void shouldGetPipelines() throws AzDException { - p.getPipelines(); - } - - @Test - public void shouldGetPipelineLog() throws AzDException { - p.getPipelineLog(8, 661, 1); - } - - @Test - public void shouldGetPipelineLogWithOptions() throws AzDException { - p.getPipelineLog(8, 661, 1, PipelinesExpandOptions.SIGNEDCONTENT); - } - - @Test - public void shouldGetPipelineLogs() throws AzDException { - p.getPipelineLogs(8, 661); - } - - // Should throw PipelineExistsException; - // Modify this test if the pipeline doesn't exist to create a new one. - @Test(expected = AzDException.class) - public void shouldCreateAPipeline() throws AzDException { - String repoId = g.getRepository("newRepo").getId(); - p.createPipeline("Demo-Pipeline-CI", "/", "/azure-pipelines.yaml", repoId, "newRepo"); - } - - @Test - public void shouldPreviewADryRunAndReturnYaml() throws AzDException { - p.previewPipeline(25, true); - } - - @Test - public void shouldRunAnExistingPipeline() throws AzDException { - p.runPipeline(25); - } -} diff --git a/azd/src/test/java/org/azd/legacy/PolicyApiTest.java b/azd/src/test/java/org/azd/legacy/PolicyApiTest.java deleted file mode 100644 index fc5c2742..00000000 --- a/azd/src/test/java/org/azd/legacy/PolicyApiTest.java +++ /dev/null @@ -1,96 +0,0 @@ -package org.azd.legacy; - -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.GitDetails; -import org.azd.interfaces.PolicyDetails; -import org.azd.utils.AzDClientApi; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; -import java.util.ArrayList; -import java.util.HashMap; - -public class PolicyApiTest { - private static final JsonMapper MAPPER = new JsonMapper(); - private static PolicyDetails p; - private static GitDetails g; - private static AzDClient webApi; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - p = webApi.getPolicyApi(); - g = webApi.getGitApi(); - } - - @Test(expected = AzDException.class) - public void shouldCreatePolicyConfiguration() throws AzDException { - String repoId = g.getRepository("azure-devops-java-sdk").getId(); - var scope = new ArrayList<>(); - var obj = new HashMap() {{ - put("repositoryId", repoId); - put("refName", "refs/heads/develop"); - put("matchKind", "exact"); - }}; - - scope.add(obj); - - var settings = new HashMap() {{ - put("minimumApproverCount", 1); - put("creatorVoteCounts", false); - put("scope", scope); - }}; - - p.createPolicyConfiguration("fa4e907d-c16b-4a4c-9dfa-4906e5d171dd", true, false, settings); - } - - @Test - public void shouldGetPolicyConfigurations() throws AzDException { - p.getPolicyConfigurations().getPolicyConfigurations(); - } - - @Test - public void shouldGetPolicyConfiguration() throws AzDException { - p.getPolicyConfiguration(1); - } - - @Test - public void shouldUpdatePolicyConfiguration() throws AzDException { - String repoId = g.getRepository("azure-devops-java-sdk").getId(); - var scope = new ArrayList<>(); - var obj = new HashMap() {{ - put("repositoryId", repoId); - put("refName", "refs/heads/develop"); - put("matchKind", "exact"); - }}; - - scope.add(obj); - - var settings = new HashMap() {{ - put("minimumApproverCount", 1); - put("creatorVoteCounts", false); - put("scope", scope); - }}; - - p.updatePolicyConfiguration(1, "fa4e907d-c16b-4a4c-9dfa-4906e5d171dd", true, false, settings); - } - - @Test - public void shouldGetPolicyTypes() throws AzDException { - p.getPolicyTypes().getPolicyTypes(); - } - - @Test - public void shouldGetPolicyType() throws AzDException { - p.getPolicyType("fa4e907d-c16b-4a4c-9dfa-4906e5d171dd"); - } -} diff --git a/azd/src/test/java/org/azd/legacy/ReleaseApiTest.java b/azd/src/test/java/org/azd/legacy/ReleaseApiTest.java deleted file mode 100644 index 6d3daea9..00000000 --- a/azd/src/test/java/org/azd/legacy/ReleaseApiTest.java +++ /dev/null @@ -1,150 +0,0 @@ -package org.azd.legacy; - -import org.azd.enums.ReleaseApprovalStatus; -import org.azd.enums.SingleReleaseExpands; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.BuildDetails; -import org.azd.interfaces.ReleaseDetails; -import org.azd.release.types.ConfigurationVariableValue; -import org.azd.utils.AzDClientApi; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; -import java.util.HashMap; - -public class ReleaseApiTest { - private static final JsonMapper MAPPER = new JsonMapper(); - private static AzDClient webApi; - private static ReleaseDetails r; - private static BuildDetails b; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - r = webApi.getReleaseApi(); - b = webApi.getBuildApi(); - } - - @Test - public void shouldCreateARelease() throws AzDException { - var build = b.getBuild(176); - r.createRelease(2, "Sample Release", "_Demo-Pipeline-CI", build.getBuildNumber(), - "Demo-CI", false); - } - - @Test - public void shouldGetAllReleases() throws AzDException { - r.getReleases(); - } - - @Test - public void shouldGetARelease() throws AzDException { - var rId = r.getReleases().getReleases().stream().findFirst().get().getId(); - r.getRelease(rId); - } - - @Test - public void shouldGetReleaseEnvironmentDetails() throws AzDException { - var rId = r.getReleases().getReleases().stream().findFirst().get().getId(); - var res = r.getRelease(rId, SingleReleaseExpands.TASKS); - r.getReleaseEnvironment(res.getId(), res.getEnvironments().stream().findFirst().get().getId()); - } - - @Test - public void shouldGetAllReleaseDefinitions() throws AzDException { - r.getReleaseDefinitions(); - } - - @Test - public void shouldGetAReleaseDefinition() throws AzDException { - r.getReleaseDefinition(2); - } - - @Test - public void shouldGetReleaseDefinitionHistory() throws AzDException { - r.getReleaseDefinitionHistory(2); - } - - @Test - public void shouldDeleteARelease() throws AzDException { - var build = b.getBuild(176); - var release = r.createRelease(2, "Sample Release", "_Demo-Pipeline-CI", build.getBuildNumber(), - "Demo-CI", false); - r.deleteRelease(release.getId()); - } - - @Test(expected = AzDException.class) - public void shouldQueueAReleaseWithEnvironmentName() throws AzDException { - r.queueRelease(354, "D"); - } - - @Test(expected = AzDException.class) - public void shouldAbandonARelease() throws AzDException { - // Expected :- InvalidRequestException: VS402966: Transitioning of release from state 'Abandoned' to state 'Abandoned' is not allowed. - r.abandonRelease(355); - } - - @Test - public void shouldGetReleaseApprovals() throws AzDException { - r.getReleaseApprovals(); - } - - @Test - public void shouldUpdateARelease() throws AzDException { - var releaseId = r.getReleases().getReleases() - .stream() - .filter(rel -> rel.getReleaseDefinition().getName().equals("Demo-CD")) - .findFirst() - .get() - .getId(); - - var release = r.getRelease(releaseId); - - release.getVariables().get("Name").setIsSecret(true); - - r.updateRelease(release.getId(), release); - } - - @Test(expected = AzDException.class) - public void shouldUpdateReleaseApprovals() throws AzDException { - r.updateApproval(2, ReleaseApprovalStatus.APPROVED, "Good to go"); - } - - @Test - public void shouldGetManualInterventions() throws AzDException { - var releaseId = r.getReleases().getReleases().get(0).getId(); - r.getManualInterventions(releaseId); - } - - @Test - public void shouldUpdateAReleaseDefinitionOrPipeline() throws AzDException { - try { - var releaseDef = r.getReleaseDefinition(2); - - // Set the releases to keep in environment retention policy. - releaseDef.getEnvironments().stream().findFirst().get().getRetentionPolicy().setReleasesToKeep(4); - - // Set the new value to the variables. - var c = new ConfigurationVariableValue(); - c.setValue("NewCustomValue"); - - var variables = new HashMap() {{ - put("Name", c); - }}; - - releaseDef.setVariables(variables); - - r.updateReleaseDefinition(releaseDef); - } catch (AzDException ignore) { - } - } -} diff --git a/azd/src/test/java/org/azd/legacy/RestClientTest.java b/azd/src/test/java/org/azd/legacy/RestClientTest.java deleted file mode 100644 index b314ce44..00000000 --- a/azd/src/test/java/org/azd/legacy/RestClientTest.java +++ /dev/null @@ -1,94 +0,0 @@ -package org.azd.legacy; - -import org.azd.build.types.Builds; -import org.azd.common.ApiVersion; -import org.azd.common.ResourceId; -import org.azd.enums.CustomHeader; -import org.azd.enums.Instance; -import org.azd.enums.RequestMethod; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.utils.AzDClientApi; -import org.azd.utils.RestClient; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; -import java.text.MessageFormat; -import java.util.HashMap; -import java.util.Map; - -@Deprecated(since = "v6.0") -public class RestClientTest { - private static final JsonMapper MAPPER = new JsonMapper(); - private static AzDClientApi webApi; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - } - - @Test - public void shouldCallBuildApiAndReturnAllBuilds() throws AzDException { - // GET https://dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=7.1-preview.7 - // The base instance returns -> https://dev.azure.com/ - var requestUrl = MessageFormat.format("{0}/{1}/{2}/_apis/build/builds?api-version={3}", - Instance.BASE_INSTANCE.getInstance(), webApi.getConnection().getOrganization(), - webApi.getConnection().getProject(), ApiVersion.BUILD); - // Pass the request url, connection object, request method, request body (in this case it is null), - // content type (json), whether to look for redirect url or not and in this case it is false. - var response = RestClient.send(requestUrl, webApi.getConnection(), RequestMethod.GET, - null, CustomHeader.JSON, false); - - // Now that we the response, we can deserialize the json and convert it to POJO. - var mapper = new JsonMapper(); - var builds = mapper.mapJsonResponse(response, Builds.class); - - builds.getBuildResults().get(0).getDefinition().getName(); - } - - @Test - public void shouldListAllTestRuns() throws AzDException { - // GET GET https://dev.azure.com/{organization}/{project}/_apis/test/runs?api-version=7.1-preview.3 - // The base instance returns -> https://dev.azure.com/ - // Request method -> Get, connection object, resource id, project, area, id, resource, apiVersion, query string, - // request body (for post/put/patch) and content type -> defaults to "Accept": "application/json". - // optionally we can set the custom headers by calling setCustomHeaders(name, value). - // Adding query string - // If there are more than one query string, you can create a HashMap() and add the query parameters. - var response = RestClient.send(RequestMethod.GET, webApi.getConnection(), ResourceId.TEST, webApi.getConnection().getProject(), - "test/runs", null, null, ApiVersion.TEST_RUNS, - Map.of("includeRunDetails", true), null, null); - - // If there is no definition found you can create your own definition class and deserialize it or - // convert it to jsonNode. - var mapper = new JsonMapper(); - var jsonNode = mapper.convertToJson(response); - // Test - Runs returns an array of results in {"count": , "value": []} format - jsonNode.get("value").get(0); - } - - @Test - public void shouldUpdateBuildGeneralSettings() throws AzDException { - // https://learn.microsoft.com/en-us/rest/api/azure/devops/build/general-settings/update?view=azure-devops-rest-7.1 - // PATCH https://dev.azure.com/{organization}/{project}/_apis/build/generalsettings?api-version=7.1-preview.1 - - var requestBody = new HashMap() {{ - put("publishPipelineMetadata", false); - put("enforceReferencedRepoScopedToken", true); - put("statusBadgesArePrivate", false); - }}; - - var response = RestClient.send(RequestMethod.PATCH, webApi.getConnection(), ResourceId.BUILD, webApi.getConnection().getProject(), - "build/generalsettings", null, null, "7.1-preview.1", null, requestBody, - CustomHeader.JSON_CONTENT_TYPE); - - System.out.println(response); - } -} diff --git a/azd/src/test/java/org/azd/legacy/SecurityApiTest.java b/azd/src/test/java/org/azd/legacy/SecurityApiTest.java deleted file mode 100644 index 4492f6d2..00000000 --- a/azd/src/test/java/org/azd/legacy/SecurityApiTest.java +++ /dev/null @@ -1,415 +0,0 @@ -package org.azd.legacy; - -import org.azd.core.CoreApi; -import org.azd.core.types.Project; -import org.azd.exceptions.AzDException; -import org.azd.git.GitApi; -import org.azd.git.types.GitRepository; -import org.azd.graph.GraphApi; -import org.azd.graph.types.GraphGroup; -import org.azd.graph.types.GraphUser; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.*; -import org.azd.pipelines.PipelinesApi; -import org.azd.pipelines.types.Pipeline; -import org.azd.security.SecurityToken; -import org.azd.security.types.*; -import org.azd.utils.AzDClientApi; -import org.junit.Assume; -import org.junit.Before; -import org.junit.Ignore; -import org.junit.Test; - -import java.io.File; -import java.util.*; -import java.util.stream.Stream; - -import static org.junit.Assert.*; -import static org.junit.Assume.assumeFalse; -import static org.junit.Assume.assumeTrue; - -public class SecurityApiTest { - private static final JsonMapper MAPPER = new JsonMapper(); - private static AzDClient webApi; - private static SecurityDetails s; - - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); -// String project = m.getP(); - String project = "My-Project"; - webApi = new AzDClientApi(organization, project, token); - s = webApi.getSecurityApi(); - } - - @Test - public void shouldListSecurityNamespaces() throws AzDException { - SecurityNamespaces securityNamespaces = s.getNamespaces(); - assertFalse(securityNamespaces.getSecurityNamespaces().isEmpty()); - } - - @Test - public void shouldGetANamespace() throws AzDException { - var namespace = "Git Repositories"; - SecurityNamespace securityNamespace = s.getNamespaces().getSecurityNamespaces().stream().filter(x -> x.getDisplayName().equals(namespace)).findFirst().get(); - SecurityNamespace securityNamespace1 = s.getNamespace(securityNamespace.getNamespaceId()); - assertEquals(securityNamespace.getDisplayName(), securityNamespace1.getDisplayName()); - } - - @Test - public void shouldListACLs() throws AzDException { - var namespace = "Git Repositories"; - SecurityNamespace securityNamespace = s.getNamespaces().getSecurityNamespaces().stream().filter(x -> x.getDisplayName().equals(namespace)).findFirst().get(); - ACLs acLs = s.getAccessControlLists(securityNamespace.getNamespaceId()); - assertFalse(acLs.getACLs().isEmpty()); - Optional no_extended = acLs.getACLs().stream().filter(x -> x.getAcesDictionary().values().stream().anyMatch(y -> y.getExtendedInfo() == null)).findAny(); - assertTrue(no_extended.isPresent()); - } - - @Test - public void shouldListACLsWithExtendedInfo() throws AzDException { - var namespace = "Git Repositories"; - CoreDetails coreApi = webApi.getCoreApi(); - Optional anyProject = coreApi.getProjects().getProjects().stream().findAny(); - Assume.assumeTrue(anyProject.isPresent()); - SecurityNamespace securityNamespace = s.getNamespaces().getSecurityNamespaces().stream().filter(x -> x.getDisplayName().equals(namespace)).findFirst().get(); - String token = SecurityToken.generate(SecurityToken.Scope.Collection, Map.of()); - //String token = SecurityToken.generate(SecurityToken.Scope.GIT, Map.of("PROJECT_ID", anyProject.get().getId())); - ACLs acLs = s.getAccessControlLists(securityNamespace.getNamespaceId(), null, token, true, false); - assertFalse(acLs.getACLs().isEmpty()); - Optional any = acLs.getACLs().stream().filter(x -> x.getAcesDictionary().values().stream().anyMatch(y -> y.getExtendedInfo() != null && y.getExtendedInfo().getEffectiveAllow() != null)).findAny(); - assertTrue(any.isPresent()); - } - - @Test - public void shouldResolveSubjectIdentities() throws AzDException { - final Map expectedIdentifierDomain = Map.of( - "aad", "Microsoft.IdentityModel.Claims.ClaimsIdentity", - "svc", "Microsoft.TeamFoundation.ServiceIdentity", - "bnd", "Microsoft.TeamFoundation.BindPendingIdentity", - "vssgp", "Microsoft.TeamFoundation.Identity", - "aadgp", "Microsoft.TeamFoundation.Identity" - ); - GraphDetails g = webApi.getGraphApi(); - var allusers = g.getUsers().getUsers(); - var allgroups = g.getGroups().getGraphGroups(); - List allIdentifiers = new ArrayList<>(); - for (String prefix : expectedIdentifierDomain.keySet()) { - var u_opt = allusers.stream().map(GraphUser::getDescriptor); - var g_opt = allgroups.stream().map(GraphGroup::getDescriptor); - Optional any = Stream.concat(u_opt, g_opt).filter(x -> x.startsWith(prefix)).findAny(); - if (any.isPresent()) allIdentifiers.add(any.get()); - } - Identities identitiesFromSubjectDescriptors = s.getIdentitiesFromSubjectDescriptors(allIdentifiers.toArray(new String[0])); - for (Identity identity : identitiesFromSubjectDescriptors.getIdentities()) { - var prefix = identity.getSubjectDescriptor().split("\\.")[0]; - assertTrue(expectedIdentifierDomain.containsKey(prefix)); - assertTrue(identity.getDescriptor().startsWith(expectedIdentifierDomain.get(prefix))); - } - } - - - @Test - public void shouldListACLForDescriptor() throws AzDException { - GraphDetails g = webApi.getGraphApi(); - CoreDetails c = webApi.getCoreApi(); - - Optional aadUser = g.getUsers().getUsers().stream().filter(x -> x.getDescriptor().startsWith("aad")).findAny(); - assumeTrue(aadUser.isPresent()); - Project project = c.getProject("my-awesome-project"); - assumeTrue(project != null); - var namespace = "Git Repositories"; - SecurityNamespace securityNamespace = s.getNamespaces().getSecurityNamespaces().stream().filter(x -> x.getDisplayName().equals(namespace)).findFirst().get(); - - - ACLs acLs = s.getAccessControlLists(securityNamespace.getNamespaceId(), new String[]{aadUser.get().getDescriptor()}, null, false, false); - assertNotNull(acLs.getACLs()); - assertFalse(acLs.getACLs().isEmpty()); - } - - /** - * not really a test. Dump all actions to see bitmasks - * - * @throws AzDException - */ - @Test - @Ignore - public void shouldDumpAllNamespaceActions() throws AzDException { - List securityNamespaces = s.getNamespaces().getSecurityNamespaces(); - for (SecurityNamespace ns : securityNamespaces) { - System.out.println("Namespace: " + ns.getDisplayName()); - ns.getActions().stream().forEach(x -> { - System.out.println(" Action: " + x.getDisplayName() + " (" + x.getBit() + ")"); - }); - } - } - - @Test - public void shouldGenerateTokenString() throws AzDException { - String expected; - String generated = SecurityToken.generate(SecurityToken.Scope.GIT, Map.of()); - expected = "repoV2"; - assertEquals(expected, generated); - String generated2 = SecurityToken.generate(SecurityToken.Scope.GIT, Map.of( - "PROJECT_ID", "my-project-id", - "REPO_ID", "repository-id" - )); - expected = "repoV2/my-project-id/repository-id"; - assertEquals(expected, generated2); - } - - @Test - public void shouldListRequiredTokenProperties() throws AzDException { - Set keys = SecurityToken.keys(SecurityToken.Scope.GIT); - assertEquals(2, keys.size()); - assertTrue(keys.contains("PROJECT_ID")); - assertTrue(keys.contains("REPO_ID")); - } - - @Test(expected = AssertionError.class) - public void shouldAddAndRemoveACL() throws AzDException { - CoreDetails coreApi = webApi.getCoreApi(); - PipelinesDetails pipelinesApi = webApi.getPipelinesApi(); - GraphDetails graphApi = webApi.getGraphApi(); - long allowMask = 1 + 2 + 4 + 256 + 1024; - long denyMask = 8 + 16 + 32; - - // create a group - graphApi.createGroup("test-acl-group", "test group created to grant new permissions"); - Optional groupOptional = graphApi.getGroups().getGraphGroups().stream().filter(x -> x.getDisplayName().equals("test-acl-group")).findAny(); - assertTrue(groupOptional.isPresent()); - Identities identitiesFromSubjectDescriptors = s.getIdentitiesFromSubjectDescriptors(groupOptional.get().getDescriptor()); - assertTrue(identitiesFromSubjectDescriptors.getIdentities().size() == 1); - String descriptor = identitiesFromSubjectDescriptors.getIdentities().stream().findFirst().get().getDescriptor(); - System.out.println(groupOptional.get().getDescriptor() + " ==> " + descriptor); - - // random project - Optional projectOptional = coreApi.getProjects().getProjects().stream().filter(x -> x.getName().equals("My-Project")).findAny(); - assumeTrue(projectOptional.isPresent()); - Map tokenParameters = new HashMap<>() {{ - put("PROJECT_ID", projectOptional.get().getId()); - }}; - Optional pipelineOptional = pipelinesApi.getPipelines().getPipelines().stream().findAny(); - if (pipelineOptional.isPresent()) { - tokenParameters.put("BUILD_DEFINITION_ID", Integer.toString(pipelineOptional.get().getId())); - } - String projectBuildToken = SecurityToken.generate(SecurityToken.Scope.Build, tokenParameters); - System.out.println("Generated token: " + projectBuildToken); - - ACLs accessControlLists = s.getAccessControlLists(SecurityToken.Scope.Build.getNamespace(), new String[]{descriptor}, projectBuildToken, false, false); - assertTrue(accessControlLists.getACLs() == null || accessControlLists.getACLs().isEmpty()); - System.out.println("ACLS: " + accessControlLists); - - ACL newEntry = new ACL(); - ACE ace = new ACE(); - ace.setDescriptor(descriptor); - ace.setAllow(allowMask); - ace.setDeny(denyMask); - newEntry.setToken(projectBuildToken); - newEntry.setInheritPermissions(false); - newEntry.setAcesDictionary(Map.of(descriptor, ace)); - ACLs newEntrySet = new ACLs(); - newEntrySet.setACLs(List.of(newEntry)); - try { - s.setAccessControlList(SecurityToken.Scope.Build.getNamespace(), newEntrySet); - Thread.sleep(5000l); // may occasionally fail if we don't wait long enough after removal - ACLs updatedACL = s.getAccessControlLists(SecurityToken.Scope.Build.getNamespace(), new String[]{descriptor}, projectBuildToken, false, false); - assertTrue(updatedACL.getACLs() != null && updatedACL.getACLs().size() == 1); - s.removeAccessControlLists(SecurityToken.Scope.Build.getNamespace(), false, new String[]{projectBuildToken}); - Thread.sleep(5000l); // may occasionally fail if we don't wait long enough after removal - ACLs removedACLs = s.getAccessControlLists(SecurityToken.Scope.Build.getNamespace(), new String[]{descriptor}, projectBuildToken, false, false); - assertTrue(removedACLs.getACLs() == null || removedACLs.getACLs().isEmpty()); - } catch (InterruptedException e) { - // ignore - } finally { - graphApi.deleteGroup(groupOptional.get().getDescriptor()); - } - } - - /** - * - lookup a user and a repository - * - get current ACL - * - update ACL - * - re-fetch ACL and compare, assert allow / deny value changed - * - reset ACL - * - * @throws AzDException - */ - @Test - public void shouldUpdateAccessControlList() throws AzDException { - GraphDetails graphApi = webApi.getGraphApi(); - - long allowMask = 1 + 2 + 4 + 256 + 1024; - long denyMask = 8 + 16 + 32; - Optional userOptional = graphApi.getUsers().getUsers().stream().findAny(); - assumeTrue(userOptional.isPresent()); - - Identities identitiesFromSubjectDescriptors = s.getIdentitiesFromSubjectDescriptors(userOptional.get().getDescriptor()); - String descriptor = identitiesFromSubjectDescriptors.getIdentities().stream().findFirst().get().getDescriptor(); - System.out.println(userOptional.get().getDescriptor() + " ==> " + descriptor); - - // scan all ACLs and find one matching our (randomly selected) descriptor - // copy it with different permissions - List accessControlLists = s.getAccessControlLists(SecurityToken.Scope.GIT.getNamespace(), new String[]{descriptor}, null, false, false).getACLs(); - assumeFalse(accessControlLists.isEmpty()); - //accessControlLists.stream().forEach(x -> { - // System.out.println("ACL: " + x.getToken() + " " + x.getAcesDictionary().keySet().size()); - //}); - ACL existingACL = accessControlLists.stream().findAny().get(); - System.out.println("Token: " + existingACL.getToken()); - ACE currentACE = existingACL.getAcesDictionary().get(descriptor); - ACL newACL = new ACL(); - newACL.setToken(existingACL.getToken()); - ACE entry = new ACE(); - entry.setDescriptor(descriptor); - if (allowMask == currentACE.getAllow()) { - // flip a bit in case allow is already the same - allowMask = allowMask ^ (Math.round(Math.random()) % 1025); - } - entry.setAllow(allowMask); - if (denyMask == currentACE.getDeny()) { - denyMask = denyMask ^ (Math.round(Math.random()) % 1025); - } - entry.setDeny(denyMask); - newACL.setAcesDictionary(Map.of(descriptor, entry)); - ACLs newAclSet = new ACLs(); - newAclSet.setACLs(List.of(newACL)); - try { - s.setAccessControlList(SecurityToken.Scope.GIT.getNamespace(), newAclSet); - try { - Thread.sleep(5000l); // delay to allow change to take effect - } catch (InterruptedException e) { - } - ACLs updatedControlLists = s.getAccessControlLists(SecurityToken.Scope.GIT.getNamespace(), new String[]{descriptor}, existingACL.getToken(), false, false); - //updatedControlLists.getACLs().stream().forEach(x -> { - // System.out.println("Updated ACL: " + x.getToken() + " " + x.getAcesDictionary().keySet().size()); - //}); - - for (ACL updatedAcl : updatedControlLists.getACLs()) { - Optional originalAcl = accessControlLists.stream().filter(x -> x.getToken().equals(updatedAcl.getToken()) && x.getAcesDictionary().containsKey(descriptor)).findAny(); - assertTrue(originalAcl.isPresent()); - assertTrue(updatedAcl.getAcesDictionary().containsKey(descriptor)); -// assertNotEquals(updatedAcl.getAcesDictionary().get(descriptor).getAllow(), originalAcl.get().getAcesDictionary().get(descriptor).getAllow()); -// assertNotEquals(updatedAcl.getAcesDictionary().get(descriptor).getDeny(), originalAcl.get().getAcesDictionary().get(descriptor).getDeny()); - StringBuilder sb = new StringBuilder().append("Allow: ") - .append(originalAcl.get().getAcesDictionary().get(descriptor).getAllow()).append(" => ").append(updatedAcl.getAcesDictionary().get(descriptor).getAllow()) - .append(", Deny: ") - .append(originalAcl.get().getAcesDictionary().get(descriptor).getDeny()).append(" => ").append(updatedAcl.getAcesDictionary().get(descriptor).getDeny()); - sb.append(" ").append(descriptor).append(" : ").append(updatedAcl.getToken()); - System.out.println(sb.toString()); - } - } finally { - ACLs acLs = new ACLs(); - acLs.setACLs(List.of(existingACL)); - s.setAccessControlList(SecurityToken.Scope.GIT.getNamespace(), acLs); - } - } - - /** - * - lookup a user and a repository - * - get current ACL - * - update ACE with merge flag set - * - re-fetch ACL and compare: - * - deny value should be our mask OR'd with original values - * , allow value should be our mask OR'd with original values + with deny bits unset - * - reset ACL - *

- * Not necessarily universal. - * Depending on the internal permission logic, denying access to one action may implicitly deny other actions. - * i.e. in git permissions, bit 1 (admin) appears to be flipped depending on other allow/deny values - * - * @throws AzDException - */ - @Test - public void shouldUpdateAccessControlEntry() throws AzDException { - var projectName = "my-awesome-project"; - long allowMask = 2 + 4 + 16; - long denyMask = 256 + 512; - GitDetails gitApi = webApi.getGitApi(); - CoreDetails coreApi = webApi.getCoreApi(); - GraphDetails graphApi = webApi.getGraphApi(); - - //s.getNamespace(SecurityToken.Scope.GIT.getNamespace()).getActions().stream().sorted(Comparator.comparingInt(x -> x.getBit())).forEach(x -> System.out.println("Action ("+x.getBit()+"): " + x.getDisplayName())); - Optional userOptional = graphApi.getUsers().getUsers().stream().findAny(); - assumeTrue(userOptional.isPresent()); -// Optional repositoryOptional = gitApi.getRepositories().getRepositories().stream().findAny(); - Optional repositoryOptional = gitApi.getRepositories().getRepositories().stream() - .filter(x -> x.getName().equals("newRepo")) - .findFirst(); - assumeTrue(repositoryOptional.isPresent()); - //System.out.println("" + repositoryOptional.get()); - - Identities identitiesFromSubjectDescriptors = s.getIdentitiesFromSubjectDescriptors(userOptional.get().getDescriptor()); - String descriptor = identitiesFromSubjectDescriptors.getIdentities().stream().findFirst().get().getDescriptor(); - System.out.println(userOptional.get().getDescriptor() + " ==> " + descriptor); - - String token = SecurityToken.generate(SecurityToken.Scope.GIT, Map.of( - "PROJECT_ID", repositoryOptional.get().getProject().getId(), - "REPO_ID", repositoryOptional.get().getId() - )); - System.out.println("Token: " + token); - ACLs accessControlLists = s.getAccessControlLists(SecurityToken.Scope.GIT.getNamespace(), new String[]{descriptor}, token, false, false); - //assumeFalse(accessControlLists.getACLs().isEmpty()); - //assertTrue(accessControlLists.getACLs().get(0).getAcesDictionary().containsKey(descriptor)); - //System.out.println("Original: "); - //accessControlLists.getACLs().stream().map(ACL::toString).forEach(System.out::println); - ACEs newACEs = new ACEs(); - newACEs.setMerge(true); - newACEs.setToken(token); - ACE entry = new ACE(); - entry.setDescriptor(descriptor); - entry.setAllow(allowMask); - entry.setDeny(denyMask); - newACEs.setAccessControlEntries(List.of(entry)); - try { - s.setAccessControlEntries(SecurityToken.Scope.GIT.getNamespace(), newACEs); - - try { - Thread.sleep(5000l); // wait for completion - } catch (InterruptedException ie) { - } - - ACLs updatedControlLists = s.getAccessControlLists(SecurityToken.Scope.GIT.getNamespace(), new String[]{descriptor}, token, false, false); - //System.out.println("Updated: "); - //updatedControlLists.getACLs().stream().map(ACL::toString).forEach(System.out::println); - - assertTrue(updatedControlLists.getACLs().size() == 1); - assertTrue(updatedControlLists.getACLs().get(0).getAcesDictionary().containsKey(descriptor)); - - // set original values == 0 if they didn't exist - BitSet originalAllow = new BitSet(); - BitSet originalDeny = new BitSet(); - if (accessControlLists.getACLs() != null && !accessControlLists.getACLs().isEmpty()) { - originalAllow = BitSet.valueOf(new long[]{accessControlLists.getACLs().get(0).getAcesDictionary().get(descriptor).getAllow()}); - originalDeny = BitSet.valueOf(new long[]{accessControlLists.getACLs().get(0).getAcesDictionary().get(descriptor).getDeny()}); - } - BitSet deltaAllow = BitSet.valueOf(new long[]{allowMask}); - BitSet deltaDeny = BitSet.valueOf(new long[]{denyMask}); - - // set expected values via bitset operations - deltaAllow.or(originalAllow); - deltaDeny.or(originalDeny); - deltaAllow.andNot(deltaDeny); - - BitSet updatedAllow = BitSet.valueOf(new long[]{updatedControlLists.getACLs().get(0).getAcesDictionary().get(descriptor).getAllow()}); - BitSet updatedDeny = BitSet.valueOf(new long[]{updatedControlLists.getACLs().get(0).getAcesDictionary().get(descriptor).getDeny()}); - - assertEquals(deltaAllow, updatedAllow); - assertEquals(deltaDeny, updatedDeny); - - assertEquals(0, Arrays.compare(updatedAllow.toLongArray(), deltaAllow.toLongArray())); - assertEquals(0, Arrays.compare(updatedDeny.toLongArray(), deltaDeny.toLongArray())); - } finally { - if (accessControlLists.getACLs() == null || accessControlLists.getACLs().isEmpty()) { - s.removeAccessControlEntries(SecurityToken.Scope.GIT.getNamespace(), new String[]{descriptor}, new String[]{token}); - } else { - s.setAccessControlList(SecurityToken.Scope.GIT.getNamespace(), accessControlLists); - } - } - } -} diff --git a/azd/src/test/java/org/azd/legacy/ServiceEndpointApiTest.java b/azd/src/test/java/org/azd/legacy/ServiceEndpointApiTest.java deleted file mode 100644 index 7c7114f3..00000000 --- a/azd/src/test/java/org/azd/legacy/ServiceEndpointApiTest.java +++ /dev/null @@ -1,65 +0,0 @@ -package org.azd.legacy; - -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.ServiceEndpointDetails; -import org.azd.utils.AzDClientApi; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; - -public class ServiceEndpointApiTest { - private static final JsonMapper MAPPER = new JsonMapper(); - private static AzDClient webApi; - private static ServiceEndpointDetails s; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - s = webApi.getServiceEndpointApi(); - } - - @Test(expected = AzDException.class) - public void shouldCreateAzureRMServiceEndpoint() throws AzDException { - - s.createAzureRMServiceEndpoint( - "myEndpoint", - "servicePrincipalId", - "servicePrincipalKey", - "tenantId", - "subscriptionId", - "subscriptionName"); - } - - @Test - public void shouldGetAllServiceEndpoints() throws AzDException { - s.getServiceEndpoints(); - } - - @Test(expected = AzDException.class) - public void shouldDeleteAServiceEndpoint() throws AzDException { - s.deleteServiceEndpoint("endpointId", new String[]{"projectName"}); - } - - @Test - public void shouldShareServiceEndpointConnection() throws AzDException { - try { - var endpointId = s.getServiceEndpoints().getServiceEndpoints() - .stream() - .filter(x -> x.getName().equals("myEndpoint")) - .findFirst() - .get() - .getId(); - s.shareServiceEndpoint(endpointId, "projectName", "mySharedConnection"); - } catch (Exception ignored) { - } - } -} diff --git a/azd/src/test/java/org/azd/legacy/ServiceHooksApiTest.java b/azd/src/test/java/org/azd/legacy/ServiceHooksApiTest.java deleted file mode 100644 index 07451688..00000000 --- a/azd/src/test/java/org/azd/legacy/ServiceHooksApiTest.java +++ /dev/null @@ -1,79 +0,0 @@ -package org.azd.legacy; - -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.CoreDetails; -import org.azd.interfaces.ServiceHooksDetails; -import org.azd.servicehooks.types.ServiceHooks; -import org.azd.utils.AzDClientApi; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; -import java.util.LinkedHashMap; - -public class ServiceHooksApiTest { - private static final JsonMapper MAPPER = new JsonMapper(); - private static AzDClient webApi; - private static ServiceHooksDetails s; - private static CoreDetails c; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - c = webApi.getCoreApi(); - s = webApi.getServiceHooksApi(); - } - - @Test - public void shouldCreateASubscription() throws AzDException { - var projectId = c.getProject("azure-devops-java-sdk"); - var serviceHooks = new ServiceHooks(); - - var pI = new LinkedHashMap() {{ - put("buildStatus", "Failed"); - put("definitionName", "Demo-CI"); - put("projectId", projectId.getId()); - }}; - - var cI = new LinkedHashMap() {{ - put("url", "https://mywebsite/api/webhook"); - }}; - - serviceHooks.setPublisherId("tfs"); - serviceHooks.setEventType("build.complete"); - serviceHooks.setResourceVersion("1.0-preview.1"); - serviceHooks.setConsumerId("webHooks"); - serviceHooks.setConsumerActionId("httpRequest"); - serviceHooks.setPublisherInputs(pI); - serviceHooks.setConsumerInputs(cI); - - var res = s.createSubscription(serviceHooks); - - res.getId(); - } - - @Test - public void shouldGetASubscription() throws AzDException { - var subscriptions = s.getSubscriptions(); - s.getSubscription(subscriptions.getSubscriptions().stream().findFirst().get().getId()); - } - - @Test - public void shouldGetSubscriptions() throws AzDException { - s.getSubscriptions(); - } - - @Test - public void shouldDeleteASubscription() throws AzDException { - var subscriptions = s.getSubscriptions(); - s.deleteSubscription(subscriptions.getSubscriptions().stream().findFirst().get().getId()); - } -} diff --git a/azd/src/test/java/org/azd/legacy/TestApiTest.java b/azd/src/test/java/org/azd/legacy/TestApiTest.java deleted file mode 100644 index 08565677..00000000 --- a/azd/src/test/java/org/azd/legacy/TestApiTest.java +++ /dev/null @@ -1,58 +0,0 @@ -package org.azd.legacy; - -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.TestDetails; -import org.azd.test.TestApi; -import org.azd.test.types.TestCaseResults; -import org.azd.utils.AzDClientApi; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; - -public class TestApiTest { - private static final JsonMapper MAPPER = new JsonMapper(); - private static AzDClient webApi; - private static TestDetails t; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - t = webApi.getTestApi(); - } - - @Test - public void shouldGetATestRun() throws AzDException { - t.getTestRunById(424); - } - - @Test - public void shouldListAllTestRuns() throws AzDException { - t.getTestRuns().getTestRuns().stream().filter(id -> id.getId().equals(424)).findFirst().get(); - } - - @Test - public void shouldGetATestRunStatistics() throws AzDException { - t.getTestRunStatistics(424); - } - - @Test(expected = AzDException.class) - public void shouldDeleteATestRun() throws AzDException { - t.deleteTestRun(222334); - } - - @Test - public void shouldUpdateATestResults() throws AzDException { - try { - t.updateTestResults(424, new TestCaseResults()); - } catch (AzDException ignored) {} - } -} diff --git a/azd/src/test/java/org/azd/legacy/UPackApiTest.java b/azd/src/test/java/org/azd/legacy/UPackApiTest.java deleted file mode 100644 index 87db4dcc..00000000 --- a/azd/src/test/java/org/azd/legacy/UPackApiTest.java +++ /dev/null @@ -1,162 +0,0 @@ -package org.azd.legacy; - -import org.azd.enums.PackagePromote; -import org.azd.enums.PackagesBatchOperation; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.UpackDetails; -import org.azd.upack.types.Package; -import org.azd.upack.types.UPackPackageVersionDeletionState; -import org.azd.utils.AzDClientApi; -import org.junit.AfterClass; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.concurrent.TimeUnit; - -import static org.junit.Assert.assertEquals; - -public class UPackApiTest { - - private static final JsonMapper MAPPER = new JsonMapper(); - private static final String FEED = "universal-packages-feed"; - private static final String TEST1_PACKAGENAME = "universal-package"; - private static final String TEST1_VERSION = "1.0.0"; - // Recycle bin Package - private static final String TEST2_PACKAGENAME = "universa-package"; - private static final String TEST2_VERSION = "1.0.0"; - private static AzDClient webApi; - private static UpackDetails upack; - - @AfterClass - public static void restorePackage() { - try { - List packages = new ArrayList<>(); - - Map p1 = new HashMap<>(); - p1.put("id", TEST1_PACKAGENAME); - p1.put("version", TEST1_VERSION); - packages.add(p1); - - upack.updateRecycleBinPackages(FEED, PackagesBatchOperation.RESTORETOFEED, packages); - } catch (Exception e) { - } - } - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - upack = webApi.getUPackApi(); - } - - @Test - public void shouldGetPackageVersion() throws AzDException { - try { - System.out.println("Universal Package API TEST : getPackageVersion"); - Package testPackage = upack.getPackageVersion(FEED, TEST1_PACKAGENAME, TEST1_VERSION); - assertEquals(TEST1_PACKAGENAME, testPackage.getName()); - assertEquals(TEST1_VERSION, testPackage.getVersion()); - System.out.println("Universal Package API TEST : getPackageVersion - OK"); - } catch (AzDException e) { - } - } - - @Test - public void shouldGetPackageVersionWithQueryParameters() throws AzDException { - try { - System.out.println("Universal Package API TEST : getPackageVersion with query parameters"); - Package testPackage = upack.getPackageVersion(FEED, TEST1_PACKAGENAME, TEST1_VERSION, true); - assertEquals(TEST1_PACKAGENAME, testPackage.getName()); - assertEquals(TEST1_VERSION, testPackage.getVersion()); - System.out.println("Universal Package API TEST : getPackageVersion with query parameters - OK"); - } catch (AzDException e) { - } - } - - @Test - public void shouldUpdatePackageVersion() throws AzDException { - try { - System.out.println("Universal Package API TEST : updatePackageVersion"); - upack.updatePackageVersion(FEED, TEST1_PACKAGENAME, TEST1_VERSION, "Release"); - upack.updatePackageVersion(FEED, TEST1_PACKAGENAME, TEST1_VERSION, PackagePromote.PRERELEASE); - System.out.println("Universal Package API TEST : updatePackageVersion - OK"); - } catch (AzDException e) { - } - } - - @Test - public void shouldDeleteRestorePackageVersion() throws AzDException, InterruptedException { - try { - System.out.println("Universal Package API TEST : deletePackageVersion"); - upack.deletePackageVersion(FEED, TEST1_PACKAGENAME, TEST1_VERSION); - TimeUnit.SECONDS.sleep(5); - System.out.println("Universal Package API TEST : deletePackageVersion - OK"); - - System.out.println("Universal Package API TEST : restorePackageVersionFromRecycleBin"); - upack.restorePackageVersionFromRecycleBin(FEED, TEST1_PACKAGENAME, TEST1_VERSION); - TimeUnit.SECONDS.sleep(5); - System.out.println("Universal Package API TEST : restorePackageVersionFromRecycleBin - OK"); - } catch (AzDException e) { - } - } - - @Test - public void shouldGetPackageVersionFromRecycleBin() throws AzDException { - try { - System.out.println("Universal Package API TEST : shouldGetPackageVersionFromRecycleBin"); - UPackPackageVersionDeletionState testPackage = upack.getPackageVersionFromRecycleBin(FEED, TEST2_PACKAGENAME, - TEST2_VERSION); - assertEquals(TEST2_PACKAGENAME, testPackage.getName()); - System.out.println("Universal Package API TEST : shouldGetPackageVersionFromRecycleBin - OK"); - } catch (AzDException e) { - } - } - - // // @Test - // // public void shouldDownloadPackage() throws AzDException { - // // mvn.downloadPackage("test2", "com.acme", "app", "1.0.2", "app-1.0.2.zip"); - // // } - - @Test - public void shouldUpdatePackageVersions() throws AzDException, InterruptedException { - try { - System.out.println("Universal Package API : updatePackageVersions"); - List packages = new ArrayList<>(); - - Map p1 = new HashMap<>(); - p1.put("id", TEST1_PACKAGENAME); - p1.put("version", TEST1_VERSION); - packages.add(p1); - - upack.updatePackageVersions(FEED, "Release", PackagesBatchOperation.PROMOTE, packages); - upack.updatePackageVersions(FEED, "Release", PackagesBatchOperation.DELETE, packages); - TimeUnit.SECONDS.sleep(3); - System.out.println("Universal Package API : updatePackageVersions - OK"); - - System.out.println("Universal Package APIT : updateRecycleBinPackages"); - upack.updateRecycleBinPackages(FEED, PackagesBatchOperation.RESTORETOFEED, packages); - TimeUnit.SECONDS.sleep(3); - System.out.println("Universal Package API : updateRecycleBinPackages - OK"); - } catch (AzDException e) { - } - } - - @Test(expected = AzDException.class) // cannot be undone test - public void shouldDeletePackageVersionFromRecycleBin() throws AzDException { - System.out.println("Universal Package API : deletePackageVersionFromRecycleBin"); - upack.deletePackageVersionFromRecycleBin(FEED, TEST1_PACKAGENAME, "0.0.0"); // cant not be undone - System.out.println("Universal Package API : deletePackageVersionFromRecycleBin - OK"); - } -} diff --git a/azd/src/test/java/org/azd/legacy/WikiApiTest.java b/azd/src/test/java/org/azd/legacy/WikiApiTest.java deleted file mode 100644 index d5749279..00000000 --- a/azd/src/test/java/org/azd/legacy/WikiApiTest.java +++ /dev/null @@ -1,231 +0,0 @@ -package org.azd.legacy; - -import org.azd.enums.GitVersionOptions; -import org.azd.enums.GitVersionType; -import org.azd.enums.VersionControlRecursionType; -import org.azd.enums.WikiType; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.helpers.StreamHelper; -import org.azd.interfaces.CoreDetails; -import org.azd.interfaces.GitDetails; -import org.azd.interfaces.WikiDetails; -import org.azd.utils.AzDClientApi; -import org.azd.wiki.types.GitVersionDescriptor; -import org.azd.wiki.types.WikiCreateParameters; -import org.azd.wiki.types.WikiPageMoveParameters; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; - -public class WikiApiTest { - private static final JsonMapper MAPPER = new JsonMapper(); - private static AzDClientApi webApi; - private static WikiDetails w; - private static CoreDetails c; - private static GitDetails g; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - c = webApi.getCoreApi(); - w = webApi.getWikiApi(); - g = webApi.getGitApi(); - } - - @Test - public void shouldCreateWiki() throws AzDException { - var projectId = c.getProject("azure-devops-java-sdk").getId(); - var repoId = g.getRepository("testRepository").getId(); - String wikiPage = null; - try { - wikiPage = w.getWiki("NewWiki").getName(); - } catch (AzDException e) { - } - - if (wikiPage == null) { - var version = new GitVersionDescriptor(); - version.version = "develop"; - var wikiCreateParameters = new WikiCreateParameters("/docs", "NewWiki", projectId, repoId, WikiType.CODEWIKI, - version); - w.createWiki(wikiCreateParameters); - } - } - - @Test - public void shouldCreateNewProjectWiki() { - try { - var projectId = c.getProject("azure-devops-java-sdk").getId(); - var wikiCreateParameters = new WikiCreateParameters("Azure DevOps java sdk documentation", projectId, WikiType.PROJECTWIKI); - w.createWiki(wikiCreateParameters); - } catch (AzDException e) { - // ignore WikiAlreadyExistsException - } - } - - @Test - public void shouldGetAWiki() throws AzDException { - w.getWiki("NewWiki"); - } - - @Test - public void shouldGetAllWikis() throws AzDException { - w.getWikis(); - } - - @Test - public void shouldDeleteAWiki() { - try { - w.deleteWiki("MyProjectWiki"); - } catch (AzDException e) { - } - } - - @Test - public void shouldCreateAWikiAttachment() { - try { - var wiki = w.getWikis().getWikiPages(); - var wikiId = wiki.get(0).getId(); - var wikiName = "azure-architecture.png"; - StreamHelper.downloadFromUrl("https://support.content.office.net/en-us/media/714fa128-65fa-4ab5-b1f7-15bed1065500.png", - "azure-architecture.png"); - var content = StreamHelper.convertToStream(new File("azure-architecture.png")); - - w.createWikiAttachment(wikiId, wikiName, "develop", GitVersionType.BRANCH, GitVersionOptions.NONE, content); - } catch (AzDException e) { - // Ignore WikiCreateAttachmentFailedException - } - } - - @Test - public void shouldCreateWikiPageMove() throws AzDException { - var wiki = w.getWikis().getWikiPages(); - var wikiId = wiki.get(0).getId(); - var pageMoveParams = new WikiPageMoveParameters(); - pageMoveParams.setPath("requirements"); - pageMoveParams.setNewPath("requirements"); - pageMoveParams.setNewOrder(0); - - w.createPageMove(wikiId, null, "develop", GitVersionType.BRANCH, GitVersionOptions.NONE, pageMoveParams); - } - - @Test - public void shouldGetThePageStats() throws AzDException { - var wiki = w.getWikis().getWikiPages(); - var wikiId = wiki.get(0).getId(); - w.getPageStats(wikiId, 1, 0); - } - - @Test - public void shouldCreateAWikiPage() { - try { - var wiki = w.getWikis().getWikiPages(); - var wikiId = wiki.get(0).getId(); - var page = "ProjectSafeLanding"; - - w.createOrUpdateWikiPage(wikiId, page, "Page initial commit", null, "develop", GitVersionType.BRANCH, - GitVersionOptions.NONE, "New sample WIKI page"); - } catch (AzDException e) { - // Ignore WikiPageAlreadyExistsException - } - } - - @Test - public void shouldDeleteAWikiPage() { - try { - var wiki = w.getWikis().getWikiPages(); - var wikiId = wiki.get(0).getId(); - var page = "ProjectSafeLanding"; - - w.deleteWikiPage(wikiId, page, "Page deleted", "develop", GitVersionType.BRANCH, - GitVersionOptions.NONE); - } catch (AzDException e) { - // Ignore WikiPageNotFoundException - } - } - - @Test - public void shouldGetAWikiPage() { - try { - var wiki = w.getWikis().getWikiPages(); - var wikiId = wiki.get(0).getId(); - var page = "ProjectSafeLanding"; - - w.getWikiPage(wikiId, false, page, VersionControlRecursionType.FULL, - "Get wiki page", "develop", GitVersionType.BRANCH, GitVersionOptions.NONE); - } catch (AzDException e) { - // Ignore WikiPageNotFoundException - } - } - - @Test - public void shouldGetWikiPageById() { - try { - var wiki = w.getWikis().getWikiPages(); - var wikiId = wiki.get(0).getId(); - var page = "ProjectSafeLanding"; - - var wikiPage = w.getWikiPage(wikiId, false, page, VersionControlRecursionType.FULL, - "Get wiki page", "develop", GitVersionType.BRANCH, GitVersionOptions.NONE); - - w.getWikiPageById(wikiPage.getId().toString(), wikiId, true, VersionControlRecursionType.FULL); - } catch (AzDException e) { - // Ignore WikiPageNotFoundException - } - } - - @Test - public void shouldGetWikiPageContent() { - try { - var wiki = w.getWikis().getWikiPages(); - var wikiId = wiki.get(0).getId(); - var page = "ProjectSafeLanding"; - var wikiPage = w.getWikiPage(wikiId, false, page, VersionControlRecursionType.FULL, - "Get wiki page", "develop", GitVersionType.BRANCH, GitVersionOptions.NONE); - - w.getWikiPageContent(wikiPage.getId().toString(), wikiId); - } catch (AzDException e) { - // Ignore WikiPageNotFoundException - } - } - - @Test - public void shouldGetWikiPageContentAsZip() throws AzDException { - try { - var wiki = w.getWikis().getWikiPages(); - var wikiId = wiki.get(0).getId(); - var page = "ProjectSafeLanding"; - var wikiPage = w.getWikiPage(wikiId, false, page, VersionControlRecursionType.FULL, - "Get wiki page", "develop", GitVersionType.BRANCH, GitVersionOptions.NONE); - - var res = w.getWikiPageAsZip(wikiPage.getId().toString(), wikiId); - StreamHelper.download(page + ".zip", res); - } catch (AzDException e) { - // Ignore WikiPageNotFoundException - } - } - - @Test - public void shouldUpdateWikiPage() { - try { - var wiki = w.getWikis().getWikiPages(); - var wikiId = wiki.get(0).getId(); - var page = "ProjectSafeLanding"; - var wikiPage = w.getWikiPage(wikiId, false, page, VersionControlRecursionType.FULL, - "Get wiki page", "develop", GitVersionType.BRANCH, GitVersionOptions.NONE); - - w.updateWikiPage(wikiPage.getId().toString(), wikiId, "Updated page content", wikiPage.geteTag(), "# Heading\n" + - "This is updated content. \n ## Second Heading \n Place holder for safe landing project."); - } catch (AzDException e) { - // Ignore WikiPageNotFoundException - } - } - -} diff --git a/azd/src/test/java/org/azd/legacy/WorkApiTest.java b/azd/src/test/java/org/azd/legacy/WorkApiTest.java deleted file mode 100644 index 2ef46216..00000000 --- a/azd/src/test/java/org/azd/legacy/WorkApiTest.java +++ /dev/null @@ -1,118 +0,0 @@ -package org.azd.legacy; - -import org.azd.enums.IterationsTimeFrame; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.WorkDetails; -import org.azd.utils.AzDClientApi; -import org.azd.work.WorkApi; -import org.azd.work.types.Activity; -import org.azd.work.types.TeamMemberCapacityIdentityRef; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; -import java.util.List; - -import static org.junit.Assert.assertEquals; - -public class WorkApiTest { - private static final JsonMapper MAPPER = new JsonMapper(); - private static AzDClient webApi; - private static WorkDetails w; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - w = webApi.getWorkApi(); - } - - @Test - public void shouldGetTeamIterations() throws AzDException { - w.getTeamSettingsIterations("azure-devops-java-sdk Team"); - } - - @Test - public void shouldGetTeamIterationsWithTimeFrame() throws AzDException { - var res = w.getTeamSettingsIterations("azure-devops-java-sdk Team", IterationsTimeFrame.CURRENT); - assertEquals("Sprint 1", res.getIterations().stream().findFirst().get().getName()); - } - - @Test - public void shouldGetTeamIterationWorkItems() throws AzDException { - var id = w.getTeamSettingsIterations("azure-devops-java-sdk Team").getIterations().stream().findFirst().get().getId(); - var res = w.getTeamIterationWorkItems("azure-devops-java-sdk Team", id); - res.get_links(); - } - - @Test - public void shouldGetATeamIteration() throws AzDException { - var id = w.getTeamSettingsIterations("azure-devops-java-sdk Team") - .getIterations().stream().findFirst().get().getId(); - w.getTeamSettingsIteration("azure-devops-java-sdk Team", id); - } - - @Test(expected = AzDException.class) - public void shouldDeleteATeamIteration() throws AzDException { - w.deleteTeamSettingsIteration("azure-devops-java-sdk Team", "0000-00000-00000-00000-00000"); - } - - @Test - public void shouldGetTotalTeamCapacity() throws AzDException { - var iterationId = w.getTeamSettingsIterations("azure-devops-java-sdk Team").getIterations().get(0).getId(); - w.getTotalTeamCapacity(iterationId, "azure-devops-java-sdk Team"); - } - - @Test - public void shouldGetTeamMemberCapacity() throws AzDException { - var iterationId = w.getTeamSettingsIterations("azure-devops-java-sdk Team").getIterations().get(0).getId(); - var teamMemberId = w.getTotalTeamCapacity(iterationId, "azure-devops-java-sdk Team").getTeamMembers().get(0).getTeamMember().getId(); - w.getTeamMemberCapacity(iterationId, "azure-devops-java-sdk Team", teamMemberId); - } - - @Test - public void shouldUpdateTeamMemberCapacity() throws AzDException { - var iterationId = w.getTeamSettingsIterations("azure-devops-java-sdk Team").getIterations().get(0).getId(); - var teamMemberId = w.getTotalTeamCapacity(iterationId, "azure-devops-java-sdk Team").getTeamMembers().get(0).getTeamMember().getId(); - - var teamMemberIdentityRef = new TeamMemberCapacityIdentityRef(); - - var activity = new Activity(); - activity.setName("Development"); - activity.setCapacityPerDay(5); - - var activities = List.of(activity); - - teamMemberIdentityRef.setActivities(activities); - - w.updateTeamMemberCapacity(iterationId, "azure-devops-java-sdk Team", teamMemberId, teamMemberIdentityRef); - } - - @Test - public void shouldUpdateTeamMembersCapacity() throws AzDException { - var iterationId = w.getTeamSettingsIterations("azure-devops-java-sdk Team").getIterations().get(0).getId(); - var teamMember = w.getTotalTeamCapacity(iterationId, "azure-devops-java-sdk Team").getTeamMembers().get(0).getTeamMember(); - - var teamMemberIdentityRef = new TeamMemberCapacityIdentityRef(); - teamMemberIdentityRef.setTeamMember(teamMember); - - var teamMemberIdentityRefs = List.of(teamMemberIdentityRef); - - var activity = new Activity(); - activity.setName("Development"); - activity.setCapacityPerDay(3); - - var activities = List.of(activity); - - teamMemberIdentityRef.setActivities(activities); - - w.updateTeamMembersCapacity(iterationId, "azure-devops-java-sdk Team", teamMemberIdentityRefs); - } -} diff --git a/azd/src/test/java/org/azd/legacy/WorkItemTrackingApiTest.java b/azd/src/test/java/org/azd/legacy/WorkItemTrackingApiTest.java deleted file mode 100644 index c4562b9c..00000000 --- a/azd/src/test/java/org/azd/legacy/WorkItemTrackingApiTest.java +++ /dev/null @@ -1,349 +0,0 @@ -package org.azd.legacy; - -import org.azd.enums.*; -import org.azd.exceptions.AzDException; -import org.azd.helpers.JsonMapper; -import org.azd.helpers.StreamHelper; -import org.azd.interfaces.AzDClient; -import org.azd.interfaces.CoreDetails; -import org.azd.interfaces.WorkItemTrackingDetails; -import org.azd.utils.AzDClientApi; -import org.azd.workitemtracking.WorkItemTrackingApi; -import org.azd.workitemtracking.types.QueryHierarchyItem; -import org.azd.workitemtracking.types.WorkItemField; -import org.azd.workitemtracking.types.WorkItemFieldOperation; -import org.junit.Before; -import org.junit.Test; - -import java.io.File; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import static org.junit.Assert.assertEquals; - -public class WorkItemTrackingApiTest { - - private static final JsonMapper MAPPER = new JsonMapper(); - - private static AzDClient webApi; - - private static WorkItemTrackingDetails w; - - private static CoreDetails c; - - @Before - public void init() throws AzDException { - String dir = System.getProperty("user.dir"); - File file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - MockParameters m = MAPPER.mapJsonFromFile(file, MockParameters.class); - String organization = m.getO(); - String token = m.getT(); - String project = m.getP(); - webApi = new AzDClientApi(organization, project, token); - w = webApi.getWorkItemTrackingApi(); - c = webApi.getCoreApi(); - } - - @Test - public void shouldGetWorkItem() throws AzDException { - var expectedValue = "azure-devops-java-sdk"; - var result = w.getWorkItem(2).getFields().getSystemTeamProject(); - assertEquals(expectedValue, result); - } - - @Test - public void shouldGetWorkItemWithOptionalParameters() throws AzDException { - var expectedValue = "azure-devops-java-sdk"; - var result = w.getWorkItem(2, WorkItemExpand.ALL).getFields().getSystemTeamProject(); - assertEquals(expectedValue, result); - } - - @Test - public void shouldCreateAWorkItem() throws AzDException { - w.createWorkItem("user story", WorkItemOperation.ADD, "Sample User story", "Description for the user story", - new String[]{"DevOps", "Java", "SDK"}); - } - - @Test - public void shouldCreateAWorkItemWithAdditionalFields() throws AzDException { - var additionalFields = new HashMap() {{ - put("System.Tags", String.join(",", "DevOps", "Java", "SDK")); - }}; - - w.createWorkItem("user story", "Sample User story", "Description for the user story", additionalFields); - } - - @Test(expected = AzDException.class) - public void shouldDeleteAWorkItem() throws AzDException { - w.deleteWorkItem(6); - } - - @Test - public void shouldGetWorkItems() throws AzDException { - w.getWorkItems(new int[]{1, 2, 4}); - } - - @Test - public void shouldGetWorkItemRevisions() throws AzDException { - var r = w.getWorkItemRevisions(2, WorkItemExpand.ALL).getWorkItems().stream().findFirst().get().getFields() - .getSystemAreaId(); - assertEquals(12, r); - } - - @Test - public void shouldGetWorkItemRevision() throws AzDException { - w.getWorkItemRevision(2, 1); - } - - @Test - public void shouldQueryWorkItems() throws AzDException { - var query = "Select * From WorkItems Where [System.WorkItemType] = 'User Story'"; - var team = "azure-devops-java-sdk Team"; - w.queryByWiql(team, query, 10, true).getWorkItems(); - } - - @Test - public void shouldQueryWorkItemsAndGetExactlyOneResult() throws AzDException { - var query = "Select * From WorkItems Where [System.WorkItemType] = 'User Story'"; - var team = "azure-devops-java-sdk Team"; - var res = (long) w.queryByWiql(team, query, 1, true).getWorkItems().size(); - assertEquals(1, res); - } - - @Test(expected = AzDException.class) - public void shouldRemoveWorkItemFromRecycleBin() throws AzDException { - w.removeWorkItemFromRecycleBin(93); - } - - @Test(expected = AzDException.class) - public void shouldGetWorkItemFromRecycleBin() throws AzDException { - w.getWorkItemFromRecycleBin(760); - } - - @Test - public void shouldGetDeletedWorkItemFromRecycleBin() throws AzDException { - w.getDeletedWorkItemsFromRecycleBin(); - } - - @Test(expected = AzDException.class) - public void shouldGetDeletedWorkItemsFromRecycleBin() throws AzDException { - w.getDeletedWorkItemsFromRecycleBin(new int[]{71, 72, 73, 74}); - } - - @Test(expected = AzDException.class) - public void shouldRestoreWorkItemFromRecycleBin() throws AzDException { - w.restoreWorkItemFromRecycleBin(70); - } - - @Test - public void shouldUpdateAWorkItem() throws AzDException { - var fieldsToUpdate = new HashMap() {{ - put("System.AssignedTo", "test@xmail.com"); - }}; - w.updateWorkItem(176, fieldsToUpdate); - } - - @Test - public void shouldAddHyperlink() throws AzDException { - Map hyperlinksMap = new HashMap<>(); - hyperlinksMap.put("https://docs.microsoft.com/en-us/rest/api/azure/devops", - "This is a hyperlink that points to the Azure DevOps REST documentation."); - w.addHyperLinks(1, hyperlinksMap); - } - - @Test - public void shouldRemoveHyperlink() throws AzDException { - List hyperlinks = new ArrayList<>(); - hyperlinks.add("https://docs.microsoft.com/en-us/rest/api/azure/devops"); - try { - w.removeHyperLinks(1, hyperlinks); - } catch (AzDException e) { - // Test is also successful if hyperlink doesn't exist. - if (e.getMessage().toLowerCase().contains("the hyperlink doesn't exist")) { - return; - } - throw e; - } - } - - @Test - public void shouldGetWorkItemTypes() throws AzDException { - w.getWorkItemTypes(); - } - - @Test - public void shouldGetAWorkItemType() throws AzDException { - w.getWorkItemType("Bug"); - } - - @Test - public void shouldCreateWorkItemAttachment() throws AzDException { - var contentStream = StreamHelper.convertToStream("This is sample content"); - w.createAttachment("testFile.txt", AttachmentUploadType.SIMPLE, - "azure-devops-java-sdk", contentStream); - } - - @Test - public void shouldGetWorkItemAttachmentAsStreamToAFile() throws AzDException { - var responseStream = w.getAttachmentContent("1b8993be-1c0c-4282-9147-4a2141af1a91", "newTestFile.txt", true); - StreamHelper.download("newTestFile.txt", responseStream); - } - - @Test - public void shouldGetWorkItemAttachmentAsZipFile() throws AzDException { - var responseStream = w.getAttachmentContent("7a62c972-9403-4032-8182-5a2b2eb927b7", "test.zip", true); - StreamHelper.download("test.zip", responseStream); - } - - @Test - public void shouldAddAnAttachmentToAWorkItem() { - try { - var contentStream = StreamHelper.convertToStream("This is sample content"); - - var attachment = w.createAttachment("testFile.txt", AttachmentUploadType.SIMPLE, - "azure-devops-java-sdk", contentStream); - var attachmentFields = new HashMap() {{ - put(attachment.getUrl(), "Test File url."); - }}; - - w.addWorkItemAttachment(994, attachmentFields); - } catch (AzDException e) { - } - } - - @Test - public void shouldRemoveAnAttachmentFromAWorkItem() { - try { - var urls = w.getWorkItem(994, WorkItemExpand.RELATIONS).getRelations(); - if (urls != null) - for (var url : urls) - w.removeWorkItemAttachment(994, List.of(url.getUrl())); - } catch (AzDException e) { - } - } - - @Test - public void shouldGetWorkItemActivities() throws AzDException { - w.getMyWorkRecentActivity(); - } - - @Test - public void shouldGetWorkItemFields() throws AzDException { - w.getWorkItemFields(); - } - - @Test - public void shouldGetWorkItemFieldsWithFieldsExpanded() throws AzDException { - w.getWorkItemFields(GetFieldsExpand.EXTENSIONFIELDS); - } - - @Test - public void shouldGetWorkItemField() throws AzDException { - w.getWorkItemField("Acceptance Criteria"); - } - - @Test - public void shouldCreateWorkItemField() throws AzDException { - try { - var workitemField = new WorkItemField(); - workitemField.setName("New Work Item Field"); - workitemField.setReferenceName("SupportedOperations.GreaterThanEquals"); - workitemField.setDescription(null); - workitemField.setType(FieldType.STRING); - workitemField.setUsage(FieldUsage.WORKITEM); - workitemField.setReadOnly(false); - workitemField.setCanSortBy(true); - workitemField.setIsQueryable(true); - workitemField.setSupportedOperations(List.of(new WorkItemFieldOperation() {{ - setReferenceName("SupportedOperations.Equals"); - setReferenceName("="); - }})); - workitemField.setIsIdentity(true); - workitemField.setIsPicklist(false); - workitemField.setIsPicklistSuggested(false); - workitemField.setUrl(null); - - w.createWorkItemField(workitemField); - } catch (AzDException e) { - // Ignore ProcessFieldAlreadyExistsInformedException - } - } - - @Test - public void shouldDeleteWorkItemField() throws AzDException { - try { - w.deleteWorkItemField("New Work Item Field"); - } catch (AzDException e) { - // Ignore ProcessFieldCouldNotBeFoundException - } - } - - @Test - public void shouldUpdateAWorkItemField() throws AzDException { - try { - w.updateWorkItemField("New Work Item Field", false); - } catch (AzDException e) { - // Ignore FieldHasNotBeenDeletedException - } - } - - @Test - public void shouldCreateAQueryFolder() throws AzDException { - try { - var q = new QueryHierarchyItem(); - var query = w.getQueries().getQueryHierarchyItems().get(1).getId(); - - q.setName("Website team"); - q.setIsFolder(true); - w.createQuery(query, q); - } catch (AzDException e) { - // Ignore LegacyQueryItemException - } - } - - @Test - public void shouldCreateAQuery() throws AzDException { - try { - var q = new QueryHierarchyItem(); - q.setName("All Bugs"); - q.setWiql("Select [System.Id], [System.Title], [System.State] From WorkItems Where [System.WorkItemType] " + - "= 'Bug' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc"); - - w.createQuery("My Queries/Website team", q); - } catch (AzDException e) { - // Ignore LegacyQueryItemException - } - } - - @Test - public void shouldGetAllQueries() throws AzDException { - w.getQueries().getQueryHierarchyItems(); - } - - @Test - public void shouldGetAQueryObject() throws AzDException { - w.getQuery("My Queries"); - } - - @Test - public void shouldDeleteAQuery() throws AzDException { - try { - w.deleteQuery("My Queries/Website team"); - } catch (AzDException e) { - // Ignore QueryItemNotFoundException - } - } - - @Test - public void shouldGetQueriesInBatch() throws AzDException { - var id = w.getQueries().getQueryHierarchyItems().stream().findFirst().get().getId(); - w.getQueryBatches(QueryErrorPolicy.OMIT, QueryExpand.ALL, new String[]{id}); - } - - @Test - public void shouldSearchQueriesBasedOnFilter() throws AzDException { - w.searchQuery("Bugs"); - } -} \ No newline at end of file diff --git a/azd/src/test/java/org/azd/unittests/AccountsRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/AccountsRequestBuilderTest.java index d3aeb0c7..9cc18498 100644 --- a/azd/src/test/java/org/azd/unittests/AccountsRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/AccountsRequestBuilderTest.java @@ -1,11 +1,11 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; import org.azd.authentication.PersonalAccessTokenCredential; import org.azd.enums.Instance; import org.azd.exceptions.AzDException; -import org.azd.legacy.MockParameters; import org.azd.serviceclient.AzDService; import org.azd.serviceclient.AzDServiceClient; import org.junit.Before; @@ -34,18 +34,8 @@ public void init() throws AzDException { @Test public void shouldGetAccounts() throws AzDException { - // There are two ways to get the id; - // 1. Use profile Api. - // 2. Get the id from connection data (authenticated user). - - // 1. Use profile Api. var id = client.accounts().profile().get().getId(); - - // 2. Get the id from connection data (authenticated user). - var authenticatedUserId = client.locations().getConnectionData().getAuthenticatedUser().getId(); - - assert Objects.equals(client.accounts().list(id).getAccounts().get(0).getAccountId(), - client.accounts().list(authenticatedUserId).getAccounts().get(0).getAccountId()); + assert client.accounts().list(id).getAccounts().get(0).getAccountId() != null; } @Test diff --git a/azd/src/test/java/org/azd/unittests/ArtifactsPackageTypesRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/ArtifactsPackageTypesRequestBuilderTest.java index 01304b0a..d5a8b971 100644 --- a/azd/src/test/java/org/azd/unittests/ArtifactsPackageTypesRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/ArtifactsPackageTypesRequestBuilderTest.java @@ -1,14 +1,12 @@ package org.azd.unittests; -import org.azd.UnitTestConfiguration; +import org.azd.MockParameters; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; import org.azd.artifactspackagetypes.ArtifactsPackageTypesRequestBuilder; import org.azd.artifactspackagetypes.maven.MavenRequestBuilder; -import org.azd.artifactspackagetypes.types.MavenMinimalPackageDetails; -import org.azd.artifactspackagetypes.types.MavenPackagesBatchRequest; -import org.azd.artifactspackagetypes.types.MavenRecycleBinPackageVersionDetails; -import org.azd.artifactspackagetypes.types.PackageVersionDetails; +import org.azd.artifactspackagetypes.types.Package; +import org.azd.artifactspackagetypes.types.*; import org.azd.authentication.PersonalAccessTokenCredential; import org.azd.common.types.JsonPatchDocument; import org.azd.enums.Instance; @@ -18,10 +16,6 @@ import org.azd.exceptions.AzDException; import org.azd.helpers.StreamHelper; import org.azd.helpers.artifactspackagetypes.ArtifactsPackageTypesHelpersRequestBuilder; -import org.azd.legacy.MockParameters; -import org.azd.maven.types.MavenPackageVersionDeletionState; -import org.azd.maven.types.Package; -import org.azd.maven.types.UpstreamingBehavior; import org.azd.serviceclient.AzDService; import org.azd.serviceclient.AzDServiceClient; import org.junit.AfterClass; @@ -30,8 +24,6 @@ import java.io.File; import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; import java.util.Map; import java.util.concurrent.TimeUnit; @@ -40,7 +32,6 @@ public class ArtifactsPackageTypesRequestBuilderTest { private static final SerializerContext serializer = InstanceFactory.createSerializerContext(); private static AzDServiceClient client; - private static UnitTestConfiguration testConfiguration; private static final String FEED = "maven-feed"; private static final String TEST1_GROUP = "org.jack.click"; private static final String TEST1_ARTIFACT = "ClickJack"; @@ -60,9 +51,7 @@ public class ArtifactsPackageTypesRequestBuilderTest { public void init() throws AzDException { String dir = System.getProperty("user.dir"); var file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); - var configFile = new File(dir + "/src/test/java/org/azd/config.json"); var m = serializer.deserialize(file, MockParameters.class); - testConfiguration = serializer.deserialize(configFile, UnitTestConfiguration.class); String organization = m.getO(); String token = m.getT(); String project = m.getP(); @@ -102,7 +91,7 @@ public static void restorePackage() { } @Test - public void shouldGetPackageVersion() throws AzDException { + public void shouldGetPackageVersion() { System.out.println("Maven API TEST : getPackageVersion"); try { Package testPackage = mvn.get(r -> { @@ -224,7 +213,7 @@ public void shouldDeleteRestorePackageVersion() throws AzDException, Interrupted } @Test - public void shouldGetPackageVersionFromRecycleBin() throws AzDException { + public void shouldGetPackageVersionFromRecycleBin() { System.out.println("Maven API TEST : shouldGetPackageVersionFromRecycleBin"); try { mvn.recycleBin().get(r -> { @@ -233,7 +222,7 @@ public void shouldGetPackageVersionFromRecycleBin() throws AzDException { r.artifactId = TEST3_ARTIFACT; r.version = TEST3_VERSION; }); - } catch (AzDException ignored) { + } catch (Exception ignored) { } System.out.println("Maven API TEST : shouldGetPackageVersionFromRecycleBin - OK"); } @@ -289,7 +278,7 @@ public void shouldUploadPackage() throws AzDException { } } - @Test + @Test(expected = AzDException.class) public void shouldUpdatePackageVersions() throws AzDException, InterruptedException { System.out.println("Maven API TEST : updatePackageVersions"); var batchRequest = new MavenPackagesBatchRequest(); diff --git a/azd/src/test/java/org/azd/unittests/ArtifactsRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/ArtifactsRequestBuilderTest.java index cb2b1195..67c3a37c 100644 --- a/azd/src/test/java/org/azd/unittests/ArtifactsRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/ArtifactsRequestBuilderTest.java @@ -1,16 +1,16 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; +import org.azd.artifacts.types.Feed; +import org.azd.artifacts.types.FeedView; import org.azd.authentication.PersonalAccessTokenCredential; import org.azd.enums.FeedRole; import org.azd.enums.FeedViewType; import org.azd.enums.FeedVisibility; import org.azd.enums.Instance; import org.azd.exceptions.AzDException; -import org.azd.feedmanagement.types.Feed; -import org.azd.feedmanagement.types.FeedView; -import org.azd.legacy.MockParameters; import org.azd.serviceclient.AzDService; import org.azd.serviceclient.AzDServiceClient; import org.junit.Before; diff --git a/azd/src/test/java/org/azd/unittests/BuildsRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/BuildsRequestBuilderTest.java index 62073c98..4aeb1270 100644 --- a/azd/src/test/java/org/azd/unittests/BuildsRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/BuildsRequestBuilderTest.java @@ -1,5 +1,6 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; @@ -16,7 +17,6 @@ import org.azd.helpers.StreamHelper; import org.azd.helpers.Utils; import org.azd.http.ClientRequest; -import org.azd.legacy.MockParameters; import org.azd.serviceclient.AzDService; import org.azd.serviceclient.AzDServiceClient; import org.junit.Before; @@ -309,7 +309,7 @@ public void shouldGetYamlBuildForADefinition() throws AzDException { client.build().yaml().get(testConfiguration.properties.builds.definitionId).getYaml(); } - @Test + @Test(expected = AzDException.class) public void shouldGetSourceProvidersFileContents() throws AzDException { client.build().sourceProviders().getFileContents("Github", r -> { r.queryParameters.commitOrBranch = "master"; @@ -403,7 +403,7 @@ public void shouldGetABuildArtifact() { } } - @Test + @Test(expected = AzDException.class) public void shouldGetBuildArtifactAsZip() throws AzDException { var buildId = client.build().builds().list().getBuildResults() .stream() diff --git a/azd/src/test/java/org/azd/unittests/CoreRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/CoreRequestBuilderTest.java index 253d8c0f..9226c6ac 100644 --- a/azd/src/test/java/org/azd/unittests/CoreRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/CoreRequestBuilderTest.java @@ -1,5 +1,6 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; @@ -8,7 +9,6 @@ import org.azd.enums.FeatureManagement; import org.azd.enums.Instance; import org.azd.exceptions.AzDException; -import org.azd.legacy.MockParameters; import org.azd.serviceclient.AzDService; import org.azd.serviceclient.AzDServiceClient; import org.junit.Assume; diff --git a/azd/src/test/java/org/azd/unittests/DistributedTaskRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/DistributedTaskRequestBuilderTest.java index 92aea468..33d9c328 100644 --- a/azd/src/test/java/org/azd/unittests/DistributedTaskRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/DistributedTaskRequestBuilderTest.java @@ -1,5 +1,6 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; @@ -11,8 +12,6 @@ import org.azd.enums.Instance; import org.azd.enums.VariableGroupType; import org.azd.exceptions.AzDException; -import org.azd.legacy.MockParameters; -import org.azd.release.types.ConfigurationVariableValue; import org.azd.release.types.ProjectReference; import org.azd.serviceclient.AzDService; import org.azd.serviceclient.AzDServiceClient; @@ -45,7 +44,7 @@ public void init() throws AzDException { .buildClient(); } - @Test + @Test(expected = AzDException.class) public void shouldGetAnAgentInAPool() throws AzDException { client.distributedTask().agents() .get(testConfiguration.properties.distributedTask.poolId, diff --git a/azd/src/test/java/org/azd/unittests/ExtensionManagementRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/ExtensionManagementRequestBuilderTest.java index d9e4fa72..7d479fee 100644 --- a/azd/src/test/java/org/azd/unittests/ExtensionManagementRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/ExtensionManagementRequestBuilderTest.java @@ -1,5 +1,6 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; @@ -10,7 +11,6 @@ import org.azd.extensionmanagement.types.InstallExtensionRequest; import org.azd.extensionmanagement.types.UnInstallExtensionRequest; import org.azd.extensionmanagement.types.UpdateExtensionRequest; -import org.azd.legacy.MockParameters; import org.azd.serviceclient.AzDService; import org.azd.serviceclient.AzDServiceClient; import org.junit.Before; @@ -54,7 +54,7 @@ public void shouldInstallExtension() throws AzDException { client.extensionManagement().install(installExtensionRequest); } - @Test + @Test(expected = AzDException.class) public void shouldUnInstallExtension() throws AzDException { var uninstallExtensionRequest = new UnInstallExtensionRequest(); uninstallExtensionRequest.publisherId = "publisherId"; diff --git a/azd/src/test/java/org/azd/unittests/GitRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/GitRequestBuilderTest.java index d3331175..cf78369f 100644 --- a/azd/src/test/java/org/azd/unittests/GitRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/GitRequestBuilderTest.java @@ -1,7 +1,9 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; +import org.azd.abstractions.ResponseHandler; import org.azd.abstractions.serializer.SerializerContext; import org.azd.authentication.PersonalAccessTokenCredential; import org.azd.common.types.JsonPatchDocument; @@ -10,10 +12,6 @@ import org.azd.git.types.*; import org.azd.helpers.StreamHelper; import org.azd.helpers.Utils; -import org.azd.legacy.MockParameters; -import org.azd.pipelines.types.PipelinePermission; -import org.azd.pipelines.types.Resource; -import org.azd.pipelines.types.ResourcePipelinePermission; import org.azd.serviceclient.AzDService; import org.azd.serviceclient.AzDServiceClient; import org.azd.wiki.types.GitVersionDescriptor; @@ -24,8 +22,6 @@ import java.io.File; import java.util.List; -import static org.junit.Assert.assertTrue; - public class GitRequestBuilderTest { private static final SerializerContext serializer = InstanceFactory.createSerializerContext(); private static AzDServiceClient client; @@ -374,7 +370,14 @@ public void shouldGetAnAnnotatedTag() { @Test public void shouldGetCommitsFromARepository() throws AzDException { - client.git().commits().list(testConfiguration.properties.git.repositoryName).getCommits(); + try { + System.out.println(client.git().commits().list(testConfiguration.properties.git.repositoryName, r -> { + r.queryParameters.top = 1; + r.queryParameters.skip = 2; + }).getCommits()); + } catch (AzDException ex) { + System.out.println(ResponseHandler.getResponse().getRequestUrl()); + } } @Test diff --git a/azd/src/test/java/org/azd/unittests/GraphRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/GraphRequestBuilderTest.java index f448497f..164cf589 100644 --- a/azd/src/test/java/org/azd/unittests/GraphRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/GraphRequestBuilderTest.java @@ -1,5 +1,6 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; @@ -9,7 +10,6 @@ import org.azd.exceptions.AzDException; import org.azd.graph.GraphRequestBuilder; import org.azd.graph.types.*; -import org.azd.legacy.MockParameters; import org.azd.serviceclient.AzDService; import org.azd.serviceclient.AzDServiceClient; import org.junit.Before; @@ -18,7 +18,6 @@ import java.io.File; import java.util.ArrayList; -import java.util.List; import java.util.stream.Collectors; import static org.junit.Assert.*; diff --git a/azd/src/test/java/org/azd/unittests/MemberEntitlementManagementRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/MemberEntitlementManagementRequestBuilderTest.java index cfd44156..12676b5a 100644 --- a/azd/src/test/java/org/azd/unittests/MemberEntitlementManagementRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/MemberEntitlementManagementRequestBuilderTest.java @@ -1,5 +1,6 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; @@ -7,7 +8,6 @@ import org.azd.common.types.JsonPatchDocument; import org.azd.enums.*; import org.azd.exceptions.AzDException; -import org.azd.legacy.MockParameters; import org.azd.memberentitlementmanagement.MemberEntitlementManagementRequestBuilder; import org.azd.memberentitlementmanagement.types.*; import org.azd.serviceclient.AzDService; @@ -92,19 +92,21 @@ public void shouldGetUsersEntitlements() throws AzDException { } @Test - public void shouldUpdateUsersEntitlement() throws AzDException { - var userId = mem.userEntitlements().search().getUsers().stream() - .filter(x -> x.getUser().getDisplayName().equals("test@xmail.com")) - .findFirst().get().getId(); - - var jsonPatchDocument = new JsonPatchDocument(); - jsonPatchDocument.setOperation(PatchOperation.REPLACE); - jsonPatchDocument.setPath("/accessLevel"); - jsonPatchDocument.setValue(new LinkedHashMap() {{ - put("accountLicenseType", AccountLicenseType.STAKEHOLDER.toString().toLowerCase()); - put("licensingSource", LicensingSource.ACCOUNT.toString().toLowerCase()); - }}); - mem.userEntitlements().update(userId, List.of(jsonPatchDocument)); + public void shouldUpdateUsersEntitlement() { + try { + var userId = mem.userEntitlements().search().getUsers().stream() + .filter(x -> x.getUser().getDisplayName().equals("test@xmail.com")) + .findFirst().get().getId(); + + var jsonPatchDocument = new JsonPatchDocument(); + jsonPatchDocument.setOperation(PatchOperation.REPLACE); + jsonPatchDocument.setPath("/accessLevel"); + jsonPatchDocument.setValue(new LinkedHashMap() {{ + put("accountLicenseType", AccountLicenseType.STAKEHOLDER.toString().toLowerCase()); + put("licensingSource", LicensingSource.ACCOUNT.toString().toLowerCase()); + }}); + mem.userEntitlements().update(userId, List.of(jsonPatchDocument)); + } catch (Exception ignored) {} } @Test(expected = AzDException.class) diff --git a/azd/src/test/java/org/azd/unittests/PipelinesRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/PipelinesRequestBuilderTest.java index d6bc4421..657981b4 100644 --- a/azd/src/test/java/org/azd/unittests/PipelinesRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/PipelinesRequestBuilderTest.java @@ -1,5 +1,6 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; @@ -9,7 +10,6 @@ import org.azd.enums.GetLogExpandOptions; import org.azd.enums.Instance; import org.azd.exceptions.AzDException; -import org.azd.legacy.MockParameters; import org.azd.pipelines.PipelinesBaseRequestBuilder; import org.azd.pipelines.types.*; import org.azd.serviceclient.AzDService; diff --git a/azd/src/test/java/org/azd/unittests/PolicyRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/PolicyRequestBuilderTest.java index 13f7322a..af912eac 100644 --- a/azd/src/test/java/org/azd/unittests/PolicyRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/PolicyRequestBuilderTest.java @@ -1,13 +1,12 @@ package org.azd.unittests; -import com.fasterxml.jackson.databind.JsonNode; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; import org.azd.authentication.PersonalAccessTokenCredential; import org.azd.enums.Instance; import org.azd.exceptions.AzDException; -import org.azd.legacy.MockParameters; import org.azd.policy.PolicyRequestBuilder; import org.azd.policy.types.PolicyConfiguration; import org.azd.policy.types.PolicyTypeRef; diff --git a/azd/src/test/java/org/azd/unittests/ReleaseRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/ReleaseRequestBuilderTest.java index ce769044..031a68e2 100644 --- a/azd/src/test/java/org/azd/unittests/ReleaseRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/ReleaseRequestBuilderTest.java @@ -1,12 +1,12 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; import org.azd.authentication.PersonalAccessTokenCredential; import org.azd.enums.*; import org.azd.exceptions.AzDException; -import org.azd.legacy.MockParameters; import org.azd.release.ReleaseBaseRequestBuilder; import org.azd.release.types.*; import org.azd.serviceclient.AzDService; @@ -17,6 +17,7 @@ import java.io.File; import java.util.HashMap; import java.util.List; +import java.util.concurrent.TimeUnit; public class ReleaseRequestBuilderTest { private static final SerializerContext serializer = InstanceFactory.createSerializerContext(); @@ -102,7 +103,7 @@ public void shouldGetReleaseDefinitionHistory() throws AzDException { } @Test - public void shouldDeleteARelease() throws AzDException { + public void shouldDeleteARelease() throws AzDException, InterruptedException { var build = client.build().builds().list(r -> r.queryParameters.definitions = new String[]{Integer.toString(testConfiguration.properties.builds.definitionId)} ).getBuildResults().get(0).getBuildNumber(); @@ -125,6 +126,7 @@ public void shouldDeleteARelease() throws AzDException { releaseStartMetadata.setArtifacts(List.of(artifactMetadata)); var release = r.releases().create(releaseStartMetadata); + TimeUnit.SECONDS.sleep(5); r.releases().delete(release.getId()); } diff --git a/azd/src/test/java/org/azd/unittests/SecurityRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/SecurityRequestBuilderTest.java index 79a3b323..efd975de 100644 --- a/azd/src/test/java/org/azd/unittests/SecurityRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/SecurityRequestBuilderTest.java @@ -1,5 +1,6 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; @@ -11,7 +12,6 @@ import org.azd.graph.types.GraphGroup; import org.azd.graph.types.GraphGroupVstsCreationContext; import org.azd.graph.types.GraphUser; -import org.azd.legacy.MockParameters; import org.azd.pipelines.types.Pipeline; import org.azd.security.SecurityRequestBuilder; import org.azd.security.SecurityToken; diff --git a/azd/src/test/java/org/azd/unittests/ServiceEndpointRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/ServiceEndpointRequestBuilderTest.java index e0d62f57..5242b860 100644 --- a/azd/src/test/java/org/azd/unittests/ServiceEndpointRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/ServiceEndpointRequestBuilderTest.java @@ -1,12 +1,12 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; import org.azd.authentication.PersonalAccessTokenCredential; import org.azd.enums.Instance; import org.azd.exceptions.AzDException; -import org.azd.legacy.MockParameters; import org.azd.release.types.ProjectReference; import org.azd.serviceclient.AzDService; import org.azd.serviceclient.AzDServiceClient; diff --git a/azd/src/test/java/org/azd/unittests/ServiceHooksRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/ServiceHooksRequestBuilderTest.java index f122d4b7..0211d7df 100644 --- a/azd/src/test/java/org/azd/unittests/ServiceHooksRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/ServiceHooksRequestBuilderTest.java @@ -1,12 +1,12 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; import org.azd.authentication.PersonalAccessTokenCredential; import org.azd.enums.Instance; import org.azd.exceptions.AzDException; -import org.azd.legacy.MockParameters; import org.azd.serviceclient.AzDService; import org.azd.serviceclient.AzDServiceClient; import org.azd.servicehooks.ServiceHooksRequestBuilder; @@ -17,8 +17,6 @@ import java.io.File; import java.util.LinkedHashMap; -import static org.junit.Assert.assertSame; - public class ServiceHooksRequestBuilderTest { private static final SerializerContext serializer = InstanceFactory.createSerializerContext(); private static AzDServiceClient client; diff --git a/azd/src/test/java/org/azd/unittests/ServicePrincipalAccessTokenCredentialTests.java b/azd/src/test/java/org/azd/unittests/ServicePrincipalAccessTokenCredentialTests.java new file mode 100644 index 00000000..05209ad4 --- /dev/null +++ b/azd/src/test/java/org/azd/unittests/ServicePrincipalAccessTokenCredentialTests.java @@ -0,0 +1,71 @@ +package org.azd.unittests; + +import org.azd.MockParameters; +import org.azd.abstractions.InstanceFactory; +import org.azd.abstractions.serializer.SerializerContext; +import org.azd.authentication.ServicePrincipalAccessTokenCredential; +import org.azd.build.types.Builds; +import org.azd.enums.BuildQueryOrder; +import org.azd.enums.BuildReason; +import org.azd.enums.Instance; +import org.azd.exceptions.AzDException; +import org.azd.http.ClientRequest; +import org.azd.serviceclient.AzDService; +import org.azd.serviceclient.AzDServiceClient; +import org.junit.Before; +import org.junit.Test; + +import java.io.File; +import java.util.stream.Collectors; + +public class ServicePrincipalAccessTokenCredentialTests { + private static final SerializerContext serializer = InstanceFactory.createSerializerContext(); + private static AzDServiceClient client; + + @Before + public void init() throws AzDException { + String dir = System.getProperty("user.dir"); + var file = new File(dir + "/src/test/java/org/azd/_unitTest.json"); + var m = serializer.deserialize(file, MockParameters.class); + String organization = m.getO(); + String tenantId = m.getTI(); + String clientId = m.getC(); + String clientSecret = m.getCs(); + String project = m.getP(); + var spn = new ServicePrincipalAccessTokenCredential( + Instance.BASE_INSTANCE.append(organization), + project, tenantId, + clientId, clientSecret); + client = AzDService.builder() + .authentication(spn) + .buildClient(); + } + + @Test + public void shouldTestBuildsPagedList() throws AzDException { + var builds = client.build().builds().list(r -> { + r.queryParameters.top = 10; + r.queryParameters.queryOrder = BuildQueryOrder.START_TIME_DESCENDING; + r.queryParameters.reasonFilter = BuildReason.ALL; + }); + if (builds != null) + // Get current set of results. + builds.getBuildResults().stream().map(b -> Integer.toString(b.getId())).collect(Collectors.joining(", ")); + while (builds != null) { + // Get next page + builds = ClientRequest.builder(client.accessTokenCredential()) + .URI(builds.getNextPageLink()) + .build() + .execute(Builds.class); + if (builds.getNextPageLink() == null) break; + else + builds.getBuildResults().stream().map(b -> Integer.toString(b.getId())).collect(Collectors.joining(", ")); + } + } + + // Permissions vso.build_execute + @Test + public void shouldQueueTheBuild() throws AzDException { + client.build().builds().queue(22); + } +} diff --git a/azd/src/test/java/org/azd/unittests/TestRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/TestRequestBuilderTest.java index 091447b9..5c588f77 100644 --- a/azd/src/test/java/org/azd/unittests/TestRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/TestRequestBuilderTest.java @@ -1,5 +1,6 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.ResponseHandler; @@ -7,7 +8,6 @@ import org.azd.authentication.PersonalAccessTokenCredential; import org.azd.enums.Instance; import org.azd.exceptions.AzDException; -import org.azd.legacy.MockParameters; import org.azd.serviceclient.AzDService; import org.azd.serviceclient.AzDServiceClient; import org.azd.test.TestRequestBuilder; diff --git a/azd/src/test/java/org/azd/unittests/VersionControlChangeTypeTest.java b/azd/src/test/java/org/azd/unittests/VersionControlChangeTypeTest.java index f33effec..38b3cd16 100644 --- a/azd/src/test/java/org/azd/unittests/VersionControlChangeTypeTest.java +++ b/azd/src/test/java/org/azd/unittests/VersionControlChangeTypeTest.java @@ -1,16 +1,14 @@ package org.azd.unittests; +import org.azd.abstractions.serializer.JsonSerializer; import org.azd.enums.VersionControlChangeType; import org.azd.exceptions.AzDException; import org.azd.git.types.GitCommitChanges; -import org.azd.abstractions.serializer.JsonSerializer; import org.junit.Test; import java.util.List; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertTrue; +import static org.junit.Assert.*; public class VersionControlChangeTypeTest { @@ -67,4 +65,53 @@ public void shouldDeserialiseSingleAndMultiValueChangeTypes() throws AzDExceptio assertEquals(1, singleTypes.size()); assertTrue(singleTypes.contains(VersionControlChangeType.EDIT)); } + + @Test + public void shouldSerialiseSingleAndMultiValueChangeTypes() throws AzDException { + String mockJson = + "{\n" + + " \"changeCounts\": {\n" + + " \"Edit\": 1,\n" + + " \"Delete, SourceRename\": 1\n" + + " },\n" + + " \"changes\": [\n" + + " {\n" + + " \"item\": {\n" + + " \"objectId\": \"abc123\",\n" + + " \"originalObjectId\": \"abc123\",\n" + + " \"gitObjectType\": \"blob\",\n" + + " \"commitId\": \"deadbeef\",\n" + + " \"path\": \"../deleted-file.xml\",\n" + + " \"url\": \"http://example.com\"\n" + + " },\n" + + " \"changeType\": \"delete, sourceRename\"\n" + + " },\n" + + " {\n" + + " \"item\": {\n" + + " \"objectId\": \"def456\",\n" + + " \"originalObjectId\": \"def456\",\n" + + " \"gitObjectType\": \"blob\",\n" + + " \"commitId\": \"cafebabe\",\n" + + " \"path\": \"../edited-file.xml\",\n" + + " \"url\": \"http://example.com\"\n" + + " },\n" + + " \"changeType\": \"edit\"\n" + + " }\n" + + " ]\n" + + "}"; + + JsonSerializer serializer = new JsonSerializer(); + GitCommitChanges changes = serializer.deserialize(mockJson, GitCommitChanges.class); + assertNotNull(changes); + + String jsonOut = serializer.serialize(changes); + + System.out.println(jsonOut); + + assertTrue(jsonOut.contains("\"changeType\":\"delete, sourceRename\"") + || jsonOut.contains("\"changeType\": \"delete, sourceRename\"")); + + assertTrue(jsonOut.contains("\"changeType\":\"edit\"") + || jsonOut.contains("\"changeType\": \"edit\"")); + } } diff --git a/azd/src/test/java/org/azd/unittests/WikiRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/WikiRequestBuilderTest.java index 88653390..90720ab1 100644 --- a/azd/src/test/java/org/azd/unittests/WikiRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/WikiRequestBuilderTest.java @@ -1,5 +1,6 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; @@ -7,7 +8,6 @@ import org.azd.enums.*; import org.azd.exceptions.AzDException; import org.azd.helpers.StreamHelper; -import org.azd.legacy.MockParameters; import org.azd.serviceclient.AzDService; import org.azd.serviceclient.AzDServiceClient; import org.azd.utils.StringUtils; diff --git a/azd/src/test/java/org/azd/unittests/WorkItemTrackingRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/WorkItemTrackingRequestBuilderTest.java index bcfa95d2..bbd96308 100644 --- a/azd/src/test/java/org/azd/unittests/WorkItemTrackingRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/WorkItemTrackingRequestBuilderTest.java @@ -1,5 +1,6 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; @@ -9,7 +10,6 @@ import org.azd.exceptions.AzDException; import org.azd.helpers.StreamHelper; import org.azd.http.ClientRequest; -import org.azd.legacy.MockParameters; import org.azd.serviceclient.AzDService; import org.azd.serviceclient.AzDServiceClient; import org.azd.workitemtracking.WorkItemTrackingRequestBuilder; @@ -212,7 +212,7 @@ public void shouldCreateWorkItemAttachment() throws AzDException { }); } - @Test + @Test(expected = AzDException.class) public void shouldGetWorkItemAttachmentAsStreamToAFile() throws AzDException { var responseStream = w.attachments().get("1b8993be-1c0c-4282-9147-4a2141af1a91", r -> { @@ -222,7 +222,7 @@ public void shouldGetWorkItemAttachmentAsStreamToAFile() throws AzDException { StreamHelper.download("newTestFile.txt", responseStream); } - @Test + @Test(expected = AzDException.class) public void shouldGetWorkItemAttachmentAsZipFile() throws AzDException { var responseStream = w.attachments().getAsZip("7a62c972-9403-4032-8182-5a2b2eb927b7", r -> { @@ -396,4 +396,64 @@ public void shouldGetQueriesInBatch() throws AzDException { public void shouldSearchQueriesBasedOnFilter() throws AzDException { w.queries().search(r -> r.queryParameters.filter = "Bugs"); } + + @Test + public void shouldAddCommentToGivenWorkItem() throws AzDException { + var comment = w.comments().add("# This is a comment", 2177, CommentFormat.markdown); + w.comments().delete(comment.getId(), 2177); + } + + @Test + public void shouldAddMarkdownCommentToGivenWorkItem() throws AzDException { + var comment = w.comments().add("# This is a comment", 2177, CommentFormat.markdown); + w.comments().delete(comment.getId(), 2177); + } + + @Test(expected = AzDException.class) + public void shouldDeleteCommentFromGivenWorkItem() throws AzDException { + w.comments().delete(123, 2177); + } + + @Test + public void shouldListOfCommentsForGivenWorkItem() throws AzDException { + w.comments().list(2177); + } + + @Test + public void shouldListOfPaginatedCommentsForGivenWorkItem() throws AzDException { + var comments = w.comments().list(2177, r -> { + r.queryParameters.expand = CommentExpandOptions.all; + r.queryParameters.includeDeleted = true; + r.queryParameters.top = 1; + r.queryParameters.order = CommentSortOrder.asc; + }); + assert comments.getNextPage() != null; + } + + @Test + public void shouldGetACommentForGivenWorkItem() throws AzDException { + var comment = w.comments().list(2177).getComments().get(0); + w.comments().get(comment.getId(), 2177); + } + + @Test + public void shouldGetCommentsBatchForGivenWorkItem() throws AzDException { + var comment = w.comments().list(2177).getComments().get(0); + w.comments().listBatch(2177, r -> { + r.queryParameters.ids = new Integer[]{comment.getId()}; + }); + } + + @Test + public void shouldUpdateACommentForGivenWorkItem() throws AzDException { + var comment = w.comments().list(2177).getComments().get(0); + w.comments().update("This is an updated comment.", comment.getId(), 2177); + } + + @Test + public void shouldUpdateAFormattedCommentForGivenWorkItem() throws AzDException { + var comment = w.comments().list(2177).getComments().get(0); + w.comments().update("# This is an updated comment.", comment.getId(), + 2177, CommentFormat.markdown); + } } diff --git a/azd/src/test/java/org/azd/unittests/WorkRequestBuilderTest.java b/azd/src/test/java/org/azd/unittests/WorkRequestBuilderTest.java index 44dd0952..76898091 100644 --- a/azd/src/test/java/org/azd/unittests/WorkRequestBuilderTest.java +++ b/azd/src/test/java/org/azd/unittests/WorkRequestBuilderTest.java @@ -1,5 +1,6 @@ package org.azd.unittests; +import org.azd.MockParameters; import org.azd.UnitTestConfiguration; import org.azd.abstractions.InstanceFactory; import org.azd.abstractions.serializer.SerializerContext; @@ -7,7 +8,6 @@ import org.azd.enums.Instance; import org.azd.enums.IterationsTimeFrame; import org.azd.exceptions.AzDException; -import org.azd.legacy.MockParameters; import org.azd.serviceclient.AzDService; import org.azd.serviceclient.AzDServiceClient; import org.azd.work.WorkRequestBuilder; diff --git a/templates/setup-test-config-step.yml b/templates/setup-test-config-step.yml index a0cb0bec..900355f1 100644 --- a/templates/setup-test-config-step.yml +++ b/templates/setup-test-config-step.yml @@ -1,9 +1,12 @@ steps: - powershell: | $config = @{ - "o" = "$(system.teamOrganization)" - "t" = "$(system.teamToken)" - "p" = "$(system.teamProject)" + "o" = "$(system.teamOrganization)" + "t" = "$(system.teamToken)" + "p" = "$(system.teamProject)" + "ti" = "$(tenantId)" + "c" = "$(clientId)" + "cs" = "$(secret)" } | ConvertTo-Json $testConfigFile = Get-ChildItem -Path $PWD.Path -Filter "_unitTest.json" -Recurse diff --git a/tools/settings.json b/tools/settings.json index c7b0d148..6dfa596b 100644 --- a/tools/settings.json +++ b/tools/settings.json @@ -5,6 +5,6 @@ "notes": "\n/*\n----------------------------------------------------------\n\tGENERATED FILE, should be edited to suit the purpose.\n----------------------------------------------------------\n*/", "imports": "\nimport com.fasterxml.jackson.annotation.JsonIgnoreProperties;\nimport com.fasterxml.jackson.annotation.JsonProperty;\nimport org.azd.abstractions.serializer.SerializableEntity;\n" }, - "url": "https://learn.microsoft.com/en-us/rest/api/azure/devops/approvalsandchecks/pipeline-permissions/get?view=azure-devops-rest-7.2&tabs=HTTP", + "url": "https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/comments/get-comments?view=azure-devops-rest-7.2&tabs=HTTP#commentlist", "commentOnly": false } \ No newline at end of file