Add Google Cloud PubSub emulator container. (#30)

Author: tillahoffmann

Pipfile

@@ -22,4 +22,4 @@ pymongo = "*"
 selenium = "*"
 sqlalchemy = "*"
 pymysql = "*"
-
+google-cloud-pubsub = "*"

Pipfile.lock

@@ -0,0 +1,18 @@
+Google Cloud Emulators
+======================
+
+Allows to spin up google cloud emulators, such as PubSub.
+
+PubSub example
+--------------
+
+::
+
+    def test_docker_run_pubsub():
+        config = PubSubContainer('google/cloud-sdk:latest')
+        with config as pubsub:
+            publisher = pubsub.get_publisher()
+            topic_path = publisher.topic_path(pubsub.project, "my-topic")
+            topic = publisher.create_topic(topic_path)
+
+The example will spin up a Google Cloud PubSub emulator that you can use for integration tests. The :code:`pubsub` instance provides convenience methods :code:`get_publisher` and :code:`get_subscriber` to connect to the emulator without having to set the environment variable :code:`PUBSUB_EMULATOR_HOST`.

docs/google-cloud-emulators.rst

@@ -13,6 +13,7 @@ Currently available features:
 - Selenim Standalone containers
 - MySql db container
 - PostgreSQL db container
+- Google Cloud PubSub emulator container
 - Generic Docker containers
 
 Installation
@@ -28,8 +29,9 @@ and can be installed using pip, depending on which containers you need:
    pip install testcontainers[mysql]
    pip install testcontainers[postgresql]
    pip install testcontainers[selenium]
+   pip install testcontainers[google-cloud-pubsub]
    # or with multiple
-   pip install testcontainers[mysql,postgresql,selenium]
+   pip install testcontainers[mysql,postgresql,selenium,google-cloud-pubsub]
 
 
 Compatibility
@@ -47,5 +49,6 @@ Usage modes
 
    Database containers <database>
    Selenium containers <selenium>
-   Generic containers <generic> 
+   Generic containers <generic>
    Docker Compose <compose>
+   Google Cloud Emulators <google-cloud-emulators>

docs/index.rst

@@ -1,7 +1,7 @@
 Release process
 ===============
 
-Run tests on target brunch
+Run tests on target branch
 --------------------------
 
 Steps::
@@ -67,5 +67,3 @@ Submit release to PYPI
 Steps::
 
     twine dist/* upload
-
-

release-process.rst

@@ -48,5 +48,6 @@
         'mysql': ['sqlalchemy', 'pymysql'],
         'postgresql': ['sqlalchemy', 'psycopg2'],
         'selenium': ['selenium==2.53.1'],
+        'google-cloud-pubsub': ['google-cloud-pubsub'],
     }
 )

setup.py

@@ -0,0 +1 @@
+from .pubsub import PubSubContainer

testcontainers/google/__init__.py

@@ -0,0 +1,47 @@
+#
+#    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
+
+from ..core.generic import GenericContainer
+
+
+class PubSubContainer(GenericContainer):
+    def __init__(self, image="google/cloud-sdk:latest",
+                 project="test-project", port=8432):
+        super(PubSubContainer, self).__init__(image=image)
+        self.project = project
+        self.port = port
+        self.with_exposed_ports(self.port)
+        self.with_command("gcloud beta emulators pubsub start --project="
+                          "{project} --host-port=0.0.0.0:{port}".format(
+                              project=self.project, port=self.port,
+                          ))
+
+    def get_pubsub_emulator_host(self):
+        return "{host}:{port}".format(host=self.get_container_host_ip(),
+                                      port=self.get_exposed_port(self.port))
+
+    def _get_channel(self, channel=None):
+        if channel is None:
+            import grpc
+            return grpc.insecure_channel(target=self.get_pubsub_emulator_host())
+
+    def get_publisher_client(self, **kwargs):
+        from google.cloud import pubsub
+        kwargs['channel'] = self._get_channel(kwargs.get('channel'))
+        return pubsub.PublisherClient(**kwargs)
+
+    def get_subscriber_client(self, **kwargs):
+        from google.cloud import pubsub
+        kwargs['channel'] = self._get_channel(kwargs.get('channel'))
+        return pubsub.SubscriberClient(**kwargs)

testcontainers/google/pubsub.py

@@ -0,0 +1,27 @@
+from testcontainers.google import PubSubContainer
+from queue import Queue
+
+
+def test_pubsub_container():
+    with PubSubContainer() as pubsub:
+        import time; time.sleep(5)
+        # Create a new topic
+        publisher = pubsub.get_publisher_client()
+        topic_path = publisher.topic_path(pubsub.project, "my-topic")
+        publisher.create_topic(topic_path)
+
+        # Create a subscription
+        subscriber = pubsub.get_subscriber_client()
+        subscription_path = subscriber.subscription_path(pubsub.project,
+                                                         "my-subscription")
+        subscriber.create_subscription(subscription_path, topic_path)
+
+        # Publish a message
+        publisher.publish(topic_path, b"Hello world!")
+
+        # Receive the message
+        queue = Queue()
+        subscriber.subscribe(subscription_path, queue.put)
+        message = queue.get(timeout=1)
+        assert message.data == b"Hello world!"
+        message.ack()