web-chefs/laravel-app-spawn

Laravel custom application instance bootstrap creator. Used predominantly for doing Laravel specific testing.

1.6 2021-09-20 11:38 UTC

Requires

• php: ^7.0|^8.0
• laravel/framework: >=5.3

Requires (Dev)

• phpunit/phpunit: ^7.5.15|^8.4|^9.3.3

MIT

• Justin Fossey

• logging
• database
• debugging
• test
• laravel

README

Laravel Custom Application Spawner is primarily used for creating a Application instance in a unit testing environment, allowing you to interact with Laravel in your tests.

By default it will use a SQLite in memory database, allowing you to run migrations and use a fully functional database during your tests.

It is up to you to migration and seed this test database.

Install

Via Composer

$ composer require web-chefs/laravel-app-spawn --dev

Basic usage example

use Illuminate\Foundation\Testing\TestCase;
use WebChefs\LaraAppSpawn\ApplicationResolver;

class MyTest extends TestCase
{
    /**
     * Creates the application.
     *
     * @return \Illuminate\Foundation\Application
     */
    public function createApplication()
    {
        // Root of my app, used as a fallback for location of /database when
        // database.path in config is null.
        $appRoutePath = __DIR__;

        // Resolve Application
        $resolver  = ApplicationResolver::makeApp($appRoutePath);
        $this->app = $resolver->app();

        // Run our database migrations if required
        $this->artisan('migrate:refresh', [ '--force' => 1 ]);

        return $this->app;
    }

}

Example with custom configs

use Illuminate\Support\Arr;
use Illuminate\Foundation\Testing\TestCase;
use WebChefs\LaraAppSpawn\ApplicationResolver;

class MyTest extends TestCase
{
    /**
     * Creates the application.
     *
     * @return \Illuminate\Foundation\Application
     */
    public function createApplication()
    {
        // Root of my app, used as a fallback for location of /database when
        // database.path in config is null.
        $appRoutePath = __DIR__;

        // Build Resolver config
        $config = ApplicationResolver::defaultConfig();
        Arr::set($config, 'database.connection', $this->connectionName);
        Arr::set($config, 'queue.connection', $this->connectionName);

        // Resolve Application
        $resolver  = ApplicationResolver::makeApp($appRoutePath, $config);
        $this->app = $resolver->app();

        // Run our database migrations if required
        $this->artisan('migrate:refresh', [ '--force' => 1 ]);

        return $this->app;
    }

}

TravisCI

This was originally developed for WebChefs\QueueButler and for testing multiple version of Laravel using the same tests.

To see how that is possible see WebChefs\QueueButler .travis.yml.

Contributing

All code submissions will only be evaluated and accepted as pull-requests. If you have any questions or find any bugs please feel free to open an issue.

Credits

• All Contributors

License

The MIT License (MIT). Please see License File for more information.