自動テストにおける「目視確認」をポジティブにこなす魔法

本記事はソフトウェアテスト Advent Calendar 2023 2日目の記事です。

自動テストを書いていて、テストコードで検証目的を達成できず「目視で確認」とするのは負けた気持ちになりますし、テストを実行するオペレーターやコントリビューターのモチベーションも下がります。特に、技術的には可能であってもROIが悪くて予算・納期的に不可能なときはなおさらです。

そんなとき、目視確認を指示するコメントに次の言葉を添えてみましょう。たちまち罪悪感は消え*1、またこれを見たオペレーターも高いモチベーションで取り組んでくれることでしょう*2！

日本語の例

君の目で確かめてくれ！
目撃せよ！

実際のテストコードに適用するとこうなります*3。

[Test]
public void TakeScreenshot_Gizmoあり_スクリーンショットにGizmoが写っていること()
{
  _sut.TakeScreenshot(gizmo: true);

  Assert.That(new FileInfo(path), Has.Length.GreaterThan(FileSizeThreshold));
  // Gizmoは写っているか？　ぜひ君の目で確かめてくれ！
}

英語の例

See for yourself! （君自身で確かめてくれ！）
See it with your own eyes! （君の目で確かめてくれ！）
Be a witness! （目撃者になれ！）
Don’t just read a test report. Witness the drama unfold before you! （テストレポートを読むだけではだめだ。目の前でドラマが展開するのを目撃するのだ！）

1960年代の番宣とかで言ってそう…ということでChatGPT（GPT-4 with DALL・E）に生成したもらった画像がこちら。