PHPUnit を使用した Laravel でのテストの包括的なガイド

Laravel でのテストの概要

テストは、アプリケーションが意図したとおりに動作することを確認するソフトウェア開発の重要な側面です。 Laravel は、PHP の人気のテスト フレームワークである PHPUnit を備えた、すぐに使用できる堅牢なテスト スイートを提供します。このガイドでは、Laravel でのテストの設定と実行について説明し、単体テストと機能テストの違いを説明し、さまざまなテスト シナリオの例を示します。

フォルダー構造: 単体テストと機能テスト

Laravel では、テストは通常​​、Unit と Feature という 2 つのメイン ディレクトリに編成されます。

単体テスト: これらのテストは、個々のメソッドやクラスなど、アプリケーションの独立した小さな部分をテストするように設計されています。これらは通常、tests/Unit ディレクトリにあります。各テスト関数は test という単語で始める必要があります。

例:

public function testExampleFunction() {
    $this->assertTrue(true);
}

機能テスト: これらのテストは、より複雑な対話を処理し、通常は連携して動作する複数のコンポーネントをテストします。これらは、tests/Feature ディレクトリにあります。機能テストには、多くの場合、HTTP リクエストの作成と応答のチェックが含まれます。

Laravelでのテストの実行

Laravel アプリケーションですべてのテストを実行するには、次のコマンドを使用します。

./vendor/bin/phpunit

テスト環境の構成

テストを実行する前に、テスト環境を構成することが重要です。 phpunit.xml ファイルを変更して、テスト用の環境変数を設定します。たとえば、SQLite インメモリ データベースを使用してテストを高速化するには:

<php>
    <env name="APP_ENV" value="testing"></env>
    <env name="APP_MAINTENANCE_DRIVER" value="file"></env>
    <env name="BCRYPT_ROUNDS" value="4"></env>
    <env name="CACHE_STORE" value="array"></env>
    <env name="DB_CONNECTION" value="sqlite"></env>
    <env name="DB_DATABASE" value=":memory:"></env>
    <env name="MAIL_MAILER" value="array"></env>
    <env name="PULSE_ENABLED" value="false"></env>
    <env name="QUEUE_CONNECTION" value="sync"></env>
    <env name="SESSION_DRIVER" value="array"></env>
    <env name="TELESCOPE_ENABLED" value="false"></env>
</php>

SQLite をテスト環境として有効にした後、構成キャッシュをクリアします。

php artisan config:clear

*例: プロファイル ルートが存在し、正しく動作するかどうかをテストする
*

プロファイル ルートのテストを作成します:

php artisan make:test ProfileTest

プロフィール ページに特定のテキストが表示されるかどうかを確認するテスト メソッドを追加します:

public function testProfilePage(){
    $response = $this->get('/profile');
    $response->assertSeeText('Your Profile');
}

データベース相互作用のテスト

テスト用データベースのセットアップ

データベースの相互作用をテストする前に、config/database.php でテスト用のデータベース構成を作成します。

'mysqltesting' => [
    'driver' => 'mysql',
    'url' => env('DB_URL'),
    'host' => env('DB_HOST', '127.0.0.1'),
    'port' => env('DB_PORT', '3306'),
    'database' => 'laravel_testing',
    'username' => env('DB_USERNAME', 'root'),
    'password' => env('DB_PASSWORD', ''),
    'unix_socket' => env('DB_SOCKET', ''),
    'charset' => 'utf8mb4',
    'collation' => 'utf8mb4_unicode_ci',
    'prefix' => '',
    'prefix_indexes' => true,
    'strict' => true,
    'engine' => null,
    'options' => extension_loaded('pdo_mysql') ? array_filter([
        PDO::MYSQL_ATTR_SSL_CA => env('MYSQL_ATTR_SSL_CA'),
    ]) : [],
],

データベース テストの実行

PHPUnit コマンドを実行して、テスト データベースが作成され、動作していることを確認します。

./vendor/bin/phpunit

例: ユーザー登録のテスト

ユーザー登録用のテストを作成します:

php artisan make:test UserTest

ユーザーを作成してデータベースに保存できることを確認するテスト メソッドを追加します:

public function test_registration(): void
{
    $user = new User();
    $user->name = 'Test User';
    $user->email = 'email@example.com';
    $user->password = bcrypt('password');

    $user->save();

    $this->assertDatabaseHas('users', ['email' => 'email@example.com']);
}

ストアアクションのテスト

PostTest クラスでストア アクションのテストを作成します。

public function testPostStoreValid()
{
    $data = [
        'title'=> 'Test Post',
        'slug' => 'test-post',
        'content' => 'Content of the post',
        'active' => true,
    ];

    $this->post('/posts', $data)
         ->assertStatus(302)
         ->assertSessionHas('status');

    $this->assertEquals(session('status'), 'Post was created!');
}

失敗のテスト

検証エラーをチェックするテストメソッドを追加します:

public function testPostFail()
{
    $data = [
        'title'=> '',
        'content' => '',
    ];

    $this->post('/posts', $data)
         ->assertStatus(302)
         ->assertSessionHas('errors');

    $messages = session('errors')->getMessages();

    $this->assertEquals($messages['title'][0], 'The title must be at least 4 characters.');
    $this->assertEquals($messages['title'][1], 'The title field is required.');
    $this->assertEquals($messages['content'][0], 'The content field is required.');
}

*更新アクションをテスト中
*

投稿を更新するためのテストメソッドを追加します:

public function testPostUpdate()
{
    $post = new Post();

    $post->title = "Initial Title";
    $post->slug = Str::slug($post->title, '-');
    $post->content = "Initial content";
    $post->active = true;

    $post->save();

    $this->assertDatabaseHas('posts', $post->toArray());

    $data = [
        'title' => 'Updated Title',
        'slug' => 'updated-title',
        'content' => 'Updated content',
        'active' => false,
    ];

    $this->put("/posts/{$post->id}", $data)
         ->assertStatus(302)
         ->assertSessionHas('status');

    $this->assertDatabaseHas('posts', ['title' => $data['title']]);
    $this->assertDatabaseMissing('posts', ['title' => $post->title]);
}

削除アクションをテストしています

投稿を削除するためのテストメソッドを追加します:

public function testPostDelete()
{
    $post = new Post();

    $post->title = "Title to delete";
    $post->slug = Str::slug($post->title, '-');
    $post->content = "Content to delete";
    $post->active = true;

    $post->save();

    $this->assertDatabaseHas('posts', $post->toArray());

    $this->delete("/posts/{$post->id}")
         ->assertStatus(302)
         ->assertSessionHas('status');

    $this->assertDatabaseMissing('posts', $post->toArray());
}

**

PHPUnit を使用した特定のテストの実行

**

特定のテスト メソッドまたはクラスを実行するには、PHPUnit で --filter オプションを使用します。以下にいくつかの例を示します:

特定のテストメソッドを実行する

./vendor/bin/phpunit --filter PostTest::testPostDelete

特定のクラスですべてのテストを実行する

./vendor/bin/phpunit --filter PostTest

特定のファイルでテストを実行する

./vendor/bin/phpunit tests/Feature/PostTest.php

詳細出力

さらに詳細な出力を得るには、-v オプションを追加します。

./vendor/bin/phpunit --filter PostTest::testPostDelete -v

以上がPHPUnit を使用した Laravel でのテストの包括的なガイドの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。