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
|
<?php
declare(strict_types=1);
namespace Doctrine\Tests\ORM\Cache;
use Doctrine\ORM\Cache\CacheKey;
use Doctrine\ORM\Cache\Lock;
use Doctrine\ORM\Cache\Region\DefaultRegion;
use Doctrine\ORM\Cache\Region\FileLockRegion;
use Doctrine\Tests\Mocks\CacheEntryMock;
use Doctrine\Tests\Mocks\CacheKeyMock;
use PHPUnit\Framework\Attributes\Group;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use ReflectionMethod;
use function file_put_contents;
use function is_dir;
use function rmdir;
use function sys_get_temp_dir;
use function uniqid;
use function unlink;
/** @extends RegionTestCase<FileLockRegion> */
#[Group('DDC-2183')]
class FileLockRegionTest extends RegionTestCase
{
protected string $directory;
public function tearDown(): void
{
$this->cleanTestDirectory($this->directory);
}
private function getFileName(FileLockRegion $region, CacheKey $key): string
{
$reflection = new ReflectionMethod($region, 'getLockFileName');
return $reflection->invoke($region, $key);
}
protected function createRegion(int $lockLifetime = 60): FileLockRegion
{
$this->directory = sys_get_temp_dir() . '/doctrine_lock_' . uniqid();
$region = new DefaultRegion('concurren_region_test', $this->cacheItemPool);
return new FileLockRegion($region, $this->directory, $lockLifetime);
}
public function testGetRegionName(): void
{
self::assertEquals('concurren_region_test', $this->region->getName());
}
public function testLockAndUnlock(): void
{
$key = new CacheKeyMock('key');
$entry = new CacheEntryMock(['foo' => 'bar']);
$file = $this->getFileName($this->region, $key);
self::assertFalse($this->region->contains($key));
self::assertTrue($this->region->put($key, $entry));
self::assertTrue($this->region->contains($key));
$lock = $this->region->lock($key);
self::assertFileExists($file);
self::assertInstanceOf(Lock::class, $lock);
self::assertStringEqualsFile($file, $lock->value);
// should be not available after lock
self::assertFalse($this->region->contains($key));
self::assertNull($this->region->get($key));
self::assertTrue($this->region->unlock($key, $lock));
self::assertFileDoesNotExist($file);
}
public function testLockWithExistingLock(): void
{
$key = new CacheKeyMock('key');
$entry = new CacheEntryMock(['foo' => 'bar']);
$file = $this->getFileName($this->region, $key);
self::assertFalse($this->region->contains($key));
self::assertTrue($this->region->put($key, $entry));
self::assertTrue($this->region->contains($key));
file_put_contents($file, 'foo');
self::assertFileExists($file);
self::assertStringEqualsFile($file, 'foo');
self::assertNull($this->region->lock($key));
self::assertStringEqualsFile($file, 'foo');
self::assertFileExists($file);
// should be not available
self::assertFalse($this->region->contains($key));
self::assertNull($this->region->get($key));
}
public function testUnlockWithExistingLock(): void
{
$key = new CacheKeyMock('key');
$entry = new CacheEntryMock(['foo' => 'bar']);
$file = $this->getFileName($this->region, $key);
self::assertFalse($this->region->contains($key));
self::assertTrue($this->region->put($key, $entry));
self::assertTrue($this->region->contains($key));
self::assertInstanceOf(Lock::class, $lock = $this->region->lock($key));
self::assertStringEqualsFile($file, $lock->value);
self::assertFileExists($file);
// change the lock
file_put_contents($file, 'foo');
self::assertFileExists($file);
self::assertStringEqualsFile($file, 'foo');
//try to unlock
self::assertFalse($this->region->unlock($key, $lock));
self::assertStringEqualsFile($file, 'foo');
self::assertFileExists($file);
// should be not available
self::assertFalse($this->region->contains($key));
self::assertNull($this->region->get($key));
}
public function testPutWithExistingLock(): void
{
$key = new CacheKeyMock('key');
$entry = new CacheEntryMock(['foo' => 'bar']);
$file = $this->getFileName($this->region, $key);
self::assertFalse($this->region->contains($key));
self::assertTrue($this->region->put($key, $entry));
self::assertTrue($this->region->contains($key));
// create lock
file_put_contents($file, 'foo');
self::assertFileExists($file);
self::assertStringEqualsFile($file, 'foo');
self::assertFalse($this->region->contains($key));
self::assertFalse($this->region->put($key, $entry));
self::assertFalse($this->region->contains($key));
self::assertFileExists($file);
self::assertStringEqualsFile($file, 'foo');
}
public function testLockedEvict(): void
{
$key = new CacheKeyMock('key');
$entry = new CacheEntryMock(['foo' => 'bar']);
$file = $this->getFileName($this->region, $key);
self::assertFalse($this->region->contains($key));
self::assertTrue($this->region->put($key, $entry));
self::assertTrue($this->region->contains($key));
self::assertInstanceOf(Lock::class, $lock = $this->region->lock($key));
self::assertStringEqualsFile($file, $lock->value);
self::assertFileExists($file);
self::assertFalse($this->region->contains($key));
self::assertTrue($this->region->evict($key));
self::assertFalse($this->region->contains($key));
self::assertFileDoesNotExist($file);
}
public function testLockedEvictAll(): void
{
$key1 = new CacheKeyMock('key1');
$entry1 = new CacheEntryMock(['foo1' => 'bar1']);
$file1 = $this->getFileName($this->region, $key1);
$key2 = new CacheKeyMock('key2');
$entry2 = new CacheEntryMock(['foo2' => 'bar2']);
$file2 = $this->getFileName($this->region, $key2);
self::assertFalse($this->region->contains($key1));
self::assertTrue($this->region->put($key1, $entry1));
self::assertTrue($this->region->contains($key1));
self::assertFalse($this->region->contains($key2));
self::assertTrue($this->region->put($key2, $entry2));
self::assertTrue($this->region->contains($key2));
self::assertInstanceOf(Lock::class, $lock1 = $this->region->lock($key1));
self::assertInstanceOf(Lock::class, $lock2 = $this->region->lock($key2));
self::assertStringEqualsFile($file2, $lock2->value);
self::assertStringEqualsFile($file1, $lock1->value);
self::assertFileExists($file1);
self::assertFileExists($file2);
self::assertTrue($this->region->evictAll());
self::assertFileDoesNotExist($file1);
self::assertFileDoesNotExist($file2);
self::assertFalse($this->region->contains($key1));
self::assertFalse($this->region->contains($key2));
}
public function testLockLifetime(): void
{
$this->region = $this->createRegion(-10);
$key = new CacheKeyMock('key');
$entry = new CacheEntryMock(['foo' => 'bar']);
$file = $this->getFileName($this->region, $key);
self::assertFalse($this->region->contains($key));
self::assertTrue($this->region->put($key, $entry));
self::assertTrue($this->region->contains($key));
self::assertInstanceOf(Lock::class, $lock = $this->region->lock($key));
self::assertStringEqualsFile($file, $lock->value);
self::assertFileExists($file);
// outdated lock should be removed
self::assertTrue($this->region->contains($key));
self::assertNotNull($this->region->get($key));
self::assertFileDoesNotExist($file);
}
private function cleanTestDirectory(string|null $path): void
{
$path = $path ?: $this->directory;
if (! is_dir($path)) {
return;
}
$directoryIterator = new RecursiveIteratorIterator(
new RecursiveDirectoryIterator($path),
RecursiveIteratorIterator::CHILD_FIRST,
);
foreach ($directoryIterator as $file) {
if ($file->isFile()) {
@unlink((string) $file->getRealPath());
} else {
@rmdir((string) $file->getRealPath());
}
}
}
}
|
