Merge pull request #57 from ralphschindler/feature-gzip-and-external-load

Feature: support creating and loading gzip snapshots

Author: freekmurze

README.md

@@ -82,6 +82,11 @@ return [
      * The directory where temporary files will be stored.
      */
     'temporary_directory_path' => storage_path('app/laravel-db-snapshots/temp'),
+
+    /*
+     * Create dump files that are gzipped
+     */
+    'compress' => false,
 ];
 ```
 
@@ -100,6 +105,13 @@ Giving your snapshot a name is optional. If you don't pass a name the current da
 php artisan snapshot:create
 ```
 
+When creating snapshots, you can optionally create compressed snapshots.  To do this either pass the `--compress` option on the command line, or set the `db-snapshots.compress` configuration option to `true`:
+
+```bash
+# Creates a snapshot named my-compressed-dump.sql.gz
+php artisan snapshot:create my-compressed-dump --compress
+```
+
 After you've made some changes to the database you can create another snapshot:
 
 ```bash

composer.json

@@ -19,14 +19,14 @@
         "php": "^7.0",
         "illuminate/support": "^5.4.30",
         "league/flysystem": "^1.0.41",
-        "spatie/db-dumper": "^2.7",
+        "spatie/db-dumper": "^2.11",
         "spatie/laravel-migrate-fresh": "^1.4.1",
         "spatie/temporary-directory": "^1.1"
     },
     "require-dev": {
         "mockery/mockery": "^0.9.8",
         "orchestra/testbench": "^3.4.10",
-        "phpunit/phpunit": "^6.2 || ^7.0"
+        "phpunit/phpunit": "^6.5 || ^7.0"
     },
     "autoload": {
         "psr-4": {

config/db-snapshots.php

@@ -17,4 +17,9 @@
      * The directory where temporary files will be stored.
      */
     'temporary_directory_path' => storage_path('app/laravel-db-snapshots/temp'),
+
+    /*
+     * Create dump files that are gzipped
+     */
+    'compress' => false,
 ];

src/Commands/Create.php

@@ -2,15 +2,14 @@
 
 namespace Spatie\DbSnapshots\Commands;
 
-use DB;
 use Carbon\Carbon;
 use Illuminate\Console\Command;
 use Spatie\DbSnapshots\Helpers\Format;
 use Spatie\DbSnapshots\SnapshotFactory;
 
 class Create extends Command
 {
-    protected $signature = 'snapshot:create {name?} {--connection=}';
+    protected $signature = 'snapshot:create {name?} {--connection=} {--compress}';
 
     protected $description = 'Create a new snapshot.';
 
@@ -24,10 +23,13 @@ public function handle()
 
         $snapshotName = $this->argument('name') ?: Carbon::now()->format('Y-m-d_H-i-s');
 
+        $compress = $this->option('compress', null);
+
         $snapshot = app(SnapshotFactory::class)->create(
             $snapshotName,
             config('db-snapshots.disk'),
-            $connectionName
+            $connectionName,
+            ($compress !== null) ? $compress : (bool) config('db-snapshots.compress', false)
         );
 
         $size = Format::humanReadableSize($snapshot->size());

src/Snapshot.php

@@ -22,12 +22,22 @@ class Snapshot
     /** @var string */
     public $name;
 
+    /** @var string */
+    public $compressionExtension = null;
+
     public function __construct(Disk $disk, string $fileName)
     {
         $this->disk = $disk;
 
         $this->fileName = $fileName;
 
+        $pathinfo = pathinfo($fileName);
+
+        if ($pathinfo['extension'] === 'gz') {
+            $this->compressionExtension = $pathinfo['extension'];
+            $fileName = $pathinfo['filename'];
+        }
+
         $this->name = pathinfo($fileName, PATHINFO_FILENAME);
     }
 
@@ -43,6 +53,10 @@ public function load(string $connectionName = null)
 
         $dbDumpContents = $this->disk->get($this->fileName);
 
+        if ($this->compressionExtension === 'gz') {
+            $dbDumpContents = gzdecode($dbDumpContents);
+        }
+
         DB::connection($connectionName)->unprepared($dbDumpContents);
 
         event(new LoadedSnapshot($this));

src/SnapshotFactory.php

@@ -6,6 +6,7 @@
 use Illuminate\Contracts\Filesystem\Factory;
 use Illuminate\Filesystem\FilesystemAdapter;
 use Spatie\DbSnapshots\Events\CreatedSnapshot;
+use Spatie\DbDumper\Compressors\GzipCompressor;
 use Spatie\DbSnapshots\Events\CreatingSnapshot;
 use Spatie\TemporaryDirectory\TemporaryDirectory;
 use Spatie\DbSnapshots\Exceptions\CannotCreateDisk;
@@ -25,20 +26,24 @@ public function __construct(DbDumperFactory $dumperFactory, Factory $filesystemF
         $this->filesystemFactory = $filesystemFactory;
     }
 
-    public function create(string $snapshotName, string $diskName, string $connectionName): Snapshot
+    public function create(string $snapshotName, string $diskName, string $connectionName, bool $compress = false): Snapshot
     {
         $disk = $this->getDisk($diskName);
 
         $fileName = $snapshotName.'.sql';
         $fileName = pathinfo($fileName, PATHINFO_BASENAME);
 
+        if ($compress) {
+            $fileName .= '.gz';
+        }
+
         event(new CreatingSnapshot(
             $fileName,
             $disk,
             $connectionName
         ));
 
-        $this->createDump($connectionName, $fileName, $disk);
+        $this->createDump($connectionName, $fileName, $disk, $compress);
 
         $snapshot = new Snapshot($disk, $fileName);
 
@@ -63,13 +68,19 @@ protected function getDbDumper(string $connectionName): DbDumper
         return $factory::createForConnection($connectionName);
     }
 
-    protected function createDump(string $connectionName, string $fileName, FilesystemAdapter $disk)
+    protected function createDump(string $connectionName, string $fileName, FilesystemAdapter $disk, bool $compress = false)
     {
         $directory = (new TemporaryDirectory(config('db-snapshots.temporary_directory_path')))->create();
 
         $dumpPath = $directory->path($fileName);
 
-        $this->getDbDumper($connectionName)->dumpToFile($dumpPath);
+        $dbDumper = $this->getDbDumper($connectionName);
+
+        if ($compress) {
+            $dbDumper->useCompressor(new GzipCompressor());
+        }
+
+        $dbDumper->dumpToFile($dumpPath);
 
         $file = fopen($dumpPath, 'r');
 

src/SnapshotRepository.php

@@ -19,6 +19,12 @@ public function getAll(): Collection
     {
         return collect($this->disk->allFiles())
             ->filter(function (string $fileName) {
+                $pathinfo = pathinfo($fileName);
+
+                if ($pathinfo['extension'] === 'gz') {
+                    $fileName = $pathinfo['filename'];
+                }
+
                 return pathinfo($fileName, PATHINFO_EXTENSION) === 'sql';
             })
             ->map(function (string $fileName) {

tests/Commands/CreateTest.php

@@ -15,14 +15,26 @@ public function it_can_create_a_snapshot_without_a_specific_name()
 
         $fileName = Carbon::now()->format('Y-m-d_H-i-s').'.sql';
 
-        $this->assertFileOnDiskContains($fileName, 'CREATE TABLE "models"');
+        $this->assertFileOnDiskPassesRegex($fileName, '/CREATE TABLE(?: IF NOT EXISTS){0,1} "models"/');
     }
 
     /** @test */
     public function it_can_create_a_snapshot_with_specific_name()
     {
         Artisan::call('snapshot:create', ['name' => 'test']);
 
-        $this->assertFileOnDiskContains('test.sql', 'CREATE TABLE "models"');
+        $this->assertFileOnDiskPassesRegex('test.sql', '/CREATE TABLE(?: IF NOT EXISTS){0,1} "models"/');
+    }
+
+    /** @test */
+    public function it_can_create_a_compressed_snapshot()
+    {
+        Artisan::call('snapshot:create', ['--compress' => true]);
+
+        $fileName = Carbon::now()->format('Y-m-d_H-i-s').'.sql.gz';
+
+        $this->disk->assertExists($fileName);
+
+        $this->assertNotEmpty(gzdecode($this->disk->get($fileName)));
     }
 }

tests/Commands/LoadTest.php

@@ -58,6 +58,16 @@ public function it_can_load_a_snapshot_with_connection_option()
         $this->assertSnapshotLoaded('snapshot2');
     }
 
+    /** @test */
+    public function it_can_load_a_compressed_snapshot()
+    {
+        $this->assertSnapshotNotLoaded('snapshot4');
+
+        Artisan::call('snapshot:load', ['name' => 'snapshot4']);
+
+        $this->assertSnapshotLoaded('snapshot4');
+    }
+
     protected function assertSnapshotLoaded($snapshotName)
     {
         $this->assertEquals(

tests/SnapshotRepositoryTest.php

@@ -22,7 +22,7 @@ public function it_can_load_snapshots_from_a_disk()
     {
         $snapshots = $this->repository->getAll();
 
-        $this->assertCount(3, $snapshots);
+        $this->assertCount(4, $snapshots);
 
         $this->assertInstanceOf(Snapshot::class, $snapshots->first());
     }
@@ -32,6 +32,18 @@ public function it_can_get_a_snapshot_by_name()
     {
         $this->assertInstanceOf(Snapshot::class, $this->repository->findByName('snapshot2'));
 
-        $this->assertNull($this->repository->findByName('snapshot4'));
+        $this->assertNull($this->repository->findByName('snapshot5'));
+    }
+
+    /** @test */
+    public function it_can_find_gz_compressed_snapshots()
+    {
+        $snapshot = $this->repository->findByName('snapshot4');
+
+        $this->assertInstanceOf(Snapshot::class, $snapshot);
+
+        $this->assertEquals('gz', $snapshot->compressionExtension);
+
+        $this->assertNull($this->repository->findByName('snapshot5'));
     }
 }