add integration test for setting IP from the request

Author: kseever

docs/advanced.rst

@@ -391,8 +391,10 @@ source model. This is possible by combining the ``bases`` functionality with the
 
     # define your signal handler/callback anywhere outside of models.py
     def add_history_ip_address(sender, **kwargs):
+        thread = threading.local()
         history_instance = kwargs['history_instance']
-        history_instance.ip_address = history_instance.request.META['REMOTE_ADDR']
+        # (thread.request for use only in conjunction with the simple_history middleware)
+        history_instance.ip_address = thread.request.META['REMOTE_ADDR']
 
 
 .. code-block:: python

simple_history/signals.py

@@ -2,7 +2,8 @@
 
 
 pre_create_historical_record = django.dispatch.Signal(providing_args=[
-    'instance', 'history_date', 'history_user', 'history_change_reason',
+    'instance', 'history_instance', 'history_date', 'history_user',
+    'history_change_reason',
 ])
 post_create_historical_record = django.dispatch.Signal(providing_args=[
     'instance', 'history_instance', 'history_date', 'history_user',

simple_history/tests/apps.py

@@ -1,21 +1,19 @@
 from django.apps import AppConfig
+from simple_history.models import HistoricalRecords
 from simple_history.signals import pre_create_historical_record
 
 
-def add_history_ip_address(sender, **kwargs):
-    history_instance = kwargs['history_instance']
-    history_instance.ip_address = '127.0.0.1'
-
-
 class TestsConfig(AppConfig):
     name = 'simple_history.tests'
     verbose_name = 'Tests'
 
     def ready(self):
         from simple_history.tests.models \
             import HistoricalPollWithHistoricalIPAddress
+        from simple_history.tests.tests.utils import add_history_ip_address
 
         pre_create_historical_record.connect(
             add_history_ip_address,
-            sender=HistoricalPollWithHistoricalIPAddress
+            sender=HistoricalPollWithHistoricalIPAddress,
+            dispatch_uid='add_history_ip_address'
         )

simple_history/tests/models.py

@@ -52,10 +52,12 @@ class Meta:
 class PollWithHistoricalIPAddress(models.Model):
     question = models.CharField(max_length=200)
     pub_date = models.DateTimeField('date published')
-    place = models.ForeignKey('Place', on_delete=models.CASCADE)
 
     history = HistoricalRecords(bases=[IPAddressHistoricalModel])
 
+    def get_absolute_url(self):
+        return reverse('poll-detail', kwargs={'pk': self.pk})
+
 
 class Temperature(models.Model):
     location = models.CharField(max_length=200)

simple_history/tests/tests/test_models.py

@@ -10,12 +10,14 @@
 from django.core.files.base import ContentFile
 from django.db import models
 from django.db.models.fields.proxy import OrderWrt
-from django.test import TestCase
+from django.test import TestCase, override_settings
+from django.urls import reverse
 
 from simple_history.models import (
     HistoricalRecords,
     ModelChange
 )
+from simple_history.tests.tests.utils import middleware_override_settings
 from simple_history.utils import update_change_reason
 from ..external.models import ExternalModel2, ExternalModel4
 from ..models import (
@@ -1054,19 +1056,36 @@ def test_changed_value_lost(self):
 class ExtraFieldsTestCase(TestCase):
     def test_extra_ip_address_field_populated_on_save(self):
         poll = PollWithHistoricalIPAddress.objects.create(
-            question="Will it blend?", pub_date=today,
-            place=Place.objects.create(name="Here")
+            question="Will it blend?", pub_date=today
         )
 
         poll_history = poll.history.order_by('history_date')[0]
 
-        self.assertEquals('127.0.0.1', poll_history.ip_address)
+        self.assertEquals('192.168.0.1', poll_history.ip_address)
 
     def test_extra_ip_address_field_not_present_on_poll(self):
         poll = PollWithHistoricalIPAddress.objects.create(
-            question="Will it blend?", pub_date=today,
-            place=Place.objects.create(name="Here")
+            question="Will it blend?", pub_date=today
         )
 
         with self.assertRaises(AttributeError):
             poll.ip_address
+
+
+@override_settings(**middleware_override_settings)
+class ExtraFieldsIPAddressTestCase(TestCase):
+    def test_signal_is_able_to_retrieve_request_from_thread(self):
+        data = {
+            # workaround for bad interplay with signals and mocking; see
+            # simple_history.tests.tests.utils.add_history_ip_address
+            'question': 'read IP from request',
+            'pub_date': '2018-10-30'
+        }
+
+        self.client.post(reverse('pollip-add'), data=data)
+
+        polls = PollWithHistoricalIPAddress.objects.all()
+        self.assertEqual(1, polls.count())
+
+        poll_history = polls[0].history.first()
+        self.assertEqual('127.0.0.1', poll_history.ip_address)

simple_history/tests/tests/utils.py

@@ -15,3 +15,13 @@
             settings.MIDDLEWARE_CLASSES + [request_middleware]
         )
     }
+
+
+def add_history_ip_address(sender, **kwargs):
+    history_instance = kwargs['history_instance']
+    if history_instance.question == 'read IP from request':
+        from simple_history.models import HistoricalRecords
+        history_instance.ip_address = \
+            HistoricalRecords.thread.request.META['REMOTE_ADDR']
+    else:
+        history_instance.ip_address = '192.168.0.1'

simple_history/tests/urls.py

@@ -10,7 +10,8 @@
     PollDelete,
     PollDetail,
     PollList,
-    PollUpdate
+    PollUpdate,
+    PollWithHistoricalIPAddressCreate,
 )
 from . import other_admin
 
@@ -26,6 +27,11 @@
         BucketDataRegisterRequestUserDetail.as_view(),
         name='bucket_data-detail'),
     url(r'^poll/add/$', PollCreate.as_view(), name='poll-add'),
+    url(
+        r'^pollwithhistoricalipaddress/add$',
+        PollWithHistoricalIPAddressCreate.as_view(),
+        name='pollip-add'
+    ),
     url(r'^poll/(?P<pk>[0-9]+)/$', PollUpdate.as_view(), name='poll-update'),
     url(r'^poll/(?P<pk>[0-9]+)/delete/$', PollDelete.as_view(),
         name='poll-delete'),

simple_history/tests/view.py

@@ -7,14 +7,23 @@
     UpdateView
 )
 
-from simple_history.tests.models import BucketDataRegisterRequestUser, Poll
+from simple_history.tests.models import (
+    BucketDataRegisterRequestUser,
+    Poll,
+    PollWithHistoricalIPAddress
+)
 
 
 class PollCreate(CreateView):
     model = Poll
     fields = ['question', 'pub_date']
 
 
+class PollWithHistoricalIPAddressCreate(CreateView):
+    model = PollWithHistoricalIPAddress
+    fields = ['question', 'pub_date']
+
+
 class PollUpdate(UpdateView):
     model = Poll
     fields = ['question', 'pub_date']