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 appconfig, loadapp
  22 from webtest import TestApp
  23
  24 from mediagoblin import util
  25 from mediagoblin.decorators import _make_safe
  26 from mediagoblin.db.open import setup_connection_and_db_from_config
  27
  28
  29 MEDIAGOBLIN_TEST_DB_NAME = '__mediagoblinunittests__'
  30 TEST_APP_CONFIG = pkg_resources.resource_filename(
  31     'mediagoblin.tests', 'mgoblin_test_app.ini')
  32 TEST_USER_DEV = pkg_resources.resource_filename(
  33     'mediagoblin.tests', 'test_user_dev')
  34 MGOBLIN_APP = None
  35
  36 USER_DEV_DIRECTORIES_TO_SETUP = [
  37     'media/public', 'media/queue',
  38     'beaker/sessions/data', 'beaker/sessions/lock']
  39
  40
  41 class BadCeleryEnviron(Exception): pass
  42
  43
  44 def get_test_app(dump_old_app=True):
  45     if not os.environ.get('CELERY_CONFIG_MODULE') == \
  46             'mediagoblin.celery_setup.from_tests':
  47         raise BadCeleryEnviron(
  48             u"Sorry, you *absolutely* must run nosetests with the\n"
  49             u"mediagoblin.celery_setup.from_tests module.  Like so:\n"
  50             u"$ CELERY_CONFIG_MODULE=mediagoblin.celery_setup.from_tests ./bin/nosetests")
  51
  52     # Just return the old app if that exists and it's okay to set up
  53     # and return
  54     if MGOBLIN_APP and not dump_old_app:
  55         return MGOBLIN_APP
  56
  57     # Remove and reinstall user_dev directories
  58     if os.path.exists(TEST_USER_DEV):
  59         shutil.rmtree(TEST_USER_DEV)
  60
  61     for directory in USER_DEV_DIRECTORIES_TO_SETUP:
  62         full_dir = os.path.join(TEST_USER_DEV, directory)
  63         os.makedirs(full_dir)
  64
  65     # Get app config
  66     config = appconfig(
  67         'config:' + os.path.basename(TEST_APP_CONFIG),
  68         relative_to=os.path.dirname(TEST_APP_CONFIG),
  69         name='mediagoblin')
  70
  71     # Wipe database
  72     # @@: For now we're dropping collections, but we could also just
  73     # collection.remove() ?
  74     connection, db = setup_connection_and_db_from_config(
  75         config.local_conf)
  76
  77     collections_to_wipe = [
  78         collection
  79         for collection in db.collection_names()
  80         if not collection.startswith('system.')]
  81
  82     for collection in collections_to_wipe:
  83         db.drop_collection(collection)
  84
  85     # Don't need these anymore...
  86     del(connection)
  87     del(db)
  88
  89     # TODO: Drop and recreate indexes
  90
  91     # setup app and return
  92     test_app = loadapp(
  93         'config:' + TEST_APP_CONFIG)
  94
  95     return TestApp(test_app)
  96
  97
  98 def setup_fresh_app(func):
  99     """
 100     Decorator to setup a fresh test application for this function.
 101
 102     Cleans out test buckets and passes in a new, fresh test_app.
 103     """
 104     def wrapper(*args, **kwargs):
 105         test_app = get_test_app()
 106         util.clear_test_buckets()
 107         return func(test_app, *args, **kwargs)
 108
 109     return _make_safe(wrapper, func)