Testing with external services in PyTest - Framework Patterns

Framework Mode - Testing with external services

Folder Structure

tests/
├── test_api.py           # Tests interacting with external APIs
├── test_db.py            # Tests involving external databases
├── test_auth.py          # Tests for authentication services
conftest.py               # Fixtures for setup and teardown
utils/
├── api_client.py         # Wrapper for external API calls
├── db_helper.py          # Helpers for database connections
configs/
├── config.yaml           # Environment and credentials configuration
reports/
├── latest_report.html    # Test execution reports

Test Framework Layers

• Test Layer: Contains pytest test files that call external services through utility wrappers.
• Utility Layer: Contains helper modules like api_client.py to handle API requests and db_helper.py for database connections.
• Fixture Layer: conftest.py defines pytest fixtures to setup and teardown external service connections safely.
• Configuration Layer: Stores environment variables, credentials, and service URLs in configs/config.yaml for easy management.
• Reporting Layer: Generates readable test reports after execution, stored in reports/.

Configuration Patterns

• Environment Separation: Use config.yaml to define different environments (dev, staging, prod) with URLs and credentials.
• Secure Credentials: Store sensitive data outside code, load them at runtime using environment variables or encrypted files.
• Parameterization: Use pytest command line options or fixtures to select environment and service endpoints dynamically.
• Timeouts and Retries: Configure sensible timeouts and retry logic in utility wrappers to handle flaky external services gracefully.

Test Reporting and CI/CD Integration

• Use pytest plugins like pytest-html to generate detailed HTML reports stored in reports/.
• Integrate tests into CI/CD pipelines (GitHub Actions, Jenkins) to run tests on every code push or schedule.
• Configure CI to securely inject environment variables and credentials for external services.
• Fail builds on test failures to ensure external service integration issues are caught early.

Best Practices

• Use Mocks and Stubs: When possible, mock external services to avoid dependency on their availability during tests.
• Isolate Tests: Design tests to be independent and idempotent, so failures in one do not affect others.
• Explicit Waits and Timeouts: Handle network delays and service response times carefully to avoid flaky tests.
• Clean Up: Ensure tests clean up any data or state changes made in external services to keep environments stable.
• Logging and Debugging: Add detailed logs for external calls to help diagnose failures quickly.

Self Check

Where would you add a new utility module to handle authentication tokens for an external API in this framework structure?

Key Result

Organize pytest tests with utility wrappers, fixtures, and config files to manage external service interactions cleanly and reliably.

Practice

1. What is the main reason to use mocking when testing with external services in pytest?

easy

A. To avoid calling the real external service and make tests faster

B. To increase the number of real API calls during testing

C. To make tests dependent on internet speed

D. To test the external service itself

Solution

1. Step 1: Understand the role of mocking in tests

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

2. Step 2: Identify the benefit of mocking external services

   Mocking makes tests faster and more reliable by not depending on real services.

3. Final Answer:

   To avoid calling the real external service and make tests faster -> Option A

4. Quick Check:

   Mocking speeds up tests by faking external calls [OK]

Hint: Mock external calls to speed tests and avoid failures [OK]

Common Mistakes:

• Thinking mocking increases real API calls
• Believing tests should depend on internet speed
• Confusing testing external service with testing your code

2. Which of the following is the correct way to mock a function get_data from module external_api using pytest's patch decorator?

easy

A. @patch('external_api.get_data')

B. @patch('get_data.external_api')

C. @patch('external_api->get_data')

D. @patch('external_api.getData')

Solution

1. Step 1: Recall correct patch syntax

   The patch decorator requires the full import path as a string: 'module.function'.

2. Step 2: Match the correct option

   @patch('external_api.get_data') uses 'external_api.get_data' which is the correct format and case-sensitive.

3. Final Answer:

   @patch('external_api.get_data') -> Option A

4. Quick Check:

   patch('module.function') syntax is correct [OK]

Hint: Use 'module.function' string in patch decorator [OK]

Common Mistakes:

• Swapping module and function order
• Using wrong separators like '->'
• Incorrect function name casing

3. Given the following pytest test code, what will be the output when running the test?

from unittest.mock import patch
import requests

def fetch_status():
    response = requests.get('https://api.example.com/data')
    return response.status_code

@patch('requests.get')
def test_fetch_status(mock_get):
    mock_get.return_value.status_code = 200
    assert fetch_status() == 200
    print('Test passed')

medium

A. TypeError

B. AssertionError

C. Test passed

D. No output

Solution

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

   The patch replaces requests.get with a mock that returns an object with status_code 200.

2. Step 2: Check assertion and print statement

   fetch_status() returns 200, matching the assertion, so 'Test passed' is printed.

3. Final Answer:

   Test passed -> Option C

4. Quick Check:

   Mocked return_value.status_code = 200 makes test pass [OK]

Hint: Mock return_value to control function output [OK]

Common Mistakes:

• Forgetting to set return_value.status_code
• Expecting real HTTP call instead of mock
• Missing print output due to assertion failure

4. Identify the error in the following pytest test that mocks an external service call:

from unittest.mock import patch
import myservice

@patch('myservice.call_api')
def test_api(mock_call):
    mock_call.return_value = {'status': 'ok'}
    result = myservice.call_api()
    assert result.status == 'ok'

medium

A. The patch decorator is missing parentheses

B. The assertion should use result['status'] instead of result.status

C. mock_call.return_value should be a string, not a dict

D. The test function is missing a return statement

Solution

1. Step 1: Analyze the mocked return value type

   The mock returns a dictionary {'status': 'ok'}, so result is a dict.

2. Step 2: Check the assertion syntax

   Accessing dict keys requires bracket notation, not dot notation; result.status causes AttributeError.

3. Final Answer:

   The assertion should use result['status'] instead of result.status -> Option B

4. Quick Check:

   Dict keys need brackets, not dot notation [OK]

Hint: Use brackets for dict keys in assertions [OK]

Common Mistakes:

• Using dot notation on dicts
• Forgetting parentheses in patch decorator (not here)
• Expecting return_value must be string always

5. You want to test a function process_data() that calls an external API fetch_data(). The API sometimes returns null. How should you mock fetch_data in pytest to test process_data handles null correctly?

hard

A. Do not mock fetch_data; test process_data only with real data

B. Call the real fetch_data to see if it returns null

C. Mock fetch_data to always raise an exception

D. Use patch to make fetch_data return null and assert process_data handles it

Solution

1. Step 1: Understand the need to test null handling

   Since fetch_data can return null, tests must simulate this to check process_data behavior.

2. Step 2: Use patch to mock fetch_data returning null

   Mocking fetch_data to return null allows controlled testing of process_data's handling of that case.

3. Final Answer:

   Use patch to make fetch_data return null and assert process_data handles it -> Option D

4. Quick Check:

   Mock null return to test edge case handling [OK]

Hint: Mock edge cases like null to test error handling [OK]

Common Mistakes:

• Calling real external API in tests
• Mocking only success cases, ignoring null
• Ignoring exceptions instead of testing them