Use stdout in checkpreferences (#252)

* Change logging for stdout in checkpreferences command

* Remove nose print stdout

Author: CleitonDeLima

dynamic_preferences/management/commands/checkpreferences.py

@@ -1,22 +1,23 @@
-from django.core.management.base import BaseCommand, CommandError
+from django.core.management.base import BaseCommand
 from dynamic_preferences.exceptions import NotFoundInRegistry
 from dynamic_preferences.models import GlobalPreferenceModel
-from dynamic_preferences.registries import preference_models, global_preferences_registry
-
-import logging
-logger = logging.getLogger(__name__)
+from dynamic_preferences.registries import (global_preferences_registry,
+                                            preference_models)
 
 
 def delete_preferences(queryset):
     """
-    Delete preferences objects if they are not present in registry. Return a list of deleted objects
+    Delete preferences objects if they are not present in registry.
+    Return a list of deleted objects
     """
     deleted = []
 
-    # Iterate through preferences. If an error is raised when accessing preference object, just delete it
+    # Iterate through preferences. If an error is raised when accessing
+    # preference object, just delete it
     for p in queryset:
         try:
-            pref = p.registry.get(section=p.section, name=p.name, fallback=False)
+            p.registry.get(
+                section=p.section, name=p.name, fallback=False)
         except NotFoundInRegistry:
             p.delete()
             deleted.append(p)
@@ -25,26 +26,42 @@ def delete_preferences(queryset):
 
 
 class Command(BaseCommand):
-    help = "Find and delete preferences from database if they don't exist in registries. Create preferences that are " \
-           "not present in database"
+    help = (
+        "Find and delete preferences from database if they don't exist in "
+        "registries. Create preferences that are not present in database"
+    )
 
     def handle(self, *args, **options):
 
         # Create needed preferences
         # Global
-        logger.info('Creating missing global preferences...')
+        self.stdout.write("Creating missing global preferences...")
         manager = global_preferences_registry.manager()
         manager.all()
 
         deleted = delete_preferences(GlobalPreferenceModel.objects.all())
-        logger.info("Deleted {0} global preferences".format(len(deleted)))
+        message = "Deleted {deleted} global preferences".format(
+            deleted=len(deleted)
+        )
+        self.stdout.write(message)
 
         for preference_model, registry in preference_models.items():
             deleted = delete_preferences(preference_model.objects.all())
-            logger.info("Deleted {0} {1} preferences".format(len(deleted), preference_model.__name__))
+            message = (
+                "Deleted {deleted} {model} preferences".format(
+                    deleted=len(deleted),
+                    model=preference_model.__name__,
+                )
+            )
+            self.stdout.write(message)
             if not hasattr(preference_model, 'get_instance_model'):
                 continue
 
-            logger.info('Creating missing preferences for {0} model...'.format(preference_model.get_instance_model().__name__))
+            message = (
+                "Creating missing preferences for {model} model...".format(
+                    model=preference_model.get_instance_model().__name__,
+                )
+            )
+            self.stdout.write(message)
             for instance in preference_model.get_instance_model().objects.all():
                 instance.preferences.all()

tests/settings.py

@@ -25,7 +25,6 @@
 STATIC_URL = '/static/'
 MEDIA_URL = '/media/'
 MEDIA_ROOT = tempfile.mkdtemp()
-NOSE_ARGS = ['-s']
 MIDDLEWARE =  (
     'django.contrib.sessions.middleware.SessionMiddleware',
     'django.middleware.common.CommonMiddleware',

tests/test_checkpreferences_command.py

@@ -0,0 +1,35 @@
+from io import StringIO
+
+from django.core.cache import caches
+from django.core.management import call_command
+from django.test import TestCase
+
+
+class BaseTest(object):
+
+    def tearDown(self):
+        caches["default"].clear()
+
+
+class TestCheckPreferencesCommand(BaseTest, TestCase):
+    def call_command(self, *args, **kwargs):
+        out = StringIO()
+        call_command(
+            "checkpreferences",
+            *args,
+            stdout=out,
+            stderr=StringIO(),
+            **kwargs,
+        )
+        return out.getvalue().strip()
+
+    def test_dry_run(self):
+        out = self.call_command(verbosity=0)
+        expected_output = "\n".join([
+            "Creating missing global preferences...",
+            "Deleted 0 global preferences",
+            "Deleted 0 GlobalPreferenceModel preferences",
+            "Deleted 0 UserPreferenceModel preferences",
+            "Creating missing preferences for User model...",
+        ])
+        self.assertEqual(out, expected_output)