Document how to configure options on the whole test suite

[Apakottur]

We are using the assert_all_responses_were_requested option in our test suite to avoid raising an error if not all responses were requested.
We have thousands of unit tests across hundreds of test files that would error without this flag being set to False so we were using the fixture to set it to false globally for the entire test suite.

The changes in #145 now make this flag scoped, which is a great feature, but not applicable in our case, meaning we can't use the newest version of the package.

It would be great to still be able to configure it once for the entire test suite (otherwise we'd have to add it to hundreds of files).

Or perhaps it's possible to configure it globally for entire test suite and I'm just missing something?

[Colin-b]

Hello @Apakottur ,

I am not proficient enough with pytest marks to give you a definitive answer on this.
Maybe @RazerM would know if such option exists?

If not, I am sure we could cook something up.

If you are using this option because you have a shared fixture registering a lot of responses that might not be useful in all tests, you could have a look at calling the following method at teardown (after the yield statement of your fixture).

httpx_mock.reset()

This would however prevent any assertion performed at teardown by httpx_mock (your test suite would not fail at teardown if some HTTP calls were not mocked, but your tests might still fail depending on how your code handle the Timeout raised by httpx_mock when nothing was registered).

[RazerM]

You could add this to your root conftests.py to add the marker to every test:

def pytest_collection_modifyitems(session, config, items):
    for item in items:
        item.add_marker(pytest.mark.httpx_mock(assert_all_responses_were_requested=False))

[RazerM]

Also maybe we should change

pytest_httpx/pytest_httpx/__init__.py

Line 23 in ca067b4

marker = request.node.get_closest_marker("httpx_mock")

to use request.node.iter_markers("httpx_mock") so that we appropriately combine them, e.g.

pytestmark = pytest.mark.httpx_mock(assert_all_responses_were_requested=False)

@pytest.mark.httpx_mock(non_mocked_hosts=["example.com"])
def test_foo():
    ...

[Colin-b]

Nice, so there is a workaround.

Indeed we should fix the way we currently handle provided options.
Feel free to draft a PR (or I'll do it whenever I find some more time :)), I opened an issue for it: #155

And this ticket is now a documentation update one

[Apakottur]

You could add this to your root conftests.py to add the marker to every test:

def pytest_collection_modifyitems(session, config, items):
    for item in items:
        item.add_marker(pytest.mark.httpx_mock(assert_all_responses_were_requested=False))

This works perfectly for our usecase, thank you!

[Colin-b]

Documentation was updated to help setting this up and code now handles multiple level of configuration