Add DbGate support for MySql #695
Merged
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for integrating DbGate with MySQL resources by introducing a new WithDbGate extension method, updating documentation and examples, and extending test coverage to validate the new functionality.
- Added the WithDbGate extension method in MySqlBuilderExtensions to configure DbGate container resources.
- Updated tests, documentation, and project references to support the new DbGate integration with MySQL.
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/CommunityToolkit.Aspire.Hosting.MySql.Extensions.Tests/ResourceCreationTests.cs | Added multiple tests to validate annotations and configuration for DbGate integration. |
| tests/CommunityToolkit.Aspire.Hosting.DbGate.Tests/AddDbGateTests.cs | Updated tests to include MySQL resource annotations and resource naming changes. |
| src/CommunityToolkit.Aspire.Hosting.MySql.Extensions/README.md | Updated README to reflect support for DbGate alongside Adminer. |
| src/CommunityToolkit.Aspire.Hosting.MySql.Extensions/MySqlBuilderExtensions.cs | Introduced the WithDbGate extension method and configuration logic for MySQL resources. |
| src/CommunityToolkit.Aspire.Hosting.DbGate/DbGateContainerImageTags.cs | Adjusted XML documentation from summary to remarks for consistency. |
| examples/mysql-ext/CommunityToolkit.Aspire.Hosting.MySql.Extensions.AppHost/Program.cs | Updated sample to demonstrate DbGate usage with custom host port. |
| examples/dbgate/CommunityToolkit.Aspire.Hosting.DbGate.AppHost/Program.cs | Added example usage of DbGate with multiple MySQL resources. |
| examples/dbgate/CommunityToolkit.Aspire.Hosting.DbGate.AppHost/CommunityToolkit.Aspire.Hosting.DbGate.AppHost.csproj | Included project reference for MySQL Extensions to support DbGate integration. |
Comments suppressed due to low confidence (2)
src/CommunityToolkit.Aspire.Hosting.MySql.Extensions/MySqlBuilderExtensions.cs:101
- The early exit based on the existence of 'LABEL_mysql1' may skip configuration for additional MySQL instances when multiple WithDbGate calls occur; consider revising the logic to aggregate annotations from all resources or add detailed documentation explaining this behavior.
if (context.EnvironmentVariables.ContainsKey("LABEL_mysql" + counter))
src/CommunityToolkit.Aspire.Hosting.MySql.Extensions/MySqlBuilderExtensions.cs:126
- [nitpick] Consider renaming the local variable 'CONNECTIONS' to follow camelCase (e.g., 'existingConnections') since it is not a constant.
string CONNECTIONS = context.EnvironmentVariables.GetValueOrDefault("CONNECTIONS")?.ToString() ?? string.Empty;
aaronpowell
approved these changes
May 24, 2025
Minimum allowed line rate is |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
**Contributes #415 **
This pull request introduces support for integrating DbGate with MySQL resources. It includes updates to the core functionality, examples, documentation, and tests to enable and validate this feature. The most important changes are grouped below:
Core Functionality Enhancements:
WithDbGateextension method inMySqlBuilderExtensionsto integrate DbGate with MySQL resources. This method configures environment variables and supports multiple MySQL instances.DbGateContainerImageTagsto use<remarks>instead of<summary>for better documentation consistency.Example Updates:
examples/dbgate/CommunityToolkit.Aspire.Hosting.DbGate.AppHost/Program.csto demonstrate the use ofWithDbGatewith multiple MySQL instances.examples/mysql-ext/CommunityToolkit.Aspire.Hosting.MySql.Extensions.AppHost/Program.csto include a DbGate configuration example alongside Adminer.Documentation Improvements:
CommunityToolkit.Aspire.Hosting.MySql.Extensionsto include DbGate as a supported tool for MySQL interaction, with updated usage examples. [1] [2]Testing Additions:
AddDbGateTestsandResourceCreationTeststo validate the integration of DbGate with MySQL resources, including environment variable configurations, container image tags, and support for multiple instances. [1] [2] [3]Dependency Updates:
CommunityToolkit.Aspire.Hosting.DbGateinCommunityToolkit.Aspire.Hosting.MySql.Extensions.csprojto enable the new functionality.PR Checklist
Other information