feat: Add Grafana module #1509
Open
feat: Add Grafana module #1509
+471
−0
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
Implements Testcontainers support for Grafana with the following features: - Default Grafana image: grafana/grafana:11.0.0 - Support for custom username/password authentication - Anonymous access configuration - Ability to mount datasources, dashboards, plugins, and notifiers - HTTP health check wait strategy - Connection string generation with embedded credentials 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
✅ Deploy Preview for testcontainers-dotnet ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
HofmeisterAn
added
module
HofmeisterAn
force-pushed
the
develop
branch
3 times, most recently
from
4900ecd to
8fa5f1b
Compare
HofmeisterAn
requested changes
Oct 15, 2025
Comment on lines
+78
to
+116
| /// <summary> | ||
| /// Mounts a datasource configuration file. | ||
| /// </summary> | ||
| /// <param name="datasourceFilePath">The path to the datasource configuration file.</param> | ||
| /// <returns>A configured instance of <see cref="GrafanaBuilder" />.</returns> | ||
| public GrafanaBuilder WithDataSource(string datasourceFilePath) | ||
| { | ||
| return WithBindMount(datasourceFilePath, "/etc/grafana/provisioning/datasources/"); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Mounts a dashboard configuration file. | ||
| /// </summary> | ||
| /// <param name="dashboardFilePath">The path to the dashboard configuration file.</param> | ||
| /// <returns>A configured instance of <see cref="GrafanaBuilder" />.</returns> | ||
| public GrafanaBuilder WithDashboard(string dashboardFilePath) | ||
| { | ||
| return WithBindMount(dashboardFilePath, "/etc/grafana/provisioning/dashboards/"); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Mounts a plugin configuration file. | ||
| /// </summary> | ||
| /// <param name="pluginFilePath">The path to the plugin configuration file.</param> | ||
| /// <returns>A configured instance of <see cref="GrafanaBuilder" />.</returns> | ||
| public GrafanaBuilder WithPlugin(string pluginFilePath) | ||
| { | ||
| return WithBindMount(pluginFilePath, "/etc/grafana/provisioning/plugins/"); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Mounts a notifier configuration file. | ||
| /// </summary> | ||
| /// <param name="notifierFilePath">The path to the notifier configuration file.</param> | ||
| /// <returns>A configured instance of <see cref="GrafanaBuilder" />.</returns> | ||
| public GrafanaBuilder WithNotifier(string notifierFilePath) | ||
| { | ||
| return WithBindMount(notifierFilePath, "/etc/grafana/provisioning/notifiers/"); | ||
| } |
There was a problem hiding this comment.
Mounting a share isn't aligned with our best practices. It can make the module incompatible with remote container runtimes. Instead, we recommend using the WithResourceMapping(FileInfo, FileInfo) API, which copies the files into the container.
| .WithPortBinding(GrafanaPort, true) | ||
| .WithUsername(DefaultUsername) | ||
| .WithPassword(DefaultPassword) | ||
| .WithEnvironment("GF_AUTH_ANONYMOUS_ENABLED", "false") |
There was a problem hiding this comment.
Suggested change
| .WithEnvironment("GF_AUTH_ANONYMOUS_ENABLED", "false") | |
| .WithAnonymousAccessDisabled() |
Comment on lines
+78
to
+116
| /// <summary> | ||
| /// Mounts a datasource configuration file. | ||
| /// </summary> | ||
| /// <param name="datasourceFilePath">The path to the datasource configuration file.</param> | ||
| /// <returns>A configured instance of <see cref="GrafanaBuilder" />.</returns> | ||
| public GrafanaBuilder WithDataSource(string datasourceFilePath) | ||
| { | ||
| return WithBindMount(datasourceFilePath, "/etc/grafana/provisioning/datasources/"); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Mounts a dashboard configuration file. | ||
| /// </summary> | ||
| /// <param name="dashboardFilePath">The path to the dashboard configuration file.</param> | ||
| /// <returns>A configured instance of <see cref="GrafanaBuilder" />.</returns> | ||
| public GrafanaBuilder WithDashboard(string dashboardFilePath) | ||
| { | ||
| return WithBindMount(dashboardFilePath, "/etc/grafana/provisioning/dashboards/"); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Mounts a plugin configuration file. | ||
| /// </summary> | ||
| /// <param name="pluginFilePath">The path to the plugin configuration file.</param> | ||
| /// <returns>A configured instance of <see cref="GrafanaBuilder" />.</returns> | ||
| public GrafanaBuilder WithPlugin(string pluginFilePath) | ||
| { | ||
| return WithBindMount(pluginFilePath, "/etc/grafana/provisioning/plugins/"); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Mounts a notifier configuration file. | ||
| /// </summary> | ||
| /// <param name="notifierFilePath">The path to the notifier configuration file.</param> | ||
| /// <returns>A configured instance of <see cref="GrafanaBuilder" />.</returns> | ||
| public GrafanaBuilder WithNotifier(string notifierFilePath) | ||
| { | ||
| return WithBindMount(notifierFilePath, "/etc/grafana/provisioning/notifiers/"); | ||
| } |
There was a problem hiding this comment.
These builder APIs haven't been tested. We typically add builder APIs only for configurations that are essential to run an instance or required for specific use cases.
Comment on lines
+32
to
+42
| public string GetConnectionString() | ||
| { | ||
| var endpoint = GetHttpEndpoint(); | ||
| var username = _configuration.Username ?? GrafanaBuilder.DefaultUsername; | ||
| var password = _configuration.Password ?? GrafanaBuilder.DefaultPassword; | ||
| return new UriBuilder(endpoint) | ||
| { | ||
| UserName = username, | ||
| Password = password | ||
| }.ToString(); | ||
| } |
There was a problem hiding this comment.
What's the purpose of this? The tests only use the HTTP header for authentication.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Implements Testcontainers support for Grafana with the following features: