Merge pull request #125 from ariaieboy/patch1

add --exclude to the create command

Author: freekmurze

README.md

@@ -84,18 +84,18 @@ This is the content of the published file:
 ```php
 return [
 
-    /**
+    /*
      * The name of the disk on which the snapshots are stored.
      */
     'disk' => 'snapshots',
 
-    /**
+    /*
      * The connection to be used to create snapshots. Set this to null
-     * to use the default configured in `config/database.php`
+     * to use the default configured in `config/databases.php`
      */
     'default_connection' => null,
 
-    /**
+    /*
      * The directory where temporary files will be stored.
      */
     'temporary_directory_path' => storage_path('app/laravel-db-snapshots/temp'),
@@ -111,7 +111,15 @@ return [
      * Default: `null`
      */
     'tables' => null,
+
+    /*
+     * All tables will be included in the snapshot expect this tables. Set to `null` to include all tables.
+     *
+     * Default: `null`
+     */
+    'exclude' => null,
 ];
+
 ```
 
 ## Usage
@@ -137,6 +145,14 @@ php artisan snapshot:create --table=posts,users
 php artisan snapshot:create --table=posts --table=users
 ```
 
+You may want to exclude some tables from snapshot. You can do this by passing the `--exclude` multiple times or as a comma separated list:
+```bash
+# create snapshot from all tables exclude the users and posts
+php artisan snapshot:create --exclude=posts,users
+php artisan snapshot:create --exclude=posts --exclude=users
+```
+> Note: if you pass `--table` and `--exclude` in the same time it will use `--table` to create the snapshot and it's ignore the `--exclude`
+
 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

composer.json

@@ -19,7 +19,7 @@
         "php": "^8.0",
         "illuminate/support": "^7.0|^8.0|^9.0",
         "league/flysystem": "^1.0.41|^2.0|^3.0",
-        "spatie/db-dumper": "^3.1",
+        "spatie/db-dumper": "^3.3",
         "spatie/laravel-package-tools": "^1.6",
         "spatie/temporary-directory": "^2.0"
     },

config/db-snapshots.php

@@ -29,4 +29,11 @@
      * Default: `null`
      */
     'tables' => null,
+
+    /*
+     * All tables will be included in the snapshot expect this tables. Set to `null` to include all tables.
+     *
+     * Default: `null`
+     */
+    'exclude' => null,
 ];

src/Commands/Create.php

@@ -9,7 +9,7 @@
 
 class Create extends Command
 {
-    protected $signature = 'snapshot:create {name?} {--connection=} {--compress} {--table=*}';
+    protected $signature = 'snapshot:create {name?} {--connection=} {--compress} {--table=*} {--exclude=*}';
 
     protected $description = 'Create a new snapshot.';
 
@@ -28,12 +28,21 @@ public function handle()
         $tables = $this->option('table') ?: config('db-snapshots.tables', null);
         $tables = is_string($tables) ? explode(',', $tables) : $tables;
 
+        if (is_null($tables)) {
+            $exclude = $this->option('exclude') ?: config('db-snapshots.exclude', null);
+            $exclude = is_string($exclude) ? explode(',', $exclude) : $exclude;
+        } else {
+            $exclude = null;
+        }
+
+
         $snapshot = app(SnapshotFactory::class)->create(
             $snapshotName,
             config('db-snapshots.disk'),
             $connectionName,
             $compress,
-            $tables
+            $tables,
+            $exclude
         );
 
         $size = Format::humanReadableSize($snapshot->size());

src/Events/CreatingSnapshot.php

@@ -10,7 +10,8 @@ public function __construct(
         public string $fileName,
         public FilesystemAdapter $disk,
         public string $connectionName,
-        public ?array $tables = null
+        public ?array $tables = null,
+        public ?array $exclude = null
     ) {
         //
     }

src/SnapshotFactory.php

@@ -20,11 +20,11 @@ public function __construct(
         //
     }
 
-    public function create(string $snapshotName, string $diskName, string $connectionName, bool $compress = false, ?array $tables = null): Snapshot
+    public function create(string $snapshotName, string $diskName, string $connectionName, bool $compress = false, ?array $tables = null, ?array $exclude = null): Snapshot
     {
         $disk = $this->getDisk($diskName);
 
-        $fileName = $snapshotName.'.sql';
+        $fileName = $snapshotName . '.sql';
         $fileName = pathinfo($fileName, PATHINFO_BASENAME);
 
         if ($compress) {
@@ -35,10 +35,11 @@ public function create(string $snapshotName, string $diskName, string $connectio
             $fileName,
             $disk,
             $connectionName,
-            $tables
+            $tables,
+            $exclude
         ));
 
-        $this->createDump($connectionName, $fileName, $disk, $compress, $tables);
+        $this->createDump($connectionName, $fileName, $disk, $compress, $tables, $exclude);
 
         $snapshot = new Snapshot($disk, $fileName);
 
@@ -63,7 +64,7 @@ protected function getDbDumper(string $connectionName): DbDumper
         return $factory::createForConnection($connectionName);
     }
 
-    protected function createDump(string $connectionName, string $fileName, FilesystemAdapter $disk, bool $compress = false, ?array $tables = null): void
+    protected function createDump(string $connectionName, string $fileName, FilesystemAdapter $disk, bool $compress = false, ?array $tables = null, ?array $exclude = null): void
     {
         $directory = (new TemporaryDirectory(config('db-snapshots.temporary_directory_path')))->create();
 
@@ -79,6 +80,10 @@ protected function createDump(string $connectionName, string $fileName, Filesyst
             $dbDumper->includeTables($tables);
         }
 
+        if (is_array($exclude)) {
+            $dbDumper->excludeTables($exclude);
+        }
+
         $dbDumper->dumpToFile($dumpPath);
 
         $file = fopen($dumpPath, 'r');

tests/Commands/CreateTest.php

@@ -91,4 +91,42 @@ public function it_can_create_a_snapshot_with_specific_tables_specified_in_the_c
         $this->assertFileOnDiskPassesRegex($fileName, '/CREATE TABLE(?: IF NOT EXISTS){0,1} "posts"/');
         $this->assertFileOnDiskFailsRegex($fileName, '/CREATE TABLE(?: IF NOT EXISTS){0,1} "models"/');
     }
+
+    /** @test */
+    public function it_can_create_a_snapshot_without_excluded_tables_specified_in_the_command_options()
+    {
+        Artisan::call('snapshot:create', ['--exclude' => ['users', 'posts']]);
+
+        $fileName = Carbon::now()->format('Y-m-d_H-i-s') . '.sql';
+
+        $this->assertFileOnDiskFailsRegex($fileName, '/CREATE TABLE(?: IF NOT EXISTS){0,1} "users"/');
+        $this->assertFileOnDiskFailsRegex($fileName, '/CREATE TABLE(?: IF NOT EXISTS){0,1} "posts"/');
+        $this->assertFileOnDiskPassesRegex($fileName, '/CREATE TABLE(?: IF NOT EXISTS){0,1} "models"/');
+    }
+
+    /** @test */
+    public function it_can_create_a_snapshot_without_excluded_tables_specified_in_the_command_options_as_a_string()
+    {
+        Artisan::call('snapshot:create', ['--exclude' => 'users,posts']);
+
+        $fileName = Carbon::now()->format('Y-m-d_H-i-s') . '.sql';
+
+        $this->assertFileOnDiskFailsRegex($fileName, '/CREATE TABLE(?: IF NOT EXISTS){0,1} "users"/');
+        $this->assertFileOnDiskFailsRegex($fileName, '/CREATE TABLE(?: IF NOT EXISTS){0,1} "posts"/');
+        $this->assertFileOnDiskPassesRegex($fileName, '/CREATE TABLE(?: IF NOT EXISTS){0,1} "models"/');
+    }
+
+    /** @test */
+    public function it_can_create_a_snapshot_without_excluded_tables_specified_in_the_config()
+    {
+        $this->app['config']->set('db-snapshots.exclude', ['users', 'posts']);
+
+        Artisan::call('snapshot:create');
+
+        $fileName = Carbon::now()->format('Y-m-d_H-i-s') . '.sql';
+
+        $this->assertFileOnDiskFailsRegex($fileName, '/CREATE TABLE(?: IF NOT EXISTS){0,1} "users"/');
+        $this->assertFileOnDiskFailsRegex($fileName, '/CREATE TABLE(?: IF NOT EXISTS){0,1} "posts"/');
+        $this->assertFileOnDiskPassesRegex($fileName, '/CREATE TABLE(?: IF NOT EXISTS){0,1} "models"/');
+    }
 }

tests/Events/CreatingSnapshotTest.php

@@ -20,4 +20,16 @@ public function creating_a_snapshot_fires_the_creating_snapshot_event()
             return $event->fileName === 'my-snapshot.sql';
         });
     }
+
+    /** @test */
+    public function creating_a_snapshot_with_exclude_will_pass_excluded_tables()
+    {
+        Event::fake();
+
+        Artisan::call('snapshot:create', ['name' => 'my-snapshot', '--exclude' => ['tb1', 'tb2']]);
+
+        Event::assertDispatched(CreatingSnapshot::class, function (CreatingSnapshot $event) {
+            return ($event->fileName === 'my-snapshot.sql') && $event->exclude === ['tb1', 'tb2'];
+        });
+    }
 }