predis/tests/Predis/Command/KeySortTest.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\Command;

/**
 * @group commands
 * @group realm-key
 */
class KeySortTest extends PredisCommandTestCase
{
    /**
     * {@inheritdoc}
     */
    protected function getExpectedCommand()
    {
        return 'Predis\Command\KeySort';
    }

    /**
     * {@inheritdoc}
     */
    protected function getExpectedId()
    {
        return 'SORT';
    }

    /**
     * Utility method to to an LPUSH of some unordered values on a key.
     *
     * @param  Predis\Client $redis Redis client instance.
     * @param  string        $key   Target key
     * @return array
     */
    protected function lpushUnorderedList(Predis\Client $redis, $key)
    {
        $list = array(2, 100, 3, 1, 30, 10);
        $redis->lpush($key, $list);

        return $list;
    }

    /**
     * @group disconnected
     */
    public function testFilterArguments()
    {
        $modifiers = array(
            'by' => 'by_key_*',
            'limit' => array(1, 4),
            'get' => array('object_*', '#'),
            'sort'  => 'asc',
            'alpha' => true,
            'store' => 'destination_key',
        );
        $arguments = array('key', $modifiers);

        $expected = array(
            'key', 'BY', 'by_key_*', 'GET', 'object_*', 'GET', '#',
            'LIMIT', 1, 4, 'ASC', 'ALPHA', 'STORE', 'destination_key'
        );

        $command = $this->getCommand();
        $command->setArguments($arguments);

        $this->assertEquals($expected, $command->getArguments());
    }

    /**
     * @group disconnected
     */
    public function testGetModifierCanBeString()
    {
        $arguments = array('key', array('get' => '#'));
        $expected = array('key', 'GET', '#');

        $command = $this->getCommand();
        $command->setArguments($arguments);

        $this->assertSame($expected, $command->getArguments());
    }

    /**
     * @group disconnected
     */
    public function testParseResponse()
    {
        $raw = array('value1', 'value2', 'value3');
        $expected = array('value1', 'value2', 'value3');

        $command = $this->getCommand();

        $this->assertSame($expected, $command->parseResponse($raw));
    }

    /**
     * @group disconnected
     */
    public function testPrefixKeys()
    {
        $modifiers = array(
            'by' => 'by_key_*',
            'limit' => array(1, 4),
            'get' => array('object_*', '#'),
            'sort'  => 'asc',
            'alpha' => true,
            'store' => 'destination_key',
        );
        $arguments = array('key', $modifiers);

        $expected = array(
            'prefix:key', 'BY', 'prefix:by_key_*', 'GET', 'prefix:object_*', 'GET', '#',
            'LIMIT', 1, 4, 'ASC', 'ALPHA', 'STORE', 'prefix:destination_key'
        );

        $command = $this->getCommandWithArgumentsArray($arguments);
        $command->prefixKeys('prefix:');

        $this->assertSame($expected, $command->getArguments());
    }

    /**
     * @group disconnected
     */
    public function testPrefixKeysIgnoredOnEmptyArguments()
    {
        $command = $this->getCommand();
        $command->prefixKeys('prefix:');

        $this->assertSame(array(), $command->getArguments());
    }

    /**
     * @group connected
     */
    public function testBasicSort()
    {
        $redis = $this->getClient();
        $redis->lpush('list:unordered', $unordered = array(2, 100, 3, 1, 30, 10));

        $this->assertEquals(array(1, 2, 3, 10, 30, 100), $redis->sort('list:unordered'));
    }

    /**
     * @group connected
     */
    public function testSortWithAscOrDescModifier()
    {
        $redis = $this->getClient();
        $redis->lpush('list:unordered', $unordered = array(2, 100, 3, 1, 30, 10));

        $this->assertEquals(
            array(100, 30, 10, 3, 2, 1),
            $redis->sort('list:unordered', array(
                'sort' => 'desc',
            ))
        );

        $this->assertEquals(
            array(1, 2, 3, 10, 30, 100),
            $redis->sort('list:unordered', array(
                'sort' => 'asc',
            ))
        );
    }

    /**
     * @group connected
     */
    public function testSortWithLimitModifier()
    {
        $redis = $this->getClient();
        $redis->lpush('list:unordered', $unordered = array(2, 100, 3, 1, 30, 10));

        $this->assertEquals(
            array(1, 2, 3),
            $redis->sort('list:unordered', array(
                'limit' => array(0, 3),
            ))
        );

        $this->assertEquals(
            array(10, 30),
            $redis->sort('list:unordered', array(
                'limit' => array(3, 2)
            ))
        );
    }

    /**
     * @group connected
     */
    public function testSortWithAlphaModifier()
    {
        $redis = $this->getClient();
        $redis->lpush('list:unordered', $unordered = array(2, 100, 3, 1, 30, 10));

        $this->assertEquals(
            array(1, 10, 100, 2, 3, 30),
            $redis->sort('list:unordered', array(
                'alpha' => true
            ))
        );
    }

    /**
     * @group connected
     */
    public function testSortWithStoreModifier()
    {
        $redis = $this->getClient();
        $redis->lpush('list:unordered', $unordered = array(2, 100, 3, 1, 30, 10));

        $this->assertEquals(
            count($unordered),
            $redis->sort('list:unordered', array(
                'store' => 'list:ordered'
            ))
        );

        $this->assertEquals(array(1, 2, 3, 10, 30, 100),  $redis->lrange('list:ordered', 0, -1));
    }

    /**
     * @group connected
     */
    public function testSortWithCombinedModifiers()
    {
        $redis = $this->getClient();
        $redis->lpush('list:unordered', $unordered = array(2, 100, 3, 1, 30, 10));

        $this->assertEquals(
            array(30, 10, 3, 2),
            $redis->sort('list:unordered', array(
                'alpha' => false,
                'sort'  => 'desc',
                'limit' => array(1, 4)
            ))
        );
    }

    /**
     * @group connected
     */
    public function testSortWithGetModifiers()
    {
        $redis = $this->getClient();
        $redis->lpush('list:unordered', $unordered = array(2, 100, 3, 1, 30, 10));

        $redis->rpush('list:uids', $uids = array(1003, 1001, 1002, 1000));
        $redis->mset($sortget = array(
            'uid:1000' => 'foo',  'uid:1001' => 'bar',
            'uid:1002' => 'hoge', 'uid:1003' => 'piyo',
        ));

        $this->assertEquals(array_values($sortget), $redis->sort('list:uids', array('get' => 'uid:*')));
    }

    /**
     * @group connected
     * @expectedException Predis\ServerException
     * @expectedExceptionMessage Operation against a key holding the wrong kind of value
     */
    public function testThrowsExceptionOnWrongType()
    {
        $redis = $this->getClient();

        $redis->set('foo', 'bar');
        $redis->sort('foo');
    }
}