Level 102
Don't make a static call and inject the class. That makes it easy to mock
Nov 10, 2022
16
Level 54
Testing Endpoint and not calling action class
I'm trying to test when an administrator tries to suspend a user that the SuspendAction is run and is redirected. I would instead test specifics of the action class in a separate test however I'm not sure how I can prevent it from getting inside of the actual action class.
<?php
declare(strict_types=1);
namespace App\Http\Controllers\Users;
use App\Actions\Users\SuspendAction;
use App\Exceptions\CannotBeSuspendedException;
use App\Http\Controllers\Controller;
use App\Models\User;
class SuspendController extends Controller
{
/**
* Suspend a user.
*
* @param \App\Models\User $user
* @return \Illuminate\Http\RedirectResponse
*/
public function __invoke(User $user)
{
$this->authorize('suspend', $user);
try {
SuspendAction::run($user);
} catch (CannotBeSuspendedException $e) {
return redirect()->back()->with('error', $e->getMessage());
}
return to_route('users.index');
}
}
beforeEach(function () {
$this->user = User::factory()->create();
});
test('invoke calls suspend action and redirects', function () {
$this->actingAs(administrator())
->patch(action([SuspendController::class], $this->user))
->assertRedirect(action([UsersController::class, 'index']));
RetireAction::shouldRun()->with($this->user);
});
Level 54
@sinnbeck Inject the Action class into the constructor of the controller?
Level 102
@jrdavidson like this
public function __invoke(User $user, SuspendAction $suspend)
{
$this->authorize('suspend', $user);
try {
$suspend->run($user);
} catch (CannotBeSuspendedException $e) {
return redirect()->back()->with('error', $e->getMessage());
}
return to_route('users.index');
}
You can then just swap it with a mock in the container https://laravel.com/docs/9.x/mocking#mocking-objects
Level 102
Unless it's actually a facade in which case you can just mock it
Level 54
@Sinnbeck Its not a facade, its actually a class from here. https://laravelactions.com/
Level 102
@jrdavidson that would have been useful to know https://laravelactions.com/2.x/mock-and-test.html
Level 54
@Sinnbeck My apologies. This is where the action will either return void or an exception. I'm just wanting to make sure it did run.
test('invoke calls suspend action and redirects', function () {
SuspendAction::mock()->shouldReceive('run')->with($this->user);
$this->actingAs(administrator())
->patch(action([SuspendController::class], $this->user))
->assertRedirect(action([UsersController::class, 'index']));
SuspendAction::shouldRun()->with($this->user);
});
Level 54
@Sinnbeck The problem is that it still says the following error.
No matching handler found for Mockery_2_App_Actions_Users_SuspendAction::run(object(App\Models\User)). Either the method was unexpected or its arguments matched no expected argument list for this method
Level 54
@Sinnbeck What I do realize is calling $action->run($user) then calls the handle method on the action class. So I need to make sure it realizes it gets to the handle method.
Level 102
@jrdavidson you never mentioned that error in your first post? Did you get it back then?
And ignore my advise from the first couple of posts as I had no idea you were using a package. My advice was generic on how to test. The package already ensures you resolve out of the container https://laravelactions.com/2.x/basic-usage.html#running-as-an-object
Level 54
@Sinnbeck What I'm wanting to do is make sure that there is a call to the run method and that nothing is returned. I don't want it to actually run the action. I"m thinking the shouldRun method is not what I need here.
Level 102
@jrdavidson then the code you already have should work
Level 54
@Sinnbeck WIth this current test I have the output from the test is saying that the call to run was called but no expectations were made..
test('invoke calls suspend action and redirects', function () {
SuspendAction::mock()->shouldReceive('run')->with($this->user)->andReturn();
$this->actingAs(administrator())
->patch(action([SuspendController::class], $this->user))
->assertRedirect(action([UsersController::class, 'index']));
});
Level 102
@jrdavidson but what about your original version (I moved the mock to before the run
test('invoke calls suspend action and redirects', function () {
RetireAction::shouldRun()->with($this->user);
$this->actingAs(administrator())
->patch(action([SuspendController::class], $this->user))
->assertRedirect(action([UsersController::class, 'index']));
});
Level 54
@Sinnbeck Same thing. Just not expectations were specified.
Level 54
@Sinnbeck I don't understand. There shouldn't be any expectations of what it does. I just want to make sure there's just a call to the run method.
Please or to participate in this conversation.