Fix integration tests removing local auth for Event Hubs & Service Bus (Azure#43934)

* Disable local auth  when creating resources.

* Enable use of credential in impl management tests.

* Move common sanitizers into testutils

* Move common credential logic into TestUtils.

* Disable local auth

* Add supplementary header

* Disable if environment variable not set.

* Fix env key.

Author: conniey

sdk/eventhubs/azure-messaging-eventhubs/src/test/java/com/azure/messaging/eventhubs/IntegrationTestBase.java

@@ -15,11 +15,9 @@
 import com.azure.core.util.ConfigurationBuilder;
 import com.azure.core.util.CoreUtils;
 import com.azure.core.util.logging.ClientLogger;
-import com.azure.identity.DefaultAzureCredentialBuilder;
 import com.azure.messaging.eventhubs.models.SendOptions;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Assertions;
-import org.junit.jupiter.api.Assumptions;
 import org.junit.jupiter.api.BeforeEach;
 import org.mockito.Mockito;
 import reactor.core.Disposable;
@@ -38,6 +36,11 @@
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
 
+import static com.azure.messaging.eventhubs.TestUtils.AZURE_EVENTHUBS_EVENT_HUB_NAME;
+import static com.azure.messaging.eventhubs.TestUtils.AZURE_EVENTHUBS_FULLY_QUALIFIED_DOMAIN_NAME;
+import static org.junit.jupiter.api.Assumptions.assumeFalse;
+import static org.junit.jupiter.api.Assumptions.assumeTrue;
+
 /**
  * Test base for running integration tests.
  */
@@ -61,9 +64,6 @@ public abstract class IntegrationTestBase extends TestBase {
 
     protected String testName;
 
-    private static final ClientOptions OPTIONS_WITH_TRACING
-        = new ClientOptions().setTracingOptions(new LoggingTracerProvider.LoggingTracingOptions());
-
     private Scheduler scheduler;
     private static Map<String, IntegrationTestEventData> testEventData;
     private List<AutoCloseable> toClose = new ArrayList<>();
@@ -81,7 +81,7 @@ public void setupTest(TestContextManager testContextManager) {
             testContextManager.getTestPlaybackRecordingName());
 
         testName = testContextManager.getTrackerTestName();
-        skipIfNotRecordMode();
+        skipIfNotRecordOrLiveMode();
         toClose = new ArrayList<>();
 
         scheduler = Schedulers.newParallel("eh-integration");
@@ -116,62 +116,56 @@ public void teardownTest() {
     }
 
     /**
-     * Creates a new instance of {@link EventHubClientBuilder} with the default integration test settings and uses a
-     * connection string to authenticate.
+     * Creates a new instance of {@link EventHubClientBuilder} with the default integration test settings and does not
+     * share a connection string.
      */
     protected EventHubClientBuilder createBuilder() {
         return createBuilder(false);
     }
 
     /**
-     * Creates a new instance of {@link EventHubClientBuilder} with the default integration test settings and uses a
-     * connection string to authenticate if {@code useCredentials} is false. Otherwise, uses a service principal through
-     * {@link com.azure.identity.ClientSecretCredential}.
+     * Creates a new instance of {@link EventHubClientBuilder} with the default integration test settings.  Assumes test
+     * mode is not {@link TestMode#PLAYBACK}.
      */
     protected EventHubClientBuilder createBuilder(boolean shareConnection) {
+        skipIfNotRecordOrLiveMode();
+
+        // Enables tracing.
+        final ClientOptions clientOptions
+            = new ClientOptions().setTracingOptions(new LoggingTracerProvider.LoggingTracingOptions());
+
         final EventHubClientBuilder builder = new EventHubClientBuilder().proxyOptions(ProxyOptions.SYSTEM_DEFAULTS)
             .retryOptions(RETRY_OPTIONS)
-            .clientOptions(OPTIONS_WITH_TRACING)
+            .clientOptions(clientOptions)
             .transportType(AmqpTransportType.AMQP)
             .scheduler(scheduler)
             .configuration(new ConfigurationBuilder().putProperty("com.azure.messaging.eventhubs.v2", "true").build());
 
-        final String fullyQualifiedDomainName = TestUtils.getFullyQualifiedDomainName();
-        final String eventHubName = TestUtils.getEventHubName();
-
         if (shareConnection) {
             builder.shareConnection();
         }
 
-        switch (getTestMode()) {
-            case PLAYBACK:
-                Assumptions.assumeTrue(false, "Integration tests are not enabled in playback mode.");
-                return null;
-
-            case LIVE:
-                Assumptions.assumeTrue(!CoreUtils.isNullOrEmpty(fullyQualifiedDomainName),
-                    "FullyQualifiedDomainName is not set.");
-                Assumptions.assumeTrue(!CoreUtils.isNullOrEmpty(fullyQualifiedDomainName), "EventHubName is not set.");
-
-                final TokenCredential credential = TestUtils.getPipelineCredential(credentialCached);
-                return builder.credential(fullyQualifiedDomainName, eventHubName, credential);
-
-            case RECORD:
-                final String connectionString = TestUtils.getConnectionString(false);
-
-                Assumptions.assumeTrue(!CoreUtils.isNullOrEmpty(eventHubName), "EventHubName is not set.");
-                Assumptions.assumeTrue(!CoreUtils.isNullOrEmpty(fullyQualifiedDomainName),
-                    "FullyQualifiedDomainName is not set.");
-
-                if (CoreUtils.isNullOrEmpty(connectionString)) {
-                    final TokenCredential tokenCredential = new DefaultAzureCredentialBuilder().build();
-                    return builder.credential(fullyQualifiedDomainName, eventHubName, tokenCredential);
-                } else {
-                    return builder.connectionString(connectionString).eventHubName(eventHubName);
-                }
-            default:
-                return null;
+        final TokenCredential tokenCredential = TestUtils.getTokenCredential(getTestMode(), credentialCached);
+
+        assumeTrue(tokenCredential != null, "Token credential could not be created using " + getTestMode());
+
+        if (getTestMode() == TestMode.PLAYBACK) {
+            return builder.credential(tokenCredential);
         }
+
+        final String fullyQualifiedDomainName = TestUtils.getFullyQualifiedDomainName();
+        final String eventHubName = TestUtils.getEventHubName();
+
+        assumeFalse(CoreUtils.isNullOrEmpty(fullyQualifiedDomainName),
+            "Env variable: '" + AZURE_EVENTHUBS_FULLY_QUALIFIED_DOMAIN_NAME + "' must be set.");
+        assumeFalse(CoreUtils.isNullOrEmpty(eventHubName),
+            "Env variable: '" + AZURE_EVENTHUBS_EVENT_HUB_NAME + "' must be set.");
+
+        return builder.credential(fullyQualifiedDomainName, eventHubName, tokenCredential);
+    }
+
+    protected TokenCredential getOrCreateTokenCredential() {
+        return TestUtils.getTokenCredential(getTestMode(), credentialCached);
     }
 
     /**
@@ -247,8 +241,7 @@ protected void dispose() {
         toClose.clear();
     }
 
-    private void skipIfNotRecordMode() {
-        Assumptions.assumeTrue(getTestMode() != TestMode.PLAYBACK, "Is not in RECORD/LIVE mode.");
+    private void skipIfNotRecordOrLiveMode() {
+        assumeTrue(getTestMode() != TestMode.PLAYBACK, "Is not in RECORD/LIVE mode.");
     }
-
 }

sdk/eventhubs/azure-messaging-eventhubs/src/test/java/com/azure/messaging/eventhubs/NonFederatedIntegrationTests.java

@@ -15,6 +15,7 @@
 import com.azure.messaging.eventhubs.models.SendOptions;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Assumptions;
+import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable;
 import reactor.test.StepVerifier;
@@ -23,6 +24,7 @@
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
+@Tag("integration")
 public class NonFederatedIntegrationTests extends IntegrationTestBase {
     private static final ClientLogger LOGGER = new ClientLogger(NonFederatedIntegrationTests.class);
     private static final String PARTITION_ID = "2";
@@ -34,8 +36,8 @@ public class NonFederatedIntegrationTests extends IntegrationTestBase {
     @Test
     @EnabledIfEnvironmentVariable(
         named = "AZURE_EVENTHUBS_CONNECTION_STRING_WITH_SAS",
-        matches = ".*ShadAccessSignature .*")
-    void sendWithSasConnectionString() {
+        matches = ".*SharedAccessSignature.*")
+    public void sendWithSasConnectionString() {
         final String eventHubName = TestUtils.getEventHubName();
         final EventData event = new EventData("body");
         final SendOptions options = new SendOptions().setPartitionId(PARTITION_ID);
@@ -54,6 +56,7 @@ void sendWithSasConnectionString() {
     }
 
     @Test
+    @EnabledIfEnvironmentVariable(named = "AZURE_EVENTHUBS_CONNECTION_STRING", matches = ".*SharedAccessKey.*")
     public void sendAndReceiveEventByAzureSasCredential() {
         Assumptions.assumeTrue(TestUtils.getConnectionString(true) != null,
             "SAS was not set. Can't run test scenario.");
@@ -76,6 +79,7 @@ public void sendAndReceiveEventByAzureSasCredential() {
     }
 
     @Test
+    @EnabledIfEnvironmentVariable(named = "AZURE_EVENTHUBS_CONNECTION_STRING", matches = ".*SharedAccessKey.*")
     public void sendAndReceiveEventByAzureNameKeyCredential() {
         ConnectionStringProperties properties = getConnectionStringProperties();
         String fullyQualifiedNamespace = properties.getEndpoint().getHost();
@@ -101,6 +105,7 @@ public void sendAndReceiveEventByAzureNameKeyCredential() {
      * Verifies that error conditions are handled for fetching Event Hub metadata.
      */
     @Test
+    @EnabledIfEnvironmentVariable(named = "AZURE_EVENTHUBS_CONNECTION_STRING", matches = ".*SharedAccessKey.*")
     public void getPartitionPropertiesInvalidToken() {
         // Arrange
         final ConnectionStringProperties original = getConnectionStringProperties();
@@ -127,6 +132,7 @@ public void getPartitionPropertiesInvalidToken() {
      * Verifies that error conditions are handled for fetching partition metadata.
      */
     @Test
+    @EnabledIfEnvironmentVariable(named = "AZURE_EVENTHUBS_CONNECTION_STRING", matches = ".*SharedAccessKey.*")
     public void getPartitionPropertiesNonExistentHub() {
         // Arrange
         final ConnectionStringProperties original = getConnectionStringProperties();