-
-
Notifications
You must be signed in to change notification settings - Fork 12
/
test_client.py
833 lines (709 loc) · 35.8 KB
/
test_client.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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
from datetime import date, datetime, timezone, timedelta
from itertools import islice
from pathlib import Path
import time
import pytest
import requests
from unittest import mock
from .support import create_vcr
from .._utils import SessionClosedError
from .._client import (CdxRecord,
Mode,
WaybackSession,
WaybackClient)
from ..exceptions import (BlockedSiteError,
MementoPlaybackError,
NoMementoError,
RateLimitError)
ia_vcr = create_vcr()
# It's tough to capture a rate-limited response. Using VCR to do so would
# require an overly-complex test and a very verbose recording (with lots of
# excess requests & responses in order to breach the limit). So this is simply
# a manual mock based on an actual rate-limited response.
WAYBACK_RATE_LIMIT_ERROR = dict(
status_code=429,
headers={
'Server': 'nginx/1.15.8',
'Date': 'Fri, 19 Jun 2020 23:44:42 GMT',
'Content-Type': 'text/html',
'Transfer-Encoding': 'chunked',
'Connection': 'keep-alive',
'Cache-Control': 'no-cache',
# NOTE: Wayback does not currently include this header. It's optional,
# and is included here to test whether we will handle it nicely if the
# Wayback Machine ever adds it.
# https://tools.ietf.org/html/rfc6585#section-4
'Retry-After': '10'
},
text='''<html><body><h1>429 Too Many Requests</h1>
You have sent too many requests in a given amount of time.
</body></html>'''
)
def get_file(filepath):
"""Return the content of a file in the test_files directory."""
full_path = Path(__file__).parent / 'test_files' / filepath
with open(full_path, 'rb') as file:
return file.read()
@ia_vcr.use_cassette()
def test_search():
with WaybackClient() as client:
versions = client.search('nasa.gov',
from_date=datetime(1996, 10, 1),
to_date=datetime(1997, 2, 1))
for v in versions:
assert v.timestamp >= datetime(1996, 10, 1, tzinfo=timezone.utc)
assert v.timestamp <= datetime(1997, 2, 1, tzinfo=timezone.utc)
@ia_vcr.use_cassette()
def test_search_with_date():
with WaybackClient() as client:
versions = client.search('dw.com',
from_date=date(2019, 10, 1),
to_date=date(2020, 3, 1))
for v in versions:
assert v.timestamp >= datetime(2019, 10, 1, tzinfo=timezone.utc)
assert v.timestamp <= datetime(2020, 3, 1, tzinfo=timezone.utc)
@ia_vcr.use_cassette()
def test_search_with_timezone():
with WaybackClient() as client:
# Search using UTC, equivalent to the test above where we provide a
# datetime with no timezone.
tzinfo = timezone(timedelta(hours=0))
t0 = datetime(1996, 12, 31, 23, 58, 47, tzinfo=tzinfo)
versions = client.search('nasa.gov',
from_date=t0)
version = next(versions)
assert version.timestamp == datetime(1996, 12, 31, 23, 58, 47,
tzinfo=timezone.utc)
# Search using UTC - 5, equivalent to (1997, 1, 1, 4, ...) in UTC
# so that we miss the result above and expect a different, later one.
tzinfo = timezone(timedelta(hours=-5))
t0 = datetime(1996, 12, 31, 23, 58, 47, tzinfo=tzinfo)
versions = client.search('nasa.gov',
from_date=t0)
version = next(versions)
assert version.timestamp == datetime(1997, 6, 5, 23, 5, 59,
tzinfo=timezone.utc)
@ia_vcr.use_cassette()
def test_search_multipage():
# Set page size limits low enough to guarantee multiple pages
with WaybackClient() as client:
versions = client.search('cnn.com',
from_date=datetime(2001, 4, 10),
to_date=datetime(2001, 5, 10),
limit=25)
# Exhaust the generator and make sure no entries trigger errors.
list(versions)
@ia_vcr.use_cassette()
def test_search_cannot_iterate_after_session_closing():
with pytest.raises(SessionClosedError):
with WaybackClient() as client:
versions = client.search('nasa.gov',
from_date=datetime(1996, 10, 1),
to_date=datetime(1997, 2, 1))
next(versions)
@ia_vcr.use_cassette()
def test_search_does_not_repeat_results():
with WaybackClient() as client:
versions = client.search('energystar.gov/',
from_date=datetime(2020, 6, 12),
to_date=datetime(2020, 6, 13))
previous = None
for version in versions:
assert version != previous
previous = version
@ia_vcr.use_cassette()
def test_search_raises_for_blocked_urls():
with pytest.raises(BlockedSiteError):
with WaybackClient() as client:
versions = client.search('https://nationalpost.com/health',
from_date=datetime(2019, 10, 1),
to_date=datetime(2019, 10, 2))
next(versions)
@ia_vcr.use_cassette()
def test_search_with_filter():
with WaybackClient() as client:
# Check an unfiltered request to cover false positives.
versions = client.search('nasa.gov/',
match_type='prefix',
limit=10,
from_date=date(2022, 1, 1),
to_date=date(2022, 2, 1))
versions = list(islice(versions, 10))
assert any((v.status_code == 200 for v in versions))
# Then an actually filtered request.
versions = client.search('nasa.gov/',
match_type='prefix',
limit=10,
from_date=date(2022, 1, 1),
to_date=date(2022, 2, 1),
filter_field='statuscode:404')
versions = list(islice(versions, 10))
assert all((v.status_code == 404 for v in versions))
@ia_vcr.use_cassette()
def test_search_with_filter_list():
with WaybackClient() as client:
# Check an unfiltered request to cover false positives.
versions = client.search('nasa.gov/',
match_type='prefix',
limit=10,
from_date=date(2022, 1, 1),
to_date=date(2022, 2, 1))
versions = list(islice(versions, 10))
assert any((v.status_code == 200 for v in versions))
assert any(('feature' not in v.url for v in versions))
# Then an actually filtered request.
versions = client.search('nasa.gov/',
match_type='prefix',
limit=10,
from_date=date(2022, 1, 1),
to_date=date(2022, 2, 1),
filter_field=['statuscode:404',
'urlkey:.*feature.*'])
versions = list(islice(versions, 10))
assert all((v.status_code == 404 for v in versions))
assert all(('feature' in v.url for v in versions))
@ia_vcr.use_cassette()
def test_search_with_filter_tuple():
with WaybackClient() as client:
# Then an actually filtered request.
versions = client.search('nasa.gov/',
match_type='prefix',
limit=10,
from_date=date(2022, 1, 1),
to_date=date(2022, 2, 1),
filter_field=('statuscode:404',
'urlkey:.*feature.*'))
versions = list(islice(versions, 10))
assert all((v.status_code == 404 for v in versions))
assert all(('feature' in v.url for v in versions))
def test_search_removes_malformed_entries(requests_mock):
"""
The CDX index contains many lines for things that can't actually be
archived and will have no corresponding memento, like `mailto:` and `data:`
URLs. We should be stripping these out.
Because these are rare and hard to get all in a single CDX query that isn't
*huge*, we use a made-up mock for this one instead of a VCR recording. All
the lines in the mock file are lines from real CDX queries (we lost track
of the specific cases that triggered that one, and it was *very* rare).
"""
with open(Path(__file__).parent / 'test_files' / 'malformed_cdx.txt') as f:
bad_cdx_data = f.read()
with WaybackClient() as client:
requests_mock.get('https://web.archive.org/cdx/search/cdx'
'?url=https%3A%2F%2Fepa.gov%2F%2A'
'&from=20200418000000&to=20200419000000'
'&showResumeKey=true&resolveRevisits=true',
[{'status_code': 200, 'text': bad_cdx_data}])
records = client.search('https://epa.gov/*',
from_date=datetime(2020, 4, 18),
to_date=datetime(2020, 4, 19))
assert 2 == len(list(records))
def test_search_handles_no_length_cdx_records(requests_mock):
"""
The CDX index can contain a "-" in lieu of an actual length, which can't be
parsed into an int. We should handle this.
Because these are rare and hard to get all in a single CDX query that isn't
*huge*, we use a made-up mock for this one instead of a VCR recording.
"""
with open(Path(__file__).parent / 'test_files' / 'zero_length_cdx.txt') as f:
bad_cdx_data = f.read()
with WaybackClient() as client:
requests_mock.get('https://web.archive.org/cdx/search/cdx'
'?url=www.cnn.com%2F%2A'
'&matchType=domain&filter=statuscode%3A200'
'&showResumeKey=true&resolveRevisits=true',
[{'status_code': 200, 'text': bad_cdx_data}])
records = client.search('www.cnn.com/*',
match_type="domain",
filter_field="statuscode:200")
record_list = list(records)
assert 5 == len(record_list)
for record in record_list[:4]:
assert isinstance(record.length, int)
assert record_list[-1].length is None
def test_search_handles_bad_timestamp_cdx_records(requests_mock):
"""
The CDX index can contain a timestamp with an invalid day "00", which can't be
parsed into an timestamp. We should handle this.
Because these are rare and hard to get all in a single CDX query that isn't
*huge*, we use a made-up mock for this one instead of a VCR recording.
"""
with open(Path(__file__).parent / 'test_files' / 'bad_timestamp_cdx.txt') as f:
bad_cdx_data = f.read()
with WaybackClient() as client:
requests_mock.get('https://web.archive.org/cdx/search/cdx'
'?url=www.usatoday.com%2F%2A'
'&matchType=domain&filter=statuscode%3A200'
'&showResumeKey=true&resolveRevisits=true',
[{'status_code': 200, 'text': bad_cdx_data}])
records = client.search('www.usatoday.com/*',
match_type="domain",
filter_field="statuscode:200")
record_list = list(records)
assert 5 == len(record_list)
# 00 month in 20000012170449 gets rewritten to 20001217044900
assert record_list[3].timestamp.month == 12
# 00 day in 20000800241623 gets rewritten to 20000824162300
assert record_list[4].timestamp.day == 24
@ia_vcr.use_cassette()
def test_get_memento():
with WaybackClient() as client:
memento = client.get_memento('https://www.fws.gov/birds/',
timestamp=datetime(2017, 11, 24, 15, 13, 15))
assert 'https://www.fws.gov/birds/' == memento.url
assert datetime(2017, 11, 24, 15, 13, 15, tzinfo=timezone.utc) == memento.timestamp
assert 'id_' == memento.mode
assert memento.headers == {
'Content-Type': 'text/html',
'Date': 'Fri, 24 Nov 2017 15:13:14 GMT',
'Strict-Transport-Security': 'max-age=31536000; includeSubDomains; preload',
'Transfer-Encoding': 'chunked'
}
assert memento.links == {
'first memento': {
'datetime': 'Wed, 23 Mar 2005 15:53:00 GMT',
'rel': 'first memento',
'url': 'https://web.archive.org/web/20050323155300id_/http://www.fws.gov:80/birds'
},
'last memento': {
'datetime': 'Sun, 19 Mar 2023 07:02:36 GMT',
'rel': 'last memento',
'url': 'https://web.archive.org/web/20230319070236id_/http://fws.gov/birds/'
},
'prev memento': {
'datetime': 'Fri, 29 Sep 2017 00:27:12 GMT',
'rel': 'prev memento',
'url': 'https://web.archive.org/web/20170929002712id_/https://www.fws.gov/birds/'
},
'next memento': {
'datetime': 'Thu, 28 Dec 2017 22:21:43 GMT',
'rel': 'next memento',
'url': 'https://web.archive.org/web/20171228222143id_/https://www.fws.gov/birds/'
},
'memento': {
'datetime': 'Fri, 24 Nov 2017 15:13:15 GMT',
'rel': 'memento',
'url': 'https://web.archive.org/web/20171124151315id_/https://www.fws.gov/birds/'
},
'original': {
'rel': 'original',
'url': 'https://www.fws.gov/birds/'
},
'timegate': {
'rel': 'timegate',
'url': 'https://web.archive.org/web/https://www.fws.gov/birds/'
},
'timemap': {
'rel': 'timemap',
'type': 'application/link-format',
'url': 'https://web.archive.org/web/timemap/link/https://www.fws.gov/birds/'
},
}
@ia_vcr.use_cassette()
def test_get_memento_with_date_datetime():
with WaybackClient() as client:
memento = client.get_memento('https://www.fws.gov/birds/',
timestamp=date(2017, 11, 24),
exact=False)
assert 'https://www.fws.gov/birds/' == memento.url
assert datetime(2017, 11, 24, 15, 13, 15, tzinfo=timezone.utc) == memento.timestamp
assert 'id_' == memento.mode
@ia_vcr.use_cassette()
def test_get_memento_with_string_datetime():
with WaybackClient() as client:
memento = client.get_memento('https://www.fws.gov/birds/',
timestamp='20171124151315')
assert 'https://www.fws.gov/birds/' == memento.url
assert datetime(2017, 11, 24, 15, 13, 15, tzinfo=timezone.utc) == memento.timestamp
assert 'id_' == memento.mode
@ia_vcr.use_cassette()
def test_get_memento_with_inexact_string_datetime():
with WaybackClient() as client:
memento = client.get_memento('https://www.fws.gov/birds/',
timestamp='20171124151310',
exact=False)
assert 'https://www.fws.gov/birds/' == memento.url
assert datetime(2017, 11, 24, 15, 13, 15, tzinfo=timezone.utc) == memento.timestamp
assert 'id_' == memento.mode
@ia_vcr.use_cassette()
def test_get_memento_handles_non_utc_datetime():
with WaybackClient() as client:
# Note the offset between requested_time and memento.timestamp.
requested_time = datetime(2017, 11, 24, 8, 13, 15,
tzinfo=timezone(timedelta(hours=-7)))
memento = client.get_memento('https://www.fws.gov/birds/',
timestamp=requested_time)
assert 'https://www.fws.gov/birds/' == memento.url
assert datetime(2017, 11, 24, 15, 13, 15, tzinfo=timezone.utc) == memento.timestamp
assert 'id_' == memento.mode
@ia_vcr.use_cassette()
def test_get_memento_with_invalid_datetime_type():
with WaybackClient() as client:
with pytest.raises(TypeError):
client.get_memento('https://www.fws.gov/birds/',
timestamp=True)
@ia_vcr.use_cassette()
def test_get_memento_with_requires_datetime_with_regular_url():
with WaybackClient() as client:
with pytest.raises(TypeError):
client.get_memento('https://www.fws.gov/birds/')
@ia_vcr.use_cassette()
def test_get_memento_with_archive_url():
with WaybackClient() as client:
memento = client.get_memento(
'https://web.archive.org/web/20171124151315id_/https://www.fws.gov/birds/')
# Metadata About the Memento
assert 'https://www.fws.gov/birds/' == memento.url
assert datetime(2017, 11, 24, 15, 13, 15, tzinfo=timezone.utc) == memento.timestamp
assert 'id_' == memento.mode
assert 'https://web.archive.org/web/20171124151315id_/https://www.fws.gov/birds/' == memento.memento_url
assert () == memento.history
assert () == memento.debug_history
# Archived HTTP Response
assert 200 == memento.status_code
assert memento.ok
assert not memento.is_redirect
assert {'Content-Type': 'text/html',
'Date': 'Fri, 24 Nov 2017 15:13:14 GMT',
'Strict-Transport-Security': 'max-age=31536000; includeSubDomains; preload',
'Transfer-Encoding': 'chunked'} == memento.headers
assert 'ISO-8859-1' == memento.encoding
content = get_file('fws-gov-birds.txt')
assert content == memento.content
assert content.decode('iso-8859-1') == memento.text
@ia_vcr.use_cassette()
def test_get_memento_with_cdx_record():
with WaybackClient() as client:
record = CdxRecord('xyz',
datetime(2017, 11, 24, 15, 13, 15, tzinfo=timezone.utc),
'https://www.fws.gov/birds/',
'-',
200,
'abc',
100,
'https://web.archive.org/web/20171124151315id_/https://www.fws.gov/birds/',
'https://web.archive.org/web/20171124151315/https://www.fws.gov/birds/')
memento = client.get_memento(record)
assert 'https://www.fws.gov/birds/' == memento.url
assert datetime(2017, 11, 24, 15, 13, 15, tzinfo=timezone.utc) == memento.timestamp
assert 'id_' == memento.mode
@ia_vcr.use_cassette()
def test_get_memento_with_mode():
with WaybackClient() as client:
memento = client.get_memento('https://www.fws.gov/birds/',
timestamp=datetime(2017, 11, 24, 15, 13, 15),
mode=Mode.view)
assert '' == memento.mode
assert ('https://web.archive.org/web/20171124151315/https://www.fws.gov/birds/'
== memento.memento_url)
assert ('https://web.archive.org/web/20171124151315/https://www.fws.gov/birds/'
== memento.links['memento']['url'])
assert ('https://web.archive.org/web/20050323155300/http://www.fws.gov:80/birds'
== memento.links['first memento']['url'])
memento = client.get_memento('https://www.fws.gov/birds/',
timestamp=datetime(2017, 11, 24, 15, 13, 15))
assert 'id_' == memento.mode
assert ('https://web.archive.org/web/20171124151315id_/https://www.fws.gov/birds/'
== memento.memento_url)
assert ('https://web.archive.org/web/20171124151315id_/https://www.fws.gov/birds/'
== memento.links['memento']['url'])
assert ('https://web.archive.org/web/20050323155300id_/http://www.fws.gov:80/birds'
== memento.links['first memento']['url'])
@ia_vcr.use_cassette()
def test_get_memento_with_mode_string():
with WaybackClient() as client:
memento = client.get_memento('https://www.fws.gov/birds/',
timestamp=datetime(2017, 11, 24, 15, 13, 15),
mode='id_')
assert 'id_' == memento.mode
assert 'https://web.archive.org/web/20171124151315id_/https://www.fws.gov/birds/' == memento.memento_url
@ia_vcr.use_cassette()
def test_get_memento_with_mode_boolean_is_not_allowed():
with WaybackClient() as client:
with pytest.raises(TypeError):
client.get_memento('https://www.fws.gov/birds/',
timestamp=datetime(2017, 11, 24, 15, 13, 15),
mode=True)
@ia_vcr.use_cassette()
def test_get_memento_target_window():
with WaybackClient() as client:
memento = client.get_memento('https://www.fws.gov/birds/',
date(2017, 11, 1),
exact=False,
target_window=25 * 24 * 60 * 60)
assert memento.timestamp == datetime(2017, 11, 24, 15, 13, 15, tzinfo=timezone.utc)
@ia_vcr.use_cassette()
def test_get_memento_raises_when_memento_is_outside_target_window():
with pytest.raises(MementoPlaybackError):
with WaybackClient() as client:
client.get_memento('https://www.fws.gov/birds/',
date(2017, 11, 1),
exact=False,
target_window=24 * 60 * 60)
@ia_vcr.use_cassette()
def test_get_memento_with_redirects():
with WaybackClient() as client:
memento = client.get_memento(
'https://web.archive.org/web/20180808094144id_/https://www.epa.gov/ghgreporting/san5779-factsheet')
assert len(memento.history) == 1 # memento redirects
assert len(memento.debug_history) == 2 # actual HTTP redirects
@ia_vcr.use_cassette()
def test_get_memento_with_path_based_redirects():
"""
Most redirects in Wayback redirect to a complete URL, with headers like:
Location: https://web.archive.org/web/20201027215555id_/https://www.whitehouse.gov/administration
But some include only an absolute path, e.g:
Location: /web/20201027215555id_/https://www.whitehouse.gov/ostp/about/student/faqs
This tests that we correctly handle the latter situation.
"""
with WaybackClient() as client:
memento = client.get_memento('https://www.whitehouse.gov/administration/eop/ostp/about/student/faqs',
datetime(2020, 10, 27, 21, 55, 55))
assert len(memento.history) == 1
assert memento.url == memento.history[0].headers['Location']
@ia_vcr.use_cassette()
def test_get_memento_with_schemeless_redirects():
"""
Most redirects in Wayback redirect to a complete URL, with headers like:
Location: https://web.archive.org/web/20201027215555id_/https://www.whitehouse.gov/administration
But some do not include a scheme:
Location: //web.archive.org/web/20201102232816id_/https://www.census.gov/geo/gssi/
This tests that we correctly handle the latter situation.
"""
with WaybackClient() as client:
memento = client.get_memento('https://www.census.gov/geography/gss-initiative.html',
datetime(2020, 11, 2, 23, 28, 16))
assert len(memento.history) == 1
assert memento.url == memento.history[0].headers['Location']
@ia_vcr.use_cassette()
def test_get_memento_raises_for_mementos_that_redirect_in_a_loop():
with WaybackClient() as client:
with pytest.raises(MementoPlaybackError):
client.get_memento(
'https://link.springer.com/article/10.1007/s00382-012-1331-2',
'20200925075402')
@ia_vcr.use_cassette()
def test_get_memento_with_redirect_in_view_mode():
"""
Redirects in view mode respond with different headers, status codes, and
bodies that other modes. They require special handling and testing.
"""
with WaybackClient() as client:
memento = client.get_memento(
'https://www.whitehouse.gov/administration/eop/ostp/about/student/faqs',
timestamp='20201027215555',
mode=Mode.view)
assert len(memento.history) == 1 # memento redirects
assert len(memento.debug_history) == 2 # actual HTTP redirects
@ia_vcr.use_cassette()
def test_get_memento_should_fail_for_non_playbackable_mementos():
with WaybackClient() as client:
with pytest.raises(MementoPlaybackError):
client.get_memento('https://www.fws.gov/birds/', '20150509080314')
@ia_vcr.use_cassette()
def test_get_memento_raises_blocked_error():
with WaybackClient() as client:
with pytest.raises(BlockedSiteError):
client.get_memento('https://nationalpost.com/health/', '20170929002712')
@ia_vcr.use_cassette()
def test_get_memento_raises_no_memento_error():
with WaybackClient() as client:
with pytest.raises(NoMementoError):
client.get_memento('https://this-is-not-real-url.whatever/',
'20170929002712')
@ia_vcr.use_cassette()
def test_get_memento_follows_historical_redirects():
with WaybackClient() as client:
# In February 2020, https://www.epa.gov/climatechange redirected to:
# https://www.epa.gov/sites/production/files/signpost/cc.html
#
# What should happen here under the hood:
# https://web.archive.org/web/20200201020357id_/http://epa.gov/climatechange
# Is not a memento, and sends us to:
# https://web.archive.org/web/20200201023757id_/https://www.epa.gov/climatechange
# Which is a memento of a redirect to:
# https://web.archive.org/web/20200201023757id_/https://www.epa.gov/sites/production/files/signpost/cc.html
# ...which is not a memento, and redirects to:
# https://web.archive.org/web/20200201024405id_/https://www.epa.gov/sites/production/files/signpost/cc.html
start_url = ('https://web.archive.org/web/20200201020357id_/'
'http://epa.gov/climatechange')
target = ('https://web.archive.org/web/20200201024405id_/'
'https://www.epa.gov/sites/production/files/signpost/cc.html')
memento = client.get_memento(start_url, exact=False)
assert 'https://www.epa.gov/sites/production/files/signpost/cc.html' == memento.url
assert target == memento.memento_url
assert len(memento.history) == 1
assert len(memento.debug_history) == 3
@ia_vcr.use_cassette()
def test_get_memento_follow_redirects_does_not_follow_historical_redirects():
with WaybackClient() as client:
# In February 2020, https://www.epa.gov/climatechange redirected to:
# https://www.epa.gov/sites/production/files/signpost/cc.html
#
# What should happen here under the hood:
# https://web.archive.org/web/20200201020357id_/http://epa.gov/climatechange
# Is not a memento, and sends us to:
# https://web.archive.org/web/20200201023757id_/https://www.epa.gov/climatechange
# Which is a memento of a redirect. Because follow_redirects=False,
# we should *not* follow it to:
# https://web.archive.org/web/20200201023757id_/https://www.epa.gov/sites/production/files/signpost/cc.html
# ...and then to:
# https://web.archive.org/web/20200201024405id_/https://www.epa.gov/sites/production/files/signpost/cc.html
start_url = ('https://web.archive.org/web/20200201020357id_/'
'http://epa.gov/climatechange')
target = ('https://web.archive.org/web/20200201023757id_/'
'https://www.epa.gov/climatechange')
memento = client.get_memento(start_url, exact=False, follow_redirects=False)
assert 'https://www.epa.gov/climatechange' == memento.url
assert target == memento.memento_url
assert memento.status_code == 301
assert 'https://www.epa.gov/sites/production/files/signpost/cc.html' == memento.headers['Location']
assert len(memento.history) == 0
assert len(memento.debug_history) == 1
@ia_vcr.use_cassette()
def test_get_memento_returns_memento_with_accurate_url():
with WaybackClient() as client:
# This memento is actually captured from 'https://www.', not 'http://'.
memento = client.get_memento('http://fws.gov/',
timestamp='20171124143728')
assert memento.url == 'https://www.fws.gov/'
def return_timeout(self, *args, **kwargs) -> requests.Response:
"""
Patch requests.Session.send with this in order to return a response with
the provided timeout value as the response body.
Usage:
>>> @mock.patch('requests.Session.send', side_effect=return_timeout)
>>> def test_timeout(self, mock_class):
>>> assert requests.get('http://test.com', timeout=5).text == '5'
"""
res = requests.Response()
res.status_code = 200
res._content = str(kwargs.get('timeout', None)).encode()
return res
class TestWaybackSession:
def test_request_retries(self, requests_mock):
requests_mock.get('http://test.com', [{'text': 'bad1', 'status_code': 503},
{'text': 'bad2', 'status_code': 503},
{'text': 'good', 'status_code': 200}])
session = WaybackSession(retries=2, backoff=0.1)
response = session.request('GET', 'http://test.com')
assert response.ok
session.close()
def test_stops_after_given_retries(self, requests_mock):
requests_mock.get('http://test.com', [{'text': 'bad1', 'status_code': 503},
{'text': 'bad2', 'status_code': 503},
{'text': 'good', 'status_code': 200}])
session = WaybackSession(retries=1, backoff=0.1)
response = session.request('GET', 'http://test.com')
assert response.status_code == 503
assert response.text == 'bad2'
def test_only_retries_some_errors(self, requests_mock):
requests_mock.get('http://test.com', [{'text': 'bad1', 'status_code': 400},
{'text': 'good', 'status_code': 200}])
session = WaybackSession(retries=1, backoff=0.1)
response = session.request('GET', 'http://test.com')
assert response.status_code == 400
def test_raises_rate_limit_error(self, requests_mock):
requests_mock.get('http://test.com', [WAYBACK_RATE_LIMIT_ERROR])
with pytest.raises(RateLimitError):
session = WaybackSession(retries=0)
session.request('GET', 'http://test.com')
def test_rate_limit_error_includes_retry_after(self, requests_mock):
requests_mock.get('http://test.com', [WAYBACK_RATE_LIMIT_ERROR])
with pytest.raises(RateLimitError) as excinfo:
session = WaybackSession(retries=0)
session.request('GET', 'http://test.com')
assert excinfo.value.retry_after == 10
@mock.patch('requests.Session.send', side_effect=return_timeout)
def test_timeout_applied_session(self, mock_class):
# Is the timeout applied through the WaybackSession
session = WaybackSession(timeout=1)
res = session.request('GET', 'http://test.com')
assert res.text == '1'
# Overwriting the default in the requests method
res = session.request('GET', 'http://test.com', timeout=None)
assert res.text == 'None'
res = session.request('GET', 'http://test.com', timeout=2)
assert res.text == '2'
@mock.patch('requests.Session.send', side_effect=return_timeout)
def test_timeout_applied_request(self, mock_class):
# Using the default value
session = WaybackSession()
res = session.request('GET', 'http://test.com')
assert res.text == '60'
# Overwriting the default
res = session.request('GET', 'http://test.com', timeout=None)
assert res.text == 'None'
res = session.request('GET', 'http://test.com', timeout=2)
assert res.text == '2'
@mock.patch('requests.Session.send', side_effect=return_timeout)
def test_timeout_empty(self, mock_class):
# Disabling default timeout
session = WaybackSession(timeout=None)
res = session.request('GET', 'http://test.com')
assert res.text == 'None'
# Overwriting the default
res = session.request('GET', 'http://test.com', timeout=1)
assert res.text == '1'
@ia_vcr.use_cassette()
def test_search_rate_limits(self):
# The timing relies on the cassettes being present,
# therefore the first run might fail.
# Since another test might run before this one,
# I have to wait one second before starting.
time.sleep(1)
# First test that the default rate limits are correctly applied.
start_time = time.time()
with WaybackClient() as client:
for i in range(3):
next(client.search('zew.de'))
duration_with_limits = time.time() - start_time
# Check that disabling the rate limits through the search API works.
start_time = time.time()
with WaybackClient(WaybackSession(search_calls_per_second=0)) as client:
for i in range(3):
next(client.search('zew.de'))
duration_without_limits = time.time() - start_time
# Check that a different rate limit set through the session is applied correctly.
# I need to sleep one half second in order to reset the rate limit.
time.sleep(0.5)
start_time = time.time()
with WaybackClient(WaybackSession(search_calls_per_second=2)) as client:
for i in range(3):
next(client.search('zew.de'))
duration_with_limits_custom = time.time() - start_time
assert 2.4 <= duration_with_limits <= 2.6
assert 0.0 <= duration_without_limits <= 0.05
assert 0.0 <= duration_with_limits_custom <= 1.05
@ia_vcr.use_cassette()
def test_memento_rate_limits(self):
# The timing relies on the cassettes being present,
# therefore the first run might fail.
# Since another test might run before this one,
# I have to wait one call before starting.
time.sleep(1/30)
with WaybackClient() as client:
cdx = next(client.search('zew.de'))
# First test that the default rate limits are correctly applied.
start_time = time.time()
with WaybackClient() as client:
for i in range(11):
client.get_memento(cdx)
duration_with_limits = time.time() - start_time
# Check that disabling the rate limits through the get_memento API works.
time.sleep(1) # Wait to exceed any previous rate limits.
start_time = time.time()
with WaybackClient(WaybackSession(memento_calls_per_second=0)) as client:
for i in range(3):
client.get_memento(cdx)
duration_without_limits = time.time() - start_time
# Check that a different rate limit set through the session is applied correctly.
time.sleep(1) # Wait to exceed any previous rate limits.
start_time = time.time()
with WaybackClient(WaybackSession(memento_calls_per_second=10)) as client:
for i in range(6):
client.get_memento(cdx)
duration_with_limits_custom = time.time() - start_time
assert 1.15 <= duration_with_limits <= 1.35
assert 0.0 <= duration_without_limits <= 0.05
assert 0.5 <= duration_with_limits_custom <= 0.55