Merge pull request #4855 in DEV/moodle from feature/INT-16334_excitable-donkey to master

* commit '5239ce6517b10492bb4a1bf9f2ed1ac2e32da423':
  INT-16334: Make methods signature compatible with PHPUnit 8.5 in Moodle 3.10
  INT-16334: feat: add port & auth to redis connection

Author: Mr Bot

README.md

@@ -9,7 +9,13 @@ Provides a Moodle lock factory class for locking with Redis. This plugin was con
 * PHP Redis extension
 
 ## Installation
-Clone the repository or download and extract the code into the local directory of your Moodle install (e.g. $CFG->wwwroot/local/redislock) and run the site's upgrade script. Set $CFG->local_redislock_redis_server with your Redis server's connection string. Set $CFG->lock_factory to '\\\\local_redislock\\\\lock\\\\redis_lock_factory' in your config file.
+Clone the repository or download and extract the code into the local directory of your Moodle install (e.g. $CFG->wwwroot/local/redislock) and run the site's upgrade script.
+Set:
+* `$CFG->local_redislock_redis_server` with your Redis server's connection string.
+  - It can be the `hostname` or IP address of the Redis server.
+  - It can also be `hostname:port` if you want to use other port different than `6379` (Default)
+* `$CFG->lock_factory` to `'\\local_redislock\\lock\\redis_lock_factory'` in your config file.
+* `$CFG->local_redislock_auth` with your Redis server's password string.
 
 ## Flags
 

classes/lock/redis_lock_factory.php

@@ -76,6 +76,11 @@ class redis_lock_factory implements lock_factory {
      */
     private static $conncount = 0;
 
+    /**
+     * @var string|null Redis password.
+     */
+    private $auth;
+
     /**
      * @param string $type The type this lock is used for (e.g. cron, cache).
      * @param \Redis|null $redis An instance of the PHPRedis extension class.
@@ -88,6 +93,7 @@ public function __construct($type, \Redis $redis = null, $logging = null) {
         $this->type = $type;
         $this->redisserver = $CFG->local_redislock_redis_server ?? null;
         $this->shareconnection = empty($CFG->local_redislock_disable_shared_connection);
+        $this->auth = $CFG->local_redislock_redis_auth ?? null;
         if (is_null($redis)) {
             shared_redis_connection::get_instance()->add_factory();
             $redis = $this->bootstrap_redis();
@@ -357,8 +363,19 @@ protected function bootstrap_redis() {
         }
 
         try {
+            // Default port.
+            $port = 6379;
+            $server = $this->redisserver;
+            if (strpos($this->redisserver, ':')) {
+                $serverconf = explode(':', $this->redisserver);
+                $server = $serverconf[0];
+                $port = $serverconf[1];
+            }
             $redis = new \Redis();
-            $redis->connect($this->redisserver);
+            $redis->connect($server, $port);
+            if (!empty($this->auth)) {
+                $redis->auth($this->auth);
+            }
             if ($this->shareconnection) {
                 shared_redis_connection::get_instance()->set_redis($redis); // Reusing the connection.
             } else {

tests/redis_lock_factory_test.php

@@ -39,7 +39,7 @@
 
 class local_redislock_redis_lock_factory_test extends \advanced_testcase {
 
-    public function setUp() {
+    public function setUp(): void {
         global $CFG;
 
         $this->resetAfterTest();
@@ -52,7 +52,7 @@ public function setUp() {
     /**
      * @throws coding_exception
      */
-    protected function tearDown() {
+    protected function tearDown(): void {
         shared_redis_connection::get_instance()->close();
         while (!empty(shared_redis_connection::get_instance()->get_factory_count())) {
             shared_redis_connection::get_instance()->remove_factory();