Skip to content

Commit df14e11

Browse files
vladvildanovchayim
vladvildanov
and
chayim
authored
Added support for tests running against redis cluster (#1236)
* Added support for tests running against redis cluster * Test coverage * Added comment about master nodes * Codestyle fix * Revert changes * Revert DBNUM * Added cluster endpoints to relay tests env configuration * Exclude cluster tests from relay tests environment * Removed TODO comment * Changed cluster image version to unstable * Updated configuration to match unstable cluster * Fixed path * Updated cluster CI configuration * Removed redundant flag * Removed backslash * Updated file path * Updated file path variable * Added docker cluster initialization as additional step * Run cluster tests as separate workflow * Codestyle fixes * Updated exported files * Added additional timeout so cluster image could be settled * Added support for different cluster image, use docker compose for cluster tests CI * Remove unused flag * Removed variable from volume path * Added sleep timeout to allow docker setup after running * Added timeout before tests run * Updated linter settings * Include indent changes for.sh files * Added missing coverage * Revert expected files and mark docker folder as exclusion * Specify folder itself as excluded * Moved cluster tests as separate job in tests.yml * Updated name to contain cluster word --------- Co-authored-by: Chayim <[email protected]>
1 parent 7c2e8e0 commit df14e11

16 files changed

+251
-4
lines changed

‎.codespellrc

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ skip=./.git
33
check-hidden=
44
check-filenames=
55
builtin=clear,rare,informal,usage,code,names
6-
ignore-words-list=master,masters,slave,slaves,whitelist,cas,exat,smove,SUGGET,sugget
6+
ignore-words-list=master,masters,slave,slaves,whitelist,cas,exat,smove,SUGGET,sugget,ro

‎.editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ block_comment_end = */
1414
[*.php]
1515
max_line_length = 150
1616

17-
[*.{md,yml,yaml,neon}]
17+
[*.{md,yml,yaml,neon,sh}]
1818
indent_size = 2
1919

2020
[tests/**.php]

‎.github/workflows/linters.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ jobs:
136136
EXPECTED="LICENSE,README.md,autoload.php,composer.json"
137137
CURRENT="$(
138138
git archive HEAD \
139-
| tar --list --exclude="src" --exclude="src/*" --exclude="bin" --exclude="bin/*" \
139+
| tar --list --exclude="src" --exclude="src/*" --exclude="bin" --exclude="bin/*" --exclude="docker" --exclude="docker/*" \
140140
| paste --serial --delimiters=","
141141
)"
142142
echo "CURRENT =${CURRENT}"

‎.github/workflows/tests.yml

+43
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,46 @@ jobs:
7878
run: |
7979
wget "https://github.com/php-coveralls/php-coveralls/releases/download/v2.5.3/php-coveralls.phar"
8080
php ./php-coveralls.phar -v
81+
82+
predis-cluster:
83+
84+
name: PHP ${{ matrix.php }} (Redis Cluster latest)
85+
runs-on: ubuntu-latest
86+
87+
strategy:
88+
fail-fast: false
89+
matrix:
90+
php:
91+
- '7.2'
92+
- '7.3'
93+
- '7.4'
94+
- '8.0'
95+
- '8.1'
96+
- '8.2'
97+
98+
steps:
99+
- name: Checkout repository
100+
uses: actions/checkout@v3
101+
102+
- name: Run redis cluster
103+
uses: isbang/[email protected]
104+
with:
105+
compose-file: "./docker/unstable_cluster/docker-compose.yml"
106+
107+
- name: Setup PHP with Composer and extensions
108+
uses: shivammathur/setup-php@v2
109+
with:
110+
php-version: ${{ matrix.php }}
111+
extensions: relay
112+
coverage: ${{ (matrix.php == '8.1') && 'xdebug' || 'none' }}
113+
114+
- name: Install Composer dependencies
115+
uses: ramsey/composer-install@v2
116+
with:
117+
dependency-versions: highest
118+
composer-options: ${{ matrix.php == '8.0' && '--ignore-platform-reqs' || '' }}
119+
120+
- name: Run tests against cluster
121+
run: |
122+
sleep 5 # Timeout to make sure that docker image is setup
123+
vendor/bin/phpunit --group cluster

‎docker/unstable_cluster/Dockerfile

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
FROM redis/redis-stack-server:latest as rss
2+
3+
COPY create_cluster.sh /create_cluster.sh
4+
RUN ls -R /opt/redis-stack
5+
RUN chmod a+x /create_cluster.sh
6+
7+
ENTRYPOINT [ "/create_cluster.sh"]

‎docker/unstable_cluster/create_cluster.sh

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
#! /bin/bash
2+
3+
mkdir -p /nodes
4+
touch /nodes/nodemap
5+
if [ -z ${START_PORT} ]; then
6+
START_PORT=6372
7+
fi
8+
if [ -z ${END_PORT} ]; then
9+
END_PORT=6377
10+
fi
11+
if [ ! -z "$3" ]; then
12+
START_PORT=$2
13+
START_PORT=$3
14+
fi
15+
echo "STARTING: ${START_PORT}"
16+
echo "ENDING: ${END_PORT}"
17+
18+
for PORT in `seq ${START_PORT} ${END_PORT}`; do
19+
mkdir -p /nodes/$PORT
20+
if [[ -e /redis.conf ]]; then
21+
cp /redis.conf /nodes/$PORT/redis.conf
22+
else
23+
touch /nodes/$PORT/redis.conf
24+
fi
25+
cat << EOF >> /nodes/$PORT/redis.conf
26+
port ${PORT}
27+
cluster-enabled yes
28+
daemonize yes
29+
logfile /redis.log
30+
dir /nodes/$PORT
31+
EOF
32+
33+
set -x
34+
/opt/redis-stack/bin/redis-server /nodes/$PORT/redis.conf
35+
sleep 1
36+
if [ $? -ne 0 ]; then
37+
echo "Redis failed to start, exiting."
38+
continue
39+
fi
40+
echo 127.0.0.1:$PORT >> /nodes/nodemap
41+
done
42+
if [ -z "${REDIS_PASSWORD}" ]; then
43+
echo yes | /opt/redis-stack/bin/redis-cli --cluster create `seq -f 127.0.0.1:%g ${START_PORT} ${END_PORT}` --cluster-replicas 1
44+
else
45+
echo yes | opt/redis-stack/bin/redis-cli -a ${REDIS_PASSWORD} --cluster create `seq -f 127.0.0.1:%g ${START_PORT} ${END_PORT}` --cluster-replicas 1
46+
fi
47+
tail -f /redis.log

‎docker/unstable_cluster/docker-compose.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
version: "3.9"
2+
services:
3+
cluster:
4+
container_name: redis-cluster
5+
build:
6+
context: .
7+
dockerfile: Dockerfile
8+
ports:
9+
- "6372:6372"
10+
- "6373:6373"
11+
- "6374:6374"
12+
- "6375:6375"
13+
- "6376:6376"
14+
- "6377:6378"
15+
volumes:
16+
- "./redis.conf:/redis.conf:ro"
17+

‎docker/unstable_cluster/redis.conf

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Redis Cluster config file will be shared across all nodes.
2+
# Do not change the following configurations that are already set:
3+
# port, cluster-enabled, daemonize, logfile, dir
4+
protected-mode no
5+
loadmodule /opt/redis-stack/lib/redisearch.so
6+
loadmodule /opt/redis-stack/lib/redisgraph.so
7+
loadmodule /opt/redis-stack/lib/redistimeseries.so
8+
loadmodule /opt/redis-stack/lib/rejson.so
9+
loadmodule /opt/redis-stack/lib/redisbloom.so

‎phpunit.relay.xml

+5
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
<group>realm-stack</group>
2525
<group>ext-curl</group>
2626
<group>ext-phpiredis</group>
27+
<group>cluster</group>
2728
</exclude>
2829
</groups>
2930

@@ -38,5 +39,9 @@
3839
<const name="REDIS_SERVER_PORT" value="6379" />
3940
<const name="REDIS_SERVER_DBNUM" value="0" />
4041
<env name="USE_RELAY" value="true" />
42+
43+
<!-- Redis Cluster -->
44+
<!-- Only master nodes endpoints included -->
45+
<const name="REDIS_CLUSTER_ENDPOINTS" value="127.0.0.1:6372,127.0.0.1:6373,127.0.0.1:6374" />
4146
</php>
4247
</phpunit>

‎phpunit.xml.dist

+5
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
<group>ext-relay</group>
3434
<group>ext-curl</group>
3535
<group>ext-phpiredis</group>
36+
<group>cluster</group>
3637
<!-- <group>connected</group> -->
3738
<!-- <group>disconnected</group> -->
3839
<!-- <group>commands</group> -->
@@ -51,5 +52,9 @@
5152
<const name="REDIS_SERVER_PORT" value="6379" />
5253
<const name="REDIS_SERVER_DBNUM" value="0" />
5354
<env name="USE_RELAY" value="false" />
55+
56+
<!-- Redis Cluster -->
57+
<!-- Only master nodes endpoints included -->
58+
<const name="REDIS_CLUSTER_ENDPOINTS" value="127.0.0.1:6372,127.0.0.1:6373,127.0.0.1:6374" />
5459
</php>
5560
</phpunit>

‎src/Cluster/ClusterStrategy.php

+14
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ protected function getDefaultCommands()
5353
'SORT' => [$this, 'getKeyFromSortCommand'],
5454
'DUMP' => $getKeyFromFirstArgument,
5555
'RESTORE' => $getKeyFromFirstArgument,
56+
'FLUSHDB' => [$this, 'getFakeKey'],
5657

5758
/* commands operating on string values */
5859
'APPEND' => $getKeyFromFirstArgument,
@@ -163,6 +164,9 @@ protected function getDefaultCommands()
163164
'EVAL' => [$this, 'getKeyFromScriptingCommands'],
164165
'EVALSHA' => [$this, 'getKeyFromScriptingCommands'],
165166

167+
/* server */
168+
'INFO' => [$this, 'getFakeKey'],
169+
166170
/* commands performing geospatial operations */
167171
'GEOADD' => $getKeyFromFirstArgument,
168172
'GEOHASH' => $getKeyFromFirstArgument,
@@ -216,6 +220,16 @@ public function setCommandHandler($commandID, $callback = null)
216220
$this->commands[$commandID] = $callback;
217221
}
218222

223+
/**
224+
* Get fake key for commands with no key argument.
225+
*
226+
* @return string
227+
*/
228+
protected function getFakeKey(): string
229+
{
230+
return 'key';
231+
}
232+
219233
/**
220234
* Extracts the key from the first argument of a command instance.
221235
*

‎tests/PHPUnit/PredisCommandTestCase.php

+5-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,11 @@ public function getClient(bool $flushdb = true): Client
6161
);
6262
}
6363

64-
$client = $this->createClient(null, null, $flushdb);
64+
if ($this->isClusterTest()) {
65+
$client = $this->createClient(null, ['cluster' => 'redis'], $flushdb);
66+
} else {
67+
$client = $this->createClient(null, null, $flushdb);
68+
}
6569

6670
return $client;
6771
}

‎tests/PHPUnit/PredisTestCase.php

+45
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,10 @@ public static function assertMatchesRegularExpression(string $pattern, string $s
153153
*/
154154
protected function getDefaultParametersArray(): array
155155
{
156+
if ($this->isClusterTest()) {
157+
return $this->prepareClusterEndpoints();
158+
}
159+
156160
return [
157161
'scheme' => 'tcp',
158162
'host' => constant('REDIS_SERVER_HOST'),
@@ -237,6 +241,15 @@ protected function createClient(array $parameters = null, array $options = null,
237241
getenv('USE_RELAY') ? ['connections' => 'relay'] : []
238242
);
239243

244+
if ($this->isClusterTest()) {
245+
$options = array_merge(
246+
[
247+
'cluster' => 'redis',
248+
],
249+
$options
250+
);
251+
}
252+
240253
$client = new Client($parameters, $options);
241254
$client->connect();
242255

@@ -537,4 +550,36 @@ protected function markTestSkippedOnCIEnvironment(string $message = 'Test skippe
537550
$this->markTestSkipped($message);
538551
}
539552
}
553+
554+
/**
555+
* Check annotations if it's matches to cluster test scenario.
556+
*
557+
* @return bool
558+
*/
559+
protected function isClusterTest(): bool
560+
{
561+
$annotations = TestUtil::parseTestMethodAnnotations(
562+
get_class($this),
563+
$this->getName(false)
564+
);
565+
566+
return isset($annotations['method']['requiresRedisVersion'], $annotations['method']['group'])
567+
&& !empty($annotations['method']['requiresRedisVersion'])
568+
&& in_array('connected', $annotations['method']['group'], true)
569+
&& in_array('cluster', $annotations['method']['group'], true);
570+
}
571+
572+
/**
573+
* Parse comma-separated cluster endpoints and convert them into tcp strings.
574+
*
575+
* @return array
576+
*/
577+
protected function prepareClusterEndpoints(): array
578+
{
579+
$endpoints = explode(',', constant('REDIS_CLUSTER_ENDPOINTS'));
580+
581+
return array_map(static function (string $elem) {
582+
return 'tcp://' . $elem;
583+
}, $endpoints);
584+
}
540585
}

‎tests/Predis/Cluster/PredisStrategyTest.php

+19
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,21 @@ public function testInterleavedKeysCommands(): void
106106
}
107107
}
108108

109+
/**
110+
* @group disconnected
111+
*/
112+
public function testFakeKeyCommandsWithOneKey(): void
113+
{
114+
$strategy = $this->getClusterStrategy();
115+
$commands = $this->getCommandFactory();
116+
$arguments = [];
117+
118+
foreach ($this->getExpectedCommands('keys-fake') as $commandID) {
119+
$command = $commands->create($commandID, $arguments);
120+
$this->assertNotNull($strategy->getSlot($command), $commandID);
121+
}
122+
}
123+
109124
/**
110125
* @group disconnected
111126
*/
@@ -327,6 +342,7 @@ protected function getExpectedCommands(string $type = null): array
327342
'SORT' => 'variable',
328343
'DUMP' => 'keys-first',
329344
'RESTORE' => 'keys-first',
345+
'FLUSHDB' => 'keys-fake',
330346

331347
/* commands operating on string values */
332348
'APPEND' => 'keys-first',
@@ -437,6 +453,9 @@ protected function getExpectedCommands(string $type = null): array
437453
'EVAL' => 'keys-script',
438454
'EVALSHA' => 'keys-script',
439455

456+
/* server */
457+
'INFO' => 'keys-fake',
458+
440459
/* commands performing geospatial operations */
441460
'GEOADD' => 'keys-first',
442461
'GEOHASH' => 'keys-first',

‎tests/Predis/Cluster/RedisStrategyTest.php

+19
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,21 @@ public function testInterleavedKeysCommandsWithMoreKeys(): void
134134
}
135135
}
136136

137+
/**
138+
* @group disconnected
139+
*/
140+
public function testFakeKeyCommandsWithOneKey(): void
141+
{
142+
$strategy = $this->getClusterStrategy();
143+
$commands = $this->getCommandFactory();
144+
$arguments = [];
145+
146+
foreach ($this->getExpectedCommands('keys-fake') as $commandID) {
147+
$command = $commands->create($commandID, $arguments);
148+
$this->assertNotNull($strategy->getSlot($command), $commandID);
149+
}
150+
}
151+
137152
/**
138153
* @group disconnected
139154
*/
@@ -350,6 +365,7 @@ protected function getExpectedCommands(string $type = null): array
350365
'SORT' => 'keys-first', // TODO
351366
'DUMP' => 'keys-first',
352367
'RESTORE' => 'keys-first',
368+
'FLUSHDB' => 'keys-fake',
353369

354370
/* commands operating on string values */
355371
'APPEND' => 'keys-first',
@@ -460,6 +476,9 @@ protected function getExpectedCommands(string $type = null): array
460476
'EVAL' => 'keys-script',
461477
'EVALSHA' => 'keys-script',
462478

479+
/* server */
480+
'INFO' => 'keys-fake',
481+
463482
/* commands performing geospatial operations */
464483
'GEOADD' => 'keys-first',
465484
'GEOHASH' => 'keys-first',

0 commit comments

Comments
 (0)