Go言語のカバレッジ計測(-cover)を使ったテスト品質向上ガイド
生徒
「Go言語でテストを書いた後、ちゃんと全部のコードがテストされているか確認する方法はありますか?」
先生
「あります。Goには-coverというカバレッジ計測の機能があり、テストで実行されたコードの割合を確認できます。」
生徒
「カバレッジって何ですか?」
先生
「カバレッジとは、テストによって実際に実行されたコードの割合のことです。100%に近いほどテストでコード全体がチェックされていることを示します。」
1. -coverオプションとは?
Go言語では、go testコマンドに-coverオプションを付けることで、テスト実行時にどのコードが実行されたかを計測できます。これにより、テスト漏れを防ぎ、品質の高いコードを書きやすくなります。
go test -cover
上記のコマンドを実行すると、テストの成否とともに、コードのカバレッジ率が表示されます。
2. カバレッジの詳細レポートを作る
さらに詳しく知りたい場合は、-coverprofileオプションを使ってカバレッジの詳細情報をファイルに出力できます。
go test -coverprofile=coverage.out
生成されたcoverage.outファイルを使って、HTML形式のレポートを作ることもできます。
go tool cover -html=coverage.out -o coverage.html
このHTMLレポートをブラウザで開くと、どの行がテストされているか色で確認できます。テストされていないコードが視覚的に分かるので、テスト漏れの補完に便利です。
3. カバレッジ計測で気をつけるポイント
カバレッジはあくまで「テストで実行された割合」を示すだけで、バグがないことを保証するものではありません。しかし、低いカバレッジはテストが足りないことを示すので、改善の目安になります。
- if文やfor文のすべての分岐が実行されるようにテストを書く。
- 複雑な関数は小さく分けてテストしやすくする。
- mockやinterfaceを使って外部依存のテストもカバーする。
4. 実際にカバレッジを上げる工夫
例えば、条件分岐を持つ関数をテストする場合、trueとfalse両方のケースをテストします。mockを使う場合は、通常時と異常系の動作を切り替えられるので、カバレッジが向上します。
func IsAdult(age int) bool {
if age >= 20 {
return true
}
return false
}
func TestIsAdult(t *testing.T) {
if !IsAdult(25) {
t.Error("Expected true for age 25")
}
if IsAdult(15) {
t.Error("Expected false for age 15")
}
}
このようにテストを書くことで、if文の両方の分岐が実行され、カバレッジが100%に近づきます。
5. 初心者でもできるカバレッジ活用法
テストを書いたら、まずgo test -coverで簡単に確認。次に-coverprofileで詳細を確認する。この順番で進めると、どの部分のテストが不足しているかがすぐにわかります。テスト漏れを補いながらコードを改善すると、Go言語のテスト品質は格段に向上します。