django-responsediff 0.9.0

HTTP response diffing against fixtures for testing

django-responsediff

I’m pretty lazy when it comes to writing tests for existing code, however, I’m even lazier when it comes to repetitive manual testing action.

This package aims at de-duplicating view tests inside the political-memory itself and to make it reusable for other apps.

It’s pretty much the same as django-dbdiff, except this is for HTTP response.

Response state assertion

When my user tests, he browses the website and checks that everything is rendered fine. This app allows to do high-level checks of HTML rendering.

See responsediff/response.py docstrings for example usage, or use the conveniance mixin:

from responsediff.test import ResponseDiffTestMixin

class MixinTest(ResponseDiffTestMixin, test.TestCase):
    def test_admin(self):
        self.assertResponseDiffEmpty(test.Client().get('/admin/'))

The above will fail on the first time with FixtureCreated to indicate that it has written responsediff/tests/response_fixtures/MixinTest.test_admin/{content,status_code}. This file is meant to be added to version control. So next time this will run, it will check that response.status_code and response.content is the same, in future version, or in other configurations.

Instead of deleting the fixtures manually before running the tests to regenerate them, just run your tests with FIXTURE_REWRITE=1 environment variable. This will overwrite the fixtures and make the tests look like they passed.

You can also use assertWebsiteSame to crawl your site automatically:

class SiteTest(ResponseDiffTestMixin, test.TestCase):
    def test_site(self):
        self.assertWebsiteSame()

Requirements

Python 3.10 through 3.14 and Django 4.2 (LTS), 5.2 (LTS), and 6.0 are supported. Install with pip:

pip install django-responsediff

Related app

A somewhat similar app which inspired django-responsediff is django-test-utils.