質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.93%

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

受付中

回答 2

投稿

  • 評価
  • クリップ 0
  • VIEW 151

potato_taro

score 2

前提

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

知りたいこと

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

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

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

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

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

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

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

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

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

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

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

質問への追記・修正、ベストアンサー選択の依頼

  • momon-ga

    2020/07/10 13:45

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

    キャンセル

  • momon-ga

    2020/07/10 13:46 編集

    例であげると(そのままですが)
    仕様書:パスワード (制約: 8桁の英数字)
    テストコード:パスワード (制約: 10桁の英字)
    テスト仕様書:パスワード (制約: 10桁の英字)

    念のため。良い悪いとかの話でなく、やろうとしてることは、これでよい?って確認です。

    キャンセル

  • potato_taro

    2020/07/10 14:21 編集

    違っています。実装を解析してテストコードを作成するわけではありません。
    伝え方が下手で誤解を招いてしまったかもしれません。

    私の意図を整理すると以下のようになります。
    【仕様書】
    ・メールアドレス (制約: メールアドレス形式)
    ・パスワード (制約: 8桁の英数字)

    【仕様書】に基づきソースコードを実装。
    【仕様書】に基づきテストコードを実装。

    ここまでできている前提です。
    その上で、
    【仕様書】に基づいてテストコードを作成したにも関わらず、【テスト仕様書】は必要なのか?
    また必要であれば、何を記述すべきなのか?
    といった質問です。

    分かりにくい説明で申し訳ありません。

    キャンセル

回答 2

+4

まず、その組織の決まりごと(必ずドキュメントを残せなど)が最大限優先されると思います。

また、テストモジュールの実行方法がわからない人が引き継がれた場合を想定するなら、最低限そこだけはドキュメント化するべきだと思います。

上記に当てはまらない、かつ自動テストでカバーしているケースをドキュメントに起こす想定をしているのであれば、それは二重管理になるので不要だと思います。

テストコードがメンテナンスされた時にドキュメントまでメンテナンスするのは、単純に生産性を落とすだけで誰も特しません。自動化されていない部分や、そのテストの実行に必要な手順をドキュメント化するべき、という認識です。

テストの実施結果は別途エビデンスとして残す必要はありますが、これはまた別の問題でしょう。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

0

テストコードの質(コメント量や可読性)しだいかなぁ。
私も不要でいいかなぁと思いつつも、

【仕様書】に基づきソースコードを実装。
【仕様書】に基づきテストコードを実装。

テストの仕様を確認するときに、テストコード見るのと、テスト仕様書見るのと、どっちが楽になりそう?
で作成してもらうか決めるかな。

gentaroさんの

組織の決まりごと(必ずドキュメントを残せなど)が最大限優先

は、まぁそりゃ前提でしょう。

あとは、引き継がれる側がテストコード見て、わかる?わからない?を判断してもらってもいいのじゃないかな。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.93%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る