1 # GNU MediaGoblin -- federated, autonomous media hosting
2 # Copyright (C) 2011, 2012 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/>.
23 from paste
.deploy
import loadapp
24 from webtest
import TestApp
26 from mediagoblin
import mg_globals
27 from mediagoblin
.db
.models
import User
, MediaEntry
, Collection
, MediaComment
, \
28 CommentSubscription
, CommentNotification
29 from mediagoblin
.tools
import testing
30 from mediagoblin
.init
.config
import read_mediagoblin_config
31 from mediagoblin
.db
.base
import Session
32 from mediagoblin
.meddleware
import BaseMeddleware
33 from mediagoblin
.auth
import gen_password_hash
34 from mediagoblin
.gmg_commands
.dbupdate
import run_dbupdate
37 MEDIAGOBLIN_TEST_DB_NAME
= u
'__mediagoblin_tests__'
38 TEST_SERVER_CONFIG
= pkg_resources
.resource_filename(
39 'mediagoblin.tests', 'test_paste.ini')
40 TEST_APP_CONFIG
= pkg_resources
.resource_filename(
41 'mediagoblin.tests', 'test_mgoblin_app.ini')
44 USER_DEV_DIRECTORIES_TO_SETUP
= ['media/public', 'media/queue']
47 class TestingMeddleware(BaseMeddleware
):
49 Meddleware for the Unit tests
51 It might make sense to perform some tests on all
52 requests/responses. Or prepare them in a special
53 manner. For example all html responses could be tested
54 for being valid html *after* being rendered.
56 This module is getting inserted at the front of the
57 meddleware list, which means: requests are handed here
58 first, responses last. So this wraps up the "normal"
61 If you need to add a test, either add it directly to
62 the appropiate process_request or process_response, or
63 create a new method and call it from process_*.
66 def process_response(self
, request
, response
):
67 # All following tests should be for html only!
68 if getattr(response
, 'content_type', None) != "text/html":
72 # If the template contains a reference to
73 # /mgoblin_static/ instead of using
74 # /request.staticdirect(), error out here.
75 # This could probably be implemented as a grep on
76 # the shipped templates easier...
77 if response
.text
.find("/mgoblin_static/") >= 0:
79 "Response HTML contains reference to /mgoblin_static/ "
80 "instead of staticdirect. Request was for: "
86 def get_app(request
, paste_config
=None, mgoblin_config
=None):
87 """Create a MediaGoblin app for testing.
90 - request: Not an http request, but a pytest fixture request. We
91 use this to make temporary directories that pytest
92 automatically cleans up as needed.
93 - paste_config: particular paste config used by this application.
94 - mgoblin_config: particular mediagoblin config used by this
97 paste_config
= paste_config
or TEST_SERVER_CONFIG
98 mgoblin_config
= mgoblin_config
or TEST_APP_CONFIG
100 # This is the directory we're copying the paste/mgoblin config stuff into
101 run_dir
= request
.config
._tmpdirhandler
.mktemp(
102 'mgoblin_app', numbered
=True)
103 user_dev_dir
= run_dir
.mkdir('user_dev').strpath
105 new_paste_config
= run_dir
.join('paste.ini').strpath
106 new_mgoblin_config
= run_dir
.join('mediagoblin.ini').strpath
107 shutil
.copyfile(paste_config
, new_paste_config
)
108 shutil
.copyfile(mgoblin_config
, new_mgoblin_config
)
113 # install user_dev directories
114 for directory
in USER_DEV_DIRECTORIES_TO_SETUP
:
115 full_dir
= os
.path
.join(user_dev_dir
, directory
)
116 os
.makedirs(full_dir
)
119 global_config
, validation_result
= read_mediagoblin_config(new_mgoblin_config
)
120 app_config
= global_config
['mediagoblin']
122 # Run database setup/migrations
123 run_dbupdate(app_config
, global_config
)
125 # setup app and return
127 'config:' + new_paste_config
)
129 # Insert the TestingMeddleware, which can do some
130 # sanity checks on every request/response.
131 # Doing it this way is probably not the cleanest way.
132 # We'll fix it, when we have plugins!
133 mg_globals
.app
.meddleware
.insert(0, TestingMeddleware(mg_globals
.app
))
135 app
= TestApp(test_app
)
140 def install_fixtures_simple(db
, fixtures
):
142 Very simply install fixtures in the database
144 for collection_name
, collection_fixtures
in fixtures
.iteritems():
145 collection
= db
[collection_name
]
146 for fixture
in collection_fixtures
:
147 collection
.insert(fixture
)
150 def assert_db_meets_expected(db
, expected
):
152 Assert a database contains the things we expect it to.
154 Objects are found via 'id', so you should make sure your document
158 - db: pymongo or mongokit database connection
159 - expected: the data we expect. Formatted like:
160 {'collection_name': [
162 'some_field': 'some_value'},]}
164 for collection_name
, collection_data
in expected
.iteritems():
165 collection
= db
[collection_name
]
166 for expected_document
in collection_data
:
167 document
= collection
.query
.filter_by(id=expected_document
['id']).first()
168 assert document
is not None # make sure it exists
169 assert document
== expected_document
# make sure it matches
172 def fixture_add_user(username
=u
'chris', password
=u
'toast',
173 active_user
=True, wants_comment_notification
=True):
174 # Reuse existing user or create a new one
175 test_user
= User
.query
.filter_by(username
=username
).first()
176 if test_user
is None:
178 test_user
.username
= username
179 test_user
.email
= username
+ u
'@example.com'
180 if password
is not None:
181 test_user
.pw_hash
= gen_password_hash(password
)
183 test_user
.email_verified
= True
184 test_user
.status
= u
'active'
186 test_user
.wants_comment_notification
= wants_comment_notification
191 test_user
= User
.query
.filter_by(username
=username
).first()
193 # ... and detach from session:
194 Session
.expunge(test_user
)
199 def fixture_comment_subscription(entry
, notify
=True, send_email
=None):
200 if send_email
is None:
201 uploader
= User
.query
.filter_by(id=entry
.uploader
).first()
202 send_email
= uploader
.wants_comment_notification
204 cs
= CommentSubscription(
205 media_entry_id
=entry
.id,
206 user_id
=entry
.uploader
,
208 send_email
=send_email
)
212 cs
= CommentSubscription
.query
.filter_by(id=cs
.id).first()
219 def fixture_add_comment_notification(entry_id
, subject_id
, user_id
,
221 cn
= CommentNotification(user_id
=user_id
,
223 subject_id
=subject_id
)
226 cn
= CommentNotification
.query
.filter_by(id=cn
.id).first()
233 def fixture_media_entry(title
=u
"Some title", slug
=None,
234 uploader
=None, save
=True, gen_slug
=True,
235 state
=u
'unprocessed', fake_upload
=True,
238 Add a media entry for testing purposes.
240 Caution: if you're adding multiple entries with fake_upload=True,
241 make sure you save between them... otherwise you'll hit an
242 IntegrityError from multiple newly-added-MediaEntries adding
243 FileKeynames at once. :)
246 uploader
= fixture_add_user().id
251 entry
.uploader
= uploader
252 entry
.media_type
= u
'image'
256 entry
.media_files
= {'thumb': ['a', 'b', 'c.jpg'],
257 'medium': ['d', 'e', 'f.png'],
258 'original': ['g', 'h', 'i.png']}
259 entry
.media_type
= u
'mediagoblin.media_types.image'
262 entry
.generate_slug()
268 entry
= MediaEntry
.query
.filter_by(id=entry
.id).first()
270 Session
.expunge(entry
)
275 def fixture_add_collection(name
=u
"My first Collection", user
=None):
277 user
= fixture_add_user()
278 coll
= Collection
.query
.filter_by(creator
=user
.id, title
=name
).first()
282 coll
.creator
= user
.id
288 Session
.refresh(coll
)
290 # ... and detach from session:
291 Session
.expunge(coll
)
295 def fixture_add_comment(author
=None, media_entry
=None, comment
=None):
297 author
= fixture_add_user().id
299 if media_entry
is None:
300 media_entry
= fixture_media_entry().id
304 'Auto-generated test comment by user #{0} on media #{0}'.format(
307 comment
= MediaComment(author
=author
,
308 media_entry
=media_entry
,
313 Session
.expunge(comment
)