testcase.py

# Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
# for details. All rights reserved. Use of this source code is governed by a
# BSD-style license that can be found in the LICENSE file.

import base64
import os
import re
import unittest
from cStringIO import StringIO
from decorator import decorator

import cherrypy
import webtest
from bs4 import BeautifulSoup
from Crypto.PublicKey import RSA
from Crypto import Random
from google.appengine.ext import deferred
from google.appengine.ext.testbed import Testbed
from google.appengine.ext.testbed import TASKQUEUE_SERVICE_NAME
from google.appengine.ext.testbed import USER_SERVICE_NAME
from google.appengine.api.user_service_pb import UserServiceError
from google.appengine.api import users
import json
import yaml
import tarfile

import handlers
from pub_dartlang import Application
from models.package import Package
from models.package_version import PackageVersion
from models.private_key import PrivateKey
from models.pubspec import Pubspec

class TestCase(unittest.TestCase):
    """Utility methods for testing.

    This class should be used as the superclass of all other test classes. It
    sets up the necessary test stubs and provides various utility methods to use
    in tests.
    """

    def setUp(self):
        """Initialize stubs for testing.

        This initializes the following fields:
          self.testbed: An App Engine Testbed used for mocking App Engine
            services. This is activated, and any necessary stubs are
            initialized.
          self.testapp: A webtest.TestApp wrapping the CherryPy application.

        Subclasses that define their own setUp method should be sure to call
        this one as well.
        """

        self.__users = {}
        self.__admins = {}

        self.testbed = Testbed()
        self.testbed.activate()
        self.testbed.init_app_identity_stub()
        self.testbed.init_blobstore_stub()
        self.testbed.init_datastore_v3_stub()
        self.testbed.init_files_stub()
        self.testbed.init_memcache_stub()
        self.testbed.init_taskqueue_stub()
        self.testbed.init_user_stub()

        self.testapp = webtest.TestApp(Application())

        # These private keys are not used for anything other than testing.
        PrivateKey.set_oauth('''-----BEGIN RSA PRIVATE KEY-----
Proc-Type: 4,ENCRYPTED
DEK-Info: DES-EDE3-CBC,CEB8C6541017AC8B

q1SgqAfgHXK5cQvtdIF8rkSlbAS6a92T5tYMVKJIW24giF5cw+1++X7X6S5ECykC
/iECExP7WfVlPDVoJMZpWGsYLMPhxncnKfUDICbVgwsO4KKeEv8lYTrvkY1sCZIx
kSja/lGAWpyxBnmxwoLh0LbLJBGUxUgn2Uqv/8Iid+w0m3NlgrllV+kOo4gUYF9q
bestH4nEQj6F0CeI8VPW0FxzMwn0vreHFBT5hul6xbNdB1vnRcz6ed4FiGXoAB5K
/8/Q2qyy1UPe2Hr9IoC6wo4h2kXq7pmhy/rtzU9/gjsGPD33ByavbgHAen0ajY5p
RmCx0AGidK9T6/SNoyDD9CMq7ypL+0JWoCeVoAEw2aZqN4rMJNbKMgPH+ajgiAXe
AWuMVjWN6uTL5+QJmWQct6a6TF8GPKdTcOZfNIXU5U9drHB2hggLcy6XkCYGjVJv
MvLascE4oAtOHnwz7WhrpcmX6F6Fww+TPnFzjk+IGJrnBUnAArEcM13IjiDUgg9B
iLuKimwrqasdBBY3Ua3SRMoG8PJoNKdsk1hDGlpxLnqOVUCvPKZuz4QnFusnUJrR
kiv+aqVBpZYymMh2Q1MWcogA7rL7LIowAkyLzS8dNwDhyk9jbO+1uoFSHKr5BTNv
cMJfCVm8pqhXwCVx3uYnhUzvth7mcEseXh5Dcg1RHka5rCXUz4eVxTkj1u3FOy9o
9jgARPpnDYsXH1lESxmiNZucHa50qI/ezNvQx8CbNa1/+JWoZ77yqM9qnDlXUwDY
1Sxqx9+4kthG9oyCzzUwFvhf1kTEHd0RfIapgjJ16HBQmzLnEPtjPA==
-----END RSA PRIVATE KEY-----''')

        PrivateKey.set_api('not a real API key')

        self.dont_be_oauth_user()

    def tearDown(self):
        """Deactivates the stubs initialized in setUp.

        Subclasses that define their own tearDown method should be sure to call
        this one as well.
        """
        self.testbed.deactivate()

    def normal_user(self, name = None):
        """Constructs a non-admin user object.

        Arguments:
          name: A string to distinguish this user from others. Users with
            different names will be distinct, and the same name will always
            refer to the same user. Admin users have a separate namespace from
            non-admin users.

        Returns: The user object.
        """

        if self.__users.has_key(name):
            return self.__users[name]

        email = 'test-user@example.com'
        if name:
            email = 'test-user-%s@example.com' % name

        self.__users[name] = users.User(email = email)
        return self.__users[name]

    def admin_user(self, name = None):
        """Constructs an admin user object.

        Arguments:
          name: A string to distinguish this user from others. Users with
            different names will be distinct, and the same name will always
            refer to the same user. Admin users have a separate namespace from
            non-admin users.

        Returns: The user object.
        """

        if self.__admins.has_key(name):
            return self.__admins[name]

        email = 'test-admin@example.com'
        if name:
            email = 'test-admin-%s@example.com' % name

        self.__admins[name] = users.User(email = email)
        return self.__admins[name]

    def be_normal_user(self, name = None):
        """Log in as a non-admin user.

        Arguments:
          name: A string to distinguish this user from others. Users with
            different names will be distinct, and the same name will always
            refer to the same user. Admin users have a separate namespace from
            non-admin users.
        """
        self.testbed.setup_env(
            user_email = self.normal_user(name).email(),
            overwrite = True)

    def be_admin_user(self, name = None):
        """Log in as an admin user.

        Arguments:
          name: A string to distinguish this user from others. Users with
            different names will be distinct, and the same name will always
            refer to the same user. Admin users have a separate namespace from
            non-admin users.
        """
        self.testbed.setup_env(
            user_email = self.admin_user(name).email(),
            user_is_admin = '1',
            overwrite = True)

    def dont_be_oauth_user(self):
        """Don't consider the user to be logged in via OAuth."""
        self.testbed.setup_env(
            oauth_error_code=str(UserServiceError.OAUTH_INVALID_REQUEST),
            oauth_error_detail='',
            oauth_last_scope='https://www.googleapis.com/auth/userinfo.email')

    def be_normal_oauth_user(self, name=None):
        """Log in as a non-admin OAuth user.

        Arguments:
          name: A string to distinguish this user from others. Users with
            different names will be distinct, and the same name will always
            refer to the same user. Admin users have a separate namespace from
            non-admin users.
        """
        try: del os.environ['OAUTH_ERROR_CODE']
        except KeyError: pass
        self.set_oauth_user(self.normal_user(name))

    def be_admin_oauth_user(self, name=None):
        """Log in as an admin OAuth user.

        Arguments:
          name: A string to distinguish this user from others. Users with
            different names will be distinct, and the same name will always
            refer to the same user. Admin users have a separate namespace from
            non-admin users.
        """
        try: del os.environ['OAUTH_ERROR_CODE']
        except KeyError: pass
        self.set_oauth_user(self.admin_user(name))

    def set_oauth_user(self, user):
        """Set the user that is logged in via OAuth."""
        self.testbed.get_stub(USER_SERVICE_NAME).SetOAuthUser(
            email=user.email(),
            user_id=user.user_id() or '0',
            is_admin=user.email().startswith('test-admin'))

    def create_package(self, name, version):
        """Create and save a package object with a version."""
        Package.new(name=name, uploaders=[users.get_current_user()]).put()
        self.set_latest_version(name, version)

    def set_latest_version(self, package_name, version):
        """Set the latest version of the given package."""
        package = Package.get_by_key_name(package_name)
        package.latest_version = self.package_version(package, version)
        package.latest_version.put()
        package.put()

    def package_version(self, package, version,
                       **additional_pubspec_fields):
        """Create a package version object.

        This constructs the package archive based on the other information
        passed in. The archive contains only the pubspec.
        """
        pubspec = Pubspec(name=package.name, version=version)
        pubspec.update(additional_pubspec_fields)
        return PackageVersion.new(
            version=version,
            package=package,
            pubspec=pubspec,
            uploader=package.uploaders[0])

    def tar_package(self, pubspec, files={}):
        """Return a tarfile containing the given pubspec.

        The pubspec is dumped to YAML, then placed in a tarfile. The tarfile is
        then returned as a string.
        """
        files['pubspec.yaml'] = yaml.dump(pubspec)
        files['README'] = "This is a README."
        return self.io_for_archive(files).getvalue()

    def io_for_archive(self, files):
        """Return a StringIO object containing a .tar.gz archive.

        Arugments:
          files: A dict of the names and contents of files in the archive.
        """

        tarfile_io = StringIO()
        tar = tarfile.open(fileobj=tarfile_io, mode='w:gz')
        for name, contents in files.iteritems():
            tarinfo = tarfile.TarInfo(name)
            io = StringIO(contents)
            tarinfo.size = len(contents)
            tar.addfile(tarinfo, io)
        tar.close()

        tarfile_io.seek(0)
        return tarfile_io

    def archive(self, files):
        """Creates a TarFile archive.

        Arugments:
          files: A dict of the names and contents of files in the archive.
        """
        return tarfile.open(fileobj=self.io_for_archive(files))

    def upload_archive(self, name, version, **additional_pubspec_fields):
        """Return a tuple representing a package archive upload."""
        pubspec = {'name': name, 'version': version}
        pubspec.update(additional_pubspec_fields)
        contents = self.tar_package(pubspec)
        return ('file', '%s-%s.tar.gz' % (name, version), contents)

    def post_package_version(self, version, name='test-package'):
        response = self.upload_package(self.upload_archive(name, version))
        self.assert_json_success(response)

    def upload_package(self, upload, status=None):
        get_response = self.testapp.get('/api/packages/versions/new')
        self.assertEqual(get_response.status_int, 200)
        content = json.loads(get_response.body)
        post_response = self.testapp.post(str(content['url']),
                                          content['fields'],
                                          upload_files=[upload])

        self.assertEqual(post_response.status_int, 302)
        self.assertTrue(re.match(
                r'^http://localhost:80/api/packages/versions/[^/]+/create$',
                post_response.headers['Location']))

        path = post_response.headers['Location'].replace(
            'http://localhost:80', '')
        return self.testapp.get(path, status=status)

    def assert_requires_login(self, response):
        """Assert that the given response is requesting user authentication."""
        self.assertEqual(response.status_int, 302)
        self.assertTrue(
            response.headers['Location'].startswith(
                'https://www.google.com/accounts/Login?continue='),
            'expected response to redirect to the Google login page')

    def assert_error_page(self, response):
        """Assert that the given response renders an HTTP error page.

        This only checks for HTTP errors; it will not detect flash error
        messages.

        Arguments:
          response: The webtest response object to check.
        """
        error = self.html(response).find("p", "error-message")
        self.assertTrue(error is not None, "expected error page")

    def assert_json_error(self, response):
        """Assert that the given response is a JSON error."""
        self.assertTrue("error" in json.loads(response.body))

    def assert_json_success(self, response):
        """Assert that the given response is a JSON success."""
        self.assertEqual(response.status_int, 200)
        self.assertTrue("success" in json.loads(response.body))

    def assert_oauth_error(self, response):
        """Assert that the given response is an OAuth2 error."""
        self.assertTrue(response.headers['WWW-Authenticate'].startswith(
                'Bearer error="'))

    def html(self, response):
        """Parse a webtest response with BeautifulSoup.

        WebTest includes built-in support for BeautifulSoup 3.x, but we want to
        be able to use the features in 4.x.

        Arguments:
          response: The webtest response object to parse.

        Returns: The BeautifulSoup parsed HTML.
        """
        return BeautifulSoup(response.body)

    def assert_link(self, response, url):
        """Assert that the response contains a link to the given url.

        Arguments:
          response: The webtest response object to check.
          url: The link URL to look for.
        """
        error_msg = "expected response body to contain a link to '%s'" % url
        self.assertTrue(self._link_exists(response, url), error_msg)

    def assert_no_link(self, response, url):
        """Assert that the response doesn't contain a link to the given url.

        Arguments:
          response: The webtest response object to check.
          url: The link URL to look for.
        """
        error_msg = "expected response body not to contain a link to '%s'" % url
        self.assertFalse(self._link_exists(response, url), error_msg)

    def assert_list_in_html(self, url, selector, expected_items):
        """Assert that the selected elements' contents match the given list.

        There must be as many selected elements as strings in the list, and each
        element's text must contain the respective string in the list.

        Arguments:
          url: The URL to request.
          selector: The CSS selector to apply to the resulting HTML.
          expected_items: A list of strings to look for in the matched elements.
        """

        response = self.testapp.get(url)
        for html in self.html(response).select(selector):
            if not expected_items:
                self.fail("more items were listed than expected: %s" % html)
            elif expected_items[0] in ''.join(html.strings):
                del expected_items[0]
            else:
                self.fail("expected '%s' in %s" % (expected_items[0], html))

        self.assertEqual(expected_items, [],
                "Selector '%s' missing items: %s" % (selector, expected_items))

    def run_deferred_tasks(self, queue='default'):
        """Run all tasks that have been deferred.

        Arguments:
          queue: The task queue in which the deferred tasks are queued.
        """
        taskqueue_stub = self.testbed.get_stub(TASKQUEUE_SERVICE_NAME)
        for task in taskqueue_stub.GetTasks(queue):
            deferred.run(base64.b64decode(task['body']))
        taskqueue_stub.FlushQueue(queue)

    def _link_exists(self, response, url):
        """Return whether or not the response contains a link to the given url.

        Arguments:
          response: The webtest response object to check.
          url: The link URL to look for.
        """
        return any([link.get('href') == url for link
                    in self.html(response).find_all('a')])

    def package_version_dict(self, name, version):
        """Returns the expected API dictionary for a package version."""

        package_url = "http://localhost:80/api/packages/" + name
        version_url = package_url + "/versions/" + version
        return {
            "version": version,
            "url": version_url,
            "package_url": package_url,
            "new_dartdoc_url": version_url + "/new_dartdoc",
            "archive_url": "http://localhost:80/packages/" + name +
                "/versions/" + version + ".tar.gz",
            "pubspec": {"name": name, "version": version}
        }

@decorator
def mock_not_on_dev_server(fn, *args, **kwargs):
    """A decorator for tests that need to appear to not be on the dev server.

    This is only used for the error page tests since the error page
    specifically checks to see if you're running on the dev server.
    """
    try:
        handlers.set_is_dev_server(False)
        fn(*args, **kwargs)
    finally:
        handlers.set_is_dev_server(None)