-
Notifications
You must be signed in to change notification settings - Fork 3
/
filesystem_test.py
201 lines (152 loc) · 7.05 KB
/
filesystem_test.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
# SPDX-License-Identifier: BSD-3-Clause
# Copyright (c) 2023 SciCat Project (https://github.com/SciCatProject/scitacean)
import hashlib
from datetime import datetime, timedelta, timezone
from pathlib import Path, PurePath, PurePosixPath, PureWindowsPath
import pytest
from hypothesis import given
from hypothesis import strategies as st
from scitacean.filesystem import (
RemotePath,
checksum_of_file,
escape_path,
file_modification_time,
file_size,
)
def test_remote_path_creation_and_posix():
assert RemotePath("/mnt/data/folder/file.txt").posix == "/mnt/data/folder/file.txt"
assert RemotePath("dir/image.png").posix == "dir/image.png"
assert RemotePath("data.nxs").posix == "data.nxs"
assert RemotePath(RemotePath("source/events.h5")).posix == "source/events.h5"
def test_remote_path_from_segments():
assert RemotePath("/mnt", "dir", "file.csv") == RemotePath("/mnt/dir/file.csv")
assert RemotePath("folder", "file") == RemotePath("folder/file")
assert RemotePath("", "folder", "file.csv") == RemotePath("folder/file.csv")
assert RemotePath("folder", "", "file.csv") == RemotePath("folder/file.csv")
assert RemotePath("folder", "file.csv", "") == RemotePath("folder/file.csv")
def test_remote_path_init_requires_path_like():
with pytest.raises(TypeError):
RemotePath(6133) # type: ignore[arg-type]
with pytest.raises(TypeError):
RemotePath(["folder", "file.dat"]) # type: ignore[arg-type]
@pytest.mark.parametrize("local_type", (PurePath, Path))
def test_remote_path_rejects_os_path(local_type):
with pytest.raises(TypeError):
RemotePath(local_type("dir", "file.csv")) # type: ignore[arg-type]
@pytest.mark.parametrize("local_type", (PurePath, PurePosixPath, PureWindowsPath))
def test_remote_path_from_local(local_type):
local_path = local_type("dir", "folder", "file.csv")
remote_path = RemotePath.from_local(local_path)
assert remote_path == RemotePath("dir/folder/file.csv")
@pytest.mark.parametrize("local_type", (PurePath, PurePosixPath, PureWindowsPath))
def test_remote_path_posix_uses_forward_slashes(local_type):
local_path = local_type("dir", "folder", "file.csv")
remote_path = RemotePath.from_local(local_path)
assert remote_path.posix == "dir/folder/file.csv"
def test_remote_path_str():
assert str(RemotePath("folder/file.dat")) == "RemotePath('folder/file.dat')"
def test_remote_path_repr():
assert repr(RemotePath("folder/file.dat")) == "RemotePath('folder/file.dat')"
def test_remote_path_to_local():
assert RemotePath("folder/file.dat").to_local() == PurePath("folder", "file.dat")
assert RemotePath("/folder/file.dat").to_local() == PurePath("/folder", "file.dat")
assert RemotePath("folder//file.dat").to_local() == PurePath("folder", "file.dat")
assert RemotePath("folder/file.dat/").to_local() == PurePath("folder", "file.dat")
@pytest.mark.parametrize(
"types", ((RemotePath, RemotePath), (RemotePath, str), (str, RemotePath))
)
def test_remote_path_eq(types):
ta, tb = types
assert ta("/source/data.csv") == tb("/source/data.csv")
@pytest.mark.parametrize(
"types", ((RemotePath, RemotePath), (RemotePath, str), (str, RemotePath))
)
def test_remote_path_neq(types):
ta, tb = types
assert ta("/source/data.csv") != tb("/host/dir/song.mp3")
@pytest.mark.parametrize(
"types", ((RemotePath, RemotePath), (RemotePath, str), (str, RemotePath))
)
def test_remote_path_join(types):
ta, tb = types
assert ta("/source/123") / tb("file.data") == RemotePath("/source/123/file.data")
assert ta("/source/123/") / tb("file.data") == RemotePath("/source/123/file.data")
assert ta("/source/123") / tb("/file.data") == RemotePath("/source/123/file.data")
assert ta("/source/123/") / tb("/file.data") == RemotePath("/source/123/file.data")
@pytest.mark.parametrize(
"types", ((RemotePath, RemotePath), (RemotePath, str), (str, RemotePath))
)
def test_remote_path_join_url(types):
ta, tb = types
assert ta("https://server.eu") / tb("1234-abcd/data.txt") == RemotePath(
"https://server.eu/1234-abcd/data.txt"
)
assert ta("https://server.eu/") / tb("1234-abcd/data.txt") == RemotePath(
"https://server.eu/1234-abcd/data.txt"
)
assert ta("https://server.eu") / tb("/1234-abcd/data.txt") == RemotePath(
"https://server.eu/1234-abcd/data.txt"
)
assert ta("https://server.eu/") / tb("/1234-abcd/data.txt") == RemotePath(
"https://server.eu/1234-abcd/data.txt"
)
def test_remote_path_join_rejects_os_path():
with pytest.raises(TypeError):
RemotePath("asd") / Path("qwe") # type: ignore[arg-type]
with pytest.raises(TypeError):
Path("qwe") / RemotePath("asd") # type: ignore[arg-type]
def test_remote_path_name():
assert RemotePath("table.csv").name == "table.csv"
assert RemotePath("README").name == "README"
assert RemotePath("path/").name == "path"
assert RemotePath("dir/folder/file1.txt").name == "file1.txt"
def test_remote_path_suffix():
assert RemotePath("file.txt").suffix == ".txt"
assert RemotePath("folder/image.png").suffix == ".png"
assert RemotePath("dir/table.txt.csv").suffix == ".csv"
assert RemotePath("archive.tz/data.dat").suffix == ".dat"
assert RemotePath("location.dir/file").suffix is None
assert RemotePath("source/file").suffix is None
def test_remote_path_truncated():
assert RemotePath("something-long.txt").truncated(10) == "someth.txt"
assert RemotePath("longlonglong/short").truncated(5) == "longl/short"
assert RemotePath("a-long.data.dir/filename.csv").truncated(7) == "a-l.dir/fil.csv"
assert RemotePath("file.longextension").truncated(9) == "f.longext"
@pytest.mark.parametrize("size", (0, 1, 57121))
def test_file_size(fs, size):
fs.create_file("image.tiff", st_size=size)
assert file_size(Path("image.tiff")) == size
def test_file_modification_time(fs):
fs.create_file("data.dat")
expected = datetime.now(tz=timezone.utc)
assert abs(file_modification_time(Path("data.dat")) - expected) < timedelta(
seconds=5
)
@pytest.mark.parametrize(
"contents",
(b"small file contents", b"large contents " * 100000),
ids=("small", "large"),
)
def test_checksum_of_file(fs, contents):
fs.create_file("file.txt", contents=contents)
assert (
checksum_of_file("file.txt", algorithm="md5")
== hashlib.md5(contents).hexdigest()
)
assert (
checksum_of_file("file.txt", algorithm="sha256")
== hashlib.sha256(contents).hexdigest()
)
@pytest.mark.parametrize("path_type", (str, Path, RemotePath))
def test_escape_path_returns_same_type_as_input(path_type):
assert isinstance(escape_path(path_type("x")), path_type)
@given(st.text())
def test_escape_path_returns_ascii(path):
# does not raise
escape_path(path).encode("ascii", "strict")
@given(st.text())
def test_escape_path_returns_no_bad_character(path):
bad_linux = "/" + chr(0)
bad_windows = '<>:"\\/|?*' + "".join(map(chr, range(0, 31)))
escaped = escape_path(path)
assert not any(c in escaped for c in bad_linux + bad_windows)