mirror of
https://github.com/predis/predis.git
synced 2026-08-24 20:49:41 +00:00
Daniele Alessandri
b2f59a0c63
We extract the keys from commands using the second argument of EVAL / EVALSHA which specifies the number of arguments that must be treated as keys (used to populate the KEYS table in the Lua script) and then we check if all the keys generate the same hash using the usual method. Our scripted command abstraction is also supported. It comes without saying that accessing or setting keys from within the Lua script is something that might not work as expected, so you should be careful when using EVAL and EVALSHA in the context of client-side sharding.
368 lines
13 KiB
PHP
368 lines
13 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\Cluster;
|
|
|
|
use \PHPUnit_Framework_TestCase as StandardTestCase;
|
|
|
|
use Predis\Cluster\Distribution\HashRing;
|
|
use Predis\Profile\ServerProfile;
|
|
|
|
/**
|
|
*
|
|
*/
|
|
class PredisClusterHashStrategyTest extends StandardTestCase
|
|
{
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testSupportsKeyTags()
|
|
{
|
|
$expected = -1938594527;
|
|
$strategy = $this->getHashStrategy();
|
|
|
|
$this->assertSame($expected, $strategy->getKeyHash('{foo}'));
|
|
$this->assertSame($expected, $strategy->getKeyHash('{foo}:bar'));
|
|
$this->assertSame($expected, $strategy->getKeyHash('{foo}:baz'));
|
|
$this->assertSame($expected, $strategy->getKeyHash('bar:{foo}:bar'));
|
|
|
|
$this->assertSame(0, $strategy->getKeyHash(''));
|
|
$this->assertSame(0, $strategy->getKeyHash('{}'));
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testSupportedCommands()
|
|
{
|
|
$strategy = $this->getHashStrategy();
|
|
|
|
$this->assertSame($this->getExpectedCommands(), $strategy->getSupportedCommands());
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testReturnsNullOnUnsupportedCommand()
|
|
{
|
|
$strategy = $this->getHashStrategy();
|
|
$command = ServerProfile::getDevelopment()->createCommand('ping');
|
|
|
|
$this->assertNull($strategy->getHash($command));
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testFirstKeyCommands()
|
|
{
|
|
$strategy = $this->getHashStrategy();
|
|
$profile = ServerProfile::getDevelopment();
|
|
$arguments = array('key');
|
|
|
|
foreach ($this->getExpectedCommands('keys-first') as $commandID) {
|
|
$command = $profile->createCommand($commandID, $arguments);
|
|
$this->assertNotNull($strategy->getHash($command), $commandID);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testAllKeysCommands()
|
|
{
|
|
$strategy = $this->getHashStrategy();
|
|
$profile = ServerProfile::getDevelopment();
|
|
$arguments = array('{key}:1', '{key}:2', '{key}:3', '{key}:4');
|
|
|
|
foreach ($this->getExpectedCommands('keys-all') as $commandID) {
|
|
$command = $profile->createCommand($commandID, $arguments);
|
|
$this->assertNotNull($strategy->getHash($command), $commandID);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testInterleavedKeysCommands()
|
|
{
|
|
$strategy = $this->getHashStrategy();
|
|
$profile = ServerProfile::getDevelopment();
|
|
$arguments = array('{key}:1', 'value1', '{key}:2', 'value2');
|
|
|
|
foreach ($this->getExpectedCommands('keys-interleaved') as $commandID) {
|
|
$command = $profile->createCommand($commandID, $arguments);
|
|
$this->assertNotNull($strategy->getHash($command), $commandID);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testKeysForBlockingListCommands()
|
|
{
|
|
$strategy = $this->getHashStrategy();
|
|
$profile = ServerProfile::getDevelopment();
|
|
$arguments = array('{key}:1', '{key}:2', 10);
|
|
|
|
foreach ($this->getExpectedCommands('keys-blockinglist') as $commandID) {
|
|
$command = $profile->createCommand($commandID, $arguments);
|
|
$this->assertNotNull($strategy->getHash($command), $commandID);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testKeysForZsetAggregationCommands()
|
|
{
|
|
$strategy = $this->getHashStrategy();
|
|
$profile = ServerProfile::getDevelopment();
|
|
$arguments = array('{key}:destination', 2, '{key}:1', '{key}:1', array('aggregate' => 'SUM'));
|
|
|
|
foreach ($this->getExpectedCommands('keys-zaggregated') as $commandID) {
|
|
$command = $profile->createCommand($commandID, $arguments);
|
|
$this->assertNotNull($strategy->getHash($command), $commandID);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testKeysForBitOpCommand()
|
|
{
|
|
$strategy = $this->getHashStrategy();
|
|
$profile = ServerProfile::getDevelopment();
|
|
$arguments = array('AND', '{key}:destination', '{key}:src:1', '{key}:src:2');
|
|
|
|
foreach ($this->getExpectedCommands('keys-bitop') as $commandID) {
|
|
$command = $profile->createCommand($commandID, $arguments);
|
|
$this->assertNotNull($strategy->getHash($command), $commandID);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testKeysForScriptCommand()
|
|
{
|
|
$strategy = $this->getHashStrategy();
|
|
$profile = ServerProfile::getDevelopment();
|
|
$arguments = array('%SCRIPT%', 2, '{key}:1', '{key}:2', 'value1', 'value2');
|
|
|
|
foreach ($this->getExpectedCommands('keys-script') as $commandID) {
|
|
$command = $profile->createCommand($commandID, $arguments);
|
|
$this->assertNotNull($strategy->getHash($command), $commandID);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testKeysForScriptedCommand()
|
|
{
|
|
$strategy = $this->getHashStrategy();
|
|
$arguments = array('{key}:1', '{key}:2', 'value1', 'value2');
|
|
|
|
$command = $this->getMock('Predis\Command\ScriptedCommand', array('getScript', 'getKeysCount'));
|
|
$command->expects($this->once())
|
|
->method('getScript')
|
|
->will($this->returnValue('return true'));
|
|
$command->expects($this->exactly(2))
|
|
->method('getKeysCount')
|
|
->will($this->returnValue(2));
|
|
$command->setArguments($arguments);
|
|
|
|
$this->assertNotNull($strategy->getHash($command), "Scripted Command [{$command->getId()}]");
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testUnsettingCommandHandler()
|
|
{
|
|
$strategy = $this->getHashStrategy();
|
|
$profile = ServerProfile::getDevelopment();
|
|
|
|
$strategy->setCommandHandler('set');
|
|
$strategy->setCommandHandler('get', null);
|
|
|
|
$command = $profile->createCommand('set', array('key', 'value'));
|
|
$this->assertNull($strategy->getHash($command));
|
|
|
|
$command = $profile->createCommand('get', array('key'));
|
|
$this->assertNull($strategy->getHash($command));
|
|
}
|
|
|
|
/**
|
|
* @group disconnected
|
|
*/
|
|
public function testSettingCustomCommandHandler()
|
|
{
|
|
$strategy = $this->getHashStrategy();
|
|
$profile = ServerProfile::getDevelopment();
|
|
|
|
$callable = $this->getMock('stdClass', array('__invoke'));
|
|
$callable->expects($this->once())
|
|
->method('__invoke')
|
|
->with($this->isInstanceOf('Predis\Command\CommandInterface'))
|
|
->will($this->returnValue('key'));
|
|
|
|
$strategy->setCommandHandler('get', $callable);
|
|
|
|
$command = $profile->createCommand('get', array('key'));
|
|
$this->assertNotNull($strategy->getHash($command));
|
|
}
|
|
|
|
// ******************************************************************** //
|
|
// ---- HELPER METHODS ------------------------------------------------ //
|
|
// ******************************************************************** //
|
|
|
|
/**
|
|
* Creates the default hash strategy object.
|
|
*
|
|
* @return CommandHashStrategyInterface
|
|
*/
|
|
protected function getHashStrategy()
|
|
{
|
|
$distributor = new HashRing();
|
|
$hashGenerator = $distributor->getHashGenerator();
|
|
$strategy = new PredisClusterHashStrategy($hashGenerator);
|
|
|
|
return $strategy;
|
|
}
|
|
|
|
/**
|
|
* Returns the list of expected supported commands.
|
|
*
|
|
* @param string $type Optional type of command (based on its keys)
|
|
* @return array
|
|
*/
|
|
protected function getExpectedCommands($type = null)
|
|
{
|
|
$commands = array(
|
|
/* commands operating on the key space */
|
|
'EXISTS' => 'keys-first',
|
|
'DEL' => 'keys-all',
|
|
'TYPE' => 'keys-first',
|
|
'EXPIRE' => 'keys-first',
|
|
'EXPIREAT' => 'keys-first',
|
|
'PERSIST' => 'keys-first',
|
|
'PEXPIRE' => 'keys-first',
|
|
'PEXPIREAT' => 'keys-first',
|
|
'TTL' => 'keys-first',
|
|
'PTTL' => 'keys-first',
|
|
'SORT' => 'keys-first', // TODO
|
|
|
|
/* commands operating on string values */
|
|
'APPEND' => 'keys-first',
|
|
'DECR' => 'keys-first',
|
|
'DECRBY' => 'keys-first',
|
|
'GET' => 'keys-first',
|
|
'GETBIT' => 'keys-first',
|
|
'MGET' => 'keys-all',
|
|
'SET' => 'keys-first',
|
|
'GETRANGE' => 'keys-first',
|
|
'GETSET' => 'keys-first',
|
|
'INCR' => 'keys-first',
|
|
'INCRBY' => 'keys-first',
|
|
'SETBIT' => 'keys-first',
|
|
'SETEX' => 'keys-first',
|
|
'MSET' => 'keys-interleaved',
|
|
'MSETNX' => 'keys-interleaved',
|
|
'SETNX' => 'keys-first',
|
|
'SETRANGE' => 'keys-first',
|
|
'STRLEN' => 'keys-first',
|
|
'SUBSTR' => 'keys-first',
|
|
'BITOP' => 'keys-bitop',
|
|
'BITCOUNT' => 'keys-first',
|
|
|
|
/* commands operating on lists */
|
|
'LINSERT' => 'keys-first',
|
|
'LINDEX' => 'keys-first',
|
|
'LLEN' => 'keys-first',
|
|
'LPOP' => 'keys-first',
|
|
'RPOP' => 'keys-first',
|
|
'RPOPLPUSH' => 'keys-all',
|
|
'BLPOP' => 'keys-blockinglist',
|
|
'BRPOP' => 'keys-blockinglist',
|
|
'BRPOPLPUSH' => 'keys-blockinglist',
|
|
'LPUSH' => 'keys-first',
|
|
'LPUSHX' => 'keys-first',
|
|
'RPUSH' => 'keys-first',
|
|
'RPUSHX' => 'keys-first',
|
|
'LRANGE' => 'keys-first',
|
|
'LREM' => 'keys-first',
|
|
'LSET' => 'keys-first',
|
|
'LTRIM' => 'keys-first',
|
|
|
|
/* commands operating on sets */
|
|
'SADD' => 'keys-first',
|
|
'SCARD' => 'keys-first',
|
|
'SDIFF' => 'keys-all',
|
|
'SDIFFSTORE' => 'keys-all',
|
|
'SINTER' => 'keys-all',
|
|
'SINTERSTORE' => 'keys-all',
|
|
'SUNION' => 'keys-all',
|
|
'SUNIONSTORE' => 'keys-all',
|
|
'SISMEMBER' => 'keys-first',
|
|
'SMEMBERS' => 'keys-first',
|
|
'SPOP' => 'keys-first',
|
|
'SRANDMEMBER' => 'keys-first',
|
|
'SREM' => 'keys-first',
|
|
|
|
/* commands operating on sorted sets */
|
|
'ZADD' => 'keys-first',
|
|
'ZCARD' => 'keys-first',
|
|
'ZCOUNT' => 'keys-first',
|
|
'ZINCRBY' => 'keys-first',
|
|
'ZINTERSTORE' => 'keys-zaggregated',
|
|
'ZRANGE' => 'keys-first',
|
|
'ZRANGEBYSCORE' => 'keys-first',
|
|
'ZRANK' => 'keys-first',
|
|
'ZREM' => 'keys-first',
|
|
'ZREMRANGEBYRANK' => 'keys-first',
|
|
'ZREMRANGEBYSCORE' => 'keys-first',
|
|
'ZREVRANGE' => 'keys-first',
|
|
'ZREVRANGEBYSCORE' => 'keys-first',
|
|
'ZREVRANK' => 'keys-first',
|
|
'ZSCORE' => 'keys-first',
|
|
'ZUNIONSTORE' => 'keys-zaggregated',
|
|
|
|
/* commands operating on hashes */
|
|
'HDEL' => 'keys-first',
|
|
'HEXISTS' => 'keys-first',
|
|
'HGET' => 'keys-first',
|
|
'HGETALL' => 'keys-first',
|
|
'HMGET' => 'keys-first',
|
|
'HINCRBY' => 'keys-first',
|
|
'HINCRBYFLOAT' => 'keys-first',
|
|
'HKEYS' => 'keys-first',
|
|
'HLEN' => 'keys-first',
|
|
'HSET' => 'keys-first',
|
|
'HSETNX' => 'keys-first',
|
|
'HVALS' => 'keys-first',
|
|
|
|
/* scripting */
|
|
'EVAL' => 'keys-script',
|
|
'EVALSHA' => 'keys-script',
|
|
);
|
|
|
|
if (isset($type)) {
|
|
$commands = array_filter($commands, function ($expectedType) use ($type) {
|
|
return $expectedType === $type;
|
|
});
|
|
}
|
|
|
|
return array_keys($commands);
|
|
}
|
|
}
|