Laravelのテストにて500エラーが返ってくる原因

Question

前提・実現したいこと

laravelのphpunitを使用して会員登録の簡単な記述をしたテストを実施したいのですが
期待するステータスコードが返らずに500エラーが返ってきます。

原因がわかりません。
何かアドバイス頂けると大変助かります。

発生している問題・エラーメッセージ

   │ Expected status code 200 but received 500.
   │ Failed asserting that false is true.

テストコード

<?php

namespace Tests\Feature;

use App\User;
use Tests\TestCase;
use Illuminate\Foundation\Testing\WithFaker;
use Illuminate\Foundation\Testing\RefreshDatabase;

class RegisterApiTest extends TestCase
{
    use RefreshDatabase;
    /**
     * A basic test example.
     *
     * @return void
     */
    public function testRegister()
    {
        $data = [
            'name' => 'testUser',
            'email' => '[e-mail]',
            'password' => 'test1234',
            'password_confirmation' => 'test1234'
        ];

        $response = $this->json('POST',route('register'),$data);


        $user = User::first();
        $this->assertEquals($data['name'],$user->name);

        $response->assertStatus(201)->assertJson(['name' => $user->name]);
    }
}

ルート定義(api.php)

Route::post('/register','Auth\RegisterController@register')->name('register');

Aut\RegisterController.php

//上記省略

//下記を追加
    protected function registered(Request $request,$user)
    {
        return $user;
    }

試したこと

$responseの値をdd()にて覗いてみたところ最初の$this->jsonのあたりで既に500となっていました。

補足情報（FW/ツールのバージョンなど）

ここにより詳細な情報を記載してください。
laravel 5.7.19

Answer 1

$this->json()や$this->get()などを使ってテストする場合、通常は例外処理も含めた形でテストが行われるので、バグで予期しない例外などが発生した場合でも通常はデフォルトの例外ハンドラが処理してステータス500を返す、という動作をしてしまいます。原因を調べたいならこの場合はエラーログに何か出力されている筈なのでそれを見てください。エラーログは設定を自分でいじっていなければstorage/logsディレクトリにある筈です。

例外処理のテストをするのでない場合は$this->withoutExceptionHandling()であらかじめ例外処理を抑止しておくとphpunitの出力にエラーがそのまま出てくるようになるので、エラーログを開く手間が省けて便利です。

例:

app/Http/Controllers/FooController:

<?php
namespace App\Http\Controllers;

class FooController extends Controller
{
    public function foo()
    {
        throw new \Exception('予期しないエラー');
    }
}

tests/Feature/FooTest:

<?php
namespace Tests\Feature;

use Tests\TestCase;

class FooTest extends TestCase
{
    public function testFoo(): void
    {
        $response = $this->get('/foo');
        $response->assertOk();
    }
}

と準備してphpunitを実行した場合、

% phpunit tests/Feature/FooTest.php
PHPUnit 8.4.2 by Sebastian Bergmann and contributors.

F                                                                   1 / 1 (100%)

Time: 446 ms, Memory: 28.00 MB

There was 1 failure:

1) Tests\Feature\FooTest::testFoo
Response status code [500] does not match expected 200 status code.
Failed asserting that false is true.

/Users/matsui/src.nobk/laravel60/vendor/laravel/framework/src/Illuminate/Foundation/Testing/TestResponse.php:86
/Users/matsui/src.nobk/laravel60/tests/Feature/FooTest.php:17

FAILURES!
Tests: 1, Assertions: 1, Failures: 1.

となり、エラーが起きたことはわかりますがphpunitの出力からは原因はさっぱりわかりません。

エラーログを見るとエラーの原因が出力されています

% cat storage/logs/laravel-2019-11-27.log
[2019-11-27 05:38:21] testing.ERROR: 予期しないエラー {"exception":"[object] (Exception(code: 0): 予期しないエラー at /Users/matsui/src.nobk/laravel60/app/Http/Controllers/FooController.php:13)
[stacktrace]
#0 [internal function]: App\Http\Controllers\FooController->foo()
#1 /Users/matsui/src.nobk/laravel60/vendor/laravel/framework/src/Illuminate/Routing/Controller.php(54): call_user_func_array(Array, Array)
#2 /Users/matsui/src.nobk/laravel60/vendor/laravel/framework/src/Illuminate/Routing/ControllerDispatcher.php(45): Illuminate\Routing\Controller->callAction('foo', Array)
...(略)

$this->withoutExceptionHandling()を追加して以下のようにすると、

<?php
namespace Tests\Feature;

use Tests\TestCase;

class FooTest extends TestCase
{
    public function testFoo(): void
    {
        $this->withoutExceptionHandling();
        $response = $this->get('/foo');
        $response->assertOk();
    }
}

phpunitの出力にエラーがそのまま書かれるようになります。

% phpunit tests/Feature/FooTest.php
PHPUnit 8.4.2 by Sebastian Bergmann and contributors.

E                                                                   1 / 1 (100%)

Time: 766 ms, Memory: 24.00 MB

There was 1 error:

1) Tests\Feature\FooTest::testFoo
Exception: 予期しないエラー

/Users/matsui/src.nobk/laravel60/app/Http/Controllers/FooController.php:8
/Users/matsui/src.nobk/laravel60/vendor/laravel/framework/src/Illuminate/Routing/Controller.php:54

...(略)
ERRORS!
Tests: 1, Assertions: 0, Errors: 1.

Comments

[kyutaro]

回答ありがとうございます！！
教えたいただいた方法でエラーの原因を特定することができました！
use Illuminate\Http\Requestをコントローラーで未定義だったことが原因でした。
ありがとうございます！