テストコードを書いた場合の、テストドキュメントについて

前提

後輩へのプロジェクトの引継ぎが必要だと仮定します。

知りたいこと

テストコードを書いた場合に、テストドキュメントは作成すべきでしょうか。
また作成する場合、何を記述するべきなのでしょうか。

例としまして、簡単な会員登録フォームを出します。

メールアドレス (制約: メールアドレス形式)
パスワード (制約: 8桁の英数字)

このような会員登録フォームがあるとして、テストケースとして

正しいメールアドレスを入力してメールアドレスに対してバリデーションエラーがでない
不正なメールアドレスを入力してメールアドレスに対してバリデーションエラーがでる
正しいパスワードを入力してパスワードに対してバリデーションエラーがでない
不正なパスワードを入力してパスワードに対してバリデーションエラーがでる

の4パターン("不正な"には複数パターンあると思いますが簡略化しています)をテストすれば一通りテストケースは網羅できるのかなと思います。

この場合メソッド名を的確に記述することで、よく耳にする、テストコードが仕様書の役割を果たす状態になると私は思います。

ただ一般的にシステムの引継ぎというと、何かしらのドキュメントは残すものなのかなという気持ちがあります(引継ぎ相手がテストコードの実行方法を知らないとか、そういった場合にも何かしらのヒント/説明なりを残したり...というような)。

ググってみると、エクセルで表管理して、手動でテストするのが前提(?)なドキュメントが多数でてきたため、それと認識を混ぜてしまっている可能性もあります。

一般的にはテスト項目に関する引継ぎはどのように行われているのでしょうか？

dodox86

2020/07/10 00:58

ご質問に書かれている「テストコード」とは、実行することで自動的にテスト成功・失敗が分かる自動テストのことでしょうか。例えばJavaで言えばJUnit、C++で言えばCppUnitのような。

potato_taro

2020/07/10 01:04 編集

すみません、言葉の定義があいまいでした。はい、その通りです。

momon-ga

2020/07/10 04:36

テストコードな何を元に作成されるのでしょうか？いわゆるテスト仕様書というものがあれば、それがテストドキュメントにあたります？実装を解析して作るじゃないですよね・・・

potato_taro

2020/07/10 04:41

テストコードは仕様(仕様書)に基づいて作成します。今回の場合でいうと、・メールアドレス (制約: メールアドレス形式) ・パスワード (制約: 8桁の英数字) こちらを仕様書とし、こちらに基づいてテストを作成します。私の記述したテストドキュメント = テスト仕様書のことです。

momon-ga

2020/07/10 04:45

なるほど。仕様書とテスト仕様書、ソースコードとテストコードという対比があるわけじゃないんですね。つまり、実装（ソース）を解析して、テストドキュメントを作るということなので、実装に誤りがあった場合、テスト仕様書にも、それが反映される。で良い？

momon-ga

2020/07/10 04:52 編集

例であげると（そのままですが）仕様書：パスワード (制約: 8桁の英数字) テストコード：パスワード (制約: 10桁の英字) テスト仕様書：パスワード (制約: 10桁の英字) 念のため。良い悪いとかの話でなく、やろうとしてることは、これでよい？って確認です。

potato_taro

2020/07/10 05:21 編集

違っています。実装を解析してテストコードを作成するわけではありません。伝え方が下手で誤解を招いてしまったかもしれません。私の意図を整理すると以下のようになります。【仕様書】・メールアドレス (制約: メールアドレス形式) ・パスワード (制約: 8桁の英数字) 【仕様書】に基づきソースコードを実装。【仕様書】に基づきテストコードを実装。ここまでできている前提です。その上で、【仕様書】に基づいてテストコードを作成したにも関わらず、【テスト仕様書】は必要なのか？また必要であれば、何を記述すべきなのか？といった質問です。分かりにくい説明で申し訳ありません。