From 203b60383f133c21b8cef785dcc4f9b070e7c8d8 Mon Sep 17 00:00:00 2001
From: bryanlopezinc <bryanlopez2kul2@yahoo.com>
Date: Wed, 19 Jun 2024 17:21:49 +0100
Subject: [PATCH] Added storage path permissions test for
 SettingsController@getSetupIndex

---
 app/Http/Controllers/SettingsController.php  | 26 ++++++++-------
 tests/Feature/Settings/ShowSetUpPageTest.php | 34 ++++++++++++++++++++
 2 files changed, 49 insertions(+), 11 deletions(-)

diff --git a/app/Http/Controllers/SettingsController.php b/app/Http/Controllers/SettingsController.php
index 26ab2b2a83..c0ffec8df3 100755
--- a/app/Http/Controllers/SettingsController.php
+++ b/app/Http/Controllers/SettingsController.php
@@ -25,6 +25,7 @@ use Illuminate\Support\Facades\Artisan;
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\Crypt;
 use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\File;
 use Illuminate\Support\Facades\Http;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\URL;
@@ -106,17 +107,7 @@ class SettingsController extends Controller
             $start_settings['owner_is_admin'] = false;
         }
 
-        if ((is_writable(storage_path()))
-            && (is_writable(storage_path().'/framework'))
-            && (is_writable(storage_path().'/framework/cache'))
-            && (is_writable(storage_path().'/framework/sessions'))
-            && (is_writable(storage_path().'/framework/views'))
-            && (is_writable(storage_path().'/logs'))
-        ) {
-            $start_settings['writable'] = true;
-        } else {
-            $start_settings['writable'] = false;
-        }
+        $start_settings['writable'] = $this->storagePathIsWritable();
 
         $start_settings['gd'] = extension_loaded('gd');
 
@@ -145,6 +136,19 @@ class SettingsController extends Controller
         }
     }
 
+    /**
+     * Determine if the app storage path is writable.
+     */
+    protected function storagePathIsWritable(): bool
+    {
+        return File::isWritable(storage_path())                  &&
+            File::isWritable(storage_path('framework'))          &&
+            File::isWritable(storage_path('framework/cache'))    &&
+            File::isWritable(storage_path('framework/sessions')) &&
+            File::isWritable(storage_path('framework/views'))    &&
+            File::isWritable(storage_path('logs'));
+    }
+
     /**
      * Save the first admin user from Setup.
      *
diff --git a/tests/Feature/Settings/ShowSetUpPageTest.php b/tests/Feature/Settings/ShowSetUpPageTest.php
index 44c3d5a420..7f40768db7 100644
--- a/tests/Feature/Settings/ShowSetUpPageTest.php
+++ b/tests/Feature/Settings/ShowSetUpPageTest.php
@@ -9,6 +9,7 @@ use Illuminate\Http\Client\Response;
 use Illuminate\Log\Events\MessageLogged;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Event;
+use Illuminate\Support\Facades\File;
 use Illuminate\Support\Facades\Http;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\URL;
@@ -267,4 +268,37 @@ class ShowSetUpPageTest extends TestCase
 
         $this->assertSeeAppUrlMisconfigurationErrorMessage();
     }
+
+    public function testWillSeeDirectoryPermissionErrorWhenStoragePathIsNotWritable(): void
+    {
+        File::shouldReceive('isWritable')->andReturn(false);
+
+        $this->getSetUpPageResponse()->assertOk();
+
+        $this->assertSeeDirectoryPermissionError();
+    }
+
+    protected function assertSeeDirectoryPermissionError(bool $shouldSee = true): void
+    {
+        $storagePath = storage_path();
+
+        $errorMessage = "Uh-oh. Your <code>{$storagePath}</code> directory (or sub-directories within) are not writable by the web-server. Those directories need to be writable by the web server in order for the app to work.";
+        $successMessage = 'Yippee! Your app storage directory seems writable';
+
+        if ($shouldSee) {
+            self::$latestResponse->assertSee($errorMessage, false)->assertDontSee($successMessage, false);
+            return;
+        }
+
+        self::$latestResponse->assertSee($successMessage, false)->assertDontSee($errorMessage,false);
+    }
+
+    public function testWillNotSeeDirectoryPermissionErrorWhenStoragePathIsWritable(): void
+    {
+        File::shouldReceive('isWritable')->andReturn(true);
+
+        $this->getSetUpPageResponse()->assertOk();
+
+        $this->assertSeeDirectoryPermissionError(false);
+    }
 }