Skip to content

Commit 7c2e8e0

Browse files
vladvildanovvladvildanov
authored
Added support for FUNCTION KILL, FUNCTION LIST, FUNCTION STATS commands (#1334)
* Added support for FUNCTION KILL, FUNCTION LIST, FUNCTION STATS commands * Marked tests as relay-incompatible
1 parent 0b6ab4d commit 7c2e8e0

File tree

8 files changed

+354
-2
lines changed

8 files changed

+354
-2
lines changed

‎src/Command/Redis/Container/FunctionContainer.php‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,14 @@
1515
use Predis\Response\Status;
1616

1717
/**
18-
* @method string load(string $functionCode, bool $replace = 'false')
1918
* @method Status delete(string $libraryName)
2019
* @method string dump()
2120
* @method Status flush(?string $mode = null)
22-
* @method Status restore(string $value, ?string $policy = null)
21+
* @method Status kill()
22+
* @method array list(string $libraryNamePattern = null, bool $withCode = false)
23+
* @method string load(string $functionCode, bool $replace = 'false')
24+
* @method Status restore(string $value, string $policy = null)
25+
* @method array stats()
2326
*/
2427
class FunctionContainer extends AbstractContainer
2528
{

‎src/Command/Strategy/ContainerCommands/Functions/KillStrategy.php‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Strategy\ContainerCommands\Functions;
14+
15+
use Predis\Command\Strategy\SubcommandStrategyInterface;
16+
17+
class KillStrategy implements SubcommandStrategyInterface
18+
{
19+
/**
20+
* {@inheritDoc}
21+
*/
22+
public function processArguments(array $arguments): array
23+
{
24+
return $arguments;
25+
}
26+
}

‎src/Command/Strategy/ContainerCommands/Functions/ListStrategy.php‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Strategy\ContainerCommands\Functions;
14+
15+
use Predis\Command\Strategy\SubcommandStrategyInterface;
16+
17+
class ListStrategy implements SubcommandStrategyInterface
18+
{
19+
/**
20+
* {@inheritDoc}
21+
*/
22+
public function processArguments(array $arguments): array
23+
{
24+
$processedArguments = [$arguments[0]];
25+
26+
if (array_key_exists(1, $arguments) && null !== $arguments[1]) {
27+
array_push($processedArguments, 'LIBRARYNAME', $arguments[1]);
28+
}
29+
30+
if (array_key_exists(2, $arguments) && true === $arguments[2]) {
31+
$processedArguments[] = 'WITHCODE';
32+
}
33+
34+
return $processedArguments;
35+
}
36+
}

‎src/Command/Strategy/ContainerCommands/Functions/StatsStrategy.php‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Strategy\ContainerCommands\Functions;
14+
15+
use Predis\Command\Strategy\SubcommandStrategyInterface;
16+
17+
class StatsStrategy implements SubcommandStrategyInterface
18+
{
19+
/**
20+
* {@inheritDoc}
21+
*/
22+
public function processArguments(array $arguments): array
23+
{
24+
return $arguments;
25+
}
26+
}

‎tests/Predis/Command/Redis/FUNCTIONS_Test.php‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,34 @@ public function testDumpFilterArguments(): void
8484
$this->assertSameValues($expected, $command->getArguments());
8585
}
8686

87+
/**
88+
* @group disconnected
89+
*/
90+
public function testKillFilterArguments(): void
91+
{
92+
$arguments = ['KILL'];
93+
$expected = ['KILL'];
94+
95+
$command = $this->getCommand();
96+
$command->setArguments($arguments);
97+
98+
$this->assertSameValues($expected, $command->getArguments());
99+
}
100+
101+
/**
102+
* @group disconnected
103+
*/
104+
public function testStatsFilterArguments(): void
105+
{
106+
$arguments = ['STATS'];
107+
$expected = ['STATS'];
108+
109+
$command = $this->getCommand();
110+
$command->setArguments($arguments);
111+
112+
$this->assertSameValues($expected, $command->getArguments());
113+
}
114+
87115
/**
88116
* @dataProvider flushArgumentsProvider
89117
* @group disconnected
@@ -108,6 +136,18 @@ public function testRestoreFilterArguments(array $actualArguments, array $expect
108136
$this->assertSameValues($expectedResponse, $command->getArguments());
109137
}
110138

139+
/**
140+
* @dataProvider listArgumentsProvider
141+
* @group disconnected
142+
*/
143+
public function testListFilterArguments(array $actualArguments, array $expectedResponse): void
144+
{
145+
$command = $this->getCommand();
146+
$command->setArguments($actualArguments);
147+
148+
$this->assertSameValues($expectedResponse, $command->getArguments());
149+
}
150+
111151
/**
112152
* @group disconnected
113153
*/
@@ -267,6 +307,53 @@ public function testRestoresLibraryFromSerializedPayload(): void
267307
$this->assertEquals('OK', $redis->function->restore($serializedPayload));
268308
}
269309

310+
/**
311+
* @group connected
312+
* @group relay-incompatible
313+
* @return void
314+
* @requiresRedisVersion >= 7.0.0
315+
*/
316+
public function testListReturnsListOfAvailableFunctions(): void
317+
{
318+
$redis = $this->getClient();
319+
$redis->function->flush();
320+
$expectedResponse = [
321+
[
322+
'library_name', 'mylib', 'engine', 'LUA', 'functions',
323+
[
324+
['name', 'myfunc', 'description', null, 'flags', []],
325+
],
326+
],
327+
];
328+
329+
$libName = $redis->function->load(
330+
"#!lua name={$this->libName} \n redis.register_function('myfunc', function(keys, args) return args[1] end)"
331+
);
332+
333+
$this->assertEquals($this->libName, $libName);
334+
$this->assertSame($expectedResponse, $redis->function->list());
335+
}
336+
337+
/**
338+
* @group connected
339+
* @group relay-incompatible
340+
* @return void
341+
* @requiresRedisVersion >= 7.0.0
342+
*/
343+
public function testStatsReturnsInformationAboutRunningScript(): void
344+
{
345+
$redis = $this->getClient();
346+
$redis->function->flush();
347+
$expectedResponse = ['running_script', null, 'engines', ['LUA', ['libraries_count', 1, 'functions_count', 1]]];
348+
349+
$libName = $redis->function->load(
350+
"#!lua name={$this->libName} \n redis.register_function('myfunc', function(keys, args) return args[1] end)"
351+
);
352+
353+
$this->assertEquals($this->libName, $libName);
354+
$this->assertSame($expectedResponse, $redis->function->stats());
355+
}
356+
270357
/**
271358
* @group connected
272359
* @return void
@@ -283,6 +370,22 @@ public function testDeleteFunctionThrowsErrorOnNonExistingLibrary(): void
283370
$redis->function->delete($this->libName);
284371
}
285372

373+
/**
374+
* @group connected
375+
* @return void
376+
* @requiresRedisVersion >= 7.0.0
377+
*/
378+
public function testKillThrowsExceptionOnNonExistingRunningScript(): void
379+
{
380+
$redis = $this->getClient();
381+
$redis->function->flush();
382+
383+
$this->expectException(ServerException::class);
384+
$this->expectExceptionMessage('NOTBUSY No scripts in execution right now.');
385+
386+
$redis->function->kill();
387+
}
388+
286389
public function flushArgumentsProvider(): array
287390
{
288391
return [
@@ -310,4 +413,26 @@ public function restoreArgumentsProvider(): array
310413
],
311414
];
312415
}
416+
417+
public function listArgumentsProvider(): array
418+
{
419+
return [
420+
'with default arguments' => [
421+
['LIST', null, false],
422+
['LIST'],
423+
],
424+
'with LIBRARYNAME modifier' => [
425+
['LIST', 'libraryname', false],
426+
['LIST', 'LIBRARYNAME', 'libraryname'],
427+
],
428+
'with WITHCODE modifier' => [
429+
['LIST', null, true],
430+
['LIST', 'WITHCODE'],
431+
],
432+
'with all arguments' => [
433+
['LIST', 'libraryname', true],
434+
['LIST', 'LIBRARYNAME', 'libraryname', 'WITHCODE'],
435+
],
436+
];
437+
}
313438
}

‎tests/Predis/Command/Strategy/ContainerCommands/Functions/KillStrategyTest.php‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Strategy\ContainerCommands\Functions;
14+
15+
use PredisTestCase;
16+
17+
class KillStrategyTest extends PredisTestCase
18+
{
19+
/**
20+
* @var KillStrategy
21+
*/
22+
private $strategy;
23+
24+
protected function setUp(): void
25+
{
26+
$this->strategy = new KillStrategy();
27+
}
28+
29+
/**
30+
* @group disconnected
31+
* @return void
32+
*/
33+
public function testProcessArguments(): void
34+
{
35+
$this->assertSame(['arg1', 'arg2'], $this->strategy->processArguments(['arg1', 'arg2']));
36+
}
37+
}

‎tests/Predis/Command/Strategy/ContainerCommands/Functions/ListStrategyTest.php‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Strategy\ContainerCommands\Functions;
14+
15+
use PredisTestCase;
16+
17+
class ListStrategyTest extends PredisTestCase
18+
{
19+
/**
20+
* @var ListStrategy
21+
*/
22+
private $strategy;
23+
24+
protected function setUp(): void
25+
{
26+
$this->strategy = new ListStrategy();
27+
}
28+
29+
/**
30+
* @dataProvider argumentsProvider
31+
* @group disconnected
32+
* @param array $actualArguments
33+
* @param array $expectedResponse
34+
* @return void
35+
*/
36+
public function testProcessArguments(array $actualArguments, array $expectedResponse): void
37+
{
38+
$this->assertSame($expectedResponse, $this->strategy->processArguments($actualArguments));
39+
}
40+
41+
public function argumentsProvider(): array
42+
{
43+
return [
44+
'with default arguments' => [
45+
['LIST', null, false],
46+
['LIST'],
47+
],
48+
'with LIBRARYNAME modifier' => [
49+
['LIST', 'libraryname', false],
50+
['LIST', 'LIBRARYNAME', 'libraryname'],
51+
],
52+
'with WITHCODE modifier' => [
53+
['LIST', null, true],
54+
['LIST', 'WITHCODE'],
55+
],
56+
'with all arguments' => [
57+
['LIST', 'libraryname', true],
58+
['LIST', 'LIBRARYNAME', 'libraryname', 'WITHCODE'],
59+
],
60+
];
61+
}
62+
}

0 commit comments

Comments
 (0)