Files
predis/tests/Predis/Connection/Replication/SentinelReplicationTest.php
T

2027 lines
70 KiB
PHP

<?php
/*
* This file is part of the Predis package.
*
* (c) 2009-2020 Daniele Alessandri
* (c) 2021-2026 Till Krüss
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Predis\Connection\Replication;
use Exception;
use PHPUnit\Framework\MockObject\MockObject;
use Predis\Command;
use Predis\Connection;
use Predis\Connection\Parameters;
use Predis\Connection\ParametersInterface;
use Predis\Connection\Resource\StreamFactoryInterface;
use Predis\Connection\StreamConnection;
use Predis\Replication;
use Predis\Response;
use Predis\Retry\Retry;
use Predis\Retry\Strategy\ExponentialBackoff;
use PredisTestCase;
use Psr\Http\Message\StreamInterface;
use ReflectionProperty;
use RuntimeException;
class SentinelReplicationTest extends PredisTestCase
{
/**
* @group disconnected
*/
public function testMethodGetSentinelConnectionThrowsExceptionOnEmptySentinelsPool(): void
{
$this->expectException('Predis\ClientException');
$this->expectExceptionMessage('No sentinel server available for autodiscovery.');
$replication = $this->getReplicationConnection('svc', []);
$replication->getSentinelConnection();
}
/**
* @group disconnected
*/
public function testParametersForSentinelConnectionShouldUsePasswordForAuthentication(): void
{
$replication = $this->getReplicationConnection('svc', [
'tcp://127.0.0.1:5381?alias=sentinel1&password=secret',
]);
$parameters = $replication->getSentinelConnection()->getParameters()->toArray();
$this->assertArrayHasKey('password', $parameters, 'Parameter `passwords` was expected to exist in connection parameters');
}
/**
* @group disconnected
*/
public function testParametersForSentinelConnectionShouldIgnoreDatabase(): void
{
$replication = $this->getReplicationConnection('svc', [
'tcp://127.0.0.1:5381?role=sentinel&database=1&username=myusername&password=password',
]);
$parameters = $replication->getSentinelConnection()->getParameters()->toArray();
$this->assertArrayNotHasKey('database', $parameters, 'Parameter `database` was expected to not exist in connection parameters');
$this->assertArrayHasKey('username', $parameters, 'Parameter `username` was expected to not exist in connection parameters');
$this->assertArrayHasKey('password', $parameters, 'Parameter `password` was expected to not exist in connection parameters');
}
/**
* @group disconnected
*/
public function testParametersForSentinelConnectionHaveDefaultTimeout(): void
{
$replication = $this->getReplicationConnection('svc', [
'tcp://127.0.0.1:5381?role=sentinel',
]);
$parameters = $replication->getSentinelConnection()->getParameters()->toArray();
$this->assertArrayHasKey('timeout', $parameters);
$this->assertSame(0.100, $parameters['timeout']);
}
/**
* @group disconnected
*/
public function testParametersForSentinelConnectionCanOverrideDefaultTimeout(): void
{
$replication = $this->getReplicationConnection('svc', [
'tcp://127.0.0.1:5381?role=sentinel&timeout=1',
]);
$parameters = $replication
->getSentinelConnection()
->getParameters()
->toArray();
$this->assertArrayHasKey('timeout', $parameters);
$this->assertSame('1', $parameters['timeout']);
}
/**
* @group disconnected
*/
public function testConnectionParametersInstanceForSentinelConnectionIsNotModified(): void
{
$originalParameters = Parameters::create(
'tcp://127.0.0.1:5381?role=sentinel&database=1&password=secret'
);
$replication = $this->getReplicationConnection('svc', [$originalParameters]);
$parameters = $replication
->getSentinelConnection()
->getParameters();
$this->assertSame($originalParameters, $parameters);
$this->assertNotNull($parameters->password);
$this->assertNotNull($parameters->database);
}
/**
* @group disconnected
*/
public function testConnectionParametersInstanceForSentinelConnectionIsNotModifiedEmptyPassword(): void
{
$sentinel1 = Parameters::create('tcp://127.0.0.1:5381?role=sentinel&database=1&password=');
$sentinel2 = Parameters::create('tcp://127.0.0.1:5381?role=sentinel&database=1');
$replication1 = $this->getReplicationConnection('svc', [$sentinel1]);
$replication2 = $this->getReplicationConnection('svc', [$sentinel2]);
$parameters1 = $replication1->getSentinelConnection()->getParameters();
$parameters2 = $replication2->getSentinelConnection()->getParameters();
$this->assertSame($sentinel1, $parameters1);
$this->assertSame($sentinel2, $parameters2);
$this->assertNull($parameters1->password);
$this->assertNull($parameters2->password);
$this->assertNotNull($parameters1->database);
$this->assertNotNull($parameters2->database);
}
/**
* @group disconnected
*/
public function testMethodGetSentinelConnectionReturnsFirstAvailableSentinel(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel&alias=sentinel1');
$sentinel2 = $this->getMockSentinelConnection('tcp://127.0.0.1:5382?role=sentinel&alias=sentinel2');
$sentinel3 = $this->getMockSentinelConnection('tcp://127.0.0.1:5383?role=sentinel&alias=sentinel3');
$replication = $this->getReplicationConnection('svc', [$sentinel1, $sentinel2, $sentinel3]);
$this->assertSame($sentinel1, $replication->getSentinelConnection());
}
/**
* @group disconnected
*/
public function testMethodAddAttachesMasterOrSlaveNodesToReplication(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave2 = $this->getMockConnection('tcp://127.0.0.1:6383?role=slave');
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->add($slave1);
$replication->add($slave2);
$this->assertSame($master, $replication->getConnectionById('127.0.0.1:6381'));
$this->assertSame($slave1, $replication->getConnectionById('127.0.0.1:6382'));
$this->assertSame($slave2, $replication->getConnectionById('127.0.0.1:6383'));
$this->assertSame($master, $replication->getMaster());
$this->assertSame([$slave1, $slave2], $replication->getSlaves());
}
/**
* @group disconnected
* @FIXME
*/
public function testMethodRemoveDismissesMasterOrSlaveNodesFromReplication(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave2 = $this->getMockConnection('tcp://127.0.0.1:6383?role=slave');
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->add($slave1);
$replication->add($slave2);
$this->assertTrue($replication->remove($slave1));
$this->assertTrue($replication->remove($sentinel1));
$this->assertSame('127.0.0.1:6381', (string) $replication->getMaster());
$this->assertCount(1, $slaves = $replication->getSlaves());
$this->assertSame('127.0.0.1:6383', (string) $slaves[0]);
}
/**
* @group disconnected
*/
public function testMethodGetConnectionByIdOnEmptyReplication(): void
{
$replication = $this->getReplicationConnection('svc', []);
$this->assertNull($replication->getConnectionById('127.0.0.1:6381'));
}
/**
* @group disconnected
*/
public function testMethodGetConnectionByRole(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$replication = $this->getReplicationConnection('svc', []);
$replication->add($master);
$replication->add($slave1);
$replication->add($sentinel1);
$this->assertSame($sentinel1, $replication->getConnectionByRole('sentinel'));
$this->assertSame($master, $replication->getConnectionByRole('master'));
$this->assertSame($slave1, $replication->getConnectionByRole('slave'));
}
/**
* @group disconnected
*/
public function testMethodGetConnectionByRoleOnEmptyReplicationForcesSentinelQueries(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->exactly(2))
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('SENTINEL', ['get-master-addr-by-name', 'svc'])],
[$this->isRedisCommand('SENTINEL', ['slaves', 'svc'])]
)
->willReturnOnConsecutiveCalls(
// SENTINEL get-master-addr-by-name svc
['127.0.0.1', '6381'],
// SENTINEL slaves svc
[
[
'name', '127.0.0.1:6382',
'ip', '127.0.0.1',
'port', '6382',
'runid', '112cdebd22924a7d962be496f3a1c4c7c9bad93f',
'flags', 'slave',
'master-host', '127.0.0.1',
'master-port', '6381',
],
]
);
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$this->assertSame($sentinel1, $replication->getConnectionByRole('sentinel'));
$this->assertInstanceOf('Predis\Connection\NodeConnectionInterface', $replication->getConnectionByRole('master'));
$this->assertInstanceOf('Predis\Connection\NodeConnectionInterface', $replication->getConnectionByRole('slave'));
}
/**
* @group disconnected
*/
public function testMethodGetConnectionByRoleUnknown(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$replication = $this->getReplicationConnection('svc', []);
$replication->add($master);
$replication->add($slave1);
$replication->add($sentinel1);
$this->assertNull($replication->getConnectionByRole('unknown'));
}
/**
* @group disconnected
*/
public function testMethodUpdateSentinelsFetchesSentinelNodes(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->once())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', ['sentinels', 'svc']
))
->willReturn(
[
[
'name', '127.0.0.1:5382',
'ip', '127.0.0.1',
'port', '5382',
'runid', 'a113aa7a0d4870a85bb22b4b605fd26eb93ed40e',
'flags', 'sentinel',
],
[
'name', '127.0.0.1:5383',
'ip', '127.0.0.1',
'port', '5383',
'runid', 'f53b52d281be5cdd4873700c94846af8dbe47209',
'flags', 'sentinel',
],
]
);
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->updateSentinels();
// TODO: sorry for the smell...
$reflection = new ReflectionProperty($replication, 'sentinels');
$reflection->setAccessible(true);
$expected = [
['host' => '127.0.0.1', 'port' => '5381'],
['host' => '127.0.0.1', 'port' => '5382'],
['host' => '127.0.0.1', 'port' => '5383'],
];
$this->assertSame($sentinel1, $replication->getSentinelConnection());
$this->assertSame($expected, array_intersect_key($expected, $reflection->getValue($replication)));
}
/**
* @group disconnected
*/
public function testMethodUpdateSentinelsRemovesCurrentSentinelAndRetriesNextOneOnFailure(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel&alias=sentinel1');
$sentinel1
->expects($this->once())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', ['sentinels', 'svc']
))
->willThrowException(
new Connection\ConnectionException($sentinel1, 'Unknown connection error [127.0.0.1:5381]')
);
$sentinel2 = $this->getMockSentinelConnection('tcp://127.0.0.1:5382?role=sentinel&alias=sentinel2');
$sentinel2
->expects($this->once())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', ['sentinels', 'svc']
))
->willReturn(
[
[
'name', '127.0.0.1:5383',
'ip', '127.0.0.1',
'port', '5383',
'runid', 'f53b52d281be5cdd4873700c94846af8dbe47209',
'flags', 'sentinel',
],
]
);
$replication = $this->getReplicationConnection('svc', [$sentinel1, $sentinel2]);
$replication->updateSentinels();
// TODO: sorry for the smell...
$reflection = new ReflectionProperty($replication, 'sentinels');
$reflection->setAccessible(true);
$expected = [
['host' => '127.0.0.1', 'port' => '5382'],
['host' => '127.0.0.1', 'port' => '5383'],
];
$this->assertSame($sentinel2, $replication->getSentinelConnection());
$this->assertSame($expected, array_intersect_key($expected, $reflection->getValue($replication)));
}
/**
* @group disconnected
*/
public function testMethodUpdateSentinelsThrowsExceptionOnNoAvailableSentinel(): void
{
$this->expectException('Predis\ClientException');
$this->expectExceptionMessage('No sentinel server available for autodiscovery.');
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->once())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', ['sentinels', 'svc']
))
->willThrowException(
new Connection\ConnectionException($sentinel1, 'Unknown connection error [127.0.0.1:5381]')
);
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->updateSentinels();
}
/**
* @group disconnected
*/
public function testMethodQuerySentinelFetchesMasterNodeSlaveNodesAndSentinelNodes(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel&alias=sentinel1');
$sentinel1
->expects($this->exactly(3))
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('SENTINEL', ['sentinels', 'svc'])],
[$this->isRedisCommand('SENTINEL', ['get-master-addr-by-name', 'svc'])],
[$this->isRedisCommand('SENTINEL', ['slaves', 'svc'])]
)
->willReturnOnConsecutiveCalls(
// SENTINEL sentinels svc
[
[
'name', '127.0.0.1:5382',
'ip', '127.0.0.1',
'port', '5382',
'runid', 'a113aa7a0d4870a85bb22b4b605fd26eb93ed40e',
'flags', 'sentinel',
],
],
// SENTINEL get-master-addr-by-name svc
['127.0.0.1', '6381'],
// SENTINEL slaves svc
[
[
'name', '127.0.0.1:6382',
'ip', '127.0.0.1',
'port', '6382',
'runid', '112cdebd22924a7d962be496f3a1c4c7c9bad93f',
'flags', 'slave',
'master-host', '127.0.0.1',
'master-port', '6381',
],
[
'name', '127.0.0.1:6383',
'ip', '127.0.0.1',
'port', '6383',
'runid', '1c0bf1291797fbc5608c07a17da394147dc62817',
'flags', 'slave',
'master-host', '127.0.0.1',
'master-port', '6381',
],
]
);
$sentinel2 = $this->getMockSentinelConnection('tcp://127.0.0.1:5382?role=sentinel&alias=sentinel2');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave2 = $this->getMockConnection('tcp://127.0.0.1:6383?role=slave');
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->querySentinel();
// TODO: sorry for the smell...
$reflection = new ReflectionProperty($replication, 'sentinels');
$reflection->setAccessible(true);
$sentinels = [
['host' => '127.0.0.1', 'port' => '5381'],
['host' => '127.0.0.1', 'port' => '5382'],
];
$this->assertSame($sentinel1, $replication->getSentinelConnection());
$this->assertSame($sentinels, array_intersect_key($sentinels, $reflection->getValue($replication)));
$master = $replication->getMaster();
$slaves = $replication->getSlaves();
$this->assertSame('127.0.0.1:6381', (string) $master);
$this->assertCount(2, $slaves);
$this->assertSame('127.0.0.1:6382', (string) $slaves[0]);
$this->assertSame('127.0.0.1:6383', (string) $slaves[1]);
}
/**
* @group disconnected
*/
public function testMethodGetMasterAsksSentinelForMasterOnMasterNotSet(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->once())
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('SENTINEL', ['get-master-addr-by-name', 'svc'])]
)
->willReturnOnConsecutiveCalls(
['127.0.0.1', '6381']
);
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$this->assertSame('127.0.0.1:6381', (string) $replication->getMaster());
}
/**
* @group disconnected
*/
public function testMethodGetMasterThrowsExceptionOnNoAvailableSentinels(): void
{
$this->expectException('Predis\ClientException');
$this->expectExceptionMessage('No sentinel server available for autodiscovery.');
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->any())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', ['get-master-addr-by-name', 'svc']
))
->willThrowException(
new Connection\ConnectionException($sentinel1, 'Unknown connection error [127.0.0.1:5381]')
);
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->getMaster();
}
/**
* @group disconnected
*/
public function testMethodGetSlavesOnEmptySlavePoolAsksSentinelForSlaves(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->once())
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('SENTINEL', ['slaves', 'svc'])]
)
->willReturnOnConsecutiveCalls(
[
[
'name', '127.0.0.1:6382',
'ip', '127.0.0.1',
'port', '6382',
'runid', '112cdebd22924a7d962be496f3a1c4c7c9bad93f',
'flags', 'slave',
'master-host', '127.0.0.1',
'master-port', '6381',
],
[
'name', '127.0.0.1:6383',
'ip', '127.0.0.1',
'port', '6383',
'runid', '1c0bf1291797fbc5608c07a17da394147dc62817',
'flags', 'slave',
'master-host', '127.0.0.1',
'master-port', '6381',
],
]
);
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$slaves = $replication->getSlaves();
$this->assertSame('127.0.0.1:6382', (string) $slaves[0]);
$this->assertSame('127.0.0.1:6383', (string) $slaves[1]);
}
/**
* @group disconnected
*/
public function testMethodGetSlavesThrowsExceptionOnNoAvailableSentinels(): void
{
$this->expectException('Predis\ClientException');
$this->expectExceptionMessage('No sentinel server available for autodiscovery.');
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->any())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', ['slaves', 'svc']
))
->willThrowException(
new Connection\ConnectionException($sentinel1, 'Unknown connection error [127.0.0.1:5381]')
);
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->getSlaves();
}
/**
* @group disconnected
*/
public function testMethodConnectThrowsExceptionOnConnectWithEmptySentinelsPool(): void
{
$this->expectException('Predis\ClientException');
$this->expectExceptionMessage('No sentinel server available for autodiscovery.');
$replication = $this->getReplicationConnection('svc', []);
$replication->connect();
}
/**
* @group disconnected
*/
public function testMethodConnectForcesConnectionToSlave(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->never())
->method('connect');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave1
->expects($this->once())
->method('connect');
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->add($slave1);
$replication->connect();
}
/**
* @group disconnected
*/
public function testMethodConnectOnEmptySlavePoolAsksSentinelForSlavesAndForcesConnectionToSlave(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->any())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', ['slaves', 'svc']
))
->willReturn(
[
[
'name', '127.0.0.1:6382',
'ip', '127.0.0.1',
'port', '6382',
'runid', '112cdebd22924a7d962be496f3a1c4c7c9bad93f',
'flags', 'slave',
'master-host', '127.0.0.1',
'master-port', '6381',
],
]
);
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->never())
->method('connect');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave1
->expects($this->once())
->method('connect');
/** @var Connection\FactoryInterface|MockObject */
$factory = $this->getMockBuilder('Predis\Connection\FactoryInterface')->getMock();
$factory
->expects($this->once())
->method('create')
->with([
'host' => '127.0.0.1',
'port' => '6382',
'role' => 'slave',
])
->willReturn($slave1);
$replication = $this->getReplicationConnection('svc', [$sentinel1], $factory);
$replication->add($master);
$replication->connect();
}
/**
* @group disconnected
*/
public function testMethodConnectOnEmptySlavePoolAsksSentinelForSlavesAndForcesConnectionToMasterIfStillEmpty(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->exactly(2))
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('SENTINEL', ['slaves', 'svc'])],
[$this->isRedisCommand('SENTINEL', ['get-master-addr-by-name', 'svc'])]
)
->willReturnOnConsecutiveCalls(
[],
['127.0.0.1', '6381']
);
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->once())
->method('connect');
/** @var Connection\FactoryInterface|MockObject */
$factory = $this->getMockBuilder('Predis\Connection\FactoryInterface')->getMock();
$factory
->expects($this->once())
->method('create')
->with([
'host' => '127.0.0.1',
'port' => '6381',
'role' => 'master',
])
->willReturn($master);
$replication = $this->getReplicationConnection('svc', [$sentinel1], $factory);
$replication->connect();
}
/**
* @group disconnected
*/
public function testMethodDisconnectForcesDisconnectionOnAllConnectionsInPool(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->never())
->method('disconnect');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->once())
->method('disconnect');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave1
->expects($this->once())
->method('disconnect');
$slave2 = $this->getMockConnection('tcp://127.0.0.1:6383?role=slave');
$slave2
->expects($this->once())
->method('disconnect');
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->add($slave1);
$replication->add($slave2);
$replication->disconnect();
}
/**
* @group disconnected
*/
public function testMethodIsConnectedReturnConnectionStatusOfCurrentConnection(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave1
->expects($this->exactly(2))
->method('isConnected')
->willReturnOnConsecutiveCalls(true, false);
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($slave1);
$this->assertFalse($replication->isConnected());
$replication->connect();
$this->assertTrue($replication->isConnected());
$replication->getConnectionById('127.0.0.1:6382')->disconnect();
$this->assertFalse($replication->isConnected());
}
/**
* @group disconnected
*/
public function testMethodGetConnectionByIdReturnsConnectionWhenFound(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->add($slave1);
$this->assertSame($master, $replication->getConnectionById('127.0.0.1:6381'));
$this->assertSame($slave1, $replication->getConnectionById('127.0.0.1:6382'));
$this->assertNull($replication->getConnectionById('127.0.0.1:6383'));
}
/**
* @group disconnected
*/
public function testMethodSwitchToSelectsCurrentConnection(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->once())
->method('connect');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave1
->expects($this->never())
->method('connect');
$slave2 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave2
->expects($this->once())
->method('connect');
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->add($slave1);
$replication->add($slave2);
$replication->switchTo($master);
$this->assertSame($master, $replication->getCurrent());
$replication->switchTo($slave2);
$this->assertSame($slave2, $replication->getCurrent());
}
/**
* @group disconnected
*/
public function testMethodSwitchToThrowsExceptionOnConnectionNotFound(): void
{
$this->expectException('InvalidArgumentException');
$this->expectExceptionMessage('Invalid connection or connection not found.');
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave2 = $this->getMockConnection('tcp://127.0.0.1:6383?role=slave');
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->add($slave1);
$replication->switchTo($slave2);
}
/**
* @group disconnected
*/
public function testMethodSwitchToMasterSelectsCurrentConnectionToMaster(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->once())
->method('connect');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave1
->expects($this->never())
->method('connect');
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->add($slave1);
$replication->switchToMaster();
$this->assertSame($master, $replication->getCurrent());
}
/**
* @group disconnected
*/
public function testMethodSwitchToSlaveSelectsCurrentConnectionToRandomSlave(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->never())
->method('connect');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave1
->expects($this->once())
->method('connect');
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->add($slave1);
$replication->switchToSlave();
$this->assertSame($slave1, $replication->getCurrent());
}
/**
* @group disconnected
*/
public function testGetConnectionByCommandReturnsMasterForWriteCommands(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->exactly(2))
->method('isConnected')
->willReturnOnConsecutiveCalls(false, true);
$master
->expects($this->once())
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('ROLE')]
)
->willReturnOnConsecutiveCalls(
['master', 3129659, [['127.0.0.1', 6382, 3129242]]]
);
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->add($slave1);
$this->assertSame($master, $replication->getConnectionByCommand(
Command\RawCommand::create('set', 'key', 'value')
));
$this->assertSame($master, $replication->getConnectionByCommand(
Command\RawCommand::create('del', 'key')
));
}
/**
* @group disconnected
*/
public function testGetConnectionByCommandReturnsSlaveForReadOnlyCommands(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave1
->expects($this->exactly(2))
->method('isConnected')
->willReturnOnConsecutiveCalls(false, true);
$slave1
->expects($this->once())
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('ROLE')]
)
->willReturnOnConsecutiveCalls(
['slave', '127.0.0.1', 9000, 'connected', 3167038]
);
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->add($slave1);
$this->assertSame($slave1, $replication->getConnectionByCommand(
Command\RawCommand::create('get', 'key')
));
$this->assertSame($slave1, $replication->getConnectionByCommand(
Command\RawCommand::create('exists', 'key')
));
}
/**
* @group disconnected
*/
public function testGetConnectionByCommandSwitchesToMasterAfterWriteCommand(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->exactly(2))
->method('isConnected')
->willReturnOnConsecutiveCalls(false, true);
$master
->expects($this->once())
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('ROLE')]
)
->willReturnOnConsecutiveCalls(
['master', 3129659, [['127.0.0.1', 6382, 3129242]]]
);
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave1
->expects($this->once())
->method('isConnected')
->willReturnOnConsecutiveCalls(false);
$slave1
->expects($this->once())
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('ROLE')]
)
->willReturnOnConsecutiveCalls(
['slave', '127.0.0.1', 9000, 'connected', 3167038]
);
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->add($slave1);
$this->assertSame($slave1, $replication->getConnectionByCommand(
Command\RawCommand::create('exists', 'key')
));
$this->assertSame($master, $replication->getConnectionByCommand(
Command\RawCommand::create('set', 'key', 'value')
));
$this->assertSame($master, $replication->getConnectionByCommand(
Command\RawCommand::create('get', 'key')
));
}
/**
* @group disconnected
*/
public function testGetConnectionByCommandThrowsExceptionOnNodeRoleMismatch(): void
{
$this->expectException('Predis\Replication\RoleException');
$this->expectExceptionMessage('Expected master but got slave [127.0.0.1:6381]');
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->once())
->method('isConnected')
->willReturn(false);
$master
->expects($this->once())
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('ROLE')]
)
->willReturnOnConsecutiveCalls(
['slave', '127.0.0.1', 9000, 'connected', 3167038]
);
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->getConnectionByCommand(Command\RawCommand::create('del', 'key'));
}
/**
* @group disconnected
*/
public function testGetConnectionByCommandReturnsMasterForReadOnlyOperationsOnUnavailableSlaves(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->once())
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('SENTINEL', ['slaves', 'svc'])]
)
->willReturnOnConsecutiveCalls(
[
[
'name', '127.0.0.1:6382',
'ip', '127.0.0.1',
'port', '6382',
'runid', '1c0bf1291797fbc5608c07a17da394147dc62817',
'flags', 'slave,s_down,disconnected',
'master-host', '127.0.0.1',
'master-port', '6381',
],
]
);
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->once())
->method('isConnected')
->willReturn(false);
$master
->expects($this->once())
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('ROLE')]
)
->willReturnOnConsecutiveCalls(
['master', '0', []]
);
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->getConnectionByCommand(Command\RawCommand::create('get', 'key'));
}
/**
* @group disconnected
*/
public function testMethodExecuteCommandSendsCommandToNodeAndReturnsResponse(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$cmdGet = Command\RawCommand::create('get', 'key');
$cmdGetResponse = 'value';
$cmdSet = Command\RawCommand::create('set', 'key', 'value');
$cmdSetResponse = Response\Status::get('OK');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->any())
->method('isConnected')
->willReturn(true);
$master
->expects($this->once())
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('SET', ['key', $cmdGetResponse])]
)
->willReturnOnConsecutiveCalls(
$cmdSetResponse
);
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave1
->expects($this->any())
->method('isConnected')
->willReturn(true);
$slave1
->expects($this->once())
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('GET', ['key'])]
)
->willReturnOnConsecutiveCalls(
$cmdGetResponse
);
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->add($slave1);
$this->assertSame($cmdGetResponse, $replication->executeCommand($cmdGet));
$this->assertSame($cmdSetResponse, $replication->executeCommand($cmdSet));
}
/**
* @group disconnected
*/
public function testMethodExecuteCommandRetriesReadOnlyCommandOnNextSlaveOnConnectionException(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->any())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', ['slaves', 'svc']
))
->willReturn(
[
[
'name', '127.0.0.1:6383',
'ip', '127.0.0.1',
'port', '6383',
'runid', '1c0bf1291797fbc5608c07a17da394147dc62817',
'flags', 'slave',
'master-host', '127.0.0.1',
'master-port', '6381',
],
]
);
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->any())
->method('isConnected')
->willReturn(true);
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave1
->expects($this->any())
->method('isConnected')
->willReturn(true);
$slave1
->expects($this->any())
->method('disconnect');
$slave1
->expects($this->once())
->method('executeCommand')
->with(
$this->isRedisCommand('GET', ['key'])
)
->willThrowException(
new Connection\ConnectionException($slave1, 'Unknown connection error [127.0.0.1:6382]')
);
$slave2 = $this->getMockConnection('tcp://127.0.0.1:6383?role=slave');
$slave2
->expects($this->any())
->method('isConnected')
->willReturn(true);
$slave2
->expects($this->once())
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('GET', ['key'])]
)
->willReturnOnConsecutiveCalls(
'value'
);
/** @var Connection\FactoryInterface|MockObject */
$factory = $this->getMockBuilder('Predis\Connection\FactoryInterface')->getMock();
$factory
->expects($this->once())
->method('create')
->with([
'host' => '127.0.0.1',
'port' => '6383',
'role' => 'slave',
])
->willReturn($slave2);
$replication = $this->getReplicationConnection('svc', [$sentinel1], $factory);
$replication->add($master);
$replication->add($slave1);
self::assertSame('value', $replication->executeCommand(
Command\RawCommand::create('get', 'key')
));
}
/**
* @group disconnected
*/
public function testMethodExecuteCommandRetriesReadOnlyCommandOnNextSlaveOnFailure(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->any())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', ['slaves', 'svc']
))
->willReturn(
[
[
'name', '127.0.0.1:6383',
'ip', '127.0.0.1',
'port', '6383',
'runid', '1c0bf1291797fbc5608c07a17da394147dc62817',
'flags', 'slave',
'master-host', '127.0.0.1',
'master-port', '6381',
],
]
);
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->any())
->method('isConnected')
->willReturn(true);
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave1
->expects($this->any())
->method('isConnected')
->willReturn(true);
$slave1
->expects($this->once())
->method('executeCommand')
->with(
$this->isRedisCommand('GET', ['key'])
)
->willThrowException(
new Exception('message')
);
$slave2 = $this->getMockConnection('tcp://127.0.0.1:6383?role=slave');
$slave2
->expects($this->any())
->method('isConnected')
->willReturn(true);
$slave2
->expects($this->once())
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('GET', ['key'])]
)
->willReturnOnConsecutiveCalls(
'value'
);
/** @var Connection\FactoryInterface|MockObject */
$factory = $this->getMockBuilder('Predis\Connection\FactoryInterface')->getMock();
$factory
->expects($this->once())
->method('create')
->with([
'host' => '127.0.0.1',
'port' => '6383',
'role' => 'slave',
])
->willReturn($slave2);
$replication = $this->getReplicationConnection('svc', [$sentinel1], $factory);
$replication->add($master);
$replication->add($slave1);
$this->assertSame('value', $replication->executeCommand(
Command\RawCommand::create('get', 'key')
));
}
/**
* @group disconnected
*/
public function testMethodExecuteCommandRetriesWriteCommandOnNewMasterOnFailure(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->any())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', ['get-master-addr-by-name', 'svc']
))
->willReturn(
['127.0.0.1', '6391']
);
$masterOld = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$masterOld
->expects($this->any())
->method('isConnected')
->willReturn(true);
$masterOld
->expects($this->once())
->method('executeCommand')
->with(
$this->isRedisCommand('DEL', ['key'])
)
->willThrowException(
new Connection\ConnectionException($masterOld, 'Unknown connection error [127.0.0.1:6381]')
);
$masterNew = $this->getMockConnection('tcp://127.0.0.1:6391?role=master');
$masterNew
->expects($this->any())
->method('isConnected')
->willReturn(true);
$masterNew
->expects($this->once())
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('DEL', ['key'])]
)
->willReturnOnConsecutiveCalls(
1
);
/** @var Connection\FactoryInterface|MockObject */
$factory = $this->getMockBuilder('Predis\Connection\FactoryInterface')->getMock();
$factory
->expects($this->once())
->method('create')
->with([
'host' => '127.0.0.1',
'port' => '6391',
'role' => 'master',
])
->willReturn($masterNew);
$replication = $this->getReplicationConnection('svc', [$sentinel1], $factory);
$replication->add($masterOld);
$this->assertSame(1, $replication->executeCommand(
Command\RawCommand::create('del', 'key')
));
}
/**
* @group disconnected
*/
public function testMethodExecuteCommandThrowsExceptionOnUnknownServiceName(): void
{
$this->expectException('Predis\Response\ServerException');
$this->expectExceptionMessage('ERR No such master with that name');
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->any())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', ['get-master-addr-by-name', 'svc']
))
->willReturn(null);
$masterOld = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$masterOld
->expects($this->any())
->method('isConnected')
->willReturn(true);
$masterOld
->expects($this->once())
->method('executeCommand')
->with(
$this->isRedisCommand('DEL', ['key'])
)
->willThrowException(
new Connection\ConnectionException($masterOld, 'Unknown connection error [127.0.0.1:6381]')
);
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($masterOld);
$replication->executeCommand(
Command\RawCommand::create('del', 'key')
);
}
/**
* @group disconnected
*/
public function testMethodExecuteCommandThrowsExceptionOnConnectionFailureAndNoAvailableSentinels(): void
{
$this->expectException('Predis\ClientException');
$this->expectExceptionMessage('No sentinel server available for autodiscovery.');
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->any())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', ['get-master-addr-by-name', 'svc']
))
->willThrowException(
new Connection\ConnectionException($sentinel1, 'Unknown connection error [127.0.0.1:5381]')
);
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->any())
->method('isConnected')
->willReturn(true);
$master
->expects($this->once())
->method('executeCommand')
->with(
$this->isRedisCommand('DEL', ['key'])
)
->willThrowException(
new Connection\ConnectionException($master, 'Unknown connection error [127.0.0.1:6381]')
);
$replication = $this->getReplicationConnection('svc', [$sentinel1]);
$replication->add($master);
$replication->executeCommand(
Command\RawCommand::create('del', 'key')
);
}
/**
* @group disconnected
*/
public function testMethodGetReplicationStrategyReturnsInstance(): void
{
$strategy = new Replication\ReplicationStrategy();
$factory = new Connection\Factory();
$replication = new SentinelReplication(
'svc', ['tcp://127.0.0.1:5381?role=sentinel'], $factory, $strategy
);
$this->assertSame($strategy, $replication->getReplicationStrategy());
}
/**
* @group disconnected
*/
public function testMethodSerializeCanSerializeWholeObject(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave2 = $this->getMockConnection('tcp://127.0.0.1:6383?role=slave');
$strategy = new Replication\ReplicationStrategy();
$factory = new Connection\Factory();
$replication = new SentinelReplication('svc', [$sentinel1], $factory, $strategy);
$replication->add($master);
$replication->add($slave1);
$replication->add($slave2);
$unserialized = unserialize(serialize($replication));
$this->assertEquals($master, $unserialized->getConnectionById('127.0.0.1:6381'));
$this->assertEquals($slave1, $unserialized->getConnectionById('127.0.0.1:6382'));
$this->assertEquals($master, $unserialized->getConnectionById('127.0.0.1:6383'));
$this->assertEquals($strategy, $unserialized->getReplicationStrategy());
}
/**
* @group disconnected
*/
public function testMethodGetSentinelConnectionAfterSentinelRestart(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel&alias=sentinel1');
$sentinel1
->expects($this->exactly(2))
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', ['sentinels', 'svc']
))
->willReturnOnConsecutiveCalls(
$this->throwException(new Connection\ConnectionException($sentinel1, 'Unknown connection error [127.0.0.1:5381]')),
[
[
'name', '127.0.0.1:5382',
'ip', '127.0.0.1',
'port', '5382',
'runid', 'f53b52d281be5cdd4873700c94846af8dbe47209',
'flags', 'sentinel',
],
]
);
$sentinel2 = $this->getMockSentinelConnection('tcp://127.0.0.1:5382?role=sentinel&alias=sentinel2');
$sentinel2
->expects($this->once())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', ['sentinels', 'svc']
))
->willThrowException(
new Connection\ConnectionException($sentinel2, 'Unknown connection error [127.0.0.1:5382]')
);
$replication = $this->getReplicationConnection('svc', [$sentinel1, $sentinel2]);
try {
$replication->updateSentinels();
} catch (\Predis\ClientException $exception) {
$this->assertEquals('No sentinel server available for autodiscovery.', $exception->getMessage());
}
$replication->updateSentinels();
}
/**
* @dataProvider connectionsProvider
* @group disconnected
*/
public function testGetParameters(string $connection): void
{
$sentinel = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$connection = $this->getMockConnection($connection);
$replication = $this->getReplicationConnection('srv', [$sentinel]);
$replication->add($connection);
$this->assertSame($connection->getParameters(), $replication->getParameters());
}
/**
* @group disconnected
* @return void
*/
public function testGetParametersReturnsSentinelParametersOnEmptyConnectionPool(): void
{
$sentinel = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$replication = $this->getReplicationConnection('srv', [$sentinel]);
$this->assertSame($sentinel->getParameters(), $replication->getParameters());
}
/**
* @group disconnected
* @return void
*/
public function testGetParametersReturnsParametersFromArrayAfterUpdateSentinels(): void
{
$sentinel = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel
->expects($this->once())
->method('executeCommand')
->with($this->isRedisCommand('SENTINEL', ['sentinels', 'srv']))
->willReturn([
[
'name', '127.0.0.1:5382',
'ip', '127.0.0.1',
'port', '5382',
'runid', 'a113aa7a0d4870a85bb22b4b605fd26eb93ed40e',
'flags', 'sentinel',
],
]);
$replication = $this->getReplicationConnection('srv', [$sentinel]);
$replication->updateSentinels();
// After updateSentinels(), the sentinels array contains plain arrays
$parameters = $replication->getParameters();
$this->assertInstanceOf(Parameters::class, $parameters);
$this->assertEquals('127.0.0.1', $parameters->host);
$this->assertEquals('5381', $parameters->port);
}
/**
* @group disconnected
* @return void
*/
public function testGetParametersReturnsParametersFromArrayAfterQuerySentinel(): void
{
$sentinel = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel
->expects($this->exactly(3))
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('SENTINEL', ['sentinels', 'srv'])],
[$this->isRedisCommand('SENTINEL', ['get-master-addr-by-name', 'srv'])],
[$this->isRedisCommand('SENTINEL', ['slaves', 'srv'])]
)
->willReturnOnConsecutiveCalls(
// SENTINEL sentinels srv
[
[
'name', '127.0.0.1:5382',
'ip', '127.0.0.1',
'port', '5382',
'runid', 'a113aa7a0d4870a85bb22b4b605fd26eb93ed40e',
'flags', 'sentinel',
],
],
// SENTINEL get-master-addr-by-name srv
['127.0.0.1', '6381'],
// SENTINEL slaves srv
[]
);
$replication = $this->getReplicationConnection('srv', [$sentinel]);
// Clear master and slaves to test sentinel array scenario
$replication->querySentinel();
// Remove master to force getParameters to use sentinels array
$reflectionMaster = new ReflectionProperty($replication, 'master');
$reflectionMaster->setAccessible(true);
$reflectionMaster->setValue($replication, null);
$reflectionSlaves = new ReflectionProperty($replication, 'slaves');
$reflectionSlaves->setAccessible(true);
$reflectionSlaves->setValue($replication, []);
// After querySentinel(), the sentinels array contains plain arrays
$parameters = $replication->getParameters();
$this->assertInstanceOf(Parameters::class, $parameters);
$this->assertEquals('127.0.0.1', $parameters->host);
}
/**
* @group disconnected
* @return void
*/
public function testGetParametersHandlesParametersInterfaceInSentinelsArray(): void
{
$parametersObject = Parameters::create('tcp://127.0.0.1:5381?role=sentinel');
$replication = $this->getReplicationConnection('srv', [$parametersObject]);
$parameters = $replication->getParameters();
$this->assertSame($parametersObject, $parameters);
}
/**
* @group disconnected
* @return void
*/
public function testGetParametersReturnsNullWhenNoConnectionsAvailable(): void
{
$sentinel = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$replication = $this->getReplicationConnection('srv', [$sentinel]);
// Clear all connections
$reflectionSentinels = new ReflectionProperty($replication, 'sentinels');
$reflectionSentinels->setAccessible(true);
$reflectionSentinels->setValue($replication, []);
$parameters = $replication->getParameters();
$this->assertNull($parameters);
}
/**
* @group disconnected
* @return void
*/
public function testGetParametersHandlesStringUriInSentinelsArray(): void
{
// Test with string URI (e.g., "tcp://127.0.0.1:26379")
$sentinelUri = 'tcp://127.0.0.1:5381?role=sentinel';
$replication = $this->getReplicationConnection('srv', [$sentinelUri]);
$parameters = $replication->getParameters();
$this->assertInstanceOf(ParametersInterface::class, $parameters);
$this->assertSame('127.0.0.1', $parameters->host);
$this->assertSame(5381, $parameters->port);
}
/**
* @group disconnected
*/
public function testWrite(): void
{
$command1 = new Command\Redis\Search\FTSEARCH();
$command1->setArguments(['arg1', '*']);
$command2 = new Command\Redis\Search\FTSEARCH();
$command2->setArguments(['arg2', '*']);
$command3 = new Command\Redis\Search\FTSEARCH();
$command3->setArguments(['arg3', '*']);
$sentinel = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$master = $this->getMockConnection('tcp://127.0.0.1:6379?role=master');
$slave = $this->getMockConnection('tcp://127.0.0.1:6380?role=slave');
$strategy = new Replication\ReplicationStrategy();
$factory = new Connection\Factory();
$master
->expects($this->exactly(3))
->method('isConnected')
->willReturn(true);
$slave
->expects($this->never())
->method('write');
$master
->expects($this->exactly(3))
->method('write')
->withConsecutive(
[$command1->serializeCommand()],
[$command2->serializeCommand()],
[$command3->serializeCommand()]
);
$replication = new SentinelReplication('svc', [$sentinel], $factory, $strategy);
$replication->add($master);
$replication->add($slave);
$replication->write($command1->serializeCommand() . $command2->serializeCommand() . $command3->serializeCommand());
}
public function connectionsProvider(): array
{
return [
'master connection' => ['tcp://127.0.0.1:6379?role=master'],
'slave connection' => ['tcp://127.0.0.1:6379'],
];
}
/**
* @group disconnected
*/
public function testDiscardsSlaveWhenRespondsLOADINGAndExecutesReadOnlyCommandOnNextSlave(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->any())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', ['slaves', 'svc']
))
->willReturn(
[
[
'name', '127.0.0.1:6383',
'ip', '127.0.0.1',
'port', '6383',
'runid', '1c0bf1291797fbc5608c07a17da394147dc62817',
'flags', 'slave',
'master-host', '127.0.0.1',
'master-port', '6381',
],
]
);
$master = $this->getMockConnection('tcp://127.0.0.1:6381?role=master');
$master
->expects($this->any())
->method('isConnected')
->willReturn(true);
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$slave1
->expects($this->any())
->method('isConnected')
->willReturn(true);
$slave1
->expects($this->once())
->method('executeCommand')
->with(
$this->isRedisCommand('GET', ['key'])
)
->willReturn(
new Response\Error('LOADING')
);
$slave2 = $this->getMockConnection('tcp://127.0.0.1:6383?role=slave');
$slave2
->expects($this->any())
->method('isConnected')
->willReturn(true);
$slave2
->expects($this->once())
->method('executeCommand')
->withConsecutive(
[$this->isRedisCommand('GET', ['key'])]
)
->willReturnOnConsecutiveCalls(
'value'
);
/** @var Connection\FactoryInterface|MockObject */
$factory = $this->getMockBuilder('Predis\Connection\FactoryInterface')->getMock();
$factory
->expects($this->once())
->method('create')
->with([
'host' => '127.0.0.1',
'port' => '6383',
'role' => 'slave',
])
->willReturn($slave2);
$replication = $this->getReplicationConnection('svc', [$sentinel1], $factory);
$replication->add($master);
$replication->add($slave1);
$this->assertSame('value', $replication->executeCommand(
Command\RawCommand::create('get', 'key')
));
$this->assertSame($slave2, $replication->getCurrent());
}
/**
* @medium
* @group disconnected
* @group slow
*/
public function testRetryCommandFailureOnCustomRetryConfiguration()
{
$mockStream = $this->getMockBuilder(StreamInterface::class)->getMock();
$mockStreamFactory = $this->getMockBuilder(StreamFactoryInterface::class)->getMock();
$parameters = new Parameters([
'retry' => new Retry(new ExponentialBackoff(1000, 10000), 3),
'role' => 'master',
]);
$mockStream
->expects($this->exactly(3))
->method('close')
->withAnyParameters();
$mockStream
->expects($this->exactly(6))
->method('write')
->withAnyParameters()
->willReturnOnConsecutiveCalls(
1000,
$this->throwException(new RuntimeException('', 2)),
$this->throwException(new RuntimeException('', 2)),
$this->throwException(new RuntimeException('', 2)),
1000,
1000
);
$mockStream
->expects($this->exactly(7))
->method('read')
->withAnyParameters()
->willReturnOnConsecutiveCalls("*1\r\n", "$5\r\n", "master\r\n", "*1\r\n", "$5\r\n", "master\r\n", "+OK\r\n");
$mockStreamFactory
->expects($this->exactly(4))
->method('createStream')
->withAnyParameters()
->willReturn($mockStream);
$connection = new StreamConnection($parameters, $mockStreamFactory);
$mockFactory = $this->getMockBuilder(Connection\Factory::class)->getMock();
$mockFactory
->expects($this->any())
->method('create')
->willReturn($connection);
$sentinel = $this->getMockSentinelConnection();
$sentinel
->expects($this->any())
->method('executeCommand')
->willReturn(['127.0.0.1', '6381']);
$replication = new SentinelReplication('src', [$sentinel], $mockFactory);
$replication->add($connection);
$this->assertEquals(
'OK',
$replication->executeCommand(Command\RawCommand::create('SET', 1001))
);
}
// ******************************************************************** //
// ---- HELPER METHODS ------------------------------------------------ //
// ******************************************************************** //
/**
* Creates a new instance of replication connection.
*
* @param string $service Name of the service
* @param array $sentinels Array of sentinels
* @param ConnectionFactoryInterface|null $factory Optional connection factory instance
*
* @return SentinelReplication
*/
protected function getReplicationConnection(string $service, array $sentinels, ?Connection\FactoryInterface $factory = null): SentinelReplication
{
$factory = $factory ?: new Connection\Factory();
$replication = new SentinelReplication($service, $sentinels, $factory);
$replication->setRetryWait(0);
return $replication;
}
/**
* Returns a base mocked connection from Predis\Connection\NodeConnectionInterface.
*
* @param array|string $parameters Optional parameters
*
* @return mixed
*/
protected function getMockSentinelConnection($parameters = null)
{
$connection = $this->getMockConnection($parameters);
return $connection;
}
}