Add Storage Module to POM (#4338)

* Add storage to pom as a module

* Bumping Azure Core to preview.3 as preview.2 already exists in Maven with different code

* Bulk of CheckStyle cleanup

* Last of CheckStyle cleanup

* Bulk of SpotBugs cleanup

* Cleaned up JavaDocs

* Updating AppConfiguration and KeyVault to use the correct Azure Core

* Revert version number

* Fixed error in configuration file

* Cleaning up SpotBug configurations

* Fixed client POM

* Fixed sample code

* Fixing unit tests and JavaDoc bug

* Linting cleanup for samples

* Fix last of SpotBug configuration issues

eng/code-quality-reports/src/main/resources/spotbugs/spotbugs-exclude.xml

@@ -61,7 +61,10 @@
   <!-- Suppress non-null warning in the case that we change the code and it is possible for
   KeyVaultCredentials.getAuthenticationCredentials to return null. -->
   <Match>
-    <Class name="com.microsoft.azure.keyvault.authentication.KeyVaultCredentials"/>
+    <Or>
+      <Class name="com.microsoft.azure.keyvault.authentication.KeyVaultCredentials"/>
+      <Class name="com.azure.storage.blob.implementation.AzureBlobStorageBuilder"/>
+    </Or>
     <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE"/>
   </Match>
 
@@ -104,7 +107,10 @@
   <!-- Known issue in autorest where it will generate a variable with a value of null.
   https://github.com/Azure/autorest.java/issues/324 -->
   <Match>
-    <Class name="~com\.microsoft\.azure\.(.+)Impl"/>
+    <Or>
+      <Class name="~com\.microsoft\.azure\.(.+)Impl"/>
+      <Class name="~com\.azure\.(.+)Impl"/>
+    </Or>
     <Bug pattern="NP_LOAD_OF_KNOWN_NULL_VALUE"/>
   </Match>
 
@@ -238,7 +244,10 @@
   <!-- Known issue in autorest where it will generate a variable with a value of null then use it in a not null check.
   https://github.com/Azure/autorest.java/issues/328 -->
   <Match>
-    <Class name="~com\.microsoft\.azure\.batch\.protocol\.implementation\.[\w]+Impl"/>
+    <Or>
+      <Class name="~com\.microsoft\.azure\.batch\.protocol\.implementation\.[\w]+Impl"/>
+      <Class name="com.azure.storage.blob.implementation.AzureBlobStorageBuilder"/>
+    </Or>
     <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE"/>
   </Match>
 
@@ -357,7 +366,10 @@
 
   <!-- Exclude the confusing name bugs as it is designed to name the same as autorest. -->
   <Match>
-    <Package name="com.microsoft.azure.storage.blob"/>
+    <Or>
+      <Package name="com.microsoft.azure.storage.blob"/>
+      <Class name="com.azure.storage.blob.HTTPGetterInfo"/>
+    </Or>
     <Bug pattern="NM_CONFUSING"/>
   </Match>
 
@@ -422,6 +434,15 @@
     <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
   </Match>
 
+  <!-- Incorrect flagging, if the response is null a StorageException would have been thrown -->
+  <Match>
+    <Or>
+      <Class name="com.azure.storage.blob.BlobInputStream"/>
+      <Class name="com.azure.storage.blob.BlobOutputStream"/>
+    </Or>
+    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
+  </Match>
+
   <!-- Super doesn't need to be cloned since it is Object -->
   <Match>
     <Class name="com.azure.core.util.configuration.Configuration"/>

pom.client.xml

@@ -385,6 +385,10 @@
                 <title>Azure Key Vault</title>
                 <packages>com.azure.security.keyvault*</packages>
               </group>
+              <group>
+                <title>Azure Storage - Blobs</title>
+                <packages>com.azure.storage.blob*</packages>
+              </group>
             </groups>
             <links>
               <link>https://docs.oracle.com/javase/8/docs/api/</link>
@@ -740,5 +744,6 @@
     <!-- As recommended by Eng Sys team, removing tracing as it is built and released separately -->
     <!--    <module>./sdk/tracing</module>-->
     <module>./sdk/identity/azure-identity</module>
+    <module>./storage/client/blob</module>
   </modules>
 </project>

storage/client/blob/pom.xml

@@ -56,16 +56,20 @@
       <artifactId>slf4j-api</artifactId>
     </dependency>
 
+    <!-- Added this dependency to include necessary annotations used by reactor core.
+        Without this dependency, javadoc throws a warning as it cannot find enum When.MAYBE
+        which is used in @Nullable annotation in reactor core classes -->
     <dependency>
-      <groupId>com.azure</groupId>
-      <artifactId>azure-core-test</artifactId>
-      <version>1.0.0-preview.2</version>
-      <scope>test</scope>
+      <groupId>com.google.code.findbugs</groupId>
+      <artifactId>jsr305</artifactId>
+      <version>3.0.2</version>
+      <scope>provided</scope>
     </dependency>
+
     <dependency>
       <groupId>com.azure</groupId>
-      <artifactId>azure-identity</artifactId>
-      <version>1.0.0-preview.1</version>
+      <artifactId>azure-core-test</artifactId>
+      <version>1.0.0-preview.2</version>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -141,64 +145,7 @@
           </dependency>
         </dependencies>
       </plugin>
-      <!-- Now that all checkstyle issues have been resolved, override the
-             default behavior to make checkstyle fail on error and violation. -->
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-checkstyle-plugin</artifactId>
-        <configuration>
-          <failsOnError>false</failsOnError>
-          <failOnViolation>false</failOnViolation>
-        </configuration>
-      </plugin>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-javadoc-plugin</artifactId>
-        <configuration>
-          <failOnError>false</failOnError>
-          <failOnWarnings>false</failOnWarnings>
-        </configuration>
-      </plugin>
-
-      <plugin>
-        <groupId>com.github.spotbugs</groupId>
-        <artifactId>spotbugs-maven-plugin</artifactId>
-        <configuration>
-          <failOnError>false</failOnError>
-        </configuration>
-      </plugin>
     </plugins>
   </build>
 
-  <reporting>
-    <plugins>
-      <!-- Now that all checkstyle issues have been resolved, override the
-             default behavior to make checkstyle fail on error and violation. -->
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-checkstyle-plugin</artifactId>
-        <configuration>
-          <failsOnError>false</failsOnError>
-          <failOnViolation>false</failOnViolation>
-        </configuration>
-      </plugin>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-javadoc-plugin</artifactId>
-        <configuration>
-          <failOnError>false</failOnError>
-          <failOnWarnings>false</failOnWarnings>
-        </configuration>
-      </plugin>
-
-      <plugin>
-        <groupId>com.github.spotbugs</groupId>
-        <artifactId>spotbugs-maven-plugin</artifactId>
-        <configuration>
-          <failOnError>false</failOnError>
-        </configuration>
-      </plugin>
-    </plugins>
-  </reporting>
-
-</project>
+</project>

storage/client/blob/src/main/java/com/azure/storage/blob/AccountSASPermission.java

@@ -33,7 +33,7 @@ final class AccountSASPermission {
     /**
      * Initializes an {@code AccountSASPermission} object with all fields set to false.
      */
-    public AccountSASPermission() {
+    private AccountSASPermission() {
     }
 
     /**
@@ -44,6 +44,7 @@ public AccountSASPermission() {
      *         A {@code String} which represents the {@code SharedAccessAccountPermissions}.
      *
      * @return An {@code AccountSASPermission} object generated from the given {@code String}.
+     * @throws IllegalArgumentException If {@code permString} contains a character other than r, w, d, l, a, c, u, or p.
      */
     public static AccountSASPermission parse(String permString) {
         AccountSASPermission permissions = new AccountSASPermission();

storage/client/blob/src/main/java/com/azure/storage/blob/AccountSASResourceType.java

@@ -23,7 +23,7 @@ final class AccountSASResourceType {
     /**
      * Initializes an {@code AccountSASResourceType} object with all fields set to false.
      */
-    public AccountSASResourceType() {
+    private AccountSASResourceType() {
     }
 
     /**
@@ -34,6 +34,7 @@ public AccountSASResourceType() {
      *         A {@code String} which represents the {@code AccountSASResourceTypes}.
      *
      * @return A {@code AccountSASResourceType} generated from the given {@code String}.
+     * @throws IllegalArgumentException If {@code resourceTypesString} contains a character other than s, c, or o.
      */
     public static AccountSASResourceType parse(String resourceTypesString) {
         AccountSASResourceType resourceType = new AccountSASResourceType();

storage/client/blob/src/main/java/com/azure/storage/blob/AccountSASService.java

@@ -25,7 +25,7 @@ final class AccountSASService {
     /**
      * Initializes an {@code AccountSASService} object with all fields set to false.
      */
-    public AccountSASService() {
+    private AccountSASService() {
     }
 
     /**
@@ -36,6 +36,7 @@ public AccountSASService() {
      *         A {@code String} which represents the {@code SharedAccessAccountServices}.
      *
      * @return A {@code AccountSASService} generated from the given {@code String}.
+     * @throws IllegalArgumentException If {@code servicesString} contains a character other than b, f, q, or t.
      */
     public static AccountSASService parse(String servicesString) {
         AccountSASService services = new AccountSASService();

storage/client/blob/src/main/java/com/azure/storage/blob/AccountSASSignatureValues.java

@@ -50,7 +50,7 @@ final class AccountSASSignatureValues {
      * Initializes an {@code AccountSASSignatureValues} object with the version number set to the default and all
      * other values empty.
      */
-    public AccountSASSignatureValues() {
+    AccountSASSignatureValues() {
     }
 
     /**
@@ -187,6 +187,7 @@ public AccountSASSignatureValues resourceTypes(String resourceTypes) {
      *         Credentials for the storage account and corresponding primary or secondary key.
      *
      * @return {@link SASQueryParameters}
+     * @throws RuntimeException If the HMAC-SHA256 signature for {@code sharedKeyCredentials} fails to generate.
      */
     public SASQueryParameters generateSASQueryParameters(SharedKeyCredential sharedKeyCredentials) {
         Utility.assertNotNull("SharedKeyCredential", sharedKeyCredentials);
@@ -203,7 +204,7 @@ public SASQueryParameters generateSASQueryParameters(SharedKeyCredential sharedK
         try {
             signature = sharedKeyCredentials.computeHmac256(stringToSign);
         } catch (InvalidKeyException e) {
-            throw new Error(e); // The key should have been validated by now. If it is no longer valid here, we fail.
+            throw new RuntimeException(e); // The key should have been validated by now. If it is no longer valid here, we fail.
         }
 
         return new SASQueryParameters(this.version, this.services, resourceTypes,

storage/client/blob/src/main/java/com/azure/storage/blob/AppendBlobAsyncClient.java

@@ -89,11 +89,10 @@ public Mono<Response<AppendBlobItem>> create() {
      * @return
      *      A reactive response containing the information of the created appended blob.
      */
-    public Mono<Response<AppendBlobItem>> create(BlobHTTPHeaders headers, Metadata metadata,
-                                                 BlobAccessConditions accessConditions) {
-            return appendBlobAsyncRawClient
-                .create(headers, metadata, accessConditions)
-                .map(rb -> new SimpleResponse<>(rb, new AppendBlobItem(rb.deserializedHeaders())));
+    public Mono<Response<AppendBlobItem>> create(BlobHTTPHeaders headers, Metadata metadata, BlobAccessConditions accessConditions) {
+        return appendBlobAsyncRawClient
+            .create(headers, metadata, accessConditions)
+            .map(rb -> new SimpleResponse<>(rb, new AppendBlobItem(rb.deserializedHeaders())));
     }
 
     /**

storage/client/blob/src/main/java/com/azure/storage/blob/AppendBlobClient.java

@@ -11,7 +11,6 @@
 import com.azure.storage.blob.models.BlobRange;
 import com.azure.storage.blob.models.Metadata;
 import com.azure.storage.blob.models.SourceModifiedAccessConditions;
-import io.netty.buffer.ByteBufAllocator;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 import reactor.core.scheduler.Schedulers;

storage/client/blob/src/main/java/com/azure/storage/blob/AppendBlobClientBuilder.java

@@ -26,10 +26,10 @@
 
 import java.net.MalformedURLException;
 import java.net.URL;
-import java.net.UnknownHostException;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.Objects;
 
@@ -40,7 +40,7 @@
  * <p>
  * The following information must be provided on this builder:
  *
- * <p><ul>
+ * <ul>
  *     <li>the endpoint through {@code .endpoint()}, including the container name and blob name, in the format of {@code https://{accountName}.blob.core.windows.net/{containerName}/{blobName}}.
  *     <li>the credential through {@code .credential()} or {@code .connectionString()} if the container is not publicly accessible.
  * </ul>
@@ -69,6 +69,10 @@ public final class AppendBlobClientBuilder {
     private RequestRetryOptions retryOptions;
     private Configuration configuration;
 
+    /**
+     * Creates a builder instance that is able to configure and construct {@link AppendBlobClient AppendBlobClients}
+     * and {@link AppendBlobAsyncClient AppendBlobAsyncClients}.
+     */
     public AppendBlobClientBuilder() {
         retryOptions = new RequestRetryOptions();
         logLevel = HttpLogDetailLevel.NONE;
@@ -98,7 +102,7 @@ private AzureBlobStorageBuilder buildImpl() {
             policies.add(new SASTokenCredentialPolicy(sasTokenCredential));
         } else {
             policies.add(new AnonymousCredentialPolicy());
-}
+        }
 
         policies.add(new RequestRetryPolicy(retryOptions));
 
@@ -133,6 +137,7 @@ public AppendBlobAsyncClient buildAsyncClient() {
      * Sets the service endpoint, additionally parses it for information (SAS token, container name, blob name)
      * @param endpoint URL of the service
      * @return the updated AppendBlobClientBuilder object
+     * @throws IllegalArgumentException If {@code endpoint} is a malformed URL or is using an unknown host.
      */
     public AppendBlobClientBuilder endpoint(String endpoint) {
         Objects.requireNonNull(endpoint);
@@ -153,7 +158,7 @@ public AppendBlobClientBuilder endpoint(String endpoint) {
             if (parts.snapshot() != null) {
                 this.snapshot = parts.snapshot();
             }
-        } catch (MalformedURLException | UnknownHostException ex) {
+        } catch (MalformedURLException ex) {
             throw new IllegalArgumentException("The Azure Storage Blob endpoint url is malformed.");
         }
 
@@ -246,14 +251,15 @@ public AppendBlobClientBuilder anonymousCredential() {
      * Sets the connection string for the service, parses it for authentication information (account name, account key)
      * @param connectionString connection string from access keys section
      * @return the updated AppendBlobClientBuilder object
+     * @throws IllegalArgumentException If {@code connectionString} doesn't contain AccountName or AccountKey.
      */
     public AppendBlobClientBuilder connectionString(String connectionString) {
         Objects.requireNonNull(connectionString);
 
         Map<String, String> connectionKVPs = new HashMap<>();
         for (String s : connectionString.split(";")) {
             String[] kvp = s.split("=", 2);
-            connectionKVPs.put(kvp[0].toLowerCase(), kvp[1]);
+            connectionKVPs.put(kvp[0].toLowerCase(Locale.ROOT), kvp[1]);
         }
 
         String accountName = connectionKVPs.get(ACCOUNT_NAME);