Mark IDeveloperCertificateService experimental (#12653)

Co-authored-by: David Negstad <[email protected]>

Author: github-actions[bot]

src/Aspire.Hosting.Yarp/YarpResourceExtensions.cs

@@ -43,7 +43,9 @@ public static IResourceBuilder<YarpResource> AddYarp(
         {
             yarpBuilder.WithEnvironment(ctx =>
             {
+#pragma warning disable ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
                 var developerCertificateService = ctx.ExecutionContext.ServiceProvider.GetRequiredService<IDeveloperCertificateService>();
+#pragma warning restore ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
                 if (!developerCertificateService.SupportsContainerTrust)
                 {
                     // On systems without the ASP.NET DevCert updates introduced in .NET 10, YARP will not trust the cert used

src/Aspire.Hosting/ApplicationModel/ResourceExtensions.cs

@@ -404,7 +404,9 @@ internal static NetworkIdentifier GetDefaultResourceNetwork(this IResource resou
         NetworkIdentifier? networkContext = null,
         CancellationToken cancellationToken = default)
     {
+#pragma warning disable ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
         var developerCertificateService = executionContext.ServiceProvider.GetRequiredService<IDeveloperCertificateService>();
+#pragma warning restore ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
         var trustDevCert = developerCertificateService.TrustCertificate;
 
         var certificates = new X509Certificate2Collection();

src/Aspire.Hosting/Dcp/DcpExecutor.cs

@@ -70,7 +70,9 @@ internal sealed partial class DcpExecutor : IDcpExecutor, IConsoleLogsService, I
     private readonly CancellationTokenSource _shutdownCancellation = new();
     private readonly DcpExecutorEvents _executorEvents;
     private readonly Locations _locations;
+#pragma warning disable ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
     private readonly IDeveloperCertificateService _developerCertificateService;
+#pragma warning restore ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
 
     private readonly DcpResourceState _resourceState;
     private readonly ResourceSnapshotBuilder _snapshotBuilder;
@@ -105,7 +107,9 @@ public DcpExecutor(ILogger<DcpExecutor> logger,
                        DcpNameGenerator nameGenerator,
                        DcpExecutorEvents executorEvents,
                        Locations locations,
+#pragma warning disable ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
                        IDeveloperCertificateService developerCertificateService)
+#pragma warning restore ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
     {
         _distributedApplicationLogger = distributedApplicationLogger;
         _kubernetesService = kubernetesService;

src/Aspire.Hosting/DeveloperCertificateService.cs

@@ -9,7 +9,9 @@
 
 namespace Aspire.Hosting;
 
+#pragma warning disable ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
 internal class DeveloperCertificateService : IDeveloperCertificateService
+#pragma warning restore ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
 {
     private readonly Lazy<ImmutableList<X509Certificate2>> _certificates;
     private readonly Lazy<bool> _supportsContainerTrust;

src/Aspire.Hosting/DistributedApplicationBuilder.cs

@@ -325,7 +325,9 @@ public DistributedApplicationBuilder(DistributedApplicationOptions options)
 
             return new AspireStore(Path.Combine(aspireDir, ".aspire"));
         });
+#pragma warning disable ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
         _innerBuilder.Services.AddSingleton<IDeveloperCertificateService, DeveloperCertificateService>();
+#pragma warning restore ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
 
         // Shared DCP things (even though DCP isn't used in 'publish' and 'inspect' mode
         // we still honour the DCP options around container runtime selection.

src/Aspire.Hosting/IDeveloperCertificateService.cs

@@ -2,13 +2,15 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Collections.Immutable;
+using System.Diagnostics.CodeAnalysis;
 using System.Security.Cryptography.X509Certificates;
 
 namespace Aspire.Hosting;
 
 /// <summary>
 /// Service that provides information about developer certificate trust capabilities.
 /// </summary>
+[Experimental("ASPIRECERTIFICATES001", UrlFormat = "https://aka.ms/aspire/diagnostics/{0}")]
 public interface IDeveloperCertificateService
 {
     /// <summary>

tests/Aspire.Hosting.Tests/Dcp/DcpExecutorTests.cs

@@ -2021,6 +2021,7 @@ private static DcpExecutor CreateAppExecutor(
 
         var developerCertificateService = new TestDeveloperCertificateService(new List<X509Certificate2>(), false, false);
 
+#pragma warning disable ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
         return new DcpExecutor(
             NullLogger<DcpExecutor>.Instance,
             NullLogger<DistributedApplication>.Instance,
@@ -2042,6 +2043,7 @@ private static DcpExecutor CreateAppExecutor(
             events ?? new DcpExecutorEvents(),
             new Locations(),
             developerCertificateService);
+#pragma warning restore ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
     }
 
     private sealed class TestExecutableResource(string directory) : ExecutableResource("TestExecutable", "test", directory);

tests/Aspire.Hosting.Tests/DistributedApplicationTests.cs

@@ -652,7 +652,9 @@ public async Task VerifyContainerIncludesExpectedDevCertificateConfiguration(boo
         await app.StartAsync().DefaultTimeout(TestConstants.DefaultOrchestratorTestLongTimeout);
 
         var s = app.Services.GetRequiredService<IKubernetesService>();
+#pragma warning disable ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
         var dc = app.Services.GetRequiredService<IDeveloperCertificateService>();
+#pragma warning restore ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
         var list = await s.ListAsync<Container>().DefaultTimeout(TestConstants.DefaultOrchestratorTestLongTimeout);
 
         Assert.Collection(list,

tests/Aspire.Hosting.Tests/Utils/TestDeveloperCertificateService.cs

@@ -6,7 +6,9 @@
 
 namespace Aspire.Hosting.Tests.Utils;
 
+#pragma warning disable ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
 public sealed class TestDeveloperCertificateService(List<X509Certificate2> certificates, bool supportsContainerTrust, bool trustCertificate) : IDeveloperCertificateService
+#pragma warning restore ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
 {
     /// <inheritdoc />
     public ImmutableList<X509Certificate2> Certificates { get; } = certificates.ToImmutableList();

tests/Aspire.Hosting.Yarp.Tests/AddYarpTests.cs

@@ -28,6 +28,7 @@ public void VerifyYarpResourceWithTargetPort()
     [InlineData(false)]
     public async Task VerifyRunEnvVariablesAreSet(bool containerCertificateSupport)
     {
+        #pragma warning disable ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
         var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Run);
 
         // Report that developer certificates won't support container scenarios
@@ -54,6 +55,7 @@ public async Task VerifyRunEnvVariablesAreSet(bool containerCertificateSupport)
             var value = Assert.Contains("YARP_UNSAFE_OLTP_CERT_ACCEPT_ANY_SERVER_CERTIFICATE", env);
             Assert.Equal("true", value);
         }
+        #pragma warning restore ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
     }
 
     [Fact]
@@ -75,6 +77,7 @@ public async Task VerifyPublishEnvVariablesAreSet()
     [Fact]
     public async Task VerifyWithStaticFilesAddsEnvironmentVariable()
     {
+        #pragma warning disable ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
         var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Run);
 
         // Yarp requires an IDeveloperCertificateService in run mode when building it's environment variables.
@@ -90,11 +93,13 @@ public async Task VerifyWithStaticFilesAddsEnvironmentVariable()
 
         var value = Assert.Contains("YARP_ENABLE_STATIC_FILES", env);
         Assert.Equal("true", value);
+        #pragma warning restore ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
     }
 
     [Fact]
     public async Task VerifyWithStaticFilesWorksInPublishOperation()
     {
+        #pragma warning disable ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
         var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Publish);
 
         // Yarp requires an IDeveloperCertificateService in run mode when building it's environment variables.
@@ -110,11 +115,13 @@ public async Task VerifyWithStaticFilesWorksInPublishOperation()
 
         var value = Assert.Contains("YARP_ENABLE_STATIC_FILES", env);
         Assert.Equal("true", value);
+        #pragma warning restore ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
     }
 
     [Fact]
     public async Task VerifyWithStaticFilesBindMountAddsEnvironmentVariable()
     {
+        #pragma warning disable ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
         var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Run);
 
         // Yarp requires an IDeveloperCertificateService in run mode when building it's environment variables.
@@ -132,6 +139,7 @@ public async Task VerifyWithStaticFilesBindMountAddsEnvironmentVariable()
 
         var value = Assert.Contains("YARP_ENABLE_STATIC_FILES", env);
         Assert.Equal("true", value);
+        #pragma warning restore ASPIRECERTIFICATES001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
     }
 
     [Fact]