Add hoverfly startup timeout option

Author: Artem Korzhenevskii

.github/workflows/main.yml

@@ -14,7 +14,7 @@ jobs:
 
     services:
       hoverfly:
-        image: spectolabs/hoverfly:v1.3.6
+        image: spectolabs/hoverfly:v1.3.7
         ports:
           - 8500:8500
           - 8888:8888

CHANGELOG.md

@@ -4,6 +4,15 @@ 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).
 
+## [5.0.4] - 2023-01-28
+### Changed
+- Allow specifying hoverfly startup timeout
+- Increased default hoverfly startup timeout
+
+## [5.0.3] - 2022-08-31
+### Changed
+- Bumped default Hoverfly image to 1.3.7 to support Apple silicon
+
 ## [5.0.2] - 2022-03-28
 ### Changed
 - Bumped default Hoverfly image to 1.3.6

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pytest_hoverfly"
-version = "5.0.3"
+version = "5.0.4"
 description = "Simplify working with Hoverfly from pytest"
 authors = ["Devops team at Wrike <[email protected]>"]
 repository = "https://github.com/wrike/pytest-hoverfly"
@@ -21,9 +21,9 @@ docker = ">=5.0.3"
 typing_extensions = ">=3.7.4"
 
 [tool.poetry.dev-dependencies]
-flake8 = ">=3.7.7"
+flake8 = "^5.0.4"
 toml = ">=0.10"
-isort = ">=5.3"
+isort = "^5.11"
 pytest-cov = ">=2.7.1"
 black = "^22.8.0"
 

pytest_hoverfly/base.py

@@ -73,7 +73,7 @@ def get_container(
     container_name: t.Optional[str] = None,
     ports: t.Optional[t.Dict[str, t.Optional[t.List[t.Dict[str, int]]]]] = None,
     image: str = IMAGE,
-    timeout: float = 3.0,
+    timeout: float = 30.0,
     docker_factory: t.Callable[[], DockerClient] = DockerClient.from_env,
     create_container_kwargs: t.Optional[t.Mapping[str, t.Any]] = None,
 ):

pytest_hoverfly/pytest_hoverfly.py

@@ -59,6 +59,18 @@ def pytest_addoption(parser):
         type=Path,
     )
 
+    parser.addoption(
+        "--hoverfly-start-timeout",
+        dest="hoverfly_start_timeout",
+        default=30.0,
+        help=(
+            "Timeout used while starting the container. "
+            "It's used two times: waiting for ports to start accepting connections "
+            "and waiting for endpoints to start handling requests."
+        ),
+        type=float,
+    )
+
     parser.addoption(
         "--hoverfly-args",
         dest="hoverfly_args",
@@ -151,6 +163,7 @@ def hoverfly_instance(request) -> Hoverfly:
     yield from get_container(
         create_container_kwargs={"command": request.config.option.hoverfly_args},
         image=request.config.option.hoverfly_image,
+        timeout=request.config.option.hoverfly_start_timeout,
     )
 
 

tests/test_pytest_hoverfly.py

@@ -107,20 +107,18 @@ def test_hoverfly_decorator_recorder(testdir, tmpdir):
     # create a temporary pytest test file
     testdir.makepyfile(
         """
-        from unittest.mock import ANY
-        import pytest
-        import requests
-        from pytest_hoverfly import hoverfly
-
-        @hoverfly('foaas_version_simulation', record=True)
-        def test_stateful_simulation_recorder():
-            resp = requests.get(
-                'https://foaas.com/version',
-                headers={'Accept': 'application/json'},
+from unittest.mock import ANY
+import requests
+from pytest_hoverfly import hoverfly
 
-            )
+@hoverfly('foaas_version_simulation', record=True)
+def test_stateful_simulation_recorder():
+    resp = requests.get(
+        'https://foaas.com/version',
+        headers={'Accept': 'application/json'},
+    )
 
-            assert resp.json() == {'message': ANY, 'subtitle': 'FOAAS'}
+    assert resp.json() == {'message': ANY, 'subtitle': 'FOAAS'}
     """
     )
 
@@ -202,3 +200,35 @@ def test_lack_of_unintended_side_effects():
     assert "HTTPS_PROXY" not in os.environ
     assert "SSL_CERT_FILE" not in os.environ
     assert "REQUESTS_CA_BUNDLE" not in os.environ
+
+
+def test_timeout_option(testdir):
+    """Test timeout option is parsed correctly."""
+    testdir.makepyfile(
+        """
+import requests
+from pytest_hoverfly import hoverfly
+
+
+@hoverfly(name='foaas_version_simulation')
+def test_timeout_parsing(request):
+    resp = requests.get(
+        'https://foaas.com/version',
+        headers={'Accept': 'application/json'},
+    )
+
+    assert resp.json() == {'message': 'Version 2.1.1', 'subtitle': 'FOAAS'}
+
+    # Hoverfly adds Hoverfly: Was-Here header
+    assert 'Hoverfly' in resp.headers
+
+    assert request.config.option.hoverfly_start_timeout == 55.0
+    """
+    )
+
+    # run all tests with pytest
+    result = testdir.runpytest_subprocess(
+        "--hoverfly-simulation-path", str(CURDIR / "simulations"), "--hoverfly-start-timeout", "55", "-vv"
+    )
+
+    result.assert_outcomes(passed=1)