1 # GNU MediaGoblin -- federated, autonomous media hosting
2 # Copyright (C) 2011 MediaGoblin contributors. See AUTHORS.
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.
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.
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/>.
21 from paste
.deploy
import loadapp
22 from webtest
import TestApp
24 from mediagoblin
import mg_globals
25 from mediagoblin
.tools
import testing
26 from mediagoblin
.init
.config
import read_mediagoblin_config
27 from mediagoblin
.decorators
import _make_safe
28 from mediagoblin
.db
.open import setup_connection_and_db_from_config
29 from mediagoblin
.meddleware
import BaseMeddleware
32 MEDIAGOBLIN_TEST_DB_NAME
= u
'__mediagoblin_tests__'
33 TEST_SERVER_CONFIG
= pkg_resources
.resource_filename(
34 'mediagoblin.tests', 'test_paste.ini')
35 TEST_APP_CONFIG
= pkg_resources
.resource_filename(
36 'mediagoblin.tests', 'test_mgoblin_app.ini')
37 TEST_USER_DEV
= pkg_resources
.resource_filename(
38 'mediagoblin.tests', 'test_user_dev')
41 USER_DEV_DIRECTORIES_TO_SETUP
= [
42 'media/public', 'media/queue',
43 'beaker/sessions/data', 'beaker/sessions/lock']
45 BAD_CELERY_MESSAGE
= """\
46 Sorry, you *absolutely* must run nosetests with the
47 mediagoblin.init.celery.from_tests module. Like so:
48 $ CELERY_CONFIG_MODULE=mediagoblin.init.celery.from_tests ./bin/nosetests"""
51 class BadCeleryEnviron(Exception): pass
54 class TestingMeddleware(BaseMeddleware
):
56 Meddleware for the Unit tests
58 It might make sense to perform some tests on all
59 requests/responses. Or prepare them in a special
60 manner. For example all html responses could be tested
61 for being valid html *after* being rendered.
63 This module is getting inserted at the front of the
64 meddleware list, which means: requests are handed here
65 first, responses last. So this wraps up the "normal"
68 If you need to add a test, either add it directly to
69 the appropiate process_request or process_response, or
70 create a new method and call it from process_*.
73 def process_response(self
, request
, response
):
74 # All following tests should be for html only!
75 if response
.content_type
!= "text/html":
79 # If the template contains a reference to
80 # /mgoblin_static/ instead of using
81 # /request.staticdirect(), error out here.
82 # This could probably be implemented as a grep on
83 # the shipped templates easier...
84 if response
.text
.find("/mgoblin_static/") >= 0:
86 "Response HTML contains reference to /mgoblin_static/ "
87 "instead of staticdirect. Request was for: "
93 def suicide_if_bad_celery_environ():
94 if not os
.environ
.get('CELERY_CONFIG_MODULE') == \
95 'mediagoblin.init.celery.from_tests':
96 raise BadCeleryEnviron(BAD_CELERY_MESSAGE
)
99 def get_test_app(dump_old_app
=True):
100 suicide_if_bad_celery_environ()
102 # Make sure we've turned on testing
103 testing
._activate
_testing
()
105 # Leave this imported as it sets up celery.
106 from mediagoblin
.init
.celery
import from_tests
110 # Just return the old app if that exists and it's okay to set up
112 if MGOBLIN_APP
and not dump_old_app
:
115 # Remove and reinstall user_dev directories
116 if os
.path
.exists(TEST_USER_DEV
):
117 shutil
.rmtree(TEST_USER_DEV
)
119 for directory
in USER_DEV_DIRECTORIES_TO_SETUP
:
120 full_dir
= os
.path
.join(TEST_USER_DEV
, directory
)
121 os
.makedirs(full_dir
)
124 global_config
, validation_result
= read_mediagoblin_config(TEST_APP_CONFIG
)
125 app_config
= global_config
['mediagoblin']
128 # @@: For now we're dropping collections, but we could also just
129 # collection.remove() ?
130 connection
, db
= setup_connection_and_db_from_config(app_config
)
131 assert db
.name
== MEDIAGOBLIN_TEST_DB_NAME
133 collections_to_wipe
= [
135 for collection
in db
.collection_names()
136 if not collection
.startswith('system.')]
138 for collection
in collections_to_wipe
:
139 db
.drop_collection(collection
)
141 # TODO: Drop and recreate indexes
143 # setup app and return
145 'config:' + TEST_SERVER_CONFIG
)
147 # Insert the TestingMeddleware, which can do some
148 # sanity checks on every request/response.
149 # Doing it this way is probably not the cleanest way.
150 # We'll fix it, when we have plugins!
151 mg_globals
.app
.meddleware
.insert(0, TestingMeddleware(mg_globals
.app
))
153 app
= TestApp(test_app
)
159 def setup_fresh_app(func
):
161 Decorator to setup a fresh test application for this function.
163 Cleans out test buckets and passes in a new, fresh test_app.
165 def wrapper(*args
, **kwargs
):
166 test_app
= get_test_app()
167 testing
.clear_test_buckets()
168 return func(test_app
, *args
, **kwargs
)
170 return _make_safe(wrapper
, func
)
173 def install_fixtures_simple(db
, fixtures
):
175 Very simply install fixtures in the database
177 for collection_name
, collection_fixtures
in fixtures
.iteritems():
178 collection
= db
[collection_name
]
179 for fixture
in collection_fixtures
:
180 collection
.insert(fixture
)
183 def assert_db_meets_expected(db
, expected
):
185 Assert a database contains the things we expect it to.
187 Objects are found via '_id', so you should make sure your document
191 - db: pymongo or mongokit database connection
192 - expected: the data we expect. Formatted like:
193 {'collection_name': [
195 'some_field': 'some_value'},]}
197 for collection_name
, collection_data
in expected
.iteritems():
198 collection
= db
[collection_name
]
199 for expected_document
in collection_data
:
200 document
= collection
.find_one({'_id': expected_document
['_id']})
201 assert document
is not None # make sure it exists
202 assert document
== expected_document
# make sure it matches