Add DbGate support for MySql

examples/dbgate/CommunityToolkit.Aspire.Hosting.DbGate.AppHost/CommunityToolkit.Aspire.Hosting.DbGate.AppHost.csproj

@@ -18,6 +18,7 @@
     <ProjectReference Include="..\..\..\src\CommunityToolkit.Aspire.Hosting.PostgreSQL.Extensions\CommunityToolkit.Aspire.Hosting.PostgreSQL.Extensions.csproj" IsAspireProjectResource="false" />
     <ProjectReference Include="..\..\..\src\CommunityToolkit.Aspire.Hosting.Redis.Extensions\CommunityToolkit.Aspire.Hosting.Redis.Extensions.csproj" IsAspireProjectResource="false" />
     <ProjectReference Include="..\..\..\src\CommunityToolkit.Aspire.Hosting.SqlServer.Extensions\CommunityToolkit.Aspire.Hosting.SqlServer.Extensions.csproj" IsAspireProjectResource="false" />
+    <ProjectReference Include="..\..\..\src\CommunityToolkit.Aspire.Hosting.MySql.Extensions\CommunityToolkit.Aspire.Hosting.MySql.Extensions.csproj" IsAspireProjectResource="false" />
   </ItemGroup>
 
 

examples/dbgate/CommunityToolkit.Aspire.Hosting.DbGate.AppHost/Program.cs

@@ -32,4 +32,14 @@
 sqlserver2.AddDatabase("db12");
 
 
+var mysql1 = builder.AddMySql("mysql1")
+    .WithDbGate(c => c.WithHostPort(8068));
+mysql1.AddDatabase("db13");
+mysql1.AddDatabase("db14");
+
+var mysql2 = builder.AddMySql("mysql2")
+    .WithDbGate();
+mysql2.AddDatabase("db15");
+mysql2.AddDatabase("db16");
+
 builder.Build().Run();

examples/mysql-ext/CommunityToolkit.Aspire.Hosting.MySql.Extensions.AppHost/Program.cs

@@ -1,7 +1,8 @@
 var builder = DistributedApplication.CreateBuilder(args);
 
 var mysql1 = builder.AddMySql("mysql1")
-    .WithAdminer(c => c.WithHostPort(8989));
+    .WithAdminer(c => c.WithHostPort(8989))
+    .WithDbGate(c => c.WithHostPort(9999));
 mysql1.AddDatabase("db1");
 mysql1.AddDatabase("db2");
 

src/CommunityToolkit.Aspire.Hosting.DbGate/DbGateContainerImageTags.cs

@@ -1,11 +1,11 @@
 
 internal static class DbGateContainerImageTags
 {
-    /// <summary>docker.io</summary>
+    /// <remarks>docker.io</remarks>
     public const string Registry = "docker.io";
-    /// <summary>dbgate/dbgate</summary>
+    /// <remarks>dbgate/dbgate</remarks>
     public const string Image = "dbgate/dbgate";
-    /// <summary>6.1.4</summary>
+    /// <remarks>6.1.4</remarks>
     public const string Tag = "6.1.4";
 }
 

src/CommunityToolkit.Aspire.Hosting.MySql.Extensions/CommunityToolkit.Aspire.Hosting.MySql.Extensions.csproj

@@ -12,6 +12,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\CommunityToolkit.Aspire.Hosting.Adminer\CommunityToolkit.Aspire.Hosting.Adminer.csproj" />
+    <ProjectReference Include="..\CommunityToolkit.Aspire.Hosting.DbGate\CommunityToolkit.Aspire.Hosting.DbGate.csproj" />
   </ItemGroup>
 
   <ItemGroup>

src/CommunityToolkit.Aspire.Hosting.MySql.Extensions/MySqlBuilderExtensions.cs

@@ -50,6 +50,91 @@ public static IResourceBuilder<MySqlServerResource> WithAdminer(this IResourceBu
         return builder;
     }
 
+    /// <summary>
+    /// Adds an administration and development platform for MySql to the application model using DbGate.
+    /// </summary>
+    /// <remarks>
+    /// This version of the package defaults to the <inheritdoc cref="DbGateContainerImageTags.Tag"/> tag of the <inheritdoc cref="DbGateContainerImageTags.Image"/> container image.
+    /// <param name="builder">The MySql server resource builder.</param>
+    /// <param name="configureContainer">Configuration callback for DbGate container resource.</param>
+    /// <param name="containerName">The name of the container (Optional).</param>
+    /// <example>
+    /// Use in application host with a MySql resource
+    /// <code lang="csharp">
+    /// var builder = DistributedApplication.CreateBuilder(args);
+    ///
+    /// var mysql = builder.AddMySql("mysql")
+    ///    .WithDbGate();
+    /// var db = mysql.AddDatabase("db");
+    ///
+    /// var api = builder.AddProject&lt;Projects.Api&gt;("api")
+    ///   .WithReference(db);
+    ///
+    /// builder.Build().Run();
+    /// </code>
+    /// </example>
+    /// </remarks>
+    /// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns>
+    public static IResourceBuilder<MySqlServerResource> WithDbGate(this IResourceBuilder<MySqlServerResource> builder, Action<IResourceBuilder<DbGateContainerResource>>? configureContainer = null, string? containerName = null)
+    {
+        ArgumentNullException.ThrowIfNull(builder);
+
+        containerName ??= $"{builder.Resource.Name}-dbgate";
+
+        var dbGateBuilder = DbGateBuilderExtensions.AddDbGate(builder.ApplicationBuilder, containerName);
+
+        dbGateBuilder
+            .WithEnvironment(context => ConfigureDbGateContainer(context, builder.ApplicationBuilder));
+
+        configureContainer?.Invoke(dbGateBuilder);
+
+        return builder;
+    }
+
+    private static void ConfigureDbGateContainer(EnvironmentCallbackContext context, IDistributedApplicationBuilder applicationBuilder)
+    {
+        var mysqlInstances = applicationBuilder.Resources.OfType<MySqlServerResource>();
+
+        var counter = 1;
+
+        // Multiple WithDbGate calls will be ignored
+        if (context.EnvironmentVariables.ContainsKey($"LABEL_mysql{counter}"))
+        {
+            return;
+        }
+
+        foreach (var mySqlServerResource in mysqlInstances)
+        {
+            // DbGate assumes MySql is being accessed over a default Aspire container network and hardcodes the resource address
+            context.EnvironmentVariables.Add($"LABEL_mysql{counter}", mySqlServerResource.Name);
+            context.EnvironmentVariables.Add($"SERVER_mysql{counter}", mySqlServerResource.Name);
+            context.EnvironmentVariables.Add($"USER_mysql{counter}", "root");
+            context.EnvironmentVariables.Add($"PASSWORD_mysql{counter}", mySqlServerResource.PasswordParameter.Value);
+            context.EnvironmentVariables.Add($"PORT_mysql{counter}", mySqlServerResource.PrimaryEndpoint.TargetPort!.ToString()!);
+            context.EnvironmentVariables.Add($"ENGINE_mysql{counter}", "mysql@dbgate-plugin-mysql");
+
+            counter++;
+        }
+
+        var instancesCount = mysqlInstances.Count();
+        if (instancesCount > 0)
+        {
+            var strBuilder = new StringBuilder();
+            strBuilder.AppendJoin(',', Enumerable.Range(1, instancesCount).Select(i => $"mysql{i}"));
+            var connections = strBuilder.ToString();
+
+            string CONNECTIONS = context.EnvironmentVariables.GetValueOrDefault("CONNECTIONS")?.ToString() ?? string.Empty;
+            if (string.IsNullOrEmpty(CONNECTIONS))
+            {
+                context.EnvironmentVariables["CONNECTIONS"] = connections;
+            }
+            else
+            {
+                context.EnvironmentVariables["CONNECTIONS"] += $",{connections}";
+            }
+        }
+    }
+
     internal static void ConfigureAdminerContainer(EnvironmentCallbackContext context, IDistributedApplicationBuilder applicationBuilder)
     {
         var mysqlInstances = applicationBuilder.Resources.OfType<MySqlServerResource>();

src/CommunityToolkit.Aspire.Hosting.MySql.Extensions/README.md

@@ -2,7 +2,7 @@
 
 This integration contains extensions for the [MySql hosting package](https://nuget.org/packages/Aspire.Hosting.MySql) for .NET Aspire.
 
-The integration provides support for running [Adminer](https://github.com/vrana/adminer) to interact with the MySql database.
+The integration provides support for running [Adminer](https://github.com/vrana/adminer) and [DbGate](https://github.com/dbgate/dbgate) to interact with the MySql database.
 
 ## Getting Started
 
@@ -20,6 +20,7 @@ Then, in the _Program.cs_ file of `AppHost`, define an MySql resource, then call
 
 ```csharp
 var mysql = builder.AddMySql("mysql")
+    .WithDbGate()
     .WithAdminer();
 ```
 

tests/CommunityToolkit.Aspire.Hosting.DbGate.Tests/AddDbGateTests.cs

@@ -221,6 +221,16 @@ public async Task WithDbGateShouldAddAnnotationsForMultipleDatabaseTypes()
 
         var sqlserverResource2 = sqlserverResourceBuilder2.Resource;
 
+        var mysqlResourceBuilder1 = builder.AddMySql("mysql1")
+            .WithDbGate();
+
+        var mysqlResource1 = mysqlResourceBuilder1.Resource;
+
+        var mysqlResourceBuilder2 =builder.AddMySql("mysql2")
+            .WithDbGate();
+
+        var mysqlResource2 = mysqlResourceBuilder2.Resource;
+
         using var app = builder.Build();
 
         var appModel = app.Services.GetRequiredService<DistributedApplicationModel>();
@@ -268,7 +278,7 @@ public async Task WithDbGateShouldAddAnnotationsForMultipleDatabaseTypes()
             item =>
             {
                 Assert.Equal("CONNECTIONS", item.Key);
-                Assert.Equal("mongodb1,mongodb2,postgres1,postgres2,redis1,redis2,sqlserver1,sqlserver2", item.Value);
+                Assert.Equal("mongodb1,mongodb2,postgres1,postgres2,redis1,redis2,sqlserver1,sqlserver2,mysql1,mysql2", item.Value);
             },
             item =>
             {
@@ -423,6 +433,66 @@ public async Task WithDbGateShouldAddAnnotationsForMultipleDatabaseTypes()
             {
                 Assert.Equal("ENGINE_sqlserver2", item.Key);
                 Assert.Equal("mssql@dbgate-plugin-mssql", item.Value);
+            },
+            item =>
+            {
+                Assert.Equal("LABEL_mysql1", item.Key);
+                Assert.Equal(mysqlResource1.Name, item.Value);
+            },
+            item =>
+            {
+                Assert.Equal("SERVER_mysql1", item.Key);
+                Assert.Equal(mysqlResource1.Name, item.Value);
+            },
+            item =>
+            {
+                Assert.Equal("USER_mysql1", item.Key);
+                Assert.Equal("root", item.Value);
+            },
+            item =>
+            {
+                Assert.Equal("PASSWORD_mysql1", item.Key);
+                Assert.Equal(mysqlResource1.PasswordParameter.Value, item.Value);
+            },
+            item =>
+            {
+                Assert.Equal("PORT_mysql1", item.Key);
+                Assert.Equal(mysqlResource1.PrimaryEndpoint.TargetPort.ToString(), item.Value);
+            },
+            item =>
+            {
+                Assert.Equal("ENGINE_mysql1", item.Key);
+                Assert.Equal("mysql@dbgate-plugin-mysql", item.Value);
+            },
+            item =>
+            {
+                Assert.Equal("LABEL_mysql2", item.Key);
+                Assert.Equal(mysqlResource2.Name, item.Value);
+            },
+            item =>
+            {
+                Assert.Equal("SERVER_mysql2", item.Key);
+                Assert.Equal(mysqlResource2.Name, item.Value);
+            },
+            item =>
+            {
+                Assert.Equal("USER_mysql2", item.Key);
+                Assert.Equal("root", item.Value);
+            },
+            item =>
+            {
+                Assert.Equal("PASSWORD_mysql2", item.Key);
+                Assert.Equal(mysqlResource2.PasswordParameter.Value, item.Value);
+            },
+            item =>
+            {
+                Assert.Equal("PORT_mysql2", item.Key);
+                Assert.Equal(mysqlResource2.PrimaryEndpoint.TargetPort.ToString(), item.Value);
+            },
+            item =>
+            {
+                Assert.Equal("ENGINE_mysql2", item.Key);
+                Assert.Equal("mysql@dbgate-plugin-mysql", item.Value);
             });
     }
 
@@ -455,6 +525,12 @@ public void WithDbGateShouldShouldAddOneDbGateResourceForMultipleDatabaseTypes()
         builder.AddSqlServer("sqlserver2")
             .WithDbGate();
 
+        builder.AddMySql("mysql1")
+            .WithDbGate();
+
+        builder.AddMySql("mysql2")
+            .WithDbGate();
+
         using var app = builder.Build();
 
         var appModel = app.Services.GetRequiredService<DistributedApplicationModel>();