RefreshDatabaseFast Trait

Author: Sairahcaz

README.md

@@ -16,6 +16,12 @@ You can install the package via composer:
 composer require laracraft-tech/laravel-useful-traits
 ```
 
+Then publish the config file with:
+
+```bash
+php artisan vendor:publish --tag="laravel-useful-traits-config"
+```
+
 ## Usage
 
 The following traits are provided in the `LaracraftTech`-namespace:
@@ -127,6 +133,48 @@ $class::select('foo')->fromYesterday()->first()->toArray();
 // return ['foo' => 'foo2']
 ```
 
+### RefreshDatabaseFast
+
+---
+
+Credits to [Mayahi](https://mayahi.net/laravel/make-refresh-database-trait-much-faster/).
+
+This is a trait which makes the migration of your database in your test suite much, much faster!
+It basically only migrates your database if the migration files has changed.
+So the first `migrate:fresh` takes awhile (depending on how many migrations you have), and then it's incredible fast.
+
+Optionally you can set `USEFUL_TRAITS_SEED_AFTER_FAST_DB_REFRESH` to `true` if you like to seed your database after the migration.
+
+***Pest:***
+```php
+// Pest.php
+
+use LaracraftTech\LaravelUsefulTraits\RefreshDatabaseFast;
+use Tests\TestCase;
+
+uses(
+    Tests\TestCase::class,
+     RefreshDatabaseCustom::class
+)->in('Feature');
+```
+
+***PHPUnit:***
+```php
+use LaracraftTech\LaravelUsefulTraits\RefreshDatabaseFast;
+use Tests\TestCase;
+
+class MyTest extends TestCase
+{
+    use RefreshDatabaseFast;
+    
+    /** @test **/
+    public function it_does_something()
+    {
+        // ...
+    }
+}
+```
+
 ## Testing
 
 ```bash

config/useful-traits.php

@@ -1,6 +1,10 @@
 <?php
 
-// config for LaracraftTech/LaravelUsefulTraits
 return [
-
+    "refresh_db_fast" => [
+        /**
+         * This field determines if the database should be seeded after migration.
+         */
+        "seed" => env('USEFUL_TRAITS_SEED_AFTER_FAST_DB_REFRESH', false),
+    ],
 ];

src/LaravelUsefulTraitsServiceProvider.php

@@ -15,6 +15,8 @@ public function configurePackage(Package $package): void
          * More info: https://github.com/spatie/laravel-package-tools
          */
         $package
-            ->name('laravel-useful-traits');
+            ->name('laravel-useful-traits')
+            ->hasConfigFile()
+        ;
     }
 }

src/RefreshDatabaseFast.php

@@ -0,0 +1,140 @@
+<?php
+
+namespace LaracraftTech\LaravelUsefulTraits;
+
+use Illuminate\Contracts\Console\Kernel;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Foundation\Testing\RefreshDatabaseState;
+use Symfony\Component\Finder\Finder;
+
+/**
+ * Only migrate fresh if necessary -> much faster after first time!
+ * Credits to mayahi, with some small changes of mine.
+ * @link https://mayahi.net/laravel/make-refresh-database-trait-much-faster/
+ */
+trait RefreshDatabaseFast
+{
+    use RefreshDatabase;
+
+    /**
+     * Only migrates fresh if necessary
+     *
+     * @return void
+     */
+    protected function refreshTestDatabase(): void
+    {
+        if (! RefreshDatabaseState::$migrated) {
+            $this->runMigrationsIfNecessary();
+
+            $this->app[Kernel::class]->setArtisan(null);
+
+            RefreshDatabaseState::$migrated = true;
+        }
+
+        $this->beginDatabaseTransaction();
+    }
+
+    /**
+     * Check if migration fresh is necessary by checking
+     * if the migrations files checksum has changed.
+     *
+     * @return void
+     */
+    protected function runMigrationsIfNecessary(): void
+    {
+        if (!$this->identicalChecksum()) {
+            if (config('useful-traits.refresh_db_fast.seed')) {
+                $this->seed();
+            }
+
+            $this->artisan('migrate:fresh', $this->migrateFreshUsing());
+
+            //create checksum after migration finishes
+            $this->createChecksum();
+        }
+    }
+
+    /**
+     * Calaculates the checksum of the migration files.
+     *
+     * @return string
+     */
+    private function calculateChecksum(): string
+    {
+        $files = Finder::create()
+            ->files()
+            ->exclude([
+                'factories',
+                'seeders',
+            ])
+            ->in(database_path())
+            ->ignoreDotFiles(true)
+            ->ignoreVCS(true)
+            ->getIterator();
+
+        $files = array_keys(iterator_to_array($files));
+
+        $checksum = collect($files)->map(function($file) {return md5_file($file);})->implode('');
+
+        return md5($checksum);
+    }
+
+    /**
+     * Filepath to store the checksum.
+     *
+     * @return string
+     */
+    private function checksumFilePath(): string
+    {
+        return base_path('.phpunit.database.checksum');
+    }
+
+    /**
+     * Creates the checksum file.
+     *
+     * @return void
+     */
+    private function createChecksum(): void
+    {
+        file_put_contents($this->checksumFilePath(), $this->calculateChecksum());
+    }
+
+    /**
+     * Get the checksum file content.
+     *
+     * @return false|string
+     */
+    private function checksumFileContents()
+    {
+        return file_get_contents($this->checksumFilePath());
+    }
+
+    /**
+     * Check if checksum exists.
+     *
+     * @return bool
+     */
+    private function isChecksumExists(): bool
+    {
+        return file_exists($this->checksumFilePath());
+    }
+
+    /**
+     * Check if checksum of current database migration files
+     * are identical to the one we stored already.
+     *
+     * @return bool
+     */
+    private function identicalChecksum(): bool
+    {
+        if (!$this->isChecksumExists()) {
+            return false;
+        }
+
+        if ($this->checksumFileContents() === $this->calculateChecksum()) {
+            return true;
+        }
+
+        return false;
+    }
+}

tests/Pest.php

@@ -1,8 +1,9 @@
 <?php
 
 use Illuminate\Foundation\Testing\RefreshDatabase;
+use LaracraftTech\LaravelUsefulTraits\RefreshDatabaseFast;
 use LaracraftTech\LaravelUsefulTraits\Tests\TestCase;
 
-uses(RefreshDatabase::class);
+uses(RefreshDatabaseFast::class);
 
 uses(TestCase::class)->in(__DIR__);