mirror of
https://github.com/predis/predis.git
synced 2026-08-21 13:21:48 +00:00
Till Krüss
647 lines
20 KiB
PHP
647 lines
20 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Predis package.
|
|
*
|
|
* (c) 2009-2020 Daniele Alessandri
|
|
* (c) 2021-2023 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;
|
|
|
|
use PredisTestCase;
|
|
use PHPUnit\Framework\MockObject\MockObject;
|
|
use Predis\Command\CommandInterface;
|
|
|
|
/**
|
|
* @group realm-connection
|
|
*/
|
|
abstract class PredisConnectionTestCase extends PredisTestCase
|
|
{
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testConstructorDoesNotOpenConnection(): void
|
|
{
|
|
$connection = $this->createConnection();
|
|
|
|
$this->assertFalse($connection->isConnected());
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testSupportsSchemeTCP(): void
|
|
{
|
|
$connection = $this->createConnectionWithParams(array('scheme' => 'tcp'));
|
|
|
|
$this->assertInstanceOf('Predis\Connection\NodeConnectionInterface', $connection);
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testSupportsSchemeRedis(): void
|
|
{
|
|
$connection = $this->createConnectionWithParams(array('scheme' => 'redis'));
|
|
|
|
$this->assertInstanceOf('Predis\Connection\NodeConnectionInterface', $connection);
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testSupportsSchemeTls(): void
|
|
{
|
|
$connection = $this->createConnectionWithParams(array('scheme' => 'tls'));
|
|
|
|
$this->assertInstanceOf('Predis\Connection\NodeConnectionInterface', $connection);
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testSupportsSchemeRediss(): void
|
|
{
|
|
$connection = $this->createConnectionWithParams(array('scheme' => 'rediss'));
|
|
|
|
$this->assertInstanceOf('Predis\Connection\NodeConnectionInterface', $connection);
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testSupportsSchemeUnix(): void
|
|
{
|
|
$connection = $this->createConnectionWithParams(array('scheme' => 'unix'));
|
|
|
|
$this->assertInstanceOf('Predis\Connection\NodeConnectionInterface', $connection);
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testThrowsExceptionOnInvalidScheme(): void
|
|
{
|
|
$this->expectException('InvalidArgumentException');
|
|
$this->expectExceptionMessage("Invalid scheme: 'udp'");
|
|
|
|
$this->createConnectionWithParams(array('scheme' => 'udp'));
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testExposesParameters(): void
|
|
{
|
|
$parameters = $this->getParameters();
|
|
$connection = $this->createConnectionWithParams($parameters);
|
|
|
|
$this->assertSame($parameters, $connection->getParameters());
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testCanBeSerialized(): void
|
|
{
|
|
$parameters = $this->getParameters(array(
|
|
'alias' => 'redis',
|
|
'read_write_timeout' => 10,
|
|
));
|
|
|
|
$connection = $this->createConnectionWithParams($parameters);
|
|
$unserialized = unserialize(serialize($connection));
|
|
|
|
$this->assertInstanceOf($this->getConnectionClass(), $unserialized);
|
|
$this->assertEquals($parameters, $unserialized->getParameters());
|
|
}
|
|
|
|
// ******************************************************************** //
|
|
// ---- INTEGRATION TESTS --------------------------------------------- //
|
|
// ******************************************************************** //
|
|
|
|
/**
|
|
* @group connected
|
|
* @requires PHP 5.4
|
|
*/
|
|
public function testAcceptsTcpNodelayParameter(): void
|
|
{
|
|
$connection = $this->createConnectionWithParams(array('tcp_nodelay' => false));
|
|
$connection->connect();
|
|
$this->assertTrue($connection->isConnected());
|
|
|
|
$connection = $this->createConnectionWithParams(array('tcp_nodelay' => true));
|
|
$connection->connect();
|
|
$this->assertTrue($connection->isConnected());
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testConnectForcesConnection(): void
|
|
{
|
|
$connection = $this->createConnection();
|
|
|
|
$this->assertFalse($connection->isConnected());
|
|
$connection->connect();
|
|
$this->assertTrue($connection->isConnected());
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testDoesNotThrowExceptionOnConnectWhenAlreadyConnected(): void
|
|
{
|
|
$connection = $this->createConnection();
|
|
|
|
$connection->connect();
|
|
$this->assertTrue($connection->isConnected());
|
|
|
|
$connection->connect();
|
|
$this->assertTrue($connection->isConnected());
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testDisconnectForcesDisconnection(): void
|
|
{
|
|
$connection = $this->createConnection();
|
|
|
|
$connection->connect();
|
|
$this->assertTrue($connection->isConnected());
|
|
|
|
$connection->disconnect();
|
|
$this->assertFalse($connection->isConnected());
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testDoesNotThrowExceptionOnDisconnectWhenAlreadyDisconnected(): void
|
|
{
|
|
$connection = $this->createConnection();
|
|
|
|
$this->assertFalse($connection->isConnected());
|
|
$connection->disconnect();
|
|
$this->assertFalse($connection->isConnected());
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testGetResourceForcesConnection(): void
|
|
{
|
|
$connection = $this->createConnection();
|
|
|
|
$this->assertFalse($connection->isConnected());
|
|
$this->assertIsResource($connection->getResource());
|
|
$this->assertTrue($connection->isConnected());
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testSendingCommandForcesConnection(): void
|
|
{
|
|
$connection = $this->createConnection();
|
|
$commands = $this->getCommandFactory();
|
|
|
|
$cmdPing = $commands->create('ping');
|
|
|
|
$this->assertEquals('PONG', $connection->executeCommand($cmdPing));
|
|
$this->assertTrue($connection->isConnected());
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testExecutesCommandOnServer(): void
|
|
{
|
|
$commands = $this->getCommandFactory();
|
|
|
|
/** @var CommandInterface|MockObject */
|
|
$cmdPing = $this->getMockBuilder($commands->getCommandClass('ping'))
|
|
->onlyMethods(array('parseResponse'))
|
|
->getMock();
|
|
$cmdPing->expects($this->never())
|
|
->method('parseResponse');
|
|
|
|
$connection = $this->createConnection();
|
|
|
|
$this->assertEquals('PONG', $connection->executeCommand($cmdPing));
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testExecutesCommandWithHolesInArguments(): void
|
|
{
|
|
$commands = $this->getCommandFactory();
|
|
$cmdDel = $commands->create('mget', array(0 => 'key:0', 2 => 'key:2'));
|
|
|
|
$connection = $this->createConnection();
|
|
|
|
$this->assertSame(array(null, null), $connection->executeCommand($cmdDel));
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testExecutesMultipleCommandsOnServer(): void
|
|
{
|
|
$commands = $this->getCommandFactory();
|
|
|
|
$cmdPing = $commands->create('ping');
|
|
$cmdEcho = $commands->create('echo', array('echoed'));
|
|
$cmdGet = $commands->create('get', array('foobar'));
|
|
$cmdRpush = $commands->create('rpush', array('metavars', 'foo', 'hoge', 'lol'));
|
|
$cmdLrange = $commands->create('lrange', array('metavars', 0, -1));
|
|
|
|
$connection = $this->createConnection(true);
|
|
|
|
$this->assertEquals('PONG', $connection->executeCommand($cmdPing));
|
|
$this->assertSame('echoed', $connection->executeCommand($cmdEcho));
|
|
$this->assertNull($connection->executeCommand($cmdGet));
|
|
$this->assertSame(3, $connection->executeCommand($cmdRpush));
|
|
$this->assertSame(array('foo', 'hoge', 'lol'), $connection->executeCommand($cmdLrange));
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testWritesCommandToServer(): void
|
|
{
|
|
$commands = $this->getCommandFactory();
|
|
|
|
/** @var CommandInterface|MockObject */
|
|
$cmdEcho = $this->getMockBuilder($commands->getCommandClass('echo'))
|
|
->onlyMethods(array('parseResponse'))
|
|
->getMock();
|
|
$cmdEcho->setArguments(array('ECHOED'));
|
|
$cmdEcho
|
|
->expects($this->never())
|
|
->method('parseResponse');
|
|
|
|
$connection = $this->createConnection();
|
|
$connection->writeRequest($cmdEcho);
|
|
$connection->disconnect();
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testReadsCommandFromServer(): void
|
|
{
|
|
$commands = $this->getCommandFactory();
|
|
|
|
/** @var CommandInterface|MockObject */
|
|
$cmdEcho = $this->getMockBuilder($commands->getCommandClass('echo'))
|
|
->onlyMethods(array('parseResponse'))
|
|
->getMock();
|
|
$cmdEcho->setArguments(array('ECHOED'));
|
|
$cmdEcho
|
|
->expects($this->never())
|
|
->method('parseResponse');
|
|
|
|
$connection = $this->createConnection();
|
|
$connection->writeRequest($cmdEcho);
|
|
|
|
$this->assertSame('ECHOED', $connection->readResponse($cmdEcho));
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testIsAbleToWriteMultipleCommandsAndReadThemBackForPipelining(): void
|
|
{
|
|
$commands = $this->getCommandFactory();
|
|
|
|
/** @var CommandInterface|MockObject */
|
|
$cmdPing = $this->getMockBuilder($commands->getCommandClass('ping'))
|
|
->onlyMethods(array('parseResponse'))
|
|
->getMock();
|
|
$cmdPing
|
|
->expects($this->never())
|
|
->method('parseResponse');
|
|
|
|
/** @var CommandInterface|MockObject */
|
|
$cmdEcho = $this->getMockBuilder($commands->getCommandClass('echo'))
|
|
->onlyMethods(array('parseResponse'))
|
|
->getMock();
|
|
$cmdEcho->setArguments(array('ECHOED'));
|
|
$cmdEcho
|
|
->expects($this->never())
|
|
->method('parseResponse');
|
|
|
|
$connection = $this->createConnection();
|
|
|
|
$connection->writeRequest($cmdPing);
|
|
$connection->writeRequest($cmdEcho);
|
|
|
|
$this->assertEquals('PONG', $connection->readResponse($cmdPing));
|
|
$this->assertSame('ECHOED', $connection->readResponse($cmdEcho));
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testSendsInitializationCommandsOnConnection(): void
|
|
{
|
|
$commands = $this->getCommandFactory();
|
|
|
|
/** @var CommandInterface|MockObject */
|
|
$cmdPing = $this->getMockBuilder($commands->getCommandClass('ping'))
|
|
->onlyMethods(array('getArguments'))
|
|
->getMock();
|
|
$cmdPing
|
|
->expects($this->once())
|
|
->method('getArguments')
|
|
->willReturn(array());
|
|
|
|
/** @var CommandInterface|MockObject */
|
|
$cmdEcho = $this->getMockBuilder($commands->getCommandClass('echo'))
|
|
->onlyMethods(array('getArguments'))
|
|
->getMock();
|
|
$cmdEcho->setArguments(array('ECHOED'));
|
|
$cmdEcho
|
|
->expects($this->once())
|
|
->method('getArguments')
|
|
->willReturn(array('ECHOED'));
|
|
|
|
$connection = $this->createConnection();
|
|
$connection->addConnectCommand($cmdPing);
|
|
$connection->addConnectCommand($cmdEcho);
|
|
|
|
$connection->connect();
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testReadsStatusResponses(): void
|
|
{
|
|
$commands = $this->getCommandFactory();
|
|
$connection = $this->createConnection(true);
|
|
|
|
$connection->writeRequest($commands->create('set', array('foo', 'bar')));
|
|
$this->assertInstanceOf('Predis\Response\Status', $connection->read());
|
|
|
|
$connection->writeRequest($commands->create('ping'));
|
|
$this->assertInstanceOf('Predis\Response\Status', $connection->read());
|
|
|
|
$connection->writeRequest($commands->create('multi'));
|
|
$connection->writeRequest($commands->create('ping'));
|
|
$this->assertInstanceOf('Predis\Response\Status', $connection->read());
|
|
$this->assertInstanceOf('Predis\Response\Status', $connection->read());
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testReadsBulkResponses(): void
|
|
{
|
|
$commands = $this->getCommandFactory();
|
|
$connection = $this->createConnection(true);
|
|
|
|
$connection->executeCommand($commands->create('set', array('foo', 'bar')));
|
|
|
|
$connection->writeRequest($commands->create('get', array('foo')));
|
|
$this->assertSame('bar', $connection->read());
|
|
|
|
$connection->writeRequest($commands->create('get', array('hoge')));
|
|
$this->assertNull($connection->read());
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testReadsIntegerResponses(): void
|
|
{
|
|
$commands = $this->getCommandFactory();
|
|
$connection = $this->createConnection(true);
|
|
|
|
$connection->executeCommand($commands->create('rpush', array('metavars', 'foo', 'hoge', 'lol')));
|
|
$connection->writeRequest($commands->create('llen', array('metavars')));
|
|
|
|
$this->assertSame(3, $connection->read());
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testReadsErrorResponsesAsResponseErrorObjects(): void
|
|
{
|
|
$commands = $this->getCommandFactory();
|
|
$connection = $this->createConnection(true);
|
|
|
|
$connection->executeCommand($commands->create('set', array('foo', 'bar')));
|
|
$connection->writeRequest($commands->create('rpush', array('foo', 'baz')));
|
|
|
|
$this->assertInstanceOf('Predis\Response\Error', $error = $connection->read());
|
|
$this->assertMatchesRegularExpression(
|
|
'/[ERR|WRONGTYPE] Operation against a key holding the wrong kind of value/', $error->getMessage()
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
*/
|
|
public function testReadsMultibulkResponsesAsArrays(): void
|
|
{
|
|
$commands = $this->getCommandFactory();
|
|
$connection = $this->createConnection(true);
|
|
|
|
$connection->executeCommand($commands->create('rpush', array('metavars', 'foo', 'hoge', 'lol')));
|
|
$connection->writeRequest($commands->create('lrange', array('metavars', 0, -1)));
|
|
|
|
$this->assertSame(array('foo', 'hoge', 'lol'), $connection->read());
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
* @group slow
|
|
*/
|
|
public function testThrowsExceptionOnConnectionTimeout(): void
|
|
{
|
|
$this->expectException('Predis\Connection\ConnectionException');
|
|
$this->expectExceptionMessageMatches('/.* \[tcp:\/\/169.254.10.10:6379\]/');
|
|
|
|
$connection = $this->createConnectionWithParams(array(
|
|
'host' => '169.254.10.10',
|
|
'timeout' => 0.1,
|
|
), false);
|
|
|
|
$connection->connect();
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
* @group slow
|
|
*/
|
|
public function testThrowsExceptionOnConnectionTimeoutIPv6(): void
|
|
{
|
|
$this->expectException('Predis\Connection\ConnectionException');
|
|
$this->expectExceptionMessageMatches('/.* \[tcp:\/\/\[0:0:0:0:0:ffff:a9fe:a0a\]:6379\]/');
|
|
|
|
$connection = $this->createConnectionWithParams(array(
|
|
'host' => '0:0:0:0:0:ffff:a9fe:a0a',
|
|
'timeout' => 0.1,
|
|
), false);
|
|
|
|
$connection->connect();
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
* @group slow
|
|
*/
|
|
public function testThrowsExceptionOnUnixDomainSocketNotFound(): void
|
|
{
|
|
$this->expectException('Predis\Connection\ConnectionException');
|
|
$this->expectExceptionMessageMatches('/.* \[unix:\/tmp\/nonexistent\/redis\.sock]/');
|
|
|
|
$connection = $this->createConnectionWithParams(array(
|
|
'scheme' => 'unix',
|
|
'path' => '/tmp/nonexistent/redis.sock',
|
|
), false);
|
|
|
|
$connection->connect();
|
|
}
|
|
|
|
/**
|
|
* @group connected
|
|
* @group slow
|
|
*/
|
|
public function testThrowsExceptionOnReadWriteTimeout(): void
|
|
{
|
|
$this->expectException('Predis\Connection\ConnectionException');
|
|
|
|
$commands = $this->getCommandFactory();
|
|
|
|
$connection = $this->createConnectionWithParams(array(
|
|
'read_write_timeout' => 0.5,
|
|
), true);
|
|
|
|
$connection->executeCommand($commands->create('brpop', array('foo', 3)));
|
|
}
|
|
|
|
/**
|
|
* @medium
|
|
* @group connected
|
|
*/
|
|
public function testThrowsExceptionOnProtocolDesynchronizationErrors(): void
|
|
{
|
|
$this->expectException('Predis\Protocol\ProtocolException');
|
|
|
|
$connection = $this->createConnection();
|
|
$stream = $connection->getResource();
|
|
|
|
$connection->writeRequest($this->getCommandFactory()->create('ping'));
|
|
fread($stream, 1);
|
|
|
|
$connection->read();
|
|
}
|
|
|
|
// ******************************************************************** //
|
|
// ---- HELPER METHODS ------------------------------------------------ //
|
|
// ******************************************************************** //
|
|
|
|
/**
|
|
* Returns the fully-qualified class name of the connection used for tests.
|
|
*
|
|
* @return string
|
|
*/
|
|
protected abstract function getConnectionClass(): string;
|
|
|
|
/**
|
|
* Returns a named array with the default connection parameters and their values.
|
|
*
|
|
* @return array Default connection parameters.
|
|
*/
|
|
protected function getDefaultParametersArray(): array
|
|
{
|
|
return array(
|
|
'scheme' => 'tcp',
|
|
'host' => constant('REDIS_SERVER_HOST'),
|
|
'port' => constant('REDIS_SERVER_PORT'),
|
|
'database' => constant('REDIS_SERVER_DBNUM'),
|
|
'read_write_timeout' => 2,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Asserts the connection is using a persistent resource stream.
|
|
*
|
|
* This assertion will trigger a connect() operation if the connection has
|
|
* not been open yet.
|
|
*
|
|
* @param NodeConnectionInterface $connection Connection instance
|
|
*/
|
|
protected function assertPersistentConnection(NodeConnectionInterface $connection): void
|
|
{
|
|
$this->assertSame('persistent stream', get_resource_type($connection->getResource()));
|
|
}
|
|
|
|
/**
|
|
* Asserts the connection is not using a persistent resource stream.
|
|
*
|
|
* This assertion will trigger a connect() operation if the connection has
|
|
* not been open yet.
|
|
*
|
|
* @param NodeConnectionInterface $connection Connection instance
|
|
*/
|
|
protected function assertNonPersistentConnection(NodeConnectionInterface $connection): void
|
|
{
|
|
$this->assertSame('stream', get_resource_type($connection->getResource()));
|
|
}
|
|
|
|
/**
|
|
* Creates a new connection instance.
|
|
*
|
|
* @param bool $initialize Push default initialization commands (SELECT and FLUSHDB)
|
|
*
|
|
* @return NodeConnectionInterface
|
|
*/
|
|
protected function createConnection(bool $initialize = false): NodeConnectionInterface
|
|
{
|
|
return $this->createConnectionWithParams(array(), $initialize);
|
|
}
|
|
|
|
/**
|
|
* Creates a new connection instance using additional connection parameters.
|
|
*
|
|
* @param string|array|ParametersInterface $parameters Additional connection parameters
|
|
* @param bool $initialize Push default initialization commands (SELECT and FLUSHDB)
|
|
*
|
|
* @return NodeConnectionInterface
|
|
*/
|
|
protected function createConnectionWithParams($parameters, $initialize = false): NodeConnectionInterface
|
|
{
|
|
$class = $this->getConnectionClass();
|
|
$commands = $this->getCommandFactory();
|
|
|
|
if (!$parameters instanceof ParametersInterface) {
|
|
$parameters = $this->getParameters($parameters);
|
|
}
|
|
|
|
$connection = new $class($parameters);
|
|
|
|
if ($initialize) {
|
|
$connection->addConnectCommand(
|
|
$commands->create('select', array($parameters->database))
|
|
);
|
|
|
|
$connection->addConnectCommand(
|
|
$commands->create('flushdb')
|
|
);
|
|
}
|
|
|
|
return $connection;
|
|
}
|
|
}
|