Merge lp:~zematynnad/ubuntu-webcatalog/preflight_987822 into lp:ubuntu-webcatalog

[Danny Tamez]

Preflight check for webcatalog

Overview
=========
This branch adds some more functionality for preflight check to webcatalog.

Details
========
To view preflight for ubuntu-webcatalog go to /+preflight. Here is a screenshot of the preflight page: http://simplest-image-hosting.net/png-0-sn2383

The setting PREFLIGHT_GROUPS was added so that we can configure which groups are allowed to view the preflight page. Since webcatalog does not currently have a login page the +preflight url redirects to the openid login page and then redirects on success to the preflight page.

To Test
=========
$fab bootstrap test

[Natalia Bidart (nataliabidart)]

While running the test suite I'm getting 3 failures that I already had notices in trunk, those are fixed in:

https://code.launchpad.net/~nataliabidart/ubuntu-webcatalog/law-and-order/+merge/108204

Would you please review and merge that branch in?

Besides that, I'm getting this output from the test run:

Creating test database for alias 'default'...
...................................................................F...F.......................F........................................................................................................................................Generated checkid_setup request to https://login.staging.ubuntu.com/+openid with assocication {HMAC-SHA1}{4fc7c2c1}{RSEj3w==}
................./home/nessita/canonical/webcatalog/review_preflight_987822/src/webcatalog/preflight.py:46:5: E303 too many blank lines (2)
.

Would you fix the pep8 issue? And perhaps check what is printing the "Generated checkid_setup request to..." message being printed?

Thanks!

review: Needs Fixing

[lp:~zematynnad/ubuntu-webcatalog/preflight_987822]

127. By Danny Tamez on 2012-05-31

Merge from trunk.

128. By Danny Tamez on 2012-05-31

Remove extra blank line.

129. By Danny Tamez on 2012-05-31

Fix docstrings and move imports to the top.

[Natalia Bidart (nataliabidart)]

Looks good! Thanks

review: Approve

=== modified file 'django_project/urls.py'
--- django_project/urls.py	2012-03-19 17:01:05 +0000
+++ django_project/urls.py	2012-05-31 20:32:19 +0000
@@ -29,6 +29,8 @@
     url(r'^cat/', include('webcatalog.urls')),
     url(r'^admin/', include(admin.site.urls)),
     (r'^preflight/$', include('preflight.urls')),
+    url(r'^\+preflight/$', redirect_to,
+        {'url': '/openid/login?next=/preflight/'}),
     url(r'^$', redirect_to, {'url': '/cat/'}),
 
     # OpenID views

=== added file 'src/webcatalog/preflight.py'
--- src/webcatalog/preflight.py	1970-01-01 00:00:00 +0000
+++ src/webcatalog/preflight.py	2012-05-31 20:32:19 +0000
@@ -0,0 +1,90 @@
+#   -*- coding: utf-8 -*-
+#   This file is part of the Apps Directory
+#   Copyright (C) 2011 Canonical Ltd.
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU Affero General Public License as
+#   published by the Free Software Foundation, either version 3 of the
+#   License, or (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU Affero General Public License for more details.
+#
+#   You should have received a copy of the GNU Affero General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Preflight check for webcatalog."""
+
+from __future__ import (
+    absolute_import,
+    with_statement,
+    )
+
+from django import db
+from django.conf import settings
+from preflight import Preflight, register
+
+import openid
+import piston.utils
+
+from webcatalog.utilities import WebServices
+
+__metaclass__ = type
+__all__ = [
+    'WebcatalogPreflight'
+    ]
+
+
+class WebcatalogPreflight(Preflight):
+
+    def authenticate(self, request):
+        if not request.user.is_authenticated():
+            return False
+        allowed_teams = getattr(settings, 'PREFLIGHT_GROUPS', [])
+        groups = request.user.groups.filter(name__in=allowed_teams)
+        return groups.count() > 0
+
+    def versions(self):
+        return [
+            {'name': 'openid', 'version': openid.__version__},
+            {'name': 'piston', 'version': piston.utils.get_version()},
+        ]
+
+    def check_validate_config(self):
+        """Make sure that our config files validate correctly. """
+        parser = settings.__CONFIGGLUE_PARSER__
+        return parser.is_valid()
+
+    def check_rnr_available(self):
+        """Make sure that rnr can be reached. """
+        rnr = WebServices().rnr_api
+        return rnr.server_status() == 'ok'
+
+    def check_recommender_available(self):
+        """Make sure that the recommender can be reached. """
+        recommender = WebServices().recommender_api
+        return recommender.server_status() == 'ok'
+
+    def check_screenshots_available(self):
+        """Make sure that screenshots are available. """
+        screenshots = WebServices().get_screenshots_for_package('apt')
+        return len(screenshots) > 0
+
+    def check_identity_provider_available(self):
+        """Make sure SSO can be reached."""
+        sso = WebServices().identity_provider
+        return not sso.validate_token(
+            consumer_key='invalid', token="token")
+
+    def check_database(self):
+        """Make sure database connections are accepted."""
+        cursor = db.connection.cursor()
+        cursor.execute('SELECT 42')
+        cursor.fetchone()
+
+        return True
+
+
+register(WebcatalogPreflight)

=== modified file 'src/webcatalog/schema.py'
--- src/webcatalog/schema.py	2012-04-19 23:05:19 +0000
+++ src/webcatalog/schema.py	2012-05-31 20:32:19 +0000
@@ -72,6 +72,7 @@
     class preflight(schema.Section):
         preflight_base_template = schema.StringOption(
             default="webcatalog/base.html")
+        preflight_groups = schema.ListOption(item=schema.StringOption())
 
     class rnr(schema.Section):
         rnr_service_root = schema.StringOption(

=== modified file 'src/webcatalog/tests/__init__.py'
--- src/webcatalog/tests/__init__.py	2012-03-08 18:00:09 +0000
+++ src/webcatalog/tests/__init__.py	2012-05-31 20:32:19 +0000
@@ -25,6 +25,7 @@
 from .test_models import *
 from .test_managers import *
 from .test_pep8 import *
+from .test_preflight import *
 from .test_templatetags import *
 from .test_utilities import *
 from .test_views import *

=== added file 'src/webcatalog/tests/test_preflight.py'
--- src/webcatalog/tests/test_preflight.py	1970-01-01 00:00:00 +0000
+++ src/webcatalog/tests/test_preflight.py	2012-05-31 20:32:19 +0000
@@ -0,0 +1,107 @@
+#   -*- coding: utf-8 -*-
+#   This file is part of the Ubuntu Web Catalog
+#   Copyright (C) 2011 Canonical Ltd.
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU Affero General Public License as
+#   published by the Free Software Foundation, either version 3 of the
+#   License, or (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU Affero General Public License for more details.
+#
+#   You should have received a copy of the GNU Affero General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from django.contrib.auth.models import (
+    Group,
+    User,
+    )
+from mock import patch
+
+from webcatalog.tests.factory import TestCaseWithFactory
+from webcatalog.tests.helpers import patch_settings
+
+__metaclass__ = type
+
+
+class TestPreflight(TestCaseWithFactory):
+
+    def login(self, add_to_group=True, user=None):
+        if not user:
+            user = User.objects.create_user(username='test',
+                                            email='[e-mail]',
+                                            password='test')
+        if add_to_group:
+            group = Group.objects.create(name='preflight')
+            user.groups.add(group)
+            user.save()
+        self.client.login(username='test', password='test')
+
+    def test_public_url_redirects_to_login(self):
+        response = self.client.get('/+preflight', follow=True)
+
+        with patch_settings(PREFLIGHT_GROUPS=['preflight']):
+            self.assertContains(response, 'OpenID transaction in progress')
+
+    def test_login_needed_for_preflight(self):
+        self.login()
+
+        with patch_settings(PREFLIGHT_GROUPS=['preflight']):
+            response = self.client.get('/preflight/')
+
+        self.assertEqual(200, response.status_code)
+
+    def test_no_login_means_preflight_not_found(self):
+        with patch_settings(PREFLIGHT_GROUPS=['preflight']):
+            response = self.client.get('/preflight/')
+
+        self.assertEqual(404, response.status_code)
+
+    def test_login_but_wrong_group_means_preflight_not_found(self):
+        with patch_settings(PREFLIGHT_GROUPS=['preflight']):
+            self.login(add_to_group=False)
+
+        response = self.client.get('/preflight/')
+
+        self.assertEqual(404, response.status_code)
+
+    @patch('webcatalog.utilities.WebServices.identity_provider')
+    @patch('webcatalog.utilities.WebServices.get_screenshots_for_package')
+    @patch('webcatalog.utilities.WebServices.recommender_api')
+    @patch('webcatalog.utilities.WebServices.rnr_api')
+    def test_success(self, mock_rnr, mock_recommender, mock_screenshots,
+                     mock_sso):
+        mock_rnr.server_status.return_value = 'ok'
+        mock_recommender.server_status.return_value = 'ok'
+        mock_screenshots.return_value = ['some_screenshot.jpg']
+        mock_sso.validate_token.return_value = False
+        self.login()
+
+        with patch_settings(PREFLIGHT_GROUPS=['preflight']):
+            response = self.client.get('/preflight/')
+
+        self.assertEqual(200, response.status_code)
+        libs = set([x['name'] for x in response.context[0]['versions']])
+        apps = response.context['applications']
+        checks = set((x.name, x.passed) for x in apps[0].checks)
+        expected_libs = set([
+            'Python',
+            'openid',
+            'piston',
+            'Django',
+            'preflight',
+            ])
+        expected_checks = set([
+            ('validate_config', True),
+            ('database', True),
+            ('rnr_available', True),
+            ('identity_provider_available', True),
+            ('recommender_available', True),
+            ('rnr_available', True),
+            ('screenshots_available', True),
+            ])
+        self.assertEqual(expected_libs, libs)
+        self.assertEqual(expected_checks, checks)