Consolidate MongoDB resources. (dotnet#2128)

Author: mitchdenny

playground/mongo/Mongo.AppHost/Program.cs

@@ -3,8 +3,9 @@
 
 var builder = DistributedApplication.CreateBuilder(args);
 
-var db = builder.AddMongoDBContainer("mongo")
-    .WithMongoExpress();
+var db = builder.AddMongoDB("mongo")
+    .WithMongoExpress()
+    .PublishAsContainer();
 
 builder.AddProject<Projects.Mongo_ApiService>("api")
        .WithReference(db);

src/Aspire.Hosting/MongoDB/IMongoDBParentResource.cs

@@ -15,43 +15,21 @@ public static class MongoDBBuilderExtensions
 {
     private const int DefaultContainerPort = 27017;
 
-    /// <summary>
-    /// Adds a MongoDB container to the application model. The default image is "mongo" and the tag is "latest".
-    /// </summary>
-    /// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
-    /// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
-    /// <param name="port">The host port for MongoDB.</param>
-    /// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns>
-    public static IResourceBuilder<MongoDBContainerResource> AddMongoDBContainer(
-        this IDistributedApplicationBuilder builder,
-        string name,
-        int? port = null)
-    {
-        var mongoDBContainer = new MongoDBContainerResource(name);
-
-        return builder
-            .AddResource(mongoDBContainer)
-            .WithManifestPublishingCallback(context => WriteMongoDBContainerToManifest(context, mongoDBContainer))
-            .WithAnnotation(new EndpointAnnotation(ProtocolType.Tcp, port: port, containerPort: DefaultContainerPort)) // Internal port is always 27017.
-            .WithAnnotation(new ContainerImageAnnotation { Image = "mongo", Tag = "latest" });
-    }
-
     /// <summary>
     /// Adds a MongoDB resource to the application model. A container is used for local development.
     /// </summary>
     /// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
     /// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
+    /// <param name="port">The host port for MongoDB.</param>
     /// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns>
-    public static IResourceBuilder<MongoDBServerResource> AddMongoDB(
-        this IDistributedApplicationBuilder builder,
-        string name)
+    public static IResourceBuilder<MongoDBServerResource> AddMongoDB(this IDistributedApplicationBuilder builder, string name, int? port = null)
     {
         var mongoDBContainer = new MongoDBServerResource(name);
 
         return builder
             .AddResource(mongoDBContainer)
             .WithManifestPublishingCallback(WriteMongoDBServerToManifest)
-            .WithAnnotation(new EndpointAnnotation(ProtocolType.Tcp, containerPort: DefaultContainerPort)) // Internal port is always 27017.
+            .WithAnnotation(new EndpointAnnotation(ProtocolType.Tcp, port: port, containerPort: DefaultContainerPort)) // Internal port is always 27017.
             .WithAnnotation(new ContainerImageAnnotation { Image = "mongo", Tag = "latest" });
     }
 
@@ -61,7 +39,7 @@ public static IResourceBuilder<MongoDBServerResource> AddMongoDB(
     /// <param name="builder">The MongoDB server resource builder.</param>
     /// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
     /// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns>
-    public static IResourceBuilder<MongoDBDatabaseResource> AddDatabase(this IResourceBuilder<IMongoDBParentResource> builder, string name)
+    public static IResourceBuilder<MongoDBDatabaseResource> AddDatabase(this IResourceBuilder<MongoDBServerResource> builder, string name)
     {
         var mongoDBDatabase = new MongoDBDatabaseResource(name, builder.Resource);
 
@@ -77,7 +55,7 @@ public static IResourceBuilder<MongoDBDatabaseResource> AddDatabase(this IResour
     /// <param name="hostPort">The host port for the application ui.</param>
     /// <param name="containerName">The name of the container (Optional).</param>
     /// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns>
-    public static IResourceBuilder<T> WithMongoExpress<T>(this IResourceBuilder<T> builder, int? hostPort = null, string? containerName = null) where T : IMongoDBParentResource
+    public static IResourceBuilder<T> WithMongoExpress<T>(this IResourceBuilder<T> builder, int? hostPort = null, string? containerName = null) where T : MongoDBServerResource
     {
         containerName ??= $"{builder.Resource.Name}-mongoexpress";
 
@@ -96,6 +74,7 @@ private static void ConfigureMongoExpressContainer(EnvironmentCallbackContext co
         var hostPort = GetResourcePort(resource);
 
         context.EnvironmentVariables.Add("ME_CONFIG_MONGODB_URL", $"mongodb://host.docker.internal:{hostPort}/?directConnection=true");
+        context.EnvironmentVariables.Add("ME_CONFIG_BASICAUTH", "false");
 
         static int GetResourcePort(IResource resource)
         {
@@ -109,7 +88,12 @@ static int GetResourcePort(IResource resource)
         }
     }
 
-    private static void WriteMongoDBContainerToManifest(this ManifestPublishingContext context, MongoDBContainerResource resource)
+    public static IResourceBuilder<MongoDBServerResource> PublishAsContainer(this IResourceBuilder<MongoDBServerResource> builder)
+    {
+        return builder.WithManifestPublishingCallback(context => WriteMongoDBContainerToManifest(context, builder.Resource));
+    }
+
+    private static void WriteMongoDBContainerToManifest(this ManifestPublishingContext context, MongoDBServerResource resource)
     {
         context.WriteContainer(resource);
         context.Writer.WriteString(                     // "connectionString": "...",

src/Aspire.Hosting/MongoDB/MongoDBBuilderExtensions.cs

@@ -4,14 +4,13 @@
 namespace Aspire.Hosting.ApplicationModel;
 
 /// <summary>
-/// A resource that represents a MongoDB database. This is a child resource of a <see cref="MongoDBContainerResource"/>.
+/// A resource that represents a MongoDB database. This is a child resource of a <see cref="MongoDBServerResource"/>.
 /// </summary>
 /// <param name="name">The name of the resource.</param>
-/// <param name="mongoDBContainer">The MongoDB server resource associated with this database.</param>
-public class MongoDBDatabaseResource(string name, IMongoDBParentResource mongoDBContainer)
-    : Resource(name), IResourceWithParent<IMongoDBParentResource>, IResourceWithConnectionString
+/// <param name="parent">The MongoDB server resource associated with this database.</param>
+public class MongoDBDatabaseResource(string name, MongoDBServerResource parent) : Resource(name), IResourceWithParent<MongoDBServerResource>, IResourceWithConnectionString
 {
-    public IMongoDBParentResource Parent => mongoDBContainer;
+    public MongoDBServerResource Parent => parent;
 
     /// <summary>
     /// Gets the connection string for the MongoDB database.

src/Aspire.Hosting/MongoDB/MongoDBContainerResource.cs

@@ -9,7 +9,7 @@ namespace Aspire.Hosting.ApplicationModel;
 /// A resource that represents a MongoDB container.
 /// </summary>
 /// <param name="name">The name of the resource.</param>
-public class MongoDBServerResource(string name) : Resource(name), IMongoDBParentResource
+public class MongoDBServerResource(string name) : ContainerResource(name), IResourceWithConnectionString
 {
     /// <summary>
     /// Gets the connection string for the MongoDB server.

src/Aspire.Hosting/MongoDB/MongoDBDatabaseResource.cs

@@ -15,13 +15,13 @@ public void AddMongoDBContainerWithDefaultsAddsAnnotationMetadata()
     {
         var appBuilder = DistributedApplication.CreateBuilder();
 
-        appBuilder.AddMongoDBContainer("mongodb");
+        appBuilder.AddMongoDB("mongodb");
 
         var app = appBuilder.Build();
 
         var appModel = app.Services.GetRequiredService<DistributedApplicationModel>();
 
-        var containerResource = Assert.Single(appModel.Resources.OfType<MongoDBContainerResource>());
+        var containerResource = Assert.Single(appModel.Resources.OfType<MongoDBServerResource>());
         Assert.Equal("mongodb", containerResource.Name);
 
         var manifestAnnotation = Assert.Single(containerResource.Annotations.OfType<ManifestPublishingCallbackAnnotation>());
@@ -46,13 +46,13 @@ public void AddMongoDBContainerWithDefaultsAddsAnnotationMetadata()
     public void AddMongoDBContainerAddsAnnotationMetadata()
     {
         var appBuilder = DistributedApplication.CreateBuilder();
-        appBuilder.AddMongoDBContainer("mongodb", 9813);
+        appBuilder.AddMongoDB("mongodb", 9813);
 
         var app = appBuilder.Build();
 
         var appModel = app.Services.GetRequiredService<DistributedApplicationModel>();
 
-        var containerResource = Assert.Single(appModel.Resources.OfType<MongoDBContainerResource>());
+        var containerResource = Assert.Single(appModel.Resources.OfType<MongoDBServerResource>());
         Assert.Equal("mongodb", containerResource.Name);
 
         var manifestAnnotation = Assert.Single(containerResource.Annotations.OfType<ManifestPublishingCallbackAnnotation>());
@@ -78,7 +78,7 @@ public void MongoDBCreatesConnectionString()
     {
         var appBuilder = DistributedApplication.CreateBuilder();
         appBuilder
-            .AddMongoDBContainer("mongodb")
+            .AddMongoDB("mongodb")
             .WithAnnotation(
                 new AllocatedEndpointAnnotation("mybinding",
                 ProtocolType.Tcp,

src/Aspire.Hosting/MongoDB/MongoDBServerResource.cs

@@ -7,7 +7,7 @@
 
 namespace Aspire.Hosting.Tests.MongoDB;
 
-public class MongoDBContainerResourceTests
+public class MongoDBConnectionStringBuilderTests
 {
     [Theory]
     [InlineData("password", "mongodb://root:password@myserver:1000/")]