testcontainers / testcontainers/testcontainers-python
Bug: Keycloak container fails with 'HTTPS required'
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.3k
- Forks
- 386
- Avg merge
- 4h 40m
- Merged PRs (30d)
- 1
Description
Describe the bug
The basic example from Keycloak does not run.
There is actually another "solvable" bug that the library python-keycloak does not work on version 5.7.1 due to a missing import (KeycloakClient), and must be downgraded to 5.6.0
To Reproduce
I have used the exact example provided in the source code here:
from testcontainers.keycloak import KeycloakContainer
def test_keycloak_setup():
with KeycloakContainer(f"quay.io/keycloak/keycloak:25.0.4") as keycloak:
counts = keycloak.get_client().users_count()
print(counts)
I have also tried the example on the repo example_basic.py, and this one also does not run, but fails early since the API for the library has changed.
I understand that keycloak is sometimes a pain to setup with insecure options, and probably it needs extra options, but it's unclear from the docs that that is the case. Docs here:
https://testcontainers-python.readthedocs.io/en/latest/modules/keycloak/README.html
I could offer my help to tackle the issue for a working solution, the question is if the change is for documentation (keycloak is not expected to work out of the box) or configuration. It's also possible that it needs a realm import.
Runtime environment
# Get the operating system information (on a unix os).
$ uname -a
Darwin
# Get the python version.
$ python --version
3.10.11
# Get the docker version and other docker information.
$ docker info
Client:
Version: 28.3.2
Context: desktop-linux
Debug Mode: false
# Get all python packages.
$ pip freeze
testcontainers==4.12.0
python-keycloak==5.6.0
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with modules/keycloak/testcontainers/keycloak/init.py and modules/keycloak/example_basic.py, then reproduce the failure using Keycloak 25.0.4 and python-keycloak 5.6.0. Check the Keycloak README linked in the issue and determine whether the working setup requires configuration or documentation changes; done means the basic example runs successfully and the required setup is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, python
- Domain
- authentication, testing
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100