MagicPodの「履歴機能」によるテストケースレビューの効率化

はじめに

MagicPod社の企画きっかけで前回記事を書いてから早2ヶ月。第2回の企画のテーマである「実装したテストケースのレビューのやり方」に対して記事を書こうと思いながらも、なかなか書くのが遅くなりました。

ちなみに第2回のテーマを投稿したのは私で、私自身MagicPodを使っていてテストケースレビューのやり方は本当に悩んでいました。今回の記事では、悩んでいた内容とその悩みを解決してくれた履歴機能(2023年3月リリース)についてまとめてみました。

以前の悩み：レビュー時のやりとりや修正履歴を管理するのが大変

• 困っていたこと
  • Githubのプルリクエストのように、レビュー時のやりとりや修正履歴などを管理したい。しかし、MagicPodにはそういった仕組みがなかったため、その辺の記録をどのように残すべきか迷っていた。
• 履歴機能がリリースされるまでの自チームの記録の残し方
  • 基本的にslack上でテストケースのレビューを行っており、slack上にしか情報が残らない状況でした。そして、MagicPodのテストケースからslack上の会話のログにたどり着く仕組みもあまり考えていなかったため、なぜテストケースの修正が行われたかは時間が経つと誰もわからない状況でした。

履歴機能のリリースにより私の悩みが解決

MagicPodの履歴機能とは

2023年3月にMagicPodに履歴機能が実装されました。

履歴の機能を使うと、テストケースや共有ステップに対する変更履歴を確認することができます。
これにより、いつ、誰が、どのような意図で変更したのかが明確になります。

履歴機能を使ったテストケースレビューの例

1. テストケース修正前
2. テストケースを修正し、レビュー依頼
3. レビュー実施（履歴にレビューコメント記入）
4. レビューコメントを踏まえたテストケース修正
5. 再レビュー実施

履歴機能により、1-2の差分(修正前と修正後)や1-4の差分（修正前と最終的な状態）などが簡単に見れるようになりました。
例えばですが、3-4の差分（レビューコメントを踏まえた修正前後）が見れることで、再レビューがものすごくラクになります。

今までslackで行っていたやりとりを履歴管理でできるようになったり、いつでも簡単に修正履歴の差分が見れるようになり、この機能のリリースにより私の悩みが解決しました。

履歴機能の使い方のアイデア

テストケースレビューだけでなく、「悪いテストケースの例」とそれに対して「改善したテストケースの例」などを示すのに活用できるかなと思います。

• 履歴機能がない場合

  • 「悪いテストケースの例」とそれに対して「改善したテストケースの例」の２ケースを作成する。
    →この場合、差分などが把握しづらい

• 履歴機能を使った場合

  • 履歴機能があることで、簡単にテストケースの改善前、改善後の差分を見れるようになりました。
    例
    1. 改善前のテストケースの例を作成
    2. ベースURLを利用するように改善
    3. 共有変数を使うように改善
    4. 共有ステップ化し、改善

MagicPodに慣れていない人がいきなり1と4の差分を見ても、差分が多くてどこからどう改善したのか理解しづらいかなと思います。上記の例のように履歴機能を使うことで、どういった順序で良いテストケースに変わっていくかが理解しやすくなると思います。
そのため、履歴機能はテストケースレビューへの活用だけでなく、このようにお手本を示すのにも利用できるかなと思います。

まとめ

MagicPodに追加された履歴機能を使いこなすことで、チームとしての生産性を高めることができると思います。また、今回の履歴機能に限らず、MagicPodには日々便利な機能が追加されています。リリース内容を把握し、追加された便利な機能を活用していくことが大事だと改めて思いました。