mediagoblin/tests/tools.py

   1 # GNU MediaGoblin -- federated, autonomous media hosting
   2 # Copyright (C) 2011 Free Software Foundation, Inc
   3 #
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU Affero General Public License as published by
   6 # the Free Software Foundation, either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU Affero General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Affero General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18 import pkg_resources
  19 import os, shutil
  20
  21 from paste.deploy import loadapp
  22 from webtest import TestApp
  23
  24 from mediagoblin import util, mg_globals
  25 from mediagoblin.config import read_mediagoblin_config
  26 from mediagoblin.celery_setup import setup_celery_from_config
  27 from mediagoblin.decorators import _make_safe
  28 from mediagoblin.db.open import setup_connection_and_db_from_config
  29
  30
  31 MEDIAGOBLIN_TEST_DB_NAME = u'__mediagoblin_tests__'
  32 TEST_SERVER_CONFIG = pkg_resources.resource_filename(
  33     'mediagoblin.tests', 'test_paste.ini')
  34 TEST_APP_CONFIG = pkg_resources.resource_filename(
  35     'mediagoblin.tests', 'test_mgoblin_app.ini')
  36 TEST_USER_DEV = pkg_resources.resource_filename(
  37     'mediagoblin.tests', 'test_user_dev')
  38 MGOBLIN_APP = None
  39 CELERY_SETUP = False
  40
  41 USER_DEV_DIRECTORIES_TO_SETUP = [
  42     'media/public', 'media/queue',
  43     'beaker/sessions/data', 'beaker/sessions/lock']
  44
  45 BAD_CELERY_MESSAGE = """\
  46 Sorry, you *absolutely* must run nosetests with the
  47 mediagoblin.celery_setup.from_tests module.  Like so:
  48 $ CELERY_CONFIG_MODULE=mediagoblin.celery_setup.from_tests ./bin/nosetests"""
  49
  50
  51 class BadCeleryEnviron(Exception): pass
  52
  53
  54 def suicide_if_bad_celery_environ():
  55     if not os.environ.get('CELERY_CONFIG_MODULE') == \
  56             'mediagoblin.celery_setup.from_tests':
  57         raise BadCeleryEnviron(BAD_CELERY_MESSAGE)
  58
  59
  60 def get_test_app(dump_old_app=True):
  61     suicide_if_bad_celery_environ()
  62
  63     global MGOBLIN_APP
  64     global CELERY_SETUP
  65
  66     # Just return the old app if that exists and it's okay to set up
  67     # and return
  68     if MGOBLIN_APP and not dump_old_app:
  69         return MGOBLIN_APP
  70
  71     # Remove and reinstall user_dev directories
  72     if os.path.exists(TEST_USER_DEV):
  73         shutil.rmtree(TEST_USER_DEV)
  74
  75     for directory in USER_DEV_DIRECTORIES_TO_SETUP:
  76         full_dir = os.path.join(TEST_USER_DEV, directory)
  77         os.makedirs(full_dir)
  78
  79     # Get app config
  80     global_config, validation_result = read_mediagoblin_config(TEST_APP_CONFIG)
  81     app_config = global_config['mediagoblin']
  82
  83     # Wipe database
  84     # @@: For now we're dropping collections, but we could also just
  85     # collection.remove() ?
  86     connection, db = setup_connection_and_db_from_config(app_config)
  87     assert db.name == MEDIAGOBLIN_TEST_DB_NAME
  88
  89     collections_to_wipe = [
  90         collection
  91         for collection in db.collection_names()
  92         if not collection.startswith('system.')]
  93
  94     for collection in collections_to_wipe:
  95         db.drop_collection(collection)
  96
  97     # TODO: Drop and recreate indexes
  98
  99     # setup app and return
 100     test_app = loadapp(
 101         'config:' + TEST_SERVER_CONFIG)
 102
 103     app = TestApp(test_app)
 104     MGOBLIN_APP = app
 105
 106     # setup celery
 107     if not CELERY_SETUP:
 108         setup_celery_from_config(
 109             mg_globals.app_config, mg_globals.global_config,
 110             set_environ=True)
 111         CELERY_SETUP = True
 112
 113     return app
 114
 115
 116 def setup_fresh_app(func):
 117     """
 118     Decorator to setup a fresh test application for this function.
 119
 120     Cleans out test buckets and passes in a new, fresh test_app.
 121     """
 122     def wrapper(*args, **kwargs):
 123         test_app = get_test_app()
 124         util.clear_test_buckets()
 125         return func(test_app, *args, **kwargs)
 126
 127     return _make_safe(wrapper, func)