pytest_httpserver 1.1.0__tar.gz → 1.1.1__tar.gz

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/CHANGES.rst

@@ -2,6 +2,20 @@
 Release Notes
 =============
 
+.. _Release Notes_1.1.1:
+
+1.1.1
+=====
+
+.. _Release Notes_1.1.1_New Features:
+
+New Features
+------------
+
+- Add a new ``expect`` method to the ``HTTPServer`` object which allows
+  developers to provide their own request matcher object.
+
+
 .. _Release Notes_1.1.0:
 
 1.1.0

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pytest_httpserver
-Version: 1.1.0
+Version: 1.1.1
 Summary: pytest-httpserver is a httpserver for pytest
 Home-page: https://github.com/csernazs/pytest-httpserver
 License: MIT
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: Werkzeug (>=2.0.0)
 Project-URL: Bug Tracker, https://github.com/csernazs/pytest-httpserver/issues
@@ -25,7 +26,7 @@ Project-URL: Documentation, https://pytest-httpserver.readthedocs.io/en/latest/
 Project-URL: Repository, https://github.com/csernazs/pytest-httpserver
 Description-Content-Type: text/markdown
 
-[![Build Status](https://github.com/csernazs/pytest-httpserver/workflows/build/badge.svg?branch=master)](https://github.com/csernazs/pytest-httpserver/actions?query=workflow%3Abuild+branch%3Amaster)
+[![Build Status](https://github.com/csernazs/pytest-httpserver/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/csernazs/pytest-httpserver/actions?query=workflow%3Abuild+branch%3Amaster)
 [![Documentation Status](https://readthedocs.org/projects/pytest-httpserver/badge/?version=latest)](https://pytest-httpserver.readthedocs.io/en/latest/?badge=latest)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 [![codecov](https://codecov.io/gh/csernazs/pytest-httpserver/branch/master/graph/badge.svg?token=MX2JXbHqRH)](https://codecov.io/gh/csernazs/pytest-httpserver)

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://github.com/csernazs/pytest-httpserver/workflows/build/badge.svg?branch=master)](https://github.com/csernazs/pytest-httpserver/actions?query=workflow%3Abuild+branch%3Amaster)
+[![Build Status](https://github.com/csernazs/pytest-httpserver/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/csernazs/pytest-httpserver/actions?query=workflow%3Abuild+branch%3Amaster)
 [![Documentation Status](https://readthedocs.org/projects/pytest-httpserver/badge/?version=latest)](https://pytest-httpserver.readthedocs.io/en/latest/?badge=latest)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 [![codecov](https://codecov.io/gh/csernazs/pytest-httpserver/branch/master/graph/badge.svg?token=MX2JXbHqRH)](https://codecov.io/gh/csernazs/pytest-httpserver)

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/doc/conf.py

@@ -68,7 +68,7 @@ author = "Zsolt Cserna"
 # built documents.
 #
 # The short X.Y version.
-version = "1.1.0"
+version = "1.1.1"
 # The full version, including alpha/beta/rc tags.
 release = version
 

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/doc/howto.rst

@@ -238,6 +238,17 @@ these.
     the server.
 
 
+Using custom request matcher
+----------------------------
+In the case when you want to extend or modify the request matcher in
+*pytest-httpserrver*, then you can use your own request matcher.
+
+Example:
+
+.. literalinclude :: ../tests/examples/test_howto_custom_request_matcher.py
+   :language: python
+
+
 Customizing host and port
 -------------------------
 

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pytest_httpserver"
-version = "1.1.0"
+version = "1.1.1"
 description = "pytest-httpserver is a httpserver for pytest"
 authors = ["Zsolt Cserna <cserna.zsolt@gmail.com>"]
 license = "MIT"
@@ -41,14 +41,13 @@ optional = true
 pre-commit = ">=2.20,<4.0"
 requests = "*"
 Sphinx = ">=5.1.1,<8.0.0"
-sphinx-rtd-theme = ">=1,<3"
+sphinx-rtd-theme = ">=1,<4"
 reno = "*"
 types-requests = "*"
 pytest = ">=7.1.3,<9.0.0"
 pytest-cov = ">=3,<6"
 coverage = ">=6.4.4,<8.0.0"
-types-toml = "*"
-toml = "^0.10.2"
+tomli = { version = "*", markers = "python_version < '3.11'"}
 black = "*"
 ruff = "*"
 mypy = "*"
@@ -59,7 +58,7 @@ optional = true
 
 [tool.poetry.group.doc.dependencies]
 Sphinx = ">=5.1.1,<8.0.0"
-sphinx-rtd-theme = ">=1,<3"
+sphinx-rtd-theme = ">=1,<4"
 
 
 [tool.poetry.group.test]
@@ -72,8 +71,7 @@ coverage = "*"
 requests = "*"
 types-requests = "*"
 pre-commit = "*"
-types-toml = "*"
-toml = "*"
+tomli = { version = "*", markers = "python_version < '3.11'"}
 mypy = "*"
 
 [build-system]

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/pytest_httpserver/httpserver.py

@@ -972,6 +972,22 @@ class HTTPServer(HTTPServerBase):  # pylint: disable=too-many-instance-attribute
         self.oneshot_handlers = RequestHandlerList()
         self.handlers = RequestHandlerList()
 
+    def expect(self, matcher: RequestMatcher, handler_type: HandlerType = HandlerType.PERMANENT) -> RequestHandler:
+        """
+        Create and register a request handler.
+
+        :param matcher: :py:class:`RequestMatcher` used to match requests.
+        :param handler_type: type of handler
+        """
+        request_handler = RequestHandler(matcher)
+        if handler_type == HandlerType.PERMANENT:
+            self.handlers.append(request_handler)
+        elif handler_type == HandlerType.ONESHOT:
+            self.oneshot_handlers.append(request_handler)
+        elif handler_type == HandlerType.ORDERED:
+            self.ordered_handlers.append(request_handler)
+        return request_handler
+
     def expect_request(
         self,
         uri: str | URIPattern | Pattern[str],

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/pytest_httpserver/pytest_plugin.py

@@ -61,7 +61,7 @@ def pytest_sessionfinish(session, exitstatus):  # noqa: ARG001
             Plugin.SERVER.stop()
 
 
-@pytest.fixture()
+@pytest.fixture
 def httpserver(make_httpserver):
     server = make_httpserver
     server.clear()
@@ -78,7 +78,7 @@ def make_httpserver_ipv4(httpserver_ssl_context):
         server.stop()
 
 
-@pytest.fixture()
+@pytest.fixture
 def httpserver_ipv4(make_httpserver_ipv4):
     server = make_httpserver_ipv4
     server.clear()
@@ -95,7 +95,7 @@ def make_httpserver_ipv6(httpserver_ssl_context):
         server.stop()
 
 
-@pytest.fixture()
+@pytest.fixture
 def httpserver_ipv6(make_httpserver_ipv6):
     server = make_httpserver_ipv6
     server.clear()

pytest_httpserver-1.1.1/tests/examples/test_howto_custom_request_matcher.py

@@ -0,0 +1,37 @@
+import requests
+from werkzeug import Request
+
+from pytest_httpserver import HTTPServer
+from pytest_httpserver import RequestMatcher
+
+
+class MyMatcher(RequestMatcher):
+    def match(self, request: Request) -> bool:
+        match = super().match(request)
+        if not match:  # existing parameters didn't match -> return with False
+            return match
+
+        # match the json's "value" key: if it is an integer and it is an even
+        # number, it returns True
+        json = request.json
+        if isinstance(json, dict) and isinstance(json.get("value"), int):
+            return json["value"] % 2 == 0
+
+        return False
+
+
+def test_custom_request_matcher(httpserver: HTTPServer):
+    httpserver.expect(MyMatcher("/foo")).respond_with_data("OK")
+
+    # with even number it matches the request
+    resp = requests.post(httpserver.url_for("/foo"), json={"value": 42})
+    resp.raise_for_status()
+    assert resp.text == "OK"
+
+    resp = requests.post(httpserver.url_for("/foo"), json={"value": 198})
+    resp.raise_for_status()
+    assert resp.text == "OK"
+
+    # with an odd number, it does not match the request
+    resp = requests.post(httpserver.url_for("/foo"), json={"value": 43})
+    assert resp.status_code == 500

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/tests/test_blocking_httpserver.py

@@ -40,7 +40,7 @@ def then_the_response_is_got_from(server_connection, response):
     assert server_connection.get(timeout=9).json() == response
 
 
-@pytest.fixture()
+@pytest.fixture
 def httpserver():
     server = BlockingHTTPServer(timeout=1)
     server.start()
@@ -122,4 +122,4 @@ def test_raises_assertion_error_when_request_was_not_responded(httpserver: Block
 
 
 def test_repr(httpserver: BlockingHTTPServer):
-    assert repr(httpserver) == f"<BlockingHTTPServer host=localhost port={httpserver.port}>"
+    assert repr(httpserver) == f"<BlockingHTTPServer host={httpserver.host} port={httpserver.port}>"

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/tests/test_log_leak.py

@@ -13,7 +13,7 @@ class Client:
             requests.get(self.url)
 
 
-@pytest.fixture()
+@pytest.fixture
 def my_fixture():
     client = Client()
     yield client

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/tests/test_log_querying.py

@@ -47,7 +47,7 @@ def test_verify_assert_msg(httpserver: HTTPServer):
         "Path: /foo",
         "Method: GET",
         "Body: b''",
-        f"Headers: Host: localhost:{httpserver.port}",
+        f"Headers: Host: {httpserver.host}:{httpserver.port}",
         "User-Agent: requests",
         "Accept-Encoding: gzip, deflate",
         "Accept: */*",

pytest_httpserver-1.1.1/tests/test_matcher.py

@@ -0,0 +1,11 @@
+import requests
+
+from pytest_httpserver import HTTPServer
+
+
+def test_expect_method(httpserver: HTTPServer):
+    expected_response = "OK"
+    matcher = httpserver.create_matcher(uri="/test", method="POST")
+    httpserver.expect(matcher).respond_with_data(expected_response)
+    resp = requests.post(httpserver.url_for("/test"), json={"list": [1, 2, 3, 4]})
+    assert resp.text == expected_response

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/tests/test_mixed.py

@@ -85,4 +85,4 @@ def test_all_ordered_missing(httpserver: HTTPServer):
 
 
 def test_repr(httpserver: HTTPServer):
-    assert repr(httpserver) == f"<HTTPServer host=localhost port={httpserver.port}>"
+    assert repr(httpserver) == f"<HTTPServer host={httpserver.host} port={httpserver.port}>"

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/tests/test_port_changing.py

@@ -9,7 +9,7 @@ PORT_KEY = "PYTEST_HTTPSERVER_PORT"
 HOST_KEY = "PYTEST_HTTPSERVER_HOST"
 
 
-@pytest.fixture()
+@pytest.fixture
 def tmpenv():
     old_vars = {}
     for key in (HOST_KEY, PORT_KEY):

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/tests/test_release.py

@@ -11,7 +11,13 @@ from pathlib import Path
 from typing import Iterable
 
 import pytest
-import toml
+
+try:
+    import tomllib
+except ImportError:
+    # Unfortunately mypy cannot handle this try/expect pattern, and "type: ignore"
+    # is the simplest work-around. See: https://github.com/python/mypy/issues/1153
+    import tomli as tomllib  # type: ignore
 
 # TODO: skip if poetry is not available or add mark to test it explicitly
 
@@ -20,7 +26,7 @@ pytestmark = pytest.mark.release
 
 NAME = "pytest-httpserver"
 NAME_UNDERSCORE = NAME.replace("-", "_")
-PY_MAX_VERSION = (3, 12)
+PY_MAX_VERSION = (3, 13)
 
 
 @pytest.fixture(scope="session")
@@ -31,8 +37,8 @@ def pyproject_path() -> Path:
 @pytest.fixture(scope="session")
 def pyproject(pyproject_path: Path):
     assert pyproject_path.is_file()
-    with pyproject_path.open() as infile:
-        pyproject = toml.load(infile)
+    with pyproject_path.open("rb") as infile:
+        pyproject = tomllib.load(infile)
     return pyproject
 
 
@@ -228,6 +234,7 @@ def test_sdist_contents(build: Build, version: str):
             "test_urimatch.py",
             "test_wait.py",
             "test_with_statement.py",
+            "test_matcher.py",
         },
     }
 

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/tests/test_ssl.py

@@ -5,6 +5,8 @@ from os.path import join as pjoin
 import pytest
 import requests
 
+from pytest_httpserver import HTTPServer
+
 pytestmark = pytest.mark.ssl
 
 test_dir = os.path.dirname(os.path.realpath(__file__))
@@ -24,18 +26,23 @@ def httpserver_ssl_context():
     return ssl.SSLContext(protocol)
 
 
-def test_ssl(httpserver):
+def test_ssl(httpserver: HTTPServer):
     server_crt = pjoin(assets_dir, "server.crt")
     server_key = pjoin(assets_dir, "server.key")
     root_ca = pjoin(assets_dir, "rootCA.crt")
-    context = httpserver.ssl_context
 
     assert (
-        context is not None
+        httpserver.ssl_context is not None
     ), "SSLContext not set. The session was probably started with a test that did not define an SSLContext."
 
     httpserver.ssl_context.load_cert_chain(server_crt, server_key)
     httpserver.expect_request("/foobar").respond_with_json({"foo": "bar"})
 
     assert httpserver.is_running()
-    assert requests.get(httpserver.url_for("/foobar"), verify=root_ca).json() == {"foo": "bar"}
+
+    assert httpserver.url_for("/").startswith("https://")
+
+    # ensure we are using "localhost" and not "127.0.0.1" to pass cert verification
+    url = f"https://localhost:{httpserver.port}/foobar"
+
+    assert requests.get(url, verify=root_ca).json() == {"foo": "bar"}

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/tests/test_threaded.py

@@ -10,7 +10,7 @@ from werkzeug import Response
 from pytest_httpserver import HTTPServer
 
 
-@pytest.fixture()
+@pytest.fixture
 def threaded() -> Iterable[HTTPServer]:
     server = HTTPServer(threaded=True)
     server.start()
@@ -33,8 +33,6 @@ def test_threaded(threaded: HTTPServer):
 
     threaded.expect_request("/foo").respond_with_handler(handler)
 
-    t_start = time.perf_counter()
-
     number_of_connections = 5
     conns = [http.client.HTTPConnection(threaded.host, threaded.port) for _ in range(number_of_connections)]
 
@@ -51,10 +49,4 @@ def test_threaded(threaded: HTTPServer):
     for conn in conns:
         conn.close()
 
-    t_elapsed = time.perf_counter() - t_start
-
     assert len(thread_ids) == len(set(thread_ids)), "thread ids returned should be unique"
-
-    assert (
-        t_elapsed < number_of_connections * sleep_time * 0.9
-    ), "elapsed time should be less than processing sequential requests"

{pytest_httpserver-1.1.0 → pytest_httpserver-1.1.1}/pytest_httpserver/__init__.py

@@ -4,19 +4,19 @@ This is package provides the main API for the pytest_httpserver package.
 """
 
 __all__ = [
+    "METHOD_ALL",
+    "URI_DEFAULT",
+    "BlockingHTTPServer",
+    "BlockingRequestHandler",
+    "Error",
     "HTTPServer",
     "HTTPServerError",
-    "Error",
-    "NoHandlerError",
-    "WaitingSettings",
     "HeaderValueMatcher",
+    "NoHandlerError",
     "RequestHandler",
     "RequestMatcher",
     "URIPattern",
-    "URI_DEFAULT",
-    "METHOD_ALL",
-    "BlockingHTTPServer",
-    "BlockingRequestHandler",
+    "WaitingSettings",
 ]
 
 from .blocking_httpserver import BlockingHTTPServer