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
|
<?php
declare(strict_types=1);
namespace Doctrine\Tests\ORM\Functional\Locking;
use Doctrine\DBAL\LockMode;
use Doctrine\Tests\Models\CMS\CmsArticle;
use Doctrine\Tests\OrmFunctionalTestCase;
use GearmanClient;
use PHPUnit\Framework\Attributes\Group;
use function class_exists;
use function max;
use function serialize;
#[Group('locking_functional')]
class GearmanLockTest extends OrmFunctionalTestCase
{
private GearmanClient|null $gearman = null;
private int $maxRunTime = 0;
private int $articleId;
protected function setUp(): void
{
if (! class_exists('GearmanClient', false)) {
self::markTestSkipped('pecl/gearman is required for this test to run.');
}
$this->useModelSet('cms');
parent::setUp();
$this->tasks = [];
$this->gearman = new GearmanClient();
$this->gearman->addServer(
$_SERVER['GEARMAN_HOST'] ?? null,
$_SERVER['GEARMAN_PORT'] ?? 4730,
);
$this->gearman->setCompleteCallback([$this, 'gearmanTaskCompleted']);
$article = new CmsArticle();
$article->text = 'my article';
$article->topic = 'Hello';
$this->_em->persist($article);
$this->_em->flush();
$this->articleId = $article->id;
}
public function gearmanTaskCompleted($task): void
{
$this->maxRunTime = max($this->maxRunTime, $task->data());
}
public function testFindWithLock(): void
{
$this->asyncFindWithLock(CmsArticle::class, $this->articleId, LockMode::PESSIMISTIC_WRITE);
$this->asyncFindWithLock(CmsArticle::class, $this->articleId, LockMode::PESSIMISTIC_WRITE);
$this->assertLockWorked();
}
public function testFindWithWriteThenReadLock(): void
{
$this->asyncFindWithLock(CmsArticle::class, $this->articleId, LockMode::PESSIMISTIC_WRITE);
$this->asyncFindWithLock(CmsArticle::class, $this->articleId, LockMode::PESSIMISTIC_READ);
$this->assertLockWorked();
}
public function testFindWithReadThenWriteLock(): void
{
$this->asyncFindWithLock(CmsArticle::class, $this->articleId, LockMode::PESSIMISTIC_READ);
$this->asyncFindWithLock(CmsArticle::class, $this->articleId, LockMode::PESSIMISTIC_WRITE);
$this->assertLockWorked();
}
public function testFindWithOneLock(): void
{
$this->asyncFindWithLock(CmsArticle::class, $this->articleId, LockMode::PESSIMISTIC_WRITE);
$this->asyncFindWithLock(CmsArticle::class, $this->articleId, LockMode::NONE);
$this->assertLockDoesNotBlock();
}
public function testDqlWithLock(): void
{
$this->asyncDqlWithLock('SELECT a FROM Doctrine\Tests\Models\CMS\CmsArticle a', [], LockMode::PESSIMISTIC_WRITE);
$this->asyncFindWithLock(CmsArticle::class, $this->articleId, LockMode::PESSIMISTIC_WRITE);
$this->assertLockWorked();
}
public function testLock(): void
{
$this->asyncFindWithLock(CmsArticle::class, $this->articleId, LockMode::PESSIMISTIC_WRITE);
$this->asyncLock(CmsArticle::class, $this->articleId, LockMode::PESSIMISTIC_WRITE);
$this->assertLockWorked();
}
public function testLock2(): void
{
$this->asyncFindWithLock(CmsArticle::class, $this->articleId, LockMode::PESSIMISTIC_WRITE);
$this->asyncLock(CmsArticle::class, $this->articleId, LockMode::PESSIMISTIC_READ);
$this->assertLockWorked();
}
public function testLock3(): void
{
$this->asyncFindWithLock(CmsArticle::class, $this->articleId, LockMode::PESSIMISTIC_READ);
$this->asyncLock(CmsArticle::class, $this->articleId, LockMode::PESSIMISTIC_WRITE);
$this->assertLockWorked();
}
public function testLock4(): void
{
$this->asyncFindWithLock(CmsArticle::class, $this->articleId, LockMode::NONE);
$this->asyncLock(CmsArticle::class, $this->articleId, LockMode::PESSIMISTIC_WRITE);
$this->assertLockDoesNotBlock();
}
protected function assertLockDoesNotBlock(): void
{
$this->assertLockWorked($onlyForSeconds = 1);
}
protected function assertLockWorked($forTime = 2, $notLongerThan = null): void
{
if ($notLongerThan === null) {
$notLongerThan = $forTime + 1;
}
$this->gearman->runTasks();
self::assertTrue(
$this->maxRunTime > $forTime,
'Because of locking this tests should have run at least ' . $forTime . ' seconds, ' .
'but only did for ' . $this->maxRunTime . ' seconds.',
);
self::assertTrue(
$this->maxRunTime < $notLongerThan,
'The longest task should not run longer than ' . $notLongerThan . ' seconds, ' .
'but did for ' . $this->maxRunTime . ' seconds.',
);
}
protected function asyncFindWithLock($entityName, $entityId, $lockMode): void
{
$this->startJob('findWithLock', [
'entityName' => $entityName,
'entityId' => $entityId,
'lockMode' => $lockMode,
]);
}
protected function asyncDqlWithLock($dql, $params, $lockMode): void
{
$this->startJob('dqlWithLock', [
'dql' => $dql,
'dqlParams' => $params,
'lockMode' => $lockMode,
]);
}
protected function asyncLock($entityName, $entityId, $lockMode): void
{
$this->startJob('lock', [
'entityName' => $entityName,
'entityId' => $entityId,
'lockMode' => $lockMode,
]);
}
protected function startJob($fn, $fixture): void
{
$this->gearman->addTask($fn, serialize(
[
'conn' => $this->_em->getConnection()->getParams(),
'fixture' => $fixture,
],
));
self::assertEquals(GEARMAN_SUCCESS, $this->gearman->returnCode());
}
}
|