Merge lp:~nataliabidart/django-preflight/cache-status-info into lp:django-preflight

[Natalia Bidart]

- Include status information for django caches.
- Include database connection health checks.

[Martin Albisetti (beuno)]

review: Approve

=== modified file 'debian/control'
--- debian/control	2011-02-07 16:06:51 +0000
+++ debian/control	2014-01-28 17:39:58 +0000
@@ -14,7 +14,7 @@
 Architecture: all
 XB-Python-Version: ${python:Versions}
 Depends: ${misc:Depends}, ${python:Depends},
- python-django (>= 1.0.2)
+ python-django (>= 1.4)
 Description: Base for creating pre-flight checks page for Django projects.
  This project provides basic support for creating pre-flight checks page for Django
  based projects. Such page consists with series of checks, provided by the project

=== modified file 'preflight/__init__.py'
--- preflight/__init__.py	2013-05-17 14:56:11 +0000
+++ preflight/__init__.py	2014-01-28 17:39:58 +0000
@@ -3,7 +3,7 @@
 
 from django.conf import settings
 
-from .models import REGISTRY
+from .models import Preflight, register  # NOQA
 
 __version__ = "0.1.5"
 
@@ -18,16 +18,3 @@
             msg = e.args[0].lower()
             if 'no module named' not in msg or 'preflight' not in msg:
                 raise
-
-
-class Preflight(object):
-
-    name = "Application Checks"
-
-    def authenticate(self, request):
-        return request.user.is_staff
-
-
-def register(class_):
-    if class_ not in REGISTRY:
-        REGISTRY.append(class_)

=== modified file 'preflight/models.py'
--- preflight/models.py	2014-01-24 12:21:51 +0000
+++ preflight/models.py	2014-01-28 17:39:58 +0000
@@ -2,12 +2,17 @@
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 from __future__ import absolute_import
+
+import platform
 import re
 import sys
 import traceback
 
 import django
+
+from django import db
 from django.conf import settings
+from django.core.cache import get_cache
 from django.views.debug import HIDDEN_SETTINGS
 
 from .conf import ENABLE_SETTINGS
@@ -15,6 +20,26 @@
 REGISTRY = []
 
 
+def register(class_):
+    if class_ not in REGISTRY:
+        REGISTRY.append(class_)
+
+
+class Preflight(object):
+
+    name = "Application Checks"
+
+    def authenticate(self, request):
+        return request.user.is_staff
+
+    def check_database(self):
+        """Are database connections accepted?"""
+        cursor = db.connection.cursor()
+        cursor.execute('SELECT 42')
+        cursor.fetchone()
+        return True
+
+
 class Application(object):
 
     def __init__(self, class_):
@@ -28,8 +53,8 @@
                        if s.startswith('check_'))
         for check_name in check_names:
             instance = self.class_()
-            bound_method = getattr(instance, check_name)
-            check = Check(check_name[len('check_'):], bound_method)
+            check_method = getattr(instance, check_name)
+            check = Check(check_name[len('check_'):], check_method)
             check.check()
             self.checks.append(check)
 
@@ -49,10 +74,7 @@
 
 
 class Check(object):
-
-    """
-    Representation of one check performed and place to store its result.
-    """
+    """Representation of one check performed and place to store its result."""
 
     def __init__(self, name, bound_method):
         self.name = name
@@ -63,14 +85,14 @@
             self.description = ""
 
     def check(self):
-        """
-        Returns True if check was successful and False otherwise.
+        """Return True if check was successful and False otherwise.
 
         This result is also stored in object's attribute ``passed``.
+
         """
         try:
             self.passed = bool(self.bound_method())
-        except Exception, exc:
+        except Exception:
             exc_type, exc_value, exc_traceback = sys.exc_info()
             self.exception = u"".join(
                 traceback.format_exception(exc_type, exc_value,
@@ -96,21 +118,12 @@
 
 
 def gather_versions():
-    """
-    Gather list of version information to be displayed alongside the checks
-    data.
-
-    """
-    import platform
-    import sys
-    import django
-    import preflight
+    """Return list of version information to be shown with the checks data."""
 
     items = [
         {'name': 'Platform', 'version': platform.platform()},
         {'name': 'Django', 'version': django.get_version()},
         {'name': 'Python', 'version': sys.version},
-        {'name': 'preflight', 'version': preflight.__version__}
     ]
 
     for class_ in REGISTRY:
@@ -152,7 +165,7 @@
         else:
             if isinstance(value, dict):
                 cleansed = dict((k, cleanse_setting(k, v, hidden))
-                                for k,v in value.items())
+                                for k, v in value.items())
             else:
                 cleansed = value
     except TypeError:
@@ -160,11 +173,13 @@
         cleansed = value
     return cleansed
 
+
 def gather_settings():
     if not ENABLE_SETTINGS:
         return []
 
-    names = sorted([x for x in settings._wrapped.__dict__
+    names = sorted([
+        x for x in settings._wrapped.__dict__
         if x.isupper() and not x.startswith('_')])
     settings_list = []
     hidden_settings = getattr(settings, 'PREFLIGHT_HIDDEN_SETTINGS', None)
@@ -183,9 +198,7 @@
 
 
 def authenticate(request):
-    """
-    To be able to access you need to have permission from every preflight class.
-    """
+    """For access, permission from every preflight class is required."""
     return all(class_().authenticate(request) for class_ in REGISTRY)
 
 
@@ -249,3 +262,24 @@
         status_text=switch['statusLabel'],
         conditions=conditions,
     )
+
+
+def gather_caches():
+    """Expose the status of memcache on the preflight page."""
+    caches = {}
+
+    for cache_name, cache_settings in settings.CACHES.iteritems():
+        cache = get_cache(cache_name)
+        try:
+            stats = cache._cache.get_stats()[0][1]
+        except Exception as exc:
+            stats = dict(error=unicode(exc))
+        else:
+            stats['hit_rate'] = 100 * int(
+                stats.get('get_hits')) / int(stats.get('cmd_get'))
+
+        stats['backend'] = cache_settings['BACKEND']
+        stats['host'] = cache_settings.get('LOCATION', 'No location given')
+        caches[cache_name] = stats
+
+    return caches

=== modified file 'preflight/templates/preflight/overview.html'
--- preflight/templates/preflight/overview.html	2014-01-24 14:07:11 +0000
+++ preflight/templates/preflight/overview.html	2014-01-28 17:39:58 +0000
@@ -5,11 +5,11 @@
 
 {% load i18n %}
 
-{% block title %}{% trans "Application Pre-Flight Checks" %}{% endblock %}
+{% block title %}{% trans "Preflight Checks" %}{% endblock %}
 
 {% block content %}
 <div id="preflight">
-  <h1>{% trans "Pre-flight Applications Checks" %}</h1>
+  <h1>{% trans "Preflight Checks" %}</h1>
 
   <ul id="links">
     {% for application in applications %}
@@ -22,6 +22,9 @@
     {% if switches %}
     <li><a href="#switches">Switches</a></li>
     {% endif %}
+    {% if caches %}
+    <li><a href="#caches">Caches</a></li>
+    {% endif %}
   </ul>
 
   {% for application in applications %}
@@ -60,7 +63,7 @@
   {% endfor %}
 
   <a href="#links" style="text-decoration: none;">
-    <h1 id="versions">{% trans "Versions" %}</h1>
+    <h2 id="versions">{% trans "Versions" %}</h2>
   </a>
   <table class="{{ preflight_table_class }}">
     <thead>
@@ -81,7 +84,7 @@
 
   {% if settings %}
   <a href="#links" style="text-decoration: none;">
-    <h1 id="settings">{% trans "Settings" %}</h1>
+    <h2 id="settings">{% trans "Settings" %}</h2>
   </a>
   <dl class="{{ preflight_table_class }}">
   {% for setting in settings %}
@@ -94,7 +97,7 @@
 
   {% if switches %}
   <a href="#links" style="text-decoration: none;">
-    <h1 id="switches">{% trans "Switches" %}</h1>
+    <h2 id="switches">{% trans "Gargoyle Switches" %}</h2>
   </a>
     <table id="switches-table" class="{{ preflight_table_class }}">
       <thead>
@@ -130,6 +133,20 @@
   {% else %}
     <p>No switches.</p>
   {% endif %}
+
+  {% for name, cache in caches.items %}
+    <a href="#links" style="text-decoration: none;">
+      <h2 id="caches">Cache {{ name }}</h2>
+    </a>
+    <dl>
+      {% for key, value in cache %}
+      <strong>{{ key }}</strong>: {{ value }}<br />
+      {% endfor %}
+    </dl>
+  {% empty %}
+    <p>No caches.</p>
+  {% endfor %}
+
 </div>
 
 <p>View generated at: {{ now }}</p>

=== modified file 'preflight/tests.py'
--- preflight/tests.py	2014-01-24 14:07:11 +0000
+++ preflight/tests.py	2014-01-28 17:39:58 +0000
@@ -1,12 +1,9 @@
 # Copyright 2010 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 import sys
-try:
-    from unittest import skipIf
-except ImportError:
-    from unittest2 import skipIf  # NOQA
-
-from django.conf import settings
+
+from cStringIO import StringIO
+
 from django.contrib.auth.models import AnonymousUser, User
 from django.core.management import call_command
 from django.core.urlresolvers import reverse
@@ -14,20 +11,24 @@
 from django.test import TestCase
 from django.template import RequestContext
 from django.template.loader import render_to_string
+from gargoyle import gargoyle
+from gargoyle.builtins import IPAddressConditionSet
+from gargoyle.models import (
+    DISABLED, GLOBAL, INHERIT, SELECTIVE,
+    Switch,
+)
 from mock import (
     Mock,
     patch,
 )
-
-from cStringIO import StringIO
 from pyquery import PyQuery
 
-from . import Preflight
-from .models import (
+from preflight.models import (
+    HIDDEN_SETTINGS,
+    REGISTRY,
     Application,
     Check,
-    HIDDEN_SETTINGS,
-    REGISTRY,
+    Preflight,
     authenticate,
     cleanse_setting,
     gather_checks,
@@ -47,7 +48,7 @@
         self.return_value = True
 
     def check_method(self):
-        "description"
+        """Some description"""
         if self.exception:
             raise self.exception
         return self.return_value
@@ -55,8 +56,8 @@
     def test_initialisation(self):
         check = Check("check_name", self.check_method)
 
-        self.assertEquals(check.name, "check_name")
-        self.assertEquals(check.description, "description")
+        self.assertEqual(check.name, "check_name")
+        self.assertEqual(check.description, "Some description")
 
     def test_initialisation_when_doc_is_none(self):
         def method():
@@ -64,7 +65,7 @@
 
         check = Check("check_name", method)
 
-        self.assertEquals(check.description, "")
+        self.assertEqual(check.description, "")
 
     def test_check_when_check_method_returns_true(self):
         check = Check("check_name", self.check_method)
@@ -89,7 +90,7 @@
     def test_check_returns_right_return_value(self):
         check = Check("check_name", self.check_method)
 
-        self.assertEquals(check.check(), check.passed)
+        self.assertEqual(check.check(), check.passed)
 
     def test_check_after_exception_has_exception_attribute(self):
         self.exception = Exception("error")
@@ -128,7 +129,7 @@
         app = Application(DummyPreflight)
 
         self.assertEqual(app.name, "preflight checks")
-        self.assertEqual(len(app.checks), 4)
+        self.assertEqual(len(app.checks), 5)
 
     def test_check_name_is_properly_handled(self):
         app = Application(DummyPreflight)
@@ -138,6 +139,7 @@
             'check_test',
             'maybe_fail',
             'maybe_error',
+            'database',
         ]))
 
     def test_check_sets_passed_to_false_if_at_least_one_of_check_fails(self):
@@ -146,14 +148,11 @@
         self.assertFalse(app.passed)
 
     def test_check_sets_passed_to_true_if_all_checks_passed(self):
-        DummyPreflight.fail = False
-
-        app = Application(DummyPreflight)
+        with patch.object(DummyPreflight, 'fail', False):
+            app = Application(DummyPreflight)
 
         self.assertTrue(app.passed)
 
-        DummyPreflight.fail = True
-
 
 class AuthenticatePass(Preflight):
 
@@ -241,13 +240,13 @@
 
         applications = gather_checks()
 
-        self.assertEquals(len(applications), 3)
+        self.assertEqual(len(applications), 3)
 
 
 class ExtraVersionAsCallable(Preflight):
 
     def versions(self):
-        return [{'name': 'spam', 'version': 'ni'}]
+        return [{'name': 'spam', 'version': lambda: 'ni'}]
 
 
 class ExtraVersionAsList(Preflight):
@@ -262,7 +261,7 @@
 
         versions = gather_versions()
 
-        self.assertEquals(len(versions), 4)
+        self.assertEqual(len(versions), 3)
         for item in versions:
             self.assertTrue('name' in item and 'version' in item)
 
@@ -272,8 +271,8 @@
 
         versions = gather_versions()
 
-        self.assertEquals(len(versions), 5)
-        self.assertEquals(versions[-1]['name'], 'spam')
+        self.assertEqual(len(versions), 4)
+        self.assertEqual(versions[-1]['name'], 'spam')
 
     def test_get_extra_version_information_from_class_attribute(self):
         clear_registry()
@@ -281,8 +280,8 @@
 
         versions = gather_versions()
 
-        self.assertEquals(len(versions), 5)
-        self.assertEquals(versions[-1]['version'], 'peng')
+        self.assertEqual(len(versions), 4)
+        self.assertEqual(versions[-1]['version'], 'peng')
 
 
 class PreflightCommandTestCase(TestCase):
@@ -330,6 +329,7 @@
         finally:
             sys.stdout = sys.__stdout__
 
+
 class OverviewView(TestCase):
     @patch('preflight.views.authenticate')
     def test_overview_when_not_authenticated(self, mock_authenticate):
@@ -457,21 +457,11 @@
         self.assertFalse('secret' in result['default']['PASSWORD'])
 
 
-@skipIf(not settings.USE_GARGOYLE, 'skipping for Django 1.1')
 class GargoyleTestCase(TestCase):
 
     def setUp(self):
-        from gargoyle import gargoyle
         self.gargoyle = gargoyle
-        from gargoyle.builtins import IPAddressConditionSet
         self.IPAddressConditionSet = IPAddressConditionSet
-        from gargoyle.models import (
-            Switch,
-            DISABLED,
-            SELECTIVE,
-            GLOBAL,
-            INHERIT
-        )
         self.Switch = Switch
         self.DISABLED = DISABLED
         self.SELECTIVE = SELECTIVE
@@ -482,8 +472,8 @@
 
     def get_switches(self):
         switches = [
-            self.Switch(key='DISABLED', status=self.DISABLED,
-                description='switch 1'),
+            self.Switch(
+                key='DISABLED', status=self.DISABLED, description='switch 1'),
             self.Switch(key='SELECTIVE_1', status=self.SELECTIVE),
             self.Switch(key='SELECTIVE_2', status=self.SELECTIVE),
             self.Switch(key='GLOBAL', status=self.GLOBAL),
@@ -553,3 +543,38 @@
             self.assertEqual(row[0].text, switch.key)
             self.assertEqual(row[1].text, str(switch.description))
             self.assertEqual(row[3].text, switch.get_status_label())
+
+
+class PreflightTestCase(TestCase):
+
+    url = '/preflight/'
+    email = '[e-mail]'
+    password = 'testpassword'
+
+    def setUp(self):
+        super(PreflightTestCase, self).setUp()
+        self.user = User.objects.create_superuser(
+            username='pepe', email=self.email, password=self.password)
+
+    def test_anonymous(self):
+        response = self.client.get(self.url)
+
+        self.assertEqual(404, response.status_code)
+
+    def test_not_staff(self):
+        user = User.objects.create_user(
+            username='jose', email='[e-mail]', password=self.password)
+        assert not user.is_staff
+        assert self.client.login(username='jose', password=self.password)
+
+        response = self.client.get(self.url)
+        self.assertEqual(404, response.status_code)
+
+    def test_success(self):
+        assert self.user.is_staff
+        assert self.client.login(
+            username=self.user.username, password=self.password)
+
+        response = self.client.get(self.url)
+
+        self.assertEqual(200, response.status_code)

=== modified file 'preflight/urls.py'
--- preflight/urls.py	2011-10-04 15:54:50 +0000
+++ preflight/urls.py	2014-01-28 17:39:58 +0000
@@ -1,9 +1,9 @@
 # Copyright 2010 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
-from django.conf.urls.defaults import patterns, url
-
-
-urlpatterns = patterns('preflight.views',
+from django.conf.urls import patterns, url
+
+urlpatterns = patterns(
+    'preflight.views',
     url(r'^$', 'overview', name='preflight-overview'),
 )

=== modified file 'preflight/views.py'
--- preflight/views.py	2013-06-10 12:57:48 +0000
+++ preflight/views.py	2014-01-28 17:39:58 +0000
@@ -1,24 +1,26 @@
 # Copyright 2010 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
+import functools
+import json
+
 from datetime import datetime
-import json
-import functools
 
 from django.contrib.auth import authenticate as django_authenticate
-from django.views.decorators.cache import never_cache
 from django.http import Http404, HttpResponse
 from django.shortcuts import render_to_response
 from django.template import RequestContext
+from django.views.decorators.cache import never_cache
 
-from .models import (
+from preflight.conf import BASE_TEMPLATE, TABLE_CLASS
+from preflight.models import (
     authenticate,
+    gather_caches,
     gather_checks,
     gather_settings,
+    gather_switches,
     gather_versions,
-    gather_switches,
 )
-from .conf import BASE_TEMPLATE, TABLE_CLASS
 
 
 JSON_TYPE = 'application/json'
@@ -29,11 +31,16 @@
     if not authenticate(request):
         raise Http404
 
+    caches = {
+        name: [i for i in sorted(cache.iteritems())]
+        for name, cache in gather_caches().iteritems()
+    }
     data = {
         "applications": gather_checks(),
         "versions": gather_versions(),
         "settings": gather_settings(),
         "switches": gather_switches(),
+        "caches": caches,
     }
     # poor man's conneg
     if JSON_TYPE in request.META.get('HTTP_ACCEPT', ''):
@@ -76,5 +83,3 @@
                 request.user = basic_user
         return f(self, request)
     return wrapper
-
-

=== modified file 'preflight_example_project/app/preflight.py'
--- preflight_example_project/app/preflight.py	2011-02-07 16:06:51 +0000
+++ preflight_example_project/app/preflight.py	2014-01-28 17:39:58 +0000
@@ -5,9 +5,10 @@
 
 from django.conf import settings
 
-import os.path
+import os
+import tempfile
+
 import preflight
-import tempfile
 
 
 class AppPreflight(preflight.Preflight):

=== modified file 'preflight_example_project/run.py'
--- preflight_example_project/run.py	2013-05-31 16:23:03 +0000
+++ preflight_example_project/run.py	2014-01-28 17:39:58 +0000
@@ -13,7 +13,6 @@
 from django.conf import settings
 
 
-
 def tests():
     TestRunner = get_runner(settings)
     if hasattr(TestRunner, 'func_name'):
@@ -26,6 +25,5 @@
     sys.exit(bool(failures))
 
 
-
 if __name__ == '__main__':
     tests()

=== modified file 'preflight_example_project/urls.py'
--- preflight_example_project/urls.py	2011-10-04 15:54:50 +0000
+++ preflight_example_project/urls.py	2014-01-28 17:39:58 +0000
@@ -1,15 +1,14 @@
 # Copyright 2010 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
-from django.conf.urls.defaults import (
-    handler404, handler500, include, patterns
-)
+from django.conf.urls import include, patterns
 
 import preflight
 
 
 preflight.autodiscover()
 
-urlpatterns = patterns('',
+urlpatterns = patterns(
+    '',
     (r'^preflight/', include('preflight.urls')),
 )

=== modified file 'setup.py'
--- setup.py	2013-05-31 16:23:03 +0000
+++ setup.py	2014-01-28 17:39:58 +0000
@@ -56,7 +56,7 @@
         'preflight': ['templates/preflight/*.html'],
     },
     install_requires=[
-        'django >= 1.1',
+        'django >= 1.4',
     ],
     tests_require=tests_require,
     extras_require={

=== modified file 'tox.ini'
--- tox.ini	2013-05-17 14:50:46 +0000
+++ tox.ini	2014-01-28 17:39:58 +0000
@@ -1,10 +1,8 @@
 [tox]
-envlist = 
-        py2.6-django1.1, py2.7-django1.1,
-        py2.6-django1.2, py2.7-django1.2,
-        py2.6-django1.3, py2.7-django1.3,
+envlist =
         py2.6-django1.4, py2.7-django1.4,
         py2.6-django1.5, py2.7-django1.5,
+        py2.6-django1.6, py2.7-django1.6,
         docs
 
 [testenv]
@@ -19,18 +17,6 @@
     sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
 
 # Python 2.6
-[testenv:py2.6-django1.1]
-basepython = python2.6
-deps = django >= 1.1, < 1.2
-
-[testenv:py2.6-django1.2]
-basepython = python2.6
-deps = django >= 1.2, < 1.3
-
-[testenv:py2.6-django1.3]
-basepython = python2.6
-deps = django >= 1.3, < 1.4
-
 [testenv:py2.6-django1.4]
 basepython = python2.6
 deps = django >= 1.4, < 1.5
@@ -39,19 +25,11 @@
 basepython = python2.6
 deps = django >= 1.5, < 1.6
 
+[testenv:py2.6-django1.6]
+basepython = python2.6
+deps = django >= 1.6, < 1.7
+
 # Python 2.7
-[testenv:py2.7-django1.1]
-basepython = python2.7
-deps = django >= 1.1, < 1.2
-
-[testenv:py2.7-django1.2]
-basepython = python2.7
-deps = django >= 1.2, < 1.3
-
-[testenv:py2.7-django1.3]
-basepython = python2.7
-deps = django >= 1.3, < 1.4
-
 [testenv:py2.7-django1.4]
 basepython = python2.7
 deps = django >= 1.4, < 1.5
@@ -59,3 +37,7 @@
 [testenv:py2.7-django1.5]
 basepython = python2.7
 deps = django >= 1.5, < 1.6
+
+[testenv:py2.7-django1.6]
+basepython = python2.7
+deps = django >= 1.6, < 1.7