Migrate emails to lower case

renzon · renzon · commit 7074d5df5b0b · 2020-02-28T15:41:39.000-03:00
Conflicting emails are been logged to manual handling close #1694
diff --git a/.gitignore b/.gitignore
@@ -24,6 +24,7 @@ wheels/
 *.egg-info/
 .installed.cfg
 *.egg
+dumps/
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
diff --git a/Pipfile b/Pipfile
@@ -39,6 +39,7 @@ pytest-django = "*"
 pytest-freezegun = "*"
 pytest-mock = "*"
 pytest = "*"
+django-test-migrations = "*"
 
 [requires]
 python_version = "3.8"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/pythonpro/core/migrations/0010_normalizing_email.py b/pythonpro/core/migrations/0010_normalizing_email.py
@@ -0,0 +1,39 @@
+# Generated by Django 3.0.3 on 2020-02-28 11:30
+
+from django.db import IntegrityError, migrations
+
+from django.db.transaction import atomic
+
+
+def normalize_email(apps, schema_editor):
+    '''
+    We can't import the Post model directly as it may be a newer
+    version than this migration expects. We use the historical version.
+    '''
+    User = apps.get_model('core', 'User')
+    print()
+    for msg in normalize_all_users_email(User):
+        print(msg)
+
+
+def normalize_all_users_email(User):
+    for user in User.objects.order_by('id').all():
+        original_email = user.email
+        normalized_email = user.email.lower()
+        if normalized_email != original_email:
+            user.email = normalized_email
+            try:
+                with atomic():
+                    user.save()
+            except IntegrityError:
+                yield f'Normalization error user {user.id}, {original_email}'
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('core', '0009_auto_20191031_1324'),
+    ]
+
+    operations = [
+        migrations.RunPython(normalize_email, migrations.RunPython.noop)
+    ]
diff --git a/pythonpro/core/tests/test_email_migration.py b/pythonpro/core/tests/test_email_migration.py
@@ -0,0 +1,32 @@
+from importlib import import_module
+
+from model_mommy import mommy
+
+# Workaround since module beginning with number can't be imported in regular way
+migration_module = import_module('pythonpro.core.migrations.0010_normalizing_email')
+
+
+def test_user_email_normalization_success(django_user_model):
+    """Ensures email can be normalized"""
+
+    upper_email = 'UPPER@python.pro.br'
+    mommy.make(django_user_model, email=upper_email)
+    msg = next(migration_module.normalize_all_users_email(django_user_model), None)
+    assert msg is None
+    assert django_user_model.objects.first().email == upper_email.lower()
+
+
+def test_no_msg_for_already_normalized_emails(django_user_model):
+    mommy.make(django_user_model, email='lower@python.pro.br')
+    msg = next(migration_module.normalize_all_users_email(django_user_model), None)
+    assert msg is None
+
+
+def test_conflictiong_email_msg(django_user_model):
+    lower_email = 'normalized@python.pro.br'
+    upper_email = 'NORMALIZED@python.pro.br'
+    upper_email_user = mommy.make(django_user_model, email=upper_email)
+    mommy.make(django_user_model, email=lower_email)
+    msg = next(migration_module.normalize_all_users_email(django_user_model))
+    upper_email_user = django_user_model.objects.get(id=upper_email_user.id)
+    assert msg == f'Normalization error user {upper_email_user.id}, {upper_email_user.email}'
