Merge pull request #1 from orisintel/feature/sqlite

feat(Sqlite): Initial support for Sqlite3 databases.

Author: paulrrogers

.travis.yml

@@ -19,8 +19,8 @@ sudo: required
 before_script:
 - travis_retry composer self-update
 - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
-- mysql -e 'CREATE DATABASE test_ms;'
-- psql -c 'CREATE DATABASE test_ms;' -U postgres
+- mysql -e 'CREATE DATABASE forge;'
+- psql -c 'CREATE DATABASE forge;' -U postgres
 - psql -c 'CREATE ROLE root SUPERUSER LOGIN;' -U postgres
 
 script:

README.md

@@ -7,7 +7,7 @@
 Simplify and accelerate applying many migrations at once using a flattened dump
 of the database schema and migrations, similar in spirit to Rails' `schema.rb`.
 
-Works with the `mysql` and `pgsql` database drivers.
+Works with the `mysql`, `pgsql`, and `sqlite` database drivers.
 
 ## Installation
 

phpunit.xml.travis

@@ -28,7 +28,6 @@
     </logging>
 
     <php>
-        <env name="DB_DATABASE" value="test_ms"/>
         <env name="DB_USERNAME" value="root"/>
     </php>
 </phpunit>

src/Commands/MigrateDumpCommand.php

@@ -5,7 +5,7 @@
 final class MigrateDumpCommand extends \Illuminate\Console\Command
 {
     public const SCHEMA_SQL_PATH_SUFFIX = '/migrations/sql/schema.sql';
-    public const SUPPORTED_DB_DRIVERS = ['mysql', 'pgsql'];
+    public const SUPPORTED_DB_DRIVERS = ['mysql', 'pgsql', 'sqlite'];
 
     protected $signature = 'migrate:dump
         {--database= : The database connection to use}';
@@ -78,6 +78,9 @@ private static function mysqlDump(array $db_config, string $schema_sql_path) : i
             . ' --user=' . escapeshellarg($db_config['username'])
             . ' --password=' . escapeshellarg($db_config['password'])
             . ' ' . escapeshellarg($db_config['database']);
+        // TODO: Suppress warning about insecure password.
+        // CONSIDER: Intercepting stdout and stderr and converting to colorized
+        // console output with `$this->info` and `->error`.
         passthru(
             $command_prefix
             . ' --result-file=' . escapeshellarg($schema_sql_path)
@@ -127,6 +130,7 @@ private static function pgsqlDump(array $db_config, string $schema_sql_path) : i
             . ' --port=' . escapeshellarg($db_config['port'])
             . ' --username=' . escapeshellarg($db_config['username'])
             . ' ' . escapeshellarg($db_config['database']);
+        // TODO: Suppress warning about insecure password.
         passthru(
             $command_prefix
             . ' --file=' . escapeshellarg($schema_sql_path)
@@ -148,4 +152,41 @@ private static function pgsqlDump(array $db_config, string $schema_sql_path) : i
 
         return $exit_code;
     }
+
+    /**
+     * @param array  $db_config   like ['host' => , 'port' => ].
+     * @param string $schema_sql_path like '.../schema.sql'
+     *
+     * @return int containing exit code.
+     */
+    private static function sqliteDump(array $db_config, string $schema_sql_path) : int
+    {
+        // CONSIDER: Accepting command name as option or from config.
+        $command_prefix = 'sqlite3 ' . escapeshellarg($db_config['database']);
+
+        // Since Sqlite lacks Information Schema, and dumping everything may be
+        // too slow or memory intense, just query tables and dump them
+        // individually.
+        exec($command_prefix . ' .tables', $output, $exit_code);
+        if (0 !== $exit_code) {
+            return $exit_code;
+        }
+        $tables = preg_split('/\s+/', implode(' ', $output));
+
+        foreach ($tables as $table) {
+            // Only migrations should dump data with schema.
+            $sql_command = 'migrations' === $table ? '.dump' : '.schema';
+
+            passthru(
+                $command_prefix . ' ' . escapeshellarg("$sql_command $table")
+                . ' >> ' . escapeshellarg($schema_sql_path),
+                $exit_code
+            );
+            if (0 !== $exit_code) {
+                return $exit_code;
+            }
+        }
+
+        return $exit_code;
+    }
 }

src/Commands/MigrateLoadCommand.php

@@ -145,4 +145,17 @@ private static function pgsqlLoad(string $path, array $db_config, int $verbosity
 
         return $exit_code;
     }
+
+    private static function sqliteLoad(string $path, array $db_config, int $verbosity = null) : int
+    {
+        // CONSIDER: Directly sending queries via Eloquent (requires parsing SQL
+        // or intermediate format).
+        // CONSIDER: Capturing Stderr and outputting with `$this->error()`.
+
+        $command = 'sqlite3 ' . escapeshellarg($db_config['database']) . ' ' . escapeshellarg(".read $path");
+
+        passthru($command, $exit_code);
+
+        return $exit_code;
+    }
 }

src/Handlers/MigrateStartingHandler.php

@@ -66,8 +66,8 @@ public function handle(CommandStarting $event)
             // Must pass along options or it may use wrong DB or have
             // inconsistent output.
             $options = self::inputToArtisanOptions($event->input);
-            $database = $options['--database'] ?? env('DB_CONNECTION');
-            $db_driver = \DB::connection($database)->getDriverName();
+            $database = $options['--database'] ?? \DB::getConfig('name');
+            $db_driver = \DB::getDriverName();
             if (! in_array($db_driver, MigrateDumpCommand::SUPPORTED_DB_DRIVERS, true)) {
                 // CONSIDER: Logging or emitting console warning.
                 return;
@@ -79,13 +79,13 @@ public function handle(CommandStarting $event)
             // Try-catch instead of information_schema since not all have one.
             try {
                 $has_migrated_any = ! is_null(
-                    \DB::connection($database)->table('migrations')->value('id')
+                    \DB::table('migrations')->value('id')
                 );
             } catch (\PDOException $e) {
                 // No op. when table does not exist.
                 if (
                     ! in_array($e->getCode(), ['42P01', '42S02'], true)
-                    && ! preg_match("/\bdoes ?n[o']t exist\b/iu", $e->getMessage())
+                    && ! preg_match("/\b(does ?n[o']t exist|no such table)\b/iu", $e->getMessage())
                 ) {
                     throw $e;
                 }
@@ -112,7 +112,7 @@ public static function inputToArtisanOptions(InputInterface $input) : array
                 if (false !== $input->getParameterOption($option)) {
                     $options[$option] = true;
                 }
-            } else {
+            } elseif (false !== $input->getParameterOption($option)) {
                 $options[$option] = $input->getParameterOption($option);
             }
         }

tests/Sqlite/MigrateDumpTest.php

@@ -0,0 +1,19 @@
+<?php
+
+
+namespace OrisIntel\MigrationSnapshot\Tests\Sqlite;
+
+class MigrateDumpTest extends SqliteTestCase
+{
+    public function test_handle()
+    {
+        $this->createTestTablesWithoutMigrate();
+        $result = \Artisan::call('migrate:dump');
+        $this->assertEquals(0, $result);
+        $this->assertDirectoryExists($this->schemaSqlDirectory);
+        $this->assertFileExists($this->schemaSqlPath);
+        $result_sql = file_get_contents($this->schemaSqlPath);
+        $this->assertRegExp('/CREATE TABLE( IF NOT EXISTS)? "test_ms" /', $result_sql);
+        $this->assertRegExp('/INSERT INTO "?migrations"? /', $result_sql);
+    }
+}

tests/Sqlite/MigrateLoadTest.php

@@ -0,0 +1,26 @@
+<?php
+
+
+namespace OrisIntel\MigrationSnapshot\Tests\Sqlite;
+
+
+class MigrateLoadTest extends SqliteTestCase
+{
+    public function test_handle()
+    {
+        // Make the dump file.
+        $this->createTestTablesWithoutMigrate();
+        $result = \Artisan::call('migrate:dump');
+        $this->assertEquals(0, $result);
+
+        $result = \Artisan::call('migrate:load');
+        $this->assertEquals(0, $result);
+
+        $this->assertEquals(
+            '0000_00_00_000000_create_test_tables',
+            \DB::table('migrations')->value('migration')
+        );
+
+        $this->assertNull(\DB::table('test_ms')->value('name'));
+    }
+}

tests/Sqlite/SqliteTestCase.php

@@ -0,0 +1,17 @@
+<?php
+
+
+namespace OrisIntel\MigrationSnapshot\Tests\Sqlite;
+
+use OrisIntel\MigrationSnapshot\Tests\TestCase;
+
+abstract class SqliteTestCase extends TestCase
+{
+    protected $dbDefault = 'sqlite';
+
+    public static function setUpBeforeClass()
+    {
+        // File must exist before connection will initialize, even if empty.
+        touch(__DIR__ . '/../../vendor/orchestra/testbench-core/laravel/database/database.sqlite');
+    }
+}

tests/TestCase.php

@@ -45,6 +45,7 @@ protected function createTestTablesWithoutMigrate() : void
     {
         // Executing without `loadMigrationsFrom` and without `Artisan::call` to
         // avoid unnecessary runs through migration hooks.
+
         require_once(__DIR__ . '/migrations/setup/0000_00_00_000000_create_test_tables.php');
         \Schema::dropAllTables();
         \Schema::dropAllViews();