Merge pull request #205 from timbmg/keycloak

Add support for Keycloak

Author: tillahoffmann

.github/workflows/main.yml

@@ -29,6 +29,7 @@ jobs:
           - redis.py
           - selenium.py
           - webdriver.py
+          - keycloak.py
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2

README.rst

@@ -24,6 +24,7 @@ Currently available features:
 * Generic docker containers
 * LocalStack
 * RabbitMQ
+* Keycloak
 
 Installation
 ------------

requirements.in

@@ -1,4 +1,4 @@
--e file:.[docker-compose,mysql,oracle,postgresql,selenium,google-cloud-pubsub,mongo,redis,mssqlserver,neo4j,kafka,rabbitmq,clickhouse]
+-e file:.[docker-compose,mysql,oracle,postgresql,selenium,google-cloud-pubsub,mongo,redis,mssqlserver,neo4j,kafka,rabbitmq,clickhouse,keycloak]
 codecov>=2.1.0
 cryptography<37
 flake8<3.8.0  # 3.8.0 adds a dependency on importlib-metadata which conflicts with other packages.

requirements/3.10.txt

@@ -73,6 +73,8 @@ docopt==0.6.2
     # via docker-compose
 docutils==0.17.1
     # via sphinx
+ecdsa==0.17.0
+    # via python-jose
 entrypoints==0.3
     # via flake8
 flake8==3.7.9
@@ -151,6 +153,7 @@ py==1.11.0
 pyasn1==0.4.8
     # via
     #   pyasn1-modules
+    #   python-jose
     #   rsa
 pyasn1-modules==0.2.8
     # via google-auth
@@ -186,6 +189,10 @@ pytest-cov==3.0.0
     # via -r requirements.in
 python-dotenv==0.20.0
     # via docker-compose
+python-jose==3.3.0
+    # via python-keycloak
+python-keycloak==0.27.0
+    # via testcontainers
 pytz==2022.1
     # via
     #   babel
@@ -195,24 +202,28 @@ pytz-deprecation-shim==0.1.0.post0
     # via tzlocal
 pyyaml==5.4.1
     # via docker-compose
-redis==4.2.2
+redis==4.3.0
     # via testcontainers
 requests==2.27.1
     # via
     #   codecov
     #   docker
     #   docker-compose
     #   google-api-core
+    #   python-keycloak
     #   sphinx
 rsa==4.8
-    # via google-auth
+    # via
+    #   google-auth
+    #   python-jose
 scramp==1.4.1
     # via pg8000
-selenium==4.1.4
+selenium==4.1.5
     # via testcontainers
 six==1.16.0
     # via
     #   dockerpty
+    #   ecdsa
     #   google-auth
     #   grpcio
     #   jsonschema

requirements/3.6.txt

@@ -69,6 +69,8 @@ docopt==0.6.2
     # via docker-compose
 docutils==0.17.1
     # via sphinx
+ecdsa==0.17.0
+    # via python-jose
 entrypoints==0.3
     # via flake8
 flake8==3.7.9
@@ -150,6 +152,7 @@ py==1.11.0
 pyasn1==0.4.8
     # via
     #   pyasn1-modules
+    #   python-jose
     #   rsa
 pyasn1-modules==0.2.8
     # via google-auth
@@ -181,6 +184,10 @@ pytest-cov==3.0.0
     # via -r requirements.in
 python-dotenv==0.20.0
     # via docker-compose
+python-jose==3.3.0
+    # via python-keycloak
+python-keycloak==0.27.0
+    # via testcontainers
 pytz==2022.1
     # via
     #   babel
@@ -198,16 +205,20 @@ requests==2.27.1
     #   docker
     #   docker-compose
     #   google-api-core
+    #   python-keycloak
     #   sphinx
 rsa==4.8
-    # via google-auth
+    # via
+    #   google-auth
+    #   python-jose
 scramp==1.4.1
     # via pg8000
 selenium==3.141.0
     # via testcontainers
 six==1.16.0
     # via
     #   dockerpty
+    #   ecdsa
     #   google-auth
     #   grpcio
     #   jsonschema

requirements/3.7.txt

@@ -79,6 +79,8 @@ docopt==0.6.2
     # via docker-compose
 docutils==0.17.1
     # via sphinx
+ecdsa==0.17.0
+    # via python-jose
 entrypoints==0.3
     # via flake8
 flake8==3.7.9
@@ -165,6 +167,7 @@ py==1.11.0
 pyasn1==0.4.8
     # via
     #   pyasn1-modules
+    #   python-jose
     #   rsa
 pyasn1-modules==0.2.8
     # via google-auth
@@ -200,6 +203,10 @@ pytest-cov==3.0.0
     # via -r requirements.in
 python-dotenv==0.20.0
     # via docker-compose
+python-jose==3.3.0
+    # via python-keycloak
+python-keycloak==0.27.0
+    # via testcontainers
 pytz==2022.1
     # via
     #   babel
@@ -217,16 +224,20 @@ requests==2.27.1
     #   docker
     #   docker-compose
     #   google-api-core
+    #   python-keycloak
     #   sphinx
 rsa==4.8
-    # via google-auth
+    # via
+    #   google-auth
+    #   python-jose
 scramp==1.4.1
     # via pg8000
 selenium==4.1.3
     # via testcontainers
 six==1.16.0
     # via
     #   dockerpty
+    #   ecdsa
     #   google-auth
     #   grpcio
     #   jsonschema

requirements/3.8.txt

@@ -77,6 +77,8 @@ docopt==0.6.2
     # via docker-compose
 docutils==0.17.1
     # via sphinx
+ecdsa==0.17.0
+    # via python-jose
 entrypoints==0.3
     # via flake8
 flake8==3.7.9
@@ -157,6 +159,7 @@ py==1.11.0
 pyasn1==0.4.8
     # via
     #   pyasn1-modules
+    #   python-jose
     #   rsa
 pyasn1-modules==0.2.8
     # via google-auth
@@ -192,6 +195,10 @@ pytest-cov==3.0.0
     # via -r requirements.in
 python-dotenv==0.20.0
     # via docker-compose
+python-jose==3.3.0
+    # via python-keycloak
+python-keycloak==0.27.0
+    # via testcontainers
 pytz==2022.1
     # via
     #   babel
@@ -209,16 +216,20 @@ requests==2.27.1
     #   docker
     #   docker-compose
     #   google-api-core
+    #   python-keycloak
     #   sphinx
 rsa==4.8
-    # via google-auth
+    # via
+    #   google-auth
+    #   python-jose
 scramp==1.4.1
     # via pg8000
 selenium==4.1.3
     # via testcontainers
 six==1.16.0
     # via
     #   dockerpty
+    #   ecdsa
     #   google-auth
     #   grpcio
     #   jsonschema

requirements/3.9.txt

@@ -73,6 +73,8 @@ docopt==0.6.2
     # via docker-compose
 docutils==0.17.1
     # via sphinx
+ecdsa==0.17.0
+    # via python-jose
 entrypoints==0.3
     # via flake8
 flake8==3.7.9
@@ -153,6 +155,7 @@ py==1.11.0
 pyasn1==0.4.8
     # via
     #   pyasn1-modules
+    #   python-jose
     #   rsa
 pyasn1-modules==0.2.8
     # via google-auth
@@ -188,6 +191,10 @@ pytest-cov==3.0.0
     # via -r requirements.in
 python-dotenv==0.20.0
     # via docker-compose
+python-jose==3.3.0
+    # via python-keycloak
+python-keycloak==0.27.0
+    # via testcontainers
 pytz==2022.1
     # via
     #   babel
@@ -205,16 +212,20 @@ requests==2.27.1
     #   docker
     #   docker-compose
     #   google-api-core
+    #   python-keycloak
     #   sphinx
 rsa==4.8
-    # via google-auth
+    # via
+    #   google-auth
+    #   python-jose
 scramp==1.4.1
     # via pg8000
 selenium==4.1.3
     # via testcontainers
 six==1.16.0
     # via
     #   dockerpty
+    #   ecdsa
     #   google-auth
     #   grpcio
     #   jsonschema

setup.py

@@ -66,6 +66,7 @@
         'kafka': ['kafka-python'],
         'rabbitmq': ['pika'],
         'clickhouse': ['clickhouse-driver'],
+        'keycloak': ['python-keycloak'],
     },
     long_description_content_type="text/x-rst",
     long_description=long_description,

testcontainers/keycloak.py

@@ -0,0 +1,74 @@
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+import os
+import requests
+
+from keycloak import KeycloakAdmin
+
+from testcontainers.core.container import DockerContainer
+from testcontainers.core.waiting_utils import wait_container_is_ready
+
+
+class KeycloakContainer(DockerContainer):
+    """
+    Keycloak container.
+
+    Example
+    -------
+    ::
+
+        with KeycloakContainer() as kc:
+            keycloak: KeycloakAdmin = kc.get_client()
+    """
+    KEYCLOAK_USER = os.environ.get("KEYCLOAK_USER", "test")
+    KEYCLOAK_PASSWORD = os.environ.get("KEYCLOAK_PASSWORD", "test")
+
+    def __init__(self, image="jboss/keycloak:latest"):
+        super(KeycloakContainer, self).__init__(image=image)
+        self.port_to_expose = 8080
+        self.with_exposed_ports(self.port_to_expose)
+
+    def _configure(self):
+        self.with_env("KEYCLOAK_USER", self.KEYCLOAK_USER)
+        self.with_env("KEYCLOAK_PASSWORD", self.KEYCLOAK_PASSWORD)
+
+    def get_url(self):
+        host = self.get_container_host_ip()
+        port = self.get_exposed_port(self.port_to_expose)
+        return "http://{}:{}".format(host, port)
+
+    @wait_container_is_ready(requests.exceptions.ConnectionError, requests.exceptions.ReadTimeout)
+    def _connect(self):
+        url = self.get_url()
+        response = requests.get("{}/auth".format(url), timeout=1)
+        response.raise_for_status()
+
+    def start(self):
+        self._configure()
+        super().start()
+        self._connect()
+        return self
+
+    def get_client(self, **kwargs):
+        default_kwargs = dict(
+                server_url="{}/auth/".format(self.get_url()),
+                username=self.KEYCLOAK_USER,
+                password=self.KEYCLOAK_PASSWORD,
+                realm_name="master",
+                verify=True,
+            )
+        kwargs = {
+            **default_kwargs,
+            **kwargs
+        }
+        return KeycloakAdmin(**kwargs)

tests/test_keycloak.py

@@ -0,0 +1,9 @@
+import pytest
+
+from testcontainers.keycloak import KeycloakContainer
+
+
+@pytest.mark.parametrize(["version"], [("16.1.1", )])
+def test_docker_run_keycloak(version):
+    with KeycloakContainer('jboss/keycloak:{}'.format(version)) as kc:
+        kc.get_client().users_count()