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
|
# type: ignore
"""
.. codeauthor:: Tsuyoshi Hombashi <tsuyoshi.hombashi@gmail.com>
"""
import platform as m_platform
import random
import sys
from collections import OrderedDict
from itertools import chain, product
from pathlib import Path
import pytest
from allpairspy import AllPairs
from pathvalidate import (
ErrorReason,
Platform,
ValidationError,
is_valid_filepath,
sanitize_filepath,
validate_filepath,
)
from pathvalidate._common import unprintable_ascii_chars
from pathvalidate._filepath import FilePathSanitizer, FilePathValidator
from pathvalidate.handler import NullValueHandler, ReservedNameHandler, raise_error
from ._common import (
INVALID_PATH_CHARS,
INVALID_WIN_PATH_CHARS,
NTFS_RESERVED_FILE_NAMES,
VALID_PATH_CHARS,
WIN_RESERVED_FILE_NAMES,
is_faker_installed,
platform_linux,
platform_macos,
platform_windows,
randstr,
)
nan = float("nan")
inf = float("inf")
random.seed(0)
class Test_FileSanitizer:
@pytest.mark.parametrize(
["test_platform", "expected"],
[
["windows", Platform.WINDOWS],
["linux", Platform.LINUX],
["macos", Platform.MACOS],
],
)
def test_normal_platform_auto(self, monkeypatch, test_platform, expected):
if test_platform == "windows":
patch = platform_windows
elif test_platform == "linux":
patch = platform_linux
elif test_platform == "macos":
patch = platform_macos
else:
raise ValueError(f"unexpected test platform: {test_platform}")
monkeypatch.setattr(m_platform, "system", patch)
assert FilePathSanitizer(255, platform="auto").platform == expected
def test_normal_additional_reserved_names(self):
sanitizer = FilePathSanitizer(additional_reserved_names=["abc"])
assert sanitizer.reserved_keywords == ("ABC",)
class Test_FilePathValidator:
@pytest.mark.parametrize(
["test_platform", "expected"],
[
["windows", tuple()],
["posix", ("/", ":")],
["linux", ("/",)],
["macos", ("/", ":")],
],
)
def test_normal_reserved_keywords(self, test_platform, expected):
assert FilePathValidator(255, platform=test_platform).reserved_keywords == expected
def test_normal_additional_reserved_names(self):
sanitizer = FilePathValidator(additional_reserved_names=["abc"])
assert "ABC" in sanitizer.reserved_keywords
class Test_validate_filepath:
VALID_CHARS = VALID_PATH_CHARS
VALID_MULTIBYTE_PATHS = [
"c:\\Users\\新しいフォルダー\\あいうえお.txt",
"D:\\新しいフォルダー\\ユーザ属性.txt",
]
WIN_VALID_PATHS = [
r"C:\Program Files (x86)\Microsoft",
"D:\\Users\\\\est\\AppData\\Local\\Temp\\pytest-of-test\\pytest-0\\\\hoge.csv",
"D:/Users/test/AppData/Local/Temp/pytest-of-test/pytest-0/test_exception__hoge_csv_heade1/hoge.csv", # noqa
"C:\\Users\\est\\AppData/Local\\Temp/pytest-of-test\\pytest-0/\\hoge.csv",
"C:\\Users",
"C:\\",
"\\Users",
r"\\fileserver\public",
]
@pytest.mark.parametrize(
["value", "platform"],
chain.from_iterable(
[
[
args
for args in product(
["/{0}/{1}{0}".format(randstr(64), valid_c)], ["linux", "macos"]
)
]
for valid_c in VALID_CHARS
]
),
)
def test_normal(self, value, platform):
validate_filepath(value, platform)
assert is_valid_filepath(value, platform=platform)
@pytest.mark.parametrize(
["platform"],
[
["linux"],
["macos"],
["posix"],
],
)
def test_normal_only_whitespaces(self, platform):
value = " "
validate_filepath(value, platform)
assert is_valid_filepath(value, platform=platform)
@pytest.mark.parametrize(
["platform"],
[
["windows"],
["universal"],
],
)
def test_abnormal_only_whitespaces(self, platform):
value = " "
with pytest.raises(ValidationError) as e:
validate_filepath(value, platform=platform)
assert e.value.reason == ErrorReason.NULL
assert not is_valid_filepath(value, platform)
@pytest.mark.parametrize(
["value", "platform"],
chain.from_iterable(
[
[args for args in product([valid_path], ["windows"])]
for valid_path in VALID_MULTIBYTE_PATHS
]
),
)
def test_normal_multibyte(self, value, platform):
validate_filepath(value, platform)
assert is_valid_filepath(value, platform=platform)
@pytest.mark.parametrize(["value"], [[valid_path] for valid_path in WIN_VALID_PATHS])
def test_normal_win(self, value):
platform = "windows"
validate_filepath(value, platform=platform)
assert is_valid_filepath(value, platform=platform)
@pytest.mark.parametrize(
["value", "min_len", "expected"],
[
["lower than one", -1, None],
["valid", 5, None],
["invalid_length", 200, ErrorReason.INVALID_LENGTH],
],
)
def test_normal_min_len(self, value, min_len, expected):
if expected is None:
validate_filepath(value, min_len=min_len)
assert is_valid_filepath(value, min_len=min_len)
return
with pytest.raises(ValidationError) as e:
validate_filepath(value, min_len=min_len)
assert e.value.reason == expected
assert e.value.fs_encoding
assert e.value.byte_count
assert e.value.byte_count > 0
@pytest.mark.parametrize(
["value", "platform", "max_len", "expected"],
[
["a" * 4096, "linux", None, None],
["a" * 4097, "linux", None, ErrorReason.INVALID_LENGTH],
["a" * 1024, "posix", None, None],
["a" * 1025, "posix", None, ErrorReason.INVALID_LENGTH],
["a" * 4097, Platform.LINUX, None, ErrorReason.INVALID_LENGTH],
["a" * 255, "linux", 100, ErrorReason.INVALID_LENGTH],
["a" * 5000, "windows", 10000, ErrorReason.INVALID_LENGTH],
["a" * 260, "windows", None, None],
["a" * 300, "windows", 1024, ErrorReason.INVALID_LENGTH],
["a" * 261, Platform.WINDOWS, None, ErrorReason.INVALID_LENGTH],
["a" * 261, "windows", None, ErrorReason.INVALID_LENGTH],
["a" * 260, "universal", None, None],
["a" * 261, "universal", None, ErrorReason.INVALID_LENGTH],
["a" * 300, "universal", 1024, ErrorReason.INVALID_LENGTH],
["a" * 261, Platform.UNIVERSAL, None, ErrorReason.INVALID_LENGTH],
],
)
def test_normal_max_len(self, value, platform, max_len, expected):
kwargs = {
"platform": platform,
"max_len": max_len,
}
if expected is None:
validate_filepath(value, **kwargs)
assert is_valid_filepath(value, **kwargs)
return
with pytest.raises(ValidationError) as e:
validate_filepath(value, **kwargs)
assert e.value.reason == ErrorReason.INVALID_LENGTH
assert e.value.fs_encoding
assert e.value.byte_count
assert e.value.byte_count > 0
@pytest.mark.parametrize(
["value", "platform", "fs_encoding", "max_len", "expected"],
[
["/tmp/" + "あ" * 83, "linux", "utf-8", 255, None],
["/tmp/" + "あ" * 84, "linux", "utf-8", 255, ErrorReason.INVALID_LENGTH],
["/tmp/" + "あ" * 121, "linux", "utf-16", 255, None],
["/tmp/" + "あ" * 122, "linux", "utf-16", 255, ErrorReason.INVALID_LENGTH],
],
)
def test_max_len_fs_encoding(self, value, platform, fs_encoding, max_len, expected):
kwargs = {
"platform": platform,
"max_len": max_len,
"fs_encoding": fs_encoding,
}
if expected is None:
validate_filepath(value, **kwargs)
assert is_valid_filepath(value, **kwargs)
return
with pytest.raises(ValidationError) as e:
validate_filepath(value, **kwargs)
assert e.value.reason == expected
assert e.value.fs_encoding
assert e.value.byte_count
assert e.value.byte_count > 0
@pytest.mark.parametrize(
["value", "min_len", "max_len", "expected"],
[
["valid length", 1, 255, None],
["minus min_len", -2, 100, None],
["minus max_len", -3, -2, None],
["zero max_len", -2, 0, None],
["eq min max", 10, 10, None],
["inversion", 100, 1, ValueError],
],
)
def test_minmax_len(self, value, min_len, max_len, expected):
kwargs = {
"min_len": min_len,
"max_len": max_len,
}
if expected is None:
validate_filepath(value, **kwargs)
assert is_valid_filepath(value, **kwargs)
return
with pytest.raises(expected):
validate_filepath(value, **kwargs)
@pytest.mark.parametrize(
["test_platform", "value", "expected"],
[
["linux", "/a/b/c.txt", None],
["linux", "C:\\a\\b\\c.txt", ValidationError],
["windows", "/a/b/c.txt", ValidationError],
["windows", "C:\\a\\b\\c.txt", None],
["universal", "/a/b/c.txt", ValidationError],
["universal", "C:\\a\\b\\c.txt", ValidationError],
],
)
def test_abs_path(self, test_platform, value, expected):
if expected is None:
validate_filepath(value, platform=test_platform)
assert is_valid_filepath(value, platform=test_platform)
return
with pytest.raises(expected):
validate_filepath(value, platform=test_platform)
@pytest.mark.skipif(m_platform.system() != "Windows", reason="platform dependent tests")
@pytest.mark.parametrize(
["value", "expected"],
[
["C:\\a\\b\\c.txt", None],
],
)
def test_auto_platform_win(self, value, expected):
if expected is None:
validate_filepath(value, platform="auto")
assert is_valid_filepath(value, platform="auto")
return
with pytest.raises(expected):
validate_filepath(value, platform="auto")
@pytest.mark.skipif(m_platform.system() != "Linux", reason="platform dependent tests")
@pytest.mark.parametrize(
["value", "expected"],
[
["/a/b/c.txt", None],
["C:\\a\\b\\c.txt", ValidationError],
],
)
def test_auto_platform_linux(self, value, expected):
if expected is None:
validate_filepath(value, platform="auto")
assert is_valid_filepath(value, platform="auto")
return
with pytest.raises(expected):
validate_filepath(value, platform="auto")
@pytest.mark.parametrize(
["test_platform", "value", "expected"],
[
["linux", "a/b/c.txt", None],
["linux", "a//b?/c.txt", None],
["linux", "../a/./../b/c.txt", None],
["windows", "a/b/c.txt", None],
["windows", "a//b?/c.txt", ValidationError],
["windows", "../a/./../b/c.txt", None],
["universal", "a/b/c.txt", None],
["universal", "./a/b/c.txt", None],
["universal", "../a/./../b/c.txt", None],
["universal", "a//b?/c.txt", ValidationError],
],
)
def test_relative_path(self, test_platform, value, expected):
if expected is None:
validate_filepath(value, platform=test_platform)
assert is_valid_filepath(value, platform=test_platform)
else:
with pytest.raises(expected):
validate_filepath(value, platform=test_platform)
@pytest.mark.parametrize(
["platform", "value"],
[
["linux", "period."],
["linux", "space "],
["linux", "space_and_period. "],
],
)
def test_normal_space_or_period_at_tail(self, platform, value):
validate_filepath(value, platform=platform)
assert is_valid_filepath(value, platform=platform)
@pytest.mark.parametrize(
["platform", "value"],
[
["windows", "period."],
["windows", "space "],
["windows", "space_and_period ."],
["windows", "space_and_period. "],
["universal", "period."],
["universal", "space "],
["universal", "space_and_period ."],
],
)
def test_exception_space_or_period_at_tail(self, platform, value):
with pytest.raises(ValidationError):
validate_filepath(value, platform=platform)
assert not is_valid_filepath(value, platform=platform)
@pytest.mark.skipif(not is_faker_installed(), reason="requires faker")
@pytest.mark.parametrize(
["locale"],
[
[None],
["ja_JP"],
],
)
def test_locale_jp(self, locale):
from faker import Factory
fake = Factory.create(locale=locale, seed=1)
for _ in range(100):
filepath = fake.file_path()
validate_filepath(filepath, platform="linux")
assert is_valid_filepath(filepath, platform="linux")
@pytest.mark.parametrize(
["value"],
[["{0}{1}{0}".format(randstr(64), invalid_c)] for invalid_c in INVALID_PATH_CHARS],
)
def test_exception_invalid_char(self, value):
with pytest.raises(ValidationError) as e:
validate_filepath(value)
assert e.value.reason == ErrorReason.INVALID_CHARACTER
assert not is_valid_filepath(value)
@pytest.mark.parametrize(
["value", "platform"],
[
["{0}/{1}{0}".format(randstr(64), invalid_c), platform]
for invalid_c, platform in product(
set(INVALID_WIN_PATH_CHARS + unprintable_ascii_chars).difference(
set(INVALID_PATH_CHARS)
),
["windows", "universal"],
)
],
)
def test_exception_invalid_win_char(self, value, platform):
with pytest.raises(ValidationError) as e:
validate_filepath(value, platform=platform)
assert e.value.reason == ErrorReason.INVALID_CHARACTER
assert not is_valid_filepath(value, platform=platform)
@pytest.mark.parametrize(
["value", "platform"],
[
[f"/foo/abc/{reserved_keyword}.txt", platform]
for reserved_keyword, platform in product(WIN_RESERVED_FILE_NAMES, ["linux", "macos"])
if reserved_keyword not in [".", ".."]
]
+ [
[f"{drive}\\{filename}_", platform]
for drive, platform, filename in product(
["C:", "D:"], ["windows"], NTFS_RESERVED_FILE_NAMES
)
]
+ [
[f"{drive}\\abc\\{filename}", platform]
for drive, platform, filename in product(
["C:", "D:"], ["windows"], NTFS_RESERVED_FILE_NAMES
)
],
)
def test_normal_reserved_name_used_valid_place(self, value, platform):
validate_filepath(value, platform=platform)
assert is_valid_filepath(value, platform=platform)
@pytest.mark.parametrize(
["value", "platform", "expected"],
[
[f"abc\\{reserved_keyword}\\xyz", platform, ValidationError]
for reserved_keyword, platform in product(
WIN_RESERVED_FILE_NAMES, ["windows", "universal"]
)
if reserved_keyword not in [".", ".."]
]
+ [
[f"foo/abc/{reserved_keyword}.txt", platform, ValidationError]
for reserved_keyword, platform in product(WIN_RESERVED_FILE_NAMES, ["universal"])
if reserved_keyword not in [".", ".."]
]
+ [
[f"{reserved_keyword}", platform, ValidationError]
for reserved_keyword, platform in product(
WIN_RESERVED_FILE_NAMES, ["windows", "universal"]
)
if reserved_keyword not in [".", ".."]
]
+ [
[f"{drive}\\{filename}", platform, ValidationError]
for drive, platform, filename in product(
["C:", "D:"], ["windows"], NTFS_RESERVED_FILE_NAMES
)
],
)
def test_exception_reserved_name(self, value, platform, expected):
with pytest.raises(expected) as e:
print(platform, value)
validate_filepath(value, platform=platform)
assert e.value.reason == ErrorReason.RESERVED_NAME
assert e.value.reusable_name is False
assert e.value.reserved_name
assert not is_valid_filepath(value, platform=platform)
@pytest.mark.parametrize(
["value", "arn", "expected"],
[
["abc/efg.txt", ["abc"], False],
["abc/efg.txt", ["efg.txt"], False],
],
)
def test_normal_additional_reserved_names(self, value, arn, expected):
assert is_valid_filepath(value, additional_reserved_names=arn) == expected
@pytest.mark.parametrize(
["value", "platform", "expected"],
[
[value, platform, ErrorReason.INVALID_CHARACTER]
for value, platform in product(["asdf\rsdf"], ["windows", "universal"])
],
)
def test_exception_escape_err_msg(self, value, platform, expected):
with pytest.raises(ValidationError) as e:
print(platform, repr(value))
validate_filepath(value, platform=platform)
assert e.value.reason == expected
assert str(e.value) == (
r"[PV1100] invalid characters found: invalids=('\r'), "
"platform=Windows, value='asdf\\rsdf'"
) # noqa
@pytest.mark.parametrize(
["value", "expected"],
[
[None, ValueError],
["", ValidationError],
[1, TypeError],
[True, TypeError],
],
)
def test_exception(self, value, expected):
with pytest.raises(expected):
validate_filepath(value)
assert not is_valid_filepath(value)
class Test_validate_win_file_path:
VALID_CHARS = VALID_PATH_CHARS
@pytest.mark.parametrize(
["value"],
[
["C:\\Users\\est\\AppData\\Local\\Temp\\pytest-of-test\\pytest-0\\\\hoge.csv"],
["Z:\\Users\\est\\AppData\\Local\\Temp\\pytest-of-test\\pytest-0\\hoge.csv"],
[
"C:/Users/est/AppData/Local/Temp/pytest-of-test/pytest-0/test_exception__hoge_csv_heade1/hoge.csv" # noqa
],
["C:\\Users/est\\AppData/Local\\Temp/pytest-of-test\\pytest-0/hoge.csv"],
["C:\\Users"],
["C:\\"],
["\\Users"],
],
)
def test_normal(self, value):
validate_filepath(value, platform="windows")
assert is_valid_filepath(value, platform="windows")
@pytest.mark.parametrize(
["value", "platform", "expected"],
[
[r"C:\Users\a", "universal", ErrorReason.MALFORMED_ABS_PATH],
[r"C:\Users:a", "universal", ErrorReason.MALFORMED_ABS_PATH],
["C:\\Users\\" + "a" * 1024, "windows", ErrorReason.INVALID_LENGTH],
[r"C:\Users:a", "windows", ErrorReason.INVALID_CHARACTER],
],
)
def test_exception(self, value, platform, expected):
with pytest.raises(ValidationError) as e:
validate_filepath(value, platform=platform)
assert e.value.reason == expected
assert not is_valid_filepath(value, platform=platform)
class Test_sanitize_filepath:
SANITIZE_CHARS = INVALID_WIN_PATH_CHARS + unprintable_ascii_chars
NOT_SANITIZE_CHARS = VALID_PATH_CHARS
REPLACE_TEXTS = ["", "_"]
@pytest.mark.parametrize(
["platform", "value", "replace_text", "expected"],
[
["universal", "AA" + c + "B", rep, "AA" + rep + "B"]
for c, rep in product(SANITIZE_CHARS, REPLACE_TEXTS)
]
+ [
["universal", "A" + c + "B", rep, "A" + c + "B"]
for c, rep in product(NOT_SANITIZE_CHARS, REPLACE_TEXTS)
]
+ [
["universal", "あ" + c + "い", rep, "あ" + c + "い"]
for c, rep in product(NOT_SANITIZE_CHARS, REPLACE_TEXTS)
]
+ [
[pair.platform, "A" + pair.c + "B", pair.repl, "A" + pair.repl + "B"]
for pair in AllPairs(
OrderedDict(
{
"platform": [
"posix",
"linux",
"macos",
Platform.POSIX,
Platform.LINUX,
Platform.MACOS,
],
"c": INVALID_PATH_CHARS + unprintable_ascii_chars,
"repl": REPLACE_TEXTS,
}
)
)
]
+ [
[pair.platform, "A" + pair.c + "B", pair.repl, "A" + pair.c + "B"]
for pair in AllPairs(
OrderedDict(
{
"platform": [
"posix",
"linux",
"macos",
Platform.POSIX,
Platform.LINUX,
Platform.MACOS,
],
"c": [":", "*", "?", '"', "<", ">", "|"],
"repl": REPLACE_TEXTS,
}
)
)
],
)
def test_normal_str(self, platform, value, replace_text, expected):
sanitized_name = sanitize_filepath(value, platform=platform, replacement_text=replace_text)
assert sanitized_name == expected
assert isinstance(sanitized_name, str)
validate_filepath(sanitized_name, platform=platform)
assert is_valid_filepath(sanitized_name, platform=platform)
@pytest.mark.parametrize(
["value", "test_platform", "expected"],
[
[
f"abc/{reserved_keyword}/xyz",
platform,
f"abc/{reserved_keyword}_/xyz",
]
for reserved_keyword, platform in product(WIN_RESERVED_FILE_NAMES, ["universal"])
]
+ [
[
f"/abc/{reserved_keyword}/xyz",
platform,
f"/abc/{reserved_keyword}/xyz",
]
for reserved_keyword, platform in product(WIN_RESERVED_FILE_NAMES, ["linux"])
]
+ [
[
f"abc/{reserved_keyword}.txt",
platform,
f"abc/{reserved_keyword}_.txt",
]
for reserved_keyword, platform in product(WIN_RESERVED_FILE_NAMES, ["universal"])
]
+ [
[
f"/abc/{reserved_keyword}.txt",
platform,
f"/abc/{reserved_keyword}.txt",
]
for reserved_keyword, platform in product(WIN_RESERVED_FILE_NAMES, ["linux"])
]
+ [
[
f"C:\\abc\\{reserved_keyword}.txt",
platform,
f"C:\\abc\\{reserved_keyword}_.txt",
]
for reserved_keyword, platform in product(WIN_RESERVED_FILE_NAMES, ["windows"])
]
+ [
[f"{drive}\\{filename}", platform, f"{drive}\\{filename}_"]
for drive, platform, filename in product(
["C:", "D:"], ["windows"], NTFS_RESERVED_FILE_NAMES
)
],
)
def test_normal_reserved_name(self, value, test_platform, expected):
filename = sanitize_filepath(value, platform=test_platform)
assert filename == expected
assert is_valid_filepath(filename, platform=test_platform)
@pytest.mark.parametrize(
["value", "reserved_name_handler", "expected"],
[
["CON", ReservedNameHandler.add_trailing_underscore, "CON_"],
["hoge/CON", ReservedNameHandler.add_trailing_underscore, "hoge\\CON_"],
["CON", ReservedNameHandler.add_leading_underscore, "_CON"],
["hoge/CON", ReservedNameHandler.add_leading_underscore, "hoge\\_CON"],
["CON", ReservedNameHandler.as_is, "CON"],
],
)
def test_normal_reserved_name_handler(self, value, reserved_name_handler, expected):
assert (
sanitize_filepath(
value, platform="windows", reserved_name_handler=reserved_name_handler
)
== expected
)
@pytest.mark.parametrize(
["value", "expected"],
[
["hoge/.", "hoge\\._"],
["hoge/./foo", "hoge\\._\\foo"],
["hoge/..", "hoge\\.._"],
],
)
def test_normal_custom_reserved_name_handler_for_dot_files(self, value, expected):
def always_add_trailing_underscore(e: ValidationError) -> str:
if e.reusable_name:
return e.reserved_name
return f"{e.reserved_name}_"
assert (
sanitize_filepath(
value,
platform="windows",
reserved_name_handler=always_add_trailing_underscore,
additional_reserved_names=[".", ".."],
normalize=False,
)
== expected
)
def test_exception_reserved_name_handler(self):
for platform in ["windows", "universal"]:
with pytest.raises(ValidationError) as e:
sanitize_filepath("CON", platform=platform, reserved_name_handler=raise_error)
assert e.value.reason == ErrorReason.RESERVED_NAME
@pytest.mark.parametrize(
["value", "check_reserved", "expected"],
[
["CON", True, "CON_"],
["CON", False, "CON"],
],
)
def test_normal_check_reserved(self, value, check_reserved, expected):
assert (
sanitize_filepath(value, platform="windows", check_reserved=check_reserved) == expected
)
@pytest.mark.parametrize(
["value", "arn", "expected"],
[
["abc", ["abc"], "abc_"],
],
)
def test_normal_additional_reserved_names(self, value, arn, expected):
for platform in ["windows", "universal"]:
assert (
sanitize_filepath(
value,
platform=platform,
additional_reserved_names=arn,
)
== expected
)
@pytest.mark.parametrize(
["value", "replace_text", "expected"],
[
[Path("AA" + c + "B"), rep, Path("AA" + rep + "B")]
for c, rep in product(SANITIZE_CHARS, REPLACE_TEXTS)
]
+ [
[Path("A" + c + "B"), rep, Path("A" + c + "B")]
for c, rep in product(NOT_SANITIZE_CHARS, REPLACE_TEXTS)
]
+ [
[Path("あ" + c + "い"), rep, Path("あ" + c + "い")]
for c, rep in product(NOT_SANITIZE_CHARS, REPLACE_TEXTS)
],
)
def test_normal_pathlike(self, value, replace_text, expected):
sanitized_name = sanitize_filepath(value, replace_text)
assert sanitized_name == expected
assert isinstance(sanitized_name, Path)
validate_filepath(sanitized_name)
assert is_valid_filepath(sanitized_name)
@pytest.mark.parametrize(
["test_platform", "value", "expected"],
[
["linux", "a/b/c.txt", "a/b/c.txt"],
["linux", "a//b?/c.txt", "a/b?/c.txt"],
["linux", "../a/./../b/c.txt", "../b/c.txt"],
["windows", "a/b/c.txt", "a\\b\\c.txt"],
["windows", "a//b?/c.txt", "a\\b\\c.txt"],
["windows", "../a/./../b/c.txt", "..\\b\\c.txt"],
["universal", "a/b/c.txt", "a/b/c.txt"],
["universal", "./", "."],
["universal", "./a/b/c.txt", "a/b/c.txt"],
["universal", "../a/./../b/c.txt", "../b/c.txt"],
["universal", "a//b?/c.txt", "a/b/c.txt"],
],
)
def test_normal_relative_path(self, test_platform, value, expected):
assert sanitize_filepath(value, platform=test_platform) == expected
@pytest.mark.parametrize(
["test_platform", "value", "expected"],
[
["linux", "a/b/c.txt", "a/b/c.txt"],
["linux", "a//b?/c.txt", "a/b?/c.txt"],
["linux", "../a/./../b/c.txt", "../a/./../b/c.txt"],
["windows", "a/b/c.txt", "a\\b\\c.txt"],
["windows", "a//b?/c.txt", "a\\b\\c.txt"],
["windows", "../a/./../b/c.txt", "..\\a\\.\\..\\b\\c.txt"],
["universal", "a/b/c.txt", "a/b/c.txt"],
["universal", "./", "."],
["universal", "./a/b/c.txt", "./a/b/c.txt"],
["universal", "../a/./../b/c.txt", "../a/./../b/c.txt"],
["universal", "a//b?/c.txt", "a/b/c.txt"],
],
)
def test_normal_not_normalize(self, test_platform, value, expected):
assert sanitize_filepath(value, platform=test_platform, normalize=False) == expected
@pytest.mark.parametrize(
["value"],
[
[None],
[""],
["?"],
],
)
def test_normal_null_value_handler(self, value):
assert (
sanitize_filepath(value, null_value_handler=NullValueHandler.return_null_string) == ""
)
assert sanitize_filepath(value, null_value_handler=NullValueHandler.return_timestamp) != ""
with pytest.raises(ValidationError):
sanitize_filepath(value, null_value_handler=raise_error)
@pytest.mark.parametrize(
["test_platform", "value", "replace_text", "expected"],
[
["linux", "/tmp/あいう\0えお.txt", "", "/tmp/あいうえお.txt"],
["linux", "/tmp/属\0性.txt", "-", "/tmp/属-性.txt"],
["universal", "tmp/あいう\0えお.txt", "", "tmp/あいうえお.txt"],
["universal", "tmp/属\0性.txt", "-", "tmp/属-性.txt"],
],
)
def test_normal_multibyte(self, test_platform, value, replace_text, expected):
sanitized_name = sanitize_filepath(value, replace_text, platform=test_platform)
assert sanitized_name == expected
validate_filepath(sanitized_name, platform=test_platform)
assert is_valid_filepath(sanitized_name, platform=test_platform)
@pytest.mark.parametrize(
["platform", "value", "expected"],
[
["windows", "a/b", "a\\b"],
["windows", "a\\b", "a\\b"],
["windows", "a\\\\b", "a\\b"],
["linux", "a/b", "a/b"],
["linux", "a//b", "a/b"],
["linux", "a\\b", "a/b"],
["linux", "a\\\\b", "a/b"],
["universal", "a/b", "a/b"],
["universal", "a//b", "a/b"],
["universal", "a\\b", "a/b"],
["universal", "a\\\\b", "a/b"],
],
)
def test_normal_path_separator(self, platform, value, expected):
sanitized = sanitize_filepath(value, platform=platform)
assert sanitized == expected
assert is_valid_filepath(sanitized, platform=platform)
@pytest.mark.skipif(m_platform.system() != "Windows", reason="platform dependent tests")
@pytest.mark.parametrize(
["value", "expected"],
[
["C:\\a\\b|c.txt", "C:\\a\\bc.txt"],
],
)
def test_auto_platform_win(self, value, expected):
if isinstance(expected, str):
sanitized = sanitize_filepath(value, platform="auto")
assert is_valid_filepath(sanitized, platform="auto")
else:
with pytest.raises(expected):
sanitize_filepath(value, platform="auto")
@pytest.mark.skipif(m_platform.system() != "Linux", reason="platform dependent tests")
@pytest.mark.parametrize(
["value", "expected"],
[
["C:\\a\\b\\c.txt", ValidationError],
],
)
def test_auto_platform_linux(self, value, expected):
kwargs = {
"platform": "auto",
"validate_after_sanitize": True,
}
if isinstance(expected, str):
sanitized = sanitize_filepath(value, **kwargs)
assert is_valid_filepath(sanitized, platform="auto")
return
with pytest.raises(expected) as e:
sanitize_filepath(value, **kwargs)
assert e.value.reason == ErrorReason.MALFORMED_ABS_PATH
@pytest.mark.parametrize(
["platform", "value"],
[
["windows", "CON \r"],
],
)
def test_exception_invalid_after_sanitize(self, platform, value):
print(
"'{}'".format(
sanitize_filepath(value, platform=platform, validate_after_sanitize=False)
),
file=sys.stderr,
)
with pytest.raises(ValidationError) as e:
sanitize_filepath(value, platform=platform, validate_after_sanitize=True)
assert e.value.reason == ErrorReason.INVALID_AFTER_SANITIZE
@pytest.mark.parametrize(
["value", "expected"],
[
[1, TypeError],
[True, TypeError],
[nan, TypeError],
[inf, TypeError],
],
)
def test_exception_type(self, value, expected):
with pytest.raises(expected):
sanitize_filepath(value)
assert not is_valid_filepath(value)
|