Leverage unittest2 to make assertions about logs

Python 3.4 introduces an assertLogs for unittest.TestCase. This
assertion has been backported to unittest2. Enable this assertion by
installing unittest2 and monkey-patching TestCase for Python < 3.4.

Author: francoisfreitag

README.rst

@@ -69,6 +69,9 @@ do to make sure it is compatible with your Django version and environment.
   you run any other Django application test suite. Just type ``python manage.py
   test djangosaml2``.
 
+  Python 2 users need to ``pip install djangosaml2[test]`` in order to run the
+  tests.
+
 Then you have to add the ``djangosaml2.backends.Saml2Backend``
 authentication backend to the list of authentications backends.
 By default only the ModelBackend included in Django is configured.

setup.py

@@ -13,15 +13,22 @@
 # limitations under the License.
 
 
-import os
 import codecs
+import os
+import sys
 from setuptools import setup, find_packages
 
 
 def read(*rnames):
     return codecs.open(os.path.join(os.path.dirname(__file__), *rnames), encoding='utf-8').read()
 
 
+extra = {'test': []}
+if sys.version_info < (3, 4):
+    # Necessary to use assertLogs in tests
+    extra['test'].append('unittest2')
+
+
 setup(
     name='djangosaml2',
     version='0.16.10',
@@ -65,4 +72,5 @@ def read(*rnames):
         'pysaml2==4.4.0',
         'defusedxml>=0.4.1'
         ],
+    extras_require=extra,
     )

tests/testprofiles/tests.py

@@ -14,6 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import sys
+
 from django.contrib.auth import get_user_model
 from django.contrib.auth.models import User as DjangoUserModel
 from django.test import TestCase, override_settings
@@ -22,6 +24,17 @@
 
 User = get_user_model()
 
+if sys.version_info < (3, 4):
+    # Monkey-patch TestCase to add the assertLogs method introduced in
+    # Python 3.4
+    from unittest2.case import _AssertLogsContext
+
+    class LoggerTestCase(TestCase):
+        def assertLogs(self, logger=None, level=None):
+            return _AssertLogsContext(self, logger, level)
+
+    TestCase = LoggerTestCase
+
 
 class Saml2BackendTests(TestCase):
     def test_update_user(self):

tox.ini

@@ -16,6 +16,7 @@ deps =
     django110: Django>=1.10,<1.11
     django111: Django>=1.11,<2.0
     djangomaster: https://github.com/django/django/archive/master.tar.gz
+    .[test]
 
 ignore_outcome =
     djangomaster: True