robotframework-testcontainers 0.1.0__py3-none-any.whl

TestcontainersLibrary/__init__.py

@@ -0,0 +1 @@
+from TestcontainersLibrary.library import TestcontainersLibrary  # noqa

TestcontainersLibrary/library.py

@@ -0,0 +1,111 @@
+import importlib
+from pathlib import Path
+from robot.api.deco import library, keyword
+from robot.api import logger
+from testcontainers.core.container import DockerContainer
+from testcontainers.core.wait_strategies import LogMessageWaitStrategy, HttpWaitStrategy
+from testcontainers.generic.server import ServerContainer
+
+
+@library(listener="SELF")
+class TestcontainersLibrary:
+    def __init__(self):
+        self._containers: list[DockerContainer] = []
+
+    @keyword
+    def create_docker_container(
+        self,
+        image: str,
+        command: str | None = None,
+        env: dict[str, str] | None = None,
+        name: str | None = None,
+        ports: list[int] | None = None,
+        volumes: list[tuple[Path, str, str]] | None = None,
+        start: bool = True,
+    ) -> DockerContainer:
+        container = DockerContainer(
+            image=image,
+            command=command,
+            env=env,
+            name=name,
+            ports=ports,
+            volumes=self._resolve_volume_paths(volumes) if volumes else None,
+        )
+        if start:
+            self.start_container(container)
+        return container
+
+    def _resolve_volume_paths(
+        self, volumes: list[tuple[Path, str, str]]
+    ) -> list[tuple[str, str, str]]:
+        return [(v[0].resolve().as_posix(), v[1], v[2]) for v in volumes]
+
+    @keyword
+    def create_server_container(
+        self, port: int, image: str, start: bool = True
+    ) -> ServerContainer:
+        container = ServerContainer(port=port, image=image)
+        if start:
+            self.start_container(container)
+        return container
+
+    @keyword
+    def create_community_container(
+        self, module: str, container_class: str, start: bool = True, **kwargs
+    ) -> DockerContainer:
+        _module = importlib.import_module(module)
+        clazz = getattr(_module, container_class)
+        container = clazz(**kwargs)
+        if start:
+            self.start_container(container)
+        return container
+
+    @keyword
+    def bind_ports(
+        self, container: DockerContainer, container_port: int, host_port: int
+    ) -> DockerContainer:
+        container.with_bind_ports(container_port, host_port)
+        return container
+
+    @keyword
+    def start_container(self, container: DockerContainer) -> DockerContainer:
+        try:
+            container.start()
+            self._containers.append(container)
+            return container
+        except Exception:
+            container.stop()
+            raise
+
+    @keyword
+    def wait_for_log_message(
+        self, container: DockerContainer, message: str, times: int = 1
+    ) -> None:
+        LogMessageWaitStrategy(message, times).wait_until_ready(container)
+
+    @keyword
+    def wait_for_http_endpoint(
+        self, container: DockerContainer, port: int, path: str
+    ) -> None:
+        HttpWaitStrategy(port, path).wait_until_ready(container)
+
+    @keyword
+    def stop_container(self, container: DockerContainer) -> None:
+        self._containers.remove(container)
+        container.stop()
+
+    def _end_test(self, name, attrs) -> None:
+        for container in self._containers.copy():
+            cname = container.get_wrapped_container().name
+            logger.console(
+                f"\n\tTestcontainersLibrary: stopping container {cname} in end_test hook."
+            )
+            self.stop_container(container)
+
+    def _end_suite(self, name, attrs) -> None:
+        for container in self._containers.copy():
+            cname = container.get_wrapped_container().name
+            logger.console(
+                f"\n\tTestcontainersLibrary: stopping container {cname} in end_suite hook."
+            )
+            self.stop_container(container)

robotframework_testcontainers-0.1.0.dist-info/METADATA

@@ -0,0 +1,106 @@
+Metadata-Version: 2.3
+Name: robotframework-testcontainers
+Version: 0.1.0
+Summary: Robot Framework keywords for Testcontainers.
+Author: Andreas Finkler
+Author-email: Andreas Finkler <andi.finkler@gmail.com>
+Requires-Dist: robotframework>=7.3.2
+Requires-Dist: testcontainers[generic]>=4.13.2
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# robotframework-testcontainers
+
+Robot Framework keywords for [testcontainers](https://github.com/testcontainers/testcontainers-python).
+
+## Installation
+
+- using `pip`:
+
+```shell
+pip install robotframework-testcontainers
+```
+
+- using `uv`:
+
+```shell
+uv add robotframework-testcontainers
+```
+
+- using `poetry`:
+
+```shell
+poetry add robotframework-testcontainers
+```
+
+## Usage
+
+Starting a container can be done with a single keyword:
+
+```robot
+*** Settings ***
+Library    TestcontainersLibrary
+
+*** Test Cases ***
+Basic Usage Example
+    Create Docker Container    image=hello-world
+```
+
+`TestcontainersLibrary` keeps track of all created containers.
+It will take care of stopping all created containers at the end of the test,
+by making use of the `end_test`/`end_suite` listener methods.
+
+If you require more control, you can also manually start and stop
+the container. Additionally, you can use different wait strategies
+to wait for the container to be ready:
+
+```robot
+*** Settings ***
+Library    TestcontainersLibrary
+
+*** Test Cases ***
+Advanced Usage with more control
+    ${container}=    Create Docker Container    image=traefik/whoami    start=False    ports=[80]
+    Start Container    ${container}
+    Wait For Http Endpoint    ${container}    port=80    path=/api
+    Stop Container    ${container}
+```
+
+You can also use any of the community maintained containers.
+Be aware that you have to make sure to install the required dependencies
+yourself.  
+For example: starting a CockroachDB container requires installing `testcontainers[cockroachdb]`.
+Use the `Create Community Container` keyword and specify which class to import from which module.
+Any additional arguments can be passed in as keyword arguments.
+
+```robot
+*** Settings ***
+Library             TestcontainersLibrary
+
+
+*** Test Cases ***
+Starting an CockroachDb Container
+    ${password}=    Evaluate    str(uuid.uuid4())
+    ${container}=    Create Community Container
+    ...    module=testcontainers.cockroachdb
+    ...    container_class=CockroachDBContainer
+    ...    username=demoUser
+    ...    password=${password}
+    Log    ${container.get_connection_url()}
+```
+
+You can read the acceptance tests in `test/acceptance/` for more concrete usage examples.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+
+### Third-Party Licenses
+
+This library depends on the
+[`testcontainers-python`](https://github.com/testcontainers/testcontainers-python)
+package, which is licensed under the
+[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+No parts of `testcontainers-python` are copied or modified in this project.
+It is used only as a dependency.

robotframework_testcontainers-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+TestcontainersLibrary/__init__.py,sha256=LvjJIomJqxD4X77ehVkIrZJv1SwbLtVrgWku6xuDrs4,72
+TestcontainersLibrary/library.py,sha256=jkN27qcR3fVxo9d6trFfAfKWD0mlYOhVM4eKHYYXctM,3699
+TestcontainersLibrary/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+robotframework_testcontainers-0.1.0.dist-info/WHEEL,sha256=M6du7VZflc4UPsGphmOXHANdgk8zessdJG0DBUuoA-U,78
+robotframework_testcontainers-0.1.0.dist-info/METADATA,sha256=Ca9qG0_Hts9w_M6Tz54RQ1bnWscC1RvPY3mGtsNuCyg,3016
+robotframework_testcontainers-0.1.0.dist-info/RECORD,,

robotframework_testcontainers-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.5
+Root-Is-Purelib: true
+Tag: py3-none-any