[release/13.5] Hide Azure environment when all resources use emulators

src/Aspire.Hosting.Azure/AzureResourcePreparer.cs

@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 #pragma warning disable ASPIREAZURE003
+#pragma warning disable ASPIREAZURE001
 #pragma warning disable ASPIREPIPELINES002
 
 using Aspire.Dashboard.Model;
@@ -32,6 +33,15 @@ internal async Task PrepareResourcesAsync(DistributedApplicationModel model, Can
         var azureResources = GetAzureResourcesFromAppModel(model);
         if (azureResources.Count == 0)
         {
+            // AddAzureProvisioning creates the environment before resources are configured, so wait until
+            // preparation to hide it when the final run-mode model contains only local emulators.
+            if (executionContext.IsRunMode &&
+                model.Resources.OfType<AzureEnvironmentResource>().SingleOrDefault() is { } environmentResource &&
+                !environmentResource.HasAnnotationOfType<HiddenAnnotation>())
+            {
+                environmentResource.Annotations.Add(new HiddenAnnotation(HiddenBehavior.Always));
+            }
+
             return;
         }
 

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

@@ -2,9 +2,11 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 #pragma warning disable ASPIRECOSMOSDB001
+#pragma warning disable ASPIREAZURE001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
 
 using Aspire.Hosting.ApplicationModel;
 using Aspire.Hosting.Utils;
+using Microsoft.Extensions.DependencyInjection;
 
 namespace Aspire.Hosting.Azure.Tests;
 
@@ -50,4 +52,40 @@ public void RunAsEmulator_InPublishMode_DoesNotConfigureLocalContainer(string re
         Assert.False(resource.IsContainer(), $"{resourceType} should not be configured as a local container in publish mode.");
         Assert.DoesNotContain(builder.Resources, resource => resource.Annotations.OfType<ContainerImageAnnotation>().Any());
     }
+
+    [Fact]
+    public async Task RunAsEmulator_WhenAllAzureResourcesUseEmulators_HidesAzureEnvironment()
+    {
+        using var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Run);
+        builder.AddAzureCosmosDB("cosmos").RunAsEmulator();
+        builder.AddAzureStorage("storage").RunAsEmulator();
+        builder.AddAzureEventHubs("eventhubs").RunAsEmulator();
+
+        using var app = builder.Build();
+        var model = app.Services.GetRequiredService<DistributedApplicationModel>();
+        var preparer = app.Services.GetRequiredService<AzureResourcePreparer>();
+
+        await preparer.OnBeforeStartAsync(new BeforeStartEvent(app.Services, model), CancellationToken.None);
+
+        var environment = Assert.Single(model.Resources.OfType<AzureEnvironmentResource>());
+        var hidden = Assert.Single(environment.Annotations.OfType<HiddenAnnotation>());
+        Assert.Equal(HiddenBehavior.Always, hidden.Behavior);
+    }
+
+    [Fact]
+    public async Task RunAsEmulator_WhenAzureResourceRequiresProvisioning_ShowsAzureEnvironment()
+    {
+        using var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Run);
+        builder.AddAzureStorage("emulated-storage").RunAsEmulator();
+        builder.AddAzureStorage("provisioned-storage");
+
+        using var app = builder.Build();
+        var model = app.Services.GetRequiredService<DistributedApplicationModel>();
+        var preparer = app.Services.GetRequiredService<AzureResourcePreparer>();
+
+        await preparer.OnBeforeStartAsync(new BeforeStartEvent(app.Services, model), CancellationToken.None);
+
+        var environment = Assert.Single(model.Resources.OfType<AzureEnvironmentResource>());
+        Assert.Empty(environment.Annotations.OfType<HiddenAnnotation>());
+    }
 }