Wait until container's ports are available before considering it created

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [4.0.2] - 2021-06-11
+### Fixed
+- Wait until container's ports are available before considering it created
+
 ## [4.0.0] - 2021-03-03
 ### Changed
 - Remove dependency on Wrike's internal library

pyproject.toml

@@ -1,8 +1,8 @@
 [tool.poetry]
 name = "pytest_hoverfly"
-version = "4.0.1"
+version = "4.0.2"
 description = "Simplify working with Hoverfly from pytest"
-authors = ["Devops team <[email protected]>"]
+authors = ["Devops team at Wrike <[email protected]>"]
 repository = "https://github.com/wrike/pytest-hoverfly"
 license = "MIT"
 readme = "README.md"
@@ -16,9 +16,9 @@ classifiers = [
 [tool.poetry.dependencies]
 python = "^3.7"
 pytest = ">=5.0"
-requests = "^2.22.0"
-docker = "^4.2.0"
-typing_extensions = "^3.7.4"
+requests = ">=2.22.0"
+docker = ">=4.2.0"
+typing_extensions = ">=3.7.4"
 
 [tool.poetry.dev-dependencies]
 flake8 = ">=3.7.7"
@@ -27,7 +27,7 @@ isort = ">=5.3"
 pytest-cov = ">=2.7.1"
 black = "^20.8b1"
 
-[tool.poetry.plugins] # Optional super table
+[tool.poetry.plugins]
 [tool.poetry.plugins."pytest11"]
 "hoverfly" = "pytest_hoverfly.pytest_hoverfly"
 

pytest_hoverfly/base.py

@@ -94,7 +94,7 @@ def get_container(
     )
 
     raw_container.start()
-    raw_container.reload()
+    _wait_until_ports_are_ready(raw_container, ports, timeout)
 
     container = Hoverfly.from_container(raw_container)
 
@@ -119,3 +119,21 @@ def _wait_until_ready(container: Hoverfly, timeout: float) -> None:
             delay *= 2
     else:
         raise TimeoutError(f"Container for Hoverfly did not start in {timeout}s")
+
+
+def _wait_until_ports_are_ready(raw_container: Container, ports: t.Dict[str, t.Any], timeout: float) -> None:
+    """Docker takes some time to allocate ports so they may not be immediately available."""
+    now = time.monotonic()
+    delay = 0.001
+
+    while (time.monotonic() - now) < timeout:
+        raw_container.reload()
+        # value of a port is either a None or an empty list when it's not ready
+        ready = {k: v for k, v in raw_container.ports.items() if v}
+        if set(ports).issubset(ready):
+            break
+        else:
+            time.sleep(delay)
+            delay *= 2
+    else:
+        raise TimeoutError(f"Docker failed to expose ports in {timeout}s")

pytest_hoverfly/helpers.py

@@ -43,8 +43,6 @@ def del_gcloud_credentials(pair):
 def ensure_simulation_dir(config) -> Path:
     path = get_simulations_path(config)
     if not path.exists():
-        raise ValueError(
-            "To use pytest-hoverfly you must specify " "--hoverfly-simulation-path. " f"Current value: {path}"
-        )
+        raise ValueError(f"To use pytest-hoverfly you must specify --hoverfly-simulation-path. Current value: {path}")
 
     return path

pytest_hoverfly/pytest_hoverfly.py

@@ -24,7 +24,15 @@
 
 
 class HoverflyMarker(te.Protocol):
-    def __call__(self, name: str, *, record: bool = False, stateful: bool = False) -> t.Callable[..., t.Any]:
+    def __call__(
+        self,
+        name: str,
+        *,
+        record: bool = False,
+        stateful: bool = False,
+        postprocess: t.Callable[[], t.Any],
+        enable_default_postprocessing: bool = True,
+    ) -> t.Callable[..., t.Any]:
         ...