-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathtest_utils_flock.py
265 lines (232 loc) · 7.7 KB
/
test_utils_flock.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
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
from multiprocessing import Process, Event
import time
from unittest import mock
import pytest
from buildrunner.utils import (
FailureToAcquireLockException,
acquire_flock_open_read_binary,
acquire_flock_open_write_binary,
release_flock,
)
@pytest.fixture(name="mock_logger")
def fixture_mock_logger():
mock_logger = mock.MagicMock()
mock_logger.info.side_effect = lambda message: print(f"[info] {message}")
mock_logger.warning.side_effect = lambda message: print(f"[warning] {message}")
return mock_logger
def _get_and_hold_lock(
ready_event: Event, done_event: Event, lock_file, exclusive=True, timeout_seconds=2
):
fd = None
mock_logger = mock.MagicMock()
mock_logger.info.side_effect = lambda message: print(
f"[get-and-hold-info] {message}"
)
mock_logger.warning.side_effect = lambda message: print(
f"[get-and-hold-warning] {message}"
)
try:
if exclusive:
fd = acquire_flock_open_write_binary(
lock_file=lock_file, logger=mock_logger, timeout_seconds=timeout_seconds
)
else:
fd = acquire_flock_open_read_binary(
lock_file=lock_file, logger=mock_logger, timeout_seconds=timeout_seconds
)
assert fd is not None
print(
f"Acquired lock for file {lock_file} in background process (exclusive={exclusive})"
)
ready_event.set()
done_event.wait()
finally:
release_flock(fd, mock_logger)
def _wait_and_set(event: Event, sleep_seconds: float):
time.sleep(sleep_seconds)
event.set()
def test_flock_acquire1(mock_logger, tmp_path):
try:
fd = None
lock_file = str(tmp_path / "mylock.file")
fd = acquire_flock_open_write_binary(
lock_file=lock_file, logger=mock_logger, timeout_seconds=1.0
)
assert fd is not None
finally:
if fd:
release_flock(fd, mock_logger)
def test_flock_exclusive_acquire(mock_logger, tmp_path):
try:
lock_file = str(tmp_path / "mylock.file")
fd = None
# Test exclusive followed by exclusive acquire
ready_event = Event()
done_event = Event()
p = Process(
target=_get_and_hold_lock, args=(ready_event, done_event, lock_file)
)
p.start()
ready_event.wait()
with pytest.raises(FailureToAcquireLockException):
fd = acquire_flock_open_write_binary(
lock_file, mock_logger, timeout_seconds=1.0
)
assert fd is None
done_event.set()
p.join()
# Test shared followed by exclusive acquire
ready_event.clear()
done_event.clear()
p = Process(
target=_get_and_hold_lock, args=(ready_event, done_event, lock_file, False)
)
p.start()
ready_event.wait()
with pytest.raises(FailureToAcquireLockException):
fd = acquire_flock_open_write_binary(
lock_file, mock_logger, timeout_seconds=1.0
)
assert fd is None
done_event.set()
p.join()
# Test exclusive followed by shared acquire
ready_event.clear()
done_event.clear()
p = Process(
target=_get_and_hold_lock, args=(ready_event, done_event, lock_file, True)
)
p.start()
ready_event.wait()
with pytest.raises(FailureToAcquireLockException):
fd = acquire_flock_open_read_binary(
lock_file, mock_logger, timeout_seconds=1.0
)
assert fd is None
done_event.set()
p.join()
finally:
if fd:
release_flock(fd, mock_logger)
def test_flock_release(mock_logger, tmp_path):
fd = None
try:
lock_file = str(tmp_path / "mylock.file")
ready_event = Event()
done_event = Event()
p = Process(
target=_get_and_hold_lock, args=(ready_event, done_event, lock_file)
)
p.start()
ready_event.wait()
p2 = Process(target=_wait_and_set, args=(done_event, 1.0))
p2.start()
fd = acquire_flock_open_write_binary(
lock_file, mock_logger, timeout_seconds=5.0
)
assert fd is not None
p.join()
p2.join()
finally:
if fd:
release_flock(fd, mock_logger)
def test_flock_acquire_exclusive_timeout(mock_logger, tmp_path):
try:
lock_file = str(tmp_path / "mylock.file")
fd = None
# Test exclusive followed by exclusive acquire
ready_event = Event()
done_event = Event()
p = Process(
target=_get_and_hold_lock, args=(ready_event, done_event, lock_file)
)
p.start()
ready_event.wait()
timeout_seconds = 5
start_time = time.time()
with pytest.raises(FailureToAcquireLockException):
fd = acquire_flock_open_write_binary(
lock_file, mock_logger, timeout_seconds=timeout_seconds
)
duration_seconds = time.time() - start_time
tolerance_seconds = 0.6
assert (
(timeout_seconds - tolerance_seconds)
<= duration_seconds
<= (timeout_seconds + tolerance_seconds)
)
assert fd is None
done_event.set()
p.join()
# Test exclusive followed by shared acquire
ready_event.clear()
done_event.clear()
p = Process(
target=_get_and_hold_lock, args=(ready_event, done_event, lock_file)
)
p.start()
ready_event.wait()
timeout_seconds = 5
start_time = time.time()
with pytest.raises(FailureToAcquireLockException):
fd = acquire_flock_open_read_binary(
lock_file, mock_logger, timeout_seconds=timeout_seconds
)
duration_seconds = time.time() - start_time
tolerance_seconds = 0.6
assert (
(timeout_seconds - tolerance_seconds)
<= duration_seconds
<= (timeout_seconds + tolerance_seconds)
)
assert fd is None
done_event.set()
p.join()
# Test shared followed by exclusive acquire
ready_event.clear()
done_event.clear()
p = Process(
target=_get_and_hold_lock, args=(ready_event, done_event, lock_file, False)
)
p.start()
ready_event.wait()
timeout_seconds = 5
start_time = time.time()
with pytest.raises(FailureToAcquireLockException):
fd = acquire_flock_open_write_binary(
lock_file, mock_logger, timeout_seconds=timeout_seconds
)
duration_seconds = time.time() - start_time
tolerance_seconds = 0.6
assert (
(timeout_seconds - tolerance_seconds)
<= duration_seconds
<= (timeout_seconds + tolerance_seconds)
)
assert fd is None
done_event.set()
p.join()
finally:
if fd:
release_flock(fd, mock_logger)
def test_flock_shared_acquire(mock_logger, tmp_path):
try:
lock_file = str(tmp_path / "mylock.file")
# Lock file needs to be created
with open(lock_file, "w") as file:
file.write("Test file.")
fd = None
ready_event = Event()
done_event = Event()
p = Process(
target=_get_and_hold_lock, args=(ready_event, done_event, lock_file, False)
)
p.start()
ready_event.wait()
fd = acquire_flock_open_read_binary(lock_file, mock_logger, timeout_seconds=1.0)
assert fd is not None
done_event.set()
p.join()
finally:
if fd:
release_flock(fd, mock_logger)