feat(core): Added SrvContainer

Added doctest to SrcContainer and update readme

Fix issue with SrcContainer image handle

Add test for SrcContainer

Fixed doctest

Improve SrvContainer

Fix test_srv_container logs check

Improve SrvContainer and update tests

Updates for SrvContainer

Author: Tranquility2

core/README.rst

@@ -7,6 +7,8 @@ testcontainers-core
 
 .. autoclass:: testcontainers.core.image.DockerImage
 
+.. autoclass:: testcontainers.core.generic.SrvContainer
+
 Using `DockerContainer` and `DockerImage` directly:
 
 .. doctest::

core/testcontainers/core/generic.py

@@ -11,10 +11,13 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 from typing import Optional
+from urllib.error import HTTPError
 from urllib.parse import quote
+from urllib.request import urlopen
 
 from testcontainers.core.container import DockerContainer
 from testcontainers.core.exceptions import ContainerStartException
+from testcontainers.core.image import DockerImage
 from testcontainers.core.utils import raise_for_deprecated_parameter
 from testcontainers.core.waiting_utils import wait_container_is_ready
 
@@ -79,3 +82,67 @@ def _configure(self) -> None:
 
     def _transfer_seed(self) -> None:
         pass
+
+
+class SrvContainer(DockerContainer):
+    """
+    Container for a generic server that is based on a custom image.
+
+    Example:
+
+    .. doctest::
+
+        >>> import httpx
+        >>> from testcontainers.core.generic import SrvContainer
+        >>> from testcontainers.core.waiting_utils import wait_for_logs
+
+        >>> with SrvContainer(path="./core/tests/image_fixtures/python_server", port=9000, tag="test-srv:latest") as srv:
+        ...     url = srv._create_connection_url()
+        ...     response = httpx.get(f"{url}", timeout=5)
+        ...     assert response.status_code == 200, "Response status code is not 200"
+        ...     delay = wait_for_logs(srv, "GET / HTTP/1.1")
+
+
+    :param path: Path to the Dockerfile to build the image
+    :param tag: Tag for the image to be built (default: None)
+    """
+
+    def __init__(self, path: str, port: int, tag: Optional[str], image_cleanup: bool = True) -> None:
+        self.docker_image = DockerImage(path=path, tag=tag, clean_up=image_cleanup).build()
+        super().__init__(str(self.docker_image))
+        self.internal_port = port
+        self.with_exposed_ports(self.internal_port)
+
+    @wait_container_is_ready(HTTPError)
+    def _connect(self) -> None:
+        # noinspection HttpUrlsUsage
+        url = self._create_connection_url()
+        try:
+            with urlopen(url) as r:
+                assert b"" in r.read()
+        except HTTPError as e:
+            # 404 is expected, as the server may not have the specific endpoint we are looking for
+            if e.code == 404:
+                pass
+            else:
+                raise
+
+    def get_api_url(self) -> str:
+        raise NotImplementedError
+
+    def _create_connection_url(self) -> str:
+        if self._container is None:
+            raise ContainerStartException("container has not been started")
+        host = self.get_container_host_ip()
+        exposed_port = self.get_exposed_port(self.internal_port)
+        url = f"http://{host}:{exposed_port}"
+        return url
+
+    def start(self) -> "SrvContainer":
+        super().start()
+        self._connect()
+        return self
+
+    def stop(self, force=True, delete_volume=True) -> None:
+        super().stop(force, delete_volume)
+        self.docker_image.remove()

core/tests/image_fixtures/python_server/Dockerfile

@@ -0,0 +1,3 @@
+FROM python:3
+EXPOSE 9000
+CMD ["python", "-m", "http.server", "9000"]

core/tests/test_generics.py

@@ -0,0 +1,27 @@
+import pytest
+from typing import Optional
+from testcontainers.core.generic import SrvContainer
+
+import re
+
+
+@pytest.mark.parametrize("test_image_cleanup", [True, False])
+@pytest.mark.parametrize("test_image_tag", [None, "custom-image:test"])
+def test_srv_container(test_image_tag: Optional[str], test_image_cleanup: bool, check_for_image, port=9000):
+    with SrvContainer(
+        path="./core/tests/image_fixtures/python_server",
+        port=port,
+        tag=test_image_tag,
+        image_cleanup=test_image_cleanup,
+    ) as srv:
+        image_short_id = srv.docker_image.short_id
+        image_build_logs = srv.docker_image.get_logs()
+        # check if dict is in any of the logs
+        assert {"stream": f"Step 2/3 : EXPOSE {port}"} in image_build_logs, "Image logs mismatch"
+        assert (port, None) in srv.ports.items(), "Port mismatch"
+        with pytest.raises(NotImplementedError):
+            srv.get_api_url()
+        test_url = srv._create_connection_url()
+        assert re.match(r"http://localhost:\d+", test_url), "Connection URL mismatch"
+
+    check_for_image(image_short_id, test_image_cleanup)