Implemented test for ClientIP enrichement (#15)

Test implemented using SpinWait pattern
matthiasguentert · Oct 24, 2022 · abb0270 · abb0270
1 parent 96993b1
commit abb0270
Show file tree

Hide file tree

Showing 6 changed files with 102 additions and 14 deletions.
diff --git a/test/ApplicationInsightsRequestLoggingTests/ApplicationInsightsRequestLoggingTests.csproj b/test/ApplicationInsightsRequestLoggingTests/ApplicationInsightsRequestLoggingTests.csproj
@@ -7,18 +7,19 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="FluentAssertions" Version="6.2.0" />
+    <PackageReference Include="FluentAssertions" Version="6.8.0" />
     <PackageReference Include="Microsoft.ApplicationInsights.AspNetCore" Version="2.21.0" />
-    <PackageReference Include="Microsoft.AspNetCore.TestHost" Version="3.1.21" />
-    <PackageReference Include="Microsoft.Extensions.Hosting" Version="6.0.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.0.0" />
-    <PackageReference Include="Moq" Version="4.16.1" />
-    <PackageReference Include="xunit" Version="2.4.1" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+    <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="6.0.10" />
+    <PackageReference Include="Microsoft.AspNetCore.TestHost" Version="6.0.10" />
+    <PackageReference Include="Microsoft.Extensions.Hosting" Version="6.0.1" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.2" />
+    <PackageReference Include="Moq" Version="4.18.2" />
+    <PackageReference Include="xunit" Version="2.4.2" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="coverlet.collector" Version="3.1.0">
+    <PackageReference Include="coverlet.collector" Version="3.1.2">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>

diff --git a/test/ApplicationInsightsRequestLoggingTests/BodyLoggerMiddlewareTests.cs b/test/ApplicationInsightsRequestLoggingTests/BodyLoggerMiddlewareTests.cs
@@ -9,6 +9,9 @@
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Http;
 using System.Net.Http;
+using System.Threading;
+using Microsoft.ApplicationInsights.Channel;
+using Microsoft.ApplicationInsights.DataContracts;
 using Moq;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -178,5 +181,65 @@ public async void BodyLoggerMiddleware_Should_Properly_Pass()
             var body = await response.Content.ReadAsStringAsync();
             body.Should().Be("Hello from terminating delegate!");
         }
+
+        [Fact]
+        public async void BodyLoggerMiddleware_Should_Disable_Ip_Masking()
+        {
+            // Arrange            
+            using var host = await new HostBuilder()
+                .ConfigureWebHost(webBuilder =>
+                {
+                    webBuilder
+                        .UseTestServer()
+                        .ConfigureTestServices(services =>
+                        {
+                            // Set fake client IP 
+                            services.AddSingleton<FakeRemoteIpAddressMiddleware>();
+
+                            // Register stub telemetry channel for testing
+                            services.AddSingleton<ITelemetryChannel, FakeTelemetryChannel>();
+
+                            // Register app insights infrastructure
+                            services.AddApplicationInsightsTelemetry();
+
+                            // Add request body logging middleware
+                            services.AddAppInsightsHttpBodyLogging(o =>
+                            {
+                                // Ensure middleware kicks in on success status
+                                o.HttpCodes.Add(StatusCodes.Status200OK);
+                                o.DisableIpMasking = true;
+                            });
+                        })
+                        .Configure(app =>
+                        {
+                            app.UseMiddleware<FakeRemoteIpAddressMiddleware>();
+                            app.UseAppInsightsHttpBodyLogging();
+                            app.Run(async context =>
+                            {
+                                // Send request body back in response body
+                                await context.Request.Body.CopyToAsync(context.Response.Body);
+                            });
+                        });
+                })
+                .StartAsync();
+
+            // Act
+            _ = await host.GetTestClient().PostAsync("/", new StringContent("Hello from client"));
+
+            // Assert
+            var channel = host.Services.GetService<ITelemetryChannel>() as FakeTelemetryChannel;
+            channel.Should().NotBeNull();
+
+            // Unfortunately, threads can't be synchronized in a deterministic manner
+            SpinWait.SpinUntil(() =>
+            {
+                Thread.Sleep(10);
+                return channel?.SentTelemtries.Count >= 1;
+            }, TimeSpan.FromSeconds(3)).Should().BeTrue();
+
+            var requestItem = channel?.SentTelemtries.First() as RequestTelemetry;
+            requestItem.Should().NotBeNull();
+            requestItem?.Properties["ClientIp"].Should().Be("127.168.1.32");
+        }
     }
 }
diff --git a/test/ApplicationInsightsRequestLoggingTests/FakeTelemetryChannel.cs b/test/ApplicationInsightsRequestLoggingTests/FakeTelemetryChannel.cs
@@ -0,0 +1,26 @@
+using System.Collections.Generic;
+using Microsoft.ApplicationInsights.Channel;
+
+namespace ApplicationInsightsRequestLoggingTests;
+
+public class FakeTelemetryChannel : ITelemetryChannel
+{
+    public List<ITelemetry> SentTelemtries = new();
+    public bool IsFlushed { get; private set; }
+    public bool? DeveloperMode { get; set; }
+    public string EndpointAddress { get; set; }
+
+    public void Send(ITelemetry item)
+    {
+        SentTelemtries.Add(item);
+    }
+
+    public void Flush()
+    {
+        IsFlushed = true;
+    }
+
+    public void Dispose()
+    {
+    }
+}
diff --git a/test/ManualTests/ManualTests.csproj b/test/ManualTests/ManualTests.csproj
@@ -14,5 +14,4 @@
     <ItemGroup>
       <ProjectReference Include="..\..\src\ApplicationInsightsRequestLogging\ApplicationInsightsRequestLogging.csproj" />
     </ItemGroup>
-
 </Project>
diff --git a/test/ManualTests/Program.cs b/test/ManualTests/Program.cs
@@ -38,4 +38,6 @@ void ConfigureMiddleware(IApplicationBuilder app, IServiceProvider services)
 void ConfigureEndpoints(IEndpointRouteBuilder app, IServiceProvider services)
 {
     app.MapControllers();
-}
+}
+
+public partial class Program { }
diff --git a/test/ManualTests/appsettings.json b/test/ManualTests/appsettings.json
@@ -5,8 +5,5 @@
       "Microsoft.AspNetCore": "Warning"
     }
   },
-  "AllowedHosts": "*",
-  "ApplicationInsights": {
-    "ConnectionString": "replace-me"
-  }
+  "AllowedHosts": "*"
 }