File: test__util.py

package info (click to toggle)
mutagen 1.47.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,456 kB
  • sloc: python: 22,562; makefile: 50; sh: 29
file content (950 lines) | stat: -rw-r--r-- 33,231 bytes parent folder | download | duplicates (2)
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

from mutagen._util import DictMixin, cdata, insert_bytes, delete_bytes, \
    decode_terminated, dict_match, enum, get_size, BitReader, BitReaderError, \
    resize_bytes, seek_end, verify_fileobj, fileobj_name, \
    read_full, flags, resize_file, move_bytes, encode_endian, loadfile, \
    intround, verify_filename
from tests import TestCase, get_temp_empty
import os
import random
import tempfile
import errno
import builtins
from io import BytesIO

try:
    import fcntl
except ImportError:
    fcntl = None

import pytest


def test_intround():
    assert intround(2.5) == 2
    assert intround(2.6) == 3
    assert intround(2.4) == 2


class FDict(DictMixin):

    def __init__(self):
        self.__d = {}
        self.keys = self.__d.keys

    def __getitem__(self, *args):
        return self.__d.__getitem__(*args)

    def __setitem__(self, *args):
        return self.__d.__setitem__(*args)

    def __delitem__(self, *args):
        return self.__d.__delitem__(*args)


class TDictMixin(TestCase):

    def setUp(self):
        self.fdict = FDict()
        self.rdict = {}
        self.fdict["foo"] = self.rdict["foo"] = "bar"

    def test_getsetitem(self):
        self.failUnlessEqual(self.fdict["foo"], "bar")
        self.failUnlessRaises(KeyError, self.fdict.__getitem__, "bar")

    def test_has_key_contains(self):
        self.failUnless("foo" in self.fdict)
        self.failIf("bar" in self.fdict)

    def test_iter(self):
        self.failUnlessEqual(list(iter(self.fdict)), ["foo"])

    def test_clear(self):
        self.fdict.clear()
        self.rdict.clear()
        self.failIf(self.fdict)

    def test_keys(self):
        self.failUnlessEqual(list(self.fdict.keys()), list(self.rdict.keys()))
        self.failUnlessEqual(
            list(self.fdict.keys()), list(self.rdict.keys()))

    def test_values(self):
        self.failUnlessEqual(
            list(self.fdict.values()), list(self.rdict.values()))
        self.failUnlessEqual(
            list(self.fdict.values()), list(self.rdict.values()))

    def test_items(self):
        self.failUnlessEqual(
            list(self.fdict.items()), list(self.rdict.items()))
        self.failUnlessEqual(
            list(self.fdict.items()), list(self.rdict.items()))

    def test_pop(self):
        self.failUnlessEqual(self.fdict.pop("foo"), self.rdict.pop("foo"))
        self.failUnlessRaises(KeyError, self.fdict.pop, "woo")

    def test_pop_bad(self):
        self.failUnlessRaises(TypeError, self.fdict.pop, "foo", 1, 2)

    def test_popitem(self):
        self.failUnlessEqual(self.fdict.popitem(), self.rdict.popitem())
        self.failUnlessRaises(KeyError, self.fdict.popitem)

    def test_update_other(self):
        other = {"a": 1, "b": 2}
        self.fdict.update(other)
        self.rdict.update(other)

    def test_update_other_is_list(self):
        other = [("a", 1), ("b", 2)]
        self.fdict.update(other)
        self.rdict.update(dict(other))

    def test_update_kwargs(self):
        self.fdict.update(a=1, b=2)
        # Ironically, the *real* dict doesn't support this on Python 2.3
        other = {"a": 1, "b": 2}
        self.rdict.update(other)

    def test_setdefault(self):
        self.fdict.setdefault("foo", "baz")
        self.rdict.setdefault("foo", "baz")
        self.fdict.setdefault("bar", "baz")
        self.rdict.setdefault("bar", "baz")

    def test_get(self):
        self.failUnlessEqual(self.rdict.get("a"), self.fdict.get("a"))
        self.failUnlessEqual(
            self.rdict.get("a", "b"), self.fdict.get("a", "b"))
        self.failUnlessEqual(self.rdict.get("foo"), self.fdict.get("foo"))

    def test_repr(self):
        self.failUnlessEqual(repr(self.rdict), repr(self.fdict))

    def test_len(self):
        self.failUnlessEqual(len(self.rdict), len(self.fdict))

    def tearDown(self):
        self.failUnlessEqual(self.fdict, self.rdict)
        self.failUnlessEqual(self.rdict, self.fdict)


class Tcdata(TestCase):

    ZERO = staticmethod(lambda s: b"\x00" * s)
    LEONE = staticmethod(lambda s: b"\x01" + b"\x00" * (s - 1))
    BEONE = staticmethod(lambda s: b"\x00" * (s - 1) + b"\x01")
    NEGONE = staticmethod(lambda s: b"\xff" * s)

    def test_char(self):
        self.failUnlessEqual(cdata.char(self.ZERO(1)), 0)
        self.failUnlessEqual(cdata.char(self.LEONE(1)), 1)
        self.failUnlessEqual(cdata.char(self.BEONE(1)), 1)
        self.failUnlessEqual(cdata.char(self.NEGONE(1)), -1)
        self.assertTrue(cdata.char is cdata.int8)
        self.assertTrue(cdata.to_char is cdata.to_int8)
        self.assertTrue(cdata.char_from is cdata.int8_from)
        assert cdata.int8_max == 2 ** 7 - 1
        assert cdata.int8_min == - 2 ** 7
        assert cdata.int8_max == cdata.char_max
        assert cdata.int8_min == cdata.char_min

    def test_char_from_to(self):
        self.assertEqual(cdata.to_char(-2), b"\xfe")
        self.assertEqual(cdata.char_from(b"\xfe"), (-2, 1))
        self.assertEqual(cdata.char_from(b"\x00\xfe", 1), (-2, 2))
        self.assertRaises(cdata.error, cdata.char_from, b"\x00\xfe", 3)

    def test_uchar(self):
        self.failUnlessEqual(cdata.uchar(self.ZERO(1)), 0)
        self.failUnlessEqual(cdata.uchar(self.LEONE(1)), 1)
        self.failUnlessEqual(cdata.uchar(self.BEONE(1)), 1)
        self.failUnlessEqual(cdata.uchar(self.NEGONE(1)), 255)
        self.assertTrue(cdata.uchar is cdata.uint8)
        self.assertTrue(cdata.to_uchar is cdata.to_uint8)
        self.assertTrue(cdata.uchar_from is cdata.uint8_from)
        assert cdata.uint8_max == 2 ** 8 - 1
        assert cdata.uint8_min == 0
        assert cdata.uint8_max == cdata.uchar_max
        assert cdata.uint8_min == cdata.uchar_min

    def test_short(self):
        self.failUnlessEqual(cdata.short_le(self.ZERO(2)), 0)
        self.failUnlessEqual(cdata.short_le(self.LEONE(2)), 1)
        self.failUnlessEqual(cdata.short_le(self.BEONE(2)), 256)
        self.failUnlessEqual(cdata.short_le(self.NEGONE(2)), -1)
        self.assertTrue(cdata.short_le is cdata.int16_le)

        self.failUnlessEqual(cdata.short_be(self.ZERO(2)), 0)
        self.failUnlessEqual(cdata.short_be(self.LEONE(2)), 256)
        self.failUnlessEqual(cdata.short_be(self.BEONE(2)), 1)
        self.failUnlessEqual(cdata.short_be(self.NEGONE(2)), -1)
        self.assertTrue(cdata.short_be is cdata.int16_be)

    def test_ushort(self):
        self.failUnlessEqual(cdata.ushort_le(self.ZERO(2)), 0)
        self.failUnlessEqual(cdata.ushort_le(self.LEONE(2)), 1)
        self.failUnlessEqual(cdata.ushort_le(self.BEONE(2)), 2 ** 16 >> 8)
        self.failUnlessEqual(cdata.ushort_le(self.NEGONE(2)), 65535)
        self.assertTrue(cdata.ushort_le is cdata.uint16_le)

        self.failUnlessEqual(cdata.ushort_be(self.ZERO(2)), 0)
        self.failUnlessEqual(cdata.ushort_be(self.LEONE(2)), 2 ** 16 >> 8)
        self.failUnlessEqual(cdata.ushort_be(self.BEONE(2)), 1)
        self.failUnlessEqual(cdata.ushort_be(self.NEGONE(2)), 65535)
        self.assertTrue(cdata.ushort_be is cdata.uint16_be)

    def test_int(self):
        self.failUnlessEqual(cdata.int_le(self.ZERO(4)), 0)
        self.failUnlessEqual(cdata.int_le(self.LEONE(4)), 1)
        self.failUnlessEqual(cdata.int_le(self.BEONE(4)), 2 ** 32 >> 8)
        self.failUnlessEqual(cdata.int_le(self.NEGONE(4)), -1)
        self.assertTrue(cdata.int_le is cdata.int32_le)

        self.failUnlessEqual(cdata.int_be(self.ZERO(4)), 0)
        self.failUnlessEqual(cdata.int_be(self.LEONE(4)), 2 ** 32 >> 8)
        self.failUnlessEqual(cdata.int_be(self.BEONE(4)), 1)
        self.failUnlessEqual(cdata.int_be(self.NEGONE(4)), -1)
        self.assertTrue(cdata.int_be is cdata.int32_be)

    def test_uint(self):
        self.failUnlessEqual(cdata.uint_le(self.ZERO(4)), 0)
        self.failUnlessEqual(cdata.uint_le(self.LEONE(4)), 1)
        self.failUnlessEqual(cdata.uint_le(self.BEONE(4)), 2 ** 32 >> 8)
        self.failUnlessEqual(cdata.uint_le(self.NEGONE(4)), 2 ** 32 - 1)
        self.assertTrue(cdata.uint_le is cdata.uint32_le)

        self.failUnlessEqual(cdata.uint_be(self.ZERO(4)), 0)
        self.failUnlessEqual(cdata.uint_be(self.LEONE(4)), 2 ** 32 >> 8)
        self.failUnlessEqual(cdata.uint_be(self.BEONE(4)), 1)
        self.failUnlessEqual(cdata.uint_be(self.NEGONE(4)), 2 ** 32 - 1)
        self.assertTrue(cdata.uint_be is cdata.uint32_be)

    def test_longlong(self):
        self.failUnlessEqual(cdata.longlong_le(self.ZERO(8)), 0)
        self.failUnlessEqual(cdata.longlong_le(self.LEONE(8)), 1)
        self.failUnlessEqual(cdata.longlong_le(self.BEONE(8)), 2 ** 64 >> 8)
        self.failUnlessEqual(cdata.longlong_le(self.NEGONE(8)), -1)
        self.assertTrue(cdata.longlong_le is cdata.int64_le)

        self.failUnlessEqual(cdata.longlong_be(self.ZERO(8)), 0)
        self.failUnlessEqual(cdata.longlong_be(self.LEONE(8)), 2 ** 64 >> 8)
        self.failUnlessEqual(cdata.longlong_be(self.BEONE(8)), 1)
        self.failUnlessEqual(cdata.longlong_be(self.NEGONE(8)), -1)
        self.assertTrue(cdata.longlong_be is cdata.int64_be)

    def test_ulonglong(self):
        self.failUnlessEqual(cdata.ulonglong_le(self.ZERO(8)), 0)
        self.failUnlessEqual(cdata.ulonglong_le(self.LEONE(8)), 1)
        self.failUnlessEqual(cdata.longlong_le(self.BEONE(8)), 2 ** 64 >> 8)
        self.failUnlessEqual(cdata.ulonglong_le(self.NEGONE(8)), 2 ** 64 - 1)
        self.assertTrue(cdata.ulonglong_le is cdata.uint64_le)

        self.failUnlessEqual(cdata.ulonglong_be(self.ZERO(8)), 0)
        self.failUnlessEqual(cdata.ulonglong_be(self.LEONE(8)), 2 ** 64 >> 8)
        self.failUnlessEqual(cdata.longlong_be(self.BEONE(8)), 1)
        self.failUnlessEqual(cdata.ulonglong_be(self.NEGONE(8)), 2 ** 64 - 1)
        self.assertTrue(cdata.ulonglong_be is cdata.uint64_be)

    def test_invalid_lengths(self):
        self.failUnlessRaises(cdata.error, cdata.char, b"")
        self.failUnlessRaises(cdata.error, cdata.uchar, b"")
        self.failUnlessRaises(cdata.error, cdata.int_le, b"")
        self.failUnlessRaises(cdata.error, cdata.longlong_le, b"")
        self.failUnlessRaises(cdata.error, cdata.uint_le, b"")
        self.failUnlessRaises(cdata.error, cdata.ulonglong_le, b"")
        self.failUnlessRaises(cdata.error, cdata.int_be, b"")
        self.failUnlessRaises(cdata.error, cdata.longlong_be, b"")
        self.failUnlessRaises(cdata.error, cdata.uint_be, b"")
        self.failUnlessRaises(cdata.error, cdata.ulonglong_be, b"")

    def test_test(self):
        self.failUnless(cdata.test_bit((1), 0))
        self.failIf(cdata.test_bit(1, 1))

        self.failUnless(cdata.test_bit(2, 1))
        self.failIf(cdata.test_bit(2, 0))

        v = (1 << 12) + (1 << 5) + 1
        self.failUnless(cdata.test_bit(v, 0))
        self.failUnless(cdata.test_bit(v, 5))
        self.failUnless(cdata.test_bit(v, 12))
        self.failIf(cdata.test_bit(v, 3))
        self.failIf(cdata.test_bit(v, 8))
        self.failIf(cdata.test_bit(v, 13))


class Tresize_file(TestCase):

    def get_named_file(self, content):
        filename = get_temp_empty()
        h = open(filename, "wb+")
        h.write(content)
        h.seek(0)
        return h

    def test_resize(self):
        with self.get_named_file(b"") as h:
            resize_file(h, 0)
            self.assertEqual(os.path.getsize(h.name), 0)
            self.assertRaises(ValueError, resize_file, h, -1)
            resize_file(h, 1)
            self.assertEqual(os.path.getsize(h.name), 1)
            h.seek(0)
            self.assertEqual(h.read(), b"\x00")
            resize_file(h, 2 ** 17)
            self.assertEqual(os.path.getsize(h.name), 2 ** 17 + 1)
            h.seek(0)
            self.assertEqual(h.read(), b"\x00" * (2 ** 17 + 1))

    def test_resize_content(self):
        with self.get_named_file(b"abc") as h:
            self.assertRaises(ValueError, resize_file, h, -4)
            resize_file(h, -1)
            h.seek(0)
            self.assertEqual(h.read(), b"ab")
            resize_file(h, 2)
            h.seek(0)
            self.assertEqual(h.read(), b"ab\x00\x00")

    def test_resize_dev_full(self):

        def raise_no_space(*args):
            raise IOError(errno.ENOSPC, os.strerror(errno.ENOSPC))

        # fail on first write
        h = BytesIO(b"abc")
        h.write = raise_no_space
        self.assertRaises(IOError, resize_file, h, 1)
        h.seek(0, 2)
        self.assertEqual(h.tell(), 3)

        # fail on flush
        h = BytesIO(b"abc")
        h.flush = raise_no_space
        self.assertRaises(IOError, resize_file, h, 1)
        h.seek(0, 2)
        self.assertEqual(h.tell(), 3)


class TMoveMixin(TestCase):

    MOVE = staticmethod(move_bytes)

    def file(self, contents):
        temp = tempfile.TemporaryFile()
        temp.write(contents)
        temp.flush()
        temp.seek(0)
        return temp

    def read(self, fobj):
        fobj.seek(0, 0)
        return fobj.read()

    def test_basic(self):
        with self.file(b"abc123") as h:
            self.MOVE(h, 0, 1, 4)
            self.assertEqual(self.read(h), b"bc1223")

        with self.file(b"abc123") as h:
            self.MOVE(h, 1, 0, 4)
            self.assertEqual(self.read(h), b"aabc13")

    def test_invalid_params(self):
        with self.file(b"foo") as o:
            self.assertRaises(ValueError, self.MOVE, o, -1, 0, 0)
            self.assertRaises(ValueError, self.MOVE, o, 0, -1, 0)
            self.assertRaises(ValueError, self.MOVE, o, 0, 0, -1)

    def test_outside_file(self):
        with self.file(b"foo") as o:
            self.assertRaises(ValueError, self.MOVE, o, 0, 0, 4)
            self.assertRaises(ValueError, self.MOVE, o, 0, 1, 3)
            self.assertRaises(ValueError, self.MOVE, o, 1, 0, 3)

    def test_ok(self):
        with self.file(b"foo") as o:
            self.MOVE(o, 0, 1, 2)
            self.MOVE(o, 1, 0, 2)


class FileHandling(TestCase):
    def file(self, contents):
        temp = tempfile.TemporaryFile()
        temp.write(contents)
        temp.flush()
        temp.seek(0)
        return temp

    def read(self, fobj):
        fobj.seek(0, 0)
        return fobj.read()

    def test_resize_decrease(self):
        with self.file(b'abcd') as o:
            resize_bytes(o, 2, 1, 1)
            self.assertEqual(self.read(o), b"abd")

    def test_resize_increase(self):
        with self.file(b'abcd') as o:
            resize_bytes(o, 2, 4, 1)
            self.assertEqual(self.read(o), b"abcd\x00d")

    def test_resize_nothing(self):
        with self.file(b'abcd') as o:
            resize_bytes(o, 2, 2, 1)
            self.assertEqual(self.read(o), b"abcd")

    def test_insert_into_empty(self):
        with self.file(b'') as o:
            insert_bytes(o, 8, 0)
            self.assertEqual(b'\x00' * 8, self.read(o))

    def test_insert_before_one(self):
        with self.file(b'a') as o:
            insert_bytes(o, 8, 0)
            self.assertEqual(b'a' + b'\x00' * 7 + b'a', self.read(o))

    def test_insert_after_one(self):
        with self.file(b'a') as o:
            insert_bytes(o, 8, 1)
            self.assertEqual(b'a' + b'\x00' * 8, self.read(o))

    def test_insert_after_file(self):
        with self.file(b'a') as o:
            self.assertRaises(ValueError, insert_bytes, o, 1, 2)

    def test_smaller_than_file_middle(self):
        with self.file(b'abcdefghij') as o:
            insert_bytes(o, 4, 4)
            self.assertEqual(b'abcdefghefghij', self.read(o))

    def test_smaller_than_file_to_end(self):
        with self.file(b'abcdefghij') as o:
            insert_bytes(o, 4, 6)
            self.assertEqual(b'abcdefghijghij', self.read(o))

    def test_smaller_than_file_across_end(self):
        with self.file(b'abcdefghij') as o:
            insert_bytes(o, 4, 8)
            self.assertEqual(b'abcdefghij\x00\x00ij', self.read(o))

    def test_smaller_than_file_at_end(self):
        with self.file(b'abcdefghij') as o:
            insert_bytes(o, 3, 10)
            self.assertEqual(b'abcdefghij\x00\x00\x00', self.read(o))

    def test_smaller_than_file_at_beginning(self):
        with self.file(b'abcdefghij') as o:
            insert_bytes(o, 3, 0)
            self.assertEqual(b'abcabcdefghij', self.read(o))

    def test_zero(self):
        with self.file(b'abcdefghij') as o:
            insert_bytes(o, 0, 1)
            self.assertEqual(b'abcdefghij', self.read(o))

    def test_negative(self):
        with self.file(b'abcdefghij') as o:
            self.assertRaises(ValueError, insert_bytes, o, 8, -1)

    def test_delete_one(self):
        with self.file(b'a') as o:
            delete_bytes(o, 1, 0)
            self.assertEqual(b'', self.read(o))

    def test_delete_first_of_two(self):
        with self.file(b'ab') as o:
            delete_bytes(o, 1, 0)
            self.assertEqual(b'b', self.read(o))

    def test_delete_second_of_two(self):
        with self.file(b'ab') as o:
            delete_bytes(o, 1, 1)
            self.assertEqual(b'a', self.read(o))

    def test_delete_third_of_two(self):
        with self.file(b'ab') as o:
            self.assertRaises(ValueError, delete_bytes, o, 1, 2)

    def test_delete_middle(self):
        with self.file(b'abcdefg') as o:
            delete_bytes(o, 3, 2)
            self.assertEqual(b'abfg', self.read(o))

    def test_delete_across_end(self):
        with self.file(b'abcdefg') as o:
            self.assertRaises(ValueError, delete_bytes, o, 4, 8)

    def test_delete_zero(self):
        with self.file(b'abcdefg') as o:
            delete_bytes(o, 0, 3)
            self.assertEqual(b'abcdefg', self.read(o))

    def test_delete_negative(self):
        with self.file(b'abcdefg') as o:
            self.assertRaises(ValueError, delete_bytes, o, 4, -8)

    def test_insert_6106_79_51760(self):
        # This appears to be due to ANSI C limitations in read/write on rb+
        # files.
        data = u''.join(map(str, range(12574)))  # 51760 bytes
        data = data.encode("ascii")
        with self.file(data) as o:
            insert_bytes(o, 6106, 79)
            self.failUnless(data[:6106 + 79] + data[79:] == self.read(o))

    def test_delete_6106_79_51760(self):
        # This appears to be due to ANSI C limitations in read/write on rb+
        # files.
        data = u''.join(map(str, range(12574)))  # 51760 bytes
        data = data.encode("ascii")
        with self.file(data[:6106 + 79] + data[79:]) as o:
            delete_bytes(o, 6106, 79)
            self.failUnless(data == self.read(o))

    # Generate a bunch of random insertions, apply them, delete them,
    # and make sure everything is still correct.
    #
    # The num_runs and num_changes values are tuned to take about 10s
    # on my laptop, or about 30 seconds since we we have 3 variations
    # on insert/delete_bytes brokenness. If I ever get a faster
    # laptop, it's probably a good idea to increase them. :)
    def test_many_changes(self, num_runs=5, num_changes=300,
                          min_change_size=500, max_change_size=1000,
                          min_buffer_size=1, max_buffer_size=2000):
        self.failUnless(min_buffer_size < min_change_size and
                        max_buffer_size > max_change_size and
                        min_change_size < max_change_size and
                        min_buffer_size < max_buffer_size,
                        "Given testing parameters make this test useless")
        for j in range(num_runs):
            data = b"ABCDEFGHIJKLMNOPQRSTUVWXYZ" * 1024
            with self.file(data) as fobj:
                filesize = len(data)
                # Generate the list of changes to apply
                changes = []
                for i in range(num_changes):
                    change_size = random.randrange(
                        min_change_size, max_change_size)
                    change_offset = random.randrange(0, filesize)
                    filesize += change_size
                    changes.append((change_offset, change_size))

                # Apply the changes, and make sure they all took.
                for offset, size in changes:
                    buffer_size = random.randrange(
                        min_buffer_size, max_buffer_size)
                    insert_bytes(fobj, size, offset, BUFFER_SIZE=buffer_size)
                fobj.seek(0)
                self.failIfEqual(fobj.read(len(data)), data)
                fobj.seek(0, 2)
                self.failUnlessEqual(fobj.tell(), filesize)

                # Then, undo them.
                changes.reverse()
                for offset, size in changes:
                    buffer_size = random.randrange(
                        min_buffer_size, max_buffer_size)
                    delete_bytes(fobj, size, offset, BUFFER_SIZE=buffer_size)
                fobj.seek(0)
                self.failUnless(fobj.read() == data)


class Tdict_match(TestCase):

    def test_match(self):
        self.assertEqual(dict_match({"*": 1}, "a"), 1)
        self.assertEqual(dict_match({"*": 1}, "*"), 1)
        self.assertEqual(dict_match({"*a": 1}, "ba"), 1)
        self.assertEqual(dict_match({"?": 1}, "b"), 1)
        self.assertEqual(dict_match({"[ab]": 1}, "b"), 1)

    def test_nomatch(self):
        self.assertEqual(dict_match({"*a": 1}, "ab"), None)
        self.assertEqual(dict_match({"??": 1}, "a"), None)
        self.assertEqual(dict_match({"[ab]": 1}, "c"), None)
        self.assertEqual(dict_match({"[ab]": 1}, "[ab]"), None)


class Tenum(TestCase):

    def test_enum(self):
        @enum
        class Foo(object):
            FOO = 1
            BAR = 3

        self.assertEqual(Foo.FOO, 1)
        self.assertTrue(isinstance(Foo.FOO, Foo))
        self.assertEqual(repr(Foo.FOO), "<Foo.FOO: 1>")
        self.assertEqual(repr(Foo(3)), "<Foo.BAR: 3>")
        self.assertEqual(repr(Foo(42)), "42")
        self.assertEqual(str(Foo(42)), "42")
        self.assertEqual(int(Foo(42)), 42)
        self.assertEqual(str(Foo(1)), "Foo.FOO")
        self.assertEqual(int(Foo(1)), 1)

        self.assertTrue(isinstance(str(Foo.FOO), str))
        self.assertTrue(isinstance(repr(Foo.FOO), str))


class Tflags(TestCase):

    def test_enum(self):
        @flags
        class Foo(object):
            FOO = 1
            BAR = 2

        self.assertEqual(Foo.FOO, 1)
        self.assertTrue(isinstance(Foo.FOO, Foo))
        self.assertEqual(repr(Foo.FOO), "<Foo.FOO: 1>")
        self.assertEqual(repr(Foo(3)), "<Foo.FOO | Foo.BAR: 3>")
        self.assertEqual(repr(Foo(42)), "<Foo.BAR | 40: 42>")
        self.assertEqual(str(Foo(42)), "Foo.BAR | 40")
        self.assertEqual(int(Foo(42)), 42)
        self.assertEqual(str(Foo(1)), "Foo.FOO")
        self.assertEqual(int(Foo(1)), 1)
        self.assertEqual(str(Foo(0)), "0")

        self.assertTrue(isinstance(str(Foo.FOO), str))
        self.assertTrue(isinstance(repr(Foo.FOO), str))


class Tverify_fileobj(TestCase):

    def test_verify_fileobj_fail(self):
        self.assertRaises(ValueError, verify_fileobj, object())
        with tempfile.TemporaryFile(mode="rb") as h:
            self.assertRaises(ValueError, verify_fileobj, h, writable=True)

    def test_verify_fileobj(self):
        with tempfile.TemporaryFile(mode="rb") as h:
            verify_fileobj(h)

        with tempfile.TemporaryFile(mode="rb+") as h:
            verify_fileobj(h, writable=True)


class Tfileobj_name(TestCase):

    def test_fileobj_name_other_type(self):

        class Foo(object):
            name = 123

        self.assertEqual(fileobj_name(Foo()), "123")

    def test_fileobj_name(self):
        with tempfile.TemporaryFile(mode="rb") as h:
            self.assertEqual(fileobj_name(h), str(h.name))


class Tseek_end(TestCase):

    def file(self, contents):
        temp = tempfile.TemporaryFile()
        temp.write(contents)
        temp.flush()
        temp.seek(0)
        return temp

    def test_seek_end(self):
        with self.file(b"foo") as f:
            seek_end(f, 2)
            self.assertEqual(f.tell(), 1)
            seek_end(f, 3)
            self.assertEqual(f.tell(), 0)
            seek_end(f, 4)
            self.assertEqual(f.tell(), 0)
            seek_end(f, 0)
            self.assertEqual(f.tell(), 3)
            self.assertRaises(ValueError, seek_end, f, -1)

    def test_seek_end_pos(self):
        with self.file(b"foo") as f:
            f.seek(10)
            seek_end(f, 10)
            self.assertEqual(f.tell(), 0)


class Tloadfile(TestCase):

    def test_handle_readwrite_notsup(self):

        @loadfile(method=False, writable=True)
        def file_func(filething):
            fileobj = filething.fileobj
            assert fileobj.read(3) == b"foo"
            fileobj.seek(0, 2)
            fileobj.write(b"bar")

        # first a normal test
        filename = get_temp_empty()
        try:
            with open(filename, "wb") as h:
                h.write(b"foo")
            file_func(filename)
            with open(filename, "rb") as h:
                assert h.read() == b"foobar"
        finally:
            os.unlink(filename)

        # now we mock open to return raise EOPNOTSUPP in case of mixed mode.
        # things should still work since we edit the file in memory
        raised = []
        old_open = open

        def mock_open(name, mode, *args):
            if "+" in mode:
                raised.append(True)
                raise IOError(errno.EOPNOTSUPP, "nope")
            return old_open(name, mode, *args)

        builtins.open = mock_open
        try:
            filename = get_temp_empty()
            try:
                with open(filename, "wb") as h:
                    h.write(b"foo")
                file_func(filename)
                with open(filename, "rb") as h:
                    assert h.read() == b"foobar"
            finally:
                os.unlink(filename)
        finally:
            builtins.open = old_open

        assert raised

    def test_filename_from_fspath(self):

        class FilePath(object):
            def __init__(self, filename):
                self.filename = filename

            def __fspath__(self):
                return self.filename

        @loadfile(method=False, writable=True)
        def file_func(filething):
            fileobj = filething.fileobj
            assert fileobj.read(3) == b"foo"
            fileobj.seek(0, 2)
            fileobj.write(b"bar")

        filename = get_temp_empty()
        try:
            with open(filename, "wb") as h:
                h.write(b"foo")
            file_func(FilePath(filename))
            with open(filename, "rb") as h:
                assert h.read() == b"foobar"
        finally:
            os.unlink(filename)

        with pytest.raises(TypeError, match=r'.*__fspath__.*'):
            file_func(FilePath(42))


class Tread_full(TestCase):

    def test_read_full(self):
        fileobj = BytesIO()
        self.assertRaises(ValueError, read_full, fileobj, -3)
        self.assertRaises(IOError, read_full, fileobj, 3)


class Tget_size(TestCase):

    def test_get_size(self):
        f = BytesIO(b"foo")
        f.seek(1, 0)
        self.assertEqual(f.tell(), 1)
        self.assertEqual(get_size(f), 3)
        self.assertEqual(f.tell(), 1)


class Tencode_endian(TestCase):

    def test_other(self):
        assert encode_endian(u"\xe4", "latin-1") == b"\xe4"
        assert encode_endian(u"\xe4", "utf-8") == b"\xc3\xa4"
        with self.assertRaises(LookupError):
            encode_endian(u"", "nopenope")
        with self.assertRaises(UnicodeEncodeError):
            assert encode_endian(u"\u2714", "latin-1")
        assert encode_endian(u"\u2714", "latin-1", "replace") == b"?"

    def test_utf_16(self):
        assert encode_endian(u"\xe4", "utf-16", le=True) == b"\xff\xfe\xe4\x00"
        assert encode_endian(u"\xe4", "utf-16-le") == b"\xe4\x00"
        assert encode_endian(
            u"\xe4", "utf-16", le=False) == b"\xfe\xff\x00\xe4"
        assert encode_endian(u"\xe4", "utf-16-be") == b"\x00\xe4"

    def test_utf_32(self):
        assert encode_endian(u"\xe4", "utf-32", le=True) == \
            b"\xff\xfe\x00\x00\xe4\x00\x00\x00"
        assert encode_endian(u"\xe4", "utf-32-le") == b"\xe4\x00\x00\x00"
        assert encode_endian(
            u"\xe4", "utf-32", le=False) == b"\x00\x00\xfe\xff\x00\x00\x00\xe4"
        assert encode_endian(u"\xe4", "utf-32-be") == b"\x00\x00\x00\xe4"


class Tdecode_terminated(TestCase):

    def test_all(self):
        values = [u"", u"", u"\xe4", u"abc", u"", u""]

        for codec in ["utf8", "utf-8", "utf-16", "latin-1", "utf-16be"]:
            # NULL without the BOM
            term = u"\x00".encode(codec)[-2:]
            data = b"".join(v.encode(codec) + term for v in values)

            for v in values:
                dec, data = decode_terminated(data, codec)
                self.assertEqual(dec, v)
            self.assertEqual(data, b"")

    def test_invalid(self):
        # invalid
        self.assertRaises(
            UnicodeDecodeError, decode_terminated, b"\xff", "utf-8")
        # truncated
        self.assertRaises(
            UnicodeDecodeError, decode_terminated, b"\xff\xfe\x00", "utf-16")
        # not null terminated
        self.assertRaises(ValueError, decode_terminated, b"abc", "utf-8")
        self.assertRaises(
            ValueError, decode_terminated, b"\xff\xfea\x00", "utf-16")
        # invalid encoding
        self.assertRaises(LookupError, decode_terminated, b"abc", "foobar")

    def test_lax(self):
        # missing termination
        self.assertEqual(
            decode_terminated(b"abc", "utf-8", strict=False), (u"abc", b""))

        # missing termination and truncated data
        truncated = u"\xe4\xe4".encode("utf-8")[:-1]
        self.assertRaises(
            UnicodeDecodeError, decode_terminated,
            truncated, "utf-8", strict=False)


class TBitReader(TestCase):

    def test_bits(self):
        data = b"\x12\x34\x56\x78\x89\xAB\xCD\xEF"
        ref = cdata.uint64_be(data)

        for i in range(64):
            fo = BytesIO(data)
            r = BitReader(fo)
            v = r.bits(i) << (64 - i) | r.bits(64 - i)
            self.assertEqual(v, ref)

    def test_bits_null(self):
        r = BitReader(BytesIO(b""))
        self.assertEqual(r.bits(0), 0)

    def test_bits_error(self):
        r = BitReader(BytesIO(b""))
        self.assertRaises(ValueError, r.bits, -1)

    def test_bytes_error(self):
        r = BitReader(BytesIO(b""))
        self.assertRaises(ValueError, r.bytes, -1)

    def test_skip_error(self):
        r = BitReader(BytesIO(b""))
        self.assertRaises(ValueError, r.skip, -1)

    def test_read_too_much(self):
        r = BitReader(BytesIO(b""))
        self.assertEqual(r.bits(0), 0)
        self.assertRaises(BitReaderError, r.bits, 1)

    def test_skip(self):
        r = BitReader(BytesIO(b"\xEF"))
        r.skip(4)
        self.assertEqual(r.bits(4), 0xf)

    def test_skip_more(self):
        r = BitReader(BytesIO(b"\xAB\xCD"))
        self.assertEqual(r.bits(4), 0xa)
        r.skip(8)
        self.assertEqual(r.bits(4), 0xd)
        self.assertRaises(BitReaderError, r.bits, 1)

    def test_skip_too_much(self):
        r = BitReader(BytesIO(b"\xAB\xCD"))
        # aligned skips don't fail, but the following read will
        r.skip(32 + 8)
        self.assertRaises(BitReaderError, r.bits, 1)
        self.assertRaises(BitReaderError, r.skip, 1)

    def test_bytes(self):
        r = BitReader(BytesIO(b"\xAB\xCD\xEF"))
        self.assertEqual(r.bytes(2), b"\xAB\xCD")
        self.assertEqual(r.bytes(0), b"")

    def test_bytes_unaligned(self):
        r = BitReader(BytesIO(b"\xAB\xCD\xEF"))
        r.skip(4)
        self.assertEqual(r.bytes(2), b"\xBC\xDE")

    def test_get_position(self):
        r = BitReader(BytesIO(b"\xAB\xCD"))
        self.assertEqual(r.get_position(), 0)
        r.bits(3)
        self.assertEqual(r.get_position(), 3)
        r.skip(9)
        self.assertEqual(r.get_position(), 3 + 9)
        r.align()
        self.assertEqual(r.get_position(), 16)

    def test_align(self):
        r = BitReader(BytesIO(b"\xAB\xCD\xEF"))
        r.skip(3)
        self.assertEqual(r.align(), 5)
        self.assertEqual(r.get_position(), 8)

    def test_is_aligned(self):
        r = BitReader(BytesIO(b"\xAB\xCD\xEF"))
        self.assertTrue(r.is_aligned())

        r.skip(1)
        self.assertFalse(r.is_aligned())
        r.skip(7)
        self.assertTrue(r.is_aligned())

        r.bits(7)
        self.assertFalse(r.is_aligned())
        r.bits(1)
        self.assertTrue(r.is_aligned())


class Tverify_filename(TestCase):

    def test_verify_filename_fail(self):
        self.assertRaises(ValueError, verify_filename, object())

    def test_verify_filename(self):

        class FilePath(object):
            def __init__(self, filename):
                self.filename = filename

            def __fspath__(self):
                return self.filename

        verify_filename(FilePath("foo"))
        verify_filename("foo")
        verify_filename(b"foo")