Split migrations and model definition tests into another test suite

Author: macro1

runtests.py

@@ -17,7 +17,7 @@
     'simple_history.tests',
     'simple_history.tests.custom_user',
     'simple_history.tests.external',
-    'simple_history.tests.migration_test_app',
+    'simple_history.registry_tests.migration_test_app',
 
     'simple_history',
 
@@ -51,13 +51,6 @@
 
 
 def main():
-    # reset the test app migrations
-    for migration_path in [
-        join(dirname(__file__), 'simple_history', 'tests', 'migrations'),
-        join(dirname(__file__), 'simple_history', 'tests', 'migration_test_app', 'migrations'),
-    ]:
-        for migration_file_path in listdir(migration_path):
-            unlink(join(migration_path, migration_file_path))
 
     if not settings.configured:
         settings.configure(**DEFAULT_SETTINGS)
@@ -68,9 +61,10 @@ def main():
     except ImportError:
         from django.test.simple import DjangoTestSuiteRunner
         failures = DjangoTestSuiteRunner(failfast=False).run_tests(['tests'])
+        failures |= DjangoTestSuiteRunner(failfast=False).run_tests(['registry_tests'])
     else:
-        failures = DiscoverRunner(failfast=False).run_tests(
-            ['simple_history.tests'])
+        failures = DiscoverRunner(failfast=False).run_tests(['simple_history.tests'])
+        failures |= DiscoverRunner(failfast=False).run_tests(['simple_history.registry_tests'])
     sys.exit(failures)
 
 

simple_history/tests/migration_test_app/__init__.py renamed to simple_history/registry_tests/__init__.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.9.12 on 2017-01-18 21:58
+from __future__ import unicode_literals
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='DoYouKnow',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+            ],
+        ),
+        migrations.CreateModel(
+            name='HistoricalYar',
+            fields=[
+                ('id', models.IntegerField(auto_created=True, blank=True, db_index=True, verbose_name='ID')),
+                ('history_id', models.AutoField(primary_key=True, serialize=False)),
+                ('history_date', models.DateTimeField()),
+                ('history_type', models.CharField(choices=[('+', 'Created'), ('~', 'Changed'), ('-', 'Deleted')], max_length=1)),
+                ('history_user', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'verbose_name': 'historical yar',
+                'ordering': ('-history_date', '-history_id'),
+                'get_latest_by': 'history_date',
+            },
+        ),
+        migrations.CreateModel(
+            name='Yar',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+            ],
+        ),
+        migrations.CreateModel(
+            name='WhatIMean',
+            fields=[
+                ('doyouknow_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='migration_test_app.DoYouKnow')),
+            ],
+            bases=('migration_test_app.doyouknow',),
+        ),
+        migrations.AddField(
+            model_name='yar',
+            name='what',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='migration_test_app.WhatIMean'),
+        ),
+        migrations.AddField(
+            model_name='historicalyar',
+            name='what',
+            field=models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to='migration_test_app.WhatIMean'),
+        ),
+    ]

simple_history/tests/migration_test_app/migrations/__init__.py renamed to simple_history/registry_tests/migration_test_app/__init__.py

@@ -0,0 +1,153 @@
+from __future__ import unicode_literals
+
+from datetime import datetime, timedelta
+from six.moves import cStringIO as StringIO
+import unittest
+
+import django
+from django.contrib.auth import get_user_model
+from django.core import management
+from django.test import TestCase
+
+from simple_history import exceptions, register
+from ..tests.models import (
+    Poll, Choice, Voter, Restaurant, HistoricalPoll, HistoricalChoice,
+    HistoricalState, HistoricalCustomFKError,
+    UserAccessorDefault, UserAccessorOverride,
+    TrackedAbstractBaseA, TrackedAbstractBaseB,
+    TrackedWithAbstractBase, TrackedWithConcreteBase,
+    InheritTracking1, InheritTracking2, InheritTracking3, InheritTracking4,
+)
+
+try:
+    from django.apps import apps
+except ImportError:  # Django < 1.7
+    from django.db.models import get_model
+else:
+    get_model = apps.get_model
+
+User = get_user_model()
+today = datetime(2021, 1, 1, 10, 0)
+tomorrow = today + timedelta(days=1)
+yesterday = today - timedelta(days=1)
+
+
+class RegisterTest(TestCase):
+    def test_register_no_args(self):
+        self.assertEqual(len(Choice.history.all()), 0)
+        poll = Poll.objects.create(pub_date=today)
+        choice = Choice.objects.create(poll=poll, votes=0)
+        self.assertEqual(len(choice.history.all()), 1)
+
+    def test_register_separate_app(self):
+        def get_history(model):
+            return model.history
+
+        self.assertRaises(AttributeError, get_history, User)
+        self.assertEqual(len(User.histories.all()), 0)
+        user = User.objects.create(username='bob', password='pass')
+        self.assertEqual(len(User.histories.all()), 1)
+        self.assertEqual(len(user.histories.all()), 1)
+
+    def test_reregister(self):
+        with self.assertRaises(exceptions.MultipleRegistrationsError):
+            register(Restaurant, manager_name='again')
+
+    def test_register_custome_records(self):
+        self.assertEqual(len(Voter.history.all()), 0)
+        poll = Poll.objects.create(pub_date=today)
+        choice = Choice.objects.create(poll=poll, votes=0)
+        user = User.objects.create(username='voter')
+        voter = Voter.objects.create(choice=choice, user=user)
+        self.assertEqual(len(voter.history.all()), 1)
+        expected = 'Voter object changed by None as of '
+        self.assertEqual(expected,
+                         str(voter.history.all()[0])[:len(expected)])
+
+
+class TestUserAccessor(unittest.TestCase):
+
+    def test_accessor_default(self):
+        register(UserAccessorDefault)
+        assert not hasattr(User, 'historicaluseraccessordefault_set')
+
+    def test_accessor_override(self):
+        register(UserAccessorOverride,
+                 user_related_name='my_history_model_accessor')
+        assert hasattr(User, 'my_history_model_accessor')
+
+
+class TestTrackingInheritance(TestCase):
+
+    def test_tracked_abstract_base(self):
+        self.assertEqual(
+            [
+                f.attname
+                for f in TrackedWithAbstractBase.history.model._meta.fields
+            ],
+            [
+                'id', 'history_id', 'history_date', 'history_user_id',
+                'history_type',
+            ],
+        )
+
+    def test_tracked_concrete_base(self):
+        self.assertEqual(
+            [
+                f.attname
+                for f in TrackedWithConcreteBase.history.model._meta.fields
+            ],
+            [
+                'id', 'trackedconcretebase_ptr_id', 'history_id',
+                'history_date', 'history_user_id', 'history_type',
+            ],
+        )
+
+    def test_multiple_tracked_bases(self):
+        with self.assertRaises(exceptions.MultipleRegistrationsError):
+            class TrackedWithMultipleAbstractBases(
+                    TrackedAbstractBaseA, TrackedAbstractBaseB):
+                pass
+
+    def test_tracked_abstract_and_untracked_concrete_base(self):
+        self.assertEqual(
+            [f.attname for f in InheritTracking1.history.model._meta.fields],
+            [
+                'id', 'untrackedconcretebase_ptr_id', 'history_id',
+                'history_date', 'history_user_id', 'history_type',
+            ],
+        )
+
+    def test_indirect_tracked_abstract_base(self):
+        self.assertEqual(
+            [f.attname for f in InheritTracking2.history.model._meta.fields],
+            [
+                'id', 'baseinherittracking2_ptr_id', 'history_id',
+                'history_date', 'history_user_id', 'history_type',
+            ],
+        )
+
+    def test_indirect_tracked_concrete_base(self):
+        self.assertEqual(
+            [f.attname for f in InheritTracking3.history.model._meta.fields],
+            [
+                'id', 'baseinherittracking3_ptr_id', 'history_id',
+                'history_date', 'history_user_id', 'history_type',
+            ],
+        )
+
+    def test_registering_with_tracked_abstract_base(self):
+        with self.assertRaises(exceptions.MultipleRegistrationsError):
+            register(InheritTracking4)
+
+
+@unittest.skipUnless(django.get_version() >= "1.7", "Requires 1.7 migrations")
+class TestMigrate(TestCase):
+
+    def test_makemigration_command(self):
+        management.call_command(
+            'makemigrations', 'migration_test_app', stdout=StringIO())
+
+    def test_migrate_command(self):
+        management.call_command(
+            'migrate', 'migration_test_app', fake=True, stdout=StringIO())

simple_history/registry_tests/migration_test_app/migrations/0001_initial.py

@@ -1,13 +1,10 @@
 from contextlib import contextmanager
-from six.moves import cStringIO as StringIO
 from datetime import datetime
-try:
-    from unittest import skipUnless
-except ImportError:
-    from unittest2 import skipUnless
-import django
+
+from six.moves import cStringIO as StringIO
 from django.test import TestCase
 from django.core import management
+
 from simple_history import models as sh_models
 from simple_history.management.commands import populate_history
 
@@ -106,15 +103,3 @@ def test_no_historical(self):
                                     stdout=out)
         self.assertIn(populate_history.Command.NO_REGISTERED_MODELS,
                       out.getvalue())
-
-
-@skipUnless(django.get_version() >= "1.7", "Requires 1.7 migrations")
-class TestMigrate(TestCase):
-
-    def test_makemigration_command(self):
-        management.call_command(
-            'makemigrations', 'migration_test_app', stdout=StringIO())
-
-    def test_migrate_command(self):
-        management.call_command(
-            'migrate', 'migration_test_app', fake=True, stdout=StringIO())