Add Aspire.MySqlConnector

Aspire.sln

@@ -152,6 +152,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Aspire.RabbitMQ.Client", "s
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Aspire.RabbitMQ.Client.Tests", "tests\Aspire.RabbitMQ.Client.Tests\Aspire.RabbitMQ.Client.Tests.csproj", "{165411FE-755E-4869-A756-F87F455860AC}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Aspire.MySqlConnector", "src\Components\Aspire.MySqlConnector\Aspire.MySqlConnector.csproj", "{CA283D7F-EB95-4353-B196-C409965D2B42}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Aspire.MySqlConnector.Tests", "tests\Aspire.MySqlConnector.Tests\Aspire.MySqlConnector.Tests.csproj", "{C8079F06-304F-49B1-A0C1-45AA3782A923}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -406,6 +410,14 @@ Global
 		{165411FE-755E-4869-A756-F87F455860AC}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{165411FE-755E-4869-A756-F87F455860AC}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{165411FE-755E-4869-A756-F87F455860AC}.Release|Any CPU.Build.0 = Release|Any CPU
+		{CA283D7F-EB95-4353-B196-C409965D2B42}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{CA283D7F-EB95-4353-B196-C409965D2B42}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{CA283D7F-EB95-4353-B196-C409965D2B42}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{CA283D7F-EB95-4353-B196-C409965D2B42}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C8079F06-304F-49B1-A0C1-45AA3782A923}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C8079F06-304F-49B1-A0C1-45AA3782A923}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C8079F06-304F-49B1-A0C1-45AA3782A923}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C8079F06-304F-49B1-A0C1-45AA3782A923}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -477,6 +489,8 @@ Global
 		{A84C4EE3-2601-4804-BCDC-E9948E164A22} = {A68BA1A5-1604-433D-9778-DC0199831C2A}
 		{4D8A92AB-4E77-4965-AD8E-8E206DCE66A4} = {27381127-6C45-4B4C-8F18-41FF48DFE4B2}
 		{165411FE-755E-4869-A756-F87F455860AC} = {4981B3A5-4AFD-4191-BF7D-8692D9783D60}
+		{CA283D7F-EB95-4353-B196-C409965D2B42} = {27381127-6C45-4B4C-8F18-41FF48DFE4B2}
+		{C8079F06-304F-49B1-A0C1-45AA3782A923} = {4981B3A5-4AFD-4191-BF7D-8692D9783D60}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {6DCEDFEC-988E-4CB3-B45B-191EB5086E0C}

Directory.Packages.props

@@ -38,6 +38,7 @@
     <PackageVersion Include="AspNetCore.HealthChecks.Azure.Storage.Blobs" Version="7.0.0" />
     <PackageVersion Include="AspNetCore.HealthChecks.Azure.Storage.Queues" Version="7.0.0" />
     <PackageVersion Include="AspNetCore.HealthChecks.AzureServiceBus" Version="7.0.0" />
+    <PackageVersion Include="AspNetCore.HealthChecks.MySql" Version="7.0.0" />
     <PackageVersion Include="AspNetCore.HealthChecks.NpgSql" Version="7.0.0" />
     <PackageVersion Include="AspNetCore.HealthChecks.Rabbitmq" Version="7.0.0" />
     <PackageVersion Include="AspNetCore.HealthChecks.Redis" Version="7.0.1" />
@@ -73,6 +74,7 @@
     <PackageVersion Include="JsonSchema.Net" Version="5.2.5" />
     <PackageVersion Include="Microsoft.FluentUI.AspNetCore.Components" Version="4.0.0" />
     <PackageVersion Include="Microsoft.FluentUI.AspNetCore.Components.Icons" Version="4.0.0" />
+    <PackageVersion Include="MySqlConnector.DependencyInjection" Version="2.3.0" />
     <PackageVersion Include="Npgsql.DependencyInjection" Version="8.0.0-rc.2" />
     <PackageVersion Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="8.0.0-rc.2" />
     <PackageVersion Include="Polly" Version="8.0.0" />

src/Aspire.Hosting/MySql/IMySqlResource.cs

@@ -0,0 +1,11 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Aspire.Hosting.ApplicationModel;
+
+/// <summary>
+/// Represents a MySQL resource that requires a connection string.
+/// </summary>
+public interface IMySqlResource : IResourceWithConnectionString
+{
+}

src/Aspire.Hosting/MySql/MySqlBuilderExtensions.cs

@@ -0,0 +1,81 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Net.Sockets;
+using System.Text.Json;
+using Aspire.Hosting.ApplicationModel;
+
+namespace Aspire.Hosting;
+
+/// <summary>
+/// Provides extension methods for adding MySQL resources to an <see cref="IDistributedApplicationBuilder"/>.
+/// </summary>
+public static class MySqlBuilderExtensions
+{
+    private const string PasswordEnvVarName = "MYSQL_ROOT_PASSWORD";
+
+    /// <summary>
+    /// Adds a MySQL container to the application model. The default image is "mysql" 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 MySQL.</param>
+    /// <param name="password">The password for the MySQL root user. Defaults to a random password.</param>
+    /// <returns>A reference to the <see cref="IResourceBuilder{MySqlContainerResource}"/>.</returns>
+    public static IResourceBuilder<MySqlContainerResource> AddMySqlContainer(this IDistributedApplicationBuilder builder, string name, int? port = null, string? password = null)
+    {
+        password ??= Guid.NewGuid().ToString("N");
+        var mySqlContainer = new MySqlContainerResource(name, password);
+        return builder.AddResource(mySqlContainer)
+                      .WithAnnotation(new ManifestPublishingCallbackAnnotation(WriteMySqlContainerToManifest))
+                      .WithAnnotation(new ServiceBindingAnnotation(ProtocolType.Tcp, port: port, containerPort: 3306)) // Internal port is always 3306.
+                      .WithAnnotation(new ContainerImageAnnotation { Image = "mysql", Tag = "latest" })
+                      .WithEnvironment(PasswordEnvVarName, () => mySqlContainer.Password);
+    }
+
+    /// <summary>
+    /// Adds a MySQL connection to the application model. Connection strings can also be read from the connection string section of the configuration using the name of the resource.
+    /// </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="connectionString">The MySQL connection string (optional).</param>
+    /// <returns>A reference to the <see cref="IResourceBuilder{MySqlConnectionResource}"/>.</returns>
+    public static IResourceBuilder<MySqlConnectionResource> AddMySqlConnection(this IDistributedApplicationBuilder builder, string name, string? connectionString = null)
+    {
+        var mySqlConnection = new MySqlConnectionResource(name, connectionString);
+
+        return builder.AddResource(mySqlConnection)
+            .WithAnnotation(new ManifestPublishingCallbackAnnotation((json) => WriteMySqlConnectionToManifest(json, mySqlConnection)));
+    }
+
+    /// <summary>
+    /// Adds a MySQL database to the application model.
+    /// </summary>
+    /// <param name="builder">The MySQL 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{MySqlDatabaseResource}"/>.</returns>
+    public static IResourceBuilder<MySqlDatabaseResource> AddDatabase(this IResourceBuilder<MySqlContainerResource> builder, string name)
+    {
+        var mySqlDatabase = new MySqlDatabaseResource(name, builder.Resource);
+        return builder.ApplicationBuilder.AddResource(mySqlDatabase)
+                                         .WithAnnotation(new ManifestPublishingCallbackAnnotation(
+                                             (json) => WriteMySqlDatabaseToManifest(json, mySqlDatabase)));
+    }
+
+    private static void WriteMySqlConnectionToManifest(Utf8JsonWriter jsonWriter, MySqlConnectionResource mySqlConnection)
+    {
+        jsonWriter.WriteString("type", "mysql.connection.v0");
+        jsonWriter.WriteString("connectionString", mySqlConnection.GetConnectionString());
+    }
+
+    private static void WriteMySqlContainerToManifest(Utf8JsonWriter jsonWriter)
+    {
+        jsonWriter.WriteString("type", "mysql.server.v0");
+    }
+
+    private static void WriteMySqlDatabaseToManifest(Utf8JsonWriter json, MySqlDatabaseResource mySqlDatabase)
+    {
+        json.WriteString("type", "mysql.database.v0");
+        json.WriteString("parent", mySqlDatabase.Parent.Name);
+    }
+}

src/Aspire.Hosting/MySql/MySqlConnectionResource.cs

@@ -0,0 +1,20 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Aspire.Hosting.ApplicationModel;
+
+/// <summary>
+/// A resource that represents a MySQL connection.
+/// </summary>
+/// <param name="name">The name of the resource.</param>
+/// <param name="connectionString">The MySQL connection string.</param>
+public class MySqlConnectionResource(string name, string? connectionString) : Resource(name), IMySqlResource
+{
+    private readonly string? _connectionString = connectionString;
+
+    /// <summary>
+    /// Gets the connection string for the MySQL server.
+    /// </summary>
+    /// <returns>The specified connection string.</returns>
+    public string? GetConnectionString() => _connectionString;
+}

src/Aspire.Hosting/MySql/MySqlContainerResource.cs

@@ -0,0 +1,31 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Aspire.Hosting.ApplicationModel;
+
+/// <summary>
+/// A resource that represents a MySQL container.
+/// </summary>
+/// <param name="name">The name of the resource.</param>
+/// <param name="password">The MySQL server root password.</param>
+public class MySqlContainerResource(string name, string password) : ContainerResource(name), IMySqlResource
+{
+    public string Password { get; } = password;
+
+    /// <summary>
+    /// Gets the connection string for the MySQL server.
+    /// </summary>
+    /// <returns>A connection string for the MySQL server in the form "Host=host;Port=port;Username=root;Password=password".</returns>
+    public string? GetConnectionString()
+    {
+        if (!this.TryGetAllocatedEndPoints(out var allocatedEndpoints))
+        {
+            throw new DistributedApplicationException("Expected allocated endpoints!");
+        }
+
+        var allocatedEndpoint = allocatedEndpoints.Single(); // We should only have one endpoint for MySQL.
+
+        var connectionString = $"Host={allocatedEndpoint.Address};Port={allocatedEndpoint.Port};Username=root;Password={Password};";
+        return connectionString;
+    }
+}

src/Aspire.Hosting/MySql/MySqlDatabaseResource.cs

@@ -0,0 +1,30 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Aspire.Hosting.ApplicationModel;
+
+/// <summary>
+/// A resource that represents a MySQL database. This is a child resource of a <see cref="MySqlContainerResource"/>.
+/// </summary>
+/// <param name="name">The name of the resource.</param>
+/// <param name="mySqlContainer">The MySQL server resource associated with this database.</param>
+public class MySqlDatabaseResource(string name, MySqlContainerResource mySqlContainer) : Resource(name), IMySqlResource, IResourceWithParent<MySqlContainerResource>
+{
+    public MySqlContainerResource Parent { get; } = mySqlContainer;
+
+    /// <summary>
+    /// Gets the connection string for the MySQL database.
+    /// </summary>
+    /// <returns>A connection string for the MySQL database.</returns>
+    public string? GetConnectionString()
+    {
+        if (Parent.GetConnectionString() is { } connectionString)
+        {
+            return $"{connectionString}Database={Name}";
+        }
+        else
+        {
+            throw new DistributedApplicationException("Parent resource connection string was null.");
+        }
+    }
+}

src/Components/Aspire.MySqlConnector/Aspire.MySqlConnector.csproj

@@ -0,0 +1,24 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>$(NetCurrent)</TargetFramework>
+    <IsPackable>true</IsPackable>
+    <PackageTags>$(ComponentDatabasePackageTags) mysqlconnector mysql sql</PackageTags>
+    <Description>A MySQL client that integrates with Aspire, including health checks, metrics, logging, and telemetry.</Description>
+    <PackageIconFullPath>$(SharedDir)SQL_256x.png</PackageIconFullPath>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Compile Include="..\Common\HealthChecksExtensions.cs" Link="HealthChecksExtensions.cs" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="AspNetCore.HealthChecks.MySql" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Binder" />
+    <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" />
+    <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" />
+    <PackageReference Include="MySqlConnector.DependencyInjection" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" />
+  </ItemGroup>
+
+</Project>