forked from CenterForOpenScience/osf.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
conftest.py
334 lines (279 loc) · 11.3 KB
/
conftest.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
from unittest import mock
import logging
import os
import re
from django.core.management import call_command
from django.db import transaction
from elasticsearch_dsl.connections import connections
from faker import Factory
import pytest
import responses
import xml.etree.ElementTree as ET
from api_tests.share import _utils as shtrove_test_utils
from framework.celery_tasks import app as celery_app
from osf.external.spam import tasks as spam_tasks
from website import settings as website_settings
logger = logging.getLogger(__name__)
# Silence some 3rd-party logging and some "loud" internal loggers
SILENT_LOGGERS = [
'api.caching.tasks',
'factory.generate',
'factory.containers',
'framework.analytics',
'framework.auth.core',
'website.app',
'website.archiver.tasks',
'website.mails',
'website.notifications.listeners',
'website.search.elastic_search',
'website.search_migration.migrate',
'website.util.paths',
'requests_oauthlib.oauth2_session',
'transitions.core',
'MARKDOWN',
'elasticsearch',
]
for logger_name in SILENT_LOGGERS:
logging.getLogger(logger_name).setLevel(logging.CRITICAL)
@pytest.fixture(scope='session', autouse=True)
def override_settings():
"""Override settings for the test environment.
"""
# Make tasks run synchronously, and make sure exceptions get propagated
celery_app.conf.update({
'task_always_eager': True,
'task_eager_propagates': True,
})
website_settings.ENABLE_EMAIL_SUBSCRIPTIONS = False
# TODO: Remove if this is unused?
website_settings.BCRYPT_LOG_ROUNDS = 1
# Make sure we don't accidentally send any emails
website_settings.SENDGRID_API_KEY = None
# or try to contact a SHARE
website_settings.SHARE_ENABLED = False
# Set this here instead of in SILENT_LOGGERS, in case developers
# call setLevel in local.py
logging.getLogger('website.mails.mails').setLevel(logging.CRITICAL)
@pytest.fixture()
def fake():
return Factory.create()
_MOCKS = {
'osf.models.user.new_bookmark_collection': {
'mark': 'enable_bookmark_creation',
'replacement': lambda *args, **kwargs: None,
},
'framework.celery_tasks.handlers._enqueue_task': {
'mark': 'enable_enqueue_task',
'replacement': lambda *args, **kwargs: None,
},
'osf.models.base.BaseModel.full_clean': {
'mark': 'enable_implicit_clean',
'replacement': lambda *args, **kwargs: None,
},
'osf.models.base._check_blacklist': {
'mark': 'enable_blacklist_check',
'replacement': lambda *args, **kwargs: False,
},
'website.search.search.search_engine': {
'mark': 'enable_search',
'replacement': mock.MagicMock()
},
'osf.external.messages.celery_publishers._publish_user_status_change': {
'mark': 'enable_account_status_messaging',
'replacement': mock.MagicMock()
}
}
@pytest.fixture(autouse=True, scope='session')
def _test_speedups():
mocks = {}
for target, config in _MOCKS.items():
mocks[target] = mock.patch(target, config['replacement'])
mocks[target].start()
yield mocks
for patcher in mocks.values():
patcher.stop()
@pytest.fixture(autouse=True)
def _test_speedups_disable(request, settings, _test_speedups):
patchers = []
for target, config in _MOCKS.items():
if not request.node.get_closest_marker(config['mark']):
continue
patchers.append(_test_speedups[target])
patchers[-1].stop()
yield
for patcher in patchers:
patcher.start()
@pytest.fixture(scope='session')
def setup_connections():
connections.create_connection(hosts=['http://localhost:9201'])
@pytest.fixture(scope='function')
def es6_client(setup_connections):
return connections.get_connection()
@pytest.fixture(scope='function', autouse=True)
def _es_marker(request):
"""Clear out all indices and index templates before and after
tests marked with ``es``.
"""
marker = request.node.get_closest_marker('es')
if marker:
es6_client = request.getfixturevalue('es6_client')
def teardown_es():
es6_client.indices.delete(index='*')
es6_client.indices.delete_template('*')
teardown_es()
call_command('sync_metrics')
yield
teardown_es()
else:
yield
@pytest.fixture
def mock_share_responses():
with shtrove_test_utils.mock_share_responses() as _shmock_responses:
yield _shmock_responses
@pytest.fixture
def mock_update_share():
with shtrove_test_utils.mock_update_share() as _shmock_update:
yield _shmock_update
@pytest.fixture
def mock_akismet():
"""
This should be used to mock our anti-spam service akismet.
Relevant endpoints:
f'https://{api_key}.rest.akismet.com/1.1/submit-spam'
f'https://{api_key}.rest.akismet.com/1.1/submit-ham'
f'https://{api_key}.rest.akismet.com/1.1/comment-check'
"""
with mock.patch.object(website_settings, 'SPAM_SERVICES_ENABLED', True):
with mock.patch.object(website_settings, 'AKISMET_ENABLED', True):
with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps:
rsps.add(responses.POST, 'https://test.crossref.org/servlet/deposit', status=200)
yield rsps
@pytest.fixture
def mock_datacite(registration):
"""
This should be used to mock our our datacite client.
Relevant endpoints:
f'{DATACITE_URL}/metadata'
f'{DATACITE_URL}/doi'
f'{DATACITE_URL}/metadata/{doi}'
Datacite url should be `https://mds.datacite.org' for production and `https://mds.test.datacite.org` for local
testing
"""
doi = registration.get_doi_client().build_doi(registration)
with open(os.path.join('tests', 'identifiers', 'fixtures', 'datacite_post_metadata_response.xml')) as fp:
base_xml = ET.fromstring(fp.read())
base_xml.find('{http://datacite.org/schema/kernel-4}identifier').text = doi
data = ET.tostring(base_xml)
with mock.patch.object(website_settings, 'DATACITE_ENABLED', True):
with mock.patch.object(website_settings, 'DATACITE_USERNAME', 'TestDataciteUsername'):
with mock.patch.object(website_settings, 'DATACITE_PASSWORD', 'TestDatacitePassword'):
with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps:
rsps.add(responses.GET, f'{website_settings.DATACITE_URL}/metadata', body=data, status=200)
rsps.add(responses.POST, f'{website_settings.DATACITE_URL}/metadata', body=f'OK ({doi})', status=201)
rsps.add(responses.POST, f'{website_settings.DATACITE_URL}/doi', body=f'OK ({doi})', status=201)
rsps.add(responses.DELETE, f'{website_settings.DATACITE_URL}/metadata/{doi}', status=200)
yield rsps
@pytest.fixture
def mock_crossref():
"""
This should be used to mock our our crossref integration.
Relevant endpoints:
"""
with mock.patch.object(website_settings, 'CROSSREF_URL', 'https://test.crossref.org/servlet/deposit'):
with mock.patch.object(website_settings, 'CROSSREF_USERNAME', 'TestCrossrefUsername'):
with mock.patch.object(website_settings, 'CROSSREF_PASSWORD', 'TestCrossrefPassword'):
with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps:
rsps.add(responses.POST, website_settings.CROSSREF_URL, status=200)
yield rsps
@pytest.fixture
def mock_oopspam():
"""
This should be used to mock our anti-spam service oopspam.
Relevent endpoints:
'https://oopspam.p.rapidapi.com/v1/spamdetection'
"""
with mock.patch.object(website_settings, 'SPAM_SERVICES_ENABLED', True):
with mock.patch.object(website_settings, 'OOPSPAM_ENABLED', True):
with mock.patch.object(website_settings, 'OOPSPAM_APIKEY', 'FFFFFF'):
with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps:
yield rsps
@pytest.fixture
def mock_pigeon():
"""
This should be used to mock our Internet Archive archiving microservice osf-pigeon.
Relevent endpoints:
'{settings.OSF_PIGEON_URL}archive/{guid}'
'{settings.OSF_PIGEON_URL}metadata/{guid}'
"""
def request_callback(request):
guid = request.url.split('/')[-1]
from osf.models import Registration
reg = Registration.load(guid)
reg.ia_url = 'https://test.ia.url.com'
reg.save()
return (200, {}, None)
with mock.patch.object(website_settings, 'IA_ARCHIVE_ENABLED', True):
with mock.patch.object(website_settings, 'OSF_PIGEON_URL', 'http://test.pigeon.osf.io/'):
with mock.patch('osf.external.internet_archive.tasks.settings.OSF_PIGEON_URL', 'http://test.pigeon.osf.io/'):
with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps:
rsps.add_callback(
method=responses.POST,
url=re.compile(f'{website_settings.OSF_PIGEON_URL}archive/(.*)'),
callback=request_callback
)
rsps.add(
method=responses.POST,
url=re.compile(f'{website_settings.OSF_PIGEON_URL}metadata/(.*)'),
status=200
)
yield rsps
@pytest.fixture
def mock_celery():
"""
This should only be necessary for postcommit tasks.
"""
with mock.patch.object(website_settings, 'USE_CELERY', True):
with mock.patch('osf.external.internet_archive.tasks.enqueue_postcommit_task') as mock_celery:
yield mock_celery
@pytest.fixture
def mock_spam_head_request():
with mock.patch.object(spam_tasks.requests, 'head') as mock_spam_head_request:
yield mock_spam_head_request
def rolledback_transaction(loglabel):
class ExpectedRollback(Exception):
pass
try:
with transaction.atomic():
logger.debug(f'{loglabel}: started transaction')
yield
raise ExpectedRollback('this is an expected rollback; all is well')
except ExpectedRollback:
logger.debug(f'{loglabel}: rolled back transaction (as planned)')
else:
raise ExpectedRollback('expected a rollback but did not get one; something is wrong')
@pytest.fixture(scope='class')
def _class_scoped_db(django_db_setup, django_db_blocker):
"""a class-scoped version of the `django_db` mark
(so we can use class-scoped fixtures to set up data
for use across several tests)
recommend using via the `with_class_scoped_db` fixture
(so each function gets a nested transaction) instead of
referencing directly.
"""
with django_db_blocker.unblock():
yield from rolledback_transaction('class_transaction')
@pytest.fixture(scope='function')
def with_class_scoped_db(_class_scoped_db):
"""wrap each function and the entire class in transactions
(so fixtures can have scope='class' for reuse across tests,
but what happens in each test stays in that test)
example usage:
```
@pytest.mark.usefixtures('with_class_scoped_db')
class TestMyStuff:
@pytest.fixture(scope='class')
def helpful_thing(self):
return HelpfulThingFactory()
```
"""
yield from rolledback_transaction('function_transaction')