Files
predis/tests/Predis/Connection/Replication/SentinelReplicationTest.php
T
Daniele Alessandri 6e8e23279e [tests] Update Predis\Connection\Aggregate\SentinelReplication tests.
Updated to verify that new sentinels retrieved from "SENTINEL" response
have their role automatically set to "sentinel". Also applied some minor
changes by dropping useless alias.
2020-09-12 19:44:56 +02:00

1490 lines
52 KiB
PHP

<?php
/*
* This file is part of the Predis package.
*
* (c) Daniele Alessandri <suppakilla@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Predis\Connection\Replication;
use PredisTestCase;
use PHPUnit\Framework\MockObject\MockObject;
use Predis\Command;
use Predis\Connection;
use Predis\Replication;
use Predis\Response;
/**
*
*/
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', array());
$replication->getSentinelConnection();
}
/**
* @group disconnected
*/
public function testParametersForSentinelConnectionShouldUsePasswordForAuthentication(): void
{
$replication = $this->getReplicationConnection('svc', array(
'tcp://127.0.0.1:5381?password=secret',
));
$parameters = $replication->getSentinelConnection()->getParameters()->toArray();
$this->assertArrayHasKey('password', $parameters, 'Parameter `passwords` was expected to exist in connection parameters');
}
/**
* @group disconnected
*/
public function testParametersForSentinelConnectionShouldIgnoreDatabaseAndPassword(): void
{
$replication = $this->getReplicationConnection('svc', array(
'tcp://127.0.0.1:5381?role=sentinel&database=1&username=myusername',
));
$parameters = $replication->getSentinelConnection()->getParameters()->toArray();
$this->assertArrayNotHasKey('database', $parameters, 'Parameter `database` was expected to not exist in connection parameters');
$this->assertArrayNotHasKey('username', $parameters, 'Parameter `username` was expected to not exist in connection parameters');
}
/**
* @group disconnected
*/
public function testParametersForSentinelConnectionHaveDefaultTimeout(): void
{
$replication = $this->getReplicationConnection('svc', array(
'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', array(
'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 = Connection\Parameters::create(
'tcp://127.0.0.1:5381?role=sentinel&database=1&password=secret'
);
$replication = $this->getReplicationConnection('svc', array($originalParameters));
$parameters = $replication
->getSentinelConnection()
->getParameters();
$this->assertSame($originalParameters, $parameters);
$this->assertNotNull($parameters->password);
$this->assertNotNull($parameters->database);
}
/**
* @group disconnected
*/
public function testMethodGetSentinelConnectionReturnsFirstAvailableSentinel(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel2 = $this->getMockSentinelConnection('tcp://127.0.0.1:5382?role=sentinel');
$sentinel3 = $this->getMockSentinelConnection('tcp://127.0.0.1:5383?role=sentinel');
$replication = $this->getReplicationConnection('svc', array($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', array($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(array($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', array($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', array());
$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', array());
$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(
array($this->isRedisCommand('SENTINEL', array('get-master-addr-by-name', 'svc'))),
array($this->isRedisCommand('SENTINEL', array('slaves', 'svc')))
)
->willReturnOnConsecutiveCalls(
// SENTINEL get-master-addr-by-name svc
array('127.0.0.1', '6381'),
// SENTINEL slaves svc
array(
array(
'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', array($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', array());
$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', array('sentinels', 'svc')
))
->willReturn(
array(
array(
'name', '127.0.0.1:5382',
'ip', '127.0.0.1',
'port', '5382',
'runid', 'a113aa7a0d4870a85bb22b4b605fd26eb93ed40e',
'flags', 'sentinel',
),
array(
'name', '127.0.0.1:5383',
'ip', '127.0.0.1',
'port', '5383',
'runid', 'f53b52d281be5cdd4873700c94846af8dbe47209',
'flags', 'sentinel',
),
)
);
$replication = $this->getReplicationConnection('svc', array($sentinel1));
$replication->updateSentinels();
// TODO: sorry for the smell...
$reflection = new \ReflectionProperty($replication, 'sentinels');
$reflection->setAccessible(true);
$retrievedSentinels = $reflection->getValue($replication);
$expectedSentinels = array(
array('scheme' => 'tcp', 'host' => '127.0.0.1', 'port' => '5381', 'role' => 'sentinel'),
array('host' => '127.0.0.1', 'port' => '5382', 'role' => 'sentinel'),
array('host' => '127.0.0.1', 'port' => '5383', 'role' => 'sentinel'),
);
$this->assertSame($sentinel1, $replication->getSentinelConnection());
$this->assertEquals($expectedSentinels, $retrievedSentinels);
}
/**
* @group disconnected
*/
public function testMethodUpdateSentinelsRemovesCurrentSentinelAndRetriesNextOneOnFailure(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->once())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', array('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');
$sentinel2
->expects($this->once())
->method('executeCommand')
->with($this->isRedisCommand(
'SENTINEL', array('sentinels', 'svc')
))
->willReturn(
array(
array(
'name', '127.0.0.1:5383',
'ip', '127.0.0.1',
'port', '5383',
'runid', 'f53b52d281be5cdd4873700c94846af8dbe47209',
'flags', 'sentinel',
),
)
);
$replication = $this->getReplicationConnection('svc', array($sentinel1, $sentinel2));
$replication->updateSentinels();
// TODO: sorry for the smell...
$reflection = new \ReflectionProperty($replication, 'sentinels');
$reflection->setAccessible(true);
$retrievedSentinels = $reflection->getValue($replication);
$expectedSentinels = array(
array('scheme' => 'tcp', 'host' => '127.0.0.1', 'port' => '5382', 'role' => 'sentinel'),
array('host' => '127.0.0.1', 'port' => '5383', 'role' => 'sentinel'),
);
$this->assertSame($sentinel2, $replication->getSentinelConnection());
$this->assertEquals($expectedSentinels, $retrievedSentinels);
}
/**
* @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', array('sentinels', 'svc')
))
->willThrowException(
new Connection\ConnectionException($sentinel1, 'Unknown connection error [127.0.0.1:5381]')
);
$replication = $this->getReplicationConnection('svc', array($sentinel1));
$replication->updateSentinels();
}
/**
* @group disconnected
*/
public function testMethodQuerySentinelFetchesMasterNodeSlaveNodesAndSentinelNodes(): void
{
$sentinel1 = $this->getMockSentinelConnection('tcp://127.0.0.1:5381?role=sentinel');
$sentinel1
->expects($this->exactly(3))
->method('executeCommand')
->withConsecutive(
array($this->isRedisCommand('SENTINEL', array('sentinels', 'svc'))),
array($this->isRedisCommand('SENTINEL', array('get-master-addr-by-name', 'svc'))),
array($this->isRedisCommand('SENTINEL', array('slaves', 'svc')))
)
->willReturnOnConsecutiveCalls(
// SENTINEL sentinels svc
array(
array(
'name', '127.0.0.1:5382',
'ip', '127.0.0.1',
'port', '5382',
'runid', 'a113aa7a0d4870a85bb22b4b605fd26eb93ed40e',
'flags', 'sentinel',
),
),
// SENTINEL get-master-addr-by-name svc
array('127.0.0.1', '6381'),
// SENTINEL slaves svc
array(
array(
'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',
),
array(
'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');
$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', array($sentinel1));
$replication->querySentinel();
// TODO: sorry for the smell...
$reflection = new \ReflectionProperty($replication, 'sentinels');
$reflection->setAccessible(true);
$retrievedSentinels = $reflection->getValue($replication);
$expectedSentinels = array(
array('scheme' => 'tcp', 'host' => '127.0.0.1', 'port' => '5381', 'role' => 'sentinel'),
array('host' => '127.0.0.1', 'port' => '5382', 'role' => 'sentinel'),
);
$this->assertSame($sentinel1, $replication->getSentinelConnection());
$this->assertEquals($expectedSentinels, $retrievedSentinels);
$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(
array($this->isRedisCommand('SENTINEL', array('get-master-addr-by-name', 'svc')))
)
->willReturnOnConsecutiveCalls(
array('127.0.0.1', '6381')
);
$replication = $this->getReplicationConnection('svc', array($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', array('get-master-addr-by-name', 'svc')
))
->willThrowException(
new Connection\ConnectionException($sentinel1, 'Unknown connection error [127.0.0.1:5381]')
);
$replication = $this->getReplicationConnection('svc', array($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(
array($this->isRedisCommand('SENTINEL', array('slaves', 'svc')))
)
->willReturnOnConsecutiveCalls(
array(
array(
'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',
),
array(
'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', array($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', array('slaves', 'svc')
))
->willThrowException(
new Connection\ConnectionException($sentinel1, 'Unknown connection error [127.0.0.1:5381]')
);
$replication = $this->getReplicationConnection('svc', array($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', array());
$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', array($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', array('slaves', 'svc')
))
->willReturn(
array(
array(
'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(array(
'host' => '127.0.0.1',
'port' => '6382',
'role' => 'slave',
))
->willReturn($slave1);
$replication = $this->getReplicationConnection('svc', array($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(
array($this->isRedisCommand('SENTINEL', array('slaves', 'svc'))),
array($this->isRedisCommand('SENTINEL', array('get-master-addr-by-name', 'svc')))
)
->willReturnOnConsecutiveCalls(
array(),
array('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(array(
'host' => '127.0.0.1',
'port' => '6381',
'role' => 'master',
))
->willReturn($master);
$replication = $this->getReplicationConnection('svc', array($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', array($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', array($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', array($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', array($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', array($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', array($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', array($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(
array($this->isRedisCommand('ROLE'))
)
->willReturnOnConsecutiveCalls(
array('master', 3129659, array(array('127.0.0.1', 6382, 3129242)))
);
$slave1 = $this->getMockConnection('tcp://127.0.0.1:6382?role=slave');
$replication = $this->getReplicationConnection('svc', array($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(
array($this->isRedisCommand('ROLE'))
)
->willReturnOnConsecutiveCalls(
array('slave', '127.0.0.1', 9000, 'connected', 3167038)
);
$replication = $this->getReplicationConnection('svc', array($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(
array($this->isRedisCommand('ROLE'))
)
->willReturnOnConsecutiveCalls(
array('master', 3129659, array(array('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(
array($this->isRedisCommand('ROLE'))
)
->willReturnOnConsecutiveCalls(
array('slave', '127.0.0.1', 9000, 'connected', 3167038)
);
$replication = $this->getReplicationConnection('svc', array($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(
array($this->isRedisCommand('ROLE'))
)
->willReturnOnConsecutiveCalls(
array('slave', '127.0.0.1', 9000, 'connected', 3167038)
);
$replication = $this->getReplicationConnection('svc', array($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(
array($this->isRedisCommand('SENTINEL', array('slaves', 'svc')))
)
->willReturnOnConsecutiveCalls(
array(
array(
'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(
array($this->isRedisCommand('ROLE'))
)
->willReturnOnConsecutiveCalls(
array('master', '0', array())
);
$replication = $this->getReplicationConnection('svc', array($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(
array($this->isRedisCommand('SET', array('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(
array($this->isRedisCommand('GET', array('key')))
)
->willReturnOnConsecutiveCalls(
$cmdGetResponse
);
$replication = $this->getReplicationConnection('svc', array($sentinel1));
$replication->add($master);
$replication->add($slave1);
$this->assertSame($cmdGetResponse, $replication->executeCommand($cmdGet));
$this->assertSame($cmdSetResponse, $replication->executeCommand($cmdSet));
}
/**
* @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', array('slaves', 'svc')
))
->willReturn(
array(
array(
'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', array('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(
array($this->isRedisCommand('GET', array('key')))
)
->willReturnOnConsecutiveCalls(
'value'
);
/** @var Connection\FactoryInterface|MockObject */
$factory = $this->getMockBuilder('Predis\Connection\FactoryInterface')->getMock();
$factory
->expects($this->once())
->method('create')
->with(array(
'host' => '127.0.0.1',
'port' => '6383',
'role' => 'slave',
))
->willReturn($slave2);
$replication = $this->getReplicationConnection('svc', array($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', array('get-master-addr-by-name', 'svc')
))
->willReturn(
array('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', array('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(
array($this->isRedisCommand('DEL', array('key')))
)
->willReturnOnConsecutiveCalls(
1
);
/** @var Connection\FactoryInterface|MockObject */
$factory = $this->getMockBuilder('Predis\Connection\FactoryInterface')->getMock();
$factory
->expects($this->once())
->method('create')
->with(array(
'host' => '127.0.0.1',
'port' => '6391',
'role' => 'master',
))
->willReturn($masterNew);
$replication = $this->getReplicationConnection('svc', array($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', array('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', array('key'))
)
->willThrowException(
new Connection\ConnectionException($masterOld, 'Unknown connection error [127.0.0.1:6381]')
);
$replication = $this->getReplicationConnection('svc', array($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', array('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', array('key'))
)
->willThrowException(
new Connection\ConnectionException($master, 'Unknown connection error [127.0.0.1:6381]')
);
$replication = $this->getReplicationConnection('svc', array($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', array('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', array($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());
}
// ******************************************************************** //
// ---- 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;
}
}