0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

テスト設計時のループバックチェック

Posted at

前置き

前回のテスト設計における 「SRP:単一責任原則」 のつづきになります。

今回触れる、ループバックチェックという手法は、このSRPを満たすときに、全体に避けては通れない手法です。

テストモジュールが、コンテキスト情報を失うことになる、SRP違反を招かないために、
日頃からのテストモジュール・プロダクションモジュールに対するループバックチェック
を行うことは、テストもプロダクションコードの方の可読性・理解容易性を低下させないために、必須な活動です。

ループバックチェックによる単一か?の検証

「ループバックチェック」という考え方は、単一責任原則(SRP)が本当に達成されているかを判断するための、極めて強力で実践的な思考法(ヒューリスティック) です。

まさに、

テストクラスやテストコンポーネントの命名と内部実装の間に意味的な対称性があるか

を確認する行為そのものです。

この対称性が保たれていれば、そのクラスは高い凝集度を持ち、単一の責任を果たしていると言えます。

1. トップダウン観点:予測可能性のテスト (The Predictability Test)

メカニズム

テストクラスの名前という抽象から、その内部の具体を予測します。
クラス名は、そのクラスが果たすべき 「契約」を宣言 しています。

その契約通りの実装が内部にあるかを検証する思考プロセスです。

image.png

思考の問い

「OrderServiceTestという名前のクラスがある。その中にはどんなテストメソッドがあるべきか?」

期待される答え

「注文の作成、更新、キャンセル、そしてそれらの失敗ケースに関するテストがあるはずだ。」

image.png

逸脱の検知

もしこのクラスの中にtestLoginUserのようなメソッドがあれば、「予測」は外れ、
このクラスはSRPに違反している(複数の責任を持っている)ことが明らかになります。

だって、テストクラス名からして、メイン業務の注文エンティティに関するテスト
ってわかるじゃないですか?
ログ系の横断的関心事のメソッドを含むのなら、それと矛盾します。

2. ボトムアップ観点:要約可能性のテスト (The Summarization Test)

メカニズム

テストメソッド群という具体から、それらを包括する単一の抽象(クラス名)を導き出します。

これは、内部実装の集合体が、単一の明確な「コンセプト」に要約できるかを検証する思考プロセスです。

image.png

思考の問い

「testPlaceOrderSucceeds, testCancelOrderFails, testUpdateShippingAddress... というメソッド群がある。これらを一つのクラスにまとめるなら、どんな名前が最も的確か?」

期待される答え

「これらは全て注文サービスに関する振る舞いの検証だ。だからOrderServiceTestという名前がふさわしい。」

image.png

逸脱の検知

もしこのメソッド群の中にtestCalculateShippingCostのようなメソッドが混ざっていると、「注文と配送コスト計算のテスト」のように要約が曖昧で複雑になり、単一の責任にまとまっていないことが分かります。

これは、責務の分離が必要であるサインです。

なぜこのループバックチェックが機能するのか?

このチェックが機能するのは、

SRPと高凝集の原則を、命名という非常に具体的な行為を通じて検証している

からです。

上記のトップダウンとボトムアップの2つの観点の予測結果が一致するようなテストクラスの命名やコンテキスト情報の設計が、結果的にテストモジュールを単一責務を維持することに繋がります。

ループバックが成功する場合

クラス名(責任の宣言)とメソッド群(責任の遂行)が完全に一致しており、クラス内の要素が強く関連し合っている(高凝集)ことを意味します。

ループバックが失敗する場合

クラスが複数の責任を持っているため、どんな名前を付けても、その名前では説明しきれないメソッドが存在してしまいます。これは低凝集の兆候です。

なので、即座にモデリングなどの作業を通して、コンテキスト情報の理解を深めましょう。

テストモジュール全体への波及効果

このループバックチェックを個々のテストクラスや、
よりマクロな粒度のテストモジュールに適用することが、結果的にテストモジュール全体の単一責任を維持することにつながります。

本棚のアナロジー 📚

・テストメソッド:本の中の「章」

・テストクラス:一冊の「本」

・テストクラス名:本の「タイトル」

・テストモジュール:図書館の「特定の棚(例:歴史、科学)」

図書館の棚は、大抵カテゴリー別になっています。

ループバックチェックは、「本のタイトルが、中の章の内容を正確に反映しているか?」を確認する作業です。

分類が容易 → 単一責務を満たしている

もし全ての「本」(テストクラス)が、このチェックをパスするほど明確な「タイトル」(クラス名)を持っていれば、それらを「歴史の棚」や「科学の棚」(テストモジュール)に分類するのは非常に簡単になります。

分類が困難 → 単一責務を満たしていない

しかし、タイトルが曖昧な本(例:TestUtilities)や、歴史の章と科学の章が混在している本(SRP違反のクラス)があれば、それをどの棚に置くべきか分からなくなります。

このように、クラスレベルでの責務の曖昧さは、そのままモジュールレベルでの構造の崩壊に直結するのです。

まとめ

是非とも、要件定義の段階でのモデリングフェーズで、このループバックチェックを
少しの時間でもいいので意図的にとってみて、テストモジュールとプロダクションコードのモジュールが1:1になるような設計を心がけてみてください。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?