Add tests and support for sentinel user+pw combo

snc · Sep 6, 2024 · 94dff80 · 94dff80
1 parent f576535
commit 94dff80
Show file tree

Hide file tree

Showing 11 changed files with 62 additions and 38 deletions.
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -18,7 +18,7 @@ jobs:
         include:
           - dependency-versions: "lowest"
             php-version: "7.4"
-            php-extensions: "redis-5.3.0"
+            php-extensions: "redis-5.3.2"
           - symfony-require: "5.4.*"
             php-version: "8.2"
             php-extensions: "redis"
@@ -31,13 +31,18 @@ jobs:
 
     steps:
       - name: "Checkout"
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
         with:
           fetch-depth: 2
-      - name: "Install requirements"
-        run: sudo apt-get update && sudo apt-get install --no-install-recommends redis-server ruby-foreman
+      - name: "Install redis server"
+        uses: shogo82148/actions-setup-redis@v1
+        with:
+          redis-version: "7.x"
+          auto-start: 'false'
+      - name: "Install cli for Procfile"
+        run: sudo apt-get update && sudo apt-get install --no-install-recommends ruby-foreman
       - name: "Start background services"
-        run: sudo systemctl stop redis-server && foreman start &
+        run: foreman start &
       - name: "Install PHP"
         uses: "shivammathur/setup-php@v2"
         with:
@@ -47,7 +52,7 @@ jobs:
           tools: "flex"
 
       - name: "Install dependencies with Composer"
-        uses: "ramsey/composer-install@v2"
+        uses: "ramsey/composer-install@v3"
         with:
           dependency-versions: "${{ matrix.dependency-versions }}"
 

diff --git a/.github/workflows/redis-configs/redis-sentinel.conf b/.github/workflows/redis-configs/redis-sentinel.conf
@@ -1,2 +1,4 @@
 sentinel monitor mymaster 127.0.0.1 6379 2
+user default on +@all ~* >sentinelauthdefaultpw
+user sentinelauth on +@all ~* >sentinelauthpw
 appendonly no
diff --git a/Procfile b/Procfile
@@ -1,9 +1,9 @@
-redis: redis-server .github/workflows/redis-configs/redis.conf --port 6379
-redis-acl: redis-server .github/workflows/redis-configs/redis-acl.conf --port 7099
-redis-sentinel: redis-server .github/workflows/redis-configs/redis-sentinel.conf --sentinel
-redis-node1: sh -c 'cd .github/workflows/redis-configs/redis-node1 && redis-server redis.conf --port 7079'
-redis-node2: sh -c 'cd .github/workflows/redis-configs/redis-node2 && redis-server redis.conf --port 7080'
-redis-node3: sh -c 'cd .github/workflows/redis-configs/redis-node3 && redis-server redis.conf --port 7081'
-redis-node4: sh -c 'cd .github/workflows/redis-configs/redis-node4 && redis-server redis.conf --port 7082'
-redis-node5: sh -c 'cd .github/workflows/redis-configs/redis-node5 && redis-server redis.conf --port 7083'
-redis-node6: sh -c 'cd .github/workflows/redis-configs/redis-node6 && redis-server redis.conf --port 7084'
+redis: sh -c 'cp .github/workflows/redis-configs/redis.conf /tmp/ && redis-server /tmp/redis.conf --port 6379'
+redis-acl: sh -c 'cp .github/workflows/redis-configs/redis-acl.conf /tmp/ && redis-server /tmp/redis-acl.conf --port 7099'
+redis-sentinel: sh -c 'cp .github/workflows/redis-configs/redis-sentinel.conf /tmp/ && redis-server /tmp/redis-sentinel.conf --sentinel'
+redis-node1: sh -c 'cp -R .github/workflows/redis-configs/redis-node1 /tmp/ && cd /tmp/redis-node1 && redis-server redis.conf --port 7079'
+redis-node2: sh -c 'cp -R .github/workflows/redis-configs/redis-node2 /tmp/ && cd /tmp/redis-node2 && redis-server redis.conf --port 7080'
+redis-node3: sh -c 'cp -R .github/workflows/redis-configs/redis-node3 /tmp/ && cd /tmp/redis-node3 && redis-server redis.conf --port 7081'
+redis-node4: sh -c 'cp -R .github/workflows/redis-configs/redis-node4 /tmp/ && cd /tmp/redis-node4 && redis-server redis.conf --port 7082'
+redis-node5: sh -c 'cp -R .github/workflows/redis-configs/redis-node5 /tmp/ && cd /tmp/redis-node5 && redis-server redis.conf --port 7083'
+redis-node6: sh -c 'cp -R .github/workflows/redis-configs/redis-node6 /tmp/ && cd /tmp/redis-node6 && redis-server redis.conf --port 7084'
diff --git a/docs/README.md b/docs/README.md
@@ -110,7 +110,7 @@ A setup using `predis`, `phpredis` or `relay` sentinel replication could look li
 snc_redis:
     clients:
         default:
-            type: "predis" # or "phpredis", or "relay"
+            type: "phpredis" # or "predis", or "relay"
             alias: default
             dsn:
                 - redis://localhost:26379
@@ -121,8 +121,8 @@ snc_redis:
                 parameters:
                     database: 1
                     password: pass
-                    sentinel_auth: pass1 # default to null
-
+                    sentinel_username: myuser # default to null
+                    sentinel_password: mypass # default to null
 ```
 
 The `service` is the name of the set of Redis instances.
@@ -133,7 +133,6 @@ If you use a password, it must be in the password parameter and must
 be omitted from the DSNs. Also make sure to use the sentinel port number
 (26379 by default) in the DSNs, and not the default Redis port.
 You can find more information about this on [Configuring Sentinel](https://redis.io/topics/sentinel#configuring-sentinel).
-`sentinel_auth` is used to set a specific password for Sentinel authentication. default is null (No authentication)
 A setup using `RedisCluster` from `phpredis`  could look like this:
 
 ``` yaml

diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -17,7 +17,7 @@
           config.allowUnfree = true;
           config.allowInsecurePredicate = pkg: pkgs.lib.getName pkg == "openssl";
         };
-        php = pkgs.php82.buildEnv {
+        php = pkgs.php83.buildEnv {
           extensions = (
             {
               all,

diff --git a/src/DependencyInjection/Configuration/Configuration.php b/src/DependencyInjection/Configuration/Configuration.php
@@ -155,7 +155,8 @@ private function addClientsSection(ArrayNodeDefinition $rootNode): void
                                             ->scalarNode('database')->defaultNull()->end()
                                             ->scalarNode('username')->defaultNull()->end()
                                             ->scalarNode('password')->defaultNull()->end()
-                                            ->scalarNode('sentinel_auth')->defaultNull()->end()
+                                            ->scalarNode('sentinel_username')->defaultNull()->end()
+                                            ->scalarNode('sentinel_password')->defaultNull()->end()
                                             ->booleanNode('logging')->defaultValue($this->debug)->end()
                                             ->variableNode('ssl_context')->defaultNull()->end()
                                         ->end()

diff --git a/src/Factory/PhpredisClientFactory.php b/src/Factory/PhpredisClientFactory.php
@@ -111,9 +111,9 @@ public function create(string $class, array $dsns, array $options, string $alias
     }
 
     /**
-     * @param class-string                                                                                                    $class
-     * @param list<RedisDsn>                                                                                                  $dsns
-     * @param array{service: ?string, connection_persistent: ?bool, connection_timeout: ?string, read_write_timeout: ?string} $options
+     * @param class-string                                                                                                                                                                             $class
+     * @param list<RedisDsn>                                                                                                                                                                           $dsns
+     * @param array{service: ?string, connection_persistent: ?bool, connection_timeout: ?string, read_write_timeout: ?string, parameters: array{sentinel_username: string, sentinel_password: string}} $options
      *
      * @return Redis|Relay
      */
@@ -125,6 +125,7 @@ private function createClientFromSentinel(string $class, array $dsns, string $al
         $connectionTimeout    = $options['connection_timeout'] ?? 0;
         $connectionPersistent = $options['connection_persistent'] ? $masterName : null;
         $readTimeout          = $options['read_write_timeout'] ?? 0;
+        $parameters           = $options['parameters'];
 
         foreach ($dsns as $dsn) {
             $args = [
@@ -134,7 +135,7 @@ private function createClientFromSentinel(string $class, array $dsns, string $al
                 'persistent' => $connectionPersistent,
                 'retryInterval' => 5,
                 'readTimeout' => $readTimeout,
-                'auth' => $options['parameters']['sentinel_auth'] ?? null,
+                'auth' => [$parameters['sentinel_username'], $parameters['sentinel_password']],
             ];
             try {
                 if ($isRelay || version_compare(phpversion('redis'), '6.0', '<')) {

diff --git a/tests/DependencyInjection/SncRedisExtensionEnvTest.php b/tests/DependencyInjection/SncRedisExtensionEnvTest.php
@@ -53,7 +53,8 @@ public function testPredisDefaultParameterConfig(): void
                     'database' => null,
                     'username' => null,
                     'password' => null,
-                    'sentinel_auth' => null,
+                    'sentinel_username' => null,
+                    'sentinel_password' => null,
                     'logging' => false,
                 ],
                 'commands' => ['foo' => 'Foo\Bar\Baz'],
@@ -133,7 +134,8 @@ public function testPhpredisFullConfig(): void
                     'database' => null,
                     'username' => null,
                     'password' => null,
-                    'sentinel_auth' => null,
+                    'sentinel_username' => null,
+                    'sentinel_password' => null,
                     'logging' => false,
                 ],
                 'connection_async' => false,
@@ -172,7 +174,8 @@ public function testPhpredisWithAclConfig(): void
                     'database' => null,
                     'logging' => false,
                     'ssl_context' => null,
-                    'sentinel_auth' => null,
+                    'sentinel_username' => null,
+                    'sentinel_password' => null,
                 ],
                 'prefix' => null,
                 'read_write_timeout' => null,

diff --git a/tests/Factory/PhpredisClientFactoryTest.php b/tests/Factory/PhpredisClientFactoryTest.php
@@ -107,11 +107,17 @@ public function testCreateMinimalClusterConfig(): void
 
     /**
      * @requires extension relay
-     * @testWith ["RedisSentinel", "Redis"]
-     *           ["Relay\\Sentinel", "Relay\\Relay"]
+     * @testWith ["RedisSentinel", "Redis", null, "sentinelauthdefaultpw"]
+     *           ["RedisSentinel", "Redis", "sentinelauth", "sentinelauthpw"]
+     *           ["Relay\\Sentinel", "Relay\\Relay", null, "sentinelauthdefaultpw"]
+     *           ["Relay\\Sentinel", "Relay\\Relay", "sentinelauth", "sentinelauthpw"]
      */
-    public function testCreateSentinelConfig(string $sentinelClass, string $outputClass): void
-    {
+    public function testCreateSentinelConfig(
+        string $sentinelClass,
+        string $outputClass,
+        ?string $sentinelUser,
+        ?string $sentinelPassword
+    ): void {
         $this->logger->method('debug')->with(...$this->withConsecutive(
             [$this->stringContains('Executing command "CONNECT 127.0.0.1 6379 5 <null>')],
             ['Executing command "AUTH sncredis"'],
@@ -130,6 +136,10 @@ public function testCreateSentinelConfig(string $sentinelClass, string $outputCl
                 'connection_timeout' => 5,
                 'connection_persistent' => false,
                 'service' => 'mymaster',
+                'parameters' => [
+                    'sentinel_username' => $sentinelUser,
+                    'sentinel_password' => $sentinelPassword,
+                ],
             ],
             'phpredissentinel',
             true,

diff --git a/tests/Functional/App/config.yaml b/tests/Functional/App/config.yaml
@@ -55,6 +55,9 @@ snc_redis:
             options:
                 replication: true
                 service: mymaster
+                parameters:
+                    sentinel_username: sentinelauth
+                    sentinel_password: sentinelauthpw
         with_acl:
             type: predis
             alias: with_acl