thecrypticace/suitey

Artisan command to run middleware-like hooks during phpunit tests

Suitey

Set up the world. Run code before and after PHPUnit., _(*1)

, _(*2)

Installation

1. composer require thecrypticace/suitey
2. php artisan vendor:publish --tag=suitey
3. Update steps list to configure and run the steps you want before your tests.

Usage

Run your tests with the test artisan command:, _(*3)

php artisan test

This also accepts any parameter that PHPUnit does:, _(*4)

php artisan test --filter=my_test_method_name

Want to pass arguments to artisan before PHPUnit? Use a -- to separate the two lists:, _(*5)

php artisan test -vvv -- --filter=my_test_method_name

Adding steps

When you run php artisan test you'll be running one step: PHPUnit. You'll can see this because you will get output that looks like this:, _(*6)

[1/1] Run PHPUnit
… test details here …

Lets fix that., _(*7)

Publishing the config

Run php artisan vendor:publish --tag=suitey to publish the config file. This file is where you can detail what steps run and how to load the test environment variables for tests., _(*8)

Adding steps

In the config for Suitey you will see a steps array that looks like this:, _(*9)

"steps" => [
    // \TheCrypticAce\Suitey\MigrateDatabase::class,
    // \TheCrypticAce\Suitey\RefreshDatabase::class,
    // [
    //     "class" => \TheCrypticAce\Suitey\SeedDatabase::class,
    //     "options" => ["class" => "ExampleSeeder"],
    // ]
],

Uncomment the MigrateDatabase step and your database migrations will run before your tests., _(*10)

"steps" => [
    \TheCrypticAce\Suitey\MigrateDatabase::class,

    // \TheCrypticAce\Suitey\RefreshDatabase::class,
    // [
    //     "class" => \TheCrypticAce\Suitey\SeedDatabase::class,
    //     "options" => ["class" => "ExampleSeeder"],
    // ]
],

Note: You may resolve the class through the container instead of using the facade if your wish., _(*11)

Your migrations will now run before your test runs. Don't forget to remove the DatabaseMigrations trait from your tests., _(*12)

This step is configurable if your have an atypical setup. You may optionally specify a connection name and/or a path to your migrations., _(*13)

"steps" => [
    [
        "class" => \TheCrypticAce\Suitey\MigrateDatabase::class,
        "options" => ["database" => "connection_name", "path" => "path_to_migrations"],
    ],
],

And if you have more than one migration folder:, _(*14)

"steps" => [
    [
        "class" => \TheCrypticAce\Suitey\MigrateDatabase::class,
        "options" => ["database" => "foo", "path" => "database/migrations/foo"],
    ],
    [
        "class" => \TheCrypticAce\Suitey\MigrateDatabase::class,
        "options" => ["database" => "bar", "path" => "database/migrations/bar"],
    ],
    [
        "class" => \TheCrypticAce\Suitey\MigrateDatabase::class,
        "options" => ["database" => "baz", "path" => "database/migrations/baz"],
    ],
],

Available Steps

Want to see something meta?

Suitey can run its own tests: ./tests/Fixture/artisan test, _(*15)