Merge pull request #100 from macro1/demonstrate-admin-history-user-se…

…tter

Add tests to demonstrate #43

simple_history/tests/admin.py

@@ -3,7 +3,7 @@
 from django.contrib import admin
 
 from simple_history.admin import SimpleHistoryAdmin
-from .models import Poll, Choice, Person, Book
+from .models import Poll, Choice, Person, Book, Document, Paper
 
 
 class PersonAdmin(SimpleHistoryAdmin):
@@ -15,3 +15,5 @@ def has_change_permission(self, request, obj=None):
 admin.site.register(Choice, SimpleHistoryAdmin)
 admin.site.register(Person, PersonAdmin)
 admin.site.register(Book, SimpleHistoryAdmin)
+admin.site.register(Document, SimpleHistoryAdmin)
+admin.site.register(Paper, SimpleHistoryAdmin)

simple_history/tests/models.py

@@ -82,14 +82,22 @@ class FileModel(models.Model):
 
 
 class Document(models.Model):
-    changed_by = models.ForeignKey(User, null=True)
+    changed_by = models.ForeignKey(User, null=True, blank=True)
     history = HistoricalRecords()
 
     @property
     def _history_user(self):
         return self.changed_by
 
 
+class Paper(Document):
+    history = HistoricalRecords()
+
+    @Document._history_user.setter
+    def _history_user(self, value):
+        self.changed_by = value
+
+
 class Profile(User):
     date_of_birth = models.DateField()
 

simple_history/tests/tests/__init__.py

@@ -1,2 +1,3 @@
 from .test_models import *
+from .test_admin import *
 from .test_commands import *

simple_history/tests/tests/test_admin.py

@@ -0,0 +1,157 @@
+from datetime import datetime, timedelta
+from django_webtest import WebTest
+from django import VERSION
+from django.core.urlresolvers import reverse
+try:
+    from django.contrib.auth import get_user_model
+    User = get_user_model()
+except ImportError:  # django 1.4 compatibility
+    from django.contrib.auth.models import User
+from django.contrib.admin.util import quote
+
+from ..models import Book, Document, Person, Poll
+
+
+today = datetime(2021, 1, 1, 10, 0)
+tomorrow = today + timedelta(days=1)
+
+
+def get_history_url(model, history_index=None):
+    try:
+        info = model._meta.app_label, model._meta.module_name
+    except AttributeError:
+        info = model._meta.app_label, model._meta.model_name
+    if history_index is not None:
+        history = model.history.order_by('history_id')[history_index]
+        return reverse('admin:%s_%s_simple_history' % info,
+                       args=[quote(model.pk), quote(history.history_id)])
+    else:
+        return reverse('admin:%s_%s_history' % info, args=[quote(model.pk)])
+
+
+class AdminSiteTest(WebTest):
+    def setUp(self):
+        self.user = User.objects.create_superuser('user_login',
+                                                  'u@example.com', 'pass')
+
+    def login(self, user=None):
+        if user is None:
+            user = self.user
+        form = self.app.get(reverse('admin:index')).maybe_follow().form
+        form['username'] = user.username
+        form['password'] = 'pass'
+        return form.submit()
+
+    def test_history_list(self):
+        if VERSION >= (1, 5):
+            try:
+                module_name = self.user._meta.module_name
+            except AttributeError:
+                module_name = self.user._meta.model_name
+            self.assertEqual(module_name, 'customuser')
+        self.login()
+        poll = Poll(question="why?", pub_date=today)
+        poll._history_user = self.user
+        poll.save()
+        response = self.app.get(get_history_url(poll))
+        self.assertIn(get_history_url(poll, 0), response.unicode_normal_body)
+        self.assertIn("Poll object", response.unicode_normal_body)
+        self.assertIn("Created", response.unicode_normal_body)
+        self.assertIn(self.user.username, response.unicode_normal_body)
+
+    def test_history_form_permission(self):
+        self.login(self.user)
+        person = Person.objects.create(name='Sandra Hale')
+        self.app.get(get_history_url(person, 0), status=403)
+
+    def test_invalid_history_form(self):
+        self.login()
+        poll = Poll.objects.create(question="why?", pub_date=today)
+        response = self.app.get(get_history_url(poll, 0))
+        response.form['question'] = ""
+        response = response.form.submit()
+        self.assertEqual(response.status_code, 200)
+        self.assertIn("This field is required", response.unicode_normal_body)
+
+    def test_history_form(self):
+        self.login()
+        poll = Poll.objects.create(question="why?", pub_date=today)
+        poll.question = "how?"
+        poll.save()
+
+        # Make sure form for initial version is correct
+        response = self.app.get(get_history_url(poll, 0))
+        self.assertEqual(response.form['question'].value, "why?")
+        self.assertEqual(response.form['pub_date_0'].value, "2021-01-01")
+        self.assertEqual(response.form['pub_date_1'].value, "10:00:00")
+
+        # Create new version based on original version
+        response.form['question'] = "what?"
+        response.form['pub_date_0'] = "2021-01-02"
+        response = response.form.submit()
+        self.assertEqual(response.status_code, 302)
+        if VERSION < (1, 4, 0):
+            self.assertTrue(response.headers['location']
+                            .endswith(get_history_url(poll)))
+        else:
+            self.assertTrue(response.headers['location']
+                            .endswith(reverse('admin:tests_poll_changelist')))
+
+        # Ensure form for second version is correct
+        response = self.app.get(get_history_url(poll, 1))
+        self.assertEqual(response.form['question'].value, "how?")
+        self.assertEqual(response.form['pub_date_0'].value, "2021-01-01")
+        self.assertEqual(response.form['pub_date_1'].value, "10:00:00")
+
+        # Ensure form for new third version is correct
+        response = self.app.get(get_history_url(poll, 2))
+        self.assertEqual(response.form['question'].value, "what?")
+        self.assertEqual(response.form['pub_date_0'].value, "2021-01-02")
+        self.assertEqual(response.form['pub_date_1'].value, "10:00:00")
+
+        # Ensure current version of poll is correct
+        poll = Poll.objects.get()
+        self.assertEqual(poll.question, "what?")
+        self.assertEqual(poll.pub_date, tomorrow)
+        self.assertEqual([p.history_user for p in Poll.history.all()],
+                         [self.user, None, None])
+
+    def test_history_user_on_save_in_admin(self):
+        self.login()
+
+        # Ensure polls created via admin interface save correct user
+        add_page = self.app.get(reverse('admin:tests_poll_add'))
+        add_page.form['question'] = "new poll?"
+        add_page.form['pub_date_0'] = "2012-01-01"
+        add_page.form['pub_date_1'] = "10:00:00"
+        changelist_page = add_page.form.submit().follow()
+        self.assertEqual(Poll.history.get().history_user, self.user)
+
+        # Ensure polls saved on edit page in admin interface save correct user
+        change_page = changelist_page.click("Poll object")
+        change_page.form.submit()
+        self.assertEqual([p.history_user for p in Poll.history.all()],
+                         [self.user, self.user])
+
+    def test_underscore_in_pk(self):
+        self.login()
+        book = Book(isbn="9780147_513731")
+        book._history_user = self.user
+        book.save()
+        response = self.app.get(get_history_url(book))
+        self.assertIn(book.history.all()[0].revert_url(), response.unicode_normal_body)
+
+    def test_historical_user_no_setter(self):
+        """Demonstrate admin error without `_historical_user` setter.
+        (Issue #43)
+
+        """
+        self.login()
+        add_page = self.app.get(reverse('admin:tests_document_add'))
+        self.assertRaises(AttributeError, add_page.form.submit)
+
+    def test_historical_user_with_setter(self):
+        """Documented work-around for #43"""
+        self.login()
+        add_page = self.app.get(reverse('admin:tests_paper_add'))
+        add_page.form.submit()

simple_history/tests/tests/test_models.py

@@ -2,18 +2,14 @@
 
 from datetime import datetime, timedelta
 
-from django import VERSION
 try:
     from django.contrib.auth import get_user_model
     User = get_user_model()
 except ImportError:  # django 1.4 compatibility
     from django.contrib.auth.models import User
 from django.db.models.loading import get_model
 from django.test import TestCase
-from django_webtest import WebTest
 from django.core.files.base import ContentFile
-from django.core.urlresolvers import reverse
-from django.contrib.admin.util import quote
 
 from simple_history.models import HistoricalRecords
 from simple_history import register
@@ -457,132 +453,6 @@ def test_foreignkey_field(self):
         self.assertEqual(poll_as_of(times[0]).pk, how_poll.pk)
         self.assertEqual(poll_as_of(times[1]).pk, why_poll.pk)
 
-
-def get_history_url(model, history_index=None):
-    try:
-        info = model._meta.app_label, model._meta.module_name
-    except AttributeError:
-        info = model._meta.app_label, model._meta.model_name
-    if history_index is not None:
-        history = model.history.order_by('history_id')[history_index]
-        return reverse('admin:%s_%s_simple_history' % info,
-                       args=[quote(model.pk), quote(history.history_id)])
-    else:
-        return reverse('admin:%s_%s_history' % info, args=[quote(model.pk)])
-
-
-class AdminSiteTest(WebTest):
-    def setUp(self):
-        self.user = User.objects.create_superuser('user_login',
-                                                  'u@example.com', 'pass')
-
-    def login(self, user=None):
-        if user is None:
-            user = self.user
-        form = self.app.get(reverse('admin:index')).maybe_follow().form
-        form['username'] = user.username
-        form['password'] = 'pass'
-        return form.submit()
-
-    def test_history_list(self):
-        if VERSION >= (1, 5):
-            try:
-                module_name = self.user._meta.module_name
-            except AttributeError:
-                module_name = self.user._meta.model_name
-            self.assertEqual(module_name, 'customuser')
-        self.login()
-        poll = Poll(question="why?", pub_date=today)
-        poll._history_user = self.user
-        poll.save()
-        response = self.app.get(get_history_url(poll))
-        self.assertIn(get_history_url(poll, 0), response.unicode_normal_body)
-        self.assertIn("Poll object", response.unicode_normal_body)
-        self.assertIn("Created", response.unicode_normal_body)
-        self.assertIn(self.user.username, response.unicode_normal_body)
-
-    def test_history_form_permission(self):
-        self.login(self.user)
-        person = Person.objects.create(name='Sandra Hale')
-        self.app.get(get_history_url(person, 0), status=403)
-
-    def test_invalid_history_form(self):
-        self.login()
-        poll = Poll.objects.create(question="why?", pub_date=today)
-        response = self.app.get(get_history_url(poll, 0))
-        response.form['question'] = ""
-        response = response.form.submit()
-        self.assertEqual(response.status_code, 200)
-        self.assertIn("This field is required", response.unicode_normal_body)
-
-    def test_history_form(self):
-        self.login()
-        poll = Poll.objects.create(question="why?", pub_date=today)
-        poll.question = "how?"
-        poll.save()
-
-        # Make sure form for initial version is correct
-        response = self.app.get(get_history_url(poll, 0))
-        self.assertEqual(response.form['question'].value, "why?")
-        self.assertEqual(response.form['pub_date_0'].value, "2021-01-01")
-        self.assertEqual(response.form['pub_date_1'].value, "10:00:00")
-
-        # Create new version based on original version
-        response.form['question'] = "what?"
-        response.form['pub_date_0'] = "2021-01-02"
-        response = response.form.submit()
-        self.assertEqual(response.status_code, 302)
-        if VERSION < (1, 4, 0):
-            self.assertTrue(response.headers['location']
-                            .endswith(get_history_url(poll)))
-        else:
-            self.assertTrue(response.headers['location']
-                            .endswith(reverse('admin:tests_poll_changelist')))
-
-        # Ensure form for second version is correct
-        response = self.app.get(get_history_url(poll, 1))
-        self.assertEqual(response.form['question'].value, "how?")
-        self.assertEqual(response.form['pub_date_0'].value, "2021-01-01")
-        self.assertEqual(response.form['pub_date_1'].value, "10:00:00")
-
-        # Ensure form for new third version is correct
-        response = self.app.get(get_history_url(poll, 2))
-        self.assertEqual(response.form['question'].value, "what?")
-        self.assertEqual(response.form['pub_date_0'].value, "2021-01-02")
-        self.assertEqual(response.form['pub_date_1'].value, "10:00:00")
-
-        # Ensure current version of poll is correct
-        poll = Poll.objects.get()
-        self.assertEqual(poll.question, "what?")
-        self.assertEqual(poll.pub_date, tomorrow)
-        self.assertEqual([p.history_user for p in Poll.history.all()],
-                         [self.user, None, None])
-
-    def test_history_user_on_save_in_admin(self):
-        self.login()
-
-        # Ensure polls created via admin interface save correct user
-        add_page = self.app.get(reverse('admin:tests_poll_add'))
-        add_page.form['question'] = "new poll?"
-        add_page.form['pub_date_0'] = "2012-01-01"
-        add_page.form['pub_date_1'] = "10:00:00"
-        changelist_page = add_page.form.submit().follow()
-        self.assertEqual(Poll.history.get().history_user, self.user)
-
-        # Ensure polls saved on edit page in admin interface save correct user
-        change_page = changelist_page.click("Poll object")
-        change_page.form.submit()
-        self.assertEqual([p.history_user for p in Poll.history.all()],
-                         [self.user, self.user])
-
-    def test_underscore_in_pk(self):
-        self.login()
-        book = Book(isbn="9780147_513731")
-        book._history_user = self.user
-        book.save()
-        response = self.app.get(get_history_url(book))
-        self.assertIn(book.history.all()[0].revert_url(), response.unicode_normal_body)
-
     def test_abstract_inheritance(self):
         for klass in (ConcreteAttr, ConcreteUtil):
             obj = klass.objects.create()