Improve test reliability (dotnet#3321)

Author: ReubenBond

src/Aspire.Hosting/Dashboard/DashboardLifecycleHook.cs

@@ -215,7 +215,7 @@ private async Task WatchDashboardLogsAsync(CancellationToken cancellationToken)
 
         try
         {
-            await foreach (var notification in resourceNotificationService.WatchAsync(cancellationToken))
+            await foreach (var notification in resourceNotificationService.WatchAsync(cancellationToken).ConfigureAwait(false))
             {
                 // Track all dashboard resources and start watching their logs.
                 // TODO: In the future when resources can restart, we should handle purging the taskCache.

tests/Aspire.Hosting.Tests/Aspire.Hosting.Tests.csproj

@@ -33,6 +33,7 @@
     <ProjectReference Include="..\..\src\Aspire.Hosting.Nats\Aspire.Hosting.Nats.csproj" IsAspireProjectResource="false" />
     <ProjectReference Include="..\..\src\Aspire.Hosting.PostgreSQL\Aspire.Hosting.PostgreSQL.csproj" IsAspireProjectResource="false" />
     <ProjectReference Include="..\..\src\Aspire.Hosting.Qdrant\Aspire.Hosting.Qdrant.csproj" IsAspireProjectResource="false" />
+    <ProjectReference Include="..\..\src\Aspire.Hosting.Testing\Aspire.Hosting.Testing.csproj" />
     <ProjectReference Include="..\testproject\TestProject.AppHost\TestProject.AppHost.csproj" IsAspireProjectResource="false" />
     <ProjectReference Include="..\Aspire.Hosting.Tests.SharedShim\Aspire.Hosting.Tests.SharedShim.csproj" IsAspireProjectResource="false" Aliases="AspireHostingShared" />
     <ProjectReference Include="..\..\src\Components\Aspire.Microsoft.Data.SqlClient\Aspire.Microsoft.Data.SqlClient.csproj" IsAspireProjectResource="false" />

tests/Aspire.Hosting.Tests/Azure/AzureBicepResourceTests.cs

@@ -73,7 +73,7 @@ static void CreateConstruct(ResourceModuleConstruct construct)
     [MemberData(nameof(AzureExtensions))]
     public void AzureExtensionsAutomaticallyAddAzureProvisioning(Func<IDistributedApplicationBuilder, IResourceBuilder<IResource>> addAzureResource)
     {
-        using var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Run);
+        using var builder = TestDistributedApplicationBuilder.Create();
         addAzureResource(builder);
 
         var app = builder.Build();
@@ -85,7 +85,7 @@ public void AzureExtensionsAutomaticallyAddAzureProvisioning(Func<IDistributedAp
     [MemberData(nameof(AzureExtensions))]
     public void BicepResourcesAreIdempotent(Func<IDistributedApplicationBuilder, IResourceBuilder<IResource>> addAzureResource)
     {
-        using var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Run);
+        using var builder = TestDistributedApplicationBuilder.Create();
         var azureResourceBuilder = addAzureResource(builder);
 
         if (azureResourceBuilder.Resource is not AzureConstructResource bicepResource)
@@ -541,7 +541,7 @@ param logAnalyticsWorkspaceId string
     [Fact]
     public async Task AddApplicationInsightsWithoutExplicitLawGetsDefaultLawParameterInRunMode()
     {
-        using var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Run);
+        using var builder = TestDistributedApplicationBuilder.Create();
 
         var appInsights = builder.AddAzureApplicationInsights("appInsights");
 

tests/Aspire.Hosting.Tests/Azure/AzureResourceExtensionsTests.cs

@@ -28,7 +28,7 @@ public void AzureStorageUseEmulatorCallbackWithWithDataBindMountResultsInBindMou
         });
 
         var volumeAnnotation = storage.Resource.Annotations.OfType<ContainerMountAnnotation>().Single();
-        Assert.Equal(Path.GetFullPath(".azurite/storage"), volumeAnnotation.Source);
+        Assert.Equal(Path.Combine(builder.AppHostDirectory, ".azurite", "storage"), volumeAnnotation.Source);
         Assert.Equal("/data", volumeAnnotation.Target);
         Assert.Equal(ContainerMountType.BindMount, volumeAnnotation.Type);
         Assert.Equal(isReadOnly ?? false, volumeAnnotation.IsReadOnly);
@@ -54,7 +54,7 @@ public void AzureStorageUseEmulatorCallbackWithWithDataBindMountResultsInBindMou
         });
 
         var volumeAnnotation = storage.Resource.Annotations.OfType<ContainerMountAnnotation>().Single();
-        Assert.Equal(Path.GetFullPath("mydata"), volumeAnnotation.Source);
+        Assert.Equal(Path.Combine(builder.AppHostDirectory, "mydata"), volumeAnnotation.Source);
         Assert.Equal("/data", volumeAnnotation.Target);
         Assert.Equal(ContainerMountType.BindMount, volumeAnnotation.Type);
         Assert.Equal(isReadOnly ?? false, volumeAnnotation.IsReadOnly);
@@ -80,7 +80,7 @@ public void AzureStorageUseEmulatorCallbackWithWithDataVolumeResultsInVolumeAnno
         });
 
         var volumeAnnotation = storage.Resource.Annotations.OfType<ContainerMountAnnotation>().Single();
-        Assert.Equal("testhost-storage-data", volumeAnnotation.Source);
+        Assert.Equal("Aspire.Hosting.Tests-storage-data", volumeAnnotation.Source);
         Assert.Equal("/data", volumeAnnotation.Target);
         Assert.Equal(ContainerMountType.Volume, volumeAnnotation.Type);
         Assert.Equal(isReadOnly ?? false, volumeAnnotation.IsReadOnly);

tests/Aspire.Hosting.Tests/Dapr/DaprTests.cs

@@ -14,10 +14,7 @@ public class DaprTests
     [Fact]
     public async Task WithDaprSideCarAddsAnnotationAndSidecarResource()
     {
-        using var builder = TestDistributedApplicationBuilder.Create(new DistributedApplicationOptions
-        {
-            DisableDashboard = true
-        });
+        using var builder = TestDistributedApplicationBuilder.Create();
 
         builder.AddDapr(o =>
         {
@@ -95,10 +92,7 @@ public async Task WithDaprSideCarAddsAnnotationAndSidecarResource()
     [InlineData("https", "http", null, "https", "localhost", 8000)]
     public async Task WithDaprSideCarAddsAnnotationBasedOnTheSidecarAppOptions(string? schema, string? endPoint, int? port, string expectedSchema, string expectedChannelAddress, int expectedPort)
     {
-        using var builder = TestDistributedApplicationBuilder.Create(new DistributedApplicationOptions
-        {
-            DisableDashboard = true
-        });
+        using var builder = TestDistributedApplicationBuilder.Create();
 
         builder.AddDapr(o =>
         {

tests/Aspire.Hosting.Tests/Dashboard/DashboardResourceTests.cs

@@ -19,7 +19,7 @@ public class DashboardResourceTests
     [Fact]
     public async Task DashboardIsAutomaticallyAddedAsHiddenResource()
     {
-        using var builder = TestDistributedApplicationBuilder.Create();
+        using var builder = TestDistributedApplicationBuilder.Create(options => options.DisableDashboard = false);
 
         // Ensure any ambient configuration doesn't impact this test.
         builder.Configuration.AddInMemoryCollection(new Dictionary<string, string?>
@@ -34,7 +34,7 @@ public async Task DashboardIsAutomaticallyAddedAsHiddenResource()
             o.DashboardPath = dashboardPath;
         });
 
-        var app = builder.Build();
+        using var app = builder.Build();
 
         await app.ExecuteBeforeStartHooksAsync(default);
 
@@ -52,11 +52,11 @@ public async Task DashboardIsAutomaticallyAddedAsHiddenResource()
     [Fact]
     public async Task DashboardIsAddedFirst()
     {
-        using var builder = TestDistributedApplicationBuilder.Create();
+        using var builder = TestDistributedApplicationBuilder.Create(options => options.DisableDashboard = false);
 
         builder.AddContainer("my-container", "my-image");
 
-        var app = builder.Build();
+        using var app = builder.Build();
 
         await app.ExecuteBeforeStartHooksAsync(default);
 
@@ -71,7 +71,7 @@ public async Task DashboardIsAddedFirst()
     [Fact]
     public async Task DashboardDoesNotAddResource_ConfiguresExistingDashboard()
     {
-        using var builder = TestDistributedApplicationBuilder.Create();
+        using var builder = TestDistributedApplicationBuilder.Create(options => options.DisableDashboard = false);
 
         builder.Services.AddSingleton<IDashboardEndpointProvider, MockDashboardEndpointProvider>();
 
@@ -85,7 +85,7 @@ public async Task DashboardDoesNotAddResource_ConfiguresExistingDashboard()
 
         var container = builder.AddContainer(KnownResourceNames.AspireDashboard, "my-image");
 
-        var app = builder.Build();
+        using var app = builder.Build();
 
         await app.ExecuteBeforeStartHooksAsync(default);
 
@@ -144,7 +144,7 @@ public async Task DashboardDoesNotAddResource_ConfiguresExistingDashboard()
     [Fact]
     public async Task DashboardWithDllPathLaunchesDotnet()
     {
-        using var builder = TestDistributedApplicationBuilder.Create();
+        using var builder = TestDistributedApplicationBuilder.Create(options => options.DisableDashboard = false);
 
         var dashboardPath = Path.GetFullPath("dashboard.dll");
 
@@ -173,7 +173,7 @@ public async Task DashboardWithDllPathLaunchesDotnet()
     public async Task DashboardAuthConfigured_EnvVarsPresent()
     {
         // Arrange
-        using var builder = TestDistributedApplicationBuilder.Create();
+        using var builder = TestDistributedApplicationBuilder.Create(options => options.DisableDashboard = false);
 
         builder.Services.AddSingleton<IDashboardEndpointProvider, MockDashboardEndpointProvider>();
 
@@ -187,7 +187,7 @@ public async Task DashboardAuthConfigured_EnvVarsPresent()
             ["AppHost:OtlpApiKey"] = "TestOtlpApiKey!"
         });
 
-        var app = builder.Build();
+        using var app = builder.Build();
 
         await app.ExecuteBeforeStartHooksAsync(default);
 
@@ -208,7 +208,7 @@ public async Task DashboardAuthConfigured_EnvVarsPresent()
     public async Task DashboardAuthRemoved_EnvVarsUnsecured()
     {
         // Arrange
-        using var builder = TestDistributedApplicationBuilder.Create();
+        using var builder = TestDistributedApplicationBuilder.Create(options => options.DisableDashboard = false);
 
         builder.Services.AddSingleton<IDashboardEndpointProvider, MockDashboardEndpointProvider>();
 
@@ -220,7 +220,7 @@ public async Task DashboardAuthRemoved_EnvVarsUnsecured()
             ["DOTNET_DASHBOARD_OTLP_ENDPOINT_URL"] = "http://localhost"
         });
 
-        var app = builder.Build();
+        using var app = builder.Build();
 
         await app.ExecuteBeforeStartHooksAsync(default);
 
@@ -238,7 +238,7 @@ public async Task DashboardAuthRemoved_EnvVarsUnsecured()
     public async Task DashboardResourceServiceUriIsSet()
     {
         // Arrange
-        using var builder = TestDistributedApplicationBuilder.Create();
+        using var builder = TestDistributedApplicationBuilder.Create(options => options.DisableDashboard = false);
 
         builder.Services.AddSingleton<IDashboardEndpointProvider, MockDashboardEndpointProvider>();
 
@@ -250,7 +250,7 @@ public async Task DashboardResourceServiceUriIsSet()
             ["DOTNET_DASHBOARD_OTLP_ENDPOINT_URL"] = "http://localhost"
         });
 
-        var app = builder.Build();
+        using var app = builder.Build();
 
         await app.ExecuteBeforeStartHooksAsync(default);
 
@@ -266,9 +266,13 @@ public async Task DashboardResourceServiceUriIsSet()
     [Fact]
     public async Task DashboardIsNotAddedInPublishMode()
     {
-        using var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Publish);
+        using var builder = TestDistributedApplicationBuilder.Create(options =>
+        {
+            options.DisableDashboard = false;
+            options.Args = ["--publisher", "manifest"];
+        });
 
-        var app = builder.Build();
+        using var app = builder.Build();
 
         await app.ExecuteBeforeStartHooksAsync(default);
 
@@ -280,7 +284,7 @@ public async Task DashboardIsNotAddedInPublishMode()
     [Fact]
     public async Task DashboardIsNotAddedIfDisabled()
     {
-        using var builder = TestDistributedApplicationBuilder.Create(new DistributedApplicationOptions { DisableDashboard = true });
+        using var builder = TestDistributedApplicationBuilder.Create(options => options.DisableDashboard = true);
 
         var app = builder.Build();
 
@@ -295,12 +299,11 @@ public async Task DashboardIsNotAddedIfDisabled()
     public void ContainerIsValidWithDashboardIsDisabled()
     {
         // Set the host environment to "Development" so that the container validates services.
-        using var builder = TestDistributedApplicationBuilder.Create(new DistributedApplicationOptions
+        using var builder = TestDistributedApplicationBuilder.Create(options =>
         {
-            DisableDashboard = true,
-            Args = ["--environment", "Development"]
-        }
-        );
+            options.DisableDashboard = true;
+            options.Args = ["--environment", "Development"];
+        });
 
         // Container validation logic runs when the service provider is built.
         using var app = builder.Build();
@@ -315,7 +318,7 @@ public void ContainerIsValidWithDashboardIsDisabled()
     [InlineData(LogLevel.Trace)]
     public async Task DashboardLifecycleHookWatchesLogs(LogLevel logLevel)
     {
-        using var builder = TestDistributedApplicationBuilder.Create();
+        using var builder = TestDistributedApplicationBuilder.Create(o => o.DisableDashboard = false);
 
         var loggerProvider = new TestLoggerProvider();
 
@@ -337,7 +340,7 @@ public async Task DashboardLifecycleHookWatchesLogs(LogLevel logLevel)
         await app.ExecuteBeforeStartHooksAsync(default);
 
         var model = app.Services.GetRequiredService<DistributedApplicationModel>();
-        var resourceNotifcationService = app.Services.GetRequiredService<ResourceNotificationService>();
+        var resourceNotificationService = app.Services.GetRequiredService<ResourceNotificationService>();
         var resourceLoggerService = app.Services.GetRequiredService<ResourceLoggerService>();
 
         var dashboard = Assert.Single(model.Resources.OfType<ExecutableResource>());
@@ -346,7 +349,7 @@ public async Task DashboardLifecycleHookWatchesLogs(LogLevel logLevel)
         Assert.Equal("aspire-dashboard", dashboard.Name);
 
         // Push a notification through to the dashboard resource.
-        await resourceNotifcationService.PublishUpdateAsync(dashboard, "aspire-dashboard-0", s => s with { State = "Running" });
+        await resourceNotificationService.PublishUpdateAsync(dashboard, "aspire-dashboard-0", s => s with { State = "Running" });
 
         // Push some logs through to the dashboard resource.
         var logger = resourceLoggerService.GetLogger("aspire-dashboard-0");