Pest Plugin Laravel

https://github.com/pestphp/pest-plugin-laravel
Admin
Pest Plugin Laravel is a testing framework plugin that integrates Pest testing capabilities with...
Tokens:43,197
Snippets:471
Trust Score:9.6
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### get usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Example usage of the get function. It sends a GET request to '/' and asserts the response is OK and contains 'Welcome'.

```php
use function Pest\Laravel\get;

test('home page renders', function () {
    get('/')->assertOk()->assertSee('Welcome');
});
```

--------------------------------

### Artisan commands usage examples

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/service-provider.md

Example artisan commands available after the provider is registered. pest:dusk is only available when laravel/dusk is installed.

```bash
php artisan pest:test users --unit
php artisan pest:dataset orders
php artisan pest:dusk --browse         # only when laravel/dusk is installed
```

--------------------------------

### startSession usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/session.md

Example usage of startSession. Starts the session and chains a request. Also shows that arguments are forwarded even though the wrapper declares none.

```php
use function Pest\Laravel\startSession;

startSession()->get('/')->assertOk();

// Arguments are forwarded even though the wrapper declares none:
startSession(['foo' => 'bar'])->assertGuest();
```

--------------------------------

### session usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/session.md

Example usage of session. Sets session data and chains a GET request with an assertion.

```php
use function Pest\Laravel\session;

session(['cart' => ['item-1' => 2]])->get('/cart')->assertOk();
```

--------------------------------

### withDefer usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/container.md

Usage example for withDefer. It restores deferred callbacks and then performs a GET request to '/' expecting a 200 status.

```php
use function Pest\Laravel\withDefer;

withDefer()->get('/')->assertOk();
```

--------------------------------

### withMix usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/container.md

Usage example for withMix. It restores Laravel Mix and then performs a GET request to '/' expecting a 200 status.

```php
use function Pest\Laravel\withMix;

withMix()->get('/')->assertOk();
```

--------------------------------

### getConnection usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/database.md

Example usage of getConnection. It resolves the default connection and runs a query.

```php
use function Pest\Laravel\getConnection;

getConnection()->query('select 1');
```

--------------------------------

### post usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Example of using the post helper to send a POST request and assert a redirect.

```php
use function Pest\Laravel\post;

post('/users', ['name' => 'Nuno'])->assertRedirectedTo('/users');
```

--------------------------------

### withSession usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/session.md

Example usage of withSession. Sets session data and chains a GET request with an assertion.

```php
use function Pest\Laravel\withSession;

withSession(['user_id' => $user->id, 'locale' => 'en'])
    ->get('/profile')
    ->assertSee('Profile');
```

--------------------------------

### instance usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/container.md

Example of using the instance function to register a fake mailer instance.

```php
use function Pest\Laravel\instance;

instance(Mailer::class, FakeMailer::new());
```

--------------------------------

### withMiddleware usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Example of enabling a specific middleware after disabling all middleware, then making a request and asserting a redirect.

```php
withoutMiddleware()->withMiddleware('auth')->get('/private')->assertRedirectedTo('/login');
```

--------------------------------

### withoutMiddleware usage examples

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Examples of disabling all, a single, or a list of middleware for a test request.

```php
withoutMiddleware()->get('/')->assertSee('laravel');          // all middleware
withoutMiddleware('auth')->get('/private')->assertOk();       // single middleware
withoutMiddleware(['auth', 'throttle'])->get('/private')->assertOk();
```

--------------------------------

### swap usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/container.md

Example of using the swap function to register a service instance and then make a request.

```php
use function Pest\Laravel\swap;

$service = Service::new(['api_url' => 'https://example.test']);
swap(Service::class, $service);

get('/')->assertOk();
```

--------------------------------

### Install dev dependencies with composer install

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/CONTRIBUTING.md

Installs the development dependencies after cloning the fork.

```bash
composer install
```

--------------------------------

### withVite() usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/container.md

Shows how to use withVite() in a Pest test. It imports the function and chains it with a GET request to assert a successful response.

```php
use function Pest\Laravel\withVite;

withVite()->get('/')->assertOk();
```

--------------------------------

### flushHeaders usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Example usage of flushHeaders. Sets a header, flushes all headers, and then sends a GET request to '/'. The header is removed before the request.

```php
withHeaders(['X-Debug' => '1'])->flushHeaders()->get('/');
```

--------------------------------

### withoutDefer usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/container.md

Usage example for withoutDefer. It disables deferred callbacks and then performs a GET request to '/' expecting a 200 status.

```php
use function Pest\Laravel\withoutDefer;

withoutDefer()->get('/')->assertOk();
```

--------------------------------

### put usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Example of using the put helper to send a PUT request.

```php
use function Pest\Laravel\put;

put('/users/1', ['name' => 'Nuno']);
```

--------------------------------

### withHeader usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Example usage of withHeader to add a single header, here a UUID as the X-Request-ID, and chain it with a get request.

```php
withHeader('X-Request-ID', (string) Str::uuid())->get('/');
```

--------------------------------

### withoutMix usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/container.md

Usage example for withoutMix. It disables Laravel Mix and then performs a GET request to '/' expecting a 200 status.

```php
use function Pest\Laravel\withoutMix;

withoutMix()->get('/')->assertOk();
```

--------------------------------

### withServerVariables usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Example usage of withServerVariables to set the REMOTE_ADDR server variable before making a GET request.

```php
withServerVariables(['REMOTE_ADDR' => '10.4.4.4'])->get('/');
```

--------------------------------

### flushSession usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/session.md

Example usage of flushSession. Sets session data, flushes it, and asserts the guest state.

```php
use function Pest\Laravel\flushSession;

withSession(['user_id' => 1])->flushSession()->assertGuest();
```

--------------------------------

### startSession()

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/session.md

Starts the session for the application. Returns the test case for chaining. Although the wrapper declares no parameters, it forwards `...func_get_args()` to `TestCase::startSession`, so extra arguments are passed through.

```APIDOC
## `startSession()`

### Description
Starts the session for the application. Returns the test case for chaining. Although the wrapper declares no parameters, it forwards `...func_get_args()` to `TestCase::startSession`, so extra arguments are passed through.

### Method
Function call

### Endpoint
`Pest\Laravel\startSession`

### Parameters
None declared. Extra arguments are forwarded to `TestCase::startSession`.

### Returns
`TestCase`

### Example
```php
use function Pest\Laravel\startSession;

startSession()->get('/')->assertOk();

// Arguments are forwarded even though the wrapper declares none:
startSession(['foo' => 'bar'])->assertGuest();
```
```

--------------------------------

### spy() usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/container.md

Example usage of spy(). After posting to /signup, asserts that the send method was called once.

```php
use function Pest\Laravel\spy;

$mailer = spy(Mailer::class);
post('/signup', ['email' => 'a@b.c'])->assertOk();

$mailer->shouldHaveReceived('send')->once();
```

--------------------------------

### pest:dataset usage examples

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/commands.md

Shows example invocations of the pest:dataset command, including the default test directory and a custom --test-directory option.

```bash
php artisan pest:dataset orders          # tests/Datasets/Orders.php
php artisan pest:dataset orders --test-directory=spec
```

--------------------------------

### options() helper for HTTP OPTIONS requests

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Signature and usage example for the options helper. It sends an HTTP OPTIONS request and returns an Illuminate\Testing\TestResponse. The example chains assertOk() to verify the response status.

```php
function options(string $uri, array $data = [], array $headers = [])
```

```php
use function Pest\Laravel\options;

options('/users')->assertOk();
```

--------------------------------

### withExceptionHandling() usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/exception-handling.md

Shows how to use withExceptionHandling() to restore exception handling for a request. The example sends a GET request to '/boom' and asserts a 500 status, implying the exception is rendered by the handler.

```php
use function Pest\Laravel\withExceptionHandling;

withExceptionHandling()->get('/boom')->assertStatus(500);
```

--------------------------------

### Import and use Pest Laravel get helper

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/index.md

Example of importing and using the Pest Laravel helper function `get` to make a request and assert the response contains 'laravel'.

```php
<?php

use function Pest\Laravel\get;

get('/')->assertSee('laravel');
```

--------------------------------

### withBasicAuth usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Example usage of withBasicAuth. Sends a request to '/admin' with basic authentication credentials and asserts a 200 OK response.

```php
withBasicAuth('admin', 'p4ss')->get('/admin')->assertOk();
```

--------------------------------

### seed usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/database.md

Example usage of the seed function, including default seeder and a single seeder class.

```php
use function Pest\Laravel\seed;

seed();                                  // default seeder
seed('Database\Seeders\UsersSeeder');    // single seeder class
```

--------------------------------

### assertDatabaseEmpty usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/database.md

Example of using assertDatabaseEmpty to assert that the 'users' table has no entries.

```php
use function Pest\Laravel\assertDatabaseEmpty;

assertDatabaseEmpty('users');
```

--------------------------------

### travelBack usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/time.md

Example of using travelTo and travelBack to travel to the past, perform assertions, and then travel back.

```php
use function Pest\Laravel\travelTo;
use function Pest\Laravel\travelBack;

travelTo('1999-12-31');
// ... assertions in the past ...
travelBack();
```

--------------------------------

### Example pest:dusk command invocations

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/commands.md

Shows example invocations of the pest:dusk command: headless mode, with --browse to open a browser, and with --without-tty to disable TTY output.

```bash
php artisan pest:dusk                 # headless
php artisan pest:dusk --browse        # with an open browser
php artisan pest:dusk --without-tty
```

--------------------------------

### getJson usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Example usage of the getJson function. It sends a GET request to '/api/user' and asserts the JSON response has a 'name' field equal to 'Nuno'.

```php
use function Pest\Laravel\getJson;

getJson('/api/user')->assertJsonPath('name', 'Nuno');
```

--------------------------------

### withoutVite() usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/container.md

Shows how to use withoutVite() in a Pest test. It imports the function and chains it with a GET request to assert a successful response.

```php
use function Pest\Laravel\withoutVite;

withoutVite()->get('/')->assertOk();
```

--------------------------------

### expectsDatabaseQueryCount usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/database.md

Example usage of expectsDatabaseQueryCount, including a passing case and a commented failing case.

```php
use function Pest\Laravel\expectsDatabaseQueryCount;

expectsDatabaseQueryCount(2)->get('/users');

// fails the test when query count differs:
// expectsDatabaseQueryCount(99)->get('/users');
```

--------------------------------

### travel usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/time.md

Example of using travel to move one hour into the future and then making a request.

```php
use function Pest\Laravel\travel;

travel(3600); // one hour into the future
get('/now')->assertSee(tomorrow()->format('Y-m-d H:i:s'));
```

--------------------------------

### Usage examples for pest:test

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/commands.md

Examples of using the pest:test command to create feature, unit, and dusk tests, with options for force overwrite and custom test directory.

```bash
php artisan pest:test users              # tests/Feature/Users.php
php artisan pest:test users --unit       # tests/Unit/Users.php
php artisan pest:test users --dusk       # tests/Browser/Users.php
php artisan pest:test users --force      # overwrite existing file
php artisan pest:test UserTest.php --test-directory=spec
```

--------------------------------

### assertDatabaseCount usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/database.md

Example usage of assertDatabaseCount. It asserts zero users, creates a user, then asserts one user. The User::create argument shape follows tests/Database/assertDatabaseCount.php:16-21.

```php
use function Pest\Laravel\assertDatabaseCount;

assertDatabaseCount('users', 0);

User::create([
    'name' => 'test user',
    'email' => 'email@test.xx',
    'password' => Hash::make('password'),
]);

assertDatabaseCount('users', 1);
```

--------------------------------

### postJson usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Example of using the postJson helper to send a JSON POST request and assert a created response.

```php
use function Pest\Laravel\postJson;

postJson('/api/users', ['name' => 'Nuno'])->assertCreated();
```

--------------------------------

### startSession function declaration

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/session.md

Declares the startSession helper. It starts the session for the application and returns the test case. Although it declares no parameters, it forwards extra arguments to TestCase::startSession.

```php
function startSession()
```

--------------------------------

### head helper signature and usage

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Function signature for head. The example shows how to use the helper to send an HTTP HEAD request and assert it is OK.

```php
function head(string $uri, array $headers = [])
```

```php
use function Pest\Laravel\head;

head('/users')->assertOk();
```

--------------------------------

### assertGuest usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/authentication.md

Example usage of assertGuest. It imports the function and calls it without arguments to assert the user is not authenticated.

```php
use function Pest\Laravel\assertGuest;

assertGuest();
```

--------------------------------

### partialMock() usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/container.md

Example usage of partialMock(). Only the now() method is stubbed; other methods retain their real behavior.

```php
use function Pest\Laravel\partialMock;

$clock = partialMock(Clock::class, function () {
    $this->shouldReceive('now')->andReturn(today());
});
```

--------------------------------

### handleValidationExceptions() usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/exception-handling.md

Shows using handleValidationExceptions() to handle validation exceptions. The example posts to '/users' with an empty name and asserts a 422 status.

```php
use function Pest\Laravel\handleValidationExceptions;

post('/users', ['name' => ''])->assertStatus(422);
```

--------------------------------

### isAuthenticated usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/authentication.md

Example usage of isAuthenticated. It checks if the user is authenticated and then makes a request to a private route.

```php
use function Pest\Laravel\isAuthenticated;

if (isAuthenticated()) {
    get('/private')->assertOk();
}
```

--------------------------------

### freezeSecond usage with callback

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/time.md

Example of using freezeSecond to freeze time at the beginning of the current second, then making a request.

```php
use function Pest\Laravel\freezeSecond;

freezeSecond(function () {
    get('/')->assertSee('Generated at: 12:00:00');
});
```

--------------------------------

### get(string $uri, array $headers = [])

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Executes a GET request against the application under test and returns Laravel's `Illuminate\Testing\TestResponse`. Forwards arguments to the identically named method on `Illuminate\Foundation\Testing\TestCase`.

```APIDOC
## GET /

### Description
Executes a GET request against the application under test and returns Laravel's `Illuminate\Testing\TestResponse`.

### Method
GET

### Endpoint
`{uri}`

### Parameters
#### Path Parameters
- **uri** (string) - Required - URI to visit with a GET request

#### Query Parameters
- **headers** (array) - Optional - Additional headers sent with the request

### Request Example
```php
use function Pest\Laravel\get;

test('home page renders', function () {
    get('/')->assertOk()->assertSee('Welcome');
});
```

### Response
#### Success Response (200)
Returns `Illuminate\Testing\TestResponse`.

```

--------------------------------

### mock() usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/container.md

Example usage of mock(). The closure configures the mock; calls to send() are intercepted and return true.

```php
use function Pest\Laravel\mock;

$client = mock(Client::class, function () {
    $this->shouldReceive('send')->andReturn(true);
});

$client->send('ping'); // intercepted by the mock
```

--------------------------------

### isSoftDeletableModel usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/database.md

Example usage of isSoftDeletableModel. It returns true for a SoftDeletes model and false for a string.

```php
use function Pest\Laravel\isSoftDeletableModel;

isSoftDeletableModel($user);   // true for a SoftDeletes model
isSoftDeletableModel('users'); // false
```

--------------------------------

### assertAuthenticatedAs usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/authentication.md

Example usage of assertAuthenticatedAs. It imports the function and asserts the session is authenticated as the given user.

```php
use function Pest\Laravel\assertAuthenticatedAs;

assertAuthenticatedAs($user);
```

--------------------------------

### call() with file upload

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Example of using the `call` helper to send a POST request with a file upload. The `UploadedFile::fake()->createWithContent('hello')` creates a fake file for testing. The response is asserted with `assertOk()`.

```php
use function Pest\Laravel\call;

call('POST', '/upload', ['note' => 'hello'], [], [
    'file' => UploadedFile::fake()->createWithContent('hello'), // Laravel file factory
])->assertOk();
```

--------------------------------

### assertSoftDeleted usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/database.md

Example usage of assertSoftDeleted. It creates a SoftDeletableUser, deletes it, then asserts it is soft deleted.

```php
use function Pest\Laravel\assertSoftDeleted;

$user = SoftDeletableUser::create(['name' => 'Nuno']);
$user->delete();

assertSoftDeleted($user);
```

--------------------------------

### assertModelExists usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/database.md

Example of using assertModelExists to assert that a created user model exists in the database.

```php
use function Pest\Laravel\assertModelExists;

$user = User::create(['name' => 'Nuno']);
assertModelExists($user);
```

--------------------------------

### putJson usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Example of using the putJson helper to send a JSON PUT request and assert an OK response.

```php
use function Pest\Laravel\putJson;

putJson('/api/users/1', ['name' => 'Nuno'])->assertOk();
```

--------------------------------

### forgetMock usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/container.md

Usage example for forgetMock. After calling forgetMock(Client::class), subsequent resolutions use the real binding.

```php
use function Pest\Laravel\forgetMock;

forgetMock(Client::class); // subsequent resolutions use the real binding
```

--------------------------------

### handleExceptions() usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/exception-handling.md

Demonstrates using handleExceptions() to handle only NotFoundException. The first request to '/missing' asserts a 404, while the second request to '/fail' will re-throw any other exception, causing the test to fail.

```php
use function Pest\Laravel\handleExceptions;

handleExceptions([NotFoundException::class])->get('/missing')->assertNotFound();

// Any other exception is re-thrown instead of rendered:
handleExceptions([NotFoundException::class])->post('/fail')->assertOk();
// -> the original exception fails the test
```

--------------------------------

### assertDatabaseHas usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/database.md

Example usage of assertDatabaseHas. It creates a user and then asserts that a row with the user's id exists in the users table.

```php
use function Pest\Laravel\assertDatabaseHas;

$user = User::create(['name' => 'Nuno', 'email' => 'nuno@example.com', 'password' => 'secret']);
assertDatabaseHas('users', ['id' => $user->id]);
```

--------------------------------

### withoutToken usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Example usage of withoutToken. Adds a token, then removes it, and asserts that the request to '/me' returns 401 Unauthorized.

```php
withToken('secret-token')
    ->withoutToken()
    ->get('/me')
    ->assertUnauthorized();
```

--------------------------------

### assertDatabaseMissing usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/database.md

Example usage of assertDatabaseMissing. It asserts that no user with the email 'ghost@example.com' exists in the users table.

```php
use function Pest\Laravel\assertDatabaseMissing;

assertDatabaseMissing('users', ['email' => 'ghost@example.com']);
```

--------------------------------

### delete() helper for HTTP DELETE requests

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Signature and usage example for the delete helper. It sends an HTTP DELETE request and returns an Illuminate\Testing\TestResponse. The example chains assertNoContent() to verify a 204 response.

```php
function delete(string $uri, array $data = [], array $headers = [])
```

```php
use function Pest\Laravel\delete;

delete('/users/1')->assertNoContent();
```

--------------------------------

### patch() helper for HTTP PATCH requests

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Signature and usage example for the patch helper. It sends an HTTP PATCH request and returns an Illuminate\Testing\TestResponse. The example shows how to import and call the function with a URI and data array.

```php
function patch(string $uri, array $data = [], array $headers = [])
```

```php
use function Pest\Laravel\patch;

patch('/users/1', ['name' => 'Nuno']);
```

--------------------------------

### Pest CLI usage for exception and deprecation handling

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/plugin.md

CLI usage examples showing how to pass the plugin's arguments to Pest. The first re-throws exceptions so tests fail, the second makes deprecations fail the run.

```bash
# Exceptions are re-thrown so tests fail on them
vendor/bin/pest --without-exception-handling
```

```bash
# Deprecations fail the run
vendor/bin/pest --without-deprecation-handling
```

--------------------------------

### assertNotSoftDeleted usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/database.md

Example usage of assertNotSoftDeleted. It imports the function and asserts that a user created with SoftDeletableUser is not soft deleted.

```php
use function Pest\Laravel\assertNotSoftDeleted;

$user = SoftDeletableUser::create(['name' => 'Nuno']);
assertNotSoftDeleted($user);
```

--------------------------------

### withHeaders usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Example usage of withHeaders to set headers for a JSON request and then re-define headers in a later test. The comment indicates that headers are flushed and re-defined.

```php
withHeaders(['Accept' => 'application/json'])->getJson('/api');

// Flush and re-define in a later test
withHeaders(['Accept' => 'text/html'])->get('/');
```

--------------------------------

### withToken usage examples

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Example usage of withToken. The first call uses the default 'Bearer' type and expects a 200 OK response. The second call uses 'Basic' type and expects a 401 Unauthorized response.

```php
withToken('secret-token')->get('/me')->assertOk();

withToken('abc', 'Basic')->get('/me')->assertUnauthorized();
```

--------------------------------

### optionsJson helper signature and usage

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Function signature for optionsJson. The example shows how to use the helper to send an HTTP OPTIONS request expecting a JSON response and assert it is OK.

```php
function optionsJson(string $uri, array $data = [], array $headers = [])
```

```php
use function Pest\Laravel\optionsJson;

optionsJson('/api/users')->assertOk();
```

--------------------------------

### Global helper wrapper forwarding to test case

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/index.md

Shows the facade/delegation pattern used by every global helper in the plugin. The wrapper forwards all arguments to the active test case via test()->get(...func_get_args()).

```php
function get(string $uri, array $headers = [])
{
    return test()->get(...func_get_args());
}
```

--------------------------------

### Chain withHeaders with a verb

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Shows how to use the withHeaders helper to set request headers and chain it with a verb like get, then assert the response. The helpers return Illuminate\Foundation\Testing\TestCase, making them chainable.

```php
use function Pest\Laravel\withHeaders;
use function Pest\Laravel\get;

withHeaders(['X-Request-ID' => 'abc'])->get('/')->assertOk();
```

--------------------------------

### json helper signature and usage

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Function signature for json. The example shows how to use the helper to send a JSON request with a custom method and assert the response.

```php
function json(string $method, string $uri, array $data = [], array $headers = [])
```

```php
use function Pest\Laravel\json;

json('POST', '/api/users', ['name' => 'Nuno', 'password' => 'secret'])
    ->assertCreated()
    ->assertJsonPath('name', 'Nuno');
```

--------------------------------

### getJson(string $uri, array $headers = [])

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Executes a GET request expecting a JSON response against the application under test and returns Laravel's `Illuminate\Testing\TestResponse`. Forwards arguments to the identically named method on `Illuminate\Foundation\Testing\TestCase`.

```APIDOC
## GET /json

### Description
Executes a GET request expecting a JSON response against the application under test and returns Laravel's `Illuminate\Testing\TestResponse`.

### Method
GET

### Endpoint
`{uri}`

### Parameters
#### Path Parameters
- **uri** (string) - Required - URI to visit with a GET request

#### Query Parameters
- **headers** (array) - Optional - Additional headers sent with the request

### Request Example
```php
use function Pest\Laravel\getJson;

getJson('/api/user')->assertJsonPath('name', 'Nuno');
```

### Response
#### Success Response (200)
Returns `Illuminate\Testing\TestResponse`.

```

--------------------------------

### Error handling for toBeCollection

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/expectations.md

Error handling examples showing that a non-Collection value fails with PHPUnit\Framework\ExpectationFailedException, and that negation also throws when the value is a Collection.

```php
test('a plain PHP array is not a Collection', function () {
    expect((object) [])->toBeCollection();
})->throws(ExpectationFailedException::class);

test('negation failure', function () {
    expect(collect(['a', 'b', 'c']))->not->toBeCollection();
})->throws(ExpectationFailedException::class);
```

--------------------------------

### patchJson() helper for JSON PATCH requests

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Signature and usage example for the patchJson helper. It sends an HTTP PATCH request expecting a JSON response and returns an Illuminate\Testing\TestResponse. The example chains assertOk() to verify the response status.

```php
function patchJson(string $uri, array $data = [], array $headers = [])
```

```php
use function Pest\Laravel\patchJson;

patchJson('/api/users/1', ['name' => 'Nuno'])->assertOk();
```

--------------------------------

### freezeTime usage with callback and scope form

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/time.md

Example of using freezeTime with a callback to freeze time during a request, and the scope form where time is frozen until travelBack is called.

```php
use function Pest\Laravel\freezeTime;

freezeTime(function () {
    get('/')->assertSee(now()->format('Y-m-d'));
});

// Scope form:
freezeTime();
// ... time is frozen ...
travelBack();
```

--------------------------------

### from(string $url) method signature and usage

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Declares the method signature and shows usage. Sets the Referer header and the previous-URL session value to simulate a previous request. Returns TestCase.

```php
function from(string $url)
```

```php
from('/login')->get('/dashboard')->assertOk();
```

--------------------------------

### deleteJson() helper for JSON DELETE requests

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Signature and usage example for the deleteJson helper. It sends an HTTP DELETE request expecting a JSON response and returns an Illuminate\Testing\TestResponse. The example chains assertOk() to verify the response status.

```php
function deleteJson(string $uri, array $data = [], array $headers = [])
```

```php
use function Pest\Laravel\deleteJson;

deleteJson('/api/users/1')->assertOk();
```

--------------------------------

### withoutExceptionHandling() usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/exception-handling.md

Demonstrates using withoutExceptionHandling() to disable exception handling. The test defines a route that throws an exception and then calls withoutExceptionHandling()->get('/boom'), expecting the test to throw that exception.

```php
use function Pest\Laravel\withoutExceptionHandling;

test('a route with a bug', function () {
    Route::get('/boom', function () {
        throw new Exception('Exception message');
    });

    withoutExceptionHandling()->get('/boom');
})->throws(Exception::class, 'Exception message');
```

--------------------------------

### binary() method

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/commands.md

Returns the PHP binary invocation used to launch Pest. When PHP_SAPI is 'phpdbg', it returns [PHP_BINARY, '-qrr', 'vendor/pestphp/pest/bin/pest']; otherwise, it returns [PHP_BINARY, 'vendor/pestphp/pest/bin/pest'].

```php
protected function binary(): array
```

--------------------------------

### travelTo usage with callback and non-block form

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/time.md

Example of using travelTo with a callback to travel to a specific date, and the non-block form that travels without a callback.

```php
use function Pest\Laravel\travelTo;

travelTo('2030-01-01 00:00:00', function () {
    expect(now()->format('Y'))->toBe('2030');
});

// Non-block form
travelTo(today()->addDays(30));
```

--------------------------------

### withCookie method signature and usage

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Defines the withCookie method signature and shows usage to add a single encrypted cookie to a GET request.

```php
function withCookie(string $name, string $value)
```

```php
withCookie('lang', 'es')->get('/');
```

--------------------------------

### castAsJson usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/database.md

Example usage of castAsJson with assertDatabaseHas to assert against a JSON column.

```php
use function Pest\Laravel\castAsJson;
use function Pest\Laravel\assertDatabaseHas;

assertDatabaseHas('settings', ['payload' => castAsJson(['theme' => 'dark'])]);
```

--------------------------------

### followingRedirects() method signature and usage

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Declares the method signature and shows usage. Automatically follows redirects returned from the response. Returns TestCase.

```php
function followingRedirects()
```

```php
followingRedirects()->get('/')->assertSee('Welcome'); // final page after redirect chain
```

--------------------------------

### assertCredentials: Assert valid credentials

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/authentication.md

Asserts that the given credentials are valid for the specified guard (or the default guard when null). Returns a TestCase instance. The first block shows the function signature; the second shows a usage example with the Pest\Laravel import.

```php
function assertCredentials(array $credentials, ?string $guard = null)
```

```php
use function Pest\Laravel\assertCredentials;

assertCredentials(['email' => 'nuno@example.com', 'password' => 'secret']);
```

--------------------------------

### assertModelMissing usage example

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/database.md

Example of using assertModelMissing to assert that a model built but not persisted does not exist in the database.

```php
use function Pest\Laravel\assertModelMissing;

$user = User::make(['name' => 'Nuno']); // built but not persisted
assertModelMissing($user);
```

--------------------------------

### withCredentials() method signature and usage

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Declares the method signature and shows usage. Includes cookies and authorization headers for JSON requests. Returns TestCase.

```php
function withCredentials()
```

```php
withCredentials()->getJson('/api/me')->assertOk();
```

--------------------------------

### withMiddleware($middleware = null)

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Enables the given middleware for the test.

```APIDOC
## `withMiddleware($middleware = null)`

### Description
Enables the given middleware for the test (after `withoutMiddleware()`). If `$middleware` is `null`, all middleware is enabled.

### Method
`withMiddleware`

### Parameters
- `$middleware` (string|array|null) - Optional - Middleware class or list to enable; `null` enables all middleware

### Returns
`TestCase`

### Example
```php
withoutMiddleware()->withMiddleware('auth')->get('/private')->assertRedirectedTo('/login');
```
```

--------------------------------

### withBasicAuth(string $username, string $password)

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Adds a basic authentication header with the given credentials.

```APIDOC
## withBasicAuth(string $username, string $password)

### Description
Adds a basic authentication header with the given credentials.

### Method
N/A (Test case method)

### Parameters
- **$username** (string) - Required - Basic-auth username
- **$password** (string) - Required - Basic-auth password

### Returns
`TestCase`

### Example
```php
withBasicAuth('admin', 'p4ss')->get('/admin')->assertOk();
```
```

--------------------------------

### withVite() function signature

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/container.md

Declares the withVite() method with no parameters, returning TestCase. Restores Vite in the container.

```php
function withVite()
```

--------------------------------

### Prototype for promptForMissingArgumentsUsing

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/commands.md

Method signature for prompting for missing arguments in the pest:test command.

```php
protected function promptForMissingArgumentsUsing()
```

--------------------------------

### Run all tests with composer test

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/CONTRIBUTING.md

Runs the full test suite.

```bash
composer test
```

--------------------------------

### artisan() usage - pending command with output assertion

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/console.md

Calls the 'inspire' command and expects the output 'pest' using `expectsOutput()`. This is the pattern from `tests/Console.php:5`.

```php
use function Pest\Laravel\artisan;

artisan('inspire')->expectsOutput('pest')->run();
```

--------------------------------

### Run unit tests with composer test:unit

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/CONTRIBUTING.md

Runs the unit tests.

```bash
composer test:unit
```

--------------------------------

### from(string $url)

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Sets the `Referer` header and the previous-URL session value to simulate a previous request.

```APIDOC
## `from(string $url)`

### Description
Sets the `Referer` header and the previous-URL session value to simulate a previous request.

### Method
`from(string $url)`

### Parameters
- `$url` (string) - Required - URL to set as referer / previous URL

### Returns
`TestCase`

### Example
```php
from('/login')->get('/dashboard')->assertOk();
```
```

--------------------------------

### artisan() usage - with parameters and exit code

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/console.md

Runs the 'migrate' command with a database parameter and asserts the exit code is 0.

```php
use function Pest\Laravel\artisan;

$code = artisan('migrate', ['--database' => 'testbench'])->run();

expect($code)->toBe(0);
```

--------------------------------

### Run option fixtures with Pest CLI arguments

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/configuration.md

Runs the option fixtures in tests/Options/ separately, using the 'options' group and disabling exception and deprecation handling.

```bash
vendor/bin/pest --group=options --without-exception-handling --without-deprecation-handling
```

--------------------------------

### withoutMockingConsoleOutput() usage - real stdout

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/console.md

Disables mocking and runs the 'inspire' command, writing real output to stdout.

```php
use function Pest\Laravel\withoutMockingConsoleOutput;
use function Pest\Laravel\artisan;

withoutMockingConsoleOutput()->artisan('inspire')->run(); // real stdout
```

--------------------------------

### pest:dusk command signature

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/configuration.md

Signature for the pest:dusk command. Registered only when laravel/dusk is installed and the app is running in console.

```php
{--browse} {--without-tty}
```

--------------------------------

### getJson function signature

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Signature of the Pest\Laravel\getJson function. It sends a GET request expecting a JSON response and returns Illuminate\Testing\TestResponse.

```php
function getJson(string $uri, array $headers = [])
```

--------------------------------

### get function signature

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Signature of the Pest\Laravel\get function. It forwards arguments to the identically named method on Illuminate\Foundation\Testing\TestCase and returns Illuminate\Testing\TestResponse.

```php
function get(string $uri, array $headers = [])
```

--------------------------------

### withVite()

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/container.md

Restores Vite in the container, enabling Vite templating in views. Returns a TestCase instance for chaining.

```APIDOC
## `withVite()`

### Description
Restores Vite in the container, enabling Vite templating in views.

### Method
Function call

### Signature
`function withVite()`

### Parameters
None

### Returns
`TestCase`

### Example
```php
use function Pest\Laravel\withVite;

withVite()->get('/')->assertOk();
```
```

--------------------------------

### withUnencryptedCookies method signature and usage

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Defines the withUnencryptedCookies method signature and shows usage to send multiple cookies in plain text (not encrypted) with a GET request.

```php
function withUnencryptedCookies(array $cookies)
```

```php
withUnencryptedCookies(['session' => 'plain-value'])->get('/');
```

--------------------------------

### withMiddleware method signature

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Defines the signature of the withMiddleware method. It accepts a middleware class or list, or null to enable all middleware, and returns a TestCase.

```php
function withMiddleware($middleware = null)
```

--------------------------------

### options(string $uri, array $data = [], array $headers = [])

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-requests.md

Sends an HTTP OPTIONS request to the given URI with optional data and headers. Returns an Illuminate\Testing\TestResponse.

```APIDOC
## OPTIONS [URI]

### Description
Sends an HTTP OPTIONS request to the specified URI with optional data and headers.

### Method
OPTIONS

### Endpoint
[URI]

### Parameters
#### Path Parameters
- **uri** (string) - Required - The URI to send the request to.

#### Request Body
- **data** (array) - Optional - The data to send in the request body.

#### Headers
- **headers** (array) - Optional - Additional headers to include in the request.

### Request Example
```php
use function Pest\Laravel\options;

options('/users')->assertOk();
```

### Response
#### Success Response
Returns `Illuminate\Testing\TestResponse`.

```

--------------------------------

### assertDatabaseEmpty($table, ?string $connection = null)

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/database.md

Asserts that the given database table has no entries. Optionally specify a database connection; defaults to the default connection.

```APIDOC
## `assertDatabaseEmpty($table, ?string $connection = null)`

### Description
Asserts that the given table has no entries.

### Method
`function assertDatabaseEmpty($table, ?string $connection = null)`

### Parameters
- `$table` (untyped) - Required - Table name
- `$connection` (`?string`) - Optional - Database connection name; `null` uses the default

### Returns
`TestCase`

### Example
```php
use function Pest\Laravel\assertDatabaseEmpty;

assertDatabaseEmpty('users');
```
```

--------------------------------

### withCookies method signature and usage

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Defines the withCookies method signature and shows usage to send multiple encrypted cookies with a GET request. Cookies are encrypted before being sent unless encryption is disabled.

```php
function withCookies(array $cookies)
```

```php
withCookies(['theme' => 'dark'])->get('/');
```

--------------------------------

### pest:dataset

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/commands.md

Documentation for the pest:dataset artisan command, including its signature, parameters, and return values.

```APIDOC
## pest:dataset

### Description
Creates a new dataset file in the tests directory. The command does not prompt for missing input and does not support a --force option.

### Method
artisan command

### Endpoint
php artisan pest:dataset {name} [--test-directory=tests]

### Parameters
#### Arguments
- **name** (string) - Required - The name of the dataset file.

#### Options
- **--test-directory** (string) - Optional - The name of the tests directory. Default: `tests`.

### Request Example
```bash
php artisan pest:dataset orders
php artisan pest:dataset orders --test-directory=spec
```

### Response
#### Success Response (0)
- Prints `[{relativePath}] created successfully.` and returns `0`.

#### Error Response (1)
- If the target file already exists, prints a warning `[{target}] already exist` and returns `1`.
```

--------------------------------

### withCredentials()

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/http-request-configuration.md

Includes cookies and authorization headers for JSON requests.

```APIDOC
## `withCredentials()`

### Description
Includes cookies and authorization headers for JSON requests.

### Method
`withCredentials()`

### Parameters
None.

### Returns
`TestCase`

### Example
```php
withCredentials()->getJson('/api/me')->assertOk();
```
```

--------------------------------

### assertInvalidCredentials: Assert invalid credentials

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/authentication.md

Asserts that the given credentials are invalid for the specified guard (or the default guard when null). Returns a TestCase instance. The first block shows the function signature; the second shows a usage example with the Pest\Laravel import.

```php
function assertInvalidCredentials(array $credentials, ?string $guard = null)
```

```php
use function Pest\Laravel\assertInvalidCredentials;

assertInvalidCredentials(['email' => 'nuno@example.com', 'password' => 'wrong']);
```

--------------------------------

### artisan() error handling - failed command

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/console.md

Tests that an unknown command returns a non-zero exit code, keeping the failure local to the assertion.

```php
use function Pest\Laravel\artisan;

test('failed artisan command', function () {
    $code = artisan('unknown:command')->run();
    expect($code)->not->toBe(0);
});
```

--------------------------------

### Prototype for afterPromptingForMissingArguments

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/commands.md

Method signature for handling prompts after missing arguments, where the test type is selected interactively.

```php
protected function afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)
```

--------------------------------

### hasCredentials: Check credentials validity

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/authentication.md

Checks whether the given credentials are valid for the specified guard (or the default guard when null). Returns a boolean and never throws. The first block shows the function signature; the second shows a usage example with the Pest\Laravel import.

```php
function hasCredentials(array $credentials, ?string $guard = null): bool
```

```php
use function Pest\Laravel\hasCredentials;

if (hasCredentials(['email' => 'a@b.c', 'password' => 'x'])) {
    // valid login path
}
```

--------------------------------

### artisan(string $command, array $parameters = [])

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/console.md

Runs an Artisan command and returns a pending command or the exit code. Use it to test console commands within Pest tests.

```APIDOC
## `artisan(string $command, array $parameters = [])`

### Description
Runs an Artisan command and returns a pending command or the exit code. Use it to test console commands within Pest tests.

### Method
Function call

### Signature
`artisan(string $command, array $parameters = [])`

### Parameters
- `$command` (string) - Required - Artisan command name (e.g. `'inspire'`, `'migrate'`)
- `$parameters` (array) - Optional - Arguments to pass to the command

### Return Type
`Illuminate\Testing\PendingCommand|int` - A pending command that is started/asserted explicitly, or the exit code when run directly.

### Usage — pending command with output assertion
```php
use function Pest\Laravel\artisan;

artisan('inspire')->expectsOutput('pest')->run();
```

### Usage — with parameters and exit code
```php
use function Pest\Laravel\artisan;

$code = artisan('migrate', ['--database' => 'testbench'])->run();

expect($code)->toBe(0);
```

### Usage — exit code as return value
```php
use function Pest\Laravel\artisan;

// When the command runs synchronously, the return value is the exit code
$code = artisan('route:list');

expect($code)->toBe(0);          // success
expect($code)->not->toBe(0);     // command failed
```

### Error handling
A command that exits non-zero surfaces through the returned exit code; matching on the code keeps the failure local to the assertion. Combine with `->throws(...)` when a command is expected to raise:

```php
use function Pest\Laravel\artisan;

test('failed artisan command', function () {
    $code = artisan('unknown:command')->run();
    expect($code)->not->toBe(0);
});
```
```

--------------------------------

### PestDuskCommand signature

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/commands.md

Defines the command signature for 'pest:dusk' with two optional options: --browse to open a browser instead of headless mode, and --without-tty to disable TTY output. Both default to false.

```php
protected $signature = 'pest:dusk
                {--browse : Open a browser instead of using headless mode}
                {--without-tty : Disable output to TTY}';
```

--------------------------------

### Lint code with composer lint

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/CONTRIBUTING.md

Checks the coding style of the project.

```bash
composer lint
```

--------------------------------

### be function signature and usage

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/authentication.md

Alias of actingAs with the same signature and semantics. Sets the currently logged in user and returns TestCase.

```php
function be(Authenticatable $user, ?string $driver = null)
```

```php
use function Pest\Laravel\be;

be($user)->get('/me')->assertSee($user->name);
```

--------------------------------

### mock() signature

Source: https://github.com/pestphp/pest-plugin-laravel/blob/5.x/_autodocs/api-reference/container.md

Signature of the mock() helper. Registers a Mockery mock as the container instance and returns a Mockery\MockInterface.

```php
function mock(string $abstract, ?Closure $mock = null): MockInterface
```
Tokens:
Raw