Added spock test framework and tests for queue service

sdk/storage/azure-storage-queue/pom.xml

@@ -53,31 +53,22 @@
       <version>1.0.0-preview.4</version>
       <scope>test</scope>
     </dependency>
+    <!-- https://mvnrepository.com/artifact/org.spockframework/spock-core -->
     <dependency>
-      <groupId>com.azure</groupId>
-      <artifactId>azure-identity</artifactId>
-      <version>1.0.0-preview.3</version>
+      <groupId>org.spockframework</groupId>
+      <artifactId>spock-core</artifactId>
+      <version>1.3-groovy-2.5</version>
       <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>org.slf4j</groupId>
-      <artifactId>slf4j-simple</artifactId>
-      <scope>test</scope>
-    </dependency>
     <dependency>
       <groupId>io.projectreactor</groupId>
       <artifactId>reactor-test</artifactId>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>com.microsoft.azure</groupId>
-      <artifactId>adal4j</artifactId>
-      <scope>test</scope>
-    </dependency>
   </dependencies>
 </project>

sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/QueueAsyncClient.java

@@ -24,6 +24,7 @@
 import com.azure.storage.queue.models.SignedIdentifier;
 import com.azure.storage.queue.models.StorageErrorException;
 import com.azure.storage.queue.models.UpdatedMessage;
+import java.util.Objects;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
@@ -62,6 +63,7 @@ public final class QueueAsyncClient {
      * @param queueName Name of the queue
      */
     QueueAsyncClient(AzureQueueStorageImpl client, String queueName) {
+        Objects.requireNonNull(queueName);
         this.queueName = queueName;
 
         this.client = new AzureQueueStorageBuilder().pipeline(client.getHttpPipeline())
@@ -79,6 +81,7 @@ public final class QueueAsyncClient {
      * @param queueName Name of the queue
      */
     QueueAsyncClient(URL endpoint, HttpPipeline httpPipeline, String queueName) {
+        Objects.requireNonNull(queueName);
         this.queueName = queueName;
 
         this.client = new AzureQueueStorageBuilder().pipeline(httpPipeline)

sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/QueueClientBuilder.java

@@ -137,7 +137,6 @@ public QueueClient buildClient() {
      */
     public QueueAsyncClient buildAsyncClient() {
         Objects.requireNonNull(endpoint);
-        Objects.requireNonNull(queueName);
 
         if (sasTokenCredential == null && sharedKeyCredential == null) {
             LOGGER.error("Credentials are required for authorization");

sdk/storage/azure-storage-queue/src/main/java/com/azure/storage/queue/models/StorageErrorCode.java

@@ -27,6 +27,11 @@ public final class StorageErrorCode extends ExpandableStringEnum<StorageErrorCod
      */
     public static final StorageErrorCode ACCOUNT_IS_DISABLED = fromString("AccountIsDisabled");
 
+    /**
+     * Static value AuthenticationError for StorageErrorCode.
+     */
+    public static final StorageErrorCode AUTHENTICATION_ERROR = fromString("AuthenticationError");
+
     /**
      * Static value AuthenticationFailed for StorageErrorCode.
      */

sdk/storage/azure-storage-queue/src/test/java/com/azure/storage/queue/TestHelpers.java

@@ -28,7 +28,7 @@
  * Contains helper methods for unit tests.
  */
 class TestHelpers {
-    private final String azureStorageConnectionString = "AZURE_STORAGE_CONNECTION_STRING";
+    private final String azureStorageConnectionString = "AZURE_STORAGE_QUEUE_CONNECTION_STRING";
     private final String azureStorageQueueEndpoint = "AZURE_STORAGE_QUEUE_ENDPOINT";
 
     <T> T setupClient(BiFunction<String, String, T> clientBuilder, boolean isPlaybackMode, ClientLogger logger) {

sdk/storage/azure-storage-queue/src/test/java/com/azure/storage/queue/spock/APISpec.groovy

@@ -0,0 +1,123 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.storage.queue.spock
+
+import com.azure.core.test.InterceptorManager
+import com.azure.core.test.TestMode
+import com.azure.core.test.utils.TestResourceNamer
+import com.azure.core.util.configuration.ConfigurationManager
+import com.azure.core.util.logging.ClientLogger
+import com.azure.storage.queue.QueueClientBuilder
+import com.azure.storage.queue.QueueServiceClient
+import com.azure.storage.queue.QueueServiceClientBuilder
+import com.azure.storage.queue.models.QueuesSegmentOptions
+import spock.lang.Specification
+
+class APISpec extends Specification {
+    // Field common used for all APIs.
+    def logger = new ClientLogger(APISpec.class)
+    def AZURE_TEST_MODE = "AZURE_TEST_MODE"
+    def interceptorManager
+    def testResourceName
+
+    // Clients for API tests
+    def primaryQueueServiceClient
+    def primaryQueueServiceAsyncClient
+
+
+    // Test name for test method name.
+    def methodName
+    def testMode = getTestMode()
+    def connectionString = ConfigurationManager.getConfiguration().get("AZURE_STORAGE_QUEUE_CONNECTION_STRING")
+
+    /**
+     * Setup the QueueServiceClient and QueueClient common used for the API tests.
+     */
+    def setup() {
+        String testName = refactorName(specificationContext.currentIteration.getName())
+        String className = specificationContext.getCurrentSpec().getName()
+        methodName = className + testName
+        logger.info("Test Mode: {}, Name: {}", testMode, methodName)
+        interceptorManager = new InterceptorManager(methodName, testMode)
+        testResourceName = new TestResourceNamer(methodName, testMode,
+            interceptorManager.getRecordedData())
+    }
+
+    /**
+     * Clean up the test queues and messages for the account.
+     */
+    def cleanup() {
+
+        interceptorManager.close()
+        if (getTestMode() == TestMode.RECORD) {
+            QueueServiceClient cleanupQueueServiceClient = new QueueServiceClientBuilder()
+                .connectionString(connectionString)
+                .buildClient()
+            cleanupQueueServiceClient.listQueues(new QueuesSegmentOptions().prefix(methodName.toLowerCase())).each {
+                queueItem -> cleanupQueueServiceClient.deleteQueue(queueItem.name())
+            }
+        }
+    }
+
+    /**
+     * Test mode is initialized whenever test is executed. Helper method which is used to determine what to do under
+     * certain test mode.
+     * @return The TestMode:
+     * <ul>
+     *     <li>Playback: (default if no test mode setup)</li>
+     * </ul>
+     */
+    def getTestMode() {
+        def azureTestMode = ConfigurationManager.getConfiguration().get(AZURE_TEST_MODE)
+
+        if (azureTestMode != null) {
+            try {
+                return TestMode.valueOf(azureTestMode.toUpperCase(Locale.US))
+            } catch (IllegalArgumentException e) {
+                logger.error("Could not parse '{}' into TestEnum. Using 'Playback' mode.", azureTestMode)
+                return TestMode.PLAYBACK
+            }
+        }
+
+        logger.info("Environment variable '{}' has not been set yet. Using 'Playback' mode.", AZURE_TEST_MODE)
+        return TestMode.PLAYBACK
+    }
+
+    def queueServiceBuilderHelper(final InterceptorManager interceptorManager) {
+        if (testMode == TestMode.RECORD) {
+            return new QueueServiceClientBuilder()
+                .connectionString(connectionString)
+                .addPolicy(interceptorManager.getRecordPolicy())
+        } else {
+            return new QueueServiceClientBuilder()
+                .connectionString(connectionString)
+                .httpClient(interceptorManager.getPlaybackClient())
+        }
+    }
+
+    def queueBuilderHelper(final InterceptorManager interceptorManager) {
+        def queueName = testResourceName.randomName("queue", 16)
+        if (testMode == TestMode.RECORD) {
+            return new QueueClientBuilder()
+                .connectionString(connectionString)
+                .queueName(queueName)
+                .addPolicy(interceptorManager.getRecordPolicy())
+        } else {
+            return new QueueClientBuilder()
+                .connectionString(connectionString)
+                .queueName(queueName)
+                .httpClient(interceptorManager.getPlaybackClient())
+        }
+    }
+
+    private def refactorName(String text) {
+        def fullName = text.split(" ").collect { it.capitalize() }.join("")
+        def matcher = (fullName =~ /(.*)(\[)(.*)(\])/)
+
+        if (!matcher.find()) {
+            return fullName
+        }
+        return matcher[0][1] + matcher[0][3]
+    }
+}