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
|
import multiprocessing
import os
import pytest
import sys
import time
from pathlib import Path
from liquidctl.keyval import RuntimeStorage, _FilesystemBackend
mp_ctx = multiprocessing.get_context("spawn")
@pytest.fixture
def tmpstore(tmpdir):
run_dir = tmpdir.mkdir("run_dir")
prefixes = ["prefix"]
backend = _FilesystemBackend(key_prefixes=prefixes, runtime_dirs=[run_dir])
return RuntimeStorage(prefixes, backend=backend)
def test_loads_and_stores(tmpstore):
assert tmpstore.load("key") is None
assert tmpstore.load("key", default=42) == 42
tmpstore.store("key", "42")
assert tmpstore.load("key") == "42"
assert tmpstore.load("key", of_type=int) is None
def test_updates_with_load_store(tmpstore):
assert tmpstore.load_store("key", lambda x: x) == (None, None)
assert tmpstore.load_store("key", lambda x: x, default=42) == (None, 42)
assert tmpstore.load_store("key", lambda x: str(x)) == (42, "42")
assert tmpstore.load_store("key", lambda x: x, of_type=int) == ("42", None)
def test_fs_backend_stores_truncate_appropriately(tmpdir):
run_dir = tmpdir.mkdir("run_dir")
# use a separate reader to prevent caching from masking issues
writer = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[run_dir])
reader = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[run_dir])
writer.store("key", 42)
assert reader.load("key") == 42
writer.store("key", 1)
assert reader.load("key") == 1
writer.load_store("key", lambda _: 42)
assert reader.load("key") == 42
writer.load_store("key", lambda _: 1)
assert reader.load("key") == 1
def test_fs_backend_loads_from_fallback_dir(tmpdir):
run_dir = tmpdir.mkdir("run_dir")
fb_dir = tmpdir.mkdir("fb_dir")
fallback = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[fb_dir])
fallback.store("key", 42)
store = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[run_dir, fb_dir])
assert store.load("key") == 42
store.store("key", -1)
assert store.load("key") == -1
assert fallback.load("key") == 42, "fallback location was changed"
def test_fs_backend_handles_values_corupted_with_nulls(tmpdir, caplog):
run_dir = tmpdir.mkdir("run_dir")
store = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[run_dir])
store.store("key", 42)
key_file = Path(run_dir).joinpath("prefix", "key")
assert key_file.read_bytes() == b"42", "unit test is unsound"
key_file.write_bytes(b"\x00")
val = store.load("key")
assert val is None
assert "was corrupted" in caplog.text
val, new_val = store.load_store("key", lambda x: 24)
assert val is None
assert new_val == 24
def test_fs_backend_load_store_returns_old_and_new_values(tmpdir):
run_dir = tmpdir.mkdir("run_dir")
store = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[run_dir])
assert store.load_store("key", lambda _: 42) == (None, 42)
assert store.load_store("key", lambda x: x + 1) == (42, 43)
def test_fs_backend_load_store_loads_from_fallback_dir(tmpdir):
run_dir = tmpdir.mkdir("run_dir")
fb_dir = tmpdir.mkdir("fb_dir")
fallback = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[fb_dir])
fallback.store("key", 42)
store = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[run_dir, fb_dir])
assert store.load_store("key", lambda x: x + 1) == (42, 43)
assert fallback.load("key") == 42, "content in fallback location changed"
def test_fs_backend_load_store_loads_from_fallback_dir_that_is_symlink(tmpdir):
# should deadlock if there is a problem with the lock type or with the
# handling of fallback paths that point to the same principal/write
# directory
run_dir = tmpdir.mkdir("run_dir")
fb_dir = os.path.join(run_dir, "symlink")
try:
os.symlink(run_dir, fb_dir, target_is_directory=True)
except OSError as _:
if sys.platform == "win32":
pytest.skip("unable to create Windows symlink with current permissions")
else:
raise
# don't store any initial value so that the fallback location is checked
store = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[run_dir, fb_dir])
assert store.load_store("key", lambda x: 42) == (None, 42)
fallback = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[fb_dir])
assert fallback.load("key") == 42, "content in fallback symlink did not change"
def test_fs_backend_load_store_is_atomic(tmpdir):
run_dir = tmpdir.mkdir("run_dir")
store = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[run_dir])
store.store("key", 42)
ps = [
mp_ctx.Process(target=_fs_mp_increment_key, args=(run_dir, "prefix", "key", 0.2)),
mp_ctx.Process(target=_fs_mp_increment_key, args=(run_dir, "prefix", "key", 0.2)),
mp_ctx.Process(target=_fs_mp_increment_key, args=(run_dir, "prefix", "key", 0.2)),
]
start_time = time.monotonic()
for p in ps:
p.start()
for p in ps:
p.join()
elapsed = time.monotonic() - start_time
assert store.load("key") == 45
assert elapsed >= 0.2 * len(ps)
def test_fs_backend_loads_honor_load_store_locking(tmpdir):
run_dir = tmpdir.mkdir("run_dir")
store = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[run_dir])
store.store("key", 42)
ps = [
mp_ctx.Process(target=_fs_mp_increment_key, args=(run_dir, "prefix", "key", 0.2)),
mp_ctx.Process(target=_fs_mp_check_key, args=(run_dir, "prefix", "key", 43)),
]
ps[0].start()
time.sleep(0.1)
ps[1].start()
for p in ps:
p.join()
def test_fs_backend_stores_honor_load_store_locking(tmpdir):
run_dir = tmpdir.mkdir("run_dir")
store = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[run_dir])
store.store("key", 42)
ps = [
mp_ctx.Process(target=_fs_mp_increment_key, args=(run_dir, "prefix", "key", 0.2)),
mp_ctx.Process(target=_fs_mp_store_key, args=(run_dir, "prefix", "key", -1)),
]
start_time = time.monotonic()
ps[0].start()
time.sleep(0.1)
ps[1].start()
# join second process first
ps[1].join()
elapsed = time.monotonic() - start_time
assert elapsed >= 0.2
ps[0].join()
assert store.load("key") == -1
def test_fs_backend_releases_locks(tmpdir):
# should deadlock if any method does not properly release its lock
run_dir = tmpdir.mkdir("run_dir")
store = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[run_dir])
def incr_from_other_process():
other = mp_ctx.Process(target=_fs_mp_increment_key, args=(run_dir, "prefix", "key", 0.0))
other.start()
other.join()
store.store("key", 42)
incr_from_other_process()
assert store.load("key") == 43
store.load_store("key", lambda _: -1)
incr_from_other_process()
assert store.load("key") == 0
incr_from_other_process()
assert store.load("key") == 1
def _fs_mp_increment_key(run_dir, prefix, key, sleep):
"""Open a _FilesystemBackend and increment `key`.
For the `multiprocessing` tests.
Opens the storage on `run_dir` and with `prefix`. Sleeps for `sleep`
seconds within the increment closure.
"""
def l(x):
time.sleep(sleep)
return x + 1
store = _FilesystemBackend(key_prefixes=[prefix], runtime_dirs=[run_dir])
store.load_store(key, l)
def _fs_mp_check_key(run_dir, prefix, key, expected):
"""Open a _FilesystemBackend and check `key` value against `expected`.
For the `multiprocessing` tests.
Opens the storage on `run_dir` and with `prefix`.
"""
store = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[run_dir])
assert store.load(key) == expected
def _fs_mp_store_key(run_dir, prefix, key, new_value):
"""Open a _FilesystemBackend and store `new_value` for `key`.
For the `multiprocessing` tests.
Opens the storage on `run_dir` and with `prefix`.
"""
store = _FilesystemBackend(key_prefixes=["prefix"], runtime_dirs=[run_dir])
store.store(key, new_value)
|
