Implemented features for STG 76 (Azure#18679)

Author: gapra-msft

eng/code-quality-reports/src/main/resources/revapi/revapi.json

@@ -269,7 +269,20 @@
         "code": "java.annotation.added",
         "new": "class com.azure.storage.blob.models.PageList",
         "justification": "Annotation required to resolve deserialization bug."
-      },{
+      },
+      {
+        "code": "java.annotation.attributeValueChanged",
+        "old": "class com.azure.storage.file.share.models.ShareProtocolSettings",
+        "new": "class com.azure.storage.file.share.models.ShareProtocolSettings",
+        "justification": "Annotation required to resolve a swagger error. The value is now correct."
+      },
+      {
+        "code": "java.annotation.attributeValueChanged",
+        "old": "class com.azure.storage.file.share.models.ShareSmbSettings",
+        "new": "class com.azure.storage.file.share.models.ShareSmbSettings",
+        "justification": "Annotation required to resolve a swagger error. The value is now correct."
+      },
+      {
         "code": "java.method.returnTypeChanged",
         "old": "method com.azure.core.util.IterableStream<byte[]> com.azure.core.amqp.models.AmqpDataBody::getData()",
         "new": "method java.util.List<byte[]> com.azure.core.amqp.models.AmqpDataBody::getData()",

sdk/storage/azure-storage-blob-batch/CHANGELOG.md

@@ -1,7 +1,8 @@
 # Release History
 
 ## 12.9.0-beta.1 (Unreleased)
-
+- Added support for the 2020-06-12 service version. 
+- Added support to create a BlobBatchClient from a BlobContainerClient to perform container level operations.
 
 ## 12.8.0 (2021-01-14)
 - GA release

sdk/storage/azure-storage-blob-batch/src/main/java/com/azure/storage/blob/batch/BlobBatchAsyncClient.java

@@ -51,13 +51,15 @@ public final class BlobBatchAsyncClient {
     private final ClientLogger logger = new ClientLogger(BlobBatchAsyncClient.class);
 
     private final AzureBlobStorageImpl client;
+    private final boolean containerScoped;
 
-    BlobBatchAsyncClient(String accountUrl, HttpPipeline pipeline, BlobServiceVersion version) {
+    BlobBatchAsyncClient(String clientUrl, HttpPipeline pipeline, BlobServiceVersion version, boolean containerScoped) {
         this.client = new AzureBlobStorageBuilder()
-            .url(accountUrl)
+            .url(clientUrl)
             .pipeline(pipeline)
             .version(version.getVersion())
             .build();
+        this.containerScoped = containerScoped;
     }
 
     /**
@@ -121,12 +123,18 @@ public Mono<Response<Void>> submitBatchWithResponse(BlobBatch batch, boolean thr
     }
 
     Mono<Response<Void>> submitBatchWithResponse(BlobBatch batch, boolean throwOnAnyFailure, Context context) {
+        Context finalContext = context == null ? Context.NONE : context;
         return batch.prepareBlobBatchSubmission()
-            .flatMap(batchOperationInfo -> client.services()
-                .submitBatchWithRestResponseAsync(Flux.fromIterable(batchOperationInfo.getBody()),
-                    batchOperationInfo.getContentLength(), batchOperationInfo.getContentType(),
-                    context == null ? Context.NONE.addData(AZ_TRACING_NAMESPACE_KEY, STORAGE_TRACING_NAMESPACE_VALUE)
-                    : context.addData(AZ_TRACING_NAMESPACE_KEY, STORAGE_TRACING_NAMESPACE_VALUE))
+            .flatMap(batchOperationInfo -> containerScoped
+                ? client.containers().submitBatchWithRestResponseAsync(null,
+                Flux.fromIterable(batchOperationInfo.getBody()),
+                batchOperationInfo.getContentLength(), batchOperationInfo.getContentType(),
+                finalContext.addData(AZ_TRACING_NAMESPACE_KEY, STORAGE_TRACING_NAMESPACE_VALUE))
+                .flatMap(response ->
+                    BlobBatchHelper.mapBatchResponse(batchOperationInfo, response, throwOnAnyFailure, logger))
+                : client.services().submitBatchWithRestResponseAsync(Flux.fromIterable(batchOperationInfo.getBody()),
+                batchOperationInfo.getContentLength(), batchOperationInfo.getContentType(),
+                finalContext.addData(AZ_TRACING_NAMESPACE_KEY, STORAGE_TRACING_NAMESPACE_VALUE))
                 .flatMap(response ->
                     BlobBatchHelper.mapBatchResponse(batchOperationInfo, response, throwOnAnyFailure, logger)));
     }

sdk/storage/azure-storage-blob-batch/src/main/java/com/azure/storage/blob/batch/BlobBatchClient.java

@@ -162,6 +162,7 @@ public PagedIterable<Response<Void>> setBlobsAccessTier(List<String> blobUrls, A
      * @throws BlobStorageException If the batch request is malformed.
      * @throws BlobBatchStorageException If any of the set tier operations fail.
      */
+    @ServiceMethod(returns = ReturnType.COLLECTION)
     public PagedIterable<Response<Void>> setBlobsAccessTier(List<String> blobUrls, AccessTier accessTier,
         Duration timeout, Context context) {
         return new PagedIterable<>(client.setBlobsAccessTierWithTimeout(blobUrls, accessTier, timeout, context));

sdk/storage/azure-storage-blob-batch/src/main/java/com/azure/storage/blob/batch/BlobBatchClientBuilder.java

@@ -5,6 +5,8 @@
 
 import com.azure.core.annotation.ServiceClientBuilder;
 import com.azure.core.http.HttpPipeline;
+import com.azure.storage.blob.BlobContainerAsyncClient;
+import com.azure.storage.blob.BlobContainerClient;
 import com.azure.storage.blob.BlobServiceAsyncClient;
 import com.azure.storage.blob.BlobServiceClient;
 import com.azure.storage.blob.BlobServiceVersion;
@@ -16,9 +18,10 @@
  */
 @ServiceClientBuilder(serviceClients = {BlobBatchClient.class, BlobBatchAsyncClient.class})
 public final class BlobBatchClientBuilder {
-    private final String accountUrl;
+    private final String clientUrl;
     private final HttpPipeline pipeline;
     private final BlobServiceVersion version;
+    private final boolean containerScoped;
 
     /**
      * Constructs the {@link BlobBatchClientBuilder} using the {@link BlobServiceClient#getAccountUrl() account URL} and
@@ -27,22 +30,52 @@ public final class BlobBatchClientBuilder {
      * @param client {@link BlobServiceClient} whose properties are used to configure the builder.
      */
     public BlobBatchClientBuilder(BlobServiceClient client) {
-        this.accountUrl = client.getAccountUrl();
+        this.clientUrl = client.getAccountUrl();
         this.pipeline = client.getHttpPipeline();
         this.version = client.getServiceVersion();
+        this.containerScoped = false;
     }
 
     /**
      * Constructs the {@link BlobBatchClientBuilder} using the {@link BlobServiceAsyncClient#getAccountUrl() account
      * URL} and {@link BlobServiceAsyncClient#getHttpPipeline() HttpPipeline} properties of the passed {@link
      * BlobServiceAsyncClient}.
      *
-     * @param client {@link BlobServiceClient} whose properties are used to configure the builder.
+     * @param client {@link BlobServiceAsyncClient} whose properties are used to configure the builder.
      */
     public BlobBatchClientBuilder(BlobServiceAsyncClient client) {
-        this.accountUrl = client.getAccountUrl();
+        this.clientUrl = client.getAccountUrl();
+        this.pipeline = client.getHttpPipeline();
+        this.version = client.getServiceVersion();
+        this.containerScoped = false;
+    }
+
+    /**
+     * Constructs the {@link BlobBatchClientBuilder} using the {@link BlobContainerClient#getBlobContainerUrl()
+     * container URL} and {@link BlobContainerClient#getHttpPipeline() HttpPipeline} properties of the passed
+     * {@link BlobContainerClient}.
+     *
+     * @param client {@link BlobContainerClient} whose properties are used to configure the builder.
+     */
+    public BlobBatchClientBuilder(BlobContainerClient client) {
+        this.clientUrl = client.getBlobContainerUrl();
+        this.pipeline = client.getHttpPipeline();
+        this.version = client.getServiceVersion();
+        this.containerScoped = true;
+    }
+
+    /**
+     * Constructs the {@link BlobBatchClientBuilder} using the {@link BlobContainerAsyncClient#getBlobContainerUrl()
+     * container URL} and {@link BlobContainerAsyncClient#getHttpPipeline() HttpPipeline} properties of the
+     * passed {@link BlobContainerAsyncClient}.
+     *
+     * @param client {@link BlobContainerAsyncClient} whose properties are used to configure the builder.
+     */
+    public BlobBatchClientBuilder(BlobContainerAsyncClient client) {
+        this.clientUrl = client.getBlobContainerUrl();
         this.pipeline = client.getHttpPipeline();
         this.version = client.getServiceVersion();
+        this.containerScoped = true;
     }
 
     /**
@@ -69,6 +102,6 @@ public BlobBatchClient buildClient() {
      */
     public BlobBatchAsyncClient buildAsyncClient() {
         BlobServiceVersion serviceVersion = version != null ? version : BlobServiceVersion.getLatest();
-        return new BlobBatchAsyncClient(accountUrl, pipeline, serviceVersion);
+        return new BlobBatchAsyncClient(clientUrl, pipeline, serviceVersion, containerScoped);
     }
 }

sdk/storage/azure-storage-blob-batch/src/main/java/com/azure/storage/blob/batch/BlobBatchHelper.java

@@ -6,12 +6,13 @@
 import com.azure.core.http.HttpHeaders;
 import com.azure.core.http.HttpRequest;
 import com.azure.core.http.HttpResponse;
+import com.azure.core.http.rest.Response;
 import com.azure.core.http.rest.SimpleResponse;
 import com.azure.core.util.CoreUtils;
 import com.azure.core.util.FluxUtil;
 import com.azure.core.util.logging.ClientLogger;
-import com.azure.storage.blob.implementation.models.ServicesSubmitBatchResponse;
 import com.azure.storage.blob.models.BlobStorageException;
+import com.azure.storage.common.implementation.Constants;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
@@ -52,12 +53,12 @@ class BlobBatchHelper {
 
     // This method connects the batch response values to the individual batch operations based on their Content-Id
     static Mono<SimpleResponse<Void>> mapBatchResponse(BlobBatchOperationInfo batchOperationInfo,
-        ServicesSubmitBatchResponse batchResponse, boolean throwOnAnyFailure, ClientLogger logger) {
+        Response<Flux<ByteBuffer>> rawResponse, boolean throwOnAnyFailure, ClientLogger logger) {
         /*
          * Content-Type will contain the boundary for each batch response. The expected format is:
          * "Content-Type: multipart/mixed; boundary=batchresponse_66925647-d0cb-4109-b6d3-28efe3e1e5ed"
          */
-        String contentType = batchResponse.getDeserializedHeaders().getContentType();
+        String contentType = rawResponse.getHeaders().getValue(Constants.HeaderConstants.CONTENT_TYPE);
 
         // Split on the boundary [ "multipart/mixed; boundary", "batchresponse_66925647-d0cb-4109-b6d3-28efe3e1e5ed"]
         String[] boundaryPieces = contentType.split("=", 2);
@@ -68,7 +69,7 @@ static Mono<SimpleResponse<Void>> mapBatchResponse(BlobBatchOperationInfo batchO
 
         String boundary = boundaryPieces[1];
 
-        return FluxUtil.collectBytesInByteBufferStream(batchResponse.getValue())
+        return FluxUtil.collectBytesInByteBufferStream(rawResponse.getValue())
             .flatMap(byteArrayBody -> Mono.fromRunnable(() -> {
                 String body = new String(byteArrayBody, StandardCharsets.UTF_8);
                 List<BlobStorageException> exceptions = new ArrayList<>();
@@ -79,8 +80,9 @@ static Mono<SimpleResponse<Void>> mapBatchResponse(BlobBatchOperationInfo batchO
                     int statusCode = getStatusCode(exceptionSections[1], logger);
                     HttpHeaders headers = getHttpHeaders(exceptionSections[1]);
 
-                    throw logger.logExceptionAsError(new BlobStorageException(headers.getValue("x-ms-error-code"),
-                        createHttpResponse(batchResponse.getRequest(), statusCode, headers, body), body));
+                    throw logger.logExceptionAsError(new BlobStorageException(
+                        headers.getValue(Constants.HeaderConstants.ERROR_CODE),
+                        createHttpResponse(rawResponse.getRequest(), statusCode, headers, body), body));
                 }
 
                 // Split the batch response body into batch operation responses.
@@ -110,10 +112,10 @@ static Mono<SimpleResponse<Void>> mapBatchResponse(BlobBatchOperationInfo batchO
 
                 if (throwOnAnyFailure && exceptions.size() != 0) {
                     throw logger.logExceptionAsError(new BlobBatchStorageException("Batch had operation failures.",
-                        createHttpResponse(batchResponse), exceptions));
+                        createHttpResponse(rawResponse), exceptions));
                 }
 
-                new SimpleResponse<>(batchResponse, null);
+                new SimpleResponse<>(rawResponse, null);
             }));
     }
 
@@ -212,7 +214,7 @@ public Mono<String> getBodyAsString(Charset charset) {
         };
     }
 
-    private static HttpResponse createHttpResponse(ServicesSubmitBatchResponse response) {
+    private static HttpResponse createHttpResponse(Response<Flux<ByteBuffer>> response) {
         return new HttpResponse(response.getRequest()) {
             @Override
             public int getStatusCode() {

sdk/storage/azure-storage-blob-batch/src/test/java/com/azure/storage/blob/batch/APISpec.groovy

@@ -13,6 +13,8 @@ import com.azure.core.test.utils.TestResourceNamer
 import com.azure.core.util.Configuration
 import com.azure.core.util.logging.ClientLogger
 import com.azure.identity.EnvironmentCredentialBuilder
+import com.azure.storage.blob.BlobContainerClient
+import com.azure.storage.blob.BlobContainerClientBuilder
 import com.azure.storage.blob.BlobServiceAsyncClient
 import com.azure.storage.blob.BlobServiceClient
 import com.azure.storage.blob.BlobServiceClientBuilder
@@ -26,6 +28,7 @@ import spock.lang.Specification
 
 import java.nio.ByteBuffer
 import java.nio.charset.StandardCharsets
+import java.time.OffsetDateTime
 import java.util.function.Supplier
 
 class APISpec extends Specification {
@@ -180,6 +183,10 @@ class APISpec extends Specification {
         return getServiceClientBuilder(credential, endpoint, policies).buildClient()
     }
 
+    BlobServiceClient getServiceClient(String sasToken, String endpoint) {
+        return getServiceClientBuilder(null, endpoint, null).sasToken(sasToken).buildClient()
+    }
+
     BlobServiceAsyncClient getServiceAsyncClient(StorageSharedKeyCredential credential) {
         return getServiceClientBuilder(credential, String.format(defaultEndpointTemplate, credential.getAccountName()))
             .buildAsyncClient()
@@ -206,6 +213,22 @@ class APISpec extends Specification {
         return builder
     }
 
+    BlobContainerClient getContainerClient(String sasToken, String endpoint) {
+        getContainerClientBuilder(endpoint).sasToken(sasToken).buildClient()
+    }
+
+    BlobContainerClientBuilder getContainerClientBuilder(String endpoint) {
+        BlobContainerClientBuilder builder = new BlobContainerClientBuilder()
+            .endpoint(endpoint)
+            .httpClient(getHttpClient())
+
+        if (testMode == TestMode.RECORD) {
+            builder.addPolicy(interceptorManager.getRecordPolicy())
+        }
+
+        return builder
+    }
+
     HttpClient getHttpClient() {
         NettyAsyncHttpClientBuilder builder = new NettyAsyncHttpClientBuilder()
         if (testMode != TestMode.PLAYBACK) {
@@ -233,6 +256,10 @@ class APISpec extends Specification {
         return resourceNamer.randomName(prefix + testName + entityNo, 63)
     }
 
+    OffsetDateTime getUTCNow() {
+        return resourceNamer.now()
+    }
+
     /**
      * This helper method will acquire a lease on a blob to prepare for testing lease Id. We want to test
      * against a valid lease in both the success and failure cases to guarantee that the results actually indicate