κeenのHappy Hacκing Blog | Lispエイリアンの狂想曲

テストについて考えてみた

κeenです。 普段はテストをあまり書かない人なのですが業務では流石に書く必要があって、馴れないことをしていると色々と考えることがあったのでまとめます。 まだ私はテストのセオリーとかには詳しくないので勝手気儘に考えたことです。

2016-03-05 追記: 酷い誤りがあったので修正しました。s/ホーア理論/ホーア論理/。

今まではテストは「とりあえずエッジケースとかをカバー出来てればいいんでしょ」くらいにしか考えてませんでした。 しかしオブジェクト指向をしていて他のオブジェクトの振舞いに依存するだとか関数の引数が複雑だとかの時には適切なケースを書くのが困難でした。

チームの人とかとどう書くのが適切かと話しているとなんとなくまとまってきました。

ホーア論理

ホーア論理的にはソフトウェアの振舞/性質を表すのには3つの要素が必要です。事前条件、操作、事後条件です。

「事前条件Pが満たされるときに操作Oを行い、それが停止するならば事後条件Qが満たされる」

エンジニアリング的には以下のように読み替えられます。

事前条件とは、メソッドを実行するまでのお善立て。引数を用意する、依存するオブジェクトのモックを用意する、などなど。 操作が実際のメソッドの実行。 事後条件こそがassertなどを使ったテストケース群です。

テストフレームワークとホーア論理

テストを書く時にもこの考え方は役に立つな、と思いました。事前条件 x 操作 x 事後条件を網羅していけばいい訳です。

ところで、テストフレームワークにはテストをグルーピングしたりといくつかのスコープをネスト出来る機能を持っているものもあります。 ホーア論理では要素が3つある訳ですから3段にネストするのが適切な気がするのは納得いくと思います。しかしどの順番でネストするかは議論の余地がありそうです。

勿論、ホーア論理に従うなら操作の時系列的に事前条件>操作>事後条件のネストの仕方が一番自然かと思います。 しかしテストしたい主役は振舞、メソッドなのでそれを階層の最上位に持ってくる方が可読性、ひいてはテストの意味が高まりそうです。

あるいは、4段にネストして最上位にだたのグルーピング目的にメソッドを、そしてその下に事前条件>操作>事後条件を持っていく手法もありそうです。 しかしこれだとネストが深すぎますね。また、後述するように操作の子階層を作ると例外がどこ由来なのか分かりづらいという問題もあります。

これの改良版は最上位にだたのグルーピング目的にメソッドを、そして事前条件>(操作+事後条件)という形のネストの仕方をする方法です。 これは例外の出所を明確に出来る他、多くのテストフレームワークで操作に対する表明と事後条件に対する表明を区別しない問題もクリア出来るという利点があります。 1つある欠点は、操作と事後条件のスコープが分かれているので操作の返り値に対して事後条件で表明したい時にどうにかしてスコープの外に出してやる必要がある点です。 副作用を容易に許す言語なら外のスコープの変数に代入すればいいだけですが、純粋な言語だと簡単ではありません。 そういう意味でも操作に対する表明と事後条件に対する表明は分けたいなと思う次第。

操作に対する表明

本来のホーア論理的には事後条件で表明すれば十分ですが、実際には不十分な点があります。もう一度ホーア論理の表明について思い出しましょう。

「事前条件pが満たされるときに操作oを行い、 それが停止するならば 事後条件qが満たされる」

現実的に、関数が正しく停止することも保証したいです。「無限ループを書く方が悪い」という訳ではありません。関数が停止しないのは何も無限ループだけでなく、例外などで脱出した場合も含みます。

なので例外を出す/出さないの表明も欲しくなる訳です。 もう少し踏み込んで考えると、多くのテストフレームワークでassertと例外の送出の有無を同列扱いますが、前者は事後条件に対する表明、後者は操作に対する表明なので本来は分かれるべきです。

また、操作に対する表明はスコープを作るとしても操作の返り値を返す手段を用意してくれると事後条件の表明がやりやすくなるな、と思いました。まる。

まとめ

テストをする時には3つの要素に分けて考えると考えやすくなります。その3つとは事前条件、操作、事後条件で、それぞれの組み合わせがあるのでテストケースのネストは合理的です。 しかしながら人間の認識のためにネストの順番は入れ替えた方がよいのですが、そうするとコード上いくつか問題が発生します。

グルーピング目的にメソッドを、そして事前条件>(操作+事後条件)というネストの仕方が最終案に思えますが、それを的確に表現出来、かつコード上の問題をクリア出来るテストフレームワークが中々ないのが現状です。

付録A

考えがまとまるまでの過程

Written by κeen