[Event Hubs] Update snippet syntax (Azure#23015)

The focus of these changes is to shift to using the SNIPPET compiler
constant to differentiate snippet code from test code, replacing the
specialized comment form previously used.

sdk/eventhub/Azure.Messaging.EventHubs.Processor/README.md

@@ -95,9 +95,9 @@ var eventHubsConnectionString = "<< CONNECTION STRING FOR THE EVENT HUBS NAMESPA
 var eventHubName = "<< NAME OF THE EVENT HUB >>";
 var consumerGroup = "<< NAME OF THE EVENT HUB CONSUMER GROUP >>";
 
-BlobContainerClient storageClient = new BlobContainerClient(storageConnectionString, blobContainerName);
+var storageClient = new BlobContainerClient(storageConnectionString, blobContainerName);
 
-EventProcessorClient processor = new EventProcessorClient
+var processor = new EventProcessorClient
 (
     storageClient,
     consumerGroup,
@@ -124,6 +124,7 @@ async Task processEventHandler(ProcessEventArgs eventArgs)
     {
         // Perform the application-specific processing for an event.  This method
         // is intended for illustration and is not defined in this snippet.
+
         await DoSomethingWithTheEvent(eventArgs.Partition, eventArgs.Data);
     }
     catch
@@ -138,6 +139,7 @@ async Task processErrorHandler(ProcessErrorEventArgs eventArgs)
     {
         // Perform the application-specific processing for an error.  This method
         // is intended for illustration and is not defined in this snippet.
+
         await DoSomethingWithTheError(eventArgs.Exception);
     }
     catch
@@ -183,6 +185,7 @@ try
 {
     // The processor performs its work in the background; block until cancellation
     // to allow processing to take place.
+
     await Task.Delay(Timeout.Infinite, cancellationSource.Token);
 }
 catch (TaskCanceledException)
@@ -197,6 +200,7 @@ try
 finally
 {
     // To prevent leaks, the handlers should be removed when processing is complete.
+
     processor.ProcessEventAsync -= processEventHandler;
     processor.ProcessErrorAsync -= processErrorHandler;
 }
@@ -211,16 +215,16 @@ To make use of an Active Directory principal, one of the available credentials f
 To make use of an Active Directory principal with Azure Storage blob containers, the fully qualified URL to the container must be provided when creating the storage client.  Details about the valid URI formats for accessing Blob storage may be found in [Naming and Referencing Containers, Blobs, and Metadata](https://docs.microsoft.com/rest/api/storageservices/Naming-and-Referencing-Containers--Blobs--and-Metadata#resource-uri-syntax).  
 
 ```C# Snippet:EventHubs_Processor_ReadMe_CreateWithIdentity
-TokenCredential credential = new DefaultAzureCredential();
-
-string blobStorageUrl ="<< FULLY-QUALIFIED CONTAINER URL (like https://myaccount.blob.core.windows.net/mycontainer) >>";
-BlobContainerClient storageClient = new BlobContainerClient(new Uri(blobStorageUrl), credential);
+var credential = new DefaultAzureCredential();
+var blobStorageUrl ="<< FULLY-QUALIFIED CONTAINER URL (like https://myaccount.blob.core.windows.net/mycontainer) >>";
 
 var fullyQualifiedNamespace = "<< FULLY-QUALIFIED EVENT HUBS NAMESPACE (like something.servicebus.windows.net) >>";
 var eventHubName = "<< NAME OF THE EVENT HUB >>";
 var consumerGroup = "<< NAME OF THE EVENT HUB CONSUMER GROUP >>";
 
-EventProcessorClient processor = new EventProcessorClient
+var storageClient = new BlobContainerClient(new Uri(blobStorageUrl), credential);
+
+var processor = new EventProcessorClient
 (
     storageClient,
     consumerGroup,

sdk/eventhub/Azure.Messaging.EventHubs.Processor/samples/Sample05_IdentityAndSharedAccessCredentials.md

@@ -48,7 +48,7 @@ The `EventProcessorClient` is safe to cache and use for the lifetime of the appl
 ## Processing events with identity-based authorization
 
 ```C# Snippet:EventHubs_Processor_Sample05_DefaultAzureCredential
-TokenCredential credential = new DefaultAzureCredential();
+var credential = new DefaultAzureCredential();
 
 var storageEndpoint = "<< STORAGE ENDPOINT (likely similar to {your-account}.blob.core.windows.net) >>";
 var blobContainerName = "<< NAME OF THE BLOB CONTAINER >>";
@@ -120,10 +120,11 @@ finally
 ## Processing events with Shared Access Signature authorization
 
 ```C# Snippet:EventHubs_Processor_Sample05_SharedAccessSignature
+var credential = new AzureSasCredential("<< SHARED ACCESS KEY STRING >>");
+
 var storageConnectionString = "<< CONNECTION STRING FOR THE STORAGE ACCOUNT >>";
 var blobContainerName = "<< NAME OF THE BLOB CONTAINER >>";
 
-var credential = new AzureSasCredential("<< SHARED ACCESS KEY STRING >>");
 var fullyQualifiedNamespace = "<< NAMESPACE (likely similar to {your-namespace}.servicebus.windows.net) >>";
 var eventHubName = "<< NAME OF THE EVENT HUB >>";
 var consumerGroup = "<< NAME OF THE EVENT HUB CONSUMER GROUP >>";
@@ -188,10 +189,11 @@ finally
 ## Processing events with Shared Access Key authorization
 
 ```C# Snippet:EventHubs_Processor_Sample05_SharedAccessKey
+var credential = new AzureNamedKeyCredential("<< SHARED KEY NAME >>", "<< SHARED KEY >>");
+
 var storageConnectionString = "<< CONNECTION STRING FOR THE STORAGE ACCOUNT >>";
 var blobContainerName = "<< NAME OF THE BLOB CONTAINER >>";
 
-var credential = new AzureNamedKeyCredential("<< SHARED KEY NAME >>", "<< SHARED KEY >>");
 var fullyQualifiedNamespace = "<< NAMESPACE (likely similar to {your-namespace}.servicebus.windows.net) >>";
 var eventHubName = "<< NAME OF THE EVENT HUB >>";
 var consumerGroup = "<< NAME OF THE EVENT HUB CONSUMER GROUP >>";

sdk/eventhub/Azure.Messaging.EventHubs.Processor/tests/Snippets/MigrationGuideSnippetsLiveTests.cs

@@ -3,7 +3,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.IO;
 using System.Text;
@@ -25,7 +24,6 @@ namespace Azure.Messaging.EventHubs.Tests.Snippets
     [TestFixture]
     [Category(TestCategory.Live)]
     [Category(TestCategory.DisallowVisualStudioLiveUnitTesting)]
-    [SuppressMessage("Style", "IDE0059:Unnecessary assignment of a value", Justification = "Example assignments needed for snippet output content.")]
     public class MigrationGuideSnippetsLiveTests
     {
         /// <summary>
@@ -39,20 +37,22 @@ public async Task MigrateCheckpoints()
 
             #region Snippet:EventHubs_Migrate_Checkpoints
 
+#if SNIPPET
             var fullyQualifiedNamespace = "<< NAMESPACE (likely similar to {your-namespace}.servicebus.windows.net) >>";
             var eventHubName = "<< NAME OF THE EVENT HUB >>";
             var consumerGroup = "<< NAME OF THE EVENT HUB CONSUMER GROUP >>";
-            /*@@*/
-            /*@@*/ fullyQualifiedNamespace = EventHubsTestEnvironment.Instance.FullyQualifiedNamespace;
-            /*@@*/ eventHubName = "fake-hub";
-            /*@@*/ consumerGroup = EventHubConsumerClient.DefaultConsumerGroupName;
 
             var storageConnectionString = "<< CONNECTION STRING FOR THE STORAGE ACCOUNT >>";
             var blobContainerName = "<< NAME OF THE BLOB CONTAINER  >>";
             var legacyBlobContainerName = "<< NAME OF THE BLOB CONTAINER THAT CONTAINS THE LEGACY DATA>>";
-            /*@@*/
-            /*@@*/ storageConnectionString = StorageTestEnvironment.Instance.StorageConnectionString;
-            /*@@*/ blobContainerName = storageScope.ContainerName;
+#else
+            var fullyQualifiedNamespace = EventHubsTestEnvironment.Instance.FullyQualifiedNamespace;
+            var eventHubName = "fake-hub";
+            var consumerGroup = EventHubConsumerClient.DefaultConsumerGroupName;
+
+            var storageConnectionString = StorageTestEnvironment.Instance.StorageConnectionString;
+            var blobContainerName = storageScope.ContainerName;
+#endif
 
             using var cancellationSource = new CancellationTokenSource();
 
@@ -61,13 +61,15 @@ public async Task MigrateCheckpoints()
             //
             // Note: The ReadLegacyCheckpoints method will be defined in another snippet.
 
-            /*@@*/ var legacyCheckpoints = ReadFakeLegacyCheckpoints(legacyBlobContainerName);
-            /*@@*/
-            //@@var legacyCheckpoints = await ReadLegacyCheckpoints(
-                //@@storageConnectionString,
-                //@@legacyBlobContainerName,
-                //@@consumerGroup,
-                //@@cancellationSource.Token);
+#if SNIPPET
+            var legacyCheckpoints = await ReadLegacyCheckpoints(
+                storageConnectionString,
+                legacyBlobContainerName,
+                consumerGroup,
+                cancellationSource.Token);
+#else
+            var legacyCheckpoints = ReadFakeLegacyCheckpoints("fake");
+#endif
 
             // The member names of MigrationCheckpoint match the names of the checkpoint
             // names of the checkpoint metadata keys.

sdk/eventhub/Azure.Messaging.EventHubs.Processor/tests/Snippets/ReadMeSnippetsLiveTests.cs

@@ -2,7 +2,6 @@
 // Licensed under the MIT License.
 
 using System;
-using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
@@ -23,7 +22,6 @@ namespace Azure.Messaging.EventHubs.Tests.Snippets
     [TestFixture]
     [Category(TestCategory.Live)]
     [Category(TestCategory.DisallowVisualStudioLiveUnitTesting)]
-    [SuppressMessage("Style", "IDE0059:Unnecessary assignment of a value", Justification = "Example assignments needed for snippet output content.")]
     public class ReadMeSnippetsLiveTests
     {
         /// <summary>
@@ -35,23 +33,24 @@ public void Create()
         {
             #region Snippet:EventHubs_Processor_ReadMe_Create
 
+#if SNIPPET
             var storageConnectionString = "<< CONNECTION STRING FOR THE STORAGE ACCOUNT >>";
             var blobContainerName = "<< NAME OF THE BLOB CONTAINER >>";
-            /*@@*/
-            /*@@*/ storageConnectionString = StorageTestEnvironment.Instance.StorageConnectionString;
-            /*@@*/ blobContainerName = "not-real";
 
             var eventHubsConnectionString = "<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>";
             var eventHubName = "<< NAME OF THE EVENT HUB >>";
             var consumerGroup = "<< NAME OF THE EVENT HUB CONSUMER GROUP >>";
-            /*@@*/
-            /*@@*/ eventHubsConnectionString = EventHubsTestEnvironment.Instance.EventHubsConnectionString;
-            /*@@*/ eventHubName = "fakeHub";
-            /*@@*/ consumerGroup = "fakeConsumer";
+#else
+            var storageConnectionString = StorageTestEnvironment.Instance.StorageConnectionString;
+            var blobContainerName = "not-real";
+            var eventHubsConnectionString = EventHubsTestEnvironment.Instance.EventHubsConnectionString;
+            var eventHubName = "fakeHub";
+            var consumerGroup = "fakeConsumer";
+#endif
 
-            BlobContainerClient storageClient = new BlobContainerClient(storageConnectionString, blobContainerName);
+            var storageClient = new BlobContainerClient(storageConnectionString, blobContainerName);
 
-            EventProcessorClient processor = new EventProcessorClient
+            var processor = new EventProcessorClient
             (
                 storageClient,
                 consumerGroup,
@@ -71,26 +70,28 @@ public void ConfigureHandlers()
         {
             #region Snippet:EventHubs_Processor_ReadMe_ConfigureHandlers
 
+#if SNIPPET
             var storageConnectionString = "<< CONNECTION STRING FOR THE STORAGE ACCOUNT >>";
             var blobContainerName = "<< NAME OF THE BLOB CONTAINER >>";
-            /*@@*/
-            /*@@*/ storageConnectionString = StorageTestEnvironment.Instance.StorageConnectionString;
-            /*@@*/ blobContainerName = "not-real";
 
             var eventHubsConnectionString = "<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>";
             var eventHubName = "<< NAME OF THE EVENT HUB >>";
             var consumerGroup = "<< NAME OF THE EVENT HUB CONSUMER GROUP >>";
-            /*@@*/
-            /*@@*/ eventHubsConnectionString = EventHubsTestEnvironment.Instance.EventHubsConnectionString;
-            /*@@*/ eventHubName = "fakeHub";
-            /*@@*/ consumerGroup = "fakeConsumer";
+#else
+            var storageConnectionString = StorageTestEnvironment.Instance.StorageConnectionString;
+            var blobContainerName = "not-real";
+            var eventHubsConnectionString = EventHubsTestEnvironment.Instance.EventHubsConnectionString;
+            var eventHubName = "fakeHub";
+            var consumerGroup = "fakeConsumer";
+#endif
 
             async Task processEventHandler(ProcessEventArgs eventArgs)
             {
                 try
                 {
                     // Perform the application-specific processing for an event.  This method
                     // is intended for illustration and is not defined in this snippet.
+
                     await DoSomethingWithTheEvent(eventArgs.Partition, eventArgs.Data);
                 }
                 catch
@@ -105,6 +106,7 @@ async Task processErrorHandler(ProcessErrorEventArgs eventArgs)
                 {
                     // Perform the application-specific processing for an error.  This method
                     // is intended for illustration and is not defined in this snippet.
+
                     await DoSomethingWithTheError(eventArgs.Exception);
                 }
                 catch
@@ -140,19 +142,20 @@ public async Task ProcessUntilCanceled()
             var cancellationSource = new CancellationTokenSource();
             cancellationSource.CancelAfter(TimeSpan.FromSeconds(45));
 
+#if SNIPPET
             var storageConnectionString = "<< CONNECTION STRING FOR THE STORAGE ACCOUNT >>";
             var blobContainerName = "<< NAME OF THE BLOB CONTAINER >>";
-            /*@@*/
-            /*@@*/ storageConnectionString = StorageTestEnvironment.Instance.StorageConnectionString;
-            /*@@*/ blobContainerName = storageScope.ContainerName;
 
             var eventHubsConnectionString = "<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>";
             var eventHubName = "<< NAME OF THE EVENT HUB >>";
             var consumerGroup = "<< NAME OF THE EVENT HUB CONSUMER GROUP >>";
-            /*@@*/
-            /*@@*/ eventHubsConnectionString = EventHubsTestEnvironment.Instance.EventHubsConnectionString;
-            /*@@*/ eventHubName = eventHubScope.EventHubName;
-            /*@@*/ consumerGroup = eventHubScope.ConsumerGroups.First();
+#else
+            var storageConnectionString = StorageTestEnvironment.Instance.StorageConnectionString;
+            var blobContainerName = storageScope.ContainerName;
+            var eventHubsConnectionString = EventHubsTestEnvironment.Instance.EventHubsConnectionString;
+            var eventHubName = eventHubScope.EventHubName;
+            var consumerGroup = eventHubScope.ConsumerGroups.First();
+#endif
 
             Task processEventHandler(ProcessEventArgs eventArgs) => Task.CompletedTask;
             Task processErrorHandler(ProcessErrorEventArgs eventArgs) => Task.CompletedTask;
@@ -169,6 +172,7 @@ public async Task ProcessUntilCanceled()
             {
                 // The processor performs its work in the background; block until cancellation
                 // to allow processing to take place.
+
                 await Task.Delay(Timeout.Infinite, cancellationSource.Token);
             }
             catch (TaskCanceledException)
@@ -183,6 +187,7 @@ public async Task ProcessUntilCanceled()
             finally
             {
                 // To prevent leaks, the handlers should be removed when processing is complete.
+
                 processor.ProcessEventAsync -= processEventHandler;
                 processor.ProcessErrorAsync -= processErrorHandler;
             }
@@ -199,23 +204,24 @@ public void CreateWithIdentity()
         {
             #region Snippet:EventHubs_Processor_ReadMe_CreateWithIdentity
 
-            TokenCredential credential = new DefaultAzureCredential();
-            /*@@*/ credential = EventHubsTestEnvironment.Instance.Credential;
-
-            string blobStorageUrl ="<< FULLY-QUALIFIED CONTAINER URL (like https://myaccount.blob.core.windows.net/mycontainer) >>";
-            /*@@*/ blobStorageUrl = $"https://{ StorageTestEnvironment.Instance.StorageAccountName }.{ StorageTestEnvironment.Instance.StorageEndpointSuffix }/{ "fake-container" }";
-            /*@@*/
-            BlobContainerClient storageClient = new BlobContainerClient(new Uri(blobStorageUrl), credential);
+#if SNIPPET
+            var credential = new DefaultAzureCredential();
+            var blobStorageUrl ="<< FULLY-QUALIFIED CONTAINER URL (like https://myaccount.blob.core.windows.net/mycontainer) >>";
 
             var fullyQualifiedNamespace = "<< FULLY-QUALIFIED EVENT HUBS NAMESPACE (like something.servicebus.windows.net) >>";
             var eventHubName = "<< NAME OF THE EVENT HUB >>";
             var consumerGroup = "<< NAME OF THE EVENT HUB CONSUMER GROUP >>";
-            /*@@*/
-            /*@@*/ fullyQualifiedNamespace = EventHubsTestEnvironment.Instance.FullyQualifiedNamespace;
-            /*@@*/ eventHubName = "fakeHub";
-            /*@@*/ consumerGroup = "fakeConsumer";
+#else
+            var credential = EventHubsTestEnvironment.Instance.Credential;
+            var blobStorageUrl = $"https://{ StorageTestEnvironment.Instance.StorageAccountName }.{ StorageTestEnvironment.Instance.StorageEndpointSuffix }/{ "fake-container" }";
+            var fullyQualifiedNamespace = EventHubsTestEnvironment.Instance.FullyQualifiedNamespace;
+            var eventHubName = "fakeHub";
+            var consumerGroup = "fakeConsumer";
+#endif
+
+            var storageClient = new BlobContainerClient(new Uri(blobStorageUrl), credential);
 
-            EventProcessorClient processor = new EventProcessorClient
+            var processor = new EventProcessorClient
             (
                 storageClient,
                 consumerGroup,

sdk/eventhub/Azure.Messaging.EventHubs.Processor/tests/Snippets/Sample01_HelloWorldLiveTests.cs

@@ -60,11 +60,13 @@ public async Task PublishEvents()
         {
             #region Snippet:EventHubs_Processor_Sample01_PublishEvents
 
+#if SNIPPET
             var connectionString = "<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>";
             var eventHubName = "<< NAME OF THE EVENT HUB >>";
-            /*@@*/
-            /*@@*/ connectionString = EventHubsTestEnvironment.Instance.EventHubsConnectionString;
-            /*@@*/ eventHubName = _eventHubScope.EventHubName;
+#else
+            var connectionString = EventHubsTestEnvironment.Instance.EventHubsConnectionString;
+            var eventHubName = _eventHubScope.EventHubName;
+#endif
 
             var producer = new EventHubProducerClient(connectionString, eventHubName);
 
@@ -123,19 +125,20 @@ public async Task ProcessEvents()
 
             #region Snippet:EventHubs_Processor_Sample01_ProcessEvents
 
+#if SNIPPET
             var storageConnectionString = "<< CONNECTION STRING FOR THE STORAGE ACCOUNT >>";
             var blobContainerName = "<< NAME OF THE BLOB CONTAINER >>";
-            /*@@*/
-            /*@@*/ storageConnectionString = StorageTestEnvironment.Instance.StorageConnectionString;
-            /*@@*/ blobContainerName = storageScope.ContainerName;
 
             var eventHubsConnectionString = "<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>";
             var eventHubName = "<< NAME OF THE EVENT HUB >>";
             var consumerGroup = "<< NAME OF THE EVENT HUB CONSUMER GROUP >>";
-            /*@@*/
-            /*@@*/ eventHubsConnectionString = EventHubsTestEnvironment.Instance.EventHubsConnectionString;
-            /*@@*/ eventHubName = _eventHubScope.EventHubName;
-            /*@@*/ consumerGroup = _eventHubScope.ConsumerGroups.First();
+#else
+            var storageConnectionString = StorageTestEnvironment.Instance.StorageConnectionString;
+            var blobContainerName = storageScope.ContainerName;
+            var eventHubsConnectionString = EventHubsTestEnvironment.Instance.EventHubsConnectionString;
+            var eventHubName = _eventHubScope.EventHubName;
+            var consumerGroup = _eventHubScope.ConsumerGroups.First();
+#endif
 
             var storageClient = new BlobContainerClient(
                 storageConnectionString,