[AzureMonitorExporter] refactor RequestTelemetryTest (Azure#29910)

* refactor tests

* cleanup

* remove

* cleanup

* citation

Author: Timothy Mothra

sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/tests/Integration.Tests/Azure.Monitor.OpenTelemetry.Exporter.Integration.Tests.csproj

@@ -40,8 +40,4 @@
     <ProjectReference Include="..\Integration.Tests.AspNetCoreWebApp\Azure.Monitor.OpenTelemetry.Exporter.Integration.Tests.AspNetCoreWebApp.csproj" />
   </ItemGroup>
 
-  <ItemGroup>
-    <Compile Include="$(AzureCoreSharedSources)\HttpPipelineMessageHandler.cs" LinkBase="Shared" />
-  </ItemGroup>
-
 </Project>

sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/tests/Integration.Tests/RequestTelemetryTests.cs

@@ -5,25 +5,25 @@
 using System.Linq;
 using System.Threading.Tasks;
 
+using Azure.Monitor.OpenTelemetry.Exporter.Integration.Tests.AspNetCoreWebApp;
 using Azure.Monitor.OpenTelemetry.Exporter.Integration.Tests.TestFramework;
-using Azure.Monitor.OpenTelemetry.Exporter.Models;
+
+using Microsoft.AspNetCore.Mvc.Testing;
+using Microsoft.AspNetCore.TestHost;
+using Microsoft.Extensions.DependencyInjection;
+
+using OpenTelemetry;
+using OpenTelemetry.Trace;
 
 using Xunit;
 using Xunit.Abstractions;
 
 namespace Azure.Monitor.OpenTelemetry.Exporter.Integration.Tests
 {
-    public class RequestTelemetryTests : IClassFixture<OpenTelemetryWebApplicationFactory<AspNetCoreWebApp.Startup>>
+    public class RequestTelemetryTests : WebApplicationTestsBase
     {
-        private readonly OpenTelemetryWebApplicationFactory<AspNetCoreWebApp.Startup> factory;
-        private readonly ITestOutputHelper output;
-        private readonly TelemetryItemOutputHelper telemetryOutput;
-
-        public RequestTelemetryTests(OpenTelemetryWebApplicationFactory<AspNetCoreWebApp.Startup> factory, ITestOutputHelper output)
+        public RequestTelemetryTests(WebApplicationFactory<Startup> factory, ITestOutputHelper output) : base(factory, output)
         {
-            this.factory = factory;
-            this.output = output;
-            this.telemetryOutput = new TelemetryItemOutputHelper(output);
         }
 
         /// <summary>
@@ -36,35 +36,35 @@ public async Task VerifyRequestTelemetry()
             string testValue = Guid.NewGuid().ToString();
 
             // Arrange
-            var client = this.factory.CreateClient();
+            var transmitter = new MockTransmitter();
+            var activityProcessor = new SimpleActivityExportProcessor(new AzureMonitorTraceExporter(transmitter));
+            var client = this.factory
+                .WithWebHostBuilder(builder =>
+                    builder.ConfigureTestServices(services =>
+                    {
+                        services.AddOpenTelemetryTracing((builder) => builder
+                            .AddAspNetCoreInstrumentation()
+                            .AddProcessor(activityProcessor));
+                    }))
+                .CreateClient();
 
             // Act
             var request = new Uri(client.BaseAddress, $"api/home/{testValue}");
             var response = await client.GetAsync(request);
 
             // Shutdown
             response.EnsureSuccessStatusCode();
-            this.factory.WaitForActivityExport();
+            this.WaitForActivityExport(transmitter.TelemetryItems);
 
             // Assert
-            Assert.True(this.factory.TelemetryItems.Any(), "test project did not capture telemetry");
-            var telemetryItem = this.factory.TelemetryItems.Single();
-            telemetryOutput.Write(telemetryItem);
-
-            Assert.Equal("Request", telemetryItem.Name);
-
-            Assert.Contains("ai.operation.id", telemetryItem.Tags.Keys);
-            Assert.Contains("ai.user.userAgent", telemetryItem.Tags.Keys);
-            Assert.Contains("ai.operation.name", telemetryItem.Tags.Keys);
-            Assert.Contains("ai.location.ip", telemetryItem.Tags.Keys);
-            Assert.Contains("ai.cloud.role", telemetryItem.Tags.Keys);
-            Assert.Contains("ai.cloud.roleInstance", telemetryItem.Tags.Keys);
-            Assert.Contains("ai.internal.sdkVersion", telemetryItem.Tags.Keys);
+            Assert.True(transmitter.TelemetryItems.Any(), "test project did not capture telemetry");
+            var telemetryItem = transmitter.TelemetryItems.Single();
+            this.telemetryOutput.Write(telemetryItem);
 
-            Assert.Equal(nameof(RequestData), telemetryItem.Data.BaseType);
-            var requestData = (RequestData)telemetryItem.Data.BaseData;
-            Assert.Equal("200", requestData.ResponseCode);
-            Assert.Equal(request.AbsoluteUri, requestData.Url);
+            AssertRequestTelemetry(
+                telemetryItem: telemetryItem,
+                expectedResponseCode: "200",
+                expectedUrl: request.AbsoluteUri);
         }
     }
 }

sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/tests/Integration.Tests/TestFramework/OpenTelemetryWebApplicationFactory.cs

@@ -0,0 +1,70 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Collections.Concurrent;
+using System.Linq;
+using System.Threading;
+
+using Azure.Monitor.OpenTelemetry.Exporter.Models;
+
+using Microsoft.AspNetCore.Mvc.Testing;
+
+using Xunit;
+using Xunit.Abstractions;
+
+namespace Azure.Monitor.OpenTelemetry.Exporter.Integration.Tests.TestFramework
+{
+    public abstract class WebApplicationTestsBase : IClassFixture<WebApplicationFactory<AspNetCoreWebApp.Startup>>
+    {
+        protected readonly WebApplicationFactory<AspNetCoreWebApp.Startup> factory;
+        protected readonly ITestOutputHelper output;
+        internal readonly TelemetryItemOutputHelper telemetryOutput;
+
+        public WebApplicationTestsBase(WebApplicationFactory<AspNetCoreWebApp.Startup> factory, ITestOutputHelper output)
+        {
+            this.factory = factory;
+            this.output = output;
+            this.telemetryOutput = new TelemetryItemOutputHelper(output);
+        }
+
+        /// <summary>
+        /// Wait for End callback to execute because it is executed after response was returned.
+        /// </summary>
+        /// <remarks>
+        /// Copied from <see href="https://github.com/open-telemetry/opentelemetry-dotnet/blob/f471a9f197d797015123fe95d3e12b6abf8e1f5f/test/OpenTelemetry.Instrumentation.AspNetCore.Tests/BasicTests.cs#L558-L570"/>.
+        /// </remarks>
+        internal void WaitForActivityExport(ConcurrentBag<TelemetryItem> telemetryItems)
+        {
+            var result = SpinWait.SpinUntil(
+                condition: () =>
+                {
+                    Thread.Sleep(10);
+                    return telemetryItems.Any();
+                },
+                timeout: TimeSpan.FromSeconds(10));
+
+            Assert.True(result, $"{nameof(WaitForActivityExport)} failed.");
+        }
+
+        internal void AssertRequestTelemetry(TelemetryItem telemetryItem, string expectedResponseCode, string expectedUrl)
+        {
+            Assert.Equal("Request", telemetryItem.Name);
+
+            // Tags
+            Assert.Contains("ai.operation.id", telemetryItem.Tags.Keys);
+            Assert.Contains("ai.user.userAgent", telemetryItem.Tags.Keys);
+            Assert.Contains("ai.operation.name", telemetryItem.Tags.Keys);
+            Assert.Contains("ai.location.ip", telemetryItem.Tags.Keys);
+            Assert.Contains("ai.cloud.role", telemetryItem.Tags.Keys);
+            Assert.Contains("ai.cloud.roleInstance", telemetryItem.Tags.Keys);
+            Assert.Contains("ai.internal.sdkVersion", telemetryItem.Tags.Keys);
+
+            // BaseData
+            Assert.Equal("RequestData", telemetryItem.Data.BaseType);
+            var requestData = (RequestData)telemetryItem.Data.BaseData;
+            Assert.Equal(expectedResponseCode, requestData.ResponseCode);
+            Assert.Equal(expectedUrl, requestData.Url);
+        }
+    }
+}