Fixture based server options

Enable users to specify options for the server via fixtures.

We use a dataclass which keeps the options (so it is extendable later on),
which is returned by a fixture.  This fixture can be overridden by the user
to customize the options.

The other options: host, port, ssl_context are still provided by their own
fixtures and this is kept for backward compatibility.

Author: csernazs

pytest_httpserver/__init__.py

@@ -10,6 +10,7 @@
     "BlockingHTTPServer",
     "BlockingRequestHandler",
     "Error",
+    "ExtraOptions",
     "HTTPServer",
     "HTTPServerError",
     "HeaderValueMatcher",
@@ -27,6 +28,7 @@
 from .httpserver import METHOD_ALL
 from .httpserver import URI_DEFAULT
 from .httpserver import Error
+from .httpserver import ExtraOptions
 from .httpserver import HeaderValueMatcher
 from .httpserver import HTTPServer
 from .httpserver import HTTPServerError

pytest_httpserver/httpserver.py

@@ -18,6 +18,7 @@
 from contextlib import contextmanager
 from contextlib import suppress
 from copy import copy
+from dataclasses import dataclass
 from enum import Enum
 from http import HTTPStatus
 from re import Pattern
@@ -947,6 +948,13 @@ def format_host(host: str) -> str:
         return host
 
 
+@dataclass
+class ExtraOptions:
+    default_waiting_settings: WaitingSettings | None = None
+    threaded: bool = False
+    startup_timeout: float | None = None
+
+
 class HTTPServer(HTTPServerBase):  # pylint: disable=too-many-instance-attributes
     """
     Server instance which manages handlers to serve pre-defined requests.
@@ -1001,6 +1009,19 @@ def __init__(
         self.startup_timeout = startup_timeout
         self._readiness_check_pending = False
 
+    @classmethod
+    def with_extra_options(
+        cls, host: str, port: int, ssl_context: SSLContext | None, extra_options: ExtraOptions
+    ) -> Self:
+        return cls(
+            host,
+            port,
+            ssl_context,
+            default_waiting_settings=extra_options.default_waiting_settings,
+            threaded=extra_options.threaded,
+            startup_timeout=extra_options.startup_timeout,
+        )
+
     def start(self) -> None:
         super().start()
         self._readiness_check_pending = self.startup_timeout is not None

pytest_httpserver/pytest_plugin.py

@@ -5,6 +5,7 @@
 
 import pytest
 
+from .httpserver import ExtraOptions
 from .httpserver import HTTPServer
 
 if TYPE_CHECKING:
@@ -44,18 +45,29 @@ def httpserver_ssl_context() -> None:
     return None
 
 
+@pytest.fixture(scope="session")
+def httpserver_extra_options() -> ExtraOptions:
+    return ExtraOptions()
+
+
 @pytest.fixture(scope="session")
 def make_httpserver(
     httpserver_listen_address: tuple[str | None, int | None],
     httpserver_ssl_context: SSLContext | None,
+    httpserver_extra_options: ExtraOptions,
 ) -> Generator[HTTPServer, None, None]:
     host, port = httpserver_listen_address
     if not host:
         host = HTTPServer.DEFAULT_LISTEN_HOST
     if not port:
         port = HTTPServer.DEFAULT_LISTEN_PORT
 
-    server = HTTPServer(host=host, port=port, ssl_context=httpserver_ssl_context)
+    server = HTTPServer.with_extra_options(
+        host=host,
+        port=port,
+        ssl_context=httpserver_ssl_context,
+        extra_options=httpserver_extra_options,
+    )
     server.start()
     yield server
     server.clear()
@@ -80,8 +92,14 @@ def httpserver(make_httpserver: HTTPServer) -> HTTPServer:
 @pytest.fixture(scope="session")
 def make_httpserver_ipv4(
     httpserver_ssl_context: SSLContext | None,
+    httpserver_extra_options: ExtraOptions,
 ) -> Generator[HTTPServer, None, None]:
-    server = HTTPServer(host="127.0.0.1", port=0, ssl_context=httpserver_ssl_context)
+    server = HTTPServer.with_extra_options(
+        host="127.0.0.1",
+        port=0,
+        ssl_context=httpserver_ssl_context,
+        extra_options=httpserver_extra_options,
+    )
     server.start()
     yield server
     server.clear()
@@ -99,8 +117,14 @@ def httpserver_ipv4(make_httpserver_ipv4: HTTPServer) -> HTTPServer:
 @pytest.fixture(scope="session")
 def make_httpserver_ipv6(
     httpserver_ssl_context: SSLContext | None,
+    httpserver_extra_options: ExtraOptions,
 ) -> Generator[HTTPServer, None, None]:
-    server = HTTPServer(host="::1", port=0, ssl_context=httpserver_ssl_context)
+    server = HTTPServer.with_extra_options(
+        host="::1",
+        port=0,
+        ssl_context=httpserver_ssl_context,
+        extra_options=httpserver_extra_options,
+    )
     server.start()
     yield server
     server.clear()

tests/test_extra_options.py

@@ -0,0 +1,41 @@
+from inspect import signature
+
+from pytest_httpserver import ExtraOptions
+from pytest_httpserver import HTTPServer
+from pytest_httpserver import WaitingSettings
+
+
+def test_httpserver_extra_options():
+    extra_options = ExtraOptions(
+        startup_timeout=60,
+        threaded=True,
+        default_waiting_settings=WaitingSettings(timeout=5),
+    )
+
+    server = HTTPServer.with_extra_options(
+        host="localhost",
+        port=0,
+        ssl_context=None,
+        extra_options=extra_options,
+    )
+
+    assert server.startup_timeout == 60
+    assert server.threaded is True
+    assert server.default_waiting_settings.timeout == 5
+
+
+def test_constructor_signature_matches_with_extra_options():
+    # compares that ExtraOptions default values matches with HTTPServer
+    # constructor defaults
+
+    httpserver_sig = signature(HTTPServer.__init__)
+    extra_options_sig = signature(ExtraOptions.__init__)
+    for param_name, extra_param in extra_options_sig.parameters.items():
+        if param_name == "self":
+            continue
+        httpserver_param = httpserver_sig.parameters.get(param_name)
+        assert httpserver_param is not None, f"Parameter {param_name} missing in HTTPServer"
+        assert httpserver_param.default == extra_param.default, (
+            f"Default value for parameter {param_name} does not match: "
+            f"{httpserver_param.default} != {extra_param.default}"
+        )

tests/test_release.py

@@ -219,6 +219,7 @@ def test_sdist_contents(build: Build, version: str):
             "examples",
             "test_bake.py",
             "test_blocking_httpserver.py",
+            "test_extra_options.py",
             "test_handler_errors.py",
             "test_headers.py",
             "test_hooks.py",