Refactored test header logic into a global spock extension

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

@@ -9,13 +9,6 @@ import spock.lang.Specification
 
 class OptionsBagTest extends Specification {
 
-    def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
-    }
-
     def "SetAccessTier constructor"() {
         setup:
         def url = "https://account.blob.core.windows.net/container/blob"

sdk/storage/azure-storage-blob-changefeed/src/test/java/com/azure/storage/blob/changefeed/BlobChangefeedPagedFluxTest.groovy

@@ -27,10 +27,6 @@ class BlobChangefeedPagedFluxTest extends Specification {
     List<BlobChangefeedEventWrapper> mockEventWrappers
 
     def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
         setupEvents()
         mockContainer = mock(BlobContainerAsyncClient.class)
         mockChangefeedFactory = mock(ChangefeedFactory.class)

sdk/storage/azure-storage-blob-changefeed/src/test/java/com/azure/storage/blob/changefeed/BlobChunkedDownloaderTest.groovy

@@ -15,10 +15,6 @@ class BlobChunkedDownloaderTest extends APISpec {
     BlobChunkedDownloaderFactory factory
 
     def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
         def cc = primaryBlobServiceAsyncClient.getBlobContainerAsyncClient(generateContainerName())
         cc.create().block()
         bc = Spy(cc.getBlobAsyncClient(generateBlobName()))

sdk/storage/azure-storage-blob-changefeed/src/test/java/com/azure/storage/blob/changefeed/ChangefeedCursorTest.groovy

@@ -12,13 +12,6 @@ import java.time.OffsetDateTime
 
 class ChangefeedCursorTest extends Specification {
 
-    def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
-    }
-
     String urlHost = 'testaccount.blob.core.windows.net'
     OffsetDateTime endTime = OffsetDateTime.MAX
 

sdk/storage/azure-storage-blob-changefeed/src/test/java/com/azure/storage/blob/changefeed/ChangefeedTest.groovy

@@ -37,10 +37,6 @@ class ChangefeedTest extends Specification {
     String urlHost = 'testaccount.blob.core.windows.net'
 
     def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
         mockContainer = mock(BlobContainerAsyncClient.class)
         mockSegmentFactory = mock(SegmentFactory.class)
 

sdk/storage/azure-storage-blob-changefeed/src/test/java/com/azure/storage/blob/changefeed/ChunkTest.groovy

@@ -44,10 +44,6 @@ class ChunkTest extends Specification {
     List<AvroObject> mockAvroObjects
 
     def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
         setupEvents()
 
         mockContainer = mock(BlobContainerAsyncClient.class)

sdk/storage/azure-storage-blob-changefeed/src/test/java/com/azure/storage/blob/changefeed/SegmentTest.groovy

@@ -38,10 +38,6 @@ class SegmentTest extends Specification {
     ChangefeedCursor cfCursor
 
     def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
         mockContainer = mock(BlobContainerAsyncClient.class)
         mockBlob = mock(BlobAsyncClient.class)
         mockShardFactory = mock(ShardFactory.class)

sdk/storage/azure-storage-blob-changefeed/src/test/java/com/azure/storage/blob/changefeed/ShardTest.groovy

@@ -44,10 +44,6 @@ class ShardTest extends Specification {
     ChangefeedCursor segmentCursor
 
     def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
         mockContainer = mock(BlobContainerAsyncClient.class)
         mockChunkFactory = mock(ChunkFactory.class)
         mockChunk0 = mock(Chunk.class)

sdk/storage/azure-storage-blob-changefeed/src/test/java/com/azure/storage/blob/changefeed/TimeUtilsTest.groovy

@@ -9,13 +9,6 @@ import java.time.ZoneOffset
 
 class TimeUtilsTest extends Specification {
 
-    def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
-    }
-
     @Unroll
     def "convertPathToTime"() {
         expect:

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

@@ -17,13 +17,6 @@ import java.time.ZoneOffset
 
 class BlobServiceSasModelsTest extends Specification {
 
-    def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
-    }
-
     @Unroll
     def "BlobSASPermissions toString"() {
         setup:

sdk/storage/azure-storage-blob/src/test/java/com/azure/storage/blob/implementation/util/StorageBlockingSinkTest.groovy

@@ -14,13 +14,6 @@ import java.util.concurrent.TimeUnit
 
 class StorageBlockingSinkTest extends Specification {
 
-    def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
-    }
-
     def "min"() {
         setup:
         def blockingSink = new StorageBlockingSink()

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

@@ -105,7 +105,7 @@
         <version>3.0.0</version> <!-- {x-version-update;org.codehaus.mojo:build-helper-maven-plugin;external_dependency} -->
         <executions>
           <execution>
-            <id>compile-samples-source</id>
+            <id>compile-test-shared-source</id>
             <phase>generate-test-sources</phase>
             <goals>
               <goal>add-test-source</goal>
@@ -121,24 +121,34 @@
 
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-jar-plugin</artifactId>
-        <version>3.1.2</version> <!-- {x-version-update;org.apache.maven.plugins:maven-jar-plugin;external_dependency} -->
+        <artifactId>maven-assembly-plugin</artifactId>
+        <version>3.2.0</version> <!-- {x-version-update;org.apache.maven.plugins:maven-assembly-plugin;external_dependency} -->
         <executions>
           <execution>
-            <id>test-jar</id>
+            <id>package-test-shared-jar</id>
             <phase>test-compile</phase>
             <goals>
-              <goal>test-jar</goal>
+              <goal>single</goal>
             </goals>
             <configuration>
-              <includes>
-                <include>com/azure/storage/common/test/shared/**/*</include>
-                <include>SpockConfig.groovy</include>
-              </includes>
+              <descriptors>
+                <descriptor>src/test-shared/assembly/assembly.xml</descriptor>
+              </descriptors>
             </configuration>
           </execution>
         </executions>
       </plugin>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>3.0.0-M3</version> <!-- {x-version-update;org.apache.maven.plugins:maven-surefire-plugin;external_dependency} -->
+        <configuration>
+          <additionalClasspathElements>
+            <additionalClasspathElement>${settings.localRepository}/com/azure/${project.artifactId}/${project.version}/${project.artifactId}-${project.version}-tests.jar</additionalClasspathElement>
+          </additionalClasspathElements>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
 

sdk/storage/azure-storage-common/src/test-shared/assembly/assembly.xml

@@ -0,0 +1,29 @@
+<assembly
+    xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3 http://maven.apache.org/xsd/assembly-1.1.3.xsd">
+  <id>tests</id>
+  <formats>
+    <format>jar</format>
+  </formats>
+  <includeBaseDirectory>false</includeBaseDirectory>
+  <fileSets>
+    <fileSet>
+      <directory>${project.build.directory}/test-classes</directory>
+      <outputDirectory>${file.separator}</outputDirectory>
+      <includes>
+        <include>com/azure/storage/common/test/shared/**/*</include>
+        <include>SpockConfig.groovy</include>
+      </includes>
+      <useDefaultExcludes>true</useDefaultExcludes>
+    </fileSet>
+    <fileSet>
+      <directory>${project.build.directory}/test-classes/manifests</directory>
+      <outputDirectory>${file.separator}</outputDirectory>
+      <includes>
+        <include>**/*</include>
+      </includes>
+      <useDefaultExcludes>true</useDefaultExcludes>
+    </fileSet>
+  </fileSets>
+</assembly>

sdk/storage/azure-storage-common/src/test-shared/java/com/azure/storage/common/test/shared/StorageSpec.groovy

@@ -21,10 +21,9 @@ class StorageSpec extends Specification {
     private StorageResourceNamer namer
 
     def setup() {
-        def testName = getTestName()
+        def testName = TestNameProvider.getTestName(specificationContext.getCurrentIteration());
         interceptorManager = new InterceptorManager(testName, ENVIRONMENT.testMode)
         namer = new StorageResourceNamer(testName, ENVIRONMENT.testMode, interceptorManager.getRecordedData())
-        System.out.printf("========================= %s =========================%n", testName)
     }
 
     def cleanup() {
@@ -88,19 +87,4 @@ class StorageSpec extends Specification {
             .map { it.getToken() }
             .block()
     }
-
-    private String getTestName() {
-        def iterationInfo = specificationContext.currentIteration
-        def featureInfo = iterationInfo.getParent()
-        def specInfo = featureInfo.getParent()
-        def fullName = specInfo.getName() + featureInfo.getName().split(" ").collect { it.capitalize() }.join("")
-
-        if (iterationInfo.getDataValues().length == 0) {
-            return fullName
-        }
-        def prefix = fullName
-        def suffix = "[" + iterationInfo.getIterationIndex() + "]"
-
-        return prefix + suffix
-    }
 }

sdk/storage/azure-storage-common/src/test-shared/java/com/azure/storage/common/test/shared/TestNameProvider.java

@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.storage.common.test.shared;
+
+import org.spockframework.runtime.model.FeatureInfo;
+import org.spockframework.runtime.model.IterationInfo;
+import org.spockframework.runtime.model.SpecInfo;
+
+import java.util.Arrays;
+import java.util.stream.Collectors;
+
+public final class TestNameProvider {
+    public static String getTestName(IterationInfo iterationInfo) {
+        FeatureInfo featureInfo = iterationInfo.getFeature();
+        SpecInfo specInfo = featureInfo.getSpec();
+
+        String fullName = specInfo.getName() + Arrays.stream(featureInfo.getName().split(" "))
+            .map(it -> it.substring(0, 1).toUpperCase() + it.substring(1))
+            .collect(Collectors.joining(""));
+
+        return (iterationInfo.getDataValues().length == 0)
+            ? fullName
+            : String.format("%s[%d]", fullName, iterationInfo.getIterationIndex());
+    }
+}

sdk/storage/azure-storage-common/src/test-shared/java/com/azure/storage/common/test/shared/extensions/TestHeaderExtension.java

@@ -0,0 +1,33 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.storage.common.test.shared.extensions;
+
+import com.azure.storage.common.test.shared.TestNameProvider;
+import org.spockframework.runtime.extension.AbstractGlobalExtension;
+import org.spockframework.runtime.extension.IMethodInterceptor;
+import org.spockframework.runtime.extension.IMethodInvocation;
+import org.spockframework.runtime.model.SpecInfo;
+
+public final class TestHeaderExtension extends AbstractGlobalExtension {
+
+    @Override
+    public void visitSpec(SpecInfo specInfo) {
+        specInfo.getAllFeatures().forEach(feature ->
+            feature.addIterationInterceptor(new TestHeaderIterationInterceptor()));
+    }
+
+    private static class TestHeaderIterationInterceptor implements IMethodInterceptor {
+        @Override
+        public void intercept(IMethodInvocation invocation) {
+            // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
+            String testName = TestNameProvider.getTestName(invocation.getIteration());
+            System.out.printf("========================= %s =========================%n", testName);
+            try {
+                invocation.proceed();
+            } catch (Throwable throwable) {
+                throwable.printStackTrace();
+            }
+        }
+    }
+}

sdk/storage/azure-storage-common/src/test/java/com/azure/storage/common/implementation/BufferStagingAreaTest.groovy

@@ -8,13 +8,6 @@ import spock.lang.Unroll
 import java.nio.ByteBuffer
 
 class BufferStagingAreaTest extends Specification {
-    def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
-    }
-
     static def generateData(int numBuffs, int minBuffSize, int maxBuffSize) {
         def random = new Random()
         // Generate random sizes between minBuffSize and maxBuffSize for the buffers

sdk/storage/azure-storage-common/src/test/java/com/azure/storage/common/implementation/FluxInputStreamTest.groovy

@@ -13,13 +13,6 @@ import java.nio.ByteBuffer
 
 class FluxInputStreamTest extends Specification {
 
-    def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
-    }
-
     /* Network tests to be performed by implementors of the FluxInputStream. */
     Flux<ByteBuffer> generateData(int num) {
         List<ByteBuffer> buffers = new ArrayList<>()

sdk/storage/azure-storage-common/src/test/java/com/azure/storage/common/implementation/SasModelsTest.groovy

@@ -18,13 +18,6 @@ import java.time.ZoneOffset
 
 class SasModelsTest extends Specification {
 
-    def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
-    }
-
     @Unroll
     def "AccountSasSignatureValues min"() {
         setup:

sdk/storage/azure-storage-common/src/test/resources/manifests/META-INF/services/org.spockframework.runtime.extension.IGlobalExtension

@@ -0,0 +1 @@
+com.azure.storage.common.test.shared.extensions.TestHeaderExtension

sdk/storage/azure-storage-file-datalake/src/test/java/com/azure/storage/file/datalake/DataLakeServiceSasModelsTest.groovy

@@ -17,13 +17,6 @@ import java.time.ZoneOffset
 
 class DataLakeServiceSasModelsTest extends Specification {
 
-    def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
-    }
-
     @Unroll
     def "PathSASPermissions toString"() {
         setup:

sdk/storage/azure-storage-file-datalake/src/test/java/com/azure/storage/file/datalake/HelperTest.groovy

@@ -9,13 +9,6 @@ import spock.lang.Unroll
 
 class HelperTest extends Specification {
 
-    def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
-    }
-
     @Unroll
     def "File range"() {
         expect:

sdk/storage/azure-storage-internal-avro/src/test/java/com/azure/storage/internal/avro/implementation/AvroParserStateTest.groovy

@@ -8,13 +8,6 @@ import java.nio.ByteBuffer
 
 class AvroParserStateTest extends Specification {
 
-    def setup() {
-        String fullTestName = specificationContext.getCurrentIteration().getName().replace(' ', '').toLowerCase()
-        String className = specificationContext.getCurrentSpec().getName()
-        // Print out the test name to create breadcrumbs in our test logging in case anything hangs.
-        System.out.printf("========================= %s.%s =========================%n", className, fullTestName)
-    }
-
     def "constructor"() {
         setup:
         AvroParserState state = new AvroParserState()