Merge pull request #334 from tillahoffmann/doctest

tillahoffmann · web-flow · commit 35fc2476a582 · 2023-04-13T13:19:21.000-04:00
Add missing doctests.
diff --git a/compose/testcontainers/compose/__init__.py b/compose/testcontainers/compose/__init__.py
@@ -23,38 +23,20 @@ class DockerCompose:
 
         .. doctest::
 
-            compose_filename = ["docker-compose-1.yml", "docker-compose-2.yml"]
-            with DockerCompose("/home/project", compose_file_name=compose_file_name, pull=True) as \
-                    compose:
-                host = compose.get_service_host("hub", 4444)
-                port = compose.get_service_port("hub", 4444)
-                driver = webdriver.Remote(
-                    command_executor=(f"http://{host}:{port}/wd/hub"),
-                    desired_capabilities=CHROME,
-                )
-                driver.get("http://automation-remarks.com")
-                stdout, stderr = compose.get_logs()
-                if stderr:
-                    print(f"Errors\\n:{stderr}")
+            >>> from testcontainers.compose import DockerCompose
+
+            >>> compose = DockerCompose("compose/tests", compose_file_name="docker-compose-4.yml",
+            ...                         pull=True)
+            >>> with compose:
+            ...     stdout, stderr = compose.get_logs()
+            >>> b"Hello from Docker!" in stdout
+            True
 
         .. code-block:: yaml
 
-            hub:
-            image: selenium/hub
-            ports:
-            - "4444:4444"
-            firefox:
-            image: selenium/node-firefox
-            links:
-                - hub
-            expose:
-                - "5555"
-            chrome:
-            image: selenium/node-chrome
-            links:
-                - hub
-            expose:
-                - "5555"
+            services:
+              hello-world:
+                image: "hello-world"
     """
     def __init__(
             self,
diff --git a/google/testcontainers/google/pubsub.py b/google/testcontainers/google/pubsub.py
@@ -30,12 +30,13 @@ class PubSubContainer(DockerContainer):
 
         .. doctest::
 
-            def test_docker_run_pubsub():
-                config = PubSubContainer('google/cloud-sdk:emulators')
-                with config as pubsub:
-                    publisher = pubsub.get_publisher()
-                    topic_path = publisher.topic_path(pubsub.project, "my-topic")
-                    topic = publisher.create_topic(topic_path)
+            >>> from testcontainers.google import PubSubContainer
+
+            >>> config = PubSubContainer()
+            >>> with config as pubsub:
+            ...    publisher = pubsub.get_publisher_client()
+            ...    topic_path = publisher.topic_path(pubsub.project, "my-topic")
+            ...    topic = publisher.create_topic(name=topic_path)
     """
     def __init__(self, image: str = "google/cloud-sdk:emulators", project: str = "test-project",
                  port: int = 8432, **kwargs) -> None:
diff --git a/localstack/setup.py b/localstack/setup.py
@@ -11,6 +11,7 @@
     long_description_content_type="text/x-rst",
     url="https://github.com/testcontainers/testcontainers-python",
     install_requires=[
+        "boto3",
         "testcontainers-core",
     ],
     python_requires=">=3.7",
diff --git a/localstack/testcontainers/localstack/__init__.py b/localstack/testcontainers/localstack/__init__.py
@@ -10,8 +10,12 @@
 #    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 boto3
+import functools as ft
+import os
 from testcontainers.core.waiting_utils import wait_for_logs
 from testcontainers.core.container import DockerContainer
+from typing import Any, Optional
 
 
 class LocalStackContainer(DockerContainer):
@@ -24,23 +28,21 @@ class LocalStackContainer(DockerContainer):
 
             >>> from testcontainers.localstack import LocalStackContainer
 
-            >>> with LocalStackContainer(image="localstack/localstack:0.11.4") as localstack:
-            ...     localstack.with_services("dynamodb", "lambda")
-            ...     dynamo_endpoint = localstack.get_url()
-            <testcontainers.localstack.LocalStackContainer object at 0x...>
-
-        The endpoint can be used to create a client with the boto3 library:
-        .. doctest::
-
-            dynamo_client = boto3.client("dynamodb", endpoint_url=dynamo_endpoint)
-            scan_result = dynamo_client.scan(TableName='foo')
-            # Do something with the scan result
+            >>> with LocalStackContainer(image="localstack/localstack:2.0.1") as localstack:
+            ...     dynamo_client = localstack.get_client("dynamodb")
+            ...     tables = dynamo_client.list_tables()
+            >>> tables
+            {'TableNames': [], ...}
     """
-    def __init__(self, image: str = 'localstack/localstack:0.11.4', edge_port: int = 4566,
-                 **kwargs) -> None:
+    def __init__(self, image: str = 'localstack/localstack:2.0.1', edge_port: int = 4566,
+                 region_name: Optional[str] = None, **kwargs) -> None:
         super(LocalStackContainer, self).__init__(image, **kwargs)
         self.edge_port = edge_port
+        self.region_name = region_name or os.environ.get("AWS_DEFAULT_REGION", "us-west-1")
         self.with_exposed_ports(self.edge_port)
+        self.with_env("AWS_DEFAULT_REGION", self.region_name)
+        self.with_env("AWS_ACCESS_KEY_ID", "testcontainers-localstack")
+        self.with_env("AWS_SECRET_ACCESS_KEY", "testcontainers-localstack")
 
     def with_services(self, *services) -> "LocalStackContainer":
         """
@@ -64,6 +66,17 @@ def get_url(self) -> str:
         port = self.get_exposed_port(self.edge_port)
         return f'http://{host}:{port}'
 
+    @ft.wraps(boto3.client)
+    def get_client(self, name, **kwargs) -> Any:
+        kwargs_ = {
+            "endpoint_url": self.get_url(),
+            "region_name": self.region_name,
+            "aws_access_key_id": "testcontainers-localstack",
+            "aws_secret_access_key": "testcontainers-localstack",
+        }
+        kwargs_.update(kwargs)
+        return boto3.client(name, **kwargs_)
+
     def start(self, timeout: float = 60) -> "LocalStackContainer":
         super().start()
         wait_for_logs(self, r'Ready\.\n', timeout=timeout)
diff --git a/localstack/tests/test_localstack.py b/localstack/tests/test_localstack.py
@@ -10,6 +10,15 @@ def test_docker_run_localstack():
         services = json.loads(resp.read().decode())['services']
 
         # Check that all services are running
-        assert all(value == 'running' for value in services.values())
+        assert all(value == 'available' for value in services.values())
         # Check that some of the services keys
-        assert all(test_service in services.keys() for test_service in ['dynamodb', 'sns', 'sqs'])
+        assert all(test_service in services for test_service in ['dynamodb', 'sns', 'sqs'])
+
+
+def test_localstack_boto3():
+    from testcontainers.localstack import LocalStackContainer
+
+    with LocalStackContainer(image="localstack/localstack:2.0.1") as localstack:
+        dynamo_client = localstack.get_client("dynamodb")
+        tables = dynamo_client.list_tables()
+    assert tables["TableNames"] == []
diff --git a/requirements/3.10.txt b/requirements/3.10.txt
@@ -88,14 +88,20 @@ attrs==22.2.0
     #   trio
 azure-core==1.26.4
     # via azure-storage-blob
-azure-storage-blob==12.15.0
+azure-storage-blob==12.16.0
     # via testcontainers-azurite
 babel==2.12.1
     # via sphinx
 bcrypt==4.0.1
     # via paramiko
 bleach==6.0.0
     # via readme-renderer
+boto3==1.26.112
+    # via testcontainers-localstack
+botocore==1.29.112
+    # via
+    #   boto3
+    #   s3transfer
 cachetools==5.3.0
     # via google-auth
 certifi==2022.12.7
@@ -155,7 +161,7 @@ flake8==3.7.9
     # via -r requirements.in
 google-api-core[grpc]==2.11.0
     # via google-cloud-pubsub
-google-auth==2.17.2
+google-auth==2.17.3
     # via google-api-core
 google-cloud-pubsub==2.16.0
     # via testcontainers-gcp
@@ -203,6 +209,10 @@ jeepney==0.8.0
     #   secretstorage
 jinja2==3.1.2
     # via sphinx
+jmespath==1.0.1
+    # via
+    #   boto3
+    #   botocore
 jsonschema==3.2.0
     # via docker-compose
 kafka-python==2.0.2
@@ -245,7 +255,7 @@ pluggy==1.0.0
     # via pytest
 proto-plus==1.22.2
     # via google-cloud-pubsub
-protobuf==4.22.1
+protobuf==4.22.3
     # via
     #   google-api-core
     #   google-cloud-pubsub
@@ -297,6 +307,7 @@ python-arango==7.5.7
     # via testcontainers-arangodb
 python-dateutil==2.8.2
     # via
+    #   botocore
     #   opensearch-py
     #   pg8000
 python-dotenv==0.21.1
@@ -342,6 +353,8 @@ rsa==4.9
     # via
     #   google-auth
     #   python-jose
+s3transfer==0.6.0
+    # via boto3
 scramp==1.4.4
     # via pg8000
 secretstorage==3.3.3
@@ -411,6 +424,7 @@ tzlocal==4.3
     # via clickhouse-driver
 urllib3[socks]==1.26.15
     # via
+    #   botocore
     #   docker
     #   minio
     #   opensearch-py
diff --git a/requirements/3.11.txt b/requirements/3.11.txt
@@ -88,14 +88,20 @@ attrs==22.2.0
     #   trio
 azure-core==1.26.4
     # via azure-storage-blob
-azure-storage-blob==12.15.0
+azure-storage-blob==12.16.0
     # via testcontainers-azurite
 babel==2.12.1
     # via sphinx
 bcrypt==4.0.1
     # via paramiko
 bleach==6.0.0
     # via readme-renderer
+boto3==1.26.112
+    # via testcontainers-localstack
+botocore==1.29.112
+    # via
+    #   boto3
+    #   s3transfer
 cachetools==5.3.0
     # via google-auth
 certifi==2022.12.7
@@ -152,7 +158,7 @@ flake8==3.7.9
     # via -r requirements.in
 google-api-core[grpc]==2.11.0
     # via google-cloud-pubsub
-google-auth==2.17.2
+google-auth==2.17.3
     # via google-api-core
 google-cloud-pubsub==2.16.0
     # via testcontainers-gcp
@@ -200,6 +206,10 @@ jeepney==0.8.0
     #   secretstorage
 jinja2==3.1.2
     # via sphinx
+jmespath==1.0.1
+    # via
+    #   boto3
+    #   botocore
 jsonschema==3.2.0
     # via docker-compose
 kafka-python==2.0.2
@@ -242,7 +252,7 @@ pluggy==1.0.0
     # via pytest
 proto-plus==1.22.2
     # via google-cloud-pubsub
-protobuf==4.22.1
+protobuf==4.22.3
     # via
     #   google-api-core
     #   google-cloud-pubsub
@@ -294,6 +304,7 @@ python-arango==7.5.7
     # via testcontainers-arangodb
 python-dateutil==2.8.2
     # via
+    #   botocore
     #   opensearch-py
     #   pg8000
 python-dotenv==0.21.1
@@ -339,6 +350,8 @@ rsa==4.9
     # via
     #   google-auth
     #   python-jose
+s3transfer==0.6.0
+    # via boto3
 scramp==1.4.4
     # via pg8000
 secretstorage==3.3.3
@@ -404,6 +417,7 @@ tzlocal==4.3
     # via clickhouse-driver
 urllib3[socks]==1.26.15
     # via
+    #   botocore
     #   docker
     #   minio
     #   opensearch-py
diff --git a/requirements/3.7.txt b/requirements/3.7.txt
@@ -88,7 +88,7 @@ attrs==22.2.0
     #   trio
 azure-core==1.26.4
     # via azure-storage-blob
-azure-storage-blob==12.15.0
+azure-storage-blob==12.16.0
     # via testcontainers-azurite
 babel==2.12.1
     # via sphinx
@@ -100,6 +100,12 @@ bcrypt==4.0.1
     # via paramiko
 bleach==6.0.0
     # via readme-renderer
+boto3==1.26.112
+    # via testcontainers-localstack
+botocore==1.29.112
+    # via
+    #   boto3
+    #   s3transfer
 cached-property==1.5.2
     # via docker-compose
 cachetools==5.3.0
@@ -161,7 +167,7 @@ flake8==3.7.9
     # via -r requirements.in
 google-api-core[grpc]==2.11.0
     # via google-cloud-pubsub
-google-auth==2.17.2
+google-auth==2.17.3
     # via google-api-core
 google-cloud-pubsub==2.16.0
     # via testcontainers-gcp
@@ -219,6 +225,10 @@ jeepney==0.8.0
     #   secretstorage
 jinja2==3.1.2
     # via sphinx
+jmespath==1.0.1
+    # via
+    #   boto3
+    #   botocore
 jsonschema==3.2.0
     # via docker-compose
 kafka-python==2.0.2
@@ -261,7 +271,7 @@ pluggy==1.0.0
     # via pytest
 proto-plus==1.22.2
     # via google-cloud-pubsub
-protobuf==4.22.1
+protobuf==4.22.3
     # via
     #   google-api-core
     #   google-cloud-pubsub
@@ -313,6 +323,7 @@ python-arango==7.5.6
     # via testcontainers-arangodb
 python-dateutil==2.8.2
     # via
+    #   botocore
     #   opensearch-py
     #   pg8000
 python-dotenv==0.21.1
@@ -359,6 +370,8 @@ rsa==4.9
     # via
     #   google-auth
     #   python-jose
+s3transfer==0.6.0
+    # via boto3
 scramp==1.4.4
     # via pg8000
 secretstorage==3.3.3
@@ -434,6 +447,7 @@ tzlocal==4.3
     # via clickhouse-driver
 urllib3[socks]==1.26.15
     # via
+    #   botocore
     #   docker
     #   minio
     #   opensearch-py
diff --git a/requirements/3.8.txt b/requirements/3.8.txt
diff --git a/requirements/3.9.txt b/requirements/3.9.txt
