django-testmigrate

Run automated tests for your migrations.

Install

pip install django-testmigrate

Add "django_testmigrate" to your INSTALLED_APPS.

Run Your Tests

This command creates and then destroys a test database just like the Django test runner does. Migrations are run all the way forward and then as far backwards as possible.

./manage.py testmigrate

Add Tests to Your Migrations

Four optional test methods can be added to your migration classes:

• test_apply_start - Run before this migration.
• test_apply_success - Run after this migration.
• test_unapply_start - Run before this migration is reversed.
• test_unapply_success - Run after this migration is reversed.

They will not be run during the normal migration command, only during "testmigrate". This makes it possible to create models in your test database that you can write assertions against.

class Migration(migrations.Migration):

    dependencies = [
        ('myapp', '0001_initial'),
    ]

    operations = [
        migrations.RunPython(
            populate_data,
            populate_data_rev,
        ),
    ]

    def test_apply_start(self, apps, testcase):
        """
        self - This migration instance.
        apps - The project_state for this app, same as what's passed in to
            functions for migrations.RunPython.
        testcase - A TestCase instance to provide the assertions you're used to.
            This instance is shared between migration test functions in case you
            need to share state.
        """
        MyModel = apps.get_model("myapp", "MyModel")

        testcase.assertEqual(MyModel.objects.count(), 5)

    def test_apply_success(self, apps, testcase):
        pass

    def test_unapply_start(self, apps, testcase):
        pass

    def test_unapply_success(self, apps, testcase):
        pass

Please note, apps.get_model() will likely not work in 0001 migrations, since the app hasn't been registered yet. If you need to create data, put it in test_apply_start() for that app's 0002 migration.