【Laravel】コントローラー新規作成と同時にテストクラスも作成するtestオプションを解説します

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在5社経験している、12年目エンジニアです。

この記事では、 Laravelのコントローラー新規作成と同時にテストクラスも作成するtestオプションについて解説していきます。

前提：実行環境
testオプションとは
まとめ：コントローラーを作成するときはtestオプションを使ってみよう

前提：実行環境

実行環境は以下の通りです。

OS	Windows11
PHPのバージョン	8.2.4
Laravelのバージョン	10.45.1

この記事では

C:\Laravel

配下に【LaravelSample】という名前でプロジェクトを作成しています。
Laravelのphp cs fixerのバージョンを確認するやり方を解説

testオプションとは

testオプションとは、コントローラー新規作成と同時にテストクラスも作成する、便利なオプションです。
testオプションは、コントローラーを作成するコマンドに追加して使うオプションです。

コントローラーを作成するコマンドは以下でした。

php artisan  make:controller 【作成するコントローラーの名前】

1	php artisan make:controller 【作成するコントローラーの名前】

詳細な説明については、こちらの記事をご参考ください。

【Laravel】コントローラーを新規作成するartisan make:controllerコマンドを解説します

testオプションをつけると以下のようなコマンドになります。

php artisan make:controller 【作成するコントローラーの名前】 --test

1	php artisan make:controller 【作成するコントローラーの名前】 --test

作成するコントローラーの後ろに【–test】をつければOKです。

Controllersディレクトリ直下にSampleControllerとテストクラスを作る場合

php artisan make:controller SampleController --test

1	php artisan make:controller SampleController --test

というコマンドになります。

たたくと
Laravelのコントローラー新規作成と同時にテストクラスも作成するtestオプションを解説

C:\Laravel\LaravelSample>php artisan make:controller SampleController --test

   INFO  Controller and test [C:\Laravel\LaravelSample\app\Http\Controllers\SampleController.php] created successfully.

C:\Laravel\LaravelSample>php artisan make:controller SampleController --test

INFO Controller and test [C:\Laravel\LaravelSample\app\Http\Controllers\SampleController.php] created successfully.

とが表示されれば、無事に作成されています。

新規作成されたコントローラーの中身は↓のようになっています。

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class SampleController extends Controller
{
    //
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class SampleController extends Controller

{

}

テストクラスは

【プロジェクト】\tests\Feature\Http\Controllers

配下に「SampleControllerTest.php」という名前で作成されています。
Laravelのコントローラー新規作成と同時にテストクラスも作成するtestオプションを解説
中身は以下になってます。

<?php

namespace Tests\Feature\Http\Controllers;

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

class SampleControllerTest extends TestCase
{
    /**
     * A basic feature test example.
     */
    public function test_example(): void
    {
        $response = $this->get('/');

        $response->assertStatus(200);
    }
}

<?php

namespace Tests\Feature\Http\Controllers;

use Illuminate\Foundation\Testing\RefreshDatabase;

use Illuminate\Foundation\Testing\WithFaker;

use Tests\TestCase;

class SampleControllerTest extends TestCase

{

/**

* A basic feature test example.

public function test_example(): void

{

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

$response->assertStatus(200);

}

まとめ：コントローラーを作成するときはtestオプションを使ってみよう

以上がLaravelのコントローラー新規作成と同時にテストクラスも作成するtestオプションの解説でした！

あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ