Merge pull request #1857 from ddm14159/#1817-dto-check-result

Replace CheckResult with CheckResultData DTO

Author: fey

app/DTO/CheckResultData.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\DTO;
+
+use Spatie\LaravelData\Data;
+
+class CheckResultData extends Data
+{
+    public const int SUCCESS_EXIT_CODE = 0;
+    public const int FAILED_TESTS_EXIT_CODE = 1;
+
+    private const string SUCCESS_STATUS = 'success';
+    private const string TESTS_FAILED_STATUS = 'tests_failed';
+    private const string CHECK_EXECUTION_ERROR_STATUS = 'check_error';
+
+    public function __construct(
+        public int $exitCode,
+        public string $output = '',
+    ) {
+    }
+
+    public function getResultStatus(): string
+    {
+        return match ($this->exitCode) {
+            self::SUCCESS_EXIT_CODE => self::SUCCESS_STATUS,
+            self::FAILED_TESTS_EXIT_CODE => self::TESTS_FAILED_STATUS,
+            default => self::CHECK_EXECUTION_ERROR_STATUS,
+        };
+    }
+
+    public function isSuccess(): bool
+    {
+        return $this->getResultStatus() === self::SUCCESS_STATUS;
+    }
+
+    public function isFailedTests(): bool
+    {
+        return $this->getResultStatus() === self::TESTS_FAILED_STATUS;
+    }
+
+    public function isCheckExecutionError(): bool
+    {
+        return $this->getResultStatus() === self::CHECK_EXECUTION_ERROR_STATUS;
+    }
+}

app/Http/Resources/Api/Exercise/CheckResultResource.php

@@ -2,21 +2,21 @@
 
 namespace App\Http\Resources\Api\Exercise;
 
+use App\DTO\CheckResultData;
 use Illuminate\Http\Request;
 use Illuminate\Http\Resources\Json\JsonResource;
 
 /**
- * @property \App\Services\CheckResult $resource
+ * @property CheckResultData $resource
  */
 class CheckResultResource extends JsonResource
 {
     public function toArray(Request $request): array
     {
         return [
-            /** @var int */
             'exit_code' => $this->resource->exitCode,
             'result_status' => $this->resource->getResultStatus(),
-            'output' => $this->resource->getOutput(),
+            'output' => $this->resource->output,
         ];
     }
 }

app/Services/CheckResult.php

@@ -4,6 +4,7 @@
 
 namespace App\Services;
 
+use App\DTO\CheckResultData;
 use App\Models\User;
 use App\Models\Exercise;
 use App\Models\ExerciseMember;
@@ -13,13 +14,13 @@
 
 class ExerciseService
 {
-    private const POINTS_PER_EXERCISE = 3;
+    private const int POINTS_PER_EXERCISE = 3;
 
     public function __construct(private SolutionChecker $checker, private ActivityService $activityService)
     {
     }
 
-    public function check(User $user, Exercise $exercise, string $solutionCode): CheckResult
+    public function check(User $user, Exercise $exercise, string $solutionCode): CheckResultData
     {
         $checkResult = $this->checker->check($exercise, $solutionCode);
 

app/Services/ExerciseService.php

@@ -2,16 +2,17 @@
 
 namespace App\Services;
 
+use App\DTO\CheckResultData;
 use App\Models\Exercise;
 use Illuminate\Support\Facades\Storage;
 use mikehaertl\shellcommand\Command;
 
 class SolutionChecker
 {
-    public function check(Exercise $exercise, string $solutionCode): CheckResult
+    public function check(Exercise $exercise, string $solutionCode): CheckResultData
     {
         if (!$exercise->hasTests()) {
-            return new CheckResult(CheckResult::SUCCESS_EXIT_CODE);
+            return new CheckResultData(CheckResultData::SUCCESS_EXIT_CODE);
         }
 
         $tests = $exercise->getExerciseTests();
@@ -38,7 +39,7 @@ public function check(Exercise $exercise, string $solutionCode): CheckResult
             ? $command->getOutput()
             : $command->getError();
 
-        return new CheckResult($exitCode, $output);
+        return new CheckResultData($exitCode, $output);
     }
 
     private function prettifyCode(string $code): string

app/Services/SolutionChecker.php

@@ -2,8 +2,8 @@
 
 namespace Tests\Feature\Http\Controllers\Api\Exercise;
 
+use App\DTO\CheckResultData;
 use App\Models\Exercise;
-use App\Services\CheckResult;
 use Database\Seeders\ChaptersTableSeeder;
 use Database\Seeders\ExercisesTableSeeder;
 use Tests\ControllerTestCase;
@@ -39,7 +39,7 @@ public function testCheck(): void
 
         $responseBody = $response->decodeResponseJson();
 
-        $this->assertTrue(array_get($responseBody, 'check_result.exit_code') === CheckResult::SUCCESS_EXIT_CODE);
+        $this->assertTrue(array_get($responseBody, 'check_result.exit_code') === CheckResultData::SUCCESS_EXIT_CODE);
 
         $this->assertDatabaseHas('activity_log', [
             'causer_id' => $this->user->id,
@@ -69,6 +69,6 @@ public function testCheckByGuest(): void
         $response->assertCreated();
         $responseBody = $response->decodeResponseJson();
 
-        $this->assertTrue(array_get($responseBody, 'check_result.exit_code') === CheckResult::SUCCESS_EXIT_CODE);
+        $this->assertTrue(array_get($responseBody, 'check_result.exit_code') === CheckResultData::SUCCESS_EXIT_CODE);
     }
 }