Copied!

# ① フローの名前。自由記述。
name: Laravel CI

# ② フローのトリガー条件。今回はdevelopブランチへのプッシュとプルリクエストをトリガーに設定。複数設定可能。
on:
 pull_request:
   branches: [ develop ]
 push:
   branches: [ develop ]

# ③ ジョブの定義。自由記述
jobs:
 laravel-check:

   # ④ ジョブの実行環境。ubuntu-latest, windows-latest, macos-latestなどが指定可能。ubuntu-latestがおすすめ。
   runs-on: ubuntu-latest
   # ⑤ ジョブの戦略。matrixで複数バージョンのPHPでテストを実行するように設定。
   strategy:
     # ⑤-1 途中で失敗しても他のバージョンのテストを続行する設定。
     fail-fast: false
     # ⑤-2 テストするPHPのバージョン。8.4のみで実行するように設定。
     matrix:
       php: [ '8.4' ]

   # ⑥ ジョブのステップ。各ステップで実行する内容を定義。
   steps:
       # ⑥-1 リポジトリのコードをチェックアウト。
     - name: Checkout repository
       uses: actions/checkout@v4

       # ⑥-2 PHPのセットアップ。指定したバージョンのPHPと必要な拡張モジュールをインストール。
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
       with:
         php-version: ${{ matrix.php }}
         extensions: mbstring, intl, pdo_sqlite, dom, fileinfo
         coverage: none

         # ⑥-3 Composerのキャッシュを設定。依存関係のインストール。
     - name: Cache Composer dependencies
       uses: actions/cache@v4
       with:
         path: src/vendor
         key: ${{ runner.os }}-php-${{ matrix.php }}-composer-${{ hashFiles('src/composer.lock') }}
         restore-keys: |
           ${{ runner.os }}-php-${{ matrix.php }}-composer-
           ${{ runner.os }}-php-

             # ⑥-4 Composerのインストール。最新バージョンのComposerをインストール。
     - name: Install Composer dependencies
       working-directory: src
       run: composer install --no-interaction --no-progress --prefer-dist

       # ⑥-5 .envファイルのコピー。テスト用に.env.exampleを.envとしてコピー。
     - name: Copy .env
       working-directory: src
       run: cp .env.example .env

       # ⑥-6 アプリケーションキーの生成。LaravelアプリケーションのAPP_KEYを生成。
     - name: Generate app key
       working-directory: src
       run: php artisan key:generate

       # ⑥-7 artisanコマンドの動作確認。artisanが正しく動作するか確認。
     - name: Check artisan works
       working-directory: src
       run: php artisan about

       # ⑥-8 SQLiteデータベースファイルの準備。テスト用のSQLiteデータベースファイルを作成。
     - name: Prepare SQLite database file
       working-directory: src
       run: |
         mkdir -p database
         touch database/database.sqlite

       # ⑥-9 .env.testingファイルの作成。テスト環境用の設定を.env.testingに記述。
     - name: Create .env.testing
       working-directory: src
       run: |
         cat > .env.testing << 'EOF'
         APP_ENV=testing
         CACHE_DRIVER=array
         SESSION_DRIVER=array
         QUEUE_CONNECTION=sync
         DB_CONNECTION=sqlite
         DB_DATABASE=database/database.sqlite
         EOF

       # ⑥-10 テスト用APP_KEYの設定。テスト環境用のAPP_KEYを生成して.env.testingに追記。
     - name: Set testing APP_KEY
       working-directory: src
       shell: bash
       run: |
         KEY=$(php artisan key:generate --show)
         printf "\nAPP_KEY=%s\n" "$KEY" >> .env.testing

       # ⑥-11 設定キャッシュのクリア。設定のキャッシュをクリアして最新の設定を反映。
     - name: Clear config cache
       working-directory: src
       run: php artisan config:clear

       # ⑥-12 データベースマイグレーションの実行。テスト環境でマイグレーションを実行。
     - name: Migrate
       working-directory: src
       run: php artisan migrate --env=testing --force

       # ⑥-13 テストの実行。PHPUnitを使ってテストを実行。
     - name: Run tests
       working-directory: src
       run: php artisan test

Copied!

<?php
namespace Tests\Feature;

use Tests\TestCase;

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


       $response->assertStatus(200);
   }
}

Copied!

<?php
namespace Tests\Feature;

use Tests\TestCase;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\Attributes\TestDox;
use PHPUnit\Framework\Attributes\Group;

final class HealthCheckTest extends TestCase
{
   #[Test]
   #[Group('fast')]
   #[TestDox('GET /health returns 200 and {"status":"ok"}')]
   public function health_endpoint_returns_ok(): void
   {
       $res = $this->get('/health');


       $res->assertOk()
           ->assertJson(['status' => 'ok']);
   }
}

Copied!

<?php
namespace Tests\Feature;

use App\Models\User;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\Attributes\TestDox;
use PHPUnit\Framework\Attributes\Group;

final class UserCrudTest extends TestCase
{
   use RefreshDatabase;

   #[Test]
   #[Group('database')]
   #[TestDox('UserモデルのCRUD操作が正常に動作する')]
   public function it_can_create_update_and_delete_user(): void
   {
       // CREATE
       $user = User::factory()->create([
           'name' => 'Taro',
           'email' => 'taro@example.com',
       ]);
       $this->assertDatabaseHas('users', ['email' => 'taro@example.com']);

       // UPDATE
       $user->update(['name' => 'Hanako']);
       $this->assertDatabaseHas('users', [
           'email' => 'taro@example.com',
           'name'  => 'Hanako',
       ]);

       // DELETE
       $user->delete();
       $this->assertDatabaseMissing('users', ['email' => 'taro@example.com']);
   }
}

Copied!

Route::get('/health', function () {
   return response()->json(['status' => 'ok']);
});