arie0703 / go-test-tutorial

go-test-tutorial

Goで単体テストコードを書くためのチュートリアルです
あらかじめ実装されているコードに対してテストコードを作成してください

ディレクトリ構成

├── build               : docker buildで利用するファイル
├── mysql               : DB接続クライアント生成などの処理。当チュートリアルでは単体テストコード作成対象外
├── tools               : mock生成スクリプト
└── chapters            : 当チュートリアルで単体テストコードの作成対象となる資産
    └── chapterX        : チャプター毎のパッケージ
        ├── chapterX.go : 各チャプターのプログラム
        ├── main        : chapter4のみ。メイン処理
        └── db          : chapter4のみ。DBアクセス処理

動作環境

• Docker Desktop等のdocker及びdocker-composeが動作する環境
• 以下コマンドが必要です
  • git
  • make（Windowsをお使いの方）

初期構築

1. 当リポジトリを自分のリポジトリへForkしてください
2. Forkしたリポジトリを任意のディレクトリでclone
3. $ make upを実行してコンテナを起動
   • Windowsをお使いの方は事前にmakeコマンドをインストールしてください
   • コンテナを終了する場合は$ make downを実行してください

チュートリアル

• 課題はchaptersディレクトリ配下にchapterで区切られて格納されています
  • 課題内容は各chapterのREADMEを参照してください
• テストは以下条件を満たしてください
  • テーブルドリブンで記述
  • カバレッジ100%到達
    • ※mock.goは対象外です
    • カバレッジはcover.htmlから確認してください
• テスト実施方法
  • $ make gotestを実行してください
  • パッケージ単位や関数単位でテストを実行したい場合
    • パッケージ単位：$ docker-compose exec -T <サービス名(※)> go test -v <テスト対象のパッケージまでのパス>
    • 関数単位：上記パッケージ単位までのコマンドに -run <関数名> を追加してください
      • ※サービス名はdocker-compose.ymlのservicesに記載されているものです。当チュートリアルの場合はappになります

テストの記述例

// 関数名は必ず「Test」を接頭辞に付ける
// 引数「t *testing.T」を受けることでテスト関数として動作する
func TestExample(t *testing.T) {
  // 正常系のテストパターン
  success := map[string]struct {
    paramA string
    paramB int
    want []string
  }{
    "テストケース名": {
      paramA: "abcdefg",
      paramB: 12345,
      want: []string{"a","b","c"},
    },
  }
  // エラー系のテストパターン
  fail := map[string]struct {
    paramA string
    paramB int
    wantErrStr string
  }{
    "テストケース名": {
      paramA: "",
      paramB: -100,
      wantErrStr: "パラメータが不正です",
    },
  }

  for tt, tc := range success {
    t.Run(tt, func(t *testing.T) {
      // テスト対象の関数を呼び出す。
      got, err := example(tc.paramA, tc.paramB)
      // 戻り値が想定通りか検証する。
      if err != nil {
        t.Errorf("test is failed: %s", err)
      }
      if tc.want != got {
        t.Errorf("test is failed: %s", err)
      }
    })
  }
  for tt, tc := range fail {
    t.Run(tt, func(t *testing.T) {
      got, err := example(tc.paramA, tc.paramB)
      if got != nil {
        t.Errorf("test is failed: %s", err)
      }
      if tc.wantErrStr != err.Error() {
        t.Errorf("test is failed: %s", err)
      }
    })
  }
}