Testing Laravel Route hitting a Controller Method

Just use below command in your CMD you can get every single details of the App with controller and web.php Routes,

   php artisan route:list

Hi @munazzil, you didn't get my question. I know the Artisan command available to list the routes....

I want to write a PHPUnit test that ensures that the "Given Route hits the Specified Controller Action (Method) and it has the Specified middlewares applied"

Something like this should do it:

    /** @test */
    public function userCanAccessDashboard()
    {
        $user = factory(User::class)->create();

        $response = $this->actingAs($user)
            ->get('/dashboard');

        $response->assertStatus(200);
        $response->assertViewHas(['item_from_view', 'another_item_from_view']);
    }

    /** @test */
    public function guestCanNotVisitLoggedInPages()
    {
        $response = $this->get('/dashboard');

        $response->assertRedirect('/login');

    }

I think this meets your criteria. You can be sure that the controller action is hit by confirming that variables it creates and passed to the view (assuming it returns a view) end up in the view, i.e.

$response->assertViewHas(['item_from_view', 'another_item_from_view']);

@kingmaker_bgp Kindly check your controller method namespace

use App\Http\Controller\DashboardController;

Route::get('dashboard', [DashboardController::class, 'index'])
     ->middleware('auth');

@mahaveer, This is just a non-real Project.

The Codes were just examples to Illustrate the Scenario.

@kingmaker_bgp did you see this? https://laracasts.com/discuss/channels/testing/testing-laravel-route-hitting-a-controller-method?reply=522676

Hi @mstrauss , Your Answer is good for checking the Application Feature about getting the correct view and ensuring that the auth Middleware is applied.

I want to test the URL Route is being Handled by the Expected Controller Action (Irrespective of the Action Logic / Implementation). To be very precise, I want to hook the Test into the Laravel Routing layer and ensure that the correct Action method is invoked.

Goal / Motivation

Write a Loosely Coupled Test to check the Route calls the expected Action method.

@kingmaker_bgp I see what you are saying, but in essence, you are testing the Laravel Framework at that point, which is already thoroughly tested by many excellent developers. Your tests should test the unique things that your application does, not the Framework (IMO).

Yes @mstrauss, I didn't wish to test the Laravel Framework, But my concern is

I might accidentally change the routes/web.php file in the Future and the correct Controller Action may not be called.... I would like to prevent this using a Test for the Defined Routes.

This will tell exactly the Error and I don't want to reverse engineer other Failing Tests.

Ah, okay. Thanks for clarifying.

Hi guys, finally found a working way for Testing Routes hitting the Expected Controller Action using the Mockery::mock()

<?php

namespace Tests\Routes;

use Tests\TestCase;
use Mockery;
use App\Http\Controllers\Auth\LoginController;

class AuthRoutesTest extends TestCase
{
    /**
     * @test
     */
    public function test_login_view_route() {
        $controller_class = LoginController::class;
        $action = 'showLoginForm';
        $route = route('login');

        // Mock
        $controller_mocked = Mockery::mock($controller_class . '['. 'callAction' .']');
        $this->app->instance($controller_class, $controller_mocked);

        // Assert
        $controller_mocked->shouldReceive('callAction')->withArgs([$action, Mockery::any()])->once();

        // Visit Route
        $this->get($route);

    }

This provides a little more confident over my code.

PS

Any improvements to the Test are appreciated and welcomed.

Hope this helps someone :smile: