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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
|
#!/usr/bin/env python
import datetime
import hashlib
import io
import itertools
import json
import logging
import ntpath
import os
import random
import sys
import time
import zipfile
import zlib
import pytest
import zipstream
from zipstream import ZipStream
PY36 = sys.version_info < (3, 7)
PY35 = sys.version_info < (3, 6)
FILES = [
("empty", 0),
("byte", 1),
("kbyte", 1024),
("mbyte", 1024 * 1024),
]
# Patch is_dir onto ZipInfo objects in 3.5 to make testing easier
@pytest.fixture(autouse=PY35)
def add_is_dir(monkeypatch):
monkeypatch.setattr(
zipfile.ZipInfo, "is_dir",
zipstream.ZipStreamInfo.is_dir,
raising=False
)
@pytest.fixture(scope="session")
def files(tmp_path_factory):
d = tmp_path_factory.mktemp("data")
paths = []
for f in FILES:
path = d / f[0]
data = _randbytes(f[1])
hash_ = hashlib.md5(data).hexdigest()
crc32 = zlib.crc32(data) & 0xFFFFFFFF
path.write_bytes(data)
paths.append((path, hash_, crc32))
return paths
################################
# Test helpers
################################
def _randbytes(n):
# Backported from Python 3.9
if not n:
return b""
return random.getrandbits(n * 8).to_bytes(n, "little")
def _get_zip(data):
if not isinstance(data, io.IOBase):
if not isinstance(data, (bytes, bytearray)):
data = b"".join(data)
data = io.BytesIO(data)
return zipfile.ZipFile(data)
def _verify_zip_contains(zfile, pathdata):
path, hash_, crc32 = pathdata
path = os.path.basename(str(path))
zinfo = zfile.getinfo(path)
assert zinfo.filename == path
assert zinfo.CRC == crc32
assert hashlib.md5(zfile.read(zinfo)).hexdigest() == hash_
def _assert_equal_zips(z1, z2):
assert z1.comment == z2.comment
z1i = sorted(z1.infolist(), key=lambda x: x.filename)
z2i = sorted(z2.infolist(), key=lambda x: x.filename)
assert len(z1i) == len(z2i)
for x1, x2, in zip(z1i, z2i):
assert x1.filename == x2.filename
assert x1.file_size == x2.file_size
assert x1.compress_size == x2.compress_size
assert x1.date_time == x2.date_time
assert x1.CRC == x2.CRC
assert x1.compress_type == x2.compress_type
def _gen_rand():
for x in range(10):
yield _randbytes(1024)
################################
# Tests start
################################
@pytest.mark.parametrize("ct", [
zipfile.ZIP_STORED,
zipfile.ZIP_LZMA,
zipfile.ZIP_DEFLATED,
zipfile.ZIP_BZIP2
])
def test_zipstream_compression(caplog, files, ct):
"""Test that all types of compression properly compress and extract"""
caplog.set_level(logging.WARNING)
zs = ZipStream(compress_type=ct)
for f in files:
zs.add_path(f[0])
zf = _get_zip(zs)
assert "Size mismatch" not in caplog.text
zinfos = zf.infolist()
assert len(zinfos) == len(files)
for zinfo in zinfos:
assert zinfo.compress_type == ct
for f in files:
_verify_zip_contains(zf, f)
@pytest.mark.parametrize("ct", [
zipfile.ZIP_STORED,
zipfile.ZIP_LZMA,
zipfile.ZIP_DEFLATED,
zipfile.ZIP_BZIP2
])
@pytest.mark.parametrize("cl", [None, 2])
def test_mixed_compression_and_getinfo(ct, cl):
"""Test that files are compressed using the correct method and level and
that the information from info_list accurately reflects this"""
# Make the test just test compression types on 3.6 and below
cl, TEST_CL = (None, None) if PY36 else (cl, 5)
zs = ZipStream(compress_type=ct, compress_level=cl)
zs.add(b"0", arcname="0")
zs.add(b"1", arcname="1", compress_type=zipfile.ZIP_STORED)
zs.add(b"1c", arcname="1c", compress_type=zipfile.ZIP_STORED, compress_level=TEST_CL)
zs.add(b"2", arcname="2", compress_type=zipfile.ZIP_LZMA)
zs.add(b"2c", arcname="2c", compress_type=zipfile.ZIP_LZMA, compress_level=TEST_CL)
zs.add(b"3", arcname="3", compress_type=zipfile.ZIP_DEFLATED)
zs.add(b"3c", arcname="3c", compress_type=zipfile.ZIP_DEFLATED, compress_level=TEST_CL)
zs.add(b"4", arcname="4", compress_type=zipfile.ZIP_BZIP2)
zs.add(b"4c", arcname="4c", compress_type=zipfile.ZIP_BZIP2, compress_level=TEST_CL)
zf = _get_zip(zs)
zinfos = zf.infolist()
fullinfos = zs.info_list()
assert len(zinfos) == len(fullinfos) == 9
def assert_zinfo(idx, name, compress_type, compress_level):
zi = zinfos[idx]
fi = fullinfos[idx]
assert fi["name"] == zi.filename == name
assert fi["compress_type"] == zi.compress_type == compress_type
assert fi["compress_level"] == compress_level
assert fi["compressed_size"] == zi.compress_size
assert zf.read(zi) == name.encode("utf-8")
# no compression level for stored and lzma
if ct in (zipfile.ZIP_STORED, zipfile.ZIP_LZMA):
assert_zinfo(0, "0", ct, None)
else:
assert_zinfo(0, "0", ct, cl)
assert_zinfo(1, "1", zipfile.ZIP_STORED, None)
assert_zinfo(2, "1c", zipfile.ZIP_STORED, None)
assert_zinfo(3, "2", zipfile.ZIP_LZMA, None)
assert_zinfo(4, "2c", zipfile.ZIP_LZMA, None)
assert_zinfo(5, "3", zipfile.ZIP_DEFLATED, cl)
assert_zinfo(6, "3c", zipfile.ZIP_DEFLATED, TEST_CL)
assert_zinfo(7, "4", zipfile.ZIP_BZIP2, cl)
assert_zinfo(8, "4c", zipfile.ZIP_BZIP2, TEST_CL)
@pytest.mark.parametrize("zip64", [False, True])
def test_zipstream_normal_paths(monkeypatch, files, zip64):
"""Test adding paths and iterating"""
if zip64:
monkeypatch.setattr(zipfile, "ZIP64_LIMIT", 100)
monkeypatch.setattr(zipstream.ng, "ZIP64_LIMIT", 100)
zs = ZipStream()
for f in files:
zs.add_path(f[0])
zf = _get_zip(zs)
assert len(zf.infolist()) == len(files)
for f in files:
_verify_zip_contains(zf, f)
def test_zipstream_all_then_footer_paths(files):
"""Test adding paths and iterating over all files, then footer"""
zs = ZipStream()
for f in files:
zs.add_path(f[0])
data = io.BytesIO()
data.writelines(zs.all_files())
data.writelines(zs.footer())
zf = _get_zip(data)
assert len(zf.infolist()) == len(files)
for f in files:
_verify_zip_contains(zf, f)
def test_per_file_iteration(files):
"""Test iterating per-file while adding files works"""
zs = ZipStream()
data = b""
assert zs.num_streamed() == 0
assert zs.num_queued() == 0
assert zs.is_empty()
assert not zs
zs.add("a", "a")
zs.add("b", "b")
zs.add("c", "c")
assert zs.num_streamed() == 0
assert zs.num_queued() == 3
assert not zs.is_empty()
assert zs
data += b"".join(zs.file())
assert zs.num_streamed() == 1
assert zs.num_queued() == 2
assert not zs.is_empty()
assert zs
data += b"".join(zs.all_files())
assert zs.num_streamed() == 3
assert zs.num_queued() == 0
assert not zs.is_empty()
assert zs
zs.add("d", "d")
assert zs.num_streamed() == 3
assert zs.num_queued() == 1
assert not zs.is_empty()
assert zs
data += b"".join(zs.finalize())
assert zs.num_streamed() == 4
assert zs.num_queued() == 0
assert not zs.is_empty()
assert zs
assert len(_get_zip(data).infolist()) == 4
def test_footer_empty(files):
"""Test calling footer before iterating files results in a valid but empty zip"""
zs = ZipStream()
for f in files:
zs.add_path(f[0])
data = io.BytesIO()
data.writelines(zs.footer())
# Minimum size of a zip file is 22 bytes
# (just the end of central directory record)
assert len(data.getvalue()) == 22
zf = _get_zip(data)
assert len(zf.infolist()) == 0
def test_footer_partial(files):
"""Test calling footer before iterating all files results in valid but partial zip"""
zs = ZipStream()
for f in files:
zs.add_path(f[0])
data = io.BytesIO()
data.writelines(zs.file())
data.writelines(zs.footer())
zf = _get_zip(data)
assert len(zf.infolist()) == 1
_verify_zip_contains(zf, files[0])
@pytest.mark.skipif(not PY36, reason="Tests error handling when compress_level is unavailable (Python <3.7 only)")
@pytest.mark.parametrize("ct", [
zipfile.ZIP_STORED,
zipfile.ZIP_LZMA
])
def test_compress_level_python_36(ct):
"""Test that using compress_level on <3.7 produces an error"""
with pytest.raises(ValueError, match="compress_level is not supported"):
ZipStream(compress_type=ct, compress_level=1)
zs = ZipStream(compress_type=ct)
with pytest.raises(ValueError, match="compress_level is not supported"):
zs.add_path(".", compress_level=1)
with pytest.raises(ValueError, match="compress_level is not supported"):
zs.add("data", "data.bin", compress_level=1)
# Test that basic compression still works
zs.add(b"moredata", "data.bin")
zf = _get_zip(zs)
zinfos = zf.infolist()
assert len(zinfos) == 1
assert zinfos[0].filename == "data.bin"
assert zf.read(zinfos[0]) == b"moredata"
@pytest.mark.skipif(PY36, reason="Tests compress_level (Python 3.7+ only)")
@pytest.mark.parametrize("ct", [
zipfile.ZIP_STORED,
zipfile.ZIP_LZMA
])
def test_non_effective_compression_warn(caplog, ct):
"""Test warning for non-effective compression level settings"""
caplog.set_level(logging.WARNING)
ZipStream(compress_type=ct)
assert "no effect" not in caplog.text
ZipStream(compress_type=ct, compress_level=1)
assert "no effect" in caplog.text
@pytest.mark.skipif(PY36, reason="Tests compress_level (Python 3.7+ only)")
@pytest.mark.parametrize("ct", [
zipfile.ZIP_DEFLATED,
zipfile.ZIP_BZIP2
])
def test_invalid_compression(ct):
"""Test values outside of valid ones cause an error"""
ZipStream(compress_type=ct)
invalid = [-1, 10]
if ct == zipfile.ZIP_BZIP2:
invalid.append(0)
for x in invalid:
with pytest.raises(ValueError):
ZipStream(compress_type=ct, compress_level=x)
with pytest.raises(ValueError):
ZipStream().add_path(".", compress_type=ct, compress_level=x)
with pytest.raises(ValueError):
ZipStream().add(".", arcname=".", compress_type=ct, compress_level=x)
zs = ZipStream(compress_type=ct)
with pytest.raises(ValueError):
zs.add(".", arcname=".", compress_level=x)
zs = ZipStream(compress_level=x)
with pytest.raises(ValueError):
zs.add(".", arcname=".", compress_type=ct)
def test_multibyte_and_non_ascii_characters_in_filenames():
zs = ZipStream(sized=True)
zs.add(None, "☆/")
zs.add(b"some data", "Здравствуйте")
zs.add(b"", "你好")
data = bytes(zs)
assert len(data) == len(zs)
zinfos = _get_zip(data).infolist()
assert len(zinfos) == 3
assert zinfos[0].filename == "☆/"
assert zinfos[0].is_dir()
assert zinfos[1].filename == "Здравствуйте"
assert not zinfos[1].is_dir()
assert zinfos[2].filename == "你好"
assert not zinfos[2].is_dir()
def test_adding_windows_paths(monkeypatch):
"""Test that paths ending with both \\ and / are considered folders on Windows"""
# mock os-specific path separators and recompute PATH_SEPARATORS to fake being on Windows
monkeypatch.setattr(os, "sep", ntpath.sep)
monkeypatch.setattr(os, "altsep", ntpath.altsep)
monkeypatch.setattr(zipstream.ng, "PATH_SEPARATORS", set(x for x in (os.sep, os.altsep, "/") if x))
zs = ZipStream(sized=True)
zs.add("", "a/b\\")
zs.add("", "a\\b/")
zs.add("", "a\\b\\")
zs.mkdir("a/b\\")
zs.mkdir("a\\b/")
zs.mkdir("a\\b\\")
predicted = len(zs)
actual = len(bytes(zs))
assert predicted == actual
info = zs.info_list()
assert len(info) == 6
for x in info:
assert x["name"] == "a/b/"
def test_external_attrs(tmpdir):
folder = tmpdir.mkdir("folder-frompath")
file = tmpdir.join("file-frompath")
file.write(b"")
zs = ZipStream()
zs.add_path(folder)
zs.add_path(file)
zs.add(None, "folder-fromadd/")
zs.add(b"", "file-fromadd")
# Test values:
# 0x10 = MS-DOS directory flag
# 0o40000 << 16 = d---------
# 0o40775 << 16 = drwxrwxr-x
# 0o600 << 16 = ?rw-------
zinfos = _get_zip(zs).infolist()
assert len(zinfos) == 4
assert zinfos[0].filename == "folder-frompath/"
assert zinfos[0].is_dir()
assert zinfos[0].external_attr & 0x10
assert zinfos[0].external_attr & 0o40000 << 16
assert zinfos[1].filename == "file-frompath"
assert not zinfos[1].is_dir()
assert not zinfos[1].external_attr & 0x10
assert not zinfos[1].external_attr & 0o40000 << 16
assert zinfos[2].filename == "folder-fromadd/"
assert zinfos[2].is_dir()
assert zinfos[2].external_attr & 0x10
assert zinfos[2].external_attr & 0o40775 << 16
assert zinfos[3].filename == "file-fromadd"
assert not zinfos[3].is_dir()
assert not zinfos[3].external_attr & 0x10
assert not zinfos[3].external_attr & 0o40000 << 16
assert zinfos[3].external_attr & 0o600 << 16
def test_creating_dirs_with_data():
"""Test creating directories works except when adding data to them"""
zs = ZipStream()
zs.add(None, "folder0/")
zs.add(b"", "folder1/")
zs.add("", "folder2/")
with pytest.raises(ValueError):
zs.add("data", "folder3/")
zinfos = _get_zip(zs).infolist()
assert len(zinfos) == 3
for i in range(3):
assert zinfos[i].filename == "folder{}/".format(i)
assert zinfos[i].is_dir()
assert zinfos[i].file_size == 0
assert zinfos[i].compress_size == 0
def test_mkdir():
zs = ZipStream(sized=True)
with pytest.raises(ValueError, match="A valid arcname for the directory is required"):
zs.mkdir("")
PATHS = (
"folder0", # no trailing slash
"folder1",
"folder1/sub", # into existing dir
"folder2/sub/sub/sub/", # new path
)
for p in PATHS:
zs.mkdir(p)
data = bytes(zs)
assert len(data) == len(zs)
zinfos = _get_zip(data).infolist()
assert len(zinfos) == 4
for i, p in enumerate(x.rstrip("/") + "/" for x in PATHS):
assert zinfos[i].filename == p
assert zinfos[i].is_dir()
assert zinfos[i].file_size == 0
assert zinfos[i].compress_size == 0
@pytest.mark.parametrize("arcname", ["/", "//", "///"])
def test_adding_path_slash_arcname(tmpdir, arcname):
te = tmpdir.mkdir("empty")
tne = tmpdir.mkdir("not_empty")
f = tne.join("file")
f.write(b"x")
def _getinfo(z):
data = bytes(z)
assert len(data) == len(z)
return _get_zip(data).infolist()
# empty dir - adds nothing
zs = ZipStream.from_path(te, arcname=arcname)
assert not zs
zinfos = _getinfo(zs)
assert len(zinfos) == 0
# adds the file in the dir at the top level
zs = ZipStream.from_path(tne, arcname=arcname)
assert zs
zinfos = _getinfo(zs)
assert len(zinfos) == 1
assert zinfos[0].filename == "file"
with pytest.raises(ValueError, match="A valid arcname is required"):
ZipStream.from_path(f, arcname=arcname)
@pytest.mark.parametrize("arcname", [None, "", ".", "/", "//", "///"])
def test_directly_adding_empty_dir(tmpdir, arcname):
"""Test adding an empty directory"""
t = tmpdir.mkdir("empty")
zs = ZipStream.from_path(t, arcname=arcname)
data = bytes(zs)
assert len(data) == len(zs)
zinfos = _get_zip(data).infolist()
if not arcname or arcname == ".":
assert len(zinfos) == 1
assert zinfos[0].filename == "{}/".format(arcname or "empty")
assert zinfos[0].is_dir()
assert zinfos[0].file_size == 0
assert zinfos[0].compress_size == 0
else:
# told to skip the top level with nothing under it - no data
assert len(zinfos) == 0
def test_add_path_dir_as_file(tmpdir):
t = tmpdir.mkdir("dir")
zs = ZipStream(sized=True)
zs.add_path(
t,
arcname="filename.txt",
recurse=False
)
assert zs.info_list()[0]["name"] == "filename.txt/"
assert len(zs) == len(bytes(zs))
def test_add_path_file_as_dir(tmpdir):
t = tmpdir.join("file")
t.write(b"x")
zs = ZipStream(sized=True)
zs.add_path(
t,
arcname="dir/",
recurse=False
)
assert zs.info_list()[0]["name"] == "dir"
assert len(zs) == len(bytes(zs))
def test_adding_local_dir(tmpdir):
"""Test adding files/folder from the local directory doesn't include the directory name of ."""
t = tmpdir.mkdir("top")
t.mkdir("empty")
t.mkdir("not_empty").join("file.txt").write(b"x")
os.chdir(str(t))
zs = ZipStream.from_path(".")
data = bytes(zs)
assert len(data) == len(zs)
zinfos = sorted(_get_zip(data).infolist(), key=lambda x: x.filename)
assert len(zinfos) == 2
assert zinfos[0].filename == "empty/"
assert zinfos[0].is_dir()
assert zinfos[0].file_size == 0
assert zinfos[0].compress_size == 0
assert zinfos[1].filename == "not_empty/file.txt"
assert not zinfos[1].is_dir()
assert zinfos[1].file_size == 1
assert zinfos[1].compress_size == 1
def test_empty_folders_preserved_recursive(tmpdir):
"""Test that recursively adding a directory preserves empty files and folders in it"""
t = tmpdir.mkdir("top")
t.mkdir("empty")
t.join("file.txt").write(b"")
zs = ZipStream.from_path(t)
data = bytes(zs)
assert len(data) == len(zs)
zinfos = sorted(_get_zip(data).infolist(), key=lambda x: x.filename)
assert len(zinfos) == 2
assert zinfos[0].filename == "top/empty/"
assert zinfos[0].is_dir()
assert zinfos[0].file_size == 0
assert zinfos[0].compress_size == 0
assert zinfos[1].filename == "top/file.txt"
assert not zinfos[1].is_dir()
assert zinfos[1].file_size == 0
assert zinfos[1].compress_size == 0
def test_recursion_disable(tmpdir):
"""Test that recursion can be disabled to just add a single (empty) folder"""
t = tmpdir.mkdir("top")
t.mkdir("empty")
t.join("file.txt").write(b"")
zinfos = _get_zip(ZipStream.from_path(t, recurse=False)).infolist()
assert len(zinfos) == 1
assert zinfos[0].filename == "top/"
assert zinfos[0].is_dir()
assert zinfos[0].file_size == 0
assert zinfos[0].compress_size == 0
@pytest.mark.parametrize("preserve_empty", [True, False])
@pytest.mark.parametrize("followlinks", [True, False])
def test_zipstream_walk(tmpdir, preserve_empty, followlinks):
"""Test the zipstream's walk walks the walk it talks"""
# Create directory structure
t = tmpdir.mkdir("top")
t.mkdir("empty")
t.join("empty.txt").write("")
t.join("test.txt").write("test")
f = t.mkdir("filled")
f.join("file.bin").write_binary(b"\x00\x01\xFF")
# Can't make symlinks on some platforms
symlink_support = hasattr(t, "mksymlinkto")
if symlink_support:
f.join("file2.bin").mksymlinkto("file.bin")
o = tmpdir.mkdir("othertop")
o.join("other.txt").write("other")
f.join("notevil").mksymlinkto("../../othertop")
f.join("evil").mksymlinkto("../")
def walk(path):
yield from zipstream.walk(
path,
preserve_empty=preserve_empty,
followlinks=followlinks
)
zs = ZipStream.from_path(t, recurse=walk)
data = bytes(zs)
assert len(data) == len(zs)
contents = {
x.filename: x.is_dir()
for x in _get_zip(data).infolist()
}
for name, is_dir in contents.items():
assert (name == "top/empty/") == is_dir
names = set(contents)
assert "top/empty.txt" in names
assert symlink_support == ("top/filled/file2.bin" in names)
assert "top/filled/file.bin" in names
assert "top/test.txt" in names
assert preserve_empty == ("top/empty/" in names)
assert (symlink_support and followlinks) == ("top/filled/notevil/other.txt" in names)
def test_custom_walk(tmpdir):
"""Test that custom walk functions are supported"""
t = tmpdir.mkdir("top")
t.join("1.txt").write("1")
t.join("2.txt").write("22")
t.join("3.bin").write("333")
t.join("4.txt").write("4444")
t.join("5.txt").write("55555")
t.mkdir("empty")
def custom_walk(path):
for dirpath, dirnames, files in os.walk(path):
for f in files:
if f.endswith(".bin"):
continue
fullpath = os.path.join(dirpath, f)
if os.path.getsize(fullpath) > 4:
continue
yield fullpath
if not files and not dirnames:
yield dirpath # no trailing pathsep
zs = ZipStream.from_path(t, recurse=custom_walk)
data = bytes(zs)
assert len(data) == len(zs)
zf = _get_zip(data)
assert zf.getinfo("top/empty/").is_dir()
names = sorted(x.filename for x in zf.infolist())
assert len(names) == 4
assert "top/3.bin" not in names
assert "top/5.txt" not in names
@pytest.mark.parametrize("data", [
"this is a string",
b"these are some bytes",
bytearray(b"this is a bytearray"),
[b"a", b"list", b"of", b"bytes"],
_gen_rand()
])
@pytest.mark.parametrize("ct", [
zipfile.ZIP_STORED,
zipfile.ZIP_LZMA,
zipfile.ZIP_DEFLATED,
zipfile.ZIP_BZIP2
])
def test_adding_data(caplog, data, ct):
"""Test adding non-files with different compression methods"""
caplog.set_level(logging.WARNING)
zs = ZipStream(compress_type=ct)
tostore = data
if isinstance(data, str):
# Strings will be utf-8 encoded
data = data.encode("utf-8")
elif not isinstance(data, (bytes, str, bytearray)):
# tee the iterator and get the contents from it so they can be checked
# against what's put into the stream
tostore, data = itertools.tee(data)
data = b"".join(data)
# Test arcname is required
with pytest.raises(ValueError, match="A valid arcname is required"):
zs.add(tostore, None)
with pytest.raises(ValueError, match="A valid arcname is required"):
zs.add(tostore, "")
with pytest.raises(ValueError, match="Can't store .* as a directory"):
zs.add(tostore, "directory/")
zs.add(tostore, "data.bin")
zf = _get_zip(zs)
assert "Size mismatch" not in caplog.text
zinfos = zf.infolist()
assert len(zinfos) == 1
assert zinfos[0].compress_type == ct
from_file = zf.read(zinfos[0])
assert from_file == data
@pytest.mark.parametrize("data", [0, 1, object(), type(None)])
def test_adding_invalid_data(data):
zs = ZipStream()
with pytest.raises(TypeError):
zs.add(data, "test")
@pytest.mark.parametrize("name", ["file", "directory/"])
def test_adding_broken_symlinks(tmpdir, name):
"""Test that adding a broken symlink will raise a FileNotFoundError"""
t = tmpdir.mkdir("top")
if not hasattr(t, "mksymlinkto"):
pytest.skip("mksymlinkto not supported - can't test broken links")
l = t.join(name)
l.mksymlinkto("nothing")
zs = ZipStream()
with pytest.raises(FileNotFoundError):
zs.add_path(l)
with pytest.raises(FileNotFoundError):
zs.add_path(t)
@pytest.mark.parametrize("data", [
["strs", "cannot", "be", "added"],
range(10),
ZipStream,
])
def test_adding_undetectable_invalid_data(data):
"""Test iterables that yield bad data are only detected at generation time"""
zs = ZipStream()
zs.add(data, "test")
with pytest.raises(TypeError):
list(zs)
def test_directory_links_without_infinite_recursion(tmpdir):
"""Ensure adding paths follows directory links without being vulnerable to
infinite recursion"""
t = tmpdir.mkdir("top")
if not hasattr(t, "mksymlinkto"):
pytest.skip("mksymlinkto not supported - can't test infinite recursion")
o = tmpdir.mkdir("other")
o.join("validfile").write("this is valid")
b = t.mkdir("mid").mkdir("bottom")
# Create cycle
b.join("evil").mksymlinkto("../../../")
# Create valid dirlink
b.join("notevil").mksymlinkto("../../../other")
pathnames = (
"top/mid/bottom/evil/",
"top/mid/bottom/notevil/validfile"
)
zs = ZipStream.from_path(t)
data = bytes(zs)
assert len(data) == len(zs)
zinfos = sorted(_get_zip(data).infolist(), key=lambda x: x.filename)
assert len(zinfos) == len(pathnames)
for x, n in zip(zinfos, pathnames):
assert x.filename == n
if "/validfile" in n:
assert not x.is_dir()
assert x.file_size != 0
assert x.compress_size != 0
else:
assert x.is_dir()
assert x.file_size == 0
assert x.compress_size == 0
def test_adding_missing_path(tmpdir):
with pytest.raises(FileNotFoundError):
ZipStream.from_path(tmpdir.join("doesntexist"))
def test_adding_deleted_path(tmpdir):
zs = ZipStream(sized=True)
f = tmpdir.join("file")
f.write(b"this is some data")
zs.add_path(f)
assert len(zs) == 139
f.remove()
assert len(zs) == 139
with pytest.raises(FileNotFoundError):
bytes(zs)
def test_adding_empty_name(tmpdir, monkeypatch):
"""Test that when trying to discover an arcname for a path empty names raise an error"""
monkeypatch.setattr(os.path, "basename", lambda _: "")
zs = ZipStream(sized=True)
for recurse in (False, True):
with pytest.raises(ValueError, match="No arcname for path .* could be assumed"):
zs.add_path(tmpdir, recurse=recurse)
with pytest.raises(ValueError, match="No arcname for path .* could be assumed"):
zs.add_path(tmpdir, arcname="", recurse=recurse)
def test_adding_null_byte_name():
zs = ZipStream(sized=True)
zs.add(b"data", "file.txt\x00and more")
with pytest.raises(ValueError, match="A valid arcname is required"):
zs.add(b"otherdata", "\x00nofilename")
zs.mkdir("directory\x00and more")
with pytest.raises(ValueError, match="A valid arcname for the directory is required"):
zs.mkdir("\x00nodirectory")
expected_len = len(zs)
data = bytes(zs)
assert len(data) == expected_len
zinfos = sorted(_get_zip(data).infolist(), key=lambda x: x.filename)
assert len(zinfos) == 2
assert zinfos[0].filename == "directory/"
assert zinfos[0].file_size == 0
assert zinfos[0].is_dir()
assert zinfos[1].filename == "file.txt"
assert zinfos[1].file_size == 4
assert not zinfos[1].is_dir()
@pytest.mark.parametrize("data", [
("short text", "then longer text"),
("first longer text", "then shorter"),
])
@pytest.mark.parametrize("sized", (True, False))
def test_adding_changed_path(caplog, tmpdir, sized, data):
caplog.set_level(logging.WARNING)
zs = ZipStream(sized=sized)
f = tmpdir.join("file")
f.write(data[0])
zs.add_path(f)
f.write(data[1]) # overwrites, doesn't append
assert not caplog.text
if sized:
with pytest.raises(RuntimeError, match="Error adding 'file' to sized ZipStream"):
bytes(zs)
else:
bytes(zs)
msg = "Size mismatch when adding data for 'file' (expected {} bytes, got {})".format(
len(data[0]),
len(data[1])
)
assert msg in caplog.text
@pytest.mark.parametrize("sized", (True, False))
@pytest.mark.parametrize("size", (None, -1, 0, 1, 100))
def test_adding_iterator_invalid_size(caplog, sized, size):
"""Make sure errors are raised when generating if an incorrect iterator size was provided"""
caplog.set_level(logging.WARNING)
l_rand = len(b"".join(_gen_rand()))
zs = ZipStream(sized=sized)
zs.add(_gen_rand(), "rand.txt", size=size)
assert not caplog.text
if sized and size is not None:
with pytest.raises(RuntimeError, match="Error adding 'rand.txt' to sized ZipStream"):
bytes(zs)
else:
bytes(zs)
# only emits a warning when size was specfied
assert (size is not None) == ("Size mismatch when adding data for 'rand.txt'" in caplog.text)
def test_adding_iterator_invalid_size_underestimate_zip64(monkeypatch):
"""Make sure that if an iterator size that doesn't require zip64 is given
and the data from it does, a RuntimeError is raised"""
monkeypatch.setattr(zipfile, "ZIP64_LIMIT", 100)
monkeypatch.setattr(zipstream.ng, "ZIP64_LIMIT", 100)
zs = ZipStream(sized=False)
zs.add(_gen_rand(), "rand.txt", size=1)
with pytest.raises(RuntimeError, match="Adding file 'rand.txt' unexpectedly required using Zip64 extensions"):
bytes(zs)
def test_underestimate_zip64_via_compression(monkeypatch):
"""Test that underestimating compresed size raises a RuntimeError"""
# compressed data can be bigger than uncompressed data. This generally only
# happens with small amounts of data but can with large amounts of data as
# well. This is less of a test and more of a demonstration of why the
# estimation factor is needed
monkeypatch.setattr(zipfile, "ZIP64_LIMIT", 10)
monkeypatch.setattr(zipstream.ng, "ZIP64_LIMIT", 10)
ZEROS = "0" * 10
NUMS = "0123456789"
def _make_zip(content):
zs = ZipStream(compress_type=zipfile.ZIP_DEFLATED)
zs.add(content, "file.txt")
bytes(zs)
assert len(ZEROS) == len(NUMS)
_make_zip(ZEROS)
_make_zip(NUMS)
# remove overestimation
monkeypatch.setattr(zipstream.ng, "ZIP64_ESTIMATE_FACTOR", 1)
_make_zip(ZEROS)
with pytest.raises(RuntimeError, match="Adding file 'file.txt' unexpectedly required using Zip64 extensions"):
_make_zip(NUMS)
def test_adding_comment(caplog):
caplog.set_level(logging.WARNING)
zs = ZipStream()
zs.comment = "test"
assert zs.comment == "test".encode("utf-8")
zs.comment = None
assert not zs.comment
with pytest.raises(TypeError):
zs.comment += "test"
zs.comment += "test".encode("utf-8")
zs.comment = None
assert not zs.comment
zs.comment = bytearray(b"test")
assert zs.comment == "test".encode("utf-8")
c = b"this is a test with a big comment" + bytes(zipfile.ZIP_MAX_COMMENT)
l = len(c)
assert "too long" not in caplog.text
zs.comment = c
assert "too long" in caplog.text
assert len(zs.comment) != l
assert len(zs.comment) == zipfile.ZIP_MAX_COMMENT
with pytest.raises(TypeError):
zs.comment = 10
def test_finalizing():
# Finalize by iteration
zs = ZipStream()
_get_zip(zs)
assert zs._final
# Finalize explicitly
zs = ZipStream()
_get_zip(zs.finalize())
assert zs._final
# Finalize using footer
zs = ZipStream()
_get_zip(zs.footer())
assert zs._final
# Doesn't finalize if just asking for file data
data = b""
zs = ZipStream()
zs.add("", "a")
data += b"".join(zs.file())
assert not zs._final
data += b"".join(zs.file())
assert not zs._final
zs.add("", "b")
data += b"".join(zs.all_files())
assert not zs._final
data += b"".join(zs.footer())
assert zs._final
_get_zip(data)
def test_adding_after_complete():
"""Test that adding files/changing the comment after the stream has been
finalized is an error"""
zs = ZipStream()
list(zs)
assert zs._final
with pytest.raises(RuntimeError):
zs.add("", "b")
with pytest.raises(RuntimeError):
zs.add_path(".")
with pytest.raises(RuntimeError):
zs.comment = "comment"
def test_asking_for_files_after_complete():
"""Test that trying to iterate files after the stream has been finalized
returns nothing"""
zs = ZipStream()
list(zs)
assert zs._final
assert not list(zs)
assert not list(zs.file())
assert not list(zs.all_files())
assert not list(zs.footer())
assert not list(zs.finalize())
def test_last_modified(monkeypatch, files):
"""Test that the last_modified property correctly reflects the dates of the
files in the archive"""
dates = {
"a": (2000, 1, 1, 1, 1, 1),
"b": (2000, 3, 1, 1, 1, 1),
"c": (2000, 2, 1, 1, 1, 1),
"d": (2107, 12, 31, 23, 59, 59),
}
zs = ZipStream()
assert zs.last_modified is None
orig_localtime = time.localtime
monkeypatch.setattr(time, "localtime", lambda _=None: dates["a"])
zs.add("a", "a.txt")
assert zs.last_modified == datetime.datetime(*dates["a"])
monkeypatch.setattr(time, "localtime", lambda _=None: dates["b"])
zs.add("b", "b.txt")
assert zs.last_modified == datetime.datetime(*dates["b"])
monkeypatch.setattr(time, "localtime", lambda _=None: dates["c"])
zs.add("c", "c.txt")
assert zs.last_modified == datetime.datetime(*dates["b"])
monkeypatch.setattr(time, "localtime", orig_localtime)
latest_file = 0
for f in files:
path = f[0]
mtime = path.stat().st_mtime
if mtime > latest_file:
latest_file = mtime
zs.add_path(path)
assert zs.last_modified == datetime.datetime.fromtimestamp(int(latest_file))
monkeypatch.setattr(time, "localtime", lambda _=None: dates["d"])
zs.add("d", "d.txt")
assert zs.last_modified == datetime.datetime(*dates["d"])
zinfos = _get_zip(zs).infolist()
assert len(zinfos) == len(files) + len(dates)
@pytest.mark.parametrize("date", [
(0, 0, 0, 0, 0, 0),
(1979, 12, 31, 23, 59, 59),
(1980, 0, 0 ,0, 0, 0), # breaks zipfile.ZipFile
(2107, 99, 0, 0, 0, 0), # breaks zipfile.ZipFile
(2108, 0, 0, 0, 0, 0),
(9999, 99, 99 ,99, 99, 99),
])
def test_invalid_dates(monkeypatch, date):
"""Test that dates outside the range that the zip format supports are
automatically clamped to the closest valid value"""
def fakelocaltime(_=None):
return date
monkeypatch.setattr(time, "localtime", fakelocaltime)
zs = ZipStream()
zs.add("a", "a.txt")
zinfos = _get_zip(zs).infolist()
assert len(zinfos) == 1
if date < (2000, 1, 1, 0, 0, 0):
assert zinfos[0].date_time == (1980, 1, 1, 0, 0, 0)
else:
# The seconds are 58 instead of 59 because times encoded in zip files
# only have 2 second precision (rounded down)
assert zinfos[0].date_time == (2107, 12, 31, 23, 59, 58)
def test_info_list(monkeypatch):
faketime = (1980, 1, 1, 0, 0, 0)
def fakelocaltime(_=None):
return faketime
monkeypatch.setattr(time, "localtime", fakelocaltime)
data = bytearray()
zs = ZipStream(compress_type=zipfile.ZIP_STORED)
zs.add(None, "empty/", compress_type=zipfile.ZIP_DEFLATED)
zs.add(b"test", "text.txt", compress_type=zipfile.ZIP_BZIP2, compress_level=5 if not PY36 else None)
zs.add(b"test", "text2.txt")
info = list(zs.info_list())
assert len([x for x in info if not x["streamed"]]) == zs.num_queued() == 3
assert len([x for x in info if x["streamed"]]) == zs.num_streamed() == 0
assert info[0] == {
"name": "empty/",
"size": 0,
"compressed_size": 0,
"datetime": None,
"is_dir": True,
"CRC": None,
"compress_type": zipfile.ZIP_DEFLATED,
"compress_level": None,
"streamed": False,
}
assert info[1] == {
"name": "text.txt",
"size": 4,
"compressed_size": None,
"datetime": None,
"is_dir": False,
"CRC": None,
"compress_type": zipfile.ZIP_BZIP2,
"compress_level": 5 if not PY36 else None,
"streamed": False,
}
assert info[2] == {
"name": "text2.txt",
"size": 4,
"compressed_size": 4,
"datetime": None,
"is_dir": False,
"CRC": None,
"compress_type": zipfile.ZIP_STORED,
"compress_level": None,
"streamed": False,
}
data += b"".join(zs.all_files())
info2 = list(zs.info_list())
assert len([x for x in info2 if not x["streamed"]]) == zs.num_queued() == 0
assert len([x for x in info2 if x["streamed"]]) == zs.num_streamed() == 3
# Make sure any information that ws provided up-front hasn't changed
# (except for the "streamed" key which mush got False -> True)
for pre, post in zip(info, info2):
for k, v in pre.items():
if k == "streamed":
assert not v
assert post[k]
elif v is not None:
assert post[k] == v
assert info2[0] == {
"name": "empty/",
"size": 0,
"compressed_size": 0,
"datetime": faketime,
"is_dir": True,
"CRC": 0,
"compress_type": zipfile.ZIP_DEFLATED,
"compress_level": None,
"streamed": True,
}
assert info2[1] == {
"name": "text.txt",
"size": 4,
"compressed_size": 40,
"datetime": faketime,
"is_dir": False,
"CRC": 3632233996,
"compress_type": zipfile.ZIP_BZIP2,
"compress_level": 5 if not PY36 else None,
"streamed": True,
}
assert info2[2] == {
"name": "text2.txt",
"size": 4,
"compressed_size": 4,
"datetime": faketime,
"is_dir": False,
"CRC": 3632233996,
"compress_type": zipfile.ZIP_STORED,
"compress_level": None,
"streamed": True,
}
zs.add(json.dumps(info2, indent=2), "manifest.json")
assert zs.num_queued() == 1
data += bytes(zs)
assert zs.num_queued() == 0
assert len(zs.info_list()) == 4
zinfos = _get_zip(data).infolist()
assert len(zinfos) == 4
def test_get_info(monkeypatch):
faketime = (1980, 1, 1, 0, 0, 0)
def fakelocaltime(_=None):
return faketime
monkeypatch.setattr(time, "localtime", fakelocaltime)
data = bytearray()
zs = ZipStream(compress_type=zipfile.ZIP_STORED)
zs.add(None, "empty/", compress_type=zipfile.ZIP_DEFLATED)
zs.add(b"test", "text.txt", compress_type=zipfile.ZIP_BZIP2, compress_level=5 if not PY36 else None)
zs.add(b"test", "text2.txt")
assert zs.num_queued() == 3
with pytest.warns(DeprecationWarning, match="ZipStream.info_list"):
assert len(zs.get_info()) == 0
data += b"".join(zs.all_files())
assert zs.num_queued() == 0
with pytest.warns(DeprecationWarning, match="ZipStream.info_list"):
info = zs.get_info()
assert len(info) == 3
assert info[0] == {
"name": "empty/",
"size": 0,
"compressed_size": 0,
"datetime": "1980-01-01T00:00:00",
"CRC": 0,
"compress_type": zipfile.ZIP_DEFLATED,
"compress_level": None,
"extract_version": zipfile.DEFAULT_VERSION
}
assert info[1] == {
"name": "text.txt",
"size": 4,
"compressed_size": 40,
"datetime": "1980-01-01T00:00:00",
"CRC": 3632233996,
"compress_type": zipfile.ZIP_BZIP2,
"compress_level": 5 if not PY36 else None,
"extract_version": zipfile.BZIP2_VERSION
}
assert info[2] == {
"name": "text2.txt",
"size": 4,
"compressed_size": 4,
"datetime": "1980-01-01T00:00:00",
"CRC": 3632233996,
"compress_type": zipfile.ZIP_STORED,
"compress_level": None,
"extract_version": zipfile.DEFAULT_VERSION
}
zs.add(json.dumps(info, indent=2), "manifest.json")
assert zs.num_queued() == 1
data += bytes(zs)
assert zs.num_queued() == 0
with pytest.warns(DeprecationWarning, match="ZipStream.info_list"):
assert len(zs.get_info()) == 4
zinfos = _get_zip(data).infolist()
assert len(zinfos) == 4
@pytest.mark.skipif(PY35, reason="Requires zipfiles to support unseekable streams (Python 3.6+ only)")
def test_readme_stdlib_comparison(tmpdir):
"""Make sure the comparison is accurate"""
# Set up the stdlib version scaffolding
from zipfile import ZipFile, ZipInfo
class Stream(io.RawIOBase):
"""An unseekable stream for the ZipFile to write to"""
def __init__(self):
self._buffer = bytearray()
self._closed = False
def close(self):
self._closed = True
def write(self, b):
if self._closed:
raise ValueError("Can't write to a closed stream")
self._buffer += b
return len(b)
def readall(self):
chunk = bytes(self._buffer)
self._buffer.clear()
return chunk
def iter_files(path):
for dirpath, _, files in os.walk(path, followlinks=True):
if not files:
yield dirpath # Preserve empty directories
for f in files:
yield os.path.join(dirpath, f)
def read_file(path):
with open(path, "rb") as fp:
while True:
buf = fp.read(1024 * 64)
if not buf:
break
yield buf
def generate_zipstream(path):
stream = Stream()
with ZipFile(stream, mode="w") as zf:
toplevel = os.path.basename(os.path.normpath(path))
for f in iter_files(path):
# Use the basename of the path to set the arcname
arcname = os.path.join(toplevel, os.path.relpath(f, path))
zinfo = ZipInfo.from_file(f, arcname)
# Write data to the zip file then yield the stream content
with zf.open(zinfo, mode="w") as fp:
if zinfo.is_dir():
continue
for buf in read_file(f):
fp.write(buf)
yield stream.readall()
yield stream.readall()
# Create directory structure
t = tmpdir.mkdir("top")
t.mkdir("empty")
t.join("empty.txt").write("")
t.join("test.txt").write("test")
f = t.mkdir("filled")
f.join("file.bin").write_binary(b"\x00\x01\xFF")
# Can't make symlinks on some platforms
if hasattr(t, "mksymlinkto"):
f.join("file2.bin").mksymlinkto("file.bin")
o = tmpdir.mkdir("othertop")
o.join("other.txt").write("other")
f.join("notevil").mksymlinkto("../../othertop")
# TODO: make stdlib version handle infinte loops
#f.join("evil").mksymlinkto("../")
_assert_equal_zips(
_get_zip(generate_zipstream(t)),
_get_zip(ZipStream.from_path(t))
)
def test_add_duplicate_file():
"""Test adding multiple files with the same name works"""
zs = ZipStream(sized=True)
zs.add(b"test", "test.txt")
zs.add(b"another test", "test.txt")
calculated = len(zs)
data = bytes(zs)
assert len(data) == calculated
zf = _get_zip(data)
zinfos = zf.infolist()
assert len(zinfos) == 2
assert zf.read(zinfos[0]) == b"test"
assert zf.read(zinfos[1]) == b"another test"
def test_unsized_zipstream_len_typeerror():
"""Test that an unsized ZipStream raises a TypeError when asked for the length"""
zs = ZipStream(sized=False)
assert not zs.sized
with pytest.raises(TypeError):
len(ZipStream(sized=False))
@pytest.mark.parametrize("zip64", [False, True])
@pytest.mark.parametrize("sized", [False, True])
@pytest.mark.parametrize("known_size", [False, True])
def test_proper_zip64_min_version(monkeypatch, zip64, sized, known_size):
"""Ensure that the zip64 extensions are used when needed and the min
version is set accordingly
"""
if zip64:
monkeypatch.setattr(zipfile, "ZIP64_LIMIT", 100)
monkeypatch.setattr(zipstream.ng, "ZIP64_LIMIT", 100)
zs = ZipStream(sized=sized)
size = None if not known_size else len(b"".join(_gen_rand()))
zs.add(_gen_rand(), "rand.txt", size=size)
zi = _get_zip(zs).infolist()[0]
# A sized zipstream will always pull the entire iterator into memory and
# realize that zip64 is not required. Likewise if the size of the iterator
# is known.
# An unsized zipstream will not pull it into memory and be forced to use
# zip64 extensions if the size of the iterator is unknown since the size
# could be too big.
expected_version = (zipfile.DEFAULT_VERSION if not zip64 and (sized or known_size) else zipfile.ZIP64_VERSION)
assert zi.create_version == expected_version
assert zi.extract_version == expected_version
@pytest.mark.parametrize("sized", [False, True])
@pytest.mark.parametrize("known_size", [False, True])
def test_adding_iterator_sized(sized, known_size):
"""Check that adding an iterator to the ZipStream only immediately reads it
into memory if the ZipStream is sized and the size isn't provided
"""
read = False
def _my_iter():
nonlocal read
yield from _gen_rand()
read = True
l_rand = len(b"".join(_gen_rand()))
zs = ZipStream(sized=sized)
zs.add(_my_iter(), "rand.txt", size=None if not known_size else l_rand)
assert read == (False if known_size else sized)
bytes(zs)
assert read
@pytest.mark.parametrize("zip64", [False, True])
def test_sized_zipstream(monkeypatch, files, zip64):
"""Test a sized ZipStream accurately calculates its final size"""
if zip64:
monkeypatch.setattr(zipfile, "ZIP64_LIMIT", 100)
monkeypatch.setattr(zipstream.ng, "ZIP64_LIMIT", 100)
with pytest.raises(ValueError):
ZipStream(sized=True, compress_type=zipfile.ZIP_DEFLATED)
with pytest.raises(ValueError):
ZipStream(sized=True, compress_type=zipfile.ZIP_LZMA)
with pytest.raises(ValueError):
ZipStream(sized=True, compress_type=zipfile.ZIP_BZIP2)
with pytest.raises(ValueError):
ZipStream.from_path(".", sized=True, compress_type=zipfile.ZIP_DEFLATED)
szs = ZipStream(sized=True)
for f in files:
szs.add_path(f[0])
# Specifying null/useless compression works
szs.add(None, "a_dir/", compress_type=zipfile.ZIP_STORED)
szs.add(_gen_rand(), "random.txt", compress_type=None)
szs.add(b"data", "data.bin", compress_level=None)
szs.add("text", "data.text", compress_level=10 if not PY36 else None)
# Specifying any actual compression raises errors
with pytest.raises(ValueError):
szs.add("invalid", "invalid", compress_type=zipfile.ZIP_DEFLATED)
with pytest.raises(ValueError):
szs.add("invalid", "invalid", compress_type=zipfile.ZIP_LZMA)
with pytest.raises(ValueError):
szs.add("invalid", "invalid", compress_type=zipfile.ZIP_BZIP2)
assert szs.sized
calculated = len(szs)
data = bytes(szs)
assert calculated == len(data)
zf = _get_zip(data)
for f in files:
_verify_zip_contains(zf, f)
assert len(zf.infolist()) == len(files) + 4
@pytest.mark.parametrize("zip64", [False, True])
def test_sized_zipstream_size_while_adding(monkeypatch, files, zip64):
"""Test a sized ZipStream accurately calculates its final size while adding
files"""
if zip64:
monkeypatch.setattr(zipfile, "ZIP64_LIMIT", 100)
monkeypatch.setattr(zipstream.ng, "ZIP64_LIMIT", 100)
# Get sizes of zips with a subset of files in them
sizes = []
for l in range(len(files) + 1):
szs = ZipStream(sized=True)
for i in range(l):
szs.add_path(files[i][0])
s = len(szs)
assert s == sum(len(x) for x in szs)
sizes.append(s)
if zip64:
# files > 100b use zip64 extensions, requiring more space
assert sizes == [22, 124, 301, 1483, 1050217]
else:
assert sizes == [22, 124, 225, 1351, 1050029]
# Add files and check the sizes match the above values
szs = ZipStream(sized=True)
assert sizes[0] == len(szs)
for i, f in enumerate(files, 1):
szs.add_path(f[0])
assert sizes[i] == len(szs)
# make sure adding comment adds to the size
szs.comment = "this is a comment"
assert sizes[-1] + len(szs.comment) == len(szs)
# check against size of actual generated bytes
calculated = len(szs)
data = bytes(szs)
assert calculated == len(data)
# check contents
zf = _get_zip(data)
assert len(zf.infolist()) == len(files)
for f in files:
_verify_zip_contains(zf, f)
# Warning: skipped because it creates a 4GB+ temp file
@pytest.mark.skip
def test_zip64_real(tmpdir):
"""Test compressing a large file using Zip64 extensions works"""
large_file = tmpdir.join("large.bin")
zip_file = tmpdir.join("out.zip")
# Generate a big empty file that requires Zip64 extensions to handle
# bookended by 1MB of random data. Also generate a small file with random
# data to test the header offset of it being over non-zip64 limits.
datasize = 1024 * 1024
startdata = _randbytes(datasize)
enddata = _randbytes(datasize)
smalldata = _randbytes(datasize)
# Write large file
with open(str(large_file), "wb") as fp:
fp.write(startdata)
fp.seek(zipfile.ZIP64_LIMIT, io.SEEK_CUR)
fp.write(enddata)
# Write as a stream to a zip file
zs = ZipStream(sized=True)
zs.add_path(large_file)
zs.add(smalldata, "small.bin")
calculated = len(zs)
l = 0
with open(str(zip_file), "wb") as fp:
for chunk in zs:
l += len(chunk)
fp.write(chunk)
assert l == calculated
with zipfile.ZipFile(str(zip_file), "r") as zf:
zinfos = zf.infolist()
assert len(zinfos) == 2
# Read the data and make sure it's the same as what was put in
with zf.open("large.bin", "r") as fp:
assert startdata == fp.read(datasize)
if PY36:
# No support for seeking <3.7 - read it all in 128MB chunks
per = 1024 * 1024 * 128
rem = zipfile.ZIP64_LIMIT % per
for _ in range(zipfile.ZIP64_LIMIT // per):
fp.read(per)
fp.read(rem)
else:
fp.seek(zipfile.ZIP64_LIMIT, io.SEEK_CUR)
assert enddata == fp.read()
with zf.open("small.bin", "r") as fp:
assert smalldata == fp.read()
|