Testbench
Testbench Component for Laravel
Testbench Component bring Laravel Framework testing features to Laravel package.
Installation
You can either update the composer.json file and run composer install or run composer require directly:
{
"require-dev": {
"orchestra/testbench": "~3.0"
}
}
composer require --dev "orchestra/testbench=~3.0"
Usage
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 5.
<?php
class TestCase extends Orchestra\Testbench\TestCase
{
//
}
Custom Service Providers
To load your package service provider, override the getPackageProviders().
<?php
class TestCase extends Orchestra\Testbench\TestCase
{
/* ... */
protected function getPackageProviders($app)
{
return ['Acme\AcmeServiceProvider'];
}
}
Custom Aliases
To load your package alias, override the getPackageAliases.
<?php
class TestCase extends Orchestra\Testbench\TestCase
{
/* ... */
protected function getPackageAliases($app)
{
return [
'Acme' => 'Acme\Facade'
];
}
}
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():
<?php
class TestCase extends Orchestra\Testbench\TestCase
{
/* ... */
protected function setUp()
{
parent::setUp();
// Your code here
}
}
If you need to add something early in the application bootstrapping process, you could use the getEnvironmentSetUp() method:
<?php
class TestCase extends Orchestra\Testbench\TestCase
{
/* ... */
protected function getEnvironmentSetUp($app)
{
# Setup default database to use sqlite :memory:
$app['config']->set('database.default', 'testbench');
$app['config']->set('database.connections.testbench', [
'driver' => 'sqlite',
'database' => ':memory:',
'prefix' => '',
]);
}
}
Overriding Console Kernel
You can easily swap Console Kernel for application bootstrap by overriding resolveApplicationConsoleKernel() method:
<?php
class TestCase extends Orchestra\Testbench\TestCase
{
/* ... */
protected function resolveApplicationConsoleKernel($app)
{
$app->singleton('Illuminate\Contracts\Console\Kernel', 'Acme\Testbench\Console\Kernel');
}
}
Overriding HTTP Kernel
You can easily swap HTTP Kernel for application bootstrap by overriding resolveApplicationHttpKernel() method:
<?php
class TestCase extends Orchestra\Testbench\TestCase
{
/* ... */
protected function resolveApplicationHttpKernel($app)
{
$app->singleton('Illuminate\Contracts\Http\Kernel', 'Acme\Testbench\Http\Kernel');
}
}
Overriding Application Timezone
You can also easily override application default timezone, instead of the default "UTC":
<?php
class TestCase extends Orchestra\Testbench\TestCase
{
/* ... */
protected function getApplicationTimezone($app)
{
return 'Asia/Kuala_Lumpur';
}
}
Using Migrations
Testbench include a custom migrations command that support realpath option instead of the basic relative path option, this would make it easier for you to run database migrations during testing by just including the full realpath to your package database/migration folder.
<?php
class TestCase extends Orchestra\Testbench\TestCase
{
/* ... */
protected function setUp()
{
parent::setUp();
$this->artisan('migrate', [
'--database' => 'testbench',
'--realpath' => realpath(__DIR__.'/../migrations'),
]);
}
}
Using Model Factories
Testbench include withFactories() method to allow you to register custom model factory path for your test suite.
<?php
class TestCase extends Orchestra\Testbench\TestCase
{
/* ... */
protected function setUp()
{
parent::setUp();
$this->withFactories(__DIR__.'/factories');
}
}
Alternative 3rd Party Testing
There also 3rd party packages that extends Testbench Component on CodeCeption and PHPSpec:
Troubleshooting
No supported encrypter found. The cipher and / or key length are invalid.
RuntimeException: No supported encrypter found. The cipher and / or key length are invalid.
This error would only occur if your test suite require actual usage of the encrypter. To solve this you can add a dummy APP_KEY or use a specific key to your application/package phpunit.xml.
<phpunit>
// ...
<php>
<env name="APP_KEY" value="AckfSECXIvnK5r28GVIWUAxmbBSjTsmF"/>
</php>
</phpunit>
Updated less than a minute ago