Predis ClientInterface declares zadd as:

https://github.com/nrk/predis/blob/111d100ee389d624036b46b35ed0c9ac59c71313/src/ClientInterface.php#L116
* @method int zadd($key, array $membersAndScoresDictionary)

While RedisMock declares:
https://github.com/M6Web/RedisMock/blob/f4c6f55497becb1c6f5d9593b2a74163e0281858/src/M6Web/Component/RedisMock/RedisMock.php#L931
public function zadd($key, $score, $member) {

Am I missing something?

array_key_exists(): The first argument should be either a string or an integer at
m6web/redis-mock/src/M6Web/Component/RedisMock/RedisMock.php:756

vendor/predis/predis/src/ClientInterface.php:69

• @method int hdel($key, array $fields)

Currently the client mocks a connection to one single Redis server, and storage is static, shared across all instances of the mock (which is good).
I would like to use a test scenario involving two (or more) Redis servers. The storage should remain mock-static, but per "Redis server".

Shall I fork and propose?

Hi, could you add QUIT command support ?

http://redis.io/commands/QUIT

It always returns OK.

Thanks

So I'm using this project in a Lumen setup that uses Predis 1.1. Mocking a Redis server works perfectly when using individual Redis commands, however, I can't get it to work when using pipeline. When doing something like this:

$response = Redis::pipeline(function($pipe) {
   // Run redis commands here
});

I'm expecting that $response will be an array with command results. However, when mocking the Predis Client, I get an instance of RedisMock instead.

Is the pipeline support not fully implemented or am I missing something here?

Thanks.

Hi

Right now I'm using Predis as redis library. The ZADD function is defined this way:
zadd($key, array $membersAndScoresDictionary)

When using RedisMock in my unit tests, I get an error stating that argument 3 is missing for zadd. (as ZADD is defined as zadd($key, $score, $member)).

Does it seem logical to add this change? Or do other PHP Redis library implment zadd differently?

I have a project env that is PHP 5.6, need to use the scan feature, hope to support it, thx.

• DISCARD
• EXEC
• MULTI
• UNWATCH
• WATCH

missing feature allowing us a complete unit test of this lib https://github.com/M6Web/Redis :)

Hi, thanks for a great lib!

I would love to see support for llen (should be easy) and blpop (a bit harder I think). Blpop could work by just adding a warning if the queue is emtpy and retuning after a sleep() timeout.

redis> sadd raoul toto
(integer) 1
redis> hdel raoul toto
WRONGTYPE Operation against a key holding the wrong kind of value
redis>

actually, hard to mock cause a concrete class can throw any kind of exception ...

Hi, I thought Predis transactions were supported - is that not correct?

Here's the code I was trying to test:

function fetchMessages($redisClient) {
        $messages = $redisClient->zrevrangebyscore('myqueue', time(), 0);
        $queueId = 'myqueue';

        foreach ($messages as $message) {
            $dmes = json_decode($message, true);
            $redisClient->transaction(
                function ($tx) use ($dmes, $queueId, $message) {
                    $tx->zrem($queueId, $message);
                    $tx->rpush($dmes['destination'], json_encode($dmes['message']));
                }
            );
        }

}

And the test:

function testMyRedisQueue() {
$factory = new \M6Web\Component\RedisMock\RedisMockFactory();
        $redis = $factory->getAdapter('Predis\Client', true, false, '', [
           [ 'profile' => '3.0']
        ]);

  $message = json_encode(['destination'=>'tq1', 'message' => ['key' => 'v'], 'timestamp' =>  new \DateTimeImmutable('now - 3 hours')->getTimestamp()]);
        $redis->zadd('myqueue',  \DateTimeImmutable('now - 3 hours')->getTimestamp(), $message);

        $this->assertEquals(0, $redis->llen('tq1'));

       fetchMessages($redis); 
  
       $this->assertEquals(1, $this->redis->llen('tq1'));

}

I have isolated the problem to the code within the transaction call. If I run it outside the transaction then the test works. Any ideas on how to fix this?

• Version: 2.8.0
• PHP: 7.2
• Warning: "Parameter must be an array or an object that implements Countable"

Affected code:

$deletedKeyCount += count(self::$dataValues[$this->storage][$k]);

Bugfix:

$value = self::$dataValues[$this->storage][$k];
$deletedKeyCount += is_array($value) ? count($value) : 1;

Any particular reason you do not support adding multiple members with SADD? Or just didn't get to it yet?

We discovered an issue with phpredis.

We wan't to create a Redis mock to inject them into another class that expects an instance of Redis.
Our solution now is to not use the factory but creating RedisMock directly, remove the typehint in our sut and inject the RedisMock directly.

System Informations

OS: Linux
PHP: PHP 7.1.10-1+0~20170929170631.9+jessie~1.gbp501135 (cli)
phpredis: 3.1.2

Reproduce

$factory          = new \M6Web\Component\RedisMock\RedisMockFactory();
$myRedisMockClass = $factory->getAdapter(Redis::class, true);
$myRedisMock      = new $myRedisMockClass();

$myRedisMock->hSetNx('foo', 'bar', 'baz');

Error

ArgumentCountError: Too few arguments to function M6Web\Component\RedisMock\RedisMock::hsetnx(), 0 passed in vendor/m6web/redis-mock/src/M6Web/Component/RedisMock/RedisMockFactory.php(226) : eval()'d code on line 370 and exactly 3 expected

vendor/m6web/redis-mock/src/M6Web/Component/RedisMock/RedisMock.php:579

More informations

we debugged a bit and found out that the reflection of Redis give no details about the parameters for most of the methods.

php > $ref = new ReflectionClass(Redis::class);
php > echo (string)$ref;
Class [ <internal:redis> class Redis ] {
...
    Method [ <internal:redis> public method hGet ] {
    }

    Method [ <internal:redis> public method hSet ] {
    }

    Method [ <internal:redis> public method hSetNx ] {
    }

    Method [ <internal:redis> public method hDel ] {
    }
...
    Method [ <internal:redis> public method command ] {
    }

    Method [ <internal:redis> public method scan ] {

      - Parameters [3] {
        Parameter #0 [ <required> &$i_iterator ]
        Parameter #1 [ <optional> $str_pattern ]
        Parameter #2 [ <optional> $i_count ]
      }
    }

    Method [ <internal:redis> public method hscan ] {

      - Parameters [4] {
        Parameter #0 [ <required> $str_key ]
        Parameter #1 [ <required> &$i_iterator ]
        Parameter #2 [ <optional> $str_pattern ]
        Parameter #3 [ <optional> $i_count ]
      }
    }
...
}

Hi there,
I want to test that my code behaviour in a certain manner when the set command returns an exception.
Is there a way in your library to tell the mocked redis to return an exception on certain commands?
Thanks, Gioia

The set method signature on RedisMock seems to be wrong and store ttl in second.

However set should support milliseconds for ttl definition.

public function set($key, $value, $options = null, $ttl = null)
{
    /**
     * Per https://redis.io/commands/set#options
     * EX seconds -- Set the specified expire time, in seconds.
     * PX milliseconds -- Set the specified expire time, in milliseconds.
     * NX -- Only set the key if it does not already exist.
     * XX -- Only set the key if it already exist.
     */
    if (!is_null($options) && !in_array($options, ['ex', 'px', 'nx', 'xx'])) {
        $this->returnPipedInfo('(error) ERR syntax error');
    }
    if ('nx'=== $options && $this->get($key)) {
        return $this->returnPipedInfo(0);
    }
    if ('xx' === $options && !$this->get($key)) {
        return $this->returnPipedInfo(0);
    }

    if ($options === 'ex') {
        $ttl = $ttl;
    } elseif ($options === 'px') {
        $ttl = $ttl / 1000;
    }

    self::$dataValues[$this->storage][$key] = $value;
    self::$dataTypes[$this->storage][$key] = 'string';

    if (!is_null($ttl)) {
        self::$dataTtl[$this->storage][$key] = microtime(true) + $ttl;
    }

As it will be impacted, We should update RedisSessionHandler, and check that ttl resolution is compatible with symfony session resolution

The latest releases of Laravel have started using the sscan method to chunk results.

RedisMock does not support this method. It would be really helpful to get this functionality added.

laravel/framework#39939

Updating predis to ~v2 in composer.json fails the tests with:

PHP Fatal error:  Declaration of M6Web\Component\RedisMock\RedisMock_Predis_Client_Adapter::pipeline($arguments) must be compatible with Predis\Client::pipeline(...$arguments) in /var/www/html/scriptsender/vendor/m6web/redis-mock/src/M6Web/Component/RedisMock/RedisMockFactory.php(226) : eval()'d code on line 40

Trying to mock Predis (https://github.com/nrk/predis). The following exception is thrown by the getAdapterClass() function:

$factory          = new \M6Web\Component\RedisMock\RedisMockFactory();
$myRedisMockClass = $factory->getAdapterClass('Predis\Client', true);

M6Web\Component\RedisMock\UnsupportedException: Redis command `quit` is not supported by RedisMock.

.../m6web/redis-mock/src/M6Web/Component/RedisMock/RedisMockFactory.php:267
.../m6web/redis-mock/src/M6Web/Component/RedisMock/RedisMockFactory.php:237

Result in mock fail.
The ex and nx parameters diff.
https://github.com/M6Web/RedisMock/blob/7438b0d8f94662d47dbd8931f5944d36f3a93e8e/src/M6Web/Component/RedisMock/RedisMock.php#L80

    public function set($key, $value, $seconds = null)
    {
        if (\is_array($seconds)) {
...

https://github.com/nrk/predis/blob/111d100ee389d624036b46b35ed0c9ac59c71313/src/ClientInterface.php#L63

@method mixed  set($key, $value, $expireResolution = null, $expireTTL = null, $flag = null)

Sure at the time of writing there was an update back in May 2023 but here is the thing, this project is trying to mimic a Redis server in PHP. No small feat.

We just came out of 2 days of searching why our unit tests would randomly fail. We noticed that "waiting enough" was a "solution" only to realize that the SET method doesn't properly support the EX argument - more specifically Predis allows for $predis->set('my key', 'my value', 'EX', 1000); when this lib would only support $predisMock->set('my key', 'my value', ['EX' => 1000]); - effectively applying a none-determined TTL thus explaining the side-effect.

We then began to fork the project in order to contribute with a fix. We tried to follow the README saying we should use vagrant for running the unit tests - aka https://github.com/BedrockStreaming/RedisMock#tests - so we could TDD ourselves here, only to realize that the referenced image doesn't exist anymore and obviously vagrant is a dead technology now, so...

And it is at that moment we asked ourselves, why? Why would we try to fix this specific behavior when there are probably plenty of others waiting for us to uncover. And most importantly, what do people do in our situation, when they need to "mock Redis"?

Well,

1. people simply mock the Redis client straight up, mocking the ->set() function, etc.
2. when you cannot "simply mock Redis" because your unit test is more "functional" than "unit", then you should use... Redis itself 🤷

It's easy and fast to bootstrap a clean Redis instance, especially with docker,

  redis:
    container_name: redis
    restart: unless-stopped
    image: redis:latest
    command: redis-server --loglevel notice

And then with Gitlab CI/CD it is even more easier, https://docs.gitlab.com/ee/ci/services/redis.html

services:
  - redis:latest

I suppose it is also something easy to achieve on Github - https://docs.github.com/en/actions/using-containerized-services/creating-redis-service-containers

Anyway, the point of this is issue is to warn people looking to use redis-mock. That would be nice to have a disclaimer in the README file as well.

I would like to take a moment of gratitude to the dev(s) and maintainer of the project 🙏 even though I think it's a bad idea to go down that route I respect the effort and dedication.

Maybe I'm doing it wrong but I cannot get this to work with the Redis extension. I'm running PHP 7, here is the list of warnings I'm getting:

Declaration of M6Web\Component\RedisMock\RedisMock_Redis_Adapter::scan(&$i_iterator, $str_pattern, $i_count) should be compatible with Redis::scan(&$i_iterator, $str_pattern = NULL, $i_count = NULL)
Declaration of M6Web\Component\RedisMock\RedisMock_Redis_Adapter::hscan($str_key, &$i_iterator, $str_pattern, $i_count) should be compatible with Redis::hscan($str_key, &$i_iterator, $str_pattern = NULL, $i_count = NULL)
Declaration of M6Web\Component\RedisMock\RedisMock_Redis_Adapter::zscan($str_key, &$i_iterator, $str_pattern, $i_count) should be compatible with Redis::zscan($str_key, &$i_iterator, $str_pattern = NULL, $i_count = NULL)
Declaration of M6Web\Component\RedisMock\RedisMock_Redis_Adapter::sscan($str_key, &$i_iterator, $str_pattern, $i_count) should be compatible with Redis::sscan($str_key, &$i_iterator, $str_pattern = NULL, $i_count = NULL)

I'm suspecting this is because the default value of internal/extension classes cannot be read (see Ocramius/ProxyManager#162 for example or also ParameterResolver.php#L97).

I'm wondering if it's sane to set a default value of null if we know there is a default value ($parameter->isOptional()) but we can't read it ($parameter->isDefaultValueAvailable())…

Has anyone managed to make this work with the Redis class of the Redis extension? (if so, which PHP version?)

See https://github.com/nrk/predis/blob/v1.0/tests/Predis/Command/ListPushHeadTest.php#L53

Regards ,

Tarjei

Add support for http://redis.io/commands/getset.

Hello!

I work with the Laravel framework and start switching to the latest version (5.8)
I use the josiasmontag / laravel-redis-mock library (which uses your library) to test Laravel queues
Starting with version 5.8, Laravel Redis starts using the function eval, and I get this error

Is it possible to add the eval function to the RedisMock class?

I will be very grateful for this!