Art of Coding 第13章:設計の規律としてのテスト
この記事は、ブログシリーズ「Art of Coding」全26回のうちの第18回です。前回の記事はArt of Coding 第12章:物語を伝える道具としてのバージョン管理でした。
設計の規律としてのテスト
かつての私は、テストを雑用のようなものだと考えていました。コードを書くという「本当の仕事」が終わった後にやるもの。機能を書き、動くことを確かめ、カバレッジの要件を満たすために渋々テストを追加する。しかし、キャリアのどこかで、その考え方がひっくり返りました。テストとは、後から正しさを証明するためのものではない。作る前に設計を研ぎ澄ますためのものなのだと気づいたのです。
コードをテストしようと腰を据えると、それを外側から眺めざるを得なくなります。「これはコンパイルできるか?」と問うのをやめ、「この振る舞いを、検証できるほど明確に記述できるか?」と問い始めるのです。実装の視点から振る舞いの視点へのこの転換こそが、設計の本質です。
丁寧に書かれたテストは、扱いにくいAPIをあぶり出します。あるクラスをテストするのにコードベースの半分を引っ張り込まなければならないなら、それは設計が絡まりすぎているというフィードバックです。ある関数のテストケースを準備するのに十数個もの引数が必要なら、インターフェースが複雑すぎるのかもしれないというサインです。テストは、画家のスケッチブックに描かれた下絵のようなものです。最終的な作品を形づくる手助けをしてくれるのです。
私の知る最も優れたエンジニアたちは、発想をまるごと逆転させています。彼らはテストを創造的なプロセスの一部として書き、ときには実装そのものよりも先に書きます。この実践(一般にテスト駆動開発と呼ばれます)は、最初から明快さを強制します。実装を作る前に、契約を定義するのです。テストは生きたドキュメントになり、システムがどう振る舞うべきかを正確に示す物語になります。
生きた仕様書としてのテスト
今でも驚かされることがあります。テストは決して嘘をつかないドキュメントだということです。Wikiのページはひと月もすれば古くなります。設計書は、もはや存在しないシステムを説明しているかもしれません。しかしテストはどうでしょう。現実が変わった瞬間に、大きな声で失敗を知らせてくれます。テストは、現実のほうが合わせなければならない仕様書なのです。
よく書かれたテストが実際に何を伝えているかを考えてみてください。test_new_user_starts_with_empty_cart()という名前のテストを見れば、システムが何をするのかがすぐにわかります。コードを読む必要はありません。テストの名前と構造が意図を説明してくれます。よく選ばれたテストケースをいくつか加えれば、さまざまな条件下でシステムがどう振る舞うべきかの全体像が手に入ります。
最良のテストは、ほとんど文章のように読めます。準備のフェーズ(これが世界です)、実行のフェーズ(では、これをしてください)、そして検証(こうなるはずです)があります。この構造は、人間が物語について考えるときの流れをそのまま映しています。テストがこのように書かれていると、それは検証以上のもの、つまりコミュニケーションになります。チームに新しく加わった開発者は質問する必要がありません。テストを読めば、ルールが理解できるのです。
テストピラミッド:バランスが宿る場所
ユニットテストは、テストにおける削りたての鉛筆のようなものです。正確で、速く、細部を明らかにしてくれます。しかし、システムが孤立して存在することはめったにありません。実際のソフトウェアには、データベース、API、ユーザーインターフェース、サードパーティのサービスといったレイヤーがあります。そこで重要になるのが、統合テストとエンドツーエンドテストです。これらは、部品同士が実際に連携して動くことを検証します。
テストピラミッドは、役に立つメンタルモデルです。土台には高速なユニットテストを幅広く、中間層にはコンポーネント同士がつながる継ぎ目をカバーする統合テストを、そして頂点には最も重要なユーザーの動線のためのエンドツーエンドテストを少しだけ置きます。この形は、コストと価値の両方を反映しています。ユニットテストは安く、エンドツーエンドテストは高くつきます。しかしエンドツーエンドテストは、他のどのテストにも与えられない種類の安心感をもたらします。実際にシステムを使う人たちの視点から、システムが動くことを証明してくれるのです。
落とし穴は、どれか一種類のテストを100%揃えなければならないと考えることです。私は、何千ものユニットテストを持ちながら、部品同士のやり取りを誰もテストしていなかったために本番環境で障害を起こすチームを見てきました。一方で、エンドツーエンドテストしかなく、それが遅くて不安定なために、やがてチームから無視されるようになったケースも見てきました。大切なのはバランスです。目的に合った適切なテストを選ぶこと、それこそが腕の見せどころです。
テスト設計の悪さがもたらす見えないコスト
ここには静かな皮肉があります。コードベースを守るためのものが、やり方を誤ればその崩壊の原因になり得るのです。私は、テストスイートが何千行もの謎めいた準備コード、モックの中のモック、誰も理解していないマジック変数でできているシステムで働いたことがあります。チームはそれを信頼しなくなりました。リリース前にはテストが無効化されるようになり、最終的には完全に見捨てられてしまいました。
教訓はこうです。テストもまたコードなのです。明快さ、一貫性、そして丁寧さに値します。テストは、他の10個のファイルを追いかけなくても、何をなぜテストしているのかを説明できるべきです。名前が大切です。構造が大切です。テストの準備コードの重複を減らすことが大切です。こうした実践は、最初はほとんどコストがかかりませんが、計り知れない見返りをもたらします。
テストが読みやすく保守しやすいものになると、魔法のようなことが起こります。テストは重荷ではなく、共同作業のように感じられるようになります。あなたはテストを信頼し、チームメイトもテストを信頼します。テストは設計の言語の一部となり、システムがどう振る舞うべきかについての共通理解になります。そしてテストはあなたの足を引っ張るどころか、むしろ加速させてくれます。テストがリグレッションを検知してくれるとわかっているので、自信を持ってリファクタリングできるからです。
本書では、テストを輝かせる具体的な実践を探っています。明快さのためのテストの組み立て方、テストを壊れやすくするよくある落とし穴の避け方、意図を伝える道具としてのテストの使い方です。大事なのは、より多くのテストを書くことではなく、より良いテストを書くことです。設計を実際に改善し、コードベースをより暮らしやすい場所にしてくれるテストを。
下田 昌平
開発に関するインプットをアウトプットしています。カテゴリー
タグ
検索ログ
開発・技術相談
システム開発や技術検証、要件定義の作成、アーキテクチャ設計、 テスト設計、運用設計まで、一気通貫で支援しています。 企画段階の「まず相談したい」レベルから、実装・運用まで 幅広く対応できますので、お気軽にお問い合わせください。
お問い合わせ