Mocking external services in Flask - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is mocking in the context of testing Flask applications?

Mocking means creating fake versions of external services or functions so tests can run without calling real services. It helps test your code safely and quickly.

beginner

Why do we mock external services in Flask tests?

We mock external services to avoid slow or unreliable network calls, control test data, and test how our app handles different responses without depending on real services.

beginner

Which Python library is commonly used to mock external services in Flask tests?

The 'unittest.mock' library is commonly used to replace parts of your system with mock objects during tests.

intermediate

How does the 'patch' decorator help in mocking external services?

The 'patch' decorator temporarily replaces a real function or service with a mock version during a test, so the real external call is not made.

intermediate

What is a common pattern to mock an HTTP request to an external API in Flask tests?

You mock the function that makes the HTTP request (like 'requests.get') to return a fake response object with the data you want for your test.

What is the main benefit of mocking external services in Flask tests?

A To skip writing tests

B To make the app run slower

C To increase dependency on external APIs

D To avoid real network calls and speed up tests

Mocking avoids real network calls, making tests faster and more reliable.

Which Python module provides tools to mock functions in Flask tests?

A unittest.mock

B flask.mock

C requests

D json

'unittest.mock' is the standard Python library for mocking.

What does the 'patch' decorator do in mocking?

A Deletes the function permanently

B Runs the real function twice

C Replaces a real function with a mock during a test

D Creates a new Flask app

'patch' temporarily replaces a function with a mock for testing.

When mocking an HTTP request, what should the mock return?

A A fake response object with test data

B An error to stop the test

C Nothing at all

D The real HTTP response

Mocks return fake responses to simulate external service behavior.

Why is it important to control test data when mocking external services?

A To make tests unpredictable

B To test how your app handles different responses

C To avoid writing test cases

D To slow down the test suite

Controlling test data helps test app behavior under various conditions.

Explain how you would mock an external API call in a Flask test using 'unittest.mock'.

Think about replacing 'requests.get' or similar with a mock.

Why is mocking external services important for reliable and fast Flask tests?

Consider what happens if tests depend on real external services.

Practice

1. What is the main reason to mock external services in Flask testing?

easy

A. To change the Flask app configuration permanently

B. To speed up the Flask server in production

C. To add more routes to the Flask app

D. To avoid making real network calls during tests

Solution

1. Step 1: Understand the purpose of mocking

   Mocking replaces real external calls with fake ones to avoid delays and failures during tests.

2. Step 2: Identify the benefit in Flask testing

   This avoids real network calls, making tests faster and more reliable.

3. Final Answer:

   To avoid making real network calls during tests -> Option D

4. Quick Check:

   Mocking = Avoid real network calls [OK]

Hint: Mock to skip real network calls in tests [OK]

Common Mistakes:

• Thinking mocking speeds up production
• Confusing mocking with adding routes
• Believing mocking changes app config permanently

2. Which of the following is the correct way to patch an external function requests.get in a Flask test using unittest.mock?

easy

A. with patch('requests.get') as mock_get:

B. with patch(requests.get) as mock_get:

C. with patch('requests->get') as mock_get:

D. with patch('requests_get') as mock_get:

Solution

1. Step 1: Understand patch syntax

   Patch requires the full path as a string, e.g., 'requests.get'.

2. Step 2: Identify correct string format

   with patch('requests.get') as mock_get: uses the correct string 'requests.get'. Others use invalid syntax or missing quotes.

3. Final Answer:

   with patch('requests.get') as mock_get: -> Option A

4. Quick Check:

   Patch needs string path = with patch('requests.get') as mock_get: [OK]

Hint: Patch uses string path like 'module.function' [OK]

Common Mistakes:

• Passing function object instead of string
• Using wrong string format with arrows
• Missing quotes around patch target

3. Given this Flask test code snippet, what will be printed?

from unittest.mock import patch
import requests

def fetch_data():
    response = requests.get('http://example.com')
    return response.status_code

with patch('requests.get') as mock_get:
    mock_get.return_value.status_code = 404
    print(fetch_data())

medium

A. None

B. 200

C. 404

D. Raises an error

Solution

1. Step 1: Understand patch effect on requests.get

   The patch replaces requests.get with a mock whose return_value.status_code is set to 404.

2. Step 2: Trace fetch_data call inside patch

   fetch_data calls requests.get, which returns the mock with status_code 404, so fetch_data returns 404.

3. Final Answer:

   404 -> Option C

4. Quick Check:

   Mocked status_code = 404 [OK]

Hint: Mock return_value sets fake response attributes [OK]

Common Mistakes:

• Expecting real HTTP 200 response
• Confusing mock object with None
• Thinking patch causes error

4. What is wrong with this Flask test code that tries to mock requests.post?

from unittest.mock import patch
import requests

def send_data():
    response = requests.post('http://example.com', data={'key': 'value'})
    return response.ok

with patch('requests.post') as mock_post:
    mock_post.ok = True
    print(send_data())

medium

A. mock_post.ok should be set on return_value, not mock_post

B. patch target should be 'requests.get' not 'requests.post'

C. send_data should use requests.get instead of post

D. mock_post.ok is correct and code works fine

Solution

1. Step 1: Identify mock object usage

   mock_post is the mock for requests.post function, its return_value simulates the response object.

2. Step 2: Correct attribute assignment

   Setting mock_post.ok sets attribute on the function mock, not the response. It should be mock_post.return_value.ok = True.

3. Final Answer:

   mock_post.ok should be set on return_value, not mock_post -> Option A

4. Quick Check:

   Mock response attributes go on return_value [OK]

Hint: Set mock response attributes on return_value [OK]

Common Mistakes:

• Setting attributes on mock function instead of return_value
• Confusing post with get method
• Assuming code works without fixing mock

5. You want to test a Flask route that calls an external API and returns JSON data. Which approach correctly mocks the external API call and returns a custom JSON response {"success": true} during the test?

hard

A. Use patch on the Flask route function and return {"success": true} directly

B. Use patch on the external call, set return_value.json.return_value = {"success": true}

C. Call the real external API and check if it returns {"success": true}

D. Mock the Flask app config to include {"success": true}

Solution

1. Step 1: Identify what to mock

   The external API call (e.g., requests.get) should be mocked to avoid real network calls.

2. Step 2: Set mock return JSON data

   Set the mock's return_value.json.return_value to the desired JSON dict to simulate API response.

3. Final Answer:

   Use patch on the external call, set return_value.json.return_value = {"success": true} -> Option B

4. Quick Check:

   Mock external call's json() method = Use patch on the external call, set return_value.json.return_value = {"success": true} [OK]

Hint: Mock return_value.json.return_value for JSON responses [OK]

Common Mistakes:

• Mocking Flask route instead of external call
• Calling real API in tests
• Changing app config instead of mocking