---
url: /docs/9.x/guide/testing-legacy.md
---
# Testing with Sharp (legacy API)

::: warning
This page documents the old Testing API, we recommend using the new [Testing API](/guide/testing).
:::

Sharp provides a few assertions and helpers to help you test your Sharp code.

## The `SharpAssertions` trait

The `Code16\Sharp\Utils\Testing\SharpAssertions` trait is intended to be used in a Feature test.

```php
class PostFormTest extends TestCase
{
    use SharpAssertions;
    
    // ...
}
```

### Helpers

The trait adds a few helpers:

#### `loginAsSharpUser($user)`

Logs in the given user as a Sharp user.

#### `getSharpShow(string $entityClassNameOrKey, $instanceId)`

Call the Sharp API to display the Show Page for the Entity `$entityClassNameOrKey` and instance `$instanceId`.

#### `getSharpForm(string $entityClassNameOrKey, $instanceId = null)`

Call the Sharp API to display the Form for the Entity `$entityClassNameOrKey`. If `$instanceId` is provided, it will be an edit form, and otherwise a creation one.

#### `getSharpSingleForm(string $entityClassNameOrKey)`

Call the Sharp API to display the edit Form for the single Entity `$entityClassNameOrKey`.

#### `updateSharpForm(string $entityClassNameOrKey, $instanceId, array $data)`

Call the Sharp API to update the Entity `$entityClassNameOrKey` of id `$instanceId`, with `$data`.

#### `updateSharpSingleForm(string $entityClassNameOrKey, array $data)`

Call the Sharp API to update the single Entity `$entityClassNameOrKey` with `$data`.

#### `storeSharpForm(string $entityClassNameOrKey, array $data)`

Call the Sharp API to store a new Entity `$entityClassNameOrKey` with `$data`.

#### `deleteFromSharpList(string $entityClassNameOrKey, $instanceId)`

Call the Sharp API to delete an `$entityClassNameOrKey` instance on the Entity List.

#### `deleteFromSharpShow(string $entityClassNameOrKey, $instanceId)`

Call the Sharp API to delete an `$entityClassNameOrKey` instance on the Show Page.

#### `callSharpEntityCommandFromList(string $entityClassNameOrKey, string $commandKeyOrClassName, array $data, ?string $commandStep = null)`

Call the `$commandKeyOrClassName` Entity Command with the optional `$data`.

In case of a wizard command, here’s how you can specify the step in the `$commandStep` parameter:

```php
it('allows the user to use the wizard', function () {
    // First step, no need to declare any previous step
    $step = $this
        ->callSharpEntityCommandFromList(
            entityClassNameOrKey: MyEntity::class,
            commandKeyOrClassName: MyWizardCommand::class,
            data: ['some_key' => 'some value'],
        ) 
        ->assertOk()
        ->json('step'); // Get back the step key from the response

    // Second step
    $this
        ->callSharpEntityCommandFromList(
            entityClassNameOrKey: MyEntity::class, 
            commandKeyOrClassName: MyWizardCommand::class, 
            data: ['another_key' => 'another value'], 
            commandStep: $step // We must specify the step we got from the first call
        )
        ->assertOk();

    // ...
});
```

#### `callSharpInstanceCommandFromList(string $entityClassNameOrKey, $instanceId, string $commandKeyOrClassName, array $data, ?string $commandStep = null)`

Call the `$commandKeyOrClassName` Instance Command with the optional `$data`.

For a wizard command, you can refer to the [previous example](#callsharpentitycommandfromlist-string-entitykey-string-commandkeyorclassname-array-data-string-commandstep-null).

#### `callSharpInstanceCommandFromShow(string $entityClassNameOrKey, $instanceId, string $commandKeyOrClassName, array $data, ?string $commandStep = null)`

Call the `$commandKeyOrClassName` Instance Command with the optional `$data`.

For a wizard command, you can refer to the [previous example](#callsharpentitycommandfromlist-string-entitykey-string-commandkeyorclassname-array-data-string-commandstep-null).

#### `withSharpBreadcrumb(Closure $callback): self`

Most of the time, the breadcrumb automatically set by Sharp is enough. But sometimes it can be useful to define a whole Sharp context before calling an endpoint, and that's the purpose of this method. The `$callback` contains a built instance of Code16\Sharp\Utils\Links\BreadcrumbBuilder, which can be used like this:

```php
it('allows the user to display a leaf form', function () {
    $this
        ->loginAsSharpUser()
        ->withSharpBreadcrumb(function (BreadcrumbBuilder $builder) {
            return $builder
                ->appendEntityList(TreeEntity::class)
                ->appendShowPage(TreeEntity::class, 6)
                ->appendShowPage(LeafEntity::class, 16);
        })
        ->getSharpForm(LeafEntity::class, 16)
        ->assertOk();
});
```

#### `withSharpGlobalFilterValues(array|string $globalFilterValues): self`

You can specify the global filter values to use in the Sharp context.

```php
it('allows the user to display a leaf form', function () {
    $tenant = Tenant::factory()->create();
    $user = User::factory()->create(['tenant_id' => $tenant->id]);

    $this
        ->loginAsSharpUser($user)
        ->withSharpGlobalFilterValues($tenant->id)
        ->getSharpForm(LeafEntity::class, 16)
        ->assertOk();
});
```