TestCase

To use Testbench Component, all you need to do is extend Orchestra\Testbench\TestCase instead of PHPUnit\Framework\TestCase. The fixture app booted by Orchestra\Testbench\TestCase is predefined to follow the base application skeleton of Laravel.

<?php

namespace Tests;

class TestCase extends \Orchestra\Testbench\TestCase
{
    //
}

• Package Service Providers
• Package Aliases
• Package Auto-Discovery
• Overriding Default Service Providers
• Overriding setUp() method
• Overriding Console Kernel
• Overriding HTTP Kernel
• Testing Blade components

Package Service Providers

To load your package service provider, override the getPackageProviders.

/**
 * Get package providers.
 *
 * @param  \Illuminate\Foundation\Application  $app
 *
 * @return array<int, string>
 */
protected function getPackageProviders($app)
{
    return [
        'Acme\AcmeServiceProvider',
    ];
}

Package Aliases

To load your package alias, override the getPackageAliases.

/**
 * Override application aliases.
 *
 * @param  \Illuminate\Foundation\Application  $app
 *
 * @return array<string, string>
 */
protected function getPackageAliases($app)
{
    return [
        'Acme' => 'Acme\Facade',
    ];
}

Package Auto-Discovery

By default Testbench doesn't enable any package discovery autoloading when running tests, however you can change this to ignore specific package using:

/**
 * Ignore package discovery from.
 *
 * @return array<int, string>
 */
public function ignorePackageDiscoveriesFrom()
{
    return ['laravel/passport'];
}

You may also enable auto discovery for all vendor packages using the following:

/**
 * Ignore package discovery from.
 *
 * @return array<int, array>
 */
public function ignorePackageDiscoveriesFrom()
{
    return [];
}

You can also enable auto discovery globally by setting the following property to your TestCase class:

/**
 * Automatically enables package discoveries.
 *
 * @var bool
 */
protected $enablesPackageDiscoveries = true;

Be aware that root package doesn't automate using package discovery and you need to define it using Package Service Providers or registering it to the application using ./vendor/bin/testbench package:discover command.

Overriding Default Service Providers

You can also override the default application using the following commands:

/**
 * Get package providers.
 *
 * @param  \Illuminate\Foundation\Application  $app
 *
 * @return array<string, string>
 */
protected function overrideApplicationBindings($app)
{
    return [
        'Illuminate\View\ViewServiceProvider' => 'Acme\ViewServiceProvider',
    ];
}

Overriding setUp() method

Since Orchestra\Testbench\TestCase replace Laravel's Illuminate\Foundation\Testing\TestCase, if you need your own setUp() implementation, do not forget to call parent::setUp() and make sure proper declaration compatibility:

/**
 * Setup the test environment.
 */
protected function setUp(): void
{
    // Code before application created.

    parent::setUp();

    // Code after application created.
}

Overriding Console Kernel

You can easily swap Console Kernel for application bootstrap by overriding resolveApplicationConsoleKernel() method:

/**
 * Resolve application Console Kernel implementation.
 *
 * @param  \Illuminate\Foundation\Application  $app
 * @return void
 */
protected function resolveApplicationConsoleKernel($app)
{
    $app->singleton('Illuminate\Contracts\Console\Kernel', 'Tests\Console\Kernel');
}

Overriding HTTP Kernel

You can easily swap HTTP Kernel for application bootstrap by overriding resolveApplicationHttpKernel() method:

/**
 * Resolve application HTTP Kernel implementation.
 *
 * @param  \Illuminate\Foundation\Application  $app
 * @return void
 */
protected function resolveApplicationHttpKernel($app)
{
    $app->singleton('Illuminate\Contracts\Http\Kernel', 'Tests\Http\Kernel');
}

Testing Blade components

You can easily test blade components with Laravel's Illuminate\Foundation\Testing\Concerns\InteractsWithViews trait.

<?php

namespace Tests;

use Illuminate\Foundation\Testing\Concerns\InteractsWithViews;

class TestCase extends \Orchestra\Testbench\TestCase
{
    use InteractsWithViews;
}