Skip to content

fix(keycloak): Fixed Keycloak testcontainer for latest version v26.1.0 #766

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

Merged
alexanderankin merged 7 commits into from
Feb 11, 2025
Merged

fix(keycloak): Fixed Keycloak testcontainer for latest version v26.1.0 #766

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bf07954
Fixed Keycloak testcontainer for latest version v26.1.0
max-pfeiffer Feb 1, 2025
ae593ef
also include legacy vars
alexanderankin Feb 11, 2025
5e37379
ruff
alexanderankin Feb 11, 2025
68536ce
add back waiting
alexanderankin Feb 11, 2025
2e20d3b
add back constant
alexanderankin Feb 11, 2025
2df0fd2
restore old functionality for env vars
alexanderankin Feb 11, 2025
f0e26d7
ruff
alexanderankin Feb 11, 2025
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
18 changes: 11 additions & 7 deletions modules/keycloak/testcontainers/keycloak/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,12 @@

from keycloak import KeycloakAdmin
from testcontainers.core.container import DockerContainer
from testcontainers.core.waiting_utils import wait_container_is_ready, wait_for_logs
from testcontainers.core.waiting_utils import wait_container_is_ready

_DEFAULT_DEV_COMMAND = "start-dev"
# Since Keycloak v26.0.0
# See: https://www.keycloak.org/server/all-config#category-bootstrap_admin
ADMIN_USERNAME_ENVIRONMENT_VARIABLE = "KC_BOOTSTRAP_ADMIN_USERNAME"
ADMIN_PASSWORD_ENVIRONMENT_VARIABLE = "KC_BOOTSTRAP_ADMIN_PASSWORD"


class KeycloakContainer(DockerContainer):
Expand All @@ -46,17 +49,20 @@ def __init__(
password: Optional[str] = None,
port: int = 8080,
management_port: int = 9000,
cmd: Optional[str] = _DEFAULT_DEV_COMMAND,
cmd: Optional[str] = "start-dev",
) -> None:
super().__init__(image=image)
self.username = username or os.environ.get("KEYCLOAK_ADMIN", "test")
self.password = password or os.environ.get("KEYCLOAK_ADMIN_PASSWORD", "test")
self.username = username or os.environ.get(ADMIN_USERNAME_ENVIRONMENT_VARIABLE, "test")
self.password = password or os.environ.get(ADMIN_PASSWORD_ENVIRONMENT_VARIABLE, "test")
self.port = port
self.management_port = management_port
self.with_exposed_ports(self.port, self.management_port)
self.cmd = cmd

def _configure(self) -> None:
self.with_env(ADMIN_USERNAME_ENVIRONMENT_VARIABLE, self.username)
self.with_env(ADMIN_PASSWORD_ENVIRONMENT_VARIABLE, self.password)
# legacy env vars (<= 26.0.0)
self.with_env("KEYCLOAK_ADMIN", self.username)
self.with_env("KEYCLOAK_ADMIN_PASSWORD", self.password)
# Enable health checks
Expand Down Expand Up @@ -88,8 +94,6 @@ def _readiness_probe(self) -> None:
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, "Added user .* to realm .*")

def start(self) -> "KeycloakContainer":
super().start()
Expand Down
2 changes: 1 addition & 1 deletion modules/keycloak/tests/test_keycloak.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from testcontainers.keycloak import KeycloakContainer


@pytest.mark.parametrize("image_version", ["25.0", "24.0.1", "18.0"])
@pytest.mark.parametrize("image_version", ["26.0.0", "25.0", "24.0.1", "18.0"])
def test_docker_run_keycloak(image_version: str):
with KeycloakContainer(f"quay.io/keycloak/keycloak:{image_version}") as keycloak_admin:
assert keycloak_admin.get_client().users_count() == 1
Loading