Add a keep option to skip the cleanup. (#105)

Co-authored-by: Stefan Zweifel <stefan@stefanzweifel.dev>

Author: ojsoft

README.md

@@ -68,6 +68,7 @@ php artisan backup:restore
     --connection=mysql 
     --password=my-secret-password 
     --reset
+    --keep
 ```
 
 Note that we used `latest` as the value for `--backup`. The command will automatically download the latest available backup and restore its database.
@@ -88,6 +89,9 @@ Password used to decrypt a possible encrypted backup. Defaults to encryption pas
 #### `--reset`
 Reset the database before restoring the backup. Defaults to `false`.
 
+#### `--keep`
+Keeps the downloaded backup (and the decrypted backup folder) in existence. You need to delete it by hand. Useful for extracting and restoring backuped files. Defaults to `false`.
+
 ---
 
 The command asks for confirmation before starting the restore process. If you run the `backup:restore`-command in an environment where you can't confirm the process (for example through a cronjob), you can use the `--no-interaction`-option to bypass the question.

src/Actions/CleanupLocalBackupAction.php

@@ -5,6 +5,7 @@
 namespace Wnx\LaravelBackupRestore\Actions;
 
 use Illuminate\Support\Facades\Storage;
+use Wnx\LaravelBackupRestore\Events\LocalBackupRemoved;
 use Wnx\LaravelBackupRestore\PendingRestore;
 
 class CleanupLocalBackupAction
@@ -16,5 +17,7 @@ public function execute(PendingRestore $pendingRestore): void
 
         Storage::disk($pendingRestore->restoreDisk)
             ->deleteDirectory($pendingRestore->getPathToLocalDecompressedBackup());
+
+        event(new LocalBackupRemoved($pendingRestore));
     }
 }

src/Commands/RestoreCommand.php

@@ -40,7 +40,9 @@ class RestoreCommand extends Command
                         {--backup= : The backup to restore. Defaults to the latest backup.}
                         {--connection= : The database connection to restore the backup to. Defaults to the first connection in config/backup.php.}
                         {--password= : The password to decrypt the backup.}
-                        {--reset : Drop all tables in the database before restoring the backup.}';
+                        {--reset : Drop all tables in the database before restoring the backup.}
+                        {--keep : Keeps the downloaded zip and decrypted folder from the backup in existence. Handy for moving files afterwards by hand to the correct location.}
+                        ';
 
     public $description = 'Restore a database backup dump from a given disk to a database connection.';
 
@@ -93,8 +95,10 @@ public function handle(
 
         $importDumpAction->execute($pendingRestore);
 
-        info('Cleaning up …');
-        $cleanupLocalBackupAction->execute($pendingRestore);
+        if (!$this->option('keep')) {
+            info('Cleaning up …');
+            $cleanupLocalBackupAction->execute($pendingRestore);
+        }
 
         return $this->runHealthChecks($pendingRestore);
     }

src/Events/LocalBackupRemoved.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Wnx\LaravelBackupRestore\Events;
+
+use Wnx\LaravelBackupRestore\PendingRestore;
+
+class LocalBackupRemoved
+{
+    public function __construct(public readonly PendingRestore $pendingRestore) {}
+}

tests/Commands/RestoreCommandTest.php

@@ -6,6 +6,7 @@
 use Illuminate\Support\Facades\Event;
 use Wnx\LaravelBackupRestore\Commands\RestoreCommand;
 use Wnx\LaravelBackupRestore\Events\DatabaseReset;
+use Wnx\LaravelBackupRestore\Events\LocalBackupRemoved;
 use Wnx\LaravelBackupRestore\Exceptions\NoBackupsFound;
 
 // MySQL
@@ -21,7 +22,7 @@
         ->expectsOutputToContain('All health checks passed.')
         ->assertSuccessful();
 
-    $result = DB::connection('mysql')->table('users')->count();
+    $result = DB::connection('mysql-restore')->table('users')->count();
 
     expect($result)->toBe(10);
 })->with([
@@ -124,7 +125,7 @@
         ->expectsQuestion('Proceed to restore "Laravel/2023-01-28-mysql-no-compression-encrypted.zip" using the "mysql-restore" database connection. (Database: laravel_backup_restore, Host: 127.0.0.1, username: root)', true)
         ->assertSuccessful();
 
-    $result = DB::connection('mysql')->table('users')->count();
+    $result = DB::connection('mysql-restore')->table('users')->count();
 
     expect($result)->toBe(10);
 })->group('mysql');
@@ -175,3 +176,24 @@
         ->expectsOutputToContain('Database has not tables after restore.')
         ->assertFailed();
 });
+
+it('does not clear downloaded backup if --keep option is being used', function () {
+    Event::fake([LocalBackupRemoved::class]);
+
+    $this->artisan(RestoreCommand::class, [
+        '--disk' => 'remote',
+        '--backup' => 'Laravel/2023-02-28-sqlite-no-compression-no-encryption.zip',
+        '--connection' => 'sqlite-restore',
+        '--password' => null,
+        '--no-interaction' => true,
+        '--keep' => true,
+    ])
+        ->expectsQuestion('Proceed to restore "Laravel/2023-02-28-sqlite-no-compression-no-encryption.zip" using the "sqlite-restore" database connection. (Database: database/database.sqlite)', true)
+        ->assertSuccessful();
+
+    Event::assertNotDispatched(LocalBackupRemoved::class);
+    $files = \Illuminate\Support\Facades\Storage::disk('local')->allFiles('backup-restore-temp');
+
+    expect($files)->not->toBeEmpty();
+
+})->group('sqlite');

tests/Databases/MySqlTest.php

@@ -21,7 +21,7 @@
         return $event->absolutePathToDump === $dumpFile;
     });
 
-    $result = DB::connection('mysql')->table('users')->count();
+    $result = DB::connection('mysql-restore')->table('users')->count();
     expect($result)->toBe(10);
 })->with([
     __DIR__.'/../storage/Laravel/2023-01-28-mysql-no-compression-no-encryption.sql',