refactor Backup status to an enum

src/Enums/BackupStatus.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Spatie\BackupServer\Enums;
+
+enum BackupStatus: string
+{
+    case Pending = 'pending';
+    case InProgress = 'in_progress';
+    case Completed = 'completed';
+    case Failed = 'failed';
+    case Deleting = 'deleting';
+}

src/Models/Backup.php

@@ -10,6 +10,7 @@
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Support\Facades\Storage;
 use Illuminate\Support\Str;
+use Spatie\BackupServer\Enums\BackupStatus;
 use Spatie\BackupServer\Models\Concerns\HasAsyncDelete;
 use Spatie\BackupServer\Models\Concerns\LogsActivity;
 use Spatie\BackupServer\Support\Helpers\DestinationLocation;
@@ -34,17 +35,8 @@ class Backup extends Model
 
     public $guarded = [];
 
-    public const STATUS_PENDING = 'pending';
-
-    public const STATUS_IN_PROGRESS = 'in_progress';
-
-    public const STATUS_COMPLETED = 'completed';
-
-    public const STATUS_FAILED = 'failed';
-
-    public const STATUS_DELETING = 'deleting';
-
     protected $casts = [
+        'status' => BackupStatus::class,
         'log' => 'array',
         'size_in_kb' => 'int',
         'real_size_in_kb' => 'int',
@@ -112,7 +104,7 @@ public function destinationLocation(): DestinationLocation
     public function markAsInProgress(): self
     {
         $this->update([
-            'status' => self::STATUS_IN_PROGRESS,
+            'status' => BackupStatus::InProgress,
         ]);
 
         return $this;
@@ -123,7 +115,7 @@ public function markAsCompleted(): self
         $this->logInfo(Task::BACKUP, 'Backup completed.');
 
         $this->update([
-            'status' => self::STATUS_COMPLETED,
+            'status' => BackupStatus::Completed,
             'completed_at' => now(),
         ]);
 
@@ -135,20 +127,20 @@ public function markAsFailed(string $errorMessage): self
         $this->logError(Task::BACKUP, "Backup failed: {$errorMessage}");
 
         $this->update([
-            'status' => self::STATUS_FAILED,
+            'status' => BackupStatus::Failed,
         ]);
 
         return $this;
     }
 
     public function scopeCompleted(Builder $query): void
     {
-        $query->where('status', static::STATUS_COMPLETED);
+        $query->where('status', BackupStatus::Completed);
     }
 
     public function scopeFailed(Builder $query): void
     {
-        $query->where('status', static::STATUS_FAILED);
+        $query->where('status', BackupStatus::Failed);
     }
 
     public function handleProgress(string $type, string $progressOutput): self
@@ -301,14 +293,14 @@ public function findContent(string $searchFor, callable $handleSearchResult): bo
     public function isPendingOrInProgress(): bool
     {
         return in_array($this->status, [
-            Backup::STATUS_PENDING,
-            Backup::STATUS_IN_PROGRESS,
+            BackupStatus::Pending,
+            BackupStatus::InProgress,
         ], true);
     }
 
     public function isCompleted(): bool
     {
-        return $this->status === static::STATUS_COMPLETED;
+        return $this->status === BackupStatus::Completed;
     }
 
     public function fileList(string $relativeDirectory = '/'): FileList

src/Models/Concerns/HasAsyncDelete.php

@@ -2,11 +2,13 @@
 
 namespace Spatie\BackupServer\Models\Concerns;
 
+use Spatie\BackupServer\Enums\BackupStatus;
+
 trait HasAsyncDelete
 {
     public function asyncDelete(): void
     {
-        $this->update(['status' => static::STATUS_DELETING]);
+        $this->update(['status' => BackupStatus::Deleting]);
 
         $deletionJobClassName = $this->getDeletionJobClassName();
 
@@ -15,7 +17,7 @@ public function asyncDelete(): void
 
     public function willBeDeleted(): bool
     {
-        return $this->status === static::STATUS_DELETING;
+        return $this->status === BackupStatus::Deleting;
     }
 
     abstract public function getDeletionJobClassName(): string;

src/Tasks/Backup/Actions/CreateBackupAction.php

@@ -2,6 +2,7 @@
 
 namespace Spatie\BackupServer\Tasks\Backup\Actions;
 
+use Spatie\BackupServer\Enums\BackupStatus;
 use Spatie\BackupServer\Models\Backup;
 use Spatie\BackupServer\Models\Source;
 use Spatie\BackupServer\Support\Helpers\Enums\Task;
@@ -30,9 +31,8 @@ public function doNotUseQueue(): self
 
     public function execute(Source $source): Backup
     {
-        /** @var \Spatie\BackupServer\Models\Backup $backup */
         $backup = Backup::create([
-            'status' => Backup::STATUS_PENDING,
+            'status' => BackupStatus::Pending,
             'source_id' => $source->id,
             'destination_id' => $source->destination->id,
             'disk_name' => $source->destination->disk_name,

tests/Factories/BackupFactory.php

@@ -31,7 +31,7 @@ public function source(Source $source): self
 
     public function completed(): self
     {
-        $this->status = Backup::STATUS_COMPLETED;
+        $this->status = BackupStatus::Completed;
 
         return $this;
     }

tests/Feature/Commands/DispatchPerformCleanupJobsCommandTest.php

@@ -5,6 +5,7 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Notification;
 use Illuminate\Support\Facades\Storage;
+use Spatie\BackupServer\Enums\BackupStatus;
 use Spatie\BackupServer\Models\Backup;
 use Spatie\BackupServer\Models\Destination;
 use Spatie\BackupServer\Models\Source;
@@ -99,7 +100,7 @@
     TestTime::freeze();
 
     $failedBackup = (new BackupFactory())->makeSureBackupDirectoryExists()->create([
-        'status' => Backup::STATUS_FAILED,
+        'status' => BackupStatus::Failed,
         'created_at' => now(),
     ]);
 

tests/Feature/Tasks/Backup/Jobs/PerformBackupJobTest.php

@@ -3,6 +3,7 @@
 uses(\Spatie\BackupServer\Tests\TestCase::class);
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Facades\Storage;
+use Spatie\BackupServer\Enums\BackupStatus;
 use Spatie\BackupServer\Models\Backup;
 use Spatie\BackupServer\Models\Source;
 use Spatie\Docker\DockerContainer;
@@ -34,7 +35,7 @@
 
     $this->artisan('backup-server:dispatch-backups')->assertExitCode(0);
 
-    expect($this->source->backups()->first()->status)->toBe(Backup::STATUS_COMPLETED);
+    expect($this->source->backups()->first()->status)->toBe(BackupStatus::Completed);
     expect($this->source->backups()->first()->has('src/1.txt'))->toBeTrue();
     expect($this->source->backups()->first()->has('src/exclude.txt'))->toBeFalse();
 });
@@ -48,7 +49,7 @@
 
     expect($this->source->backups()->first()->has('src/newfile.txt'))->toBeTrue();
 
-    expect($this->source->backups()->first()->status)->toBe(Backup::STATUS_COMPLETED);
+    expect($this->source->backups()->first()->status)->toBe(BackupStatus::Completed);
 });
 
 it('will mark the backup as failed if the pre backup commands cannot execute', function () {
@@ -58,7 +59,7 @@
 
     $this->artisan('backup-server:dispatch-backups')->assertExitCode(0);
 
-    expect($this->source->backups()->first()->status)->toBe(Backup::STATUS_FAILED);
+    expect($this->source->backups()->first()->status)->toBe(BackupStatus::Failed);
 });
 
 it('can perform post backup commands', function () {
@@ -72,31 +73,31 @@
 
     expect(trim($process->getOutput()))->toBe('ok');
 
-    expect($this->source->backups()->first()->status)->toBe(Backup::STATUS_COMPLETED);
+    expect($this->source->backups()->first()->status)->toBe(BackupStatus::Completed);
 });
 
 it('will mark the backup as failed if the post backup commands cannot execute', function () {
     $this->source->update(['post_backup_commands' => ['invalid-command']]);
 
     $this->artisan('backup-server:dispatch-backups')->assertExitCode(0);
 
-    expect($this->source->backups()->first()->status)->toBe(Backup::STATUS_FAILED);
+    expect($this->source->backups()->first()->status)->toBe(BackupStatus::Failed);
 });
 
 it('will fail if the source is not reachable', function () {
     $this->source->update(['host' => 'non-existing-host']);
 
     $this->artisan('backup-server:dispatch-backups')->assertExitCode(0);
 
-    expect($this->source->backups()->first()->status)->toBe(Backup::STATUS_FAILED);
+    expect($this->source->backups()->first()->status)->toBe(BackupStatus::Failed);
 });
 
 it('will fail if it cannot login', function () {
     $this->source->update(['ssh_private_key_file' => null]);
 
     $this->artisan('backup-server:dispatch-backups')->assertExitCode(0);
 
-    expect($this->source->backups()->first()->status)->toBe(Backup::STATUS_FAILED);
+    expect($this->source->backups()->first()->status)->toBe(BackupStatus::Failed);
 });
 
 afterEach(function () {

tests/Feature/Tasks/Monitor/HealthChecks/Destination/MaximumStorageInMBTest.php

@@ -10,7 +10,7 @@
     $maximumSizeInMB = 1;
 
     $backup = Backup::factory()->create([
-        'status' => Backup::STATUS_COMPLETED,
+        'status' => BackupStatus::Completed,
         'real_size_in_kb' => $maximumSizeInMB * 1024,
     ]);
 
@@ -20,7 +20,7 @@
     $this->assertHealthCheckSucceeds($healthCheck->getResult($destination));
 
     Backup::factory()->create([
-        'status' => Backup::STATUS_COMPLETED,
+        'status' => BackupStatus::Completed,
         'destination_id' => $destination->id,
     ]);
 
@@ -31,7 +31,7 @@
     $maximumSizeInMB = 0;
 
     $backup = Backup::factory()->create([
-        'status' => Backup::STATUS_COMPLETED,
+        'status' => BackupStatus::Completed,
         'real_size_in_kb' => 2 * 1024,
     ]);
 

tests/Feature/Tasks/Monitor/HealthChecks/Source/MaximumStorageInMBTest.php

@@ -10,7 +10,7 @@
     $maximumSizeInMB = 1;
 
     $backup = Backup::factory()->create([
-        'status' => Backup::STATUS_COMPLETED,
+        'status' => BackupStatus::Completed,
         'real_size_in_kb' => $maximumSizeInMB * 1024,
     ]);
 
@@ -20,7 +20,7 @@
     $this->assertHealthCheckSucceeds($healthCheck->getResult($source));
 
     Backup::factory()->create([
-        'status' => Backup::STATUS_COMPLETED,
+        'status' => BackupStatus::Completed,
         'source_id' => $source->id,
     ]);
 

tests/Unit/Models/BackupTest.php

@@ -36,7 +36,7 @@
 
     $backup->markAsCompleted();
 
-    expect($backup->status)->toEqual(Backup::STATUS_COMPLETED);
+    expect($backup->status)->toEqual(BackupStatus::Completed);
     expect($backup->completed_at->format('YmdHis'))->toEqual(now()->format('YmdHis'));
 });