Skip to content

fix(keycloak): Use wait strategy instead of deprecated decorator #1135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mschmitzer wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(keycloak): Use wait strategy instead of deprecated decorator #1135

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 31 additions & 16 deletions src/testcontainers/community/keycloak/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
from typing_extensions import Self

from testcontainers.core.container import DockerContainer
from testcontainers.core.waiting_utils import wait_container_is_ready, wait_for_logs
from testcontainers.core.wait_strategies import LogMessageWaitStrategy, WaitStrategy

_DEFAULT_DEV_COMMAND = "start-dev"
# Since Keycloak v26.0.0
Expand Down Expand Up @@ -96,23 +96,9 @@ def get_management_url(self) -> str:
else:
return f"http://{host}:{port}"

@wait_container_is_ready(requests.exceptions.ConnectionError, requests.exceptions.ReadTimeout)
def _readiness_probe(self) -> None:
# Keycloak provides REST API endpoints for health checks: https://www.keycloak.org/server/health
try:
# Try the new health endpoint for keycloak 25.0.0 and above
# See https://www.keycloak.org/docs/25.0.0/release_notes/#management-port-for-metrics-and-health-endpoints
response = requests.get(f"{self.get_management_url()}/health/ready", timeout=1)
except requests.exceptions.ConnectionError:
response = requests.get(f"{self.get_url()}/health/ready", timeout=1)
response.raise_for_status()
if _DEFAULT_DEV_COMMAND in self._command:
wait_for_logs(self, "started in \\d+\\.\\d+s")
wait_for_logs(self, "Created temporary admin user|Added user '")

def start(self) -> Self:
super().start()
self._readiness_probe()
KeycloakWaitStrategy().wait_until_ready(self)
self._disable_ssl_required()
return self

Expand Down Expand Up @@ -165,3 +151,32 @@ def get_client(self, **kwargs: object) -> KeycloakAdmin:
}
kwargs = {**default_kwargs, **kwargs}
return KeycloakAdmin(**kwargs)


class KeycloakWaitStrategy(WaitStrategy):
def wait_until_ready(self, container: KeycloakContainer):
self._poll(
lambda: self._poll_health(container),
transient_exceptions=[
requests.exceptions.ConnectionError,
requests.exceptions.ReadTimeout,
],
)
if _DEFAULT_DEV_COMMAND in container._command:
for message in (
"started in \\d+\\.\\d+s",
"Created temporary admin user|Added user '",
):
LogMessageWaitStrategy(message).wait_until_ready(container)

@classmethod
def _poll_health(cls, container: KeycloakContainer):
# Keycloak provides REST API endpoints for health checks: https://www.keycloak.org/server/health
try:
# Try the new health endpoint for keycloak 25.0.0 and above
# See https://www.keycloak.org/docs/25.0.0/release_notes/#management-port-for-metrics-and-health-endpoints
response = requests.get(f"{container.get_management_url()}/health/ready", timeout=1)
except requests.exceptions.ConnectionError:
response = requests.get(f"{container.get_url()}/health/ready", timeout=1)
response.raise_for_status()
return True
Loading