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 = '__mediagoblinunittests__'
  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
  46 class BadCeleryEnviron(Exception): pass
  47
  48
  49 def get_test_app(dump_old_app=True):
  50     if not os.environ.get('CELERY_CONFIG_MODULE') == \
  51             'mediagoblin.celery_setup.from_tests':
  52         raise BadCeleryEnviron(
  53             u"Sorry, you *absolutely* must run nosetests with the\n"
  54             u"mediagoblin.celery_setup.from_tests module.  Like so:\n"
  55             u"$ CELERY_CONFIG_MODULE=mediagoblin.celery_setup.from_tests ./bin/nosetests")
  56
  57     global MGOBLIN_APP
  58     global CELERY_SETUP
  59
  60     # Just return the old app if that exists and it's okay to set up
  61     # and return
  62     if MGOBLIN_APP and not dump_old_app:
  63         return MGOBLIN_APP
  64
  65     # Remove and reinstall user_dev directories
  66     if os.path.exists(TEST_USER_DEV):
  67         shutil.rmtree(TEST_USER_DEV)
  68
  69     for directory in USER_DEV_DIRECTORIES_TO_SETUP:
  70         full_dir = os.path.join(TEST_USER_DEV, directory)
  71         os.makedirs(full_dir)
  72
  73     # Get app config
  74     global_config, validation_result = read_mediagoblin_config(TEST_APP_CONFIG)
  75     app_config = global_config['mediagoblin']
  76
  77     # Wipe database
  78     # @@: For now we're dropping collections, but we could also just
  79     # collection.remove() ?
  80     connection, db = setup_connection_and_db_from_config(app_config)
  81
  82     collections_to_wipe = [
  83         collection
  84         for collection in db.collection_names()
  85         if not collection.startswith('system.')]
  86
  87     for collection in collections_to_wipe:
  88         db.drop_collection(collection)
  89
  90     # Don't need these anymore...
  91     del(connection)
  92     del(db)
  93
  94     # TODO: Drop and recreate indexes
  95
  96     # setup app and return
  97     test_app = loadapp(
  98         'config:' + TEST_SERVER_CONFIG)
  99
 100     app = TestApp(test_app)
 101     MGOBLIN_APP = app
 102
 103     # setup celery
 104     if not CELERY_SETUP:
 105         setup_celery_from_config(
 106             mg_globals.app_config, mg_globals.global_config,
 107             set_environ=True)
 108         CELERY_SETUP = True
 109
 110     return app
 111
 112
 113 def setup_fresh_app(func):
 114     """
 115     Decorator to setup a fresh test application for this function.
 116
 117     Cleans out test buckets and passes in a new, fresh test_app.
 118     """
 119     def wrapper(*args, **kwargs):
 120         test_app = get_test_app()
 121         util.clear_test_buckets()
 122         return func(test_app, *args, **kwargs)
 123
 124     return _make_safe(wrapper, func)