Merge pull request #79 from jamatheney/cleanup-old-snapshots

Add command to cleanup old snapshots

Author: freekmurze

README.md

@@ -24,6 +24,9 @@ php artisan snapshot:load my-first-dump
 
 # List all snapshots
 php artisan snapshot:list
+
+# Remove old snapshots. Keeping only the most recent
+php artisan snapshot:cleanup --keep=2
 ```
 
 This package supports MySQL, PostgreSQL and SQLite.
@@ -135,6 +138,12 @@ A dump can be deleted with:
 php artisan snapshot:delete my-first-dump
 ```
 
+To remove all backups except the most recent 2
+
+```bash
+php artisan snapshot:cleanup --keep=2
+```
+
 ## Events
 
 There are several events fired which can be used to perform some logic of your own:

src/Commands/Cleanup.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Spatie\DbSnapshots\Commands;
+
+use Illuminate\Console\Command;
+use Spatie\DbSnapshots\SnapshotRepository;
+
+class Cleanup extends Command
+{
+    protected $signature = 'snapshot:cleanup {--keep=}';
+
+    protected $description = 'Specify how many snapshots to keep and delete the rest';
+
+    public function handle()
+    {
+        $snapshots = app(SnapshotRepository::class)->getAll();
+
+        $keep = $this->option('keep');
+
+        if (! $this->option('keep')) {
+            $this->warn('No value for option --keep.');
+
+            return;
+        }
+
+        $snapshots->splice($keep)->each(function ($snapshot) {
+            $snapshot->delete();
+        });
+    }
+}

src/DbSnapshotsServiceProvider.php

@@ -6,6 +6,7 @@
 use Illuminate\Support\ServiceProvider;
 use Spatie\DbSnapshots\Commands\Create;
 use Spatie\DbSnapshots\Commands\Delete;
+use Spatie\DbSnapshots\Commands\Cleanup;
 use Illuminate\Contracts\Filesystem\Factory;
 use Spatie\DbSnapshots\Commands\ListSnapshots;
 
@@ -34,12 +35,14 @@ public function boot()
         $this->app->bind('command.snapshot:load', Load::class);
         $this->app->bind('command.snapshot:delete', Delete::class);
         $this->app->bind('command.snapshot:list', ListSnapshots::class);
+        $this->app->bind('command.snapshot:cleanup', Cleanup::class);
 
         $this->commands([
             'command.snapshot:create',
             'command.snapshot:load',
             'command.snapshot:delete',
             'command.snapshot:list',
+            'command.snapshot:cleanup',
         ]);
     }
 

tests/Commands/CleanupTest.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Spatie\DbSnapshots\Commands\Test;
+
+use Spatie\DbSnapshots\Test\TestCase;
+use Illuminate\Support\Facades\Artisan;
+
+class CleanupTest extends TestCase
+{
+    /** @test */
+    public function it_can_delete_old_snapshots_keeping_the_desired_number_of_snapshots()
+    {
+        // Add sleep to make sure files do not have the same modified time.
+        // They may not sort properly if all have the same timestamp.
+        $this->clearDisk();
+
+        $this->disk->put('snapshot1.sql', 'new content');
+
+        sleep(1);
+
+        $this->disk->put('snapshot2.sql', 'new content');
+
+        Artisan::call('snapshot:cleanup', ['--keep' => 1]);
+
+        $this->disk->assertMissing('snapshot1.sql');
+        $this->disk->assertExists('snapshot2.sql');
+    }
+}