Hapicode

# Laravel Test についてのメモ

Laravel 使って自動テストを行う作業があったので、メモして起きます。
tests ディレクトリの下 Feature と Unit ディレクトリにそれぞれのテストクラスを設置できます。

  • Feature 機能テスト、全体テスト
    • /tests/Feature 配下
  • Unit ユニットテスト、単体テスト
    • /tests/Unit 配下

ユニットテストは Laravel アプリケーションを起動しないため、アプリケーションのデータベースやその他のフレームワークサービスにアクセスできません。

機能テストはシステム全体が意図したとおりの機能も用いてログインした状態でアクセス時の動作テスト、検索パラメータ付けたアクセス時の動作確認ができます。

# テスト実行コマンド

# 作成

php artisan make:test UserTest

デフォルトは tests/Feature ディレクトリへ配置
--unitオプション使う場合tests/Unitディレクトリへ配置

# テスト実行コマンド

# phpunit
./vendor/bin/phpunit

# artisan
php artisan test

phpunit と Artisan の違い

  • Artisan テストは詳細なテストレポートを提供
  • phpunit コマンドで使用できる引数はすべて Artisan test コマンドにも渡せます。
php artisan test --testsuite=Feature --stop-on-failure

# サンプル

# テスト作る

php artisan make:test UserTest

# テストファイル編集

Faker 使ってデータ生成しながら、テストファイル編集

<?php

namespace Tests\Feature;

use Faker;
use Tests\TestCase;

class UserTest extends TestCase
{

    public function test_example()
    {
        $response = $this->get('/');

        $response->assertStatus(200);
    }

    public function test_login()
    {
        $faker = Faker\Factory::create();
        $response = $this->post('/login', [
            'email' => $faker->email(),
            'password' => 'test',
        ]);

        $response->assertStatus(200);
    }
}

# テストコマンド実行

php artisan test
#  PASS  Tests\Unit\ExampleTest
# ✓ example
#
#  PASS  Tests\Feature\ExampleTest
# ✓ example
#
#  PASS  Tests\Feature\UserTest
# ✓ example
# ✓ login
#
# Tests:  4 passed
# Time:   0.78s

# テストを並列で実行 --parallel オプション

php artisan test --parallel

--parallel オプション使うことでテスト時間を大幅に削減できます。

デフォルトではマシン CPU コアの数だけプロセスを作成されますが、--processes オプション付けることでプロセス数を調整できます。

php artisan test --parallel --processes=4

.env.testing ファイルは --env=testingオプションの際に使用されます。

# Faker のよく使うメソッド

メソッド 説明
$faker->lastName 姓
$faker->firstName 名
$faker->name 姓名
$faker->address 住所
$faker->postcode 郵便番号
$faker->phoneNumber 電話番号
$faker->country 国
$faker->email メールアドレス
$faker->safeEmail 安全メールアドレス
$faker->freeEmail 無料メールアドレス
$faker->companyEmail 企業メールアドレス
$faker->freeEmailDomain 無料メールアドレスドメイン
$faker->safeEmailDomain 安全メールアドレスドメイン
$faker->userName ユーザーネーム
$faker->password パスワード
$faker->domainName ドメイン
$faker->url URL
$faker->slug スラグ文字列
$faker->ipv4 ipv4 IP
$faker->localIpv4 ipv4 IP
$faker->ipv6 ipv6 IP
$faker->macAddress Mac アドレス

# uploadedFile ファイルアップロードのテスト

画像ファイル

<?php
namespace Tests\Feature;
use Tests\TestCase;
use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Storage;
use Illuminate\Foundation\Testing\WithoutMiddleware;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Illuminate\Foundation\Testing\DatabaseTransactions;
class ExampleTest extends TestCase
{
    public function testAvatarUpload()
    {
        Storage::fake('avatars');
        $response = $this->json('POST', '/avatar', [
            'avatar' => UploadedFile::fake()->image('avatar.jpg')
        ]);
        // ファイルが保存されたことをアサートする
        Storage::disk('avatars')->assertExists('avatar.jpg');
        // ファイルが存在しないことをアサートする
        Storage::disk('avatars')->assertMissing('missing.jpg');
    }
}

# サイズ指定画像アップロード

UploadedFile::fake()->image('avatar.jpg', $width, $height)->size(100);

# PDF ファイルアップロード

UploadedFile::fake()->create('document.pdf', $sizeInKilobytes);

# エクセルファイルアップロード

$response = $this->post(route('users.excel.import.upload'), [
            'users' => UploadedFile::fake()->create(
                name: 'users.xlsx',
                mimeType: 'application/vnd.openxmlformats-officedocument.spread'
            )
        ]);

# CSV ファイルアップロード

 $header = 'Header 1,Header 2,Header 3';
    $row1 = 'value 1,value 2,value 3';
    $row2 = 'value 1,value 2,value 3';

    $content = implode("\n", [$header, $row1, $row2]);

    $inputs = [
        'csv_file' =>
            UploadedFile::
                fake()->
                createWithContent(
                    'test.csv',
                    $content
                )
    ];


    $response = $this->postJson(
        'file-upload',
        $inputs

    );

    $response->assertOk();

# 利用可能なアサート

json、get、post、put、delete

レスポンスアサート
assertCookie $response->assertCookie($cookieName, $value = null); クッキー持っている
assertCookieExpired $response->assertCookieExpired($cookieName); クッキー期限切れである
assertCookieNotExpired $response->assertCookieNotExpired($cookieName); クッキー期限切れでない
assertCookieMissing $response->assertCookieMissing($cookieName); クッキーを持っていない
assertDontSee $response->assertDontSee($value); 指定した文字列がレスポンスに含まれていない
assertDontSeeText $response->assertDontSeeText($value); 指定した文字列がレスポンステキストに含まれていない
assertExactJson $response->assertExactJson(array $data); 指定した JSON データと完全に一致する
assertForbidden $response->assertForbidden(); forbidden ステータスコードを持っている
assertHeader $response->assertHeader($headerName, $value = null); 指定したヘッダが存在している
assertHeaderMissing $response->assertHeaderMissing($headerName); 指定したヘッダが存在していない
assertJson $response->assertJson(array $data); 指定した JSON データを持っている
assertJsonCount $response->assertJsonCount($count, $key = null); 指定したキーのアイテムを、期待値分持っている
assertJsonFragment $response->assertJsonFragment(array $data); 指定した JSON の一部を含んでいる
assertJsonMissing $response->assertJsonMissing(array $data); 指定した JSON の一部を含んでいない
assertJsonMissingExact $response->assertJsonMissingExact(array $data); JSON の一部をそのまま含んでいない
assertJsonStructure $response->assertJsonStructure(array $structure); 指定した JSON の構造を持っている
assertJsonValidationErrors $response->assertJsonValidationErrors($keys); 指定した JSON バリデーションエラーを持っている
assertLocation $response->assertLocation($uri); Location ヘッダが、指定した URI を持っている
assertNotFound $response->assertNotFound(); not found のステータスコードを持っている
assertOk $response->assertOk(); 200 のステータスコードを持っている
assertPlainCookie $response->assertPlainCookie($cookieName, $value = null); 指定した暗号化されていないクッキーを持っている
assertRedirect $response->assertRedirect($uri); 指定した URI へリダイレクトする
assertSee $response->assertSee($value); 指定した文字列がレスポンスに含まれている
assertSeeInOrder $response->assertSeeInOrder(array $values); 指定した文字列が、順番通りにレスポンスに含まれている
assertSeeText $response->assertSeeText($value); 指定した文字列がレスポンステキストに含まれている
assertSeeTextInOrder $response->assertSeeTextInOrder(array $values); 指定した文字列が、順番通りにレンスポンステキストへ含まれている
assertSessionHas $response->assertSessionHas($key, $value = null); セッションが指定したデータを持っている
assertSessionHasAll $response->assertSessionHasAll(array $data); セッションが指定したリストの値を持っている
assertSessionHasErrors $response->assertSessionHasErrors(array $keys, $format = null, $errorBag = 'default'); セッションが指定したフィールドに対するエラーを含んでいる
assertSessionHasErrorsIn $response->assertSessionHasErrorsIn($errorBag, $keys = [], $format = null); セッションが指定したエラーを持っている
assertSessionHasNoErrors $response->assertSessionHasNoErrors(); セッションがエラーを持っていない
assertSessionMissing $response->assertSessionMissing($key); セッションが指定したキーを持っていない
assertStatus $response->assertStatus($code); 指定したコードである
assertSuccessful $response->assertSuccessful(); 成功のステータスコードである
assertViewHas $response->assertViewHas($key, $value = null); 指定したデータを持っている
assertViewHasAll $response->assertViewHasAll(array $data); 指定したリストのデータを持っている
assertViewIs $response->assertViewIs($value); 指定したビューが返された
assertViewMissing $response->assertViewMissing($key); 指定したデータを持っていない

# 認証のアサート

メソッド 説明
$this->assertAuthenticated($guard = null); ユーザーが認証されている
$this->assertGuest($guard = null); ユーザーが認証されていない
$this->assertAuthenticatedAs($user, $guard = null); 指定したユーザーが認証されている
$this->assertCredentials(array $credentials, $guard = null); 指定した認証情報が有効である
$this->assertInvalidCredentials(array $credentials, $guard = null); 指定した認証情報が無効である
2022-06-10
  • php
  • laravel

関連記事

Laravel メンテナンスモード

Laravelのメンテナンスモードの使い方 Artisan down コマンド使ってメンテナンスモー...

Laravel model で hidden に設定したカラムを一時解除

Laravel モデルにhiddenで非表示になったカラムを一時的に表示するように変更しました。...

Laravel でカテゴリー作成 テーブル構築と再帰クエリ

カテゴリ関係を管理するためのテーブルを設計...

Laravel Queue で非同期処理

Queue処理のメリットとLaravel Queue使って一括処理の例をまとめ...

Laravel notification メール通知カスタマイズ

Laravelの通知（Notification）機能を使ってメール送信する作業があったので、まとめま...

Laravel lang バリデーションメッセージを多言語対応

Laravelバリデーションのエラーメッセージを多言語で対応する手順を紹介...

Laravel を API サーバーとしての初期設定

Laravel インストールからローカル環境のSail docker開発、初期設定までプロジェクト構...

Laravel リクエストログ出力

Laravelでリクエストログを出力する手順をまとめました。...

Carbon で php date 日付の日数・月数差を計算

Laravel Carbonは、DateTimeクラスよりもシンプルで読みやすいコードを書くことがで...

Laravel 429 Too Many Requests

Laravel 19使ってAPIサーバー構築とフロントはReact nextjsで構築しています。複...

Laravel Email バリデーションについて

Laravel Validation Email チェックする際の注意点、バリデーションルールオプシ...

Laravel Sanctum 使って API トークン JWT 認証と SPA 認証

Laravel JWT APIトークンの仕組みと Laravel Sanctum SPA認証使って認...

AWS SES メール開封確認　 DB に集計

メール送信の開封確認して DB更新するために使う AWS サービス SES SNS LAMBDA と...

Laravel logger でエラーログを chatwork に自動送信

Laravel 使ってエラー発生した場合、chatworkにエラー内容をリアルタイムで連絡するcha...

php CSV データ取得は fgetcsv 使う

PHP csvアップロードしてデータインポート作業がありましたが、fgetcsv使ってcsv処理につ...

Laravel tinker 使って DB データベース接続とコマンド

Laravel tinker REPLツール使ってDBアクセス、環境確認など対話式で楽しく遊べる...

Laravel Log の基本設定＆使い方

Laravel Logの基本設定 エラー発生時にslackに連絡通知する設定方法 tailコマンド使...

Exception: Class 'ZipArchive' not found

エクセル操作でZipArchive classが見つからないエラーがあったので、対応しました。...

Laravel Sail で Docker 環境構築

Laravel Sail で Docker 開発環境PHP Mysql phpMyAdmin構築 s...

PHP 文字列長さ・文字列の幅を取得方法

PHP 文字列操作関数 マルチバイト文字列日本語韓国語中国語の長さ取得など...

Codeigniter 画像アップロードとリサイズ

Codeigniter アップロード画像リサイズと回転するなど画像操作するライブラリの使い方...

Laravel Lumen Faker 日本語設定

Laravel Faker 日本語化設定 fakerphpの使い方とよく使うオプション 名前や住所の...

laravel method の基本 get post put options

Laravel Routeでget post メソッド同時に設定したい！Laravel ルート制約の...

Laravel schedule 設定

Laravel スケジュール管理の基本とtimezone設定などlaravel 8最新メソッド説明...

Class 'Imagick' not found Error

phpで画像操作したらimagickエラーで動かなくなったため、imagickモジュールをインストを...

Laravel eloquent model の規約

最新Laravel開発eloquent model設定資料まとめ...

PHP mbconvertkana 全角半角英数カナ変換

php カナコンバートなら mb_convert_kana を使う！全角半角、英数字や記号など簡単に...

Codeigniter APPPATH BASEPATH FCPATH 各種パスと URL 取得

codeigniter host url取得方法と APPPATH BASEPATHの意味を紹介...

Laravel timestamp() auto update 有効化無効化

Laravel updated_at timestamp自動にしたい！MysqlはすぐにできるけどS...

Lumen8 で JWT ユーザー認証

Lumen8でJWT認証のAPIサーバー構築してみた、便利になった時代だなあ...

Laravel toSql パラメータ付きで出力

Laravel Query Builder toSqlで出力したsql文にパラメータを自動でセット...

Lumen8 で API 開発

codeigniter 愛用者がLumenでAPIサーバーを立ててみた...

php Exception エラーキャッチでメール送信

エラーメッセージ、エラーコード、エラー詳細取得、php例外処理exceptionのいろいろ...

Smarty HTTP URL 取得できるサーバー関数

スマーティで取得するサーバー関数URLとenvなど...

Laravel blade foreach loop と current url

laravel blade foreach loop変数とurlのプロパティ対照表...

laravel session を制する

laravel sesssion 使い方を紹介、読込保存削除を使えるようになったらsession制覇...

PHP empty isset is_null の違い

PHP empty, isset, is_nullの違い よく使うPHP isset と if の違...

PHP 8 リリース新機能と変更

php8がリリースされたので、新機能と特徴などの資料まとめました。25周年迎えたPHPは更に速いプロ...

FlattenException deprecated

laravelバージョンアップ作業する際にFlattenException deprecatedにつ...

php.ini 初期設定のいろいろ

php ini ローカル環境や新規リモート環境の初期設定...

Laravel 5.1 から 8.1 にバージョンアップ

laravel5 から8にアップグレードする際に遭遇したエラーとカスタマイズauth認証の設定を修正...

PHP 7.4 にアップグレードして使えなくなる機能

php 5 から php7.4 にアップする作業があったので、アップグレード時のエラーと7.4では動...

開発時によく使うゼロ埋めパディング作業まとめ

mysql twig phpとjavascriptでよく使うゼロ埋めのいろいろ...

解決！phpMyAdmin テーブル構造の内容が表示されない問題

phpmyadmin5.0.1のxampp入れたら テーブル構造メニューが真っ白になって表示されない...

codeigniter email ライブラリでメール送信 日本語対応

codeigniterメール送信で日本語文字化け対策、改行コードとSMTP項目設定...

Composer コマンドとオプション

composer install updateの違い post-install-cmdとpost-u...

爆速軽量フレームワーク codeigniter PHP 開発

ルーター設定もなく、初期設定も少ない！軽量と爆速で動いてくれるフレームワーク codeigniter...

nuxtjs と codeigniter で jwt システム構築

nuxtjsとcodeigniterでシステム構築する際のメモ...

Lumen と Laravel 違い比較

軽量で速いマイクロフレームワークlumenとlaravelの違い、使い方比較と本当にlumen必要か...

HTML から PDF に変換 PHP ライブラリ mPDF の設定

HTMLレンダリングしてPDFに変換出力するライブリmpdfを使いこなせるための設定いろいろ...

twig 3 人気 PHP テンプレートエンジンがバージョンアップ

以前からtwigテンプレートエンジン使っていて、非常にパワーフルで使いやすさに魅了しました。15日に...

正規表現一覧 よく使う検索・置換のパターン

よく使う正規表現、文字検索・置換をまとめてみました。...

Apache 初期設定メモ

LAMP環境のApache初期設定メモ...

開発におけるコーディングルール・規約

コーディングルールと規約を大事にする、複数人で開発しても、一人で開発してもメンテナンスやコードのわか...

Laravel Error についてのメモ

laravelを使う時に出てくるエラー対応...

laravel に vuejs 使うための初期設定

PHPフレームワークlaravelにvuejs入れる時の初期設定まとめ、備忘録的...

php curl 使って クリックなしで POST 送信

PHP curl_setopt使ってシンプルにデータ転送してpost投げます。PHPは本当に短いソー...

allowurlinclude の設定で ftp_connect()エラー

FTPサーバーとやりとりする時にftp_connect()エラーが発生、PHP７にアップしたばかりで...