test-rule

テスト規則

テストファイルの命名規則

• テストファイルは実装ファイルと同じディレクトリに配置する
• ファイル名は {実装ファイル名}_test.go とする
• 例: order_service.go → order_service_test.go

テスト関数の命名規則

• テスト関数名は Test で始める
• 構造体のメソッドをテストする場合: Test_{構造体名}_{メソッド名}
  • 例: Test_orderService_CreateOrder
• パッケージ関数をテストする場合: Test{関数名}
  • 例: TestNewOrderState
• 複数のテストケースを持つ場合は、t.Run() のサブテスト名に日本語で説明的な名前を付ける
  • 例: "正常系: 注文作成"、"異常系: 在庫不足"

テスト構造

• テーブル駆動テスト（Table-Driven Tests）を推奨する
  • テストケースを構造体のスライスとして定義
  • 各テストケースに名前 (name)、入力 (args)、期待される出力 (want*)、期待されるエラー (wantErr) を含める
• t.Run() を使用して各テストケースをサブテストとして実行する
• 複雑なセットアップやアサーションはヘルパー関数に切り出す

テーブル駆動テストの例

func TestOrderService_CreateOrder(t *testing.T) {
    type fields struct { // モック化する依存関係
        orderRepo repository.OrderRepository
        itemRepo  repository.ItemRepository
    }
    type args struct { // テスト対象メソッドの引数
        ctx context.Context
        req *usecase.CreateOrderRequest
    }
    tests := []struct {
        name    string
        fields  fields // モックの期待動作設定用
        args    args
        want    *usecase.CreateOrderResponse
        wantErr bool // エラー発生を期待するかどうか
        // wantErrIs as error // 特定のエラー型を期待する場合 (errors.Is)
        // wantErrMsg string // 特定のエラーメッセージを期待する場合 (strings.Contains)
    }{
        {
            name: "正常系: 注文作成",
            fields: fields{
                // モックリポジトリのEXPECT設定
            },
            args: args{
                ctx: context.Background(),
                req: &usecase.CreateOrderRequest{ /* ... */ },
            },
            want: &usecase.CreateOrderResponse{ /* ... */ },
            wantErr: false,
        },
        // 他のテストケース...
    }
    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            ctrl := gomock.NewController(t)
            defer ctrl.Finish()

            // モックの準備 (tt.fields を使用)
            mockOrderRepo := mock_repository.NewMockOrderRepository(ctrl)
            // mockOrderRepo.EXPECT()...

            // テスト対象のサービス/メソッドを初期化
            s := &OrderService{
                orderRepo: mockOrderRepo,
                // ...
            }

            // テスト実行
            got, err := s.CreateOrder(tt.args.ctx, tt.args.req)

            // アサーション
            if (err != nil) != tt.wantErr {
                t.Errorf("CreateOrder() error = %v, wantErr %v", err, tt.wantErr)
                return
            }
            // if tt.wantErrIs != nil && !errors.Is(err, tt.wantErrIs) {
            //     t.Errorf("CreateOrder() error = %v, wantErrIs %v", err, tt.wantErrIs)
            // }
            // if tt.wantErrMsg != "" && !strings.Contains(err.Error(), tt.wantErrMsg) {
            //    t.Errorf("CreateOrder() error = %v, wantErrMsg %q", err, tt.wantErrMsg)
            //}

            // 戻り値の比較 (ポインタや複雑な構造体は go-cmp を推奨)
            if diff := cmp.Diff(tt.want, got, cmpopts.IgnoreUnexported(/* 必要に応じて */)); diff != "" {
                t.Errorf("CreateOrder() mismatch (-want +got):\n%s", diff)
            }
        })
    }
}