Tests: Simplify Django version compatibility

* Restructure runtests.py as suggested in
  https://docs.djangoproject.com/en/1.9/topics/testing/advanced/#using-the-django-test-runner-to-test-reusable-applications

* Load version-specific Django settings modules
  (rather than trying to make a single settings.configure()
  work with all supported versions).

* Use `django-admin startproject` defaults for all
  settings modules. (Tests compatibility with typical
  apps, middleware, and other settings.)

* Set up tests-specific url config; switch to literal
  urls in test cases. (Eliminates url `reverse` from
  tests.)

* Make runtests.py executable

Closes #18

Author: medmunds

runtests.py

@@ -1,57 +1,33 @@
+#!/usr/bin/env python
+
 # python setup.py test
 #   or
-# python runtests.py [anymail.tests.test_x anymail.tests.test_y.SomeTestCase ...]
+# runtests.py [tests.test_x tests.test_y.SomeTestCase ...]
 
 import sys
-import warnings
 
-from django import setup
+import django
+import os
+import warnings
 from django.conf import settings
-from django.test.runner import DiscoverRunner as TestRunner
-
-warnings.simplefilter('default')  # show DeprecationWarning and other default-ignored warnings
-
-APP = 'anymail'
-
-settings.configure(
-    DEBUG=True,
-    DATABASES={
-        'default': {
-            'ENGINE': 'django.db.backends.sqlite3',
-        }
-    },
-    ROOT_URLCONF=APP+'.urls',
-    INSTALLED_APPS=(
-        'django.contrib.auth',
-        'django.contrib.contenttypes',
-        'django.contrib.sessions',
-        'django.contrib.admin',
-        APP,
-    ),
-    MIDDLEWARE_CLASSES=(
-        'django.middleware.common.CommonMiddleware',
-        'django.contrib.sessions.middleware.SessionMiddleware',
-        'django.middleware.csrf.CsrfViewMiddleware',
-        'django.contrib.auth.middleware.AuthenticationMiddleware',
-    ),
-    TEMPLATES=[
-        # Anymail doesn't have any templates, but tests need a TEMPLATES
-        # setting to avoid warnings from the Django 1.8+ test client.
-        {
-            'BACKEND': 'django.template.backends.django.DjangoTemplates',
-        },
-    ],
-)
-
-# Initialize Django app registry
-setup()
-
-
-def runtests(*args):
+from django.test.utils import get_runner
+
+
+def runtests(test_labels=None):
+    """Discover and run project tests. Returns number of failures."""
+    test_labels = test_labels or ['tests']
+
+    # noinspection PyStringFormat
+    os.environ['DJANGO_SETTINGS_MODULE'] = \
+        'tests.test_settings.settings_%d_%d' % django.VERSION[:2]
+    django.setup()
+
+    TestRunner = get_runner(settings)
     test_runner = TestRunner(verbosity=1)
-    test_labels = args if len(args) > 0 else ['tests']
-    failures = test_runner.run_tests(test_labels)
-    sys.exit(failures)
+    return test_runner.run_tests(test_labels)
+
 
 if __name__ == '__main__':
-    runtests(*sys.argv[1:])
+    warnings.simplefilter('default')  # show DeprecationWarning and other default-ignored warnings
+    failures = runtests(test_labels=sys.argv[1:])
+    sys.exit(bool(failures))

tests/test_mailgun_webhooks.py

@@ -4,7 +4,6 @@
 import hashlib
 import hmac
 from django.core.exceptions import ImproperlyConfigured
-from django.core.urlresolvers import reverse
 from django.test import override_settings
 from django.utils.timezone import utc
 from mock import ANY
@@ -42,35 +41,34 @@ def querydict_to_postdict(qd):
 
 class MailgunWebhookSettingsTestCase(WebhookTestCase):
     def test_requires_api_key(self):
-        webhook = reverse('mailgun_tracking_webhook')
         with self.assertRaises(ImproperlyConfigured):
-            self.client.post(webhook, data=mailgun_sign({'event': 'delivered'}))
+            self.client.post('/anymail/mailgun/tracking/',
+                             data=mailgun_sign({'event': 'delivered'}))
 
 
 @override_settings(ANYMAIL_MAILGUN_API_KEY=TEST_API_KEY)
 class MailgunWebhookSecurityTestCase(WebhookTestCase, WebhookBasicAuthTestsMixin):
     should_warn_if_no_auth = False  # because we check webhook signature
 
     def call_webhook(self):
-        webhook = reverse('mailgun_tracking_webhook')
-        return self.client.post(webhook, data=mailgun_sign({'event': 'delivered'}))
+        return self.client.post('/anymail/mailgun/tracking/',
+                                data=mailgun_sign({'event': 'delivered'}))
 
     # Additional tests are in WebhookBasicAuthTestsMixin
 
     def test_verifies_correct_signature(self):
-        webhook = reverse('mailgun_tracking_webhook')
-        response = self.client.post(webhook, data=mailgun_sign({'event': 'delivered'}))
+        response = self.client.post('/anymail/mailgun/tracking/',
+                                    data=mailgun_sign({'event': 'delivered'}))
         self.assertEqual(response.status_code, 200)
 
     def test_verifies_missing_signature(self):
-        webhook = reverse('mailgun_tracking_webhook')
-        response = self.client.post(webhook, data={'event': 'delivered'})
+        response = self.client.post('/anymail/mailgun/tracking/',
+                                    data={'event': 'delivered'})
         self.assertEqual(response.status_code, 400)
 
     def test_verifies_bad_signature(self):
-        webhook = reverse('mailgun_tracking_webhook')
         data = mailgun_sign({'event': 'delivered'}, api_key="wrong API key")
-        response = self.client.post(webhook, data=data)
+        response = self.client.post('/anymail/mailgun/tracking/', data=data)
         self.assertEqual(response.status_code, 400)
 
 
@@ -99,8 +97,7 @@ def test_delivered_event(self):
             'recipient': '[email protected]',
             'event': 'delivered',
         })
-        webhook = reverse('mailgun_tracking_webhook')
-        response = self.client.post(webhook, data=raw_event)
+        response = self.client.post('/anymail/mailgun/tracking/', data=raw_event)
         self.assertEqual(response.status_code, 200)
         kwargs = self.assert_handler_called_once_with(self.tracking_handler, sender=MailgunTrackingWebhookView,
                                                       event=ANY, esp_name='Mailgun')
@@ -137,8 +134,7 @@ def test_dropped_bounce(self):
             'X-Mailgun-Sid': 'WyI3Y2VjMyIsICJib3VuY2VAZXhhbXBsZS5jb20iLCAiZjFjNzgyIl0=',
             'token': 'a3fe1fa1640349ac552b84ddde373014b4c41645830c8dd3fc',
         })
-        webhook = reverse('mailgun_tracking_webhook')
-        response = self.client.post(webhook, data=raw_event)
+        response = self.client.post('/anymail/mailgun/tracking/', data=raw_event)
         self.assertEqual(response.status_code, 200)
         kwargs = self.assert_handler_called_once_with(self.tracking_handler, sender=MailgunTrackingWebhookView,
                                                       event=ANY, esp_name='Mailgun')
@@ -162,8 +158,7 @@ def test_dropped_spam(self):
             'recipient': '[email protected]',
             # (omitting some fields that aren't relevant to the test)
         })
-        webhook = reverse('mailgun_tracking_webhook')
-        response = self.client.post(webhook, data=raw_event)
+        response = self.client.post('/anymail/mailgun/tracking/', data=raw_event)
         self.assertEqual(response.status_code, 200)
         kwargs = self.assert_handler_called_once_with(self.tracking_handler, sender=MailgunTrackingWebhookView,
                                                       event=ANY, esp_name='Mailgun')
@@ -181,8 +176,7 @@ def test_dropped_timed_out(self):
             'recipient': '[email protected]',
             # (omitting some fields that aren't relevant to the test)
         })
-        webhook = reverse('mailgun_tracking_webhook')
-        response = self.client.post(webhook, data=raw_event)
+        response = self.client.post('/anymail/mailgun/tracking/', data=raw_event)
         self.assertEqual(response.status_code, 200)
         kwargs = self.assert_handler_called_once_with(self.tracking_handler, sender=MailgunTrackingWebhookView,
                                                       event=ANY, esp_name='Mailgun')
@@ -201,8 +195,7 @@ def test_invalid_mailbox(self):
             'recipient': '[email protected]',
             # (omitting some fields that aren't relevant to the test)
         })
-        webhook = reverse('mailgun_tracking_webhook')
-        response = self.client.post(webhook, data=raw_event)
+        response = self.client.post('/anymail/mailgun/tracking/', data=raw_event)
         self.assertEqual(response.status_code, 200)
         kwargs = self.assert_handler_called_once_with(self.tracking_handler, sender=MailgunTrackingWebhookView,
                                                       event=ANY, esp_name='Mailgun')
@@ -221,7 +214,7 @@ def test_metadata(self):
             'custom1': 'value',
             'custom2': '{"key":"value"}',  # you can store JSON, but you'll need to unpack it yourself
         })
-        self.client.post(reverse('mailgun_tracking_webhook'), data=raw_event)
+        self.client.post('/anymail/mailgun/tracking/', data=raw_event)
         kwargs = self.assert_handler_called_once_with(self.tracking_handler)
         event = kwargs['event']
         self.assertEqual(event.metadata, {"custom1": "value1", "custom2": '{"key":"value"}'})
@@ -232,7 +225,7 @@ def test_tags(self):
             'tag': ['tag1', 'tag2'],  # Django TestClient encodes list as multiple field values
             'event': 'opened',
         })
-        self.client.post(reverse('mailgun_tracking_webhook'), data=raw_event)
+        self.client.post('/anymail/mailgun/tracking/', data=raw_event)
         kwargs = self.assert_handler_called_once_with(self.tracking_handler)
         event = kwargs['event']
         self.assertEqual(event.tags, ["tag1", "tag2"])
@@ -243,8 +236,7 @@ def test_x_tags(self):
             'X-Mailgun-Tag': ['tag1', 'tag2'],
             'event': 'delivered',
         })
-        self.client.post(reverse('mailgun_tracking_webhook'), data=raw_event)
-        kwargs = self.assert_handler_called_once_with(self.tracking_handler)
+        self.client.post('/anymail/mailgun/tracking/', data=raw_event)
         kwargs = self.assert_handler_called_once_with(self.tracking_handler)
         event = kwargs['event']
         self.assertEqual(event.tags, ["tag1", "tag2"])

tests/test_mandrill_webhooks.py

@@ -7,7 +7,6 @@
 import hmac
 from base64 import b64encode
 from django.core.exceptions import ImproperlyConfigured
-from django.core.urlresolvers import reverse
 from django.test import override_settings
 from django.utils.timezone import utc
 from mock import ANY
@@ -20,14 +19,14 @@
 TEST_WEBHOOK_KEY = 'TEST_WEBHOOK_KEY'
 
 
-def mandrill_args(events=None, urlname='mandrill_tracking_webhook', key=TEST_WEBHOOK_KEY):
+def mandrill_args(events=None, url='/anymail/mandrill/tracking/', key=TEST_WEBHOOK_KEY):
     """Returns TestClient.post kwargs for Mandrill webhook call with events
 
     Computes correct signature.
     """
     if events is None:
         events = []
-    url = urljoin('http://testserver/', reverse(urlname))
+    url = urljoin('http://testserver/', url)
     mandrill_events = json.dumps(events)
     signed_data = url + 'mandrill_events' + mandrill_events
     signature = b64encode(hmac.new(key=key.encode('ascii'),
@@ -42,9 +41,9 @@ def mandrill_args(events=None, urlname='mandrill_tracking_webhook', key=TEST_WEB
 
 class MandrillWebhookSettingsTestCase(WebhookTestCase):
     def test_requires_webhook_key(self):
-        webhook = reverse('mandrill_tracking_webhook')
         with self.assertRaises(ImproperlyConfigured):
-            self.client.post(webhook, data={'mandrill_events': '[]'})
+            self.client.post('/anymail/mandrill/tracking/',
+                             data={'mandrill_events': '[]'})
 
 
 @override_settings(ANYMAIL_MANDRILL_WEBHOOK_KEY=TEST_WEBHOOK_KEY)
@@ -63,8 +62,8 @@ def test_verifies_correct_signature(self):
         self.assertEqual(response.status_code, 200)
 
     def test_verifies_missing_signature(self):
-        webhook = reverse('mandrill_tracking_webhook')
-        response = self.client.post(webhook, data={'mandrill_events': '[{"event":"send"}]'})
+        response = self.client.post('/anymail/mandrill/tracking/',
+                                    data={'mandrill_events': '[{"event":"send"}]'})
         self.assertEqual(response.status_code, 400)
 
     def test_verifies_bad_signature(self):
@@ -78,8 +77,7 @@ class MandrillTrackingTestCase(WebhookTestCase):
 
     def test_head_request(self):
         # Mandrill verifies webhooks at config time with a HEAD request
-        webhook = reverse('mandrill_tracking_webhook')
-        response = self.client.head(webhook)
+        response = self.client.head('/anymail/mandrill/tracking/')
         self.assertEqual(response.status_code, 200)
 
     def test_post_request_invalid_json(self):

tests/test_postmark_webhooks.py

@@ -1,7 +1,6 @@
 import json
 from datetime import datetime
 
-from django.core.urlresolvers import reverse
 from django.utils.timezone import get_fixed_timezone
 from mock import ANY
 
@@ -12,8 +11,8 @@
 
 class PostmarkWebhookSecurityTestCase(WebhookTestCase, WebhookBasicAuthTestsMixin):
     def call_webhook(self):
-        webhook = reverse('postmark_tracking_webhook')
-        return self.client.post(webhook, content_type='application/json', data=json.dumps({}))
+        return self.client.post('/anymail/postmark/tracking/',
+                                content_type='application/json', data=json.dumps({}))
 
     # Actual tests are in WebhookBasicAuthTestsMixin
 
@@ -36,8 +35,8 @@ def test_bounce_event(self):
             "Subject": "Postmark event test",
             "Content": "..."
         }
-        webhook = reverse('postmark_tracking_webhook')
-        response = self.client.post(webhook, content_type='application/json', data=json.dumps(raw_event))
+        response = self.client.post('/anymail/postmark/tracking/',
+                                    content_type='application/json', data=json.dumps(raw_event))
         self.assertEqual(response.status_code, 200)
         kwargs = self.assert_handler_called_once_with(self.tracking_handler, sender=PostmarkTrackingWebhookView,
                                                       event=ANY, esp_name='Postmark')
@@ -69,8 +68,8 @@ def test_open_event(self):
             "ReceivedAt": "2016-04-27T16:21:41.2493688-04:00",
             "Recipient": "[email protected]"
         }
-        webhook = reverse('postmark_tracking_webhook')
-        response = self.client.post(webhook, content_type='application/json', data=json.dumps(raw_event))
+        response = self.client.post('/anymail/postmark/tracking/',
+                                    content_type='application/json', data=json.dumps(raw_event))
         self.assertEqual(response.status_code, 200)
         kwargs = self.assert_handler_called_once_with(self.tracking_handler, sender=PostmarkTrackingWebhookView,
                                                       event=ANY, esp_name='Postmark')