Migrate integration tests from TestServerBuilder to TestWebApplicationFactory

tests/Sitecore.AspNetCore.SDK.RenderingEngine.Benchmarks/ExperienceEditorMiddlewareBenchmarks.cs

@@ -1,6 +1,8 @@
 using System.Diagnostics.CodeAnalysis;
 using BenchmarkDotNet.Attributes;
 using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Mvc.Testing;
 using Microsoft.AspNetCore.TestHost;
 using Microsoft.Extensions.DependencyInjection;
 using NSubstitute;
@@ -17,37 +19,42 @@ namespace Sitecore.AspNetCore.SDK.RenderingEngine.Benchmarks;
 [ExcludeFromCodeCoverage]
 public class ExperienceEditorMiddlewareBenchmarks : IDisposable
 {
-    private readonly TestServer _server;
+    private readonly WebApplicationFactory<TestWebApplicationProgram> _factory;
     private readonly HttpClient _client;
     private readonly StringContent _content;
     private RenderingEngineBenchmarks? _baseLineTestInstance;
 
     public ExperienceEditorMiddlewareBenchmarks()
     {
-        TestServerBuilder testHostBuilder = new();
-        testHostBuilder
-            .ConfigureServices(builder =>
+        WebApplicationFactory<TestWebApplicationProgram> factory = new TestWebApplicationFactory<TestWebApplicationProgram>();
+
+        _factory = factory.WithWebHostBuilder(builder =>
+        {
+            builder.ConfigureTestServices(services =>
             {
-                builder.AddSingleton(Substitute.For<ISitecoreLayoutClient>());
-                builder.AddSitecoreRenderingEngine(options =>
+                services.AddRouting();
+
+                services.AddSingleton(Substitute.For<ISitecoreLayoutClient>());
+
+                services.AddSitecoreRenderingEngine(options =>
                 {
                     options.AddDefaultComponentRenderer();
                 }).WithExperienceEditor(options =>
                 {
                     options.Endpoint = TestConstants.EEMiddlewarePostEndpoint;
                     options.JssEditingSecret = TestConstants.JssEditingSecret;
                 });
-            })
-            .Configure(app =>
+            });
+
+            builder.Configure(app =>
             {
                 app.UseSitecoreExperienceEditor();
                 app.UseRouting();
                 app.UseSitecoreRenderingEngine();
             });
+        });
 
-        _server = testHostBuilder.BuildServer(new Uri("http://localhost"));
-
-        _client = _server.CreateClient();
+        _client = _factory.CreateClient();
         _content = new StringContent(TestConstants.EESampleRequest);
     }
 
@@ -76,7 +83,7 @@ public async Task RegularExperienceEditorRequestHandling()
 
     public void Dispose()
     {
-        _server.Dispose();
+        _factory.Dispose();
         _client.Dispose();
         _content.Dispose();
         _baseLineTestInstance?.Dispose();

tests/Sitecore.AspNetCore.SDK.RenderingEngine.Benchmarks/RenderingEngineBenchmarks.cs

@@ -2,11 +2,12 @@
 using System.Net;
 using BenchmarkDotNet.Attributes;
 using Microsoft.AspNetCore.Builder;
-using Microsoft.AspNetCore.TestHost;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Mvc.Testing;
+using Microsoft.Extensions.DependencyInjection;
 using Sitecore.AspNetCore.SDK.AutoFixture.Mocks;
 using Sitecore.AspNetCore.SDK.LayoutService.Client.Extensions;
 using Sitecore.AspNetCore.SDK.RenderingEngine.Extensions;
-using Sitecore.AspNetCore.SDK.RenderingEngine.Integration.Tests;
 using Sitecore.AspNetCore.SDK.TestData;
 
 namespace Sitecore.AspNetCore.SDK.RenderingEngine.Benchmarks;
@@ -16,38 +17,38 @@ namespace Sitecore.AspNetCore.SDK.RenderingEngine.Benchmarks;
 [ExcludeFromCodeCoverage]
 public class RenderingEngineBenchmarks : IDisposable
 {
-    private TestServer? _server;
+    private WebApplicationFactory<TestWebApplicationProgram>? _factory;
     private HttpClient? _client;
     private MockHttpMessageHandler? _mockClientHandler;
 
     [GlobalSetup]
     public void Setup()
-    {
-        TestServerBuilder testHostBuilder = new();
-        _mockClientHandler = new MockHttpMessageHandler();
-        testHostBuilder
-            .ConfigureServices(builder =>
-            {
-                builder
-                    .AddSitecoreLayoutService()
-                    .AddHttpHandler("mock", _ => new HttpClient(_mockClientHandler) { BaseAddress = new Uri("http://layout.service") })
-                    .AsDefaultHandler();
+        {
+            _mockClientHandler = new MockHttpMessageHandler();
 
-                builder.AddSitecoreRenderingEngine(options =>
+            _factory = new WebApplicationFactory<TestWebApplicationProgram>()
+                .WithWebHostBuilder(builder =>
                 {
-                    options.AddDefaultComponentRenderer();
-                });
-            })
-            .Configure(app =>
-            {
-                app.UseRouting();
-                app.UseSitecoreRenderingEngine();
-            });
+                    builder.ConfigureServices(services =>
+                    {
+                        services.AddRouting();
+                        services.AddSitecoreLayoutService();
+                        services.AddHttpClient("mock").ConfigurePrimaryHttpMessageHandler(() => _mockClientHandler!);
+                        services.AddSitecoreRenderingEngine(options =>
+                        {
+                            options.AddDefaultComponentRenderer();
+                        });
+                    });
 
-        _server = testHostBuilder.BuildServer(new Uri("http://localhost"));
+                    builder.Configure(app =>
+                    {
+                        app.UseRouting();
+                        app.UseSitecoreRenderingEngine();
+                    });
+                });
 
-        _client = _server.CreateClient();
-    }
+            _client = _factory.CreateClient();
+        }
 
     [Benchmark(Baseline = true)]
     public async Task RegularHomePageRequest()
@@ -71,8 +72,8 @@ public async Task RegularHomePageRequest()
 
     public void Dispose()
     {
-        _server?.Dispose();
         _client?.Dispose();
+        _factory?.Dispose();
         _mockClientHandler?.Dispose();
         GC.SuppressFinalize(this);
     }

tests/Sitecore.AspNetCore.SDK.RenderingEngine.Benchmarks/TrackingBenchmarks.cs

@@ -2,13 +2,13 @@
 using System.Net;
 using BenchmarkDotNet.Attributes;
 using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.HttpOverrides;
-using Microsoft.AspNetCore.TestHost;
+using Microsoft.AspNetCore.Mvc.Testing;
 using Microsoft.Extensions.DependencyInjection;
 using Sitecore.AspNetCore.SDK.AutoFixture.Mocks;
 using Sitecore.AspNetCore.SDK.LayoutService.Client.Extensions;
 using Sitecore.AspNetCore.SDK.RenderingEngine.Extensions;
-using Sitecore.AspNetCore.SDK.RenderingEngine.Integration.Tests;
 using Sitecore.AspNetCore.SDK.TestData;
 using Sitecore.AspNetCore.SDK.Tracking;
 using Sitecore.AspNetCore.SDK.Tracking.VisitorIdentification;
@@ -21,31 +21,30 @@ namespace Sitecore.AspNetCore.SDK.RenderingEngine.Benchmarks;
 [ExcludeFromCodeCoverage]
 public class TrackingBenchmarks : IDisposable
 {
-    private TestServer? _server;
+    private WebApplicationFactory<TestWebApplicationProgram>? _factory;
     private HttpClient? _client;
     private MockHttpMessageHandler? _mockClientHandler;
     private RenderingEngineBenchmarks? _baseLineTestInstance;
 
     [GlobalSetup(Target = nameof(RegularHomePageRequestWithTracking))]
     public void TrackingBenchmarksSetup()
     {
-        TestServerBuilder testHostBuilder = new();
         _mockClientHandler = new MockHttpMessageHandler();
-        testHostBuilder
-            .ConfigureServices(builder =>
+
+        _factory = new WebApplicationFactory<TestWebApplicationProgram>()
+            .WithWebHostBuilder(builder =>
             {
-                builder.Configure<ForwardedHeadersOptions>(options =>
+                builder.ConfigureServices(services =>
                 {
-                    options.ForwardedHeaders = ForwardedHeaders.XForwardedFor |
-                                               ForwardedHeaders.XForwardedProto;
-                });
-
-                builder
-                    .AddSitecoreLayoutService()
-                    .AddHttpHandler("mock", _ => new HttpClient(_mockClientHandler) { BaseAddress = new Uri("http://layout.service") })
-                    .AsDefaultHandler();
+                    services.Configure<ForwardedHeadersOptions>(options =>
+                    {
+                        options.ForwardedHeaders = ForwardedHeaders.XForwardedFor |
+                                                   ForwardedHeaders.XForwardedProto;
+                    });
 
-                builder.AddSitecoreRenderingEngine(options =>
+                    services.AddSitecoreLayoutService();
+                    services.AddHttpClient("mock").ConfigurePrimaryHttpMessageHandler(() => _mockClientHandler!);
+                    services.AddSitecoreRenderingEngine(options =>
                     {
                         options.AddDefaultComponentRenderer();
                     }).ForwardHeaders(options =>
@@ -66,22 +65,15 @@ public void TrackingBenchmarksSetup()
                     })
                     .WithTracking();
 
-                builder.AddSitecoreVisitorIdentification(options =>
-                {
-                    options.SitecoreInstanceUri = new Uri("http://layout.service");
+                    services.AddSitecoreVisitorIdentification(options =>
+                    {
+                        options.SitecoreInstanceUri = new Uri("http://layout.service");
+                    });
+                    services.AddSingleton<IStartupFilter, PipelineStartupFilter>();
                 });
-            })
-            .Configure(app =>
-            {
-                app.UseForwardedHeaders();
-                app.UseRouting();
-                app.UseSitecoreVisitorIdentification();
-                app.UseSitecoreRenderingEngine();
             });
 
-        _server = testHostBuilder.BuildServer(new Uri("http://localhost"));
-
-        _client = _server.CreateClient();
+        _client = _factory.CreateClient();
     }
 
     [GlobalSetup(Target = nameof(RegularHomePageRequest))]
@@ -119,10 +111,25 @@ public async Task RegularHomePageRequestWithTracking()
 
     public void Dispose()
     {
-        _server?.Dispose();
         _client?.Dispose();
+        _factory?.Dispose();
         _mockClientHandler?.Dispose();
         _baseLineTestInstance?.Dispose();
         GC.SuppressFinalize(this);
     }
+
+    private class PipelineStartupFilter : IStartupFilter
+    {
+        public Action<IApplicationBuilder> Configure(Action<IApplicationBuilder> next)
+        {
+            return app =>
+            {
+                app.UseForwardedHeaders();
+                app.UseRouting();
+                app.UseSitecoreVisitorIdentification();
+                app.UseSitecoreRenderingEngine();
+                next(app);
+            };
+        }
+    }
 }

tests/Sitecore.AspNetCore.SDK.RenderingEngine.Integration.Tests/Fixtures/Binding/ComplexModelBindingFixture.cs

@@ -1,6 +1,7 @@
 using System.Net;
 using AwesomeAssertions;
 using HtmlAgilityPack;
+using Microsoft.AspNetCore.Mvc.Testing;
 using Microsoft.AspNetCore.TestHost;
 using Sitecore.AspNetCore.SDK.AutoFixture.Mocks;
 using Sitecore.AspNetCore.SDK.LayoutService.Client.Extensions;
@@ -10,43 +11,11 @@
 
 namespace Sitecore.AspNetCore.SDK.RenderingEngine.Integration.Tests.Fixtures.Binding;
 
-public class ComplexModelBindingFixture : IDisposable
+public class ComplexModelBindingFixture(TestWebApplicationFactory<TestWebApplicationProgram> factory) : IClassFixture<TestWebApplicationFactory<TestWebApplicationProgram>>, IDisposable
 {
-    private readonly TestServer _server;
-    private readonly MockHttpMessageHandler _mockClientHandler;
+    private readonly MockHttpMessageHandler _mockClientHandler = new();
     private readonly Uri _layoutServiceUri = new("http://layout.service");
 
-    public ComplexModelBindingFixture()
-    {
-        TestServerBuilder testHostBuilder = new();
-        _mockClientHandler = new MockHttpMessageHandler();
-        testHostBuilder
-            .ConfigureServices(builder =>
-            {
-                builder
-                    .AddSitecoreLayoutService()
-                    .AddHttpHandler("mock", _ => new HttpClient(_mockClientHandler) { BaseAddress = _layoutServiceUri })
-                    .AsDefaultHandler();
-                builder.AddSitecoreRenderingEngine(options =>
-                {
-                    options
-                        .AddModelBoundView<ComponentModels.ComplexComponent>(name => name.Equals("Complex-Component", StringComparison.OrdinalIgnoreCase), "ComplexComponent")
-                        .AddDefaultComponentRenderer();
-                });
-            })
-            .Configure(app =>
-            {
-                app.UseRouting();
-                app.UseSitecoreRenderingEngine();
-                app.UseEndpoints(endpoints =>
-                {
-                    endpoints.MapDefaultControllerRoute();
-                });
-            });
-
-        _server = testHostBuilder.BuildServer(new Uri("http://localhost"));
-    }
-
     [Fact]
     public async Task SitecoreLayoutModelBinders_BindDataCorrectly()
     {
@@ -57,7 +26,7 @@ public async Task SitecoreLayoutModelBinders_BindDataCorrectly()
             Content = new StringContent(Serializer.Serialize(CannedResponses.WithNestedPlaceholder))
         });
 
-        HttpClient client = _server.CreateClient();
+        HttpClient client = BuildComplexModelBindingWebApplicationFactory().CreateClient();
 
         // Act
         string response = await client.GetStringAsync(new Uri("/", UriKind.Relative));
@@ -103,8 +72,38 @@ public async Task SitecoreLayoutModelBinders_BindDataCorrectly()
 
     public void Dispose()
     {
-        _server.Dispose();
         _mockClientHandler.Dispose();
         GC.SuppressFinalize(this);
     }
+
+    private WebApplicationFactory<TestWebApplicationProgram> BuildComplexModelBindingWebApplicationFactory()
+    {
+        return factory
+            .WithWebHostBuilder(builder =>
+            {
+                builder.ConfigureTestServices(services =>
+                {
+                    services
+                        .AddSitecoreLayoutService()
+                        .AddHttpHandler("mock", _ => new HttpClient(_mockClientHandler) { BaseAddress = _layoutServiceUri })
+                        .AsDefaultHandler();
+                    services.AddSitecoreRenderingEngine(options =>
+                    {
+                        options
+                            .AddModelBoundView<ComponentModels.ComplexComponent>(name => name.Equals("Complex-Component", StringComparison.OrdinalIgnoreCase), "ComplexComponent")
+                            .AddDefaultComponentRenderer();
+                    });
+                });
+
+                builder.Configure(app =>
+                {
+                    app.UseRouting();
+                    app.UseSitecoreRenderingEngine();
+                    app.UseEndpoints(endpoints =>
+                    {
+                        endpoints.MapDefaultControllerRoute();
+                    });
+                });
+            });
+    }
 }