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
|
<?php
declare(strict_types=1);
namespace malkusch\lock\Tests\mutex;
use malkusch\lock\exception\LockAcquireException;
use malkusch\lock\mutex\TransactionalMutex;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
/**
* Set the environment variables MYSQL_DSN, MYSQL_USER for this test.
*/
class TransactionalMutexTest extends TestCase
{
/**
* Tests building the mutex with an invalid error mode.
*
* @dataProvider provideInvalidErrorModeCases
*/
#[DataProvider('provideInvalidErrorModeCases')]
public function testInvalidErrorMode(int $mode): void
{
$this->expectException(\InvalidArgumentException::class);
$pdo = new \PDO('sqlite::memory:');
$pdo->setAttribute(\PDO::ATTR_ERRMODE, $mode);
new TransactionalMutex($pdo);
}
/**
* @return iterable<list<mixed>>
*/
public static function provideInvalidErrorModeCases(): iterable
{
yield [\PDO::ERRMODE_SILENT];
yield [\PDO::ERRMODE_WARNING];
}
/**
* Tests BEGIN fails.
*/
public function testBeginFails(): void
{
$this->expectException(LockAcquireException::class);
$this->expectExceptionMessage('Could not begin transaction');
$pdo = $this->buildMySqlPdo();
$pdo->setAttribute(\PDO::MYSQL_ATTR_USE_BUFFERED_QUERY, false);
$stmt = $pdo->prepare('SELECT 1 FROM DUAL');
$stmt->execute();
$mutex = new TransactionalMutex($pdo);
$mutex->synchronized(static function (): void {});
}
/**
* Tests that an exception in the critical code causes a ROLLBACK.
*/
public function testExceptionRollsback(): void
{
$pdo = $this->buildMySqlPdo();
$mutex = new TransactionalMutex($pdo);
$pdo->exec('
CREATE TEMPORARY TABLE testExceptionRollsback(
id int primary key
) engine=innodb
');
try {
$mutex->synchronized(static function () use ($pdo): void {
$pdo->exec('INSERT INTO testExceptionRollsback VALUES(1)');
throw new \DomainException();
});
} catch (\DomainException $e) {
// expected
}
$count = $pdo->query('SELECT count(*) FROM testExceptionRollsback')->fetchColumn();
self::assertSame(0, \PHP_VERSION_ID < 8_01_00 ? (int) $count : $count);
}
/**
* Tests that a ROLLBACK caused by an exception fails.
*/
public function testFailExceptionRollsback(): void
{
$pdo = $this->buildMySqlPdo();
$mutex = new TransactionalMutex($pdo);
$this->expectException(LockAcquireException::class);
$mutex->synchronized(static function () use ($pdo) {
// This will provoke the mutex' rollback to fail.
$pdo->rollBack();
throw new \DomainException();
});
}
/**
* Tests replaying the transaction.
*
* @dataProvider provideReplayTransactionCases
*/
#[DataProvider('provideReplayTransactionCases')]
public function testReplayTransaction(\Exception $exception): void
{
$pdo = $this->buildMySqlPdo();
$mutex = new TransactionalMutex($pdo);
$pdo->exec('
CREATE TEMPORARY TABLE testExceptionRollsback(
id int primary key
) engine=innodb
');
$i = 0;
$mutex->synchronized(static function () use ($pdo, &$i, $exception) {
++$i;
$count = $pdo->query('SELECT count(*) FROM testExceptionRollsback')->fetchColumn();
self::assertSame(0, \PHP_VERSION_ID < 8_01_00 ? (int) $count : $count);
$pdo->exec('INSERT INTO testExceptionRollsback VALUES(1)');
// this provokes the replay
if ($i < 5) {
throw $exception;
}
});
$count = $pdo->query('SELECT count(*) FROM testExceptionRollsback')->fetchColumn();
self::assertSame(1, \PHP_VERSION_ID < 8_01_00 ? (int) $count : $count);
self::assertSame(5, $i);
}
/**
* @return iterable<list<mixed>>
*/
public static function provideReplayTransactionCases(): iterable
{
yield [new \PDOException()];
yield [new \Exception('', 0, new \PDOException())];
}
/**
* Tests failing a ROLLBACK after the failed COMMIT.
*/
public function testRollbackAfterFailedCommitFails(): void
{
$this->expectException(LockAcquireException::class);
$this->expectExceptionMessage('Could not roll back transaction:');
$pdo = $this->buildMySqlPdo();
$mutex = new TransactionalMutex($pdo);
$mutex->synchronized(static function () use ($pdo) {
// This will provoke the mutex' commit and rollback to fail.
$pdo->rollBack();
});
}
/**
* Builds a MySQL PDO.
*
* Please provide these environment variables:
*
* - MYSQL_DSN
* - MYSQL_USER
* - MYSQL_PASSWORD
*/
private function buildMySqlPdo(): \PDO
{
if (!getenv('MYSQL_DSN')) {
self::markTestSkipped('MySQL server is needed');
}
$dsn = getenv('MYSQL_DSN');
$user = getenv('MYSQL_USER');
$password = getenv('MYSQL_PASSWORD');
$pdo = new \PDO($dsn, $user, $password);
$pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
return $pdo;
}
}
|
