How to reuse requests_mock in many tests

Question

There are different testing functions that read from the same api.

I want to mock the response of this request. Hence I'm using requests_mock library.

Imagine the following tests:

def test_get_people_names():
   names = [name for name in people_service.getPeople()] # this goes to the API GET URL
   assert len(names) > 0

def test_get_people_ages():
   ages = [age for age in people_service.getPeople()]
   assert len(ages) > 0

With this code, I want to test that people_service is doing its trick to access the correct API, not the API functionality.

With requests_mock I saw that I can do:

def test_get_people_ages(requests_mock):
   requests_mock.get('https//my.api/people', text=SOME_JSON)
   ages = [age for age in people_service.getPeople()]
   assert len(ages) > 0

What could I do to avoid rewriting the same line (requests_mock.get...) for every test?

(If there's the need to change the API or json, I can change in only 1 place)

The thing is that this requests_mock doesn't look like it's a class (lowercased name) and can be used in a context management fashion (in this case, the class Mock).

Could I just use this Mock object here and there after passing this get argument? What would be the impact of this (not using context management or not using it locally)?

score 4 · Accepted Answer · edited Jan 18 '22 at 11:25

4

You could just create another fixture using the request_mock fixture.

@pytest.fixture
def your_requests_mock(requests_mock):
    # Use return to be able to access requests_mock attributes
    return requests_mock.get('https//my.api/people', text=SOME_JSON)

def test_get_people_ages(your_requests_mock):
    ...

As you can see, you can just apply that to all your test functions that should mock out the request and you are good to go.

edited Jan 18 '22 at 11:25

Tiago Duque

1,956
1
12
31

answered Jan 17 '22 at 18:39

Simon Hawe

3,968
6
14

This brings an error: ScopeMismatch: You tried to access the 'function' scoped fixture 'requests_mock' with a 'session' scoped request object, involved factories tests/new/conftest.py:62: def your_requests_mock(requests_mock) venv/lib/python3.8/site-packages/requests_mock/contrib/_pytest_plugin.py:70: def requests_mock(request) – Tiago Duque Jan 17 '22 at 18:45
Ok, so just try to remove the scope="session", it doesn't make much sense anyways and I also remove it from my answer – Simon Hawe Jan 17 '22 at 18:46
Now, any chance that I could check if the api was actually called? Using requests_mock allows me to access .called attribute. – Tiago Duque Jan 17 '22 at 19:02
you could just return requests_mock or return requests_mock.get('https//my.api/people', text=SOME_JSON) from your_requests_mock and make use of that – Simon Hawe Jan 17 '22 at 19:04
Great! Worked as expected! – Tiago Duque Jan 17 '22 at 19:09

How to reuse requests_mock in many tests

1 Answers1