単体テストのスケルトンコードを自動生成するツール

中村圭助氏：「単体テストのスケルトンコードを自動生成するツールを作った／現在機能拡張している話」をします。よろしくお願いします。

まずは、自己紹介です。n9te9って呼ばれています。本名は、中村圭助です。好きな標準パッケージは、syncパッケージであったり、net/httpパッケージです。

DMM.comに2022年度、新卒入社しました。今は、Developer Productivity Groupの横断チームに所属しています。そのほか、社内とか社外での活動として、「DMM.go」の運営をやっていたり、「Go Conference 2024」の運営をやっています。

本セッションの構成です。まずは、ツールの概要で、どのようなものかを知ってもらって、テストカバレッジの話に移ります。テストカバレッジを満たすために必要なテスト数の洗い出しをどうやっているのかとか、スケルトンコードの出力という部分を話していきます。

今、機能開発しているgomockのEXPECT().Return()の課題点とか、テスト対象の関数が依存するgomockのinterfaceを自動生成する部分とか、gomockをベースにした話をしていきます。

本セッションでは、gomockの設計思想とかコードの自動生成について学べるようになっていると思います。

ツールの概要

ツールの概要です。「go install」でインストールできるようになっていて、コマンドで自動的にコードを生成できるようになっています。興味のある人は、実際に試してみてください。

実際に自動生成されたコードですけど、（スライドを示して）このように、テストケースドリブンで実装されたコードが出力されます。

ここからは、テストカバレッジの話に入っていきます。まず、テストカバレッジを満たすために必要なテストケース数を考えます。

必要なテストケース数を考える場合は、だいたいロジックが分岐する時にテストケースが増えると考えます。例えばifとかelse、elseifとか、switch文のケースが増えた時に、テストカバレッジを満たすために必要なテストケース数が増えるという認識を持てばいいと思います。

具体的なコードで話します。HasHogeで関数が実装されていると、まず、必要なテストケース数は、if/else/elseif文の数＋1と考えて、例えば、引数のstrsに「hoge」という文字列のスライスを渡した時に、（スライドを示して）このようにテストカバレッジがカバーされます。

次に、（スライドを示して）この赤の部分をカバーしたい場合は、「piyo」のスライスを渡せば全体がカバーされます。

次にswitch文ですけど、「v = 3」のテストをした時、「fmt.Println("C")」だけカバーされます。

ほかにも、例えば「v = 50」とか「v = 90」のテストを追加すると、（スライドの）赤の部分がカバーされて緑色になります。

ここで、テストカバレッジを満たすために必要なテストケース数を洗い出すにはどうすればいいかですけど、関数とかメソッド単位で、if/else/else-if文とか、switchのcase文を数え上げれば良いです。

どうすればいいかというと、関数の実装をASTから解析すればいいです。ASTは、木構造のデータ構造になっているので、グラフで表すと、（スライドを示して）このようになります。

BlockStmtの中に、ListでStmtのスライスが入っていて、その中に、if/elseとか、SwitchStmtがあるので、このあたりを再帰的に実行して、必要なテストケース数を数え上げればいいです。

（スライドを示して）これは、僕が作ったOSSですが、関数単位で必要なテストケース数を出力してくれるツールがあります。

これも「go install」で実行できて、このように関数ごとに必要なテストケース数を出力してくれます。

必要なテストケース数の話は終わったので、スケルトンコードというか、Goのコードの自動生成部分について考えていきます。

ASTを活用したGoコードの自動生成

まず、「ASTって何？」というところから考えていきます。ASTは、Goのコードをプログラム上で扱えるようにしたデータ構造です。つまり、ASTとGoのプログラムのコードは等価であると考えられます。そのためGoとASTは、双方向に変換が可能です。

つまり、スケルトンコードは、テストコードのASTさえ作ってしまえばGoのコードとして吐き出すことができます。（スライドを示して）ここでは、テストケースの構造体を定義するASTを作るコードになっています。このように、データ構造を定義するだけなので、ここの部分は宣言的に書けるようになっています。

先ほどのテストケースをループするASTも作成しないといけないので、RangeStmtみたいなかたちでループの文を作っています。

ループの文の中に、呼び出す関数のASTも定義しないといけないので、その中にあるBodyという要素に、呼び出す関数を生成するASTの定義をしています。

その中の関数で、実行する無名関数も実装しないといけないので、無名関数の引数とか、どういう型定義をするのかというところを実装しています。（スライドを示して）ここの部分はけっこう長くなっています。

無名関数の中身を実装しないといけないので、Bodyで実装しています。これはスケルトンコードなので、fmt.Printlnで「write your unit test」というかたちで実装するASTがここの部分で作られています。

先ほど定義されたASTをベースにこのコードで出力すると、こういうテストのスケルトンコードが出力されます。

ここまでは、スケルトンコードの話をしたので、今、僕が実際にやっている機能拡張について話していきます。

（次回へつづく）

Published at