~launchpad-pqm/launchpad/devel

# Copyright 2010 Canonical Ltd.  This software is licensed under the

# GNU Affero General Public License version 3 (see the file LICENSE).

import unittest

import urllib

import lazr.uri

import wsgi_intercept

from wsgi_intercept.urllib2_intercept import install_opener, uninstall_opener

import wsgi_intercept.zope_testbrowser

from paste.httpexceptions import HTTPExceptionHandler

from canonical.config import config

from canonical.launchpad.webapp.vhosts import allvhosts

from canonical.testing.layers import DatabaseFunctionalLayer

from launchpad_loggerhead.app import RootApp

from launchpad_loggerhead.session import SessionHandler

from lp.testing import TestCase

SESSION_VAR = 'lh.session'

# See sourcecode/launchpad-loggerhead/start-loggerhead.py for the production

# mechanism for getting the secret.

SECRET = 'secret'

def session_scribbler(app, test):

    """Squirrel away the session variable."""

    def scribble(environ, start_response):

        test.session = environ[SESSION_VAR] # Yay for mutables.

        return app(environ, start_response)

    return scribble

def dummy_destination(environ, start_response):

    """Return a fake response."""

    start_response('200 OK', [('Content-type','text/plain')])

    return ['This is a dummy destination.\n']

class SimpleLogInRootApp(RootApp):

    """A mock root app that doesn't require open id."""

    def _complete_login(self, environ, start_response):

        environ[SESSION_VAR]['user'] = 'bob'

        start_response('200 OK', [('Content-type','text/plain')])

        return ['\n']

class TestLogout(TestCase):

    layer = DatabaseFunctionalLayer

    def intercept(self, uri, app):

        """Install wsgi interceptors for the uri, app tuple."""

        if isinstance(uri, basestring):

            uri = lazr.uri.URI(uri)

        port = uri.port

        if port is None:

            if uri.scheme == 'http':

                port = 80

            elif uri.scheme == 'https':

                port = 443

            else:

                raise NotImplementedError(uri.scheme)

        else:

            port = int(port)

        wsgi_intercept.add_wsgi_intercept(uri.host, port, lambda: app)

        self.intercepted.append((uri.host, port))

    def setUp(self):

        TestCase.setUp(self)

        self.intercepted = []

        self.session = None

        self.root = app = SimpleLogInRootApp(SESSION_VAR)

        app = session_scribbler(app, self)

        app = HTTPExceptionHandler(app)

        app = SessionHandler(app, SESSION_VAR, SECRET)

        self.cookie_name = app.cookie_handler.cookie_name

        self.intercept(config.codehosting.codebrowse_root, app)

        self.intercept(config.codehosting.secure_codebrowse_root, app)

        self.intercept(allvhosts.configs['mainsite'].rooturl,

                       dummy_destination)

        install_opener()

        self.browser = wsgi_intercept.zope_testbrowser.WSGI_Browser()

        # We want to pretend we are not a robot, or else mechanize will honor

        # robots.txt.

        self.browser.mech_browser.set_handle_robots(False)

        self.browser.open(

            config.codehosting.secure_codebrowse_root + '+login')

    def tearDown(self):

        uninstall_opener()

        for host, port in self.intercepted:

            wsgi_intercept.remove_wsgi_intercept(host, port)

        TestCase.tearDown(self)

    def testLoggerheadLogout(self):

        # We start logged in as 'bob'.

        self.assertEqual(self.session['user'], 'bob')

        self.browser.open(

            config.codehosting.secure_codebrowse_root + 'favicon.ico')

        self.assertEqual(self.session['user'], 'bob')

        self.failUnless(self.browser.cookies.get(self.cookie_name))

        # When we visit +logout, our session is gone.

        self.browser.open(

            config.codehosting.secure_codebrowse_root + '+logout')

        self.assertEqual(self.session, {})

        # By default, we have been redirected to the Launchpad root.

        self.assertEqual(

            self.browser.url, allvhosts.configs['mainsite'].rooturl)

        # The session cookie still exists, because of how

        # paste.auth.cookie works (see

        # http://trac.pythonpaste.org/pythonpaste/ticket/139 ) but the user

        # does in fact have an empty session now.

        self.browser.open(

            config.codehosting.secure_codebrowse_root + 'favicon.ico')

        self.assertEqual(self.session, {})

    def testLoggerheadLogoutRedirect(self):

        # When we visit +logout with a 'next_to' value in the query string,

        # the logout page will redirect to the given URI.  As of this

        # writing, this is used by Launchpad to redirect to our OpenId

        # provider (see canonical.launchpad.tests.test_login.

        # TestLoginAndLogout.test_CookieLogoutPage).

        # Here, we will have a more useless example of the basic machinery.

        dummy_root = 'http://dummy.dev/'

        self.intercept(dummy_root, dummy_destination)

        self.browser.open(

            config.codehosting.secure_codebrowse_root +

            '+logout?' +

            urllib.urlencode(dict(next_to=dummy_root + '+logout')))

        # We are logged out, as before.

        self.assertEqual(self.session, {})

        # Now, though, we are redirected to the ``next_to`` destination.

        self.assertEqual(self.browser.url, dummy_root + '+logout')

        self.assertEqual(self.browser.contents,

                         'This is a dummy destination.\n')

def test_suite():

    return unittest.TestLoader().loadTestsFromName(__name__)