Mocking external services in Flask

Introduction

Mocking external services helps you test your Flask app without calling real outside servers. It saves time and avoids errors from network issues.

You want to test your app's response to an external API without using the real API.

You need to simulate slow or failing external services to see how your app handles them.

You want to run tests offline without internet access.

You want to control the data returned by external services for consistent test results.

Syntax

Flask

from unittest.mock import patch
import requests

@patch('requests.get')
def test_function(mock_get):
    mock_get.return_value.status_code = 200
    mock_get.return_value.json.return_value = {'key': 'value'}
    response = requests.get('http://fakeapi.com/data')
    # Your test code here

Use @patch to replace the real external call with a mock during tests.

Set the mock's return values to simulate different responses.

Examples

This mocks a successful API call returning JSON data.

Flask

from unittest.mock import patch
import requests

@patch('requests.get')
def test_success(mock_get):
    mock_get.return_value.status_code = 200
    mock_get.return_value.json.return_value = {'message': 'ok'}
    response = requests.get('http://example.com')
    print(response.json())

This mocks a failed API call returning a 404 status.

Flask

from unittest.mock import patch
import requests

@patch('requests.get')
def test_failure(mock_get):
    mock_get.return_value.status_code = 404
    response = requests.get('http://example.com')
    print(response.status_code)

Sample Program

This Flask app has a route that calls an external API. The test function mocks the external call to return fixed data. When run, it prints the mocked JSON response.

Flask

from flask import Flask, jsonify
import requests
from unittest.mock import patch

app = Flask(__name__)

@app.route('/data')
def get_data():
    response = requests.get('http://external-service.com/api')
    if response.status_code == 200:
        return jsonify(response.json())
    else:
        return jsonify({'error': 'Failed to get data'}), 500

@patch('requests.get')
def test_get_data(mock_get):
    mock_get.return_value.status_code = 200
    mock_get.return_value.json.return_value = {'name': 'Test User', 'age': 30}
    with app.test_client() as client:
        response = client.get('/data')
        print(response.json)

if __name__ == '__main__':
    test_get_data()

Important Notes

Always patch the exact location where the external call is used, not where it is defined.

Mocking helps keep tests fast and reliable.

Summary

Mock external services to test your Flask app without real network calls.

Use unittest.mock.patch to replace external calls with fake responses.

This makes your tests faster, more reliable, and easier to control.

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