system checks refactor + tests

Author: apragacz

rest_registration/checks.py

@@ -1,52 +1,51 @@
-from django.core.checks import Error, register
+from django.core.checks import register
 
+from rest_registration.decorators import simple_check
 from rest_registration.settings import registration_settings
 
 
-def check(message, error_code):
-
-    def decorator(predicate):
-
-        def f(app_configs, **kwargs):
-            errors = []
-            if not predicate():
-                errors.append(
-                    Error(
-                        message,
-                        hint=None,
-                        id='rest_registration.E{0}'.format(error_code),
-                    )
-                )
-            return errors
-
-        return f
-
-    return decorator
+class ErrorCode(object):
+    NO_RESET_PASSWORD_VER_URL = 'E001'
+    NO_REGISTER_VER_URL = 'E002'
+    NO_REGISTER_EMAIL_VER_URL = 'E003'
+    NO_VER_FROM_EMAIL = 'E004'
 
 
 @register()
-@check('RESET_PASSWORD_VERIFICATION_URL is not set', '001')
+@simple_check('RESET_PASSWORD_VERIFICATION_URL is not set',
+              ErrorCode.NO_RESET_PASSWORD_VER_URL)
 def reset_password_verification_url_check():
     return registration_settings.RESET_PASSWORD_VERIFICATION_URL
 
 
 @register()
-@check('register verification is enabled,'
-       ' but REGISTER_VERIFICATION_URL is not set', '002')
+@simple_check('register verification is enabled,'
+              ' but REGISTER_VERIFICATION_URL is not set',
+              ErrorCode.NO_REGISTER_VER_URL)
 def register_verification_url_check():
     return (not registration_settings.REGISTER_VERIFICATION_ENABLED or
             registration_settings.REGISTER_VERIFICATION_URL)
 
 
 @register()
-@check('register email verification is enabled,'
-       ' but REGISTER_EMAIL_VERIFICATION_URL is not set', '003')
+@simple_check('register email verification is enabled,'
+              ' but REGISTER_EMAIL_VERIFICATION_URL is not set',
+              ErrorCode.NO_REGISTER_EMAIL_VER_URL)
 def register_email_verification_url_check():
     return (not registration_settings.REGISTER_EMAIL_VERIFICATION_ENABLED or
             registration_settings.REGISTER_EMAIL_VERIFICATION_URL)
 
 
 @register()
-@check('VERIFICATION_FROM_EMAIL is not set', '004')
+@simple_check('VERIFICATION_FROM_EMAIL is not set',
+              ErrorCode.NO_VER_FROM_EMAIL)
 def verification_from_check():
     return registration_settings.VERIFICATION_FROM_EMAIL
+
+
+__ALL_CHECKS__ = [
+    reset_password_verification_url_check,
+    register_verification_url_check,
+    register_email_verification_url_check,
+    verification_from_check,
+]

rest_registration/decorators.py

@@ -1,5 +1,8 @@
+import functools
 import types
 
+from django.core.checks import Error
+
 
 def serializer_class_getter(class_getter):
 
@@ -16,3 +19,26 @@ def decorator(func):
             apiview_cls)
         return func
     return decorator
+
+
+def simple_check(error_message, error_code, obj=None):
+
+    def decorator(predicate):
+
+        @functools.wraps(predicate)
+        def check_fun(app_configs, **kwargs):
+            errors = []
+            if not predicate():
+                errors.append(
+                    Error(
+                        error_message,
+                        obj=obj,
+                        hint=None,
+                        id='rest_registration.{0}'.format(error_code),
+                    )
+                )
+            return errors
+
+        return check_fun
+
+    return decorator

tests/test_checks.py

@@ -0,0 +1,32 @@
+from django.apps import apps
+from django.test import TestCase
+from django.test.utils import override_settings
+
+from rest_registration.checks import __ALL_CHECKS__
+
+
+def simulate_checks():
+    app_configs = apps.app_configs
+    errors = []
+    for check in __ALL_CHECKS__:
+        errors.extend(check(app_configs))
+    return errors
+
+
+class ChecksTestCase(TestCase):
+
+    def test_checks_default(self):
+        errors = simulate_checks()
+        self.assertEqual(len(errors), 4)
+
+    @override_settings(
+        REST_REGISTRATION={
+            'REGISTER_VERIFICATION_URL': '/verify-account/',
+            'REGISTER_EMAIL_VERIFICATION_URL': '/verify-email/',
+            'RESET_PASSWORD_VERIFICATION_URL': '/reset-password/',
+            'VERIFICATION_FROM_EMAIL': 'jon.doe@example.com',
+        }
+    )
+    def test_checks_minmal_setup(self):
+        errors = simulate_checks()
+        self.assertEqual(len(errors), 0)