pytest-remote-response

====================== pytest-remote-response

|versions| |license| |doi|

|build| |docs| |coverage| |status| |codestyle|

This package provides a plugin for pytest_ framework for capturing and mocking connection requests during the test run.

Inspired by pook_ and pytest-responses_.

Get started using the documentation_ and getting-started_.

🔌Installation

.. code-block:: console

$ pip install pytest-remote-response

or

.. code-block:: console

$ git clone https://github.com/devanshshukla99/pytest-remote-response
$ cd pytest-remote-response
$ pip install .

The plugin will register automatically with pytest framework and will be ready to use.

💁🏻‍♀️Supported Clients

Currently, pytest-remote-response supports,

• ✔ urllib_
• ✔ urllib3_
• ✔ requests_
• ✔ aiohttp_

💨Usage

🐍🧪Pytest plugin

---

The plugin works by applying monkeypatches of interceptors for different libraries using a wrapper response.activate. The interceptors when applied can capture, prevent or mock the connection request.

The available interceptors are listed in response.available method.

Example of using the decorator:

.. code-block:: python

import urllib3
from pytest_response import response

response.configure(remote=True, capture=True, response=False)

@response.activate("urllib3")
def get_url():
    http = urllib3.PoolManager()
    url = "https://www.python.org"

    # Since the interceptors are in response mode, the response data and headers
    # will be spoofed with saved data in the database;
    # if the query comes back empty, this request will
    # error out with :class:`pytest_response.exceptions.ResponseNotFound`
    res = http.request("GET", url)
    assert res.status == 200
    assert res.data

Handling requests:

• Block remote requests: all requests are allowed by default; one can disable them using --remote-block flag

.. code-block:: console

$ pytest --remote-block

• Capture remote requests: the requests can be captured in a sqlite3 database using --remote-capture arg

.. code-block:: console

$ pytest --remote-capture

• Mock remote requests: the requests can be mocked using --remote-response

.. code-block:: console

$ pytest --remote-response

🐱‍👤Standalone package

---

The tools implemented in this package can be easily ported to any other application, with mimial config required.

Configuration: ^^^^^^^^^^^^^^

.. code-block:: python

from pytest_response import response

response.setup_database({DUMP FILE})
response.post({INTERCEPTOR})
...
response.unpost()

🧪 Testing

Use tox to make sure the plugin is working:

.. code-block:: console

$ git clone https://github.com/devanshshukla99/pytest-remote-response
$ cd pytest-remote-response
$ tox -e py38

See tox <https://github.com/tox-dev/tox>_ for more info.

Licence

This plugin is licenced under a MIT licence - see the LICENCE file.

.. |build| image:: https://github.com/devanshshukla99/pytest-remote-response/actions/workflows/main.yml/badge.svg

.. |coverage| image:: https://codecov.io/gh/devanshshukla99/pytest-remote-response/branch/main/graph/badge.svg?token=NQMZKNZOB2 :target: https://codecov.io/gh/devanshshukla99/pytest-remote-response :alt: Code coverage

.. |status| image:: https://img.shields.io/pypi/status/pytest-remote-response.svg :target: https://pypi.org/project/pytest-remote-response/ :alt: Package stability

.. |versions| image:: https://img.shields.io/pypi/pyversions/pytest-remote-response.svg?logo=python&logoColor=FBE072 :target: https://pypi.org/project/pytest-remote-response/ :alt: Python versions supported

.. |license| image:: https://img.shields.io/pypi/l/pytest-remote-response :target: https://pypi.org/project/pytest-remote-response/ :alt: License

.. |codestyle| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black

.. |docs| image:: https://readthedocs.org/projects/pytest-remote-response/badge/?version=latest :target: https://pytest-remote-response.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

.. |doi| image:: https://zenodo.org/badge/373798755.svg :target: https://zenodo.org/badge/latestdoi/373798755 :alt: Digital Object Identifier

.. _pytest: https://github.com/pytest-dev/pytest .. _urllib: https://docs.python.org/3/library/urllib.html .. _requests: https://github.com/psf/requests .. _aiohttp: https://github.com/aio-libs/aiohttp .. _urllib3: https://github.com/urllib3/urllib3 .. _pytest-responses: https://github.com/getsentry/pytest-responses .. _pook: https://github.com/h2non/pook .. _documentation: https://pytest-remote-response.readthedocs.io/en/latest/ .. _getting-started: https://pytest-remote-response.readthedocs.io/en/latest/user_guide.html