added testcontainer for RabbitMQ (#162)

* added testcontainer for RabbitMQ

Added a testcontainer for the message broker RabbitMQ.
It includes ready-to-use config params for the `pika` client library.
This library was added to the dependencies.

* Fix linting errors in RabbitMQ

* fix spelling in readme

Co-authored-by: Naomi Elstein <[email protected]>

Author: KerstenBreuer

.gitignore

@@ -63,3 +63,7 @@ docs/_build/
 .idea/
 .venv/
 .testrepository/
+
+# vscode:
+.devcontainer/
+.vscode/

README.rst

@@ -22,6 +22,7 @@ Currently available features:
 * Microsoft SQL Server container
 * Generic docker containers
 * LocalStack
+* RabbitMQ
 
 Installation
 ------------
@@ -75,4 +76,4 @@ We recommend you use a `virtual environment <https://virtualenv.pypa.io/en/stabl
 Adding requirements
 ^^^^^^^^^^^^^^^^^^^
 
-We use :code:`pip-tools` to resolve and manage dependencies. If you need to add a dependency to testcontainers or one of the extras, run :code:`pip install pip-tools` followed by :code:`make requirements` to update the requirements files.
+We use :code:`pip-tools` to resolve and manage dependencies. If you need to add a dependency to testcontainers or one of the extras, modify the :code:`setup.py` as well as the :code:`requirements.in` accordingly and then run :code:`pip install pip-tools` followed by :code:`make requirements` to update the requirements files.

requirements.in

@@ -1,4 +1,4 @@
--e file:.[docker-compose,mysql,oracle,postgresql,selenium,google-cloud-pubsub,mongo,redis,mssqlserver,neo4j,kafka]
+-e file:.[docker-compose,mysql,oracle,postgresql,selenium,google-cloud-pubsub,mongo,redis,mssqlserver,neo4j,kafka,rabbitmq]
 codecov>=2.1.0
 flake8
 pytest

requirements/3.6.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile
+# This file is autogenerated by pip-compile with python 3.6
 # To update, run:
 #
 #    pip-compile --output-file=requirements/3.6.txt requirements.in
@@ -43,13 +43,13 @@ deprecation==2.1.0
     # via testcontainers
 distro==1.5.0
     # via docker-compose
-docker-compose==1.26.2
-    # via testcontainers
 docker[ssh]==4.2.2
     # via
     #   -r requirements.in
     #   docker-compose
     #   testcontainers
+docker-compose==1.26.2
+    # via testcontainers
 dockerpty==0.4.1
     # via docker-compose
 docopt==0.6.2
@@ -91,7 +91,8 @@ jinja2==2.11.2
     # via sphinx
 jsonschema==3.2.0
     # via docker-compose
-kafka-python==2.0.2       # via testcontainers
+kafka-python==2.0.2
+    # via testcontainers
 markupsafe==1.1.1
     # via jinja2
 mccabe==0.6.1
@@ -107,6 +108,8 @@ packaging==20.4
     #   sphinx
 paramiko==2.7.1
     # via docker
+pika==1.2.0
+    # via testcontainers
 pluggy==0.13.1
     # via pytest
 protobuf==3.13.0
@@ -117,12 +120,12 @@ psycopg2-binary==2.8.5
     # via testcontainers
 py==1.9.0
     # via pytest
-pyasn1-modules==0.2.8
-    # via google-auth
 pyasn1==0.4.8
     # via
     #   pyasn1-modules
     #   rsa
+pyasn1-modules==0.2.8
+    # via google-auth
 pycodestyle==2.6.0
     # via flake8
 pycparser==2.20
@@ -143,12 +146,12 @@ pyparsing==2.4.7
     # via packaging
 pyrsistent==0.16.0
     # via jsonschema
-pytest-cov==2.10.1
-    # via -r requirements.in
 pytest==6.0.1
     # via
     #   -r requirements.in
     #   pytest-cov
+pytest-cov==2.10.1
+    # via -r requirements.in
 python-dotenv==0.14.0
     # via docker-compose
 pytz==2020.1

requirements/3.7.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile
+# This file is autogenerated by pip-compile with python 3.7
 # To update, run:
 #
 #    pip-compile --output-file=requirements/3.7.txt requirements.in
@@ -43,13 +43,13 @@ deprecation==2.1.0
     # via testcontainers
 distro==1.5.0
     # via docker-compose
-docker-compose==1.26.2
-    # via testcontainers
 docker[ssh]==4.2.2
     # via
     #   -r requirements.in
     #   docker-compose
     #   testcontainers
+docker-compose==1.26.2
+    # via testcontainers
 dockerpty==0.4.1
     # via docker-compose
 docopt==0.6.2
@@ -91,7 +91,8 @@ jinja2==2.11.2
     # via sphinx
 jsonschema==3.2.0
     # via docker-compose
-kafka-python==2.0.2       # via testcontainers
+kafka-python==2.0.2
+    # via testcontainers
 markupsafe==1.1.1
     # via jinja2
 mccabe==0.6.1
@@ -107,6 +108,8 @@ packaging==20.4
     #   sphinx
 paramiko==2.7.1
     # via docker
+pika==1.2.0
+    # via testcontainers
 pluggy==0.13.1
     # via pytest
 protobuf==3.13.0
@@ -117,12 +120,12 @@ psycopg2-binary==2.8.5
     # via testcontainers
 py==1.9.0
     # via pytest
-pyasn1-modules==0.2.8
-    # via google-auth
 pyasn1==0.4.8
     # via
     #   pyasn1-modules
     #   rsa
+pyasn1-modules==0.2.8
+    # via google-auth
 pycodestyle==2.6.0
     # via flake8
 pycparser==2.20
@@ -143,12 +146,12 @@ pyparsing==2.4.7
     # via packaging
 pyrsistent==0.16.0
     # via jsonschema
-pytest-cov==2.10.1
-    # via -r requirements.in
 pytest==6.0.1
     # via
     #   -r requirements.in
     #   pytest-cov
+pytest-cov==2.10.1
+    # via -r requirements.in
 python-dotenv==0.14.0
     # via docker-compose
 pytz==2020.1

requirements/3.8.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile
+# This file is autogenerated by pip-compile with python 3.8
 # To update, run:
 #
 #    pip-compile --output-file=requirements/3.8.txt requirements.in
@@ -43,13 +43,13 @@ deprecation==2.1.0
     # via testcontainers
 distro==1.5.0
     # via docker-compose
-docker-compose==1.26.2
-    # via testcontainers
 docker[ssh]==4.2.2
     # via
     #   -r requirements.in
     #   docker-compose
     #   testcontainers
+docker-compose==1.26.2
+    # via testcontainers
 dockerpty==0.4.1
     # via docker-compose
 docopt==0.6.2
@@ -85,7 +85,8 @@ jinja2==2.11.2
     # via sphinx
 jsonschema==3.2.0
     # via docker-compose
-kafka-python==2.0.2       # via testcontainers
+kafka-python==2.0.2
+    # via testcontainers
 markupsafe==1.1.1
     # via jinja2
 mccabe==0.6.1
@@ -101,6 +102,8 @@ packaging==20.4
     #   sphinx
 paramiko==2.7.1
     # via docker
+pika==1.2.0
+    # via testcontainers
 pluggy==0.13.1
     # via pytest
 protobuf==3.13.0
@@ -111,12 +114,12 @@ psycopg2-binary==2.8.5
     # via testcontainers
 py==1.9.0
     # via pytest
-pyasn1-modules==0.2.8
-    # via google-auth
 pyasn1==0.4.8
     # via
     #   pyasn1-modules
     #   rsa
+pyasn1-modules==0.2.8
+    # via google-auth
 pycodestyle==2.6.0
     # via flake8
 pycparser==2.20
@@ -137,12 +140,12 @@ pyparsing==2.4.7
     # via packaging
 pyrsistent==0.16.0
     # via jsonschema
-pytest-cov==2.10.1
-    # via -r requirements.in
 pytest==6.0.1
     # via
     #   -r requirements.in
     #   pytest-cov
+pytest-cov==2.10.1
+    # via -r requirements.in
 python-dotenv==0.14.0
     # via docker-compose
 pytz==2020.1

setup.py

@@ -63,7 +63,8 @@
         'redis': ['redis'],
         'mssqlserver': ['pyodbc'],
         'neo4j': ['neo4j'],
-        'kafka': ['kafka-python']
+        'kafka': ['kafka-python'],
+        'rabbitmq': ['pika'],
     },
     long_description_content_type="text/x-rst",
     long_description=long_description,

testcontainers/rabbitmq.py

@@ -0,0 +1,88 @@
+import os
+from typing import Optional
+
+import pika
+from testcontainers.core.container import DockerContainer
+from testcontainers.core.waiting_utils import wait_container_is_ready
+
+
+class RabbitMqContainer(DockerContainer):
+    """
+    Test container for RabbitMQ.
+
+    Example
+    -------
+    The example spins up a RabbitMQ broker and uses the `pika` client library
+    (https://pypi.org/project/pika/) establish a connection to the broker.
+    ::
+        from testcontainer.rabbitmq import RabbitMqContainer
+        import pika
+
+        with RabbitMqContainer("rabbitmq:3.9.10") as rabbitmq:
+
+            connection = pika.BlockingConnection(rabbitmq.get_connection_params())
+            channel = connection.channel()
+    """
+
+    RABBITMQ_NODE_PORT = os.environ.get("RABBITMQ_NODE_PORT", 5672)
+    RABBITMQ_DEFAULT_USER = os.environ.get("RABBITMQ_DEFAULT_USER", "guest")
+    RABBITMQ_DEFAULT_PASS = os.environ.get("RABBITMQ_DEFAULT_PASS", "guest")
+
+    def __init__(
+        self,
+        image: str = "rabbitmq:latest",
+        port: Optional[int] = None,
+        username: Optional[str] = None,
+        password: Optional[str] = None,
+    ) -> None:
+        """Initialize the RabbitMQ test container.
+
+        Args:
+            image (str, optional):
+                The docker image from docker hub. Defaults to "rabbitmq:latest".
+            port (int, optional):
+                The port to reach the AMQP API. Defaults to 5672.
+            username (str, optional):
+                Overwrite the default username which is "guest".
+            password (str, optional):
+                Overwrite the default username which is "guest".
+        """
+        super(RabbitMqContainer, self).__init__(image=image)
+        self.RABBITMQ_NODE_PORT = port or int(self.RABBITMQ_NODE_PORT)
+        self.RABBITMQ_DEFAULT_USER = username or self.RABBITMQ_DEFAULT_USER
+        self.RABBITMQ_DEFAULT_PASS = password or self.RABBITMQ_DEFAULT_PASS
+
+        self.with_exposed_ports(self.RABBITMQ_NODE_PORT)
+        self.with_env("RABBITMQ_NODE_PORT", self.RABBITMQ_NODE_PORT)
+        self.with_env("RABBITMQ_DEFAULT_USER", self.RABBITMQ_DEFAULT_USER)
+        self.with_env("RABBITMQ_DEFAULT_PASS", self.RABBITMQ_DEFAULT_PASS)
+
+    @wait_container_is_ready()
+    def readiness_probe(self) -> bool:
+        """Test if the RabbitMQ broker is ready."""
+        connection = pika.BlockingConnection(self.get_connection_params())
+        if connection.is_open:
+            connection.close()
+            return self
+        raise RuntimeError("Could not open connection to RabbitMQ broker.")
+
+    def get_connection_params(self) -> pika.ConnectionParameters:
+        """
+        Get connection params as a pika.ConnectionParameters object.
+        For more details see:
+        https://pika.readthedocs.io/en/latest/modules/parameters.html
+        """
+        credentials = pika.PlainCredentials(username=self.RABBITMQ_DEFAULT_USER,
+                                            password=self.RABBITMQ_DEFAULT_PASS)
+
+        return pika.ConnectionParameters(
+            host=self.get_container_host_ip(),
+            port=self.get_exposed_port(self.RABBITMQ_NODE_PORT),
+            credentials=credentials,
+        )
+
+    def start(self):
+        """Start the test container."""
+        super().start()
+        self.readiness_probe()
+        return self

tests/test_rabbitmq.py

@@ -0,0 +1,54 @@
+from typing import Optional
+import json
+
+import pika
+import pytest
+from testcontainers.rabbitmq import RabbitMqContainer
+
+QUEUE = "test-q"
+EXCHANGE = "test-exchange"
+ROUTING_KEY = "test-route-key"
+MESSAGE = {"hello": "world"}
+
+
+@pytest.mark.parametrize(
+    "port,username,password",
+    [
+        (None, None, None),  # use the defaults
+        (5673, None, None),  # test with custom port
+        (None, "my_test_user", "my_secret_password"),  # test with custom credentials
+    ]
+)
+def test_docker_run_rabbitmq(
+    port: Optional[int],
+    username: Optional[str],
+    password: Optional[str]
+):
+    """Run rabbitmq test container and use it to deliver a simple message."""
+    kwargs = {}
+    if port is not None:
+        kwargs["port"] = port
+    if username is not None:
+        kwargs["username"] = username
+    if password is not None:
+        kwargs["password"] = password
+
+    rabbitmq_container = RabbitMqContainer("rabbitmq:latest", **kwargs)
+    with rabbitmq_container as rabbitmq:
+        # connect to rabbitmq:
+        connection_params = rabbitmq.get_connection_params()
+        connection = pika.BlockingConnection(connection_params)
+
+        # create exchange and queue:
+        channel = connection.channel()
+        channel.exchange_declare(exchange=EXCHANGE, exchange_type="topic")
+        channel.queue_declare(QUEUE, arguments={})
+        channel.queue_bind(QUEUE, EXCHANGE, ROUTING_KEY)
+
+        # pulish message:
+        encoded_message = json.dumps(MESSAGE)
+        channel.basic_publish(EXCHANGE, ROUTING_KEY, body=encoded_message)
+
+        _, _, body = channel.basic_get(queue=QUEUE)
+        received_message = json.loads(body.decode())
+        assert received_message == MESSAGE