test: add file driver tests for forgetKey with correct mock expectations

Author: abr4xas

tests/Unit/CacheUiLaravelFileDriverTest.php

@@ -0,0 +1,136 @@
+<?php
+
+declare(strict_types=1);
+
+use Abr4xas\CacheUiLaravel\CacheUiLaravel;
+use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\File;
+
+describe('CacheUiLaravel File Driver Tests', function (): void {
+    beforeEach(function (): void {
+        $this->cacheUiLaravel = new CacheUiLaravel();
+    });
+
+    describe('forgetKey with file driver', function (): void {
+        it('successfully deletes a key from file cache by key content', function (): void {
+            Config::set('cache.default', 'file');
+            Config::set('cache.stores.file.driver', 'key-aware-file');
+            Config::set('cache.stores.file.path', storage_path('framework/cache/data'));
+
+            $cachePath = storage_path('framework/cache/data');
+            $testKey = 'test-cache-key';
+            $mockFile = Mockery::mock();
+            $mockFile->shouldReceive('getPathname')->andReturn($cachePath.'/test-file');
+
+            // Mock File::exists for deleteFileKeyByKey (checking cache directory)
+            File::shouldReceive('exists')->with($cachePath)->once()->andReturn(true);
+            // Mock File::allFiles to return a file
+            File::shouldReceive('allFiles')->with($cachePath)->once()->andReturn([$mockFile]);
+            // Mock File::get to return wrapped data with the key
+            $wrappedData = serialize(['key' => $testKey, 'value' => 'test-value']);
+            $expiration = time() + 3600;
+            File::shouldReceive('get')->with($cachePath.'/test-file')->once()->andReturn($expiration.$wrappedData);
+            // Mock File::delete to return true
+            File::shouldReceive('delete')->with($cachePath.'/test-file')->once()->andReturn(true);
+
+            // Mock Cache facade for store validation
+            $mockStore = Mockery::mock();
+            $mockStore->shouldReceive('forget')->with($testKey)->andReturn(false);
+            Cache::shouldReceive('store')->with('file')->andReturn($mockStore);
+
+            $result = $this->cacheUiLaravel->forgetKey($testKey, 'file');
+            expect($result)->toBeTrue();
+        });
+
+        it('successfully deletes a key from file cache by filename when key search fails', function (): void {
+            Config::set('cache.default', 'file');
+            Config::set('cache.stores.file.driver', 'key-aware-file');
+            Config::set('cache.stores.file.path', storage_path('framework/cache/data'));
+
+            $cachePath = storage_path('framework/cache/data');
+            $testKey = 'legacy-filename-key';
+            $mockFile = Mockery::mock();
+            $mockFile->shouldReceive('getPathname')->andReturn($cachePath.'/test-file');
+
+            // First call: deleteFileKeyByKey - check directory exists
+            File::shouldReceive('exists')->with($cachePath)->once()->andReturn(true);
+            // Mock File::allFiles to return a file
+            File::shouldReceive('allFiles')->with($cachePath)->once()->andReturn([$mockFile]);
+            // Mock File::get to return data without matching key
+            $wrappedData = serialize(['key' => 'other-key', 'value' => 'test-value']);
+            $expiration = time() + 3600;
+            File::shouldReceive('get')->with($cachePath.'/test-file')->once()->andReturn($expiration.$wrappedData);
+
+            // Second call: deleteFileKeyByFilename - check file exists
+            $filePath = $cachePath.'/'.$testKey;
+            File::shouldReceive('exists')->with($filePath)->once()->andReturn(true);
+            // Mock File::delete to return true
+            File::shouldReceive('delete')->with($filePath)->once()->andReturn(true);
+
+            // Mock Cache facade for store validation
+            $mockStore = Mockery::mock();
+            $mockStore->shouldReceive('forget')->with($testKey)->andReturn(false);
+            Cache::shouldReceive('store')->with('file')->andReturn($mockStore);
+
+            $result = $this->cacheUiLaravel->forgetKey($testKey, 'file');
+            expect($result)->toBeTrue();
+        });
+
+        it('returns false when file cache directory does not exist', function (): void {
+            Config::set('cache.default', 'file');
+            Config::set('cache.stores.file.driver', 'key-aware-file');
+            Config::set('cache.stores.file.path', storage_path('framework/cache/data'));
+
+            $cachePath = storage_path('framework/cache/data');
+            $testKey = 'test-key';
+
+            // Mock File::exists to return false (directory doesn't exist)
+            File::shouldReceive('exists')->with($cachePath)->once()->andReturn(false);
+
+            // Mock Cache facade for store validation
+            $mockStore = Mockery::mock();
+            $mockStore->shouldReceive('forget')->with($testKey)->andReturn(false);
+            Cache::shouldReceive('store')->with('file')->andReturn($mockStore);
+
+            $result = $this->cacheUiLaravel->forgetKey($testKey, 'file');
+            expect($result)->toBeFalse();
+        });
+
+        it('returns false when key is not found in file cache', function (): void {
+            Config::set('cache.default', 'file');
+            Config::set('cache.stores.file.driver', 'key-aware-file');
+            Config::set('cache.stores.file.path', storage_path('framework/cache/data'));
+
+            $cachePath = storage_path('framework/cache/data');
+            $testKey = 'non-existent-key';
+            $mockFile = Mockery::mock();
+            $mockFile->shouldReceive('getPathname')->andReturn($cachePath.'/test-file');
+
+            // First call: deleteFileKeyByKey - check directory exists
+            File::shouldReceive('exists')->with($cachePath)->once()->andReturn(true);
+            // Mock File::allFiles to return a file
+            File::shouldReceive('allFiles')->with($cachePath)->once()->andReturn([$mockFile]);
+            // Mock File::get to return data without matching key
+            $wrappedData = serialize(['key' => 'other-key', 'value' => 'test-value']);
+            $expiration = time() + 3600;
+            File::shouldReceive('get')->with($cachePath.'/test-file')->once()->andReturn($expiration.$wrappedData);
+
+            // Second call: deleteFileKeyByFilename - check file exists (should return false)
+            $filePath = $cachePath.'/'.$testKey;
+            File::shouldReceive('exists')->with($filePath)->once()->andReturn(false);
+
+            // Mock Cache facade for store validation
+            $mockStore = Mockery::mock();
+            $mockStore->shouldReceive('forget')->with($testKey)->andReturn(false);
+            Cache::shouldReceive('store')->with('file')->andReturn($mockStore);
+
+            $result = $this->cacheUiLaravel->forgetKey($testKey, 'file');
+            expect($result)->toBeFalse();
+        });
+    });
+});
+
+afterEach(function (): void {
+    Mockery::close();
+});