Add Keycloak with Postgres integration #811
+806
−1
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>net9.0</TargetFramework> | ||
| <ImplicitUsings>enable</ImplicitUsings> | ||
| <Nullable>enable</Nullable> | ||
| </PropertyGroup> | ||
axies20 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Aspire.Hosting" /> | ||
| <PackageReference Include="Aspire.Hosting.Keycloak" /> | ||
| <PackageReference Include="Aspire.Hosting.PostgreSQL" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,104 @@ | ||||||
| using Aspire.Hosting; | ||||||
| using Aspire.Hosting.ApplicationModel; | ||||||
| using Npgsql; | ||||||
|
|
||||||
| namespace CommunityToolkit.Aspire.Keycloak.Extensions.Postgres; | ||||||
|
|
||||||
| /// <summary> | ||||||
| /// Provides extension methods for integrating Keycloak resources with PostgreSQL. | ||||||
| /// </summary> | ||||||
| public static class KeycloakPostgresExtension | ||||||
| { | ||||||
| /// Configures a Keycloak resource to use a Postgres database by setting appropriate environment variables. | ||||||
axies20 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| /// <param name="builder"> | ||||||
| /// The resource builder for the Keycloak resource. | ||||||
| /// </param> | ||||||
| /// <param name="database"> | ||||||
| /// The resource builder for the Postgres database resource. | ||||||
| /// </param> | ||||||
| /// <param name="app"> | ||||||
| /// The distributed application builder for adding parameters like username and password for the Postgres database. | ||||||
| /// </param> | ||||||
| /// <returns> | ||||||
| /// The updated resource builder for the Keycloak resource. | ||||||
| /// </returns> | ||||||
| private static void WithPostgres(this IResourceBuilder<KeycloakResource> builder, | ||||||
|
||||||
| IResourceBuilder<PostgresDatabaseResource> database) | ||||||
| { | ||||||
| ArgumentNullException.ThrowIfNull(builder); | ||||||
| ArgumentNullException.ThrowIfNull(database); | ||||||
|
|
||||||
| PostgresServerResource pgServer = database.Resource.Parent; | ||||||
| EndpointReference ep = pgServer.GetEndpoint("tcp"); | ||||||
|
|
||||||
| string dbName = database.Resource.Name; | ||||||
|
|
||||||
| ReferenceExpression jdbcUrl = ReferenceExpression.Create( | ||||||
| $"jdbc:postgresql://{ep.Property(EndpointProperty.Host)}:" + | ||||||
| $"{ep.Property(EndpointProperty.Port)}/{dbName}"); | ||||||
|
|
||||||
| builder.WithEnvironment("KC_DB", "postgres") | ||||||
|
||||||
| .WithEnvironment("KC_DB_URL", jdbcUrl); | ||||||
| } | ||||||
|
|
||||||
| /// Configures a Keycloak resource to use a Postgres database in a development environment by setting appropriate | ||||||
| /// environment variables and custom connection details. | ||||||
axies20 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| /// <param name="builder"> | ||||||
| /// The resource builder for the Keycloak resource. | ||||||
| /// </param> | ||||||
| /// <param name="database"> | ||||||
| /// The resource builder for the Postgres database resource. | ||||||
| /// </param> | ||||||
| /// <param name="port"> | ||||||
| /// The port for connecting to the Postgres database. Defaults to 5432. | ||||||
| /// </param> | ||||||
| /// <returns> | ||||||
| /// The updated resource builder for the Keycloak resource. | ||||||
| /// </returns> | ||||||
| public static IResourceBuilder<KeycloakResource> WithPostgresDev(this IResourceBuilder<KeycloakResource> builder, | ||||||
|
||||||
| IResourceBuilder<PostgresDatabaseResource> database, int port = 5432) | ||||||
| { | ||||||
| WithPostgres(builder, database); | ||||||
|
|
||||||
| database.OnConnectionStringAvailable(async (dataResource, _, cancellationToken) => | ||||||
| { | ||||||
| NpgsqlConnectionStringBuilder npg = | ||||||
| new(await dataResource.ConnectionStringExpression.GetValueAsync(cancellationToken)); | ||||||
| builder.WithEnvironment("KC_DB", "postgres") | ||||||
| .WithEnvironment("KC_DB", "postgres") | ||||||
|
||||||
| builder.WithEnvironment("KC_DB", "postgres") | |
| .WithEnvironment("KC_DB", "postgres") |
Copilot uses AI. Check for mistakes.
axies20 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
axies20 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>net9.0</TargetFramework> | ||
| <ImplicitUsings>enable</ImplicitUsings> | ||
| <Nullable>enable</Nullable> | ||
| <IsPackable>false</IsPackable> | ||
| </PropertyGroup> | ||
|
||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Aspire.Hosting.Keycloak" /> | ||
| <PackageReference Include="coverlet.collector" Version="6.0.2"/> | ||
| <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0"/> | ||
| <PackageReference Include="xunit" Version="2.9.2"/> | ||
| <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2"/> | ||
|
||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <Using Include="Xunit"/> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\src\CommunityToolkit.Aspire.Keycloak.Extensions.Postgres\CommunityToolkit.Aspire.Keycloak.Extensions.Postgres.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| | ||
|
|
||
| namespace CommunityToolkit.Aspire.Keycloak.Extensions.Postgres.Tests; | ||
|
|
||
| public partial class KeycloakExtensionPostgressTests | ||
| { | ||
|
|
||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I assume this is just done when you were testing, but ensure you roll that back and use the MSBuild variable
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had error
0>CommunityToolkit.Aspire.Keycloak.Postgres.csproj: Error NU1605 : Warning As Error: Detected package downgrade: Aspire.Hosting from 9.4.1 to 9.4.0. Reference the package directly from the project to select a different version.
CommunityToolkit.Aspire.Keycloak.Postgres -> Aspire.Hosting.Keycloak 9.4.1-preview.1.25408.4 -> Aspire.Hosting (>= 9.4.1)
CommunityToolkit.Aspire.Keycloak.Postgres -> Aspire.Hosting (>= 9.4.0)
0>------- Finished building project: CommunityToolkit.Aspire.Keycloak.Postgres. Succeeded: False. Errors: 1. Warnings: 0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
mainbranch is now updated to 9.4.1 Aspire.