File: HSETEX_Test.php

package info (click to toggle)
php-nrk-predis 3.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 8,680 kB
  • sloc: php: 71,678; xml: 50; makefile: 12
file content (257 lines) | stat: -rw-r--r-- 8,310 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
<?php

/*
 * This file is part of the Predis package.
 *
 * (c) 2009-2020 Daniele Alessandri
 * (c) 2021-2025 Till Krüss
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Predis\Command\Redis;

use UnexpectedValueException;

class HSETEX_Test extends PredisCommandTestCase
{
    /**
     * {@inheritdoc}
     */
    protected function getExpectedCommand(): string
    {
        return HSETEX::class;
    }

    /**
     * {@inheritdoc}
     */
    protected function getExpectedId(): string
    {
        return 'HSETEX';
    }

    /**
     * @group disconnected
     * @dataProvider argumentsProvider
     */
    public function testFilterArguments(array $actualArguments, array $expectedArguments): void
    {
        $command = $this->getCommand();
        $command->setArguments($actualArguments);

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

    /**
     * @group connected
     * @group slow
     * @dataProvider hashProvider
     * @param  array $arguments
     * @param  int   $expectedResponse
     * @param  float $timeout
     * @return void
     * @requiresRedisVersion >= 7.9.0
     */
    public function testSetHashWithExpiration(
        array $arguments,
        int $expectedResponse,
        float $timeout
    ): void {
        $redis = $this->getClient();

        $this->assertSame($expectedResponse, $redis->hsetex(...$arguments));

        $this->sleep($timeout);

        $this->assertSame([], $redis->hgetall('hash_key'));
    }

    /**
     * @group connected
     * @return void
     * @requiresRedisVersion >= 7.9.0
     */
    public function testSetHashFieldsIfNotExists(): void
    {
        $redis = $this->getClient();

        $this->assertSame(
            1,
            $redis->hsetex('hash_key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_FNX)
        );
        $this->assertSame(
            0,
            $redis->hsetex('hash_key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_FNX)
        );
    }

    /**
     * @group connected
     * @return void
     * @requiresRedisVersion >= 7.9.0
     */
    public function testSetHashFieldsOnlyIfExists(): void
    {
        $redis = $this->getClient();

        $this->assertSame(
            0,
            $redis->hsetex('hash_key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_FXX)
        );
        $this->assertSame(
            1,
            $redis->hsetex('hash_key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_FNX)
        );
        $this->assertSame(
            1,
            $redis->hsetex('hash_key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_FXX)
        );
    }

    /**
     * @group connected
     * @return void
     * @requiresRedisVersion >= 7.9.0
     */
    public function testSetHashFieldRetainingTTLValue(): void
    {
        $redis = $this->getClient();

        $this->assertSame(
            1,
            $redis->hsetex(
                'hash_key',
                ['field1' => 'value1', 'field2' => 'value2'],
                HSETEX::SET_FNX,
                HSETEX::TTL_EX,
                100
            )
        );

        $this->assertGreaterThan(0, $redis->hexpiretime('hash_key', ['field1'])[0]);

        $this->assertSame(
            1,
            $redis->hsetex(
                'hash_key',
                ['field1' => 'value1'],
                HSETEX::SET_FXX,
                HSETEX::TTL_KEEP_TTL
            )
        );

        $this->assertGreaterThan(0, $redis->hexpiretime('hash_key', ['field1'])[0]);
    }

    /**
     * @group connected
     * @dataProvider unexpectedValuesProvider
     * @param  array  $arguments
     * @param  string $expectedExceptionMessage
     * @return void
     */
    public function testThrowsExceptionOnUnexpectedValueGiven(
        array $arguments,
        string $expectedExceptionMessage
    ): void {
        $redis = $this->getClient();

        $this->expectException(UnexpectedValueException::class);
        $this->expectExceptionMessage($expectedExceptionMessage);

        $redis->hsetex(...$arguments);
    }

    public static function argumentsProvider(): array
    {
        return [
            'with default arguments' => [
                ['key', ['field1' => 'value1', 'field2' => 'value2']],
                ['key', 'FIELDS', 2, 'field1', 'value1', 'field2', 'value2'],
            ],
            'with FNX modifier' => [
                ['key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_FNX],
                ['key', 'FNX', 'FIELDS', 2, 'field1', 'value1', 'field2', 'value2'],
            ],
            'with FXX modifier' => [
                ['key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_FXX],
                ['key', 'FXX', 'FIELDS', 2, 'field1', 'value1', 'field2', 'value2'],
            ],
            'with EX modifier' => [
                ['key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_NULL, HSETEX::TTL_EX, 10],
                ['key', 'EX', 10, 'FIELDS', 2, 'field1', 'value1', 'field2', 'value2'],
            ],
            'with PX modifier' => [
                ['key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_NULL, HSETEX::TTL_PX, 10],
                ['key', 'PX', 10, 'FIELDS', 2, 'field1', 'value1', 'field2', 'value2'],
            ],
            'with EXAT modifier' => [
                ['key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_NULL, HSETEX::TTL_EXAT, 10],
                ['key', 'EXAT', 10, 'FIELDS', 2, 'field1', 'value1', 'field2', 'value2'],
            ],
            'with PXAT modifier' => [
                ['key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_NULL, HSETEX::TTL_PXAT, 10],
                ['key', 'PXAT', 10, 'FIELDS', 2, 'field1', 'value1', 'field2', 'value2'],
            ],
            'with KEEPTTL modifier' => [
                ['key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_NULL, HSETEX::TTL_KEEP_TTL],
                ['key', 'KEEPTTL', 'FIELDS', 2, 'field1', 'value1', 'field2', 'value2'],
            ],
            'with combined modifiers' => [
                ['key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_FXX, HSETEX::TTL_PXAT, 10],
                ['key', 'FXX', 'PXAT', 10, 'FIELDS', 2, 'field1', 'value1', 'field2', 'value2'],
            ],
        ];
    }

    public static function hashProvider(): array
    {
        return [
            'with EX modifier' => [
                ['key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_NULL, HSETEX::TTL_EX, 1],
                1,
                1.2,
            ],
            'with PX modifier' => [
                ['key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_NULL, HSETEX::TTL_PX, 100],
                1,
                0.2,
            ],
            'with EXAT modifier' => [
                ['key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_NULL, HSETEX::TTL_EXAT, time() + 1],
                1,
                2,
            ],
            'with PXAT modifier' => [
                ['key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_NULL, HSETEX::TTL_PXAT, (time() * 1000) + 100],
                1,
                0.3,
            ],
            'with combined modifiers' => [
                ['key', ['field1' => 'value1', 'field2' => 'value2'], HSETEX::SET_FNX, HSETEX::TTL_PX, 100],
                1,
                0.2,
            ],
        ];
    }

    public static function unexpectedValuesProvider(): array
    {
        return [
            'with wrong set modifier' => [
                ['key', ['field1', 'field2'], 'wrong'],
                'Modifier argument accepts only: fnx, fxx values',
            ],
            'with wrong ttl modifier' => [
                ['key', ['field1', 'field2'], '', 'wrong'],
                'Modifier argument accepts only: ex, px, exat, pxat, keepttl values',
            ],
            'with wrong ttl modifier value' => [
                ['key', ['field1', 'field2'], '', HSETEX::TTL_PXAT, 'wrong'],
                'Modifier value is missing or incorrect type',
            ],
        ];
    }
}