-
Notifications
You must be signed in to change notification settings - Fork 84
/
Copy pathtest.py
1296 lines (1053 loc) · 48.1 KB
/
test.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
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# encoding: utf-8
from __future__ import absolute_import, division, print_function, unicode_literals
import codecs
import datetime
import hashlib
import logging
import os
import shutil
import stat
import sys
import tempfile
import unicodedata
import unittest
from os.path import join as j
from unittest import mock
from io import StringIO
import bagit
logging.basicConfig(filename="test.log", level=logging.DEBUG)
stderr = logging.StreamHandler()
stderr.setLevel(logging.WARNING)
logging.getLogger().addHandler(stderr)
# But we do want any exceptions raised in the logging path to be raised:
logging.raiseExceptions = True
def slurp_text_file(filename):
with bagit.open_text_file(filename) as f:
return f.read()
class SelfCleaningTestCase(unittest.TestCase):
"""TestCase subclass which cleans up self.tmpdir after each test"""
def setUp(self):
super(SelfCleaningTestCase, self).setUp()
self.starting_directory = (
os.getcwd()
) # FIXME: remove this after we stop changing directories in bagit.py
self.tmpdir = tempfile.mkdtemp()
if os.path.isdir(self.tmpdir):
shutil.rmtree(self.tmpdir)
shutil.copytree("test-data", self.tmpdir)
def tearDown(self):
# FIXME: remove this after we stop changing directories in bagit.py
os.chdir(self.starting_directory)
if os.path.isdir(self.tmpdir):
# Clean up after tests which leave inaccessible files behind:
os.chmod(self.tmpdir, 0o700)
for dirpath, subdirs, filenames in os.walk(self.tmpdir, topdown=True):
for i in subdirs:
os.chmod(os.path.join(dirpath, i), 0o700)
shutil.rmtree(self.tmpdir)
super(SelfCleaningTestCase, self).tearDown()
@mock.patch(
"bagit.VERSION", new="1.5.4"
) # This avoids needing to change expected hashes on each release
class TestSingleProcessValidation(SelfCleaningTestCase):
def validate(self, bag, *args, **kwargs):
return bag.validate(*args, **kwargs)
def test_make_bag_sha1_sha256_manifest(self):
bag = bagit.make_bag(self.tmpdir, checksum=["sha1", "sha256"])
# check that relevant manifests are created
self.assertTrue(os.path.isfile(j(self.tmpdir, "manifest-sha1.txt")))
self.assertTrue(os.path.isfile(j(self.tmpdir, "manifest-sha256.txt")))
# check valid with two manifests
self.assertTrue(self.validate(bag, fast=True))
def test_make_bag_md5_sha256_manifest(self):
bag = bagit.make_bag(self.tmpdir, checksum=["md5", "sha256"])
# check that relevant manifests are created
self.assertTrue(os.path.isfile(j(self.tmpdir, "manifest-md5.txt")))
self.assertTrue(os.path.isfile(j(self.tmpdir, "manifest-sha256.txt")))
# check valid with two manifests
self.assertTrue(self.validate(bag, fast=True))
def test_make_bag_md5_sha1_sha256_manifest(self):
bag = bagit.make_bag(self.tmpdir, checksum=["md5", "sha1", "sha256"])
# check that relevant manifests are created
self.assertTrue(os.path.isfile(j(self.tmpdir, "manifest-md5.txt")))
self.assertTrue(os.path.isfile(j(self.tmpdir, "manifest-sha1.txt")))
self.assertTrue(os.path.isfile(j(self.tmpdir, "manifest-sha256.txt")))
# check valid with three manifests
self.assertTrue(self.validate(bag, fast=True))
def test_validate_flipped_bit(self):
bag = bagit.make_bag(self.tmpdir)
readme = j(self.tmpdir, "data", "README")
txt = slurp_text_file(readme)
txt = "A" + txt[1:]
with open(readme, "w") as r:
r.write(txt)
bag = bagit.Bag(self.tmpdir)
self.assertRaises(bagit.BagValidationError, self.validate, bag)
# fast doesn't catch the flipped bit, since oxsum is the same
self.assertTrue(self.validate(bag, fast=True))
self.assertTrue(self.validate(bag, completeness_only=True))
def test_validate_fast(self):
bag = bagit.make_bag(self.tmpdir)
self.assertEqual(self.validate(bag, fast=True), True)
os.remove(j(self.tmpdir, "data", "loc", "2478433644_2839c5e8b8_o_d.jpg"))
self.assertRaises(bagit.BagValidationError, self.validate, bag, fast=True)
def test_validate_completeness(self):
bag = bagit.make_bag(self.tmpdir)
old_path = j(self.tmpdir, "data", "README")
new_path = j(self.tmpdir, "data", "extra_file")
os.rename(old_path, new_path)
bag = bagit.Bag(self.tmpdir)
self.assertTrue(self.validate(bag, fast=True))
with mock.patch.object(bag, "_validate_entries") as m:
self.assertRaises(
bagit.BagValidationError, self.validate, bag, completeness_only=True
)
self.assertEqual(m.call_count, 0)
def test_validate_fast_without_oxum(self):
bag = bagit.make_bag(self.tmpdir)
os.remove(j(self.tmpdir, "bag-info.txt"))
bag = bagit.Bag(self.tmpdir)
self.assertRaises(bagit.BagValidationError, self.validate, bag, fast=True)
def test_validate_slow_without_oxum_extra_file(self):
bag = bagit.make_bag(self.tmpdir)
os.remove(j(self.tmpdir, "bag-info.txt"))
with open(j(self.tmpdir, "data", "extra_file"), "w") as ef:
ef.write("foo")
bag = bagit.Bag(self.tmpdir)
self.assertRaises(bagit.BagValidationError, self.validate, bag, fast=False)
def test_validate_missing_directory(self):
bagit.make_bag(self.tmpdir)
tmp_data_dir = os.path.join(self.tmpdir, "data")
shutil.rmtree(tmp_data_dir)
bag = bagit.Bag(self.tmpdir)
with self.assertRaises(bagit.BagValidationError) as error_catcher:
bag.validate()
self.assertEqual(
"Expected data directory %s does not exist" % tmp_data_dir,
str(error_catcher.exception),
)
def test_validation_error_details(self):
bag = bagit.make_bag(
self.tmpdir, checksums=["md5"], bag_info={"Bagging-Date": "1970-01-01"}
)
readme = j(self.tmpdir, "data", "README")
txt = slurp_text_file(readme)
txt = "A" + txt[1:]
with open(readme, "w") as r:
r.write(txt)
bag = bagit.Bag(self.tmpdir)
got_exception = False
try:
self.validate(bag)
except bagit.BagValidationError as e:
got_exception = True
exc_str = str(e)
self.assertIn(
'data/README md5 validation failed: expected="8e2af7a0143c7b8f4de0b3fc90f27354" found="fd41543285d17e7c29cd953f5cf5b955"',
exc_str,
)
self.assertEqual(len(e.details), 1)
readme_error = e.details[0]
self.assertEqual(
'data/README md5 validation failed: expected="8e2af7a0143c7b8f4de0b3fc90f27354" found="fd41543285d17e7c29cd953f5cf5b955"',
str(readme_error),
)
self.assertIsInstance(readme_error, bagit.ChecksumMismatch)
self.assertEqual(readme_error.algorithm, "md5")
self.assertEqual(readme_error.path, "data/README")
self.assertEqual(readme_error.expected, "8e2af7a0143c7b8f4de0b3fc90f27354")
self.assertEqual(readme_error.found, "fd41543285d17e7c29cd953f5cf5b955")
if not got_exception:
self.fail("didn't get BagValidationError")
def test_validation_completeness_error_details(self):
bag = bagit.make_bag(
self.tmpdir, checksums=["md5"], bag_info={"Bagging-Date": "1970-01-01"}
)
old_path = j(self.tmpdir, "data", "README")
new_path = j(self.tmpdir, "data", "extra")
os.rename(old_path, new_path)
# remove the bag-info.txt which contains the oxum to force a full
# check of the manifest
os.remove(j(self.tmpdir, "bag-info.txt"))
bag = bagit.Bag(self.tmpdir)
got_exception = False
try:
self.validate(bag)
except bagit.BagValidationError as e:
got_exception = True
exc_str = str(e)
self.assertIn("Bag is incomplete: ", exc_str)
self.assertIn(
"bag-info.txt exists in manifest but was not found on filesystem",
exc_str,
)
self.assertIn(
"data/README exists in manifest but was not found on filesystem",
exc_str,
)
self.assertIn(
"data/extra exists on filesystem but is not in the manifest", exc_str
)
self.assertEqual(len(e.details), 3)
if e.details[0].path == "bag-info.txt":
baginfo_error = e.details[0]
readme_error = e.details[1]
else:
baginfo_error = e.details[1]
readme_error = e.details[0]
self.assertEqual(
str(baginfo_error),
"bag-info.txt exists in manifest but was not found on filesystem",
)
self.assertIsInstance(baginfo_error, bagit.FileMissing)
self.assertEqual(baginfo_error.path, "bag-info.txt")
self.assertEqual(
str(readme_error),
"data/README exists in manifest but was not found on filesystem",
)
self.assertIsInstance(readme_error, bagit.FileMissing)
self.assertEqual(readme_error.path, "data/README")
error = e.details[2]
self.assertEqual(
str(error), "data/extra exists on filesystem but is not in the manifest"
)
self.assertTrue(error, bagit.UnexpectedFile)
self.assertEqual(error.path, "data/extra")
if not got_exception:
self.fail("didn't get BagValidationError")
def test_bom_in_bagit_txt(self):
bag = bagit.make_bag(self.tmpdir)
BOM = codecs.BOM_UTF8.decode("utf-8")
with open(j(self.tmpdir, "bagit.txt"), "r") as bf:
bagfile = BOM + bf.read()
with open(j(self.tmpdir, "bagit.txt"), "w") as bf:
bf.write(bagfile)
bag = bagit.Bag(self.tmpdir)
self.assertRaises(bagit.BagValidationError, self.validate, bag)
def test_missing_file(self):
bag = bagit.make_bag(self.tmpdir)
os.remove(j(self.tmpdir, "data", "loc", "3314493806_6f1db86d66_o_d.jpg"))
self.assertRaises(bagit.BagValidationError, self.validate, bag)
def test_handle_directory_end_slash_gracefully(self):
bag = bagit.make_bag(self.tmpdir + "/")
self.assertTrue(self.validate(bag))
bag2 = bagit.Bag(self.tmpdir + "/")
self.assertTrue(self.validate(bag2))
def test_allow_extraneous_files_in_base(self):
bag = bagit.make_bag(self.tmpdir)
self.assertTrue(self.validate(bag))
f = j(self.tmpdir, "IGNOREFILE")
with open(f, "w"):
self.assertTrue(self.validate(bag))
def test_allow_extraneous_dirs_in_base(self):
bag = bagit.make_bag(self.tmpdir)
self.assertTrue(self.validate(bag))
d = j(self.tmpdir, "IGNOREDIR")
os.mkdir(d)
self.assertTrue(self.validate(bag))
def test_missing_tagfile_raises_error(self):
bag = bagit.make_bag(self.tmpdir)
self.assertTrue(self.validate(bag))
os.remove(j(self.tmpdir, "bagit.txt"))
self.assertRaises(bagit.BagValidationError, self.validate, bag)
def test_missing_manifest_raises_error(self):
bag = bagit.make_bag(self.tmpdir, checksums=["sha512"])
self.assertTrue(self.validate(bag))
os.remove(j(self.tmpdir, "manifest-sha512.txt"))
self.assertRaises(bagit.BagValidationError, self.validate, bag)
def test_mixed_case_checksums(self):
bag = bagit.make_bag(self.tmpdir, checksums=["md5"])
hashstr = {}
# Extract entries only for the payload and ignore
# entries from the tagmanifest file
for key in bag.entries.keys():
if key.startswith("data" + os.sep):
hashstr = bag.entries[key]
hashstr = next(iter(hashstr.values()))
manifest = slurp_text_file(j(self.tmpdir, "manifest-md5.txt"))
manifest = manifest.replace(hashstr, hashstr.upper())
with open(j(self.tmpdir, "manifest-md5.txt"), "wb") as m:
m.write(manifest.encode("utf-8"))
# Since manifest-md5.txt file is updated, re-calculate its
# md5 checksum and update it in the tagmanifest-md5.txt file
hasher = hashlib.new("md5")
contents = slurp_text_file(j(self.tmpdir, "manifest-md5.txt")).encode("utf-8")
hasher.update(contents)
with open(j(self.tmpdir, "tagmanifest-md5.txt"), "r") as tagmanifest:
tagman_contents = tagmanifest.read()
tagman_contents = tagman_contents.replace(
bag.entries["manifest-md5.txt"]["md5"], hasher.hexdigest()
)
with open(j(self.tmpdir, "tagmanifest-md5.txt"), "w") as tagmanifest:
tagmanifest.write(tagman_contents)
bag = bagit.Bag(self.tmpdir)
self.assertTrue(self.validate(bag))
def test_unsafe_directory_entries_raise_error(self):
bad_paths = None
# This could be more granular, but ought to be
# adequate.
if os.name == "nt":
bad_paths = (
r"C:\win32\cmd.exe",
"\\\\?\\C:\\",
"COM1:",
"\\\\.\\COM56",
"..\\..\\..\\win32\\cmd.exe",
"data\\..\\..\\..\\win32\\cmd.exe",
)
else:
bad_paths = (
"../../../secrets.json",
"~/.pgp/id_rsa",
"/dev/null",
"data/../../../secrets.json",
)
hasher = hashlib.new("md5")
corpus = "this is not a real checksum"
hasher.update(corpus.encode("utf-8"))
for bad_path in bad_paths:
bagit.make_bag(self.tmpdir, checksums=["md5"])
with open(j(self.tmpdir, "manifest-md5.txt"), "wb+") as manifest_out:
line = "%s %s\n" % (hasher.hexdigest(), bad_path)
manifest_out.write(line.encode("utf-8"))
self.assertRaises(bagit.BagError, bagit.Bag, self.tmpdir)
def test_multiple_oxum_values(self):
bag = bagit.make_bag(self.tmpdir)
with open(j(self.tmpdir, "bag-info.txt"), "a") as baginfo:
baginfo.write("Payload-Oxum: 7.7\n")
bag = bagit.Bag(self.tmpdir)
self.assertTrue(self.validate(bag, fast=True))
def test_validate_optional_tagfile(self):
bag = bagit.make_bag(self.tmpdir, checksums=["md5"])
tagdir = tempfile.mkdtemp(dir=self.tmpdir)
with open(j(tagdir, "tagfile"), "w") as tagfile:
tagfile.write("test")
relpath = j(tagdir, "tagfile").replace(self.tmpdir + os.sep, "")
relpath.replace("\\", "/")
with open(j(self.tmpdir, "tagmanifest-md5.txt"), "w") as tagman:
# Incorrect checksum.
tagman.write("8e2af7a0143c7b8f4de0b3fc90f27354 " + relpath + "\n")
bag = bagit.Bag(self.tmpdir)
self.assertRaises(bagit.BagValidationError, self.validate, bag)
hasher = hashlib.new("md5")
contents = slurp_text_file(j(tagdir, "tagfile")).encode("utf-8")
hasher.update(contents)
with open(j(self.tmpdir, "tagmanifest-md5.txt"), "w") as tagman:
tagman.write(hasher.hexdigest() + " " + relpath + "\n")
bag = bagit.Bag(self.tmpdir)
self.assertTrue(self.validate(bag))
# Missing tagfile.
os.remove(j(tagdir, "tagfile"))
bag = bagit.Bag(self.tmpdir)
self.assertRaises(bagit.BagValidationError, self.validate, bag)
def test_validate_optional_tagfile_in_directory(self):
bag = bagit.make_bag(self.tmpdir, checksums=["md5"])
tagdir = tempfile.mkdtemp(dir=self.tmpdir)
if not os.path.exists(j(tagdir, "tagfolder")):
os.makedirs(j(tagdir, "tagfolder"))
with open(j(tagdir, "tagfolder", "tagfile"), "w") as tagfile:
tagfile.write("test")
relpath = j(tagdir, "tagfolder", "tagfile").replace(self.tmpdir + os.sep, "")
relpath.replace("\\", "/")
with open(j(self.tmpdir, "tagmanifest-md5.txt"), "w") as tagman:
# Incorrect checksum.
tagman.write("8e2af7a0143c7b8f4de0b3fc90f27354 " + relpath + "\n")
bag = bagit.Bag(self.tmpdir)
self.assertRaises(bagit.BagValidationError, self.validate, bag)
hasher = hashlib.new("md5")
with open(j(tagdir, "tagfolder", "tagfile"), "r") as tf:
contents = tf.read().encode("utf-8")
hasher.update(contents)
with open(j(self.tmpdir, "tagmanifest-md5.txt"), "w") as tagman:
tagman.write(hasher.hexdigest() + " " + relpath + "\n")
bag = bagit.Bag(self.tmpdir)
self.assertTrue(self.validate(bag))
# Missing tagfile.
os.remove(j(tagdir, "tagfolder", "tagfile"))
bag = bagit.Bag(self.tmpdir)
self.assertRaises(bagit.BagValidationError, self.validate, bag)
def test_sha1_tagfile(self):
info = {"Bagging-Date": "1970-01-01", "Contact-Email": "[email protected]"}
bag = bagit.make_bag(self.tmpdir, checksum=["sha1"], bag_info=info)
self.assertTrue(os.path.isfile(j(self.tmpdir, "tagmanifest-sha1.txt")))
self.assertEqual(
"f69110479d0d395f7c321b3860c2bc0c96ae9fe8",
bag.entries["bag-info.txt"]["sha1"],
)
def test_validate_unreadable_file(self):
bag = bagit.make_bag(self.tmpdir, checksum=["md5"])
os.chmod(j(self.tmpdir, "data/loc/2478433644_2839c5e8b8_o_d.jpg"), 0)
self.assertRaises(bagit.BagValidationError, self.validate, bag, fast=False)
class TestMultiprocessValidation(TestSingleProcessValidation):
def validate(self, bag, *args, **kwargs):
return super(TestMultiprocessValidation, self).validate(
bag, *args, processes=2, **kwargs
)
@mock.patch("bagit.multiprocessing.Pool")
def test_validate_pool_error(self, pool):
# Simulate the Pool constructor raising a RuntimeError.
pool.side_effect = RuntimeError
bag = bagit.make_bag(self.tmpdir)
# Previously, this raised UnboundLocalError if uninitialized.
with self.assertRaises(RuntimeError):
self.validate(bag)
@mock.patch(
"bagit.VERSION", new="1.5.4"
) # This avoids needing to change expected hashes on each release
class TestBag(SelfCleaningTestCase):
def test_make_bag(self):
info = {"Bagging-Date": "1970-01-01", "Contact-Email": "[email protected]"}
bagit.make_bag(self.tmpdir, bag_info=info, checksums=["md5"])
# data dir should've been created
self.assertTrue(os.path.isdir(j(self.tmpdir, "data")))
# check bagit.txt
self.assertTrue(os.path.isfile(j(self.tmpdir, "bagit.txt")))
bagit_txt = slurp_text_file(j(self.tmpdir, "bagit.txt"))
self.assertTrue("BagIt-Version: 0.97", bagit_txt)
self.assertTrue("Tag-File-Character-Encoding: UTF-8", bagit_txt)
# check manifest
self.assertTrue(os.path.isfile(j(self.tmpdir, "manifest-md5.txt")))
manifest_txt = slurp_text_file(j(self.tmpdir, "manifest-md5.txt")).splitlines()
self.assertIn("8e2af7a0143c7b8f4de0b3fc90f27354 data/README", manifest_txt)
self.assertIn(
"9a2b89e9940fea6ac3a0cc71b0a933a0 data/loc/2478433644_2839c5e8b8_o_d.jpg",
manifest_txt,
)
self.assertIn(
"6172e980c2767c12135e3b9d246af5a3 data/loc/3314493806_6f1db86d66_o_d.jpg",
manifest_txt,
)
self.assertIn(
"38a84cd1c41de793a0bccff6f3ec8ad0 data/si/2584174182_ffd5c24905_b_d.jpg",
manifest_txt,
)
self.assertIn(
"5580eaa31ad1549739de12df819e9af8 data/si/4011399822_65987a4806_b_d.jpg",
manifest_txt,
)
# check bag-info.txt
self.assertTrue(os.path.isfile(j(self.tmpdir, "bag-info.txt")))
bag_info_txt = slurp_text_file(j(self.tmpdir, "bag-info.txt"))
bag_info_txt = bag_info_txt.splitlines()
self.assertIn("Contact-Email: [email protected]", bag_info_txt)
self.assertIn("Bagging-Date: 1970-01-01", bag_info_txt)
self.assertIn("Payload-Oxum: 991765.5", bag_info_txt)
self.assertIn(
"Bag-Software-Agent: bagit.py v1.5.4 <https://github.com/LibraryOfCongress/bagit-python>",
bag_info_txt,
)
# check tagmanifest-md5.txt
self.assertTrue(os.path.isfile(j(self.tmpdir, "tagmanifest-md5.txt")))
tagmanifest_txt = slurp_text_file(
j(self.tmpdir, "tagmanifest-md5.txt")
).splitlines()
self.assertIn("9e5ad981e0d29adc278f6a294b8c2aca bagit.txt", tagmanifest_txt)
self.assertIn(
"a0ce6631a2a6d1a88e6d38453ccc72a5 manifest-md5.txt", tagmanifest_txt
)
self.assertIn("0a6ffcffe67e9a34e44220f7ebcb4baa bag-info.txt", tagmanifest_txt)
def test_make_bag_sha1_manifest(self):
bagit.make_bag(self.tmpdir, checksum=["sha1"])
# check manifest
self.assertTrue(os.path.isfile(j(self.tmpdir, "manifest-sha1.txt")))
manifest_txt = slurp_text_file(j(self.tmpdir, "manifest-sha1.txt")).splitlines()
self.assertIn(
"ace19416e605cfb12ab11df4898ca7fd9979ee43 data/README", manifest_txt
)
self.assertIn(
"4c0a3da57374e8db379145f18601b159f3cad44b data/loc/2478433644_2839c5e8b8_o_d.jpg",
manifest_txt,
)
self.assertIn(
"62095aeddae2f3207cb77c85937e13c51641ef71 data/loc/3314493806_6f1db86d66_o_d.jpg",
manifest_txt,
)
self.assertIn(
"e592194b3733e25166a631e1ec55bac08066cbc1 data/si/2584174182_ffd5c24905_b_d.jpg",
manifest_txt,
)
self.assertIn(
"db49ef009f85a5d0701829f38d29f8cf9c5df2ea data/si/4011399822_65987a4806_b_d.jpg",
manifest_txt,
)
def test_make_bag_sha256_manifest(self):
bagit.make_bag(self.tmpdir, checksum=["sha256"])
# check manifest
self.assertTrue(os.path.isfile(j(self.tmpdir, "manifest-sha256.txt")))
manifest_txt = slurp_text_file(
j(self.tmpdir, "manifest-sha256.txt")
).splitlines()
self.assertIn(
"b6df8058fa818acfd91759edffa27e473f2308d5a6fca1e07a79189b95879953 data/loc/2478433644_2839c5e8b8_o_d.jpg",
manifest_txt,
)
self.assertIn(
"1af90c21e72bb0575ae63877b3c69cfb88284f6e8c7820f2c48dc40a08569da5 data/loc/3314493806_6f1db86d66_o_d.jpg",
manifest_txt,
)
self.assertIn(
"f065a4ae2bc5d47c6d046c3cba5c8cdfd66b07c96ff3604164e2c31328e41c1a data/si/2584174182_ffd5c24905_b_d.jpg",
manifest_txt,
)
self.assertIn(
"45d257c93e59ec35187c6a34c8e62e72c3e9cfbb548984d6f6e8deb84bac41f4 data/si/4011399822_65987a4806_b_d.jpg",
manifest_txt,
)
def test_make_bag_sha512_manifest(self):
bagit.make_bag(self.tmpdir, checksum=["sha512"])
# check manifest
self.assertTrue(os.path.isfile(j(self.tmpdir, "manifest-sha512.txt")))
manifest_txt = slurp_text_file(
j(self.tmpdir, "manifest-sha512.txt")
).splitlines()
self.assertIn(
"51fb9236a23795886cf42d539d580739245dc08f72c3748b60ed8803c9cb0e2accdb91b75dbe7d94a0a461827929d720ef45fe80b825941862fcde4c546a376d data/loc/2478433644_2839c5e8b8_o_d.jpg",
manifest_txt,
)
self.assertIn(
"627c15be7f9aabc395c8b2e4c3ff0b50fd84b3c217ca38044cde50fd4749621e43e63828201fa66a97975e316033e4748fb7a4a500183b571ecf17715ec3aea3 data/loc/3314493806_6f1db86d66_o_d.jpg",
manifest_txt,
)
self.assertIn(
"4cb4dafe39b2539536a9cb31d5addf335734cb91e2d2786d212a9b574e094d7619a84ad53f82bd9421478a7994cf9d3f44fea271d542af09d26ce764edbada46 data/si/2584174182_ffd5c24905_b_d.jpg",
manifest_txt,
)
self.assertIn(
"af1c03483cd1999098cce5f9e7689eea1f81899587508f59ba3c582d376f8bad34e75fed55fd1b1c26bd0c7a06671b85e90af99abac8753ad3d76d8d6bb31ebd data/si/4011399822_65987a4806_b_d.jpg",
manifest_txt,
)
def test_make_bag_unknown_algorithm(self):
self.assertRaises(
ValueError, bagit.make_bag, self.tmpdir, checksum=["not-really-a-name"]
)
def test_make_bag_with_empty_directory(self):
tmpdir = tempfile.mkdtemp()
try:
bagit.make_bag(tmpdir)
finally:
shutil.rmtree(tmpdir)
def test_make_bag_with_empty_directory_tree(self):
tmpdir = tempfile.mkdtemp()
path = j(tmpdir, "test1", "test2")
try:
os.makedirs(path)
bagit.make_bag(tmpdir)
finally:
shutil.rmtree(tmpdir)
def test_make_bag_with_bogus_directory(self):
bogus_directory = os.path.realpath("this-directory-does-not-exist")
with self.assertRaises(RuntimeError) as error_catcher:
bagit.make_bag(bogus_directory)
self.assertEqual(
"Bag directory %s does not exist" % bogus_directory,
str(error_catcher.exception),
)
def test_make_bag_with_unreadable_source(self):
os.chmod(self.tmpdir, 0)
with self.assertRaises(bagit.BagError) as error_catcher:
bagit.make_bag(self.tmpdir, checksum=["sha256"])
self.assertEqual(
"Missing permissions to move all files and directories",
str(error_catcher.exception),
)
def test_make_bag_with_unreadable_subdirectory(self):
# We'll set this write-only to exercise the second permission check in make_bag:
os.chmod(j(self.tmpdir, "loc"), 0o200)
with self.assertRaises(bagit.BagError) as error_catcher:
bagit.make_bag(self.tmpdir, checksum=["sha256"])
self.assertEqual(
"Read permissions are required to calculate file fixities",
str(error_catcher.exception),
)
def test_make_bag_with_unwritable_source(self):
path_suffixes = ("", "loc")
for path_suffix in reversed(path_suffixes):
os.chmod(j(self.tmpdir, path_suffix), 0o500)
with self.assertRaises(bagit.BagError) as error_catcher:
bagit.make_bag(self.tmpdir, checksum=["sha256"])
self.assertEqual(
"Missing permissions to move all files and directories",
str(error_catcher.exception),
)
def test_make_bag_with_unreadable_file(self):
os.chmod(j(self.tmpdir, "loc", "2478433644_2839c5e8b8_o_d.jpg"), 0)
with self.assertRaises(bagit.BagError) as error_catcher:
bagit.make_bag(self.tmpdir, checksum=["sha256"])
self.assertEqual(
"Read permissions are required to calculate file fixities",
str(error_catcher.exception),
)
def test_make_bag_with_data_dir_present(self):
os.mkdir(j(self.tmpdir, "data"))
bagit.make_bag(self.tmpdir)
# data dir should now contain another data dir
self.assertTrue(os.path.isdir(j(self.tmpdir, "data", "data")))
def test_bag_class(self):
info = {"Contact-Email": "[email protected]"}
bag = bagit.make_bag(self.tmpdir, bag_info=info, checksums=["sha384"])
self.assertIsInstance(bag, bagit.Bag)
self.assertEqual(
set(bag.payload_files()),
set(
[
"data/README",
"data/si/2584174182_ffd5c24905_b_d.jpg",
"data/si/4011399822_65987a4806_b_d.jpg",
"data/loc/2478433644_2839c5e8b8_o_d.jpg",
"data/loc/3314493806_6f1db86d66_o_d.jpg",
]
),
)
self.assertEqual(
list(bag.manifest_files()), ["%s/manifest-sha384.txt" % self.tmpdir]
)
def test_bag_string_representation(self):
bag = bagit.make_bag(self.tmpdir)
self.assertEqual(self.tmpdir, str(bag))
def test_has_oxum(self):
bag = bagit.make_bag(self.tmpdir)
self.assertTrue(bag.has_oxum())
def test_bag_constructor(self):
bag = bagit.make_bag(self.tmpdir)
bag = bagit.Bag(self.tmpdir)
self.assertEqual(type(bag), bagit.Bag)
self.assertEqual(len(list(bag.payload_files())), 5)
def test_is_valid(self):
bag = bagit.make_bag(self.tmpdir)
bag = bagit.Bag(self.tmpdir)
self.assertTrue(bag.is_valid())
with open(j(self.tmpdir, "data", "extra_file"), "w") as ef:
ef.write("bar")
self.assertFalse(bag.is_valid())
def test_garbage_in_bagit_txt(self):
bagit.make_bag(self.tmpdir)
bagfile = """BagIt-Version: 0.97
Tag-File-Character-Encoding: UTF-8
==================================
"""
with open(j(self.tmpdir, "bagit.txt"), "w") as bf:
bf.write(bagfile)
self.assertRaises(bagit.BagValidationError, bagit.Bag, self.tmpdir)
def test_make_bag_multiprocessing(self):
bagit.make_bag(self.tmpdir, processes=2)
self.assertTrue(os.path.isdir(j(self.tmpdir, "data")))
def test_multiple_meta_values(self):
baginfo = {"Multival-Meta": [7, 4, 8, 6, 8]}
bag = bagit.make_bag(self.tmpdir, baginfo)
meta = bag.info.get("Multival-Meta")
self.assertEqual(type(meta), list)
self.assertEqual(len(meta), len(baginfo["Multival-Meta"]))
def test_unicode_bag_info(self):
info = {
"Test-BMP": "This element contains a \N{LATIN SMALL LETTER U WITH DIAERESIS}",
"Test-SMP": "This element contains a \N{LINEAR B SYMBOL B049}",
}
bagit.make_bag(self.tmpdir, bag_info=info, checksums=["md5"])
bag_info_txt = slurp_text_file(j(self.tmpdir, "bag-info.txt"))
for v in info.values():
self.assertIn(v, bag_info_txt)
def test_unusual_bag_info_separators(self):
bag = bagit.make_bag(self.tmpdir)
with open(j(self.tmpdir, "bag-info.txt"), "a") as f:
print("Test-Tag: 1", file=f)
print("Test-Tag:\t2", file=f)
print("Test-Tag\t: 3", file=f)
print("Test-Tag\t:\t4", file=f)
print("Test-Tag\t \t: 5", file=f)
print("Test-Tag:\t \t 6", file=f)
bag = bagit.Bag(self.tmpdir)
bag.save(manifests=True)
self.assertTrue(bag.is_valid())
self.assertEqual(bag.info["Test-Tag"], list(map(str, range(1, 7))))
def test_default_bagging_date(self):
info = {"Contact-Email": "[email protected]"}
bagit.make_bag(self.tmpdir, bag_info=info)
bag_info_txt = slurp_text_file(j(self.tmpdir, "bag-info.txt"))
self.assertTrue("Contact-Email: [email protected]" in bag_info_txt)
today = datetime.date.strftime(datetime.date.today(), "%Y-%m-%d")
self.assertTrue("Bagging-Date: %s" % today in bag_info_txt)
def test_missing_tagmanifest_valid(self):
info = {"Contact-Email": "[email protected]"}
bag = bagit.make_bag(self.tmpdir, bag_info=info, checksums=["md5"])
self.assertTrue(bag.is_valid())
os.remove(j(self.tmpdir, "tagmanifest-md5.txt"))
self.assertTrue(bag.is_valid())
def test_carriage_return_manifest(self):
with open(j(self.tmpdir, "newline\r"), "w") as whatever:
whatever.write("ugh")
bag = bagit.make_bag(self.tmpdir)
self.assertTrue(bag.is_valid())
def test_payload_permissions(self):
perms = os.stat(self.tmpdir).st_mode
# our tmpdir should not be writeable by group
self.assertEqual(perms & stat.S_IWOTH, 0)
# but if we make it writeable by the group then resulting
# payload directory should have the same permissions
new_perms = perms | stat.S_IWOTH
self.assertTrue(perms != new_perms)
os.chmod(self.tmpdir, new_perms)
bagit.make_bag(self.tmpdir)
payload_dir = j(self.tmpdir, "data")
self.assertEqual(os.stat(payload_dir).st_mode, new_perms)
def test_save_bag_to_unwritable_directory(self):
bag = bagit.make_bag(self.tmpdir, checksum=["sha256"])
os.chmod(self.tmpdir, 0)
with self.assertRaises(bagit.BagError) as error_catcher:
bag.save()
self.assertEqual(
"Cannot save bag to non-existent or inaccessible directory %s"
% self.tmpdir,
str(error_catcher.exception),
)
def test_save_bag_with_unwritable_file(self):
bag = bagit.make_bag(self.tmpdir, checksum=["sha256"])
os.chmod(os.path.join(self.tmpdir, "bag-info.txt"), 0)
with self.assertRaises(bagit.BagError) as error_catcher:
bag.save()
self.assertEqual(
"Read permissions are required to calculate file fixities",
str(error_catcher.exception),
)
def test_save_manifests(self):
bag = bagit.make_bag(self.tmpdir)
self.assertTrue(bag.is_valid())
bag.save(manifests=True)
self.assertTrue(bag.is_valid())
with open(j(self.tmpdir, "data", "newfile"), "w") as nf:
nf.write("newfile")
self.assertRaises(bagit.BagValidationError, bag.validate, bag, fast=False)
bag.save(manifests=True)
self.assertTrue(bag.is_valid())
def test_save_manifests_deleted_files(self):
bag = bagit.make_bag(self.tmpdir)
self.assertTrue(bag.is_valid())
bag.save(manifests=True)
self.assertTrue(bag.is_valid())
os.remove(j(self.tmpdir, "data", "loc", "2478433644_2839c5e8b8_o_d.jpg"))
self.assertRaises(bagit.BagValidationError, bag.validate, bag, fast=False)
bag.save(manifests=True)
self.assertTrue(bag.is_valid())
def test_save_baginfo(self):
bag = bagit.make_bag(self.tmpdir)
bag.info["foo"] = "bar"
bag.save()
bag = bagit.Bag(self.tmpdir)
self.assertEqual(bag.info["foo"], "bar")
self.assertTrue(bag.is_valid())
bag.info["x"] = ["a", "b", "c"]
bag.save()
b = bagit.Bag(self.tmpdir)
self.assertEqual(b.info["x"], ["a", "b", "c"])
self.assertTrue(bag.is_valid())
def test_save_baginfo_with_sha1(self):
bag = bagit.make_bag(self.tmpdir, checksum=["sha1", "md5"])
self.assertTrue(bag.is_valid())
bag.save()
bag.info["foo"] = "bar"
bag.save()
bag = bagit.Bag(self.tmpdir)
self.assertTrue(bag.is_valid())
def test_save_only_baginfo(self):
bag = bagit.make_bag(self.tmpdir)
with open(j(self.tmpdir, "data", "newfile"), "w") as nf:
nf.write("newfile")
bag.info["foo"] = "bar"
bag.save()
bag = bagit.Bag(self.tmpdir)
self.assertEqual(bag.info["foo"], "bar")
self.assertFalse(bag.is_valid())
def test_make_bag_with_newline(self):
bag = bagit.make_bag(self.tmpdir, {"test": "foo\nbar"})
self.assertEqual(bag.info["test"], "foobar")
def test_unicode_in_tags(self):
bag = bagit.make_bag(self.tmpdir, {"test": "♡"})
bag = bagit.Bag(self.tmpdir)
self.assertEqual(bag.info["test"], "♡")
def test_filename_unicode_normalization(self):
# We need to handle cases where the Unicode normalization form of a
# filename has changed in-transit. This is hard to do portably in both
# directions because OS X normalizes *all* filenames to an NFD variant
# so we'll start with a basic test which writes the manifest using the
# NFC form and confirm that this does not cause the bag to fail when it
# is written to the filesystem using the NFD form, which will not be
# altered when saved to an HFS+ filesystem:
test_filename = "Núñez Papers.txt"
test_filename_nfd = unicodedata.normalize("NFD", test_filename)
os.makedirs(j(self.tmpdir, "unicode-normalization"))
with open(j(self.tmpdir, "unicode-normalization", test_filename_nfd), "w") as f:
f.write("This is a test filename written using NFD normalization\n")
bag = bagit.make_bag(self.tmpdir)
bag.save()
self.assertTrue(bag.is_valid())
# Now we'll cause the entire manifest file was normalized to NFC:
for m_f in bag.manifest_files():
contents = slurp_text_file(m_f)
normalized_bytes = unicodedata.normalize("NFC", contents).encode("utf-8")
with open(m_f, "wb") as f:
f.write(normalized_bytes)
for alg in bag.algorithms:
bagit._make_tagmanifest_file(alg, bag.path, encoding=bag.encoding)
# Now we'll reload the whole thing:
bag = bagit.Bag(self.tmpdir)
self.assertTrue(bag.is_valid())
def test_open_bag_with_missing_bagit_txt(self):
bagit.make_bag(self.tmpdir)
os.unlink(j(self.tmpdir, "bagit.txt"))
with self.assertRaises(bagit.BagError) as error_catcher:
bagit.Bag(self.tmpdir)
self.assertEqual(
"Expected bagit.txt does not exist: %s/bagit.txt" % self.tmpdir,
str(error_catcher.exception),
)
def test_open_bag_with_malformed_bagit_txt(self):
bagit.make_bag(self.tmpdir)
with open(j(self.tmpdir, "bagit.txt"), "w") as f:
os.ftruncate(f.fileno(), 0)
with self.assertRaises(bagit.BagError) as error_catcher:
bagit.Bag(self.tmpdir)
self.assertEqual(
"Missing required tag in bagit.txt: BagIt-Version, Tag-File-Character-Encoding",
str(error_catcher.exception),
)
def test_open_bag_with_invalid_versions(self):
bagit.make_bag(self.tmpdir)
for v in ("a.b", "2.", "0.1.2", "1.2.3"):
with open(j(self.tmpdir, "bagit.txt"), "w") as f:
f.write("BagIt-Version: %s\nTag-File-Character-Encoding: UTF-8\n" % v)
with self.assertRaises(bagit.BagError) as error_catcher:
bagit.Bag(self.tmpdir)
self.assertEqual(
"Bag version numbers must be MAJOR.MINOR numbers, not %s" % v,
str(error_catcher.exception),
)
def test_open_bag_with_unsupported_version(self):
bagit.make_bag(self.tmpdir)
with open(j(self.tmpdir, "bagit.txt"), "w") as f:
f.write("BagIt-Version: 2.0\nTag-File-Character-Encoding: UTF-8\n")
with self.assertRaises(bagit.BagError) as error_catcher:
bagit.Bag(self.tmpdir)