Add get_client to LocalStackContainer and fix doctests.

Author: tillahoffmann

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",

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,28 +28,21 @@ class LocalStackContainer(DockerContainer):
 
             >>> from testcontainers.localstack import LocalStackContainer
 
-            >>> with LocalStackContainer(image="localstack/localstack:0.11.4") as localstack:
-            ...     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::
-
-            >>> import boto3
-            >>> from testcontainers.localstack import LocalStackContainer
-
-            >>> with LocalStackContainer(image="localstack/localstack:0.11.4") as localstack:
-            ...     dynamo_endpoint = localstack.get_url()
-            ...     dynamo_client = boto3.client("dynamodb", endpoint_url=dynamo_endpoint,
-            ...                                  region_name="us-west-1")
-            ...     scan_result = dynamo_client.scan(TableName='foo')
+            >>> 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":
         """
@@ -69,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)

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"] == []

requirements.in

@@ -21,7 +21,6 @@
 -e file:rabbitmq
 -e file:redis
 -e file:selenium
-boto3  # Required for localstack doctest.
 cryptography<37
 flake8<3.8.0  # 3.8.0 adds a dependency on importlib-metadata which conflicts with other packages.
 pg8000

requirements/3.10.txt

@@ -97,7 +97,7 @@ bcrypt==4.0.1
 bleach==6.0.0
     # via readme-renderer
 boto3==1.26.112
-    # via -r requirements.in
+    # via testcontainers-localstack
 botocore==1.29.112
     # via
     #   boto3

requirements/3.11.txt

@@ -97,7 +97,7 @@ bcrypt==4.0.1
 bleach==6.0.0
     # via readme-renderer
 boto3==1.26.112
-    # via -r requirements.in
+    # via testcontainers-localstack
 botocore==1.29.112
     # via
     #   boto3

requirements/3.7.txt

@@ -101,7 +101,7 @@ bcrypt==4.0.1
 bleach==6.0.0
     # via readme-renderer
 boto3==1.26.112
-    # via -r requirements.in
+    # via testcontainers-localstack
 botocore==1.29.112
     # via
     #   boto3

requirements/3.8.txt

@@ -101,7 +101,7 @@ bcrypt==4.0.1
 bleach==6.0.0
     # via readme-renderer
 boto3==1.26.112
-    # via -r requirements.in
+    # via testcontainers-localstack
 botocore==1.29.112
     # via
     #   boto3

requirements/3.9.txt

@@ -97,7 +97,7 @@ bcrypt==4.0.1
 bleach==6.0.0
     # via readme-renderer
 boto3==1.26.112
-    # via -r requirements.in
+    # via testcontainers-localstack
 botocore==1.29.112
     # via
     #   boto3