coders-tm/laravel-core / .agents/skills/testbench-docs
testbench-package-testing
VerifiedDevelops and tests Laravel packages using Orchestra Testbench. Activates when writing package tests, configuring testbench.yaml, managing migrations, defining routes/environment for tests, using Testbench Dusk for browser tests, or working with Workbench for package preview.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 7.2 KB |
| api-examples.md | markdown | 907 B |
| getting-started.md | markdown | 3.2 KB |
| getting-started/configuration.md | markdown | 5.2 KB |
| markdown-examples.md | markdown | 1.0 KB |
| testbench-dusk.md | markdown | 3.3 KB |
| testbench-dusk/the-basic.md | markdown | 3.3 KB |
| testbench-dusk/troubleshooting.md | markdown | 1.7 KB |
| testbench.md | markdown | 2.7 KB |
| testbench/cli.md | markdown | 1.9 KB |
| testbench/integrations.md | markdown | 2.0 KB |
| testbench/the-basic.md | markdown | 6.4 KB |
| testbench/the-basic/databases.md | markdown | 5.0 KB |
| testbench/the-basic/environment.md | markdown | 4.9 KB |
| testbench/the-basic/routes.md | markdown | 2.3 KB |
| testbench/troubleshooting.md | markdown | 3.5 KB |
| workbench.md | markdown | 1.2 KB |
testbench/the-basic/environment.md
View on GitHub# Define Environment
Testbench utilized `phpunit.xml` configuration and `TestCase` methods and properties to setup environment variables values as global values for every test.
[[toc]]
## `defineEnvironment()` Method
If you need to add something early in the application bootstrapping process (which is executed between registering service providers and booting service providers) you could use the `defineEnvironment()` method:
```php
use Illuminate\Contracts\Config\Repository; # [!code ++]
class TestCase extends \Orchestra\Testbench\TestCase
{
/**
* Define environment setup.
*
* @param \Illuminate\Foundation\Application $app
* @return void
*/
protected function defineEnvironment($app) # [!code ++:18] # [!code focus:18]
{
// Setup default database to use sqlite :memory:
tap($app['config'], function (Repository $config) {
$config->set('database.default', 'testbench');
$config->set('database.connections.testbench', [
'driver' => 'sqlite',
'database' => ':memory:',
'prefix' => '',
]);
// Setup queue database connections.
$config([
'queue.batching.database' => 'testbench',
'queue.failed.database' => 'testbench',
]);
});
}
}
```
::: details FALLBACK METHOD
You can still use predecessor method `getEnvironmentSetup()` for backward compatibility:
```php
/**
* Define environment setup.
*
* @param \Illuminate\Foundation\Application $app
* @return void
*/
protected function getEnvironmentSetup($app) # [!code focus:4]
{
//
}
```
:::
### Using Attribute
You can also use `Orchestra\Testbench\Attributes\DefineEnvironment` attribute to customize the use of `defineEnvironment()` for specific tests.
```php
use Orchestra\Testbench\Attributes\DefineEnvironment; # [!code ++] # [!code focus]
use PHPUnit\Framework\Attributes\Test;
class TestCase extends \Orchestra\Testbench\TestCase
{
protected function usesMySqlConnection($app) # [!code hl:4] # [!code focus:4]
{
$app['config']->set('database.default', 'mysql');
}
protected function usesSqliteConnection($app) # [!code hl:4] # [!code focus:4]
{
$app['config']->set('database.default', 'sqlite');
}
#[Test]
#[DefineEnvironment('usesMySqlConnection')] # [!code ++] # [!code focus]
public function it_can_be_connected_with_mysql()
{
// write your tests
}
#[Test]
#[DefineEnvironment('usesSqliteConnection')] # [!code ++] # [!code focus]
public function it_can_be_connected_with_sqlite()
{
// write your tests
}
}
```
### Using Annotation
::: warning Deprecated
Annotation usage with PHPUnit has been mark as deprecated and will be removed in future versions.
:::
You can also use `@define-env` annotation to customize the use of `defineEnvironment()` for specific tests.
```php
class TestCase extends \Orchestra\Testbench\TestCase
{
protected function usesMySqlConnection($app) # [!code hl:4] # [!code focus:4]
{
$app['config']->set('database.default', 'mysql');
}
protected function usesSqliteConnection($app) # [!code hl:4] # [!code focus:4]
{
$app['config']->set('database.default', 'sqlite');
}
/**
* @test
* @define-env usesMySqlConnection # [!code ++] # [!code focus]
*/
public function it_can_be_connected_with_mysql()
{
// write your tests
}
/**
* @test
* @define-env usesSqliteConnection # [!code ++] # [!code focus]
*/
public function it_can_be_connected_with_sqlite()
{
// write your tests
}
}
```
## Application Key
Most applications would require `APP_KEY` to be defined in order to use encryption:
```xml
<phpunit>
// ...
<php>
<env name="APP_KEY" value="AckfSECXIvnK5r28GVIWUAxmbBSjTsmF"/> # [!code ++] # [!code focus]
</php>
</phpunit>
```
## Application Timezone
You can also easily override the application's default timezone, instead of the default `"UTC"`:
```php
class TestCase extends \Orchestra\Testbench\TestCase
{
/**
* Get the application timezone.
*
* @param \Illuminate\Foundation\Application $app
* @return string|null
*/
protected function getApplicationTimezone($app) # [!code ++:4] # [!code focus:4]
{
return 'Asia/Kuala_Lumpur';
}
}
```
## Using `.env` Environment Variables
By default, Testbench will load `.env` file when booting the application if the file exists. You can change to completely ignores `.env` file by setting `TestCase::$loadEnvironmentVariables` property to `false`:
```php
class TestCase extends \Orchestra\Testbench\TestCase
{
/**
* Automatically loads environment file if available.
*
* @var bool
*/
protected $loadEnvironmentVariables = false; # [!code ++] # [!code focus]
//
}
```
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the work | Stars: 321k | Updated | Claude CodeCodex | Verified | Install |
| systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixes | Stars: 321k | Updated | Claude CodeCodex | Verified | Install |
| test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation code | Stars: 321k | Updated | Claude CodeCodex | Verified | Install |
| skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |