HTTPretty: Intercepting HTTP Requests for Python Testing

Introduction

HTTPretty is a Python library created by Gabriel Falcão that provides a comprehensive solution for mocking HTTP client requests. It operates by intercepting HTTP requests at the Python socket level, effectively faking the entire socket module. This capability makes HTTPretty an invaluable tool for developers working on API integrations, enabling them to simulate external service responses without making actual network calls. Inspired by FakeWeb, HTTPretty simplifies the process of creating isolated and repeatable tests for applications that interact with web services.

Installation

To get started with HTTPretty, you can easily install it using pip:

pip install httpretty

Examples

Simple Example

This example demonstrates how to register a GET request and assert the response and request details.

import sure
import httpretty
import requests


@httpretty.activate(verbose=True, allow_net_connect=False)
def test_httpbin():
    httpretty.register_uri(
        httpretty.GET,
        "https://httpbin.org/ip",
        body='{"origin": "127.0.0.1"}'
    )

    response = requests.get('https://httpbin.org/ip')
    response.json().should.equal({'origin': '127.0.0.1'})

    httpretty.latest_requests().should.have.length_of(1)
    httpretty.last_request().should.equal(httpretty.latest_requests()[0])
    httpretty.last_request().body.should.equal('{"origin": "127.0.0.1"}')

Checking Multiple Responses

This example shows how to register multiple responses for the same URL and verify the request bodies.

@httpretty.activate(verbose=True, allow_net_connect=False)
def test_post_bodies():
    url = 'http://httpbin.org/post'
    httpretty.register_uri(httpretty.POST, url, status=200)
    httpretty.register_uri(httpretty.POST, url, status=400)
    requests.post(url, data={'foo': 'bar'})
    requests.post(url, data={'zoo': 'zoo'})
    assert 'foo=bar' in httpretty.latest_requests()[0].body
    assert 'zoo=bar' in httpretty.latest_requests()[1].body

Why Use HTTPretty?

HTTPretty is essential for robust software development, especially when dealing with external APIs. Its primary benefits include:

• Test-Driven Development (TDD) of API Integrations: Facilitates writing tests for API clients before or during implementation, ensuring correct behavior.
• Faking Responses of External APIs: Allows developers to simulate various API responses, including success, failure, and edge cases, without relying on actual external services.
• Recording and Playback of HTTP Requests: Useful for debugging, performance testing, and creating repeatable test scenarios.
• Isolation and Speed: By intercepting requests at the socket level, HTTPretty ensures tests are isolated from network latency and external service availability, leading to faster and more reliable test suites.

Links

• GitHub Repository
• Documentation
• PyPI Package