Refactor tests to include ITestOutputHelper for improved logging and diagnostics (#13270)

Author: davidfowl

tests/Aspire.Hosting.Tests/AppHostSmokeTests.cs

@@ -7,8 +7,6 @@
 using Microsoft.DotNet.RemoteExecutor;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
-
-//using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Testing;
 using Microsoft.Extensions.Options;

tests/Aspire.Hosting.Tests/AsHttp2ServiceTests.cs

@@ -1,9 +1,11 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using Aspire.Hosting.Utils;
+
 namespace Aspire.Hosting.Tests;
 
-public class AsHttp2ServiceTests
+public class AsHttp2ServiceTests(ITestOutputHelper testOutputHelper)
 {
     [Fact]
     public void Http2TransportIsNotSetWhenHttp2ServiceAnnotationIsNotApplied()
@@ -57,5 +59,10 @@ public void Http2TransportIsNotAppliedToNonHttpEndpoints()
         Assert.Equal("http2", httpsBinding.Transport);
     }
 
-    private static TestProgram CreateTestProgram(string[] args) => TestProgram.Create<AsHttp2ServiceTests>(args, disableDashboard: true);
+    private TestProgram CreateTestProgram(string[] args)
+    {
+        var program = TestProgram.Create<AsHttp2ServiceTests>(args, disableDashboard: true);
+        program.AppBuilder.Services.AddTestAndResourceLogging(testOutputHelper);
+        return program;
+    }
 }

tests/Aspire.Hosting.Tests/ContainerTunnelTests.cs

@@ -9,14 +9,14 @@
 
 namespace Aspire.Hosting.Tests;
 
-public class ContainerTunnelTests
+public class ContainerTunnelTests(ITestOutputHelper testOutputHelper)
 {
     [Fact]
     [RequiresDocker]
     public async Task ContainerTunnelWorksWithYarp()
     {
         const string testName = "container-tunnel-works-with-yarp";
-        using var builder = TestDistributedApplicationBuilder.Create();
+        using var builder = TestDistributedApplicationBuilder.Create(testOutputHelper);
         builder.Configuration[KnownConfigNames.EnableContainerTunnel] = "true";
 
         var servicea = builder.AddProject<Projects.ServiceA>($"{testName}-servicea");

tests/Aspire.Hosting.Tests/HealthCheckTests.cs

@@ -118,10 +118,9 @@ public async Task VerifyWithHttpHealthCheckBlocksDependentResources()
     [Fact]
     public async Task BuildThrowsOnMissingHealthCheckRegistration()
     {
-        using var builder = TestDistributedApplicationBuilder.Create();
+        using var builder = TestDistributedApplicationBuilder.Create(testOutputHelper);
 
         builder.Services.AddLogging(b => {
-            b.AddXunit(testOutputHelper);
             b.AddFakeLogging();
         });
 

tests/Aspire.Hosting.Tests/ManifestGenerationTests.cs

@@ -15,7 +15,7 @@
 
 namespace Aspire.Hosting.Tests;
 
-public class ManifestGenerationTests
+public class ManifestGenerationTests(ITestOutputHelper testOutputHelper)
 {
     [Fact]
     public void EnsureAddParameterWithSecretFalseDoesntEmitSecretField()
@@ -91,7 +91,7 @@ public void EnsureWorkerProjectDoesNotGetBindingsGenerated()
     [Fact]
     public async Task WithContainerRegistryUpdatesContainerImageAnnotationsDuringPublish()
     {
-        var builder = DistributedApplication.CreateBuilder(new DistributedApplicationOptions
+        var builder = CreateBuilder(new DistributedApplicationOptions
         {
             Args = GetManifestArgs(),
             ContainerRegistryOverride = "myprivateregistry.company.com"
@@ -113,7 +113,7 @@ public async Task WithContainerRegistryUpdatesContainerImageAnnotationsDuringPub
     [Fact]
     public void ExcludeLaunchProfileOmitsBindings()
     {
-        var appBuilder = DistributedApplication.CreateBuilder(new DistributedApplicationOptions
+        var appBuilder = CreateBuilder(new DistributedApplicationOptions
         { Args = GetJsonManifestArgs(), DisableDashboard = true, AssemblyName = typeof(ManifestGenerationTests).Assembly.FullName });
         var manifestStore = new JsonDocumentManifestStore();
         appBuilder.AddProject<Projects.ServiceA>("servicea", launchProfileName: null);
@@ -509,7 +509,7 @@ public void VerifyTestProgramFullManifest()
     [Fact]
     public async Task ParameterInputDefaultValuesGenerateCorrectly()
     {
-        var appBuilder = DistributedApplication.CreateBuilder();
+        var appBuilder = CreateBuilder();
         var param = appBuilder.AddParameter("param");
         param.Resource.Default = new GenerateParameterDefault()
         {
@@ -556,7 +556,7 @@ public async Task ParameterInputDefaultValuesGenerateCorrectly()
     [Fact]
     public async Task ContainerFilesAreWrittenToManifest()
     {
-        var builder = DistributedApplication.CreateBuilder(new DistributedApplicationOptions
+        var builder = CreateBuilder(new DistributedApplicationOptions
         {
             Args = GetManifestArgs()
         });
@@ -598,7 +598,7 @@ public async Task ContainerFilesAreWrittenToManifest()
     [Fact]
     public async Task ContainerFilesWithMultipleSourcesAreWrittenToManifest()
     {
-        var builder = DistributedApplication.CreateBuilder(new DistributedApplicationOptions
+        var builder = CreateBuilder(new DistributedApplicationOptions
         {
             Args = GetManifestArgs()
         });
@@ -642,7 +642,7 @@ public async Task ContainerFilesWithMultipleSourcesAreWrittenToManifest()
     [Fact]
     public async Task ContainerFilesWithMultipleDestinationsAreWrittenToManifest()
     {
-        var builder = DistributedApplication.CreateBuilder(new DistributedApplicationOptions
+        var builder = CreateBuilder(new DistributedApplicationOptions
         {
             Args = GetManifestArgs()
         });
@@ -695,9 +695,10 @@ public async Task ContainerFilesWithMultipleDestinationsAreWrittenToManifest()
         Assert.Equal(expectedManifest, destManifest.ToString());
     }
 
-    private static TestProgram CreateTestProgramJsonDocumentManifestPublisher(bool includeIntegrationServices = false, bool includeNodeApp = false)
+    private TestProgram CreateTestProgramJsonDocumentManifestPublisher(bool includeIntegrationServices = false, bool includeNodeApp = false)
     {
         var program = TestProgram.Create<ManifestGenerationTests>(GetJsonManifestArgs(), includeIntegrationServices, includeNodeApp);
+        program.AppBuilder.Services.AddTestAndResourceLogging(testOutputHelper);
         program.AppBuilder.Pipeline.AddJsonDocumentManifestPublishing();
         return program;
     }
@@ -713,4 +714,18 @@ private static string[] GetManifestArgs()
         var manifestPath = Path.Combine(Path.GetTempPath(), "tempmanifests", Guid.NewGuid().ToString(), "manifest.json");
         return ["--operation", "publish", "--step", "publish-manifest", "--output-path", manifestPath];
     }
+
+    private IDistributedApplicationBuilder CreateBuilder(DistributedApplicationOptions options)
+    {
+        var builder = DistributedApplication.CreateBuilder(options);
+        builder.Services.AddTestAndResourceLogging(testOutputHelper);
+        return builder;
+    }
+
+    private IDistributedApplicationBuilder CreateBuilder()
+    {
+        var builder = DistributedApplication.CreateBuilder();
+        builder.Services.AddTestAndResourceLogging(testOutputHelper);
+        return builder;
+    }
 }