fix: Add Keycloak health port 9000 starting from major version 25 #1213
Conversation
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
- Added `KeycloakHealthPort` constant set to 9000 in `KeycloakBuilder` for health check configurations. - Introduced `DefaultUsername` and `DefaultPassword` constants as "admin" in `KeycloakBuilder` for default access credentials. - Implemented logic for special handling of Keycloak version 25 and above, including: * Parsing the major version from the image tag. * Configuring `KeycloakHealthPort` port binding and a wait strategy based on the `/health/ready` endpoint for versions 25+, adapting to new health check mechanisms.
This commit makes significant updates to the KeycloakBuilder and introduces a new test class for Keycloak container health. In the KeycloakBuilder, the Build method has been revised to remove the immediate call to `Validate()` and the direct return of a new `KeycloakContainer`. Instead, it now includes logic to extract the major version number from the `DockerResourceConfiguration.Image.Tag`. If the version is 25 or higher, the builder is modified to add port binding for the Keycloak health port and a wait strategy for the `/health/ready` endpoint. After these potential modifications, `Validate()` is called to ensure the configuration is correct before returning the container. Additionally, the validation logic that previously checked the Docker image tag's major version has been removed from the direct validation method and incorporated into the Build method. This change streamlines the validation process, focusing it solely on configuration validation. A new test class, `KeycloakContainerHealthTest`, has been added to verify the health of the Keycloak container. It includes a method `HealthIsReady` that tests whether the container starts successfully and if its health endpoint returns an HTTP OK status. This method dynamically adjusts the `HttpClient.BaseAddress` based on the container's accessible hostname and port, ensuring the test is robust across different environments. The test covers both below and at the threshold versions with inline data for "quay.io/keycloak/keycloak:24.0" and "quay.io/keycloak/keycloak:25.0", ensuring the new health check configuration is properly applied. Containers are disposed of post-test to prevent resource leakage.
✅ Deploy Preview for testcontainers-dotnet ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for testcontainers-dotnet ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
For reference, it looks like the changes were introduced in version 25, according to the release notes. |
HofmeisterAn
requested changes
Jul 31, 2024
tests/Testcontainers.Keycloak.Tests/KeycloakContainerHealthTest.cs
Outdated
Show resolved
Hide resolved
PR suggestion Co-authored-by: Andre Hofmeister <[email protected]>
Enhanced `KeycloakBuilder` to better handle the `isLatestVersion` flag by including "nightly" tags and refining major version parsing. Updated the wait strategy to use `KeycloakHealthPort` for the latest versions. Renamed `couchbaseBuilder` to `keycloakBuilder` for consistency. Adjusted wait strategy condition to check for any strategies. Added `System.Linq` to global usings in `Usings.cs`.
Enhanced `KeycloakBuilder` to better handle the `isLatestVersion` flag by including "nightly" tags and refining major version parsing. Updated the wait strategy to use `KeycloakHealthPort` for the latest versions. Renamed `couchbaseBuilder` to `keycloakBuilder` for consistency. Adjusted wait strategy condition to check for any strategies. Added `System.Linq` to global usings in `Usings.cs`.
…ners-testcontainers-dotnet into paulomorgado-keycloack-health
HofmeisterAn
changed the title
HofmeisterAn
approved these changes
Aug 7, 2024
|
Thanks @paulomorgado 🙏. |
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.
What does this PR do?
Starting with tag
25.0Keycloak uses port 9000 instead of port 8080 for health checks.Why is it important?
Currently the readiness for image
25.0and above is not correct and might consider the container ready when it's yet ready.Related issues
How to test this PR
Use tag 24.0 and tag 25.0 and asset that all correctly wait for the container to be ready.