Add ability to auth with username + password to sentinel (#25)

* Add support for username + password auth

* Lint

* Refactor auth in PhpRedisSentinelConnector

* Try setting auth only if used

* Remove whitespace

---------

Co-authored-by: Namoshek <[email protected]>

Author: misakstvanu

README.md

@@ -54,6 +54,7 @@ To use the Redis Sentinel driver, the `redis` section in `config/database.php` n
         'sentinel_persistent' => env('REDIS_SENTINEL_PERSISTENT'),
         'sentinel_retry_interval' => env('REDIS_SENTINEL_RETRY_INTERVAL', 0),
         'sentinel_read_timeout' => env('REDIS_SENTINEL_READ_TIMEOUT', 0),
+        'sentinel_username' => env('REDIS_SENTINEL_USERNAME'),
         'sentinel_password' => env('REDIS_SENTINEL_PASSWORD'),
         'password' => env('REDIS_PASSWORD'),
         'database' => env('REDIS_DB', 0),

src/Connectors/PhpRedisSentinelConnector.php

@@ -89,12 +89,20 @@ private function connectToSentinel(array $config): RedisSentinel
         $persistent = $config['sentinel_persistent'] ?? null;
         $retryInterval = $config['sentinel_retry_interval'] ?? 0;
         $readTimeout = $config['sentinel_read_timeout'] ?? 0;
+        $username = $config['sentinel_username'] ?? '';
         $password = $config['sentinel_password'] ?? '';
 
         if (strlen(trim($host)) === 0) {
             throw new ConfigurationException('No host has been specified for the Redis Sentinel connection.');
         }
 
+        $auth = null;
+        if (strlen(trim($username)) !== 0 && strlen(trim($password)) !== 0) {
+            $auth = [$username, $password];
+        } elseif (strlen(trim($password)) !== 0) {
+            $auth = $password;
+        }
+
         if (version_compare(phpversion('redis'), '6.0', '>=')) {
             $options = [
                 'host' => $host,
@@ -105,18 +113,14 @@ private function connectToSentinel(array $config): RedisSentinel
                 'readTimeout' => $readTimeout,
             ];
 
-            if (strlen(trim($password)) !== 0) {
-                $options['auth'] = $password;
+            if ($auth !== null) {
+                $options['auth'] = $auth;
             }
 
             return new RedisSentinel($options);
-        } else {
-            if (strlen(trim($password)) !== 0) {
-                /** @noinspection PhpMethodParametersCountMismatchInspection */
-                return new RedisSentinel($host, $port, $timeout, $persistent, $retryInterval, $readTimeout, $password);
-            }
-
-            return new RedisSentinel($host, $port, $timeout, $persistent, $retryInterval, $readTimeout);
         }
+
+        /** @noinspection PhpMethodParametersCountMismatchInspection */
+        return new RedisSentinel($host, $port, $timeout, $persistent, $retryInterval, $readTimeout, $auth);
     }
 }

tests/TestCase.php

@@ -41,6 +41,7 @@ protected function getEnvironmentSetUp($app)
         $app['config']->set('database.redis.default', [
             'sentinel_host' => env('REDIS_SENTINEL_HOST', '127.0.0.1'),
             'sentinel_port' => (int) env('REDIS_SENTINEL_PORT', 6379),
+            'sentinel_username' => env('REDIS_SENTINEL_USERNAME'),
             'sentinel_password' => env('REDIS_SENTINEL_PASSWORD'),
             'sentinel_service' => env('REDIS_SENTINEL_SERVICE', 'mymaster'),
         ]);