Last active
December 9, 2020 16:20
-
-
Save blueyed/4fb0a807104551f103e6 to your computer and use it in GitHub Desktop.
Test Django data migrations
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
""" | |
Test (data) migrations in Django. | |
This uses py.test/pytest-django (the `transactional_db` fixture comes from there), | |
but could be easily adopted for Django's testrunner: | |
from django.test.testcases import TransactionTestCase | |
class FooTestcase(TransactionTestCase): | |
def test_with_django(self): | |
… | |
This example tests that some fields are properly migrated from a `Profile` model | |
to `User`. | |
""" | |
from django.db import connection | |
from django.db.migrations.executor import MigrationExecutor | |
def test_migrate_profile_to_user(transactional_db): | |
executor = MigrationExecutor(connection) | |
app = "YOUR_APP" | |
migrate_from = [(app, "000X_before")] | |
migrate_to = [(app, "000X_after")] | |
executor.migrate(migrate_from) | |
old_apps = executor.loader.project_state(migrate_from).apps | |
# Create some old data. | |
Profile = old_apps.get_model(app, "Profile") | |
old_profile = Profile.objects.create(email="email", | |
firstname="firstname", | |
lastname="lastname") | |
# Migrate forwards. | |
executor.loader.build_graph() # reload. | |
executor.migrate(migrate_to) | |
new_apps = executor.loader.project_state(migrate_to).apps | |
# Test the new data. | |
Profile = new_apps.get_model(app, "Profile") | |
User = new_apps.get_model(app, "UserEntry") | |
assert 'firstname' not in Profile._meta.get_all_field_names() | |
user = User.objects.get(email='email') | |
profile = Profile.objects.get(user__email='email') | |
assert user.profile.pk == old_profile.pk == profile.pk | |
assert profile.user.email == 'email' | |
assert profile.user.first_name == 'firstname' | |
assert profile.user.last_name == 'lastname' |
I have made a pypi
package out of this gist with some extra features.
Check it out: https://github.com/wemake-services/django-test-migrations
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Thanks @TauPan your version worked for me on Django 2.0 too.
Unfortunately, there is no support for
pytest.raises
for exceptions that occur during migrations, and possibly other issues, let's try to discuss it over at pytest-dev/pytest-django#593EDIT: I used @TauPan's updates (Gist-spection!) and cleaned my own fork a bit and allowed specifying a list of target migrations (when conditions span across multiple apps).