test(lock): add lock support to mock cache

- add an in-memory mock lock store for test environments
- make MockCache provide the lock store contract used by LockManager
- keep service('locks') usable under CIUnitTestCase's mocked cache

Signed-off-by: memleakd <121398829+memleakd@users.noreply.github.com>

Author: memleakd

system/Test/Mock/MockCache.php

@@ -16,10 +16,12 @@
 use Closure;
 use CodeIgniter\Cache\CacheInterface;
 use CodeIgniter\Cache\Handlers\BaseHandler;
+use CodeIgniter\Cache\LockStoreInterface;
+use CodeIgniter\Cache\LockStoreProvider;
 use CodeIgniter\I18n\Time;
 use PHPUnit\Framework\Assert;
 
-class MockCache extends BaseHandler implements CacheInterface
+class MockCache extends BaseHandler implements CacheInterface, LockStoreProvider
 {
     /**
      * Mock cache storage.
@@ -42,6 +44,8 @@ class MockCache extends BaseHandler implements CacheInterface
      */
     protected $bypass = false;
 
+    private ?MockLockStore $lockStore = null;
+
     /**
      * Takes care of any handler-specific setup that must be done.
      */
@@ -180,6 +184,7 @@ public function clean(): true
     {
         $this->cache       = [];
         $this->expirations = [];
+        $this->lockStore?->clean();
 
         return true;
     }
@@ -227,6 +232,11 @@ public function isSupported(): bool
         return true;
     }
 
+    public function lockStore(): LockStoreInterface
+    {
+        return $this->lockStore ??= new MockLockStore();
+    }
+
     // --------------------------------------------------------------------
     // Test Helpers
     // --------------------------------------------------------------------

system/Test/Mock/MockLockStore.php

@@ -0,0 +1,88 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Test\Mock;
+
+use CodeIgniter\Cache\LockStoreInterface;
+use CodeIgniter\I18n\Time;
+
+class MockLockStore implements LockStoreInterface
+{
+    /**
+     * @var array<string, array{owner: string, expires: int}>
+     */
+    private array $locks = [];
+
+    public function acquireLock(string $key, string $owner, int $ttl): bool
+    {
+        if ($this->getLockOwner($key) !== null) {
+            return false;
+        }
+
+        $this->locks[$key] = [
+            'owner'   => $owner,
+            'expires' => Time::now()->getTimestamp() + $ttl,
+        ];
+
+        return true;
+    }
+
+    public function releaseLock(string $key, string $owner): bool
+    {
+        if ($this->getLockOwner($key) !== $owner) {
+            return false;
+        }
+
+        unset($this->locks[$key]);
+
+        return true;
+    }
+
+    public function forceReleaseLock(string $key): bool
+    {
+        unset($this->locks[$key]);
+
+        return true;
+    }
+
+    public function refreshLock(string $key, string $owner, int $ttl): bool
+    {
+        if ($this->getLockOwner($key) !== $owner) {
+            return false;
+        }
+
+        $this->locks[$key]['expires'] = Time::now()->getTimestamp() + $ttl;
+
+        return true;
+    }
+
+    public function getLockOwner(string $key): ?string
+    {
+        if (! isset($this->locks[$key])) {
+            return null;
+        }
+
+        if ($this->locks[$key]['expires'] <= Time::now()->getTimestamp()) {
+            unset($this->locks[$key]);
+
+            return null;
+        }
+
+        return $this->locks[$key]['owner'];
+    }
+
+    public function clean(): void
+    {
+        $this->locks = [];
+    }
+}