-
Notifications
You must be signed in to change notification settings - Fork 12
/
test_kingfisher_process_api.py
393 lines (315 loc) · 14.8 KB
/
test_kingfisher_process_api.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
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
import json
import os
from unittest.mock import PropertyMock, patch
import pytest
import pytest_twisted
from scrapy.exceptions import NotConfigured
from scrapy.http import Request, Response
from twisted.python.failure import Failure
from kingfisher_scrapy.extensions import FilesStore, KingfisherProcessAPI
from kingfisher_scrapy.items import FileError, FileItem
from tests import spider_with_crawler, spider_with_files_store
class ExpectedError(Exception):
pass
def test_from_crawler():
spider = spider_with_crawler(settings={
'KINGFISHER_API_URI': 'http://httpbin.org/anything',
'KINGFISHER_API_KEY': 'xxx',
'KINGFISHER_API_LOCAL_DIRECTORY': 'localdir',
})
extension = KingfisherProcessAPI.from_crawler(spider.crawler)
assert extension.directory == 'localdir'
@pytest.mark.parametrize('api_url,api_key', [
(None, None),
('http://httpbin.org/anything', None),
(None, 'xxx'),
])
def test_from_crawler_missing_arguments(api_url, api_key):
spider = spider_with_crawler(settings={
'KINGFISHER_API_URI': api_url,
'KINGFISHER_API_KEY': api_key,
})
with pytest.raises(NotConfigured) as excinfo:
KingfisherProcessAPI.from_crawler(spider.crawler)
assert str(excinfo.value) == 'KINGFISHER_API_URI and/or KINGFISHER_API_KEY is not set.'
@pytest_twisted.inlineCallbacks
@pytest.mark.parametrize('sample,is_sample,path', [
(None, False, os.path.join('test', '20010203_040506', 'file.json')),
('true', True, os.path.join('test_sample', '20010203_040506', 'file.json')),
])
@pytest.mark.parametrize('note', ['', 'Started by NAME.'])
@pytest.mark.parametrize('encoding,encoding2', [(None, 'utf-8'), ('iso-8859-1', 'iso-8859-1')])
@pytest.mark.parametrize('ok', [True, False])
@pytest.mark.parametrize('directory', [True, False])
@pytest.mark.parametrize('crawl_time', [None, '2020-01-01T00:00:00'])
def test_item_scraped_file(sample, is_sample, path, note, encoding, encoding2, directory, ok, crawl_time,
tmpdir, caplog):
with patch('treq.response._Response.code', new_callable=PropertyMock) as mocked:
mocked.return_value = 200 if ok else 400
settings = {}
if directory:
settings['KINGFISHER_API_LOCAL_DIRECTORY'] = str(tmpdir.join('xxx'))
spider = spider_with_files_store(tmpdir, settings=settings, sample=sample, note=note, crawl_time=crawl_time)
extension = KingfisherProcessAPI.from_crawler(spider.crawler)
kwargs = {}
if encoding:
kwargs['encoding'] = encoding
item = spider.build_file(
file_name='file.json',
url='https://example.com/remote.json',
data=b'{"key": "value"}',
data_type='release_package',
**kwargs,
)
store_extension = FilesStore.from_crawler(spider.crawler)
store_extension.item_scraped(item, spider)
response = yield extension.item_scraped(item, spider)
data = yield response.json()
form = {
'collection_source': 'test',
'collection_data_version': '2001-02-03 04:05:06',
'collection_sample': str(is_sample),
'collection_ocds_version': '1.1',
'file_name': 'file.json',
'url': 'https://example.com/remote.json',
# Specific to File.
'data_type': 'release_package',
'encoding': encoding2,
}
if note:
form['collection_note'] = note
if crawl_time:
form['collection_data_version'] = '2020-01-01 00:00:00'
path = path.replace('20010203_040506', '20200101_000000')
if directory:
form['local_file_name'] = tmpdir.join('xxx', path)
with open(tmpdir.join(path)) as f:
assert data['method'] == 'POST'
assert data['url'] == 'http://httpbin.org/anything/api/v1/submit/file/'
assert data['headers']['Authorization'] == 'ApiKey xxx'
assert data['form'] == form
assert data['args'] == {}
assert data['data'] == ''
if directory:
assert data['files'] == {}
else:
assert data['files'] == {'file': f.read()}
if not ok:
message = 'create_file failed (https://example.com/remote.json) with status code: 400'
assert len(caplog.records) == 1
assert caplog.records[0].name == 'test'
assert caplog.records[0].levelname == 'WARNING'
assert caplog.records[0].message == message
@pytest_twisted.inlineCallbacks
@pytest.mark.parametrize('sample,is_sample', [(None, False), ('true', True)])
@pytest.mark.parametrize('note', ['', 'Started by NAME.'])
@pytest.mark.parametrize('encoding', ['utf-8', 'iso-8859-1'])
@pytest.mark.parametrize('ok', [True, False])
def test_item_scraped_file_item(sample, is_sample, note, encoding, ok, tmpdir, caplog):
with patch('treq.response._Response.code', new_callable=PropertyMock) as mocked:
mocked.return_value = 200 if ok else 400
spider = spider_with_files_store(tmpdir, sample=sample, note=note)
extension = KingfisherProcessAPI.from_crawler(spider.crawler)
item = FileItem({
'number': 1,
'file_name': 'data.json',
'data': b'{"key": "value"}',
'data_type': 'release_package',
'url': 'https://example.com/remote.json',
'encoding': encoding,
})
response = yield extension.item_scraped(item, spider)
data = yield response.json()
form = {
'collection_source': 'test',
'collection_data_version': '2001-02-03 04:05:06',
'collection_sample': str(is_sample),
'collection_ocds_version': '1.1',
'file_name': 'data.json',
'url': 'https://example.com/remote.json',
# Specific to FileItem.
'data_type': 'release_package',
'encoding': encoding,
'number': '1',
'data': '{"key": "value"}',
}
if note:
form['collection_note'] = note
assert data['method'] == 'POST'
assert data['url'] == 'http://httpbin.org/anything/api/v1/submit/item/'
assert data['headers']['Authorization'] == 'ApiKey xxx'
assert data['form'] == form
assert data['args'] == {}
assert data['data'] == ''
assert data['files'] == {}
if not ok:
message = 'create_file_item failed (https://example.com/remote.json) with status code: 400'
assert len(caplog.records) == 1
assert caplog.records[0].name == 'test'
assert caplog.records[0].levelname == 'WARNING'
assert caplog.records[0].message == message
@pytest_twisted.inlineCallbacks
@pytest.mark.parametrize('sample,is_sample', [(None, False), ('true', True)])
@pytest.mark.parametrize('ok', [True, False])
def test_item_scraped_file_error(sample, is_sample, ok, tmpdir, caplog):
with patch('treq.response._Response.code', new_callable=PropertyMock) as mocked:
mocked.return_value = 200 if ok else 400
spider = spider_with_files_store(tmpdir, sample=sample)
extension = KingfisherProcessAPI.from_crawler(spider.crawler)
item = FileError({
'file_name': 'file.json',
'url': 'https://example.com/remote.json',
'errors': {'http_code': 500},
})
response = yield extension.item_scraped(item, spider)
data = yield response.json()
form = {
'collection_source': 'test',
'collection_data_version': '2001-02-03 04:05:06',
'collection_sample': str(is_sample),
'collection_ocds_version': '1.1',
'file_name': 'file.json',
'url': 'https://example.com/remote.json',
# Specific to FileError.
'errors': '{"http_code": 500}',
}
assert data['method'] == 'POST'
assert data['url'] == 'http://httpbin.org/anything/api/v1/submit/file_errors/'
assert data['headers']['Authorization'] == 'ApiKey xxx'
assert data['form'] == form
assert data['args'] == {}
assert data['data'] == ''
assert data['files'] == {}
if not ok:
message = 'create_file_error failed (https://example.com/remote.json) with status code: 400'
assert len(caplog.records) == 1
assert caplog.records[0].name == 'test'
assert caplog.records[0].levelname == 'WARNING'
assert caplog.records[0].message == message
@pytest_twisted.inlineCallbacks
@pytest.mark.parametrize('sample,is_sample', [(None, False), ('true', True)])
@pytest.mark.parametrize('ok', [True, False])
def test_item_error(sample, is_sample, ok, tmpdir, caplog):
try:
{}['nonexistent']
except KeyError:
failure = Failure()
with patch('treq.response._Response.code', new_callable=PropertyMock) as mocked:
mocked.return_value = 200 if ok else 400
spider = spider_with_files_store(tmpdir, sample=sample)
extension = KingfisherProcessAPI.from_crawler(spider.crawler)
item = FileError({
'file_name': 'file.json',
'url': 'https://example.com/remote.json',
})
scrapy_request = yield Request('https://example.com/remote.json')
scrapy_response = Response('https://example.com/remote.json', request=scrapy_request)
response = yield extension.item_error(item, scrapy_response, spider, failure)
data = yield response.json()
errors = json.loads(data['form'].pop('errors'))
form = {
'collection_source': 'test',
'collection_data_version': '2001-02-03 04:05:06',
'collection_sample': str(is_sample),
'collection_ocds_version': '1.1',
'file_name': 'file.json',
'url': 'https://example.com/remote.json',
}
assert data['method'] == 'POST'
assert data['url'] == 'http://httpbin.org/anything/api/v1/submit/file_errors/'
assert data['headers']['Authorization'] == 'ApiKey xxx'
assert data['form'] == form
assert data['args'] == {}
assert data['data'] == ''
assert data['files'] == {}
assert len(errors) == 1
assert errors['twisted'].startswith("[Failure instance: Traceback: <class 'KeyError'>: 'nonexistent'\n")
if not ok:
message = 'create_file_error failed (file.json) with status code: 400'
assert len(caplog.records) == 1
assert caplog.records[0].name == 'test'
assert caplog.records[0].levelname == 'WARNING'
assert caplog.records[0].message == message
@pytest_twisted.inlineCallbacks
@pytest.mark.parametrize('sample,is_sample', [(None, False), ('true', True)])
@pytest.mark.parametrize('ok', [True, False])
def test_spider_closed(sample, is_sample, ok, tmpdir, caplog):
with patch('treq.response._Response.code', new_callable=PropertyMock) as mocked:
mocked.return_value = 200 if ok else 400
spider = spider_with_files_store(tmpdir, sample=sample)
extension = KingfisherProcessAPI.from_crawler(spider.crawler)
response = yield extension.spider_closed(spider, 'sample' if is_sample else 'finished')
data = yield response.json()
form = {
'collection_source': 'test',
'collection_data_version': '2001-02-03 04:05:06',
'collection_sample': str(is_sample),
'collection_ocds_version': '1.1',
}
assert data['method'] == 'POST'
assert data['url'] == 'http://httpbin.org/anything/api/v1/submit/end_collection_store/'
assert data['headers']['Authorization'] == 'ApiKey xxx'
assert data['form'] == form
assert data['args'] == {}
assert data['data'] == ''
assert data['files'] == {}
if not ok:
message = 'end_collection_store failed (test) with status code: 400'
assert len(caplog.records) == 1
assert caplog.records[0].name == 'test'
assert caplog.records[0].levelname == 'WARNING'
assert caplog.records[0].message == message
@pytest_twisted.inlineCallbacks
def test_spider_closed_exception(tmpdir, caplog):
with patch('treq.response._Response.code', new_callable=PropertyMock) as mocked:
mocked.side_effect = ExpectedError
spider = spider_with_files_store(tmpdir)
extension = KingfisherProcessAPI.from_crawler(spider.crawler)
with pytest.raises(ExpectedError):
yield extension.spider_closed(spider, 'finished')
@pytest_twisted.inlineCallbacks
def test_spider_closed_other_reason(tmpdir):
spider = spider_with_files_store(tmpdir)
extension = KingfisherProcessAPI.from_crawler(spider.crawler)
response = yield extension.spider_closed(spider, 'xxx')
assert response is None
@pytest_twisted.inlineCallbacks
@pytest.mark.parametrize('sample,is_sample', [(None, False), ('true', True)])
@pytest.mark.parametrize('ok', [True, False])
def test_spider_error(sample, is_sample, ok, tmpdir, caplog):
try:
{}['nonexistent']
except KeyError:
failure = Failure()
with patch('treq.response._Response.code', new_callable=PropertyMock) as mocked:
mocked.return_value = 200 if ok else 400
spider = spider_with_files_store(tmpdir, sample=sample)
extension = KingfisherProcessAPI.from_crawler(spider.crawler)
scrapy_request = yield Request('https://example.com/remote.json')
scrapy_response = Response('https://example.com/remote.json', request=scrapy_request)
response = yield extension.spider_error(failure, scrapy_response, spider)
data = yield response.json()
errors = json.loads(data['form'].pop('errors'))
form = {
'collection_source': 'test',
'collection_data_version': '2001-02-03 04:05:06',
'collection_sample': str(is_sample),
'collection_ocds_version': '1.1',
'file_name': 'https://example.com/remote.json',
'url': 'https://example.com/remote.json',
}
assert data['method'] == 'POST'
assert data['url'] == 'http://httpbin.org/anything/api/v1/submit/file_errors/'
assert data['headers']['Authorization'] == 'ApiKey xxx'
assert data['form'] == form
assert data['args'] == {}
assert data['data'] == ''
assert data['files'] == {}
assert len(errors) == 1
assert errors['twisted'].startswith("[Failure instance: Traceback: <class 'KeyError'>: 'nonexistent'\n")
if not ok:
message = 'create_file_error failed (https://example.com/remote.json) with status code: 400'
assert len(caplog.records) == 1
assert caplog.records[0].name == 'test'
assert caplog.records[0].levelname == 'WARNING'
assert caplog.records[0].message == message