- Fixed an issue related to the leak of httpserver state between the tests when httpserver is destructed before the other fixtures. #352
- Fix pytest-httpserver's own tests related to log querying. No functional changes in pytest-httpserver code itself. #345
- Hooks API
- New methods added to query for matching requests in the log.
- Threading support to serve requests in parallel
- When there's no handler for the request, add more details to the response sent by the server about the request to help debugging.
- Use ruff for linting. It includes some source code changes which should not introduce functional changes, or API changes.
- Add
__repr__toRequestHandlerobject so when it is compared (eg. with thelogattribute of the server) it will show the matcher parameters.
- Version 1.0.7 has been released with incorrect dependencies. This is fixed now.
- With werkzeug 2.3.x the headers type has been updated to not allow integers as header values. This restriction followed up in pytest-httpserver.
- Python versions earlier than 3.8 have been deprecated in order to support the latest werkzeug. Users using 3.7 or earlier python may use pytest-httpserver with earlier werkzeug versions but tests are no longer run for these python versions.
- Type hinting for header_value_matcher has been fixed. From now, specifying a
callable as
Callable[[str, Optional[str], str], bool]will be accepted also. Providing aHeaderValueMatcherobject will be also accepted as before, as it provides the same callable signature. - Fix Werkzeug deprecation warning about
parse_authorization_headercall. Replaceparse_authorization_headerwithAuthorization.from_headeras suggested. This fix should not introduce any functional change for the users. - Fix Werkzeug deprecation warning about
werkzeug.urls.url_decodecall. This call has been changed tourllib.parse.parse_qslin the implementation. This fix should not introduce any functional change for the users.
- Add a new way of running tests with the blocking mode. In this mode, the http server is synchronized to the main thread and the client code is run in a separate thread.
- Python version classifier updated in pyproject.toml (which updates pypi also)
- Packaging of sdist and the wheel fixed by adding the extra files only to the sdist and not to the wheel.
- Fixed type hinting of
HeaderValueMatcher.DEFAULT_MATCHERS, which did not allow modifications, however it is explicitly allowed in the documentation.
- Version of flake8 library updated to require 4.0.0+ at minimum. This is required to make flake8 working on recent python versions.
- Additional type hints improvements to make the library more mypy compliant. Imports in __init__.py have been updated to indicate that this is a namespace package.
- Package deployment and CI has been migrated to poetry. poetry.lock will be kept up to date. Make target "quick-test" renamed to "test". Also, minor adjustments were made regarding documentation generation. Make targets should be identical. Build results like sdist, and wheel are almost identical to the one which was made by setuptools.
- Type hints updated to conform to 'mypy' type checking tool. Also, py.typed file is added as package data according to PEP 561.
- Python 3.4 and 3.5 versions have been deprecated in order to support type hints in the source code. Users using 3.5 and earlier releases encouraged to upgrade to later versions. Please node that 3.5 reached EOL in September of 2020 and no longer receives security fixes.
- Improved error handling of custom request handlers. Request handlers added
with
respond_with_handlernow can use theassertstatement. Those errors will be reported when a furthercheck_assertions()call is made. Also, unhandled exceptions raised in the request handlers can be re-raised by calling the newcheck_handler_errors()method. A new method calledcheck()has been added which calls these two in sequence.
Functionally the same as 1.0.0rc1. For the list of changes between 0.3.8 and 1.0.0 see the changelist for 1.0.0rc1.
- Added a new session scoped fixture
make_httpserverwhich creates the object for thehttpserverfixture. It can be overridden to add further customizations and it must yield aHTTPServerobject - seepytest_plugin.pyfor an implementation. As this fixture is session scoped, it will be called only once when the first test using httpserver is started. This addition also deprecates the use ofPluginHTTPServerwhich was used in earlier versions as a way to customize server object creation.PluginHTTPServercan still be used but it may be subject to deprecation in the future. - Added a new session scoped fixture
httpserver_ssl_contextwhich provides the SSL context for the server. By default it returnsNone, so SSL is not enabled, but can be overridden to return a validssl.SSLContextobject which will be used for SSL connections. See test_ssl.py for example.
- Breaking change: The scope of
httpserver_listen_addressfixture changed from function to session. This is a requirement to implement the other features listed in this release. See the upgrade guide for the details.
- Deprecation warnings were added to prepare changes to 1.0.0. More details: https://pytest-httpserver.readthedocs.io/en/latest/upgrade.html
- Removed pytest-runner from setup.py as it is deprecated and makes packaging inconvenient as it needs to be installed before running setup.py.
- HTTP methods are case insensitive. The HTTP method specified is converted to uppercase in the library.
- It is now possible to specify a JSON-serializable python value (such as dict, list, etc) and match the request to it as JSON. The request's body is loaded as JSON and it will be compared to the expected value.
- The http response code sent when no handler is found for the request can be changed. It is set to 500 by default.
- Extend URI matching by allowing to specify URIPattern object or a compiled regular expression, which will be matched against the URI. URIPattern class is defined as abstract in the library so the user need to implement a new class based on it.
- Fix the tests assets created for SSL/TLS tests by extending their expiration time. Also update the Makefile which can be used to update these assets.
- Besides bytes and string, dict and MultiDict objects can be specified as query_string. When these objects are used, the query string gets parsed into a dict (or MultiDict), and comparison is made accordingly. This enables the developer to ignore the order of the keys in the query_string when expecting a request.
- Fixed issue #16 by converting string object passed as query_string to bytes which is the type of the query string in werkzeug, and also allowing bytes as the parameter.
- Fix release tagging. 0.3.2 was released in a mistake by tagging 3.0.2 to the branch.
- Add more files to source distribution (sdist). It now contains tests, assets, examples and other files.
- Add httpserver_listen_address fixture which is used to set up the bind address and port of the server. Setting bind address and port is possible by overriding this fixture.
- Support ephemeral port. This can be used by specify 0 as the port number to the HTTPServer instance. In such case, an unused port will be picked up and the server will start listening on that port. Querying the port attribute after server start reveals the real port where the server is actually listening.
- Unify request functions of the HTTPServer class to make the API more straightforward to use.
- The default port has been changed to 0, which results that the server will be staring on an ephemeral port.
- The following methods of HTTPServer have been changed in a backward-incompatible way:
- :py:meth:`pytest_httpserver.HTTPServer.expect_request` becomes a general function accepting handler_type parameter so it can create any kind of request handlers
- :py:meth:`pytest_httpserver.HTTPServer.expect_oneshot_request` no longer accepts the ordered parameter, and it creates an unordered oneshot request handler
- :py:meth:`pytest_httpserver.HTTPServer.expect_ordered_request` is a new method creating an ordered request handler
- Make it possible to intelligently compare headers. To accomplish that HeaderValueMatcher was added. It already contains logic to compare unknown headers and authorization headers. Patch by Roman Inflianskas.
Minor fixes in setup.py and build environment. No actual code change in library .py files.
- When using pytest plugin, specifying the bind address and bind port can also be possible via environment variables. Setting PYTEST_HTTPSERVER_HOST and PYTEST_HTTPSERVER_PORT will change the bind host and bind port, respectively.
- SSL/TLS support added with using the SSL/TLS support provided by werkzeug. This is based on the ssl module from the standard library.
Minor fixes in setup.py and build environment. No actual code change in library .py files.
First release