- Fixed nullable img url in solutions

- Added tests for propose solution method - Fixed some minor bugs
scify · Dec 11, 2024 · e438137 · e438137
1 parent 2f5a4fe
commit e438137
Show file tree

Hide file tree

Showing 8 changed files with 126 additions and 54 deletions.
diff --git a/.github/workflows/laravel-tests.yml b/.github/workflows/laravel-tests.yml
@@ -54,11 +54,8 @@ jobs:
       - name: Cache
         run: php artisan config:cache --env=testing
 
-      - name: Run the migrations in the testing environment
-        run: php artisan migrate --env=testing --database=sqlite_testing
-
-      - name: Run the seeders in the testing environment
-        run: php artisan db:seed --env=testing --database=sqlite_testing
+      - name: Run the migrations & seeders in the testing environment
+        run: php artisan migrate:fresh --seed --env=testing
 
       - name: Execute tests (Unit and Feature tests) via PHPUnit
         run: php artisan test --env=testing
diff --git a/README.md b/README.md
@@ -442,16 +442,10 @@ php artisan config:clear
 
 Then, make sure that you have set up the test database:
 
-First you need to run the migrations for the test database:
+Run the migrations & seeders for the test database:
 
 ```bash
-  php artisan migrate --env=testing --database=sqlite_testing
-```
-
-Then run the seeders for the test database:
-
-```bash
-  php artisan db:seed --env=testing --database=sqlite_testing
+  php artisan migrate:fresh --seed --env=testing
 ```
 
 ### PHPUnit with the `php artisan test` command

diff --git a/app/BusinessLogicLayer/Solution/SolutionManager.php b/app/BusinessLogicLayer/Solution/SolutionManager.php
@@ -106,6 +106,8 @@ public function storeSolutionFromPublicForm(array $attributes): int {
     protected function storeSolutionWithStatus(array $attributes, int $status_id): int {
         if (isset($attributes['solution-image']) && $attributes['solution-image']->isValid()) {
             $imgPath = FileHandler::uploadAndGetPath($attributes['solution-image'], 'solution_img');
+        } else {
+            $imgPath = null;
         }
         $solution_owner_problem_id = $attributes['solution-owner-problem'];
 

diff --git a/app/Http/Controllers/Solution/SolutionController.php b/app/Http/Controllers/Solution/SolutionController.php
@@ -47,18 +47,16 @@ public function create(Request $request): View|RedirectResponse {
      * Store a newly created resource in storage.
      */
     public function store(Request $request): RedirectResponse {
-        $this->validate($request, [
+        $validated = $this->validate($request, [
             'solution-title' => ['required', 'string', 'max:100'],
             'solution-description' => ['required', 'string', 'max:400'],
             'solution-status' => ['required'],
             'solution-image' => 'nullable|image|mimes:jpeg,png,jpg,webp|max:2048',
             'solution-owner-problem' => ['required'],
         ]);
 
-        $attributes = $request->validated();
-
         try {
-            $createdSolutionId = $this->solutionManager->storeSolution($attributes);
+            $createdSolutionId = $this->solutionManager->storeSolution($validated);
         } catch (\Exception $e) {
             session()->flash('flash_message_error', 'Error: ' . $e->getCode() . '  ' . $e->getMessage());
 
@@ -73,15 +71,15 @@ public function store(Request $request): RedirectResponse {
     }
 
     public function userProposalStore(Request $request): RedirectResponse {
-        $this->validate($request, [
+        $validated = $this->validate($request, [
             'solution-title' => ['required', 'string', 'max:100'],
             'solution-description' => ['required', 'string', 'max:400'],
             'solution-image' => 'nullable|image|mimes:jpeg,png,jpg,webp|max:2048',
             'solution-owner-problem' => ['required'],
         ]);
 
         try {
-            $createdSolutionId = $this->solutionManager->storeSolutionFromPublicForm($request->validated());
+            $this->solutionManager->storeSolutionFromPublicForm($validated);
         } catch (\Exception $e) {
             session()->flash('flash_message_error', 'Error: ' . $e->getCode() . '  ' . $e->getMessage());
 
@@ -90,7 +88,8 @@ public function userProposalStore(Request $request): RedirectResponse {
 
         session()->flash('flash_message_success', 'Solution Created Successfully.');
 
-        return redirect()->route('public-solution-thanks', ['solution_id' => $createdSolutionId]);
+        // redirect to the same route as the current one, with a "/solution-submitted" suffix
+        return redirect($request->path() . '/solution-submitted');
     }
 
     /**
@@ -120,7 +119,7 @@ public function edit(Request $request, string $locale, int $id) {
      * Update the specified resource in storage.
      */
     public function update(Request $request, string $locale, int $id) {
-        $this->validate($request, [
+        $validated = $this->validate($request, [
             'solution-title' => ['required', 'string', 'max:100'],
             'solution-description' => ['required', 'string', 'max:400'],
             'solution-status' => ['required'],
@@ -129,10 +128,8 @@ public function update(Request $request, string $locale, int $id) {
             'solution-owner-problem' => ['required'],
         ]);
 
-        $attributes = $request->validated();
-
         try {
-            $this->solutionManager->updateSolution($id, $attributes);
+            $this->solutionManager->updateSolution($id, $validated);
         } catch (\Exception $e) {
             session()->flash('flash_message_error', 'Error: ' . $e->getCode() . '  ' . $e->getMessage());
 
@@ -201,33 +198,6 @@ public function userProposalCreate(string $locale, string $project_slug, string
         }
     }
 
-    // public function userProposalStore(Request $request): RedirectResponse {
-    //     return 'user ProposalStore';
-    //     $this->validate($request, [
-    //         'solution-title' => ['required', 'string', 'max:100'],
-    //         'solution-description' => ['required', 'string', 'max:400'],
-    //         'solution-status' => ['required'],
-    //         'solution-image' => 'nullable|image|mimes:jpeg,png,jpg|max:2048',
-    //         'solution-owner-problem' => ['required'],
-    //     ]);
-
-    //     $attributes = $request->all();
-
-    //     try {
-    //         $createdSolutionId = $this->solutionManager->storeSolution($attributes);
-    //     } catch (\Exception $e) {
-    //         session()->flash('flash_message_error', 'Error: ' . $e->getCode() . '  ' . $e->getMessage());
-
-    //         return back()->withInput();
-    //     }
-
-    //     session()->flash('flash_message_success', 'Solution Created Successfully.');
-
-    //     $route = route('solutions.edit', ['solution' => $createdSolutionId]) . '?translations=1';
-
-    //     return redirect($route);
-    // }
-
     public function userProposalSubmitted(Request $request) {
         return 'userProposalSubmitted';
     }

diff --git a/app/Models/Problem/Problem.php b/app/Models/Problem/Problem.php
@@ -2,6 +2,7 @@
 
 namespace App\Models\Problem;
 
+use App\Models\CrowdSourcingProject\CrowdSourcingProject;
 use App\Models\Solution\Solution;
 use Awobaz\Compoships\Compoships;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
@@ -40,6 +41,10 @@ public function solutions(): HasMany {
         return $this->hasMany(Solution::class, 'problem_id', 'id');
     }
 
+    public function project(): HasOne {
+        return $this->hasOne(CrowdSourcingProject::class, 'id', 'project_id');
+    }
+
     //observe this model being deleted and delete the related records
     public static function boot() {
         parent::boot();

diff --git a/database/migrations/2024_12_11_160745_make_img_url_nullable_in_solutions_table.php b/database/migrations/2024_12_11_160745_make_img_url_nullable_in_solutions_table.php
@@ -0,0 +1,25 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    /**
+     * Run the migrations.
+     */
+    public function up(): void {
+        Schema::table('solutions', function (Blueprint $table) {
+            $table->string('img_url')->nullable()->change();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void {
+        Schema::table('solutions', function (Blueprint $table) {
+            //
+        });
+    }
+};
diff --git a/tests/Feature/Controllers/Solution/SolutionControllerTest.php b/tests/Feature/Controllers/Solution/SolutionControllerTest.php
@@ -2,6 +2,13 @@
 
 namespace Feature\Controllers\Solution;
 
+use App\BusinessLogicLayer\lkp\SolutionStatusLkp;
+use App\Http\Middleware\VerifyCsrfToken;
+use App\Models\Problem\Problem;
+use App\Models\Solution\Solution;
+use App\Models\Solution\SolutionTranslation;
+use App\Models\User\User;
+use Faker\Factory as Faker;
 use Tests\TestCase;
 
 class SolutionControllerTest extends TestCase {
@@ -23,4 +30,79 @@ public function test_user_proposal_create_redirects_to_login_page_when_user_is_n
 
         $response->assertRedirectContains(route('login', ['locale' => 'en']));
     }
+
+    /**
+     * @test
+     *
+     * @group solution-controller-test
+     *
+     * Test Scenario 2:
+     * GIVEN that a user is authenticated,
+     *
+     * AND they try to access the solution propose page,
+     * THEN they should be able to access the page.
+     *
+     * @return void
+     */
+    public function test_user_proposal_create_page_is_accessible_when_user_is_authenticated() {
+        $user = User::factory()->create();
+
+        // get the problem with id 1
+        $problem = Problem::findOrfail(1);
+        $route = route('solutions.user-proposal-create', ['locale' => 'en', 'project_slug' => $problem->project->slug, 'problem_slug' => $problem->slug]);
+
+        $response = $this->actingAs($user)->get($route);
+
+        $response->assertOk();
+    }
+
+    /**
+     * @test
+     *
+     * @group solution-controller-test
+     *
+     * Test Scenario 3:
+     * GIVEN that a user is authenticated,
+     *
+     * AND they submit a solution proposal,
+     * AND the data is valid,
+     * THEN the solution should be stored in the database.
+     * AND the solution should be associated with the problem.
+     * AND the solution should have an "UNPUBLISHED" status.
+     *
+     * @return void
+     */
+    public function test_user_proposal_store_stores_solution_in_database_when_data_is_valid() {
+        $user = User::factory()->create();
+
+        // get the problem with id 1
+        $problem = Problem::findOrfail(1);
+        $route = route('solutions.user-proposal-store', ['locale' => 'en', 'project_slug' => $problem->project->slug, 'problem_slug' => $problem->slug]);
+
+        $faker = Faker::create();
+
+        $name = $faker->name;
+        $description = $faker->text;
+
+        $response = $this->actingAs($user)->withoutMiddleware(VerifyCsrfToken::class)
+            ->post($route, [
+                'solution-title' => $name,
+                'solution-description' => $description,
+                'solution-owner-problem' => 1,
+            ]);
+
+        $response->assertRedirectContains(
+            route('solutions.user-proposal-submitted',
+                ['locale' => 'en', 'project_slug' => $problem->project->slug, 'problem_slug' => $problem->slug]
+            )
+        );
+
+        $response->assertStatus(302);
+
+        $solution = SolutionTranslation::where('title', $name)->first()->solution;
+
+        $this->assertNotNull($solution);
+        $this->assertEquals(SolutionStatusLkp::UNPUBLISHED, $solution->status_id);
+        $this->assertEquals($problem->id, $solution->problem_id);
+    }
 }
diff --git a/tests/Unit/Controllers/UserControllerTest.php b/tests/Unit/Controllers/UserControllerTest.php
@@ -9,13 +9,10 @@
 use App\Models\User\User;
 use App\ViewModels\Gamification\GamificationBadgesWithLevels;
 use App\ViewModels\User\UserDashboardViewModel;
-use Illuminate\Foundation\Testing\RefreshDatabase;
 use Illuminate\Support\Facades\Auth;
 use Tests\TestCase;
 
 class UserControllerTest extends TestCase {
-    use RefreshDatabase;
-
     private User $user;
     private UserDashboardManager $userDashboardManager;
     private UserManager $userManager;