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
|
import os
import shlex
import subprocess
import sys
import pytest
import dirhash
console_script = os.path.join(
os.path.dirname(sys.executable),
"dirhash.exe" if os.name == "nt" else "dirhash",
)
if not os.path.isfile(console_script):
print(os.listdir(os.path.dirname(sys.executable)))
raise FileNotFoundError(f"Could not find console script at {console_script}.")
if not os.access(console_script, os.X_OK):
raise PermissionError(f"Console script at {console_script} is not executable.")
def dirhash_run(argstring, add_env=None):
if add_env:
env = os.environ.copy()
env.update(add_env)
else:
env = None
process = subprocess.Popen(
[console_script] + shlex.split(argstring),
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
text=True,
env=env,
)
output, error = process.communicate()
# in python3 output and error are `bytes` as opposed to `str` in python2
if isinstance(output, bytes):
output = output.decode("utf-8")
if isinstance(error, bytes):
error = error.decode("utf-8")
return output, error, process.returncode
def create_default_tree(tmpdir):
"""
tmpdir/
|__.dir/
| |__file
|__.file
|__dir/
| |__file
|__empty/
|__file
|__file.ext1
|__file.ext2
"""
dotdir = tmpdir.mkdir(".dir")
dotdir.join("file").write("file in hidden sub-directory")
tmpdir.join(".file").write("hidden file")
dir = tmpdir.mkdir("dir")
dir.join("file").write("file in sub-directory")
tmpdir.mkdir("empty")
tmpdir.join("file").write("file")
tmpdir.join("file.ext1").write("file with extension .ext1")
tmpdir.join("file.ext2").write("file with extension .ext2")
def osp(path: str) -> str:
"""Normalize path for OS."""
if os.name == "nt": # pragma: no cover
return path.replace("/", "\\")
return path
class TestCLI:
@pytest.mark.parametrize(
"argstring, non_default_kwargs",
[
(". -a md5", {}),
(".. -a md5", {"directory": ".."}),
("target-dir -a md5", {"directory": "target-dir"}),
(". -a sha256", {"algorithm": "sha256"}),
# Filtering options
('. -a md5 -m "*" "!.*"', {"match": ["*", "!.*"]}),
(
'. -a md5 --match "d1/*" "d2/*" --ignore "*.txt"',
{"match": ["d1/*", "d2/*"], "ignore": ["*.txt"]},
),
(". -a md5 --empty-dirs", {"empty_dirs": True}),
(". -a md5 --no-linked-dirs", {"linked_dirs": False}),
(". -a md5 --no-linked-files", {"linked_files": False}),
# Protocol options
(". -a md5 --allow-cyclic-links", {"allow_cyclic_links": True}),
(". -a md5 --properties name", {"entry_properties": ["name"]}),
(". -a md5 --properties name data", {"entry_properties": ["name", "data"]}),
# Implementation
(". -a md5 -j 10", {"jobs": 10}),
(". -a md5 -s 32000", {"chunk_size": 32000}),
],
)
def test_get_kwargs(self, argstring, non_default_kwargs):
from dirhash.cli import get_kwargs
kwargs_expected = {
"list": False,
"directory": ".",
"algorithm": "md5",
"match": ["*"],
"ignore": None,
"empty_dirs": False,
"linked_dirs": True,
"linked_files": True,
"entry_properties": ["data", "name"],
"allow_cyclic_links": False,
"chunk_size": 2**20,
"jobs": 1,
}
kwargs_expected.update(non_default_kwargs)
kwargs = get_kwargs(shlex.split(argstring))
assert kwargs == kwargs_expected
@pytest.mark.parametrize(
"description, argstrings, output",
[
(
"ARGS WITHOUT EFFECT WHEN LISTING",
[
". -l",
". --list",
". -a md5 --list",
". -a sha256 --list",
". --properties name --list",
". --jobs 2 --list",
". --chunk-size 2 --list",
],
(
".dir/file\n"
".file\n"
"dir/file\n"
"file\n"
"file.ext1\n"
"file.ext2\n"
),
),
(
"IGNORE EXTENSION",
[
'. -i "*.ext1" --list',
'. --ignore "*.ext1" --list',
'. -m "*" "!*.ext1" --list',
'. --match "*" "!*.ext1" --list',
],
(".dir/file\n" ".file\n" "dir/file\n" "file\n" "file.ext2\n"),
),
(
"IGNORE MULTIPLE EXTENSIONS",
['. -i "*.ext1" "*.ext2" --list', '. -i "*.ext*" --list'],
(".dir/file\n" ".file\n" "dir/file\n" "file\n"),
),
(
"IGNORE HIDDEN",
['. -i ".*" ".*/" --list'],
("dir/file\n" "file\n" "file.ext1\n" "file.ext2\n"),
),
(
"INCLUDE EMPTY",
[". --empty-dirs --list"],
(
".dir/file\n"
".file\n"
"dir/file\n"
"empty/.\n"
"file\n"
"file.ext1\n"
"file.ext2\n"
),
),
],
)
def test_list(self, description, argstrings, output, tmpdir):
create_default_tree(tmpdir)
with tmpdir.as_cwd():
for argstring in argstrings:
o, error, returncode = dirhash_run(argstring)
assert returncode == 0
assert error == ""
assert o == osp(output)
@pytest.mark.parametrize(
"argstring, kwargs, expected_hashes",
[
(
". -a md5",
{"algorithm": "md5"},
[
"594c48dde0776b03eddeeb0232190be7",
"d8ab965636d48e407b73b9dbba4cb928",
"050e7bc9ffcb09c15186c04e0f8026df",
],
),
(
". -a sha256",
{"algorithm": "sha256"},
[
"23a04964149889e932ba3348fe22442f4f6a3b3fec616a386a70579ee857ab7b",
"7b76bac43e963f9561f37b96b92d7a174094bff230c6efbf1d8bf650e8b40b7a",
"7156da2b2e5a2926eb4b72e65f389343cb6aca0578f0aedcd6f7457abd67d8f5",
],
),
],
)
def test_hash_result(self, argstring, kwargs, expected_hashes, tmpdir):
# verify same result from cmdline and library + regression test of actual
# hashes
create_default_tree(tmpdir)
with tmpdir.as_cwd():
for add_argstring, add_kwargs, expected_hash in zip(
["", " -p data", " -p name"],
[
{},
{"entry_properties": ["data"]},
{"entry_properties": ["name"]},
],
expected_hashes,
):
# run CLI
full_argstring = argstring + add_argstring
cli_out, error, returncode = dirhash_run(full_argstring)
assert error == ""
assert returncode == 0
assert cli_out[-1] == "\n"
cli_hash = cli_out[:-1]
# run CLI multiproc
full_argstring_mp = argstring + add_argstring + " --jobs 2"
cli_out_mp, error_mp, returncode_mp = dirhash_run(full_argstring_mp)
assert error_mp == ""
assert returncode_mp == 0
assert cli_out_mp[-1] == "\n"
cli_hash_mp = cli_out_mp[:-1]
# run lib function
full_kwargs = kwargs.copy()
full_kwargs.update(add_kwargs)
lib_hash = dirhash.dirhash(str(tmpdir), **full_kwargs)
assert cli_hash == cli_hash_mp == lib_hash == expected_hash
def test_error_bad_argument(self, tmpdir):
with tmpdir.as_cwd():
o, error, returncode = dirhash_run(". --chunk-size not_an_int")
assert returncode > 0
assert error != ""
|
