Testing Laravel Nova Actions?

How can I write tests for custom Laravel Nova Actions?

In my case, I am writing a small Point of Sales application that allows users to Top Up their accounts, I want to write some tests to make sure I covered all the requirements, but the docs of Nova aren't handy.

/**
 * Perform the action on the given models.
 *
 * @param  Collection<\App\Nova\Participant>  $models
 * @return mixed
 */
public function handle(ActionFields $fields, Collection $models)
{
    if (count($models) > 1) {
        return Action::danger(__('You can only top-up one participant at a time.'));
    }

    $amount = $fields->get('amount');

    $model = $models[0];
    $model->wallet += $amount;
    $model->save();

    return Action::message(__('You did a top-up of &euro; :amount for :name.', [
        'amount' => $amount,
        'name' => $model->name,
    ]));
}

LaryAI

2 years ago

Best Answer

Level 58

To write tests for custom Laravel Nova Actions, you can follow these steps:

Create a new test file for your Nova Action. For example, if your Action is called "TopUpParticipant", you can create a file named "TopUpParticipantTest.php" in the "tests/Feature" directory.
In the test file, you can use the Nova facade to perform the action on the given models. You can use the actingAs method to authenticate a user and the post method to send a POST request to the Nova action endpoint.
Write test methods to cover different scenarios. For example, you can write a test method to check if the action returns the correct message when the top-up is successful, and another test method to check if the action returns the correct error message when trying to top-up multiple participants at once.

Here's an example of how the test file could look like:

<?php

namespace Tests\Feature;

use App\Nova\Participant;
use Laravel\Nova\Actions\Action;
use Laravel\Nova\Fields\ActionFields;
use Tests\TestCase;

class TopUpParticipantTest extends TestCase
{
    public function testTopUpParticipant()
    {
        $user = // create or get a user to authenticate as
        $participant = // create or get a participant to top-up

        $response = $this->actingAs($user)
            ->postJson('/nova-api/participants/top-up', [
                'resources' => [$participant->id],
                'fields' => [
                    'amount' => 100,
                ],
            ]);

        $response->assertStatus(200)
            ->assertJson([
                'message' => 'You did a top-up of € 100 for ' . $participant->name,
            ]);

        // Assert that the participant's wallet has been updated correctly
        $this->assertEquals(100, $participant->fresh()->wallet);
    }

    public function testTopUpMultipleParticipants()
    {
        $user = // create or get a user to authenticate as
        $participants = // create or get multiple participants to top-up

        $response = $this->actingAs($user)
            ->postJson('/nova-api/participants/top-up', [
                'resources' => $participants->pluck('id')->toArray(),
                'fields' => [
                    'amount' => 100,
                ],
            ]);

        $response->assertStatus(200)
            ->assertJson([
                'danger' => 'You can only top-up one participant at a time.',
            ]);

        // Assert that the participants' wallets have not been updated
        $participants->each(function ($participant) {
            $this->assertEquals(0, $participant->fresh()->wallet);
        });
    }
}

Make sure to replace the placeholders ($user, $participant, $participants) with the appropriate code to create or get the required user and participant models.

Note: The example assumes that you have set up Laravel Nova and have the necessary routes and authentication in place.

1 like