[#3196] Add tests for common sessions support

ckan · Aug 18, 2016 · 0daf144 · 0daf144
1 parent a64ebba
commit 0daf144
Show file tree

Hide file tree

Showing 3 changed files with 144 additions and 0 deletions.
diff --git a/ckan/templates/tests/flash_messages.html b/ckan/templates/tests/flash_messages.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <title>Hello</title>
+    </head>
+    <body>
+        Flash messages:
+        {% for message in h.flash.pop_messages() | list %}
+          <div>
+            {{ message.category }}: {{ h.literal(message) }}
+          </div>
+        {% endfor %}
+    </body>
+</html>
diff --git a/ckan/tests/config/test_sessions.py b/ckan/tests/config/test_sessions.py
@@ -0,0 +1,129 @@
+# encoding: utf-8
+
+from nose.tools import ok_
+
+from flask import Blueprint
+from flask import render_template
+from flask import redirect as flask_redirect
+from flask import url_for
+from ckan.lib.base import redirect as pylons_redirect
+from ckan.lib.base import render as pylons_render
+
+import ckan.plugins as p
+import ckan.tests.helpers as helpers
+import ckan.lib.helpers as h
+
+
+class TestCrossFlaskPylonsFlashMessages(helpers.FunctionalTestBase):
+    u'''
+    Test that flash message set in the Pylons controller can be accessed by
+    Flask views, and visa versa.
+    '''
+
+    def setup(self):
+        self.app = helpers._get_test_app()
+
+        # Install plugin and register its blueprint
+        if not p.plugin_loaded(u'test_flash_plugin'):
+            p.load(u'test_flash_plugin')
+            plugin = p.get_plugin(u'test_flash_plugin')
+            self.app.flask_app.register_extension_blueprint(
+                plugin.get_blueprint())
+
+    def test_flash_populated_by_flask_redirect_to_flask(self):
+        u'''
+        Flash store is populated by Flask view is accessible by another Flask
+        view.
+        '''
+        res = self.app.get(
+            u'/flask_add_flash_message_redirect_to_flask').follow()
+
+        ok_(u'This is a success message populated by Flask' in res.body)
+
+    def test_flash_populated_in_pylons_action_redirect_to_flask(self):
+        u'''
+        Flash store is populated by pylons action is accessible by Flask view.
+        '''
+        res = self.app.get(u'/pylons_add_flash_message_redirect_view').follow()
+
+        ok_(u'This is a success message populated by Pylons' in res.body)
+
+    def test_flash_populated_in_flask_view_redirect_to_pylons(self):
+        u'''
+        Flash store is populated by flask view is accessible by pylons action.
+        '''
+        res = self.app.get(
+            u'/flask_add_flash_message_redirect_pylons').follow()
+
+        ok_(u'This is a success message populated by Flask' in res.body)
+
+
+class FlashMessagePlugin(p.SingletonPlugin):
+    u'''
+    A Flask and Pylons compatible IRoutes/IBlueprint plugin to add Flask views
+    and Pylons actions to display flash messages.
+    '''
+
+    p.implements(p.IRoutes, inherit=True)
+    p.implements(p.IBlueprint)
+
+    def flash_message_view(self):
+        u'''Flask view that renders the flash message html template.'''
+        return render_template(u'tests/flash_messages.html')
+
+    def add_flash_message_view_redirect_to_flask(self):
+        u'''Add flash message, then redirect to Flask view to render it.'''
+        h.flash_success(u'This is a success message populated by Flask')
+        return flask_redirect(url_for(u'test_flash_plugin.flash_message_view'))
+
+    def add_flash_message_view_redirect_to_pylons(self):
+        u'''Add flash message, then redirect to view that renders it'''
+        h.flash_success(u'This is a success message populated by Flask')
+        return flask_redirect(u'/pylons_view_flash_message')
+
+    def get_blueprint(self):
+        u'''Return Flask Blueprint object to be registered by the Flask app.'''
+
+        # Create Blueprint for plugin
+        blueprint = Blueprint(self.name, self.__module__)
+        # Add plugin url rules to Blueprint object
+        rules = [
+            (u'/flask_add_flash_message_redirect_to_flask',
+             u'add_flash_message',
+             self.add_flash_message_view_redirect_to_flask),
+            (u'/flask_add_flash_message_redirect_pylons',
+             u'add_flash_message_view_redirect_to_pylons',
+             self.add_flash_message_view_redirect_to_pylons),
+            (u'/flask_view_flash_message', u'flash_message_view',
+             self.flash_message_view),
+        ]
+        for rule in rules:
+            blueprint.add_url_rule(*rule)
+
+        return blueprint
+
+    controller = \
+        u'ckan.tests.config.test_sessions:PylonsAddFlashMessageController'
+
+    def before_map(self, _map):
+        u'''Update the pylons route map to be used by the Pylons app.'''
+        _map.connect(u'/pylons_add_flash_message_redirect_view',
+                     controller=self.controller,
+                     action=u'add_flash_message_redirect')
+
+        _map.connect(u'/pylons_view_flash_message',
+                     controller=self.controller,
+                     action=u'flash_message_action')
+        return _map
+
+
+class PylonsAddFlashMessageController(p.toolkit.BaseController):
+
+    def flash_message_action(self):
+        u'''Pylons view to render flash messages in a template.'''
+        return pylons_render(u'tests/flash_messages.html')
+
+    def add_flash_message_redirect(self):
+        # Adds a flash message and redirects to flask view
+        h.flash_success(u'This is a success message populated by Pylons')
+        return pylons_redirect(u'/flask_view_flash_message')
diff --git a/setup.py b/setup.py
@@ -164,6 +164,7 @@
         'test_datastore_view = ckan.tests.lib.test_datapreview:MockDatastoreBasedResourceView',
         'test_datapusher_plugin = ckanext.datapusher.tests.test_interfaces:FakeDataPusherPlugin',
         'test_routing_plugin = ckan.tests.config.test_middleware:MockRoutingPlugin',
+        'test_flash_plugin = ckan.tests.config.test_sessions:FlashMessagePlugin',
         'test_helpers_plugin = ckan.tests.lib.test_helpers:TestHelpersPlugin',
     ],
     'babel.extractors': [