-
Notifications
You must be signed in to change notification settings - Fork 526
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds Aspire Oracle EntityFrameworkCore Database component. (#1295)
* Adds Aspire Oracle EntityFrameworkCore Database component. * AppModel apis * tests for oracle hosting * adjusting to reviews * Oracle has a 30 character password limit * functional test * adjusting to reviews * configurationschema was outdated * adjusting to reviews * updated with the latest bits
- Loading branch information
1 parent
9d4bd62
commit 398dd70
Showing
29 changed files
with
1,311 additions
and
2 deletions.
There are no files selected for viewing
This file contains 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 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
11 changes: 11 additions & 0 deletions
11
src/Aspire.Hosting/Oracle/IOracleDatabaseParentResource.cs
This file contains 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,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 Oracle Database resource that requires a connection string. | ||
| /// </summary> | ||
| public interface IOracleDatabaseParentResource : IResourceWithConnectionString, IResourceWithEnvironment | ||
| { | ||
| } |
105 changes: 105 additions & 0 deletions
105
src/Aspire.Hosting/Oracle/OracleDatabaseBuilderExtensions.cs
This file contains 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,105 @@ | ||
| // 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 Aspire.Hosting.ApplicationModel; | ||
| using Aspire.Hosting.Publishing; | ||
|
|
||
| namespace Aspire.Hosting; | ||
|
|
||
| /// <summary> | ||
| /// Provides extension methods for adding Oracle Database resources to an <see cref="IDistributedApplicationBuilder"/>. | ||
| /// </summary> | ||
| public static class OracleDatabaseBuilderExtensions | ||
| { | ||
| private const string PasswordEnvVarName = "ORACLE_PWD"; | ||
|
|
||
| /// <summary> | ||
| /// Adds a Oracle Database container to the application model. The default image is "database/free" 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 Oracle Database.</param> | ||
| /// <param name="password">The password for the Oracle Database container. Defaults to a random password.</param> | ||
| /// <returns>A reference to the <see cref="IResourceBuilder{OracleDatabaseContainerResource}"/>.</returns> | ||
| public static IResourceBuilder<OracleDatabaseContainerResource> AddOracleDatabaseContainer(this IDistributedApplicationBuilder builder, string name, int? port = null, string? password = null) | ||
| { | ||
| password = password ?? Guid.NewGuid().ToString("N").Substring(0, 30); | ||
| var oracleDatabaseContainer = new OracleDatabaseContainerResource(name, password); | ||
| return builder.AddResource(oracleDatabaseContainer) | ||
| .WithManifestPublishingCallback(context => WriteOracleDatabaseContainerResourceToManifest(context, oracleDatabaseContainer)) | ||
| .WithAnnotation(new EndpointAnnotation(ProtocolType.Tcp, port: port, containerPort: 1521)) | ||
| .WithAnnotation(new ContainerImageAnnotation { Image = "database/free", Tag = "latest", Registry = "container-registry.oracle.com" }) | ||
| .WithEnvironment(context => | ||
| { | ||
| if (context.PublisherName == "manifest") | ||
| { | ||
| context.EnvironmentVariables.Add(PasswordEnvVarName, $"{{{oracleDatabaseContainer.Name}.inputs.password}}"); | ||
| } | ||
| else | ||
| { | ||
| context.EnvironmentVariables.Add(PasswordEnvVarName, oracleDatabaseContainer.Password); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Adds a Oracle Database 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> | ||
| /// <returns>A reference to the <see cref="IResourceBuilder{OracleDatabaseServerResource}"/>.</returns> | ||
| public static IResourceBuilder<OracleDatabaseServerResource> AddOracleDatabase(this IDistributedApplicationBuilder builder, string name) | ||
| { | ||
| var password = Guid.NewGuid().ToString("N").Substring(0, 30); | ||
| var oracleDatabaseServer = new OracleDatabaseServerResource(name, password); | ||
| return builder.AddResource(oracleDatabaseServer) | ||
| .WithManifestPublishingCallback(WriteOracleDatabaseContainerToManifest) | ||
| .WithAnnotation(new EndpointAnnotation(ProtocolType.Tcp, containerPort: 1521)) | ||
| .WithAnnotation(new ContainerImageAnnotation { Image = "database/free", Tag = "latest", Registry = "container-registry.oracle.com" }) | ||
| .WithEnvironment(PasswordEnvVarName, () => oracleDatabaseServer.Password); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Adds a Oracle Database database to the application model. | ||
| /// </summary> | ||
| /// <param name="builder">The Oracle Database 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{OracleDatabaseResource}"/>.</returns> | ||
| public static IResourceBuilder<OracleDatabaseResource> AddDatabase(this IResourceBuilder<IOracleDatabaseParentResource> builder, string name) | ||
| { | ||
| var oracleDatabase = new OracleDatabaseResource(name, builder.Resource); | ||
| return builder.ApplicationBuilder.AddResource(oracleDatabase) | ||
| .WithManifestPublishingCallback(context => WriteOracleDatabaseToManifest(context, oracleDatabase)); | ||
| } | ||
|
|
||
| private static void WriteOracleDatabaseContainerToManifest(ManifestPublishingContext context) | ||
| { | ||
| context.Writer.WriteString("type", "oracle.server.v0"); | ||
| } | ||
|
|
||
| private static void WriteOracleDatabaseToManifest(ManifestPublishingContext context, OracleDatabaseResource oracleDatabase) | ||
| { | ||
| context.Writer.WriteString("type", "oracle.database.v0"); | ||
| context.Writer.WriteString("parent", oracleDatabase.Parent.Name); | ||
| } | ||
|
|
||
| private static void WriteOracleDatabaseContainerResourceToManifest(ManifestPublishingContext context, OracleDatabaseContainerResource resource) | ||
| { | ||
| context.WriteContainer(resource); | ||
| context.Writer.WriteString( // "connectionString": "...", | ||
| "connectionString", | ||
| $"user id=system;password={{{resource.Name}.inputs.password}};data source={{{resource.Name}.bindings.tcp.host}}:{{{resource.Name}.bindings.tcp.port}};"); | ||
| context.Writer.WriteStartObject("inputs"); // "inputs": { | ||
| context.Writer.WriteStartObject("password"); // "password": { | ||
| context.Writer.WriteString("type", "string"); // "type": "string", | ||
| context.Writer.WriteBoolean("secret", true); // "secret": true, | ||
| context.Writer.WriteStartObject("default"); // "default": { | ||
| context.Writer.WriteStartObject("generate"); // "generate": { | ||
| context.Writer.WriteNumber("minLength", 10); // "minLength": 10, | ||
| context.Writer.WriteEndObject(); // } | ||
| context.Writer.WriteEndObject(); // } | ||
| context.Writer.WriteEndObject(); // } | ||
| context.Writer.WriteEndObject(); // } | ||
| } | ||
| } |
33 changes: 33 additions & 0 deletions
33
src/Aspire.Hosting/Oracle/OracleDatabaseContainerResource.cs
This file contains 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,33 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using Aspire.Hosting.Utils; | ||
|
|
||
| namespace Aspire.Hosting.ApplicationModel; | ||
|
|
||
| /// <summary> | ||
| /// A resource that represents a Oracle Database container. | ||
| /// </summary> | ||
| /// <param name="name">The name of the resource.</param> | ||
| /// <param name="password">The Oracle Database server password.</param> | ||
| public class OracleDatabaseContainerResource(string name, string password) : ContainerResource(name), IOracleDatabaseParentResource | ||
| { | ||
| public string Password { get; } = password; | ||
|
|
||
| /// <summary> | ||
| /// Gets the connection string for the Oracle Database server. | ||
| /// </summary> | ||
| /// <returns>A connection string for the Oracle Database server in the form "user id=system;password=password;data source=localhost:port".</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 Oracle Database. | ||
|
|
||
| var connectionString = $"user id=system;password={PasswordUtil.EscapePassword(Password)};data source={allocatedEndpoint.Address}:{allocatedEndpoint.Port}"; | ||
| return connectionString; | ||
| } | ||
| } |
This file contains 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,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 Oracle Database database. This is a child resource of a <see cref="OracleDatabaseContainerResource"/>. | ||
| /// </summary> | ||
| /// <param name="name">The name of the resource.</param> | ||
| /// <param name="oracleParentResource">The Oracle Database parent resource associated with this database.</param> | ||
| public class OracleDatabaseResource(string name, IOracleDatabaseParentResource oracleParentResource) : Resource(name), IResourceWithParent<IOracleDatabaseParentResource>, IResourceWithConnectionString | ||
| { | ||
| public IOracleDatabaseParentResource Parent { get; } = oracleParentResource; | ||
|
|
||
| /// <summary> | ||
| /// Gets the connection string for the Oracle Database. | ||
| /// </summary> | ||
| /// <returns>A connection string for the Oracle Database.</returns> | ||
| public string? GetConnectionString() | ||
| { | ||
| if (Parent.GetConnectionString() is { } connectionString) | ||
| { | ||
| return $"{connectionString}/{Name}"; | ||
| } | ||
| else | ||
| { | ||
| throw new DistributedApplicationException("Parent resource connection string was null."); | ||
| } | ||
| } | ||
| } |
This file contains 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,33 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using Aspire.Hosting.Utils; | ||
|
|
||
| namespace Aspire.Hosting.ApplicationModel; | ||
|
|
||
| /// <summary> | ||
| /// A resource that represents a Oracle Database container. | ||
| /// </summary> | ||
| /// <param name="name">The name of the resource.</param> | ||
| /// <param name="password">The Oracle Database server password.</param> | ||
| public class OracleDatabaseServerResource(string name, string password) : Resource(name), IOracleDatabaseParentResource | ||
| { | ||
| public string Password { get; } = password; | ||
|
|
||
| /// <summary> | ||
| /// Gets the connection string for the Oracle Database server. | ||
| /// </summary> | ||
| /// <returns>A connection string for the Oracle Database server in the form "user id=system;password=password;data source=host:port".</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 Oracle. | ||
|
|
||
| var connectionString = $"user id=system;password={PasswordUtil.EscapePassword(Password)};data source={allocatedEndpoint.Address}:{allocatedEndpoint.Port}"; | ||
| return connectionString; | ||
| } | ||
| } |
25 changes: 25 additions & 0 deletions
25
src/Components/Aspire.Oracle.EntityFrameworkCore/Aspire.Oracle.EntityFrameworkCore.csproj
This file contains 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,25 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>$(NetCurrent)</TargetFramework> | ||
| <IsPackable>true</IsPackable> | ||
| <PackageTags>$(ComponentEfCorePackageTags) oracle sql</PackageTags> | ||
| <Description>An Oracle Database provider for Entity Framework Core that integrates with Aspire, including connection pooling, health check, logging, and telemetry.</Description> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <Compile Include="..\Common\HealthChecksExtensions.cs" Link="HealthChecksExtensions.cs" /> | ||
| <Compile Include="..\Common\ConfigurationSchemaAttributes.cs" Link="ConfigurationSchemaAttributes.cs" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Microsoft.Extensions.Configuration.Binder" /> | ||
| <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore" /> | ||
| <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" /> | ||
| <PackageReference Include="OpenTelemetry.Extensions.Hosting" /> | ||
| <PackageReference Include="OpenTelemetry.Instrumentation.EntityFrameworkCore" /> | ||
| <PackageReference Include="OpenTelemetry.Instrumentation.EventCounters" /> | ||
| <PackageReference Include="Oracle.EntityFrameworkCore" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
Oops, something went wrong.