Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<ItemGroup>
<ProjectReference Include="..\..\..\src\CommunityToolkit.Aspire.Hosting.Adminer\CommunityToolkit.Aspire.Hosting.Adminer.csproj" IsAspireProjectResource="false" />
<ProjectReference Include="..\..\..\src\CommunityToolkit.Aspire.Hosting.PostgreSQL.Extensions\CommunityToolkit.Aspire.Hosting.PostgreSQL.Extensions.csproj" IsAspireProjectResource="false" />
<ProjectReference Include="..\..\..\src\CommunityToolkit.Aspire.Hosting.SqlServer.Extensions\CommunityToolkit.Aspire.Hosting.SqlServer.Extensions.csproj" IsAspireProjectResource="false" />
</ItemGroup>

</Project>
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,14 @@
postgres2.AddDatabase("db3");
postgres2.AddDatabase("db4");

var sqlserver1 = builder.AddSqlServer("sqlserver1")
.WithAdminer();
sqlserver1.AddDatabase("db5");
sqlserver1.AddDatabase("db6");

var sqlserver2 = builder.AddSqlServer("sqlserver2")
.WithAdminer();
sqlserver2.AddDatabase("db7");
sqlserver2.AddDatabase("db8");

builder.Build().Run();
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
var builder = DistributedApplication.CreateBuilder(args);

var sqlserver1 = builder.AddSqlServer("sqlserver1")
.WithDbGate(c => c.WithHostPort(8068));
.WithDbGate(c => c.WithHostPort(8068))
.WithAdminer(c => c.WithHostPort(8069));
sqlserver1.AddDatabase("db1");
sqlserver1.AddDatabase("db2");

var sqlserver2 = builder.AddSqlServer("sqlserver2")
.WithDbGate();
.WithDbGate()
.WithAdminer();
sqlserver2.AddDatabase("db3");
sqlserver2.AddDatabase("db4");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,14 @@
</ItemGroup>

<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>
<Compile Include="$(SharedDir)\Adminer\AdminerLoginServer.cs" Link="AdminerLoginServer.cs" />
</ItemGroup>

<!-- Workaround for https://github.com/dotnet/aspire/issues/7779 -->
<ItemGroup Condition="'$(TargetFramework)' == 'net9.0'">
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This integration contains extensions for the [SqlServer hosting package](https://nuget.org/packages/Aspire.Hosting.SqlServer) for .NET Aspire.

The integration provides support for running [DbGate](https://github.com/dbgate/dbgate) to interact with the SqlServer database.
The integration provides support for running [DbGate](https://github.com/dbgate/dbgate) and [Adminer](https://github.com/vrana/adminer) to interact with the SqlServer database.

## Getting Started

Expand All @@ -20,7 +20,8 @@ Then, in the _Program.cs_ file of `AppHost`, define an SqlServer resource, then

```csharp
var sqlserver = builder.AddSqlServer("sqlserver")
.WithDbGate();
.WithDbGate()
.WithAdminer();
```

## Additional Information
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
using Aspire.Hosting.ApplicationModel;
using System.Text;
using System.Text.Json;

namespace Aspire.Hosting;

Expand Down Expand Up @@ -49,6 +50,46 @@ public static IResourceBuilder<SqlServerServerResource> WithDbGate(this IResourc
return builder;
}

/// <summary>
/// Adds an administration and development platform for SqlServer to the application model using Adminer.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="AdminerContainerImageTags.Tag"/> tag of the <inheritdoc cref="AdminerContainerImageTags.Image"/> container image.
/// <param name="builder">The SqlServer server resource builder.</param>
/// <param name="configureContainer">Configuration callback for Adminer container resource.</param>
/// <param name="containerName">The name of the container (Optional).</param>
/// <example>
/// Use in application host with a SqlServer resource
/// <code lang="csharp">
/// var builder = DistributedApplication.CreateBuilder(args);
///
/// var sqlserver = builder.AddSqlServer("sqlserver")
/// .WithAdminer();
/// var db = sqlserver.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<SqlServerServerResource> WithAdminer(this IResourceBuilder<SqlServerServerResource> builder, Action<IResourceBuilder<AdminerContainerResource>>? configureContainer = null, string? containerName = null)
{
ArgumentNullException.ThrowIfNull(builder);

containerName ??= $"{builder.Resource.Name}-adminer";
var adminerBuilder = AdminerBuilderExtensions.AddAdminer(builder.ApplicationBuilder, containerName);

adminerBuilder
.WithEnvironment(context => ConfigureAdminerContainer(context, builder.ApplicationBuilder));

configureContainer?.Invoke(adminerBuilder);

return builder;
}

private static void ConfigureDbGateContainer(EnvironmentCallbackContext context, IDistributedApplicationBuilder applicationBuilder)
{
var sqlServerInstances = applicationBuilder.Resources.OfType<SqlServerServerResource>();
Expand Down Expand Up @@ -93,4 +134,45 @@ private static void ConfigureDbGateContainer(EnvironmentCallbackContext context,
}
}
}

private static void ConfigureAdminerContainer(EnvironmentCallbackContext context, IDistributedApplicationBuilder applicationBuilder)
{
var sqlServerInstances = applicationBuilder.Resources.OfType<SqlServerServerResource>();

string ADMINER_SERVERS = context.EnvironmentVariables.GetValueOrDefault("ADMINER_SERVERS")?.ToString() ?? string.Empty;

var new_servers = sqlServerInstances.ToDictionary(
sqlServerServerResource => sqlServerServerResource.Name,
sqlServerServerResource =>
{
return new AdminerLoginServer
{
Server = sqlServerServerResource.Name,
UserName = "sa",
Password = sqlServerServerResource.PasswordParameter.Value,
Driver = "mssql"
};
});

if (string.IsNullOrEmpty(ADMINER_SERVERS))
{
string servers_json = JsonSerializer.Serialize(new_servers);
context.EnvironmentVariables["ADMINER_SERVERS"] = servers_json;
}
else
{
var servers = JsonSerializer.Deserialize<Dictionary<string, AdminerLoginServer>>(ADMINER_SERVERS) ?? throw new InvalidOperationException("The servers should not be null. This should never happen.");
foreach (var server in new_servers)
{
if (!servers.ContainsKey(server.Key))
{
servers!.Add(server.Key, server.Value);
}
}
string servers_json = JsonSerializer.Serialize(servers);
context.EnvironmentVariables["ADMINER_SERVERS"] = servers_json;
}

}

}
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,16 @@ public async Task WithAdminerShouldAddAnnotationsForMultipleDatabaseTypes()

var postgresResource2 = postgresResourceBuilder2.Resource;

var sqlserverResourceBuilder1 = builder.AddSqlServer("sqlserver1")
.WithAdminer();

var sqlserverResource1 = sqlserverResourceBuilder1.Resource;

var sqlserverResourceBuilder2 = builder.AddSqlServer("sqlserver2")
.WithAdminer();

var sqlserverResource2 = sqlserverResourceBuilder2.Resource;

using var app = builder.Build();

var appModel = app.Services.GetRequiredService<DistributedApplicationModel>();
Expand Down Expand Up @@ -181,6 +191,26 @@ public async Task WithAdminerShouldAddAnnotationsForMultipleDatabaseTypes()
Password = postgresResource2.PasswordParameter.Value,
UserName = postgresResource2.UserNameParameter?.Value ?? "postgres"
}
},
{
"sqlserver1",
new AdminerLoginServer
{
Driver = "mssql",
Server = sqlserverResource1.Name,
Password = sqlserverResource1.PasswordParameter.Value,
UserName = "sa"
}
},
{
"sqlserver2",
new AdminerLoginServer
{
Driver = "mssql",
Server = sqlserverResource2.Name,
Password = sqlserverResource2.PasswordParameter.Value,
UserName = "sa"
}
}
};

Expand All @@ -201,6 +231,12 @@ public void WithAdminerShouldShouldAddOneAdminerResourceForMultipleDatabaseTypes
builder.AddPostgres("postgres2")
.WithAdminer();

builder.AddSqlServer("sqlserver1")
.WithAdminer();

builder.AddSqlServer("sqlserver2")
.WithAdminer();

using var app = builder.Build();

var appModel = app.Services.GetRequiredService<DistributedApplicationModel>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,7 @@
<ProjectReference Include="..\..\src\CommunityToolkit.Aspire.Hosting.SqlServer.Extensions\CommunityToolkit.Aspire.Hosting.SqlServer.Extensions.csproj" />
<ProjectReference Include="..\CommunityToolkit.Aspire.Testing\CommunityToolkit.Aspire.Testing.csproj" />
</ItemGroup>
<ItemGroup>
<Compile Include="$(SharedDir)\Adminer\AdminerLoginServer.cs" Link="AdminerLoginServer.cs" />
</ItemGroup>
</Project>
Loading
Loading