クリーンアップステップ

概要

クリーンアップステップは、たとえ先行するステップで失敗が起こったとしても、テスト実行の最後に必ず実行される特別なステップです。特に、次のテスト実行が同じ条件で行われるよう、テスト実行中に生成されたデータを削除するなど、結果の成否によらずテストの最後に必ず実行する必要のあるステップがある場合にとても便利です。

クリーンアップステップを有効化する

クリーンアップステップは既存のシナリオに追加できますが、はじめは表示されていません。機能を有効化するには、シナリオ詳細画面のオプションタブを開き、「クリーンアップステップを表示する」にチェックを入れます。

シナリオのタブに戻ると、クリーンアップステップのセクションが画面の下部に追加されています。

クリーンアップステップを作成する

クリーンアップステップの作りかたには、二つの方法があります。

既存のステップをドラッグ&ドロップしてクリーンアップステップにする

もし、既にシナリオ内にクリーンアップステップとして利用できるようなステップがある場合は、クリーンアップステップの領域にステップをドラッグ&ドロップすることができます。

クリーンアップステップを新規にレコーディングする

クリーンアップステップは、1からレコーディングすることも可能です。なお、レコーディングはシナリオのステップ1のURLから始まる点にご注意ください。異なるURLからクリーンアップステップをレコーディングしたい場合には、クリーンアップステップの冒頭に「URLに移動」ステップを追加してください。

クリーンアップステップを持つシナリオを実行する

クリーンアップステップは、通常のステップと同様に実行できます。しかし、どのようにステップが実行されるかが異なります。

シナリオ

ステップ1から3が通常のステップ（「このステップが失敗した時」は「テストを終了する」に設定されている）で、ステップ4から5はクリーンアップステップとなっている例では

• すべて成功した場合、ステップは 1 → 2 → 3 → 4 → 5 の順で実行されます。
• もしシナリオがステップ2で失敗した場合、 1 → 2 → 4 → 5 の順で実行されます。

テスト結果

テスト結果詳細画面は、二つのパートに分けられます。通常のステップと、クリーンアップステップです。

成功したテスト結果

テストが失敗しクリーンアップステップが実行されたテスト結果

通常のステップが途中で失敗しても、クリーンアップステップは実行されます。

クリーンアップステップが失敗したテスト結果

クリーンアップステップ自体も失敗することがあります。テストは失敗とみなされますが、エラーメッセージの領域は黄色にハイライトされ、通常のステップの失敗と見分けがつきやすくなっています。

活用のコツ

冒頭に「URLに移動」ステップを追加する

クリーンアップステップは最初のURLを指定しなくても動作します。一方、クリーンアップステップが常に特定のURLから始まるようにしたい場合は「URLに移動」ステップを追加するようにしてください。

データをクリアするAPIのエンドポイントを用意する

テスト中に生成されたデータをクリーンアップするベストプラクティスの一つには、テストデータをクリアするようなAPIのエンドポイントを用意しJSステップから呼び出す方法があります。また、よりシンプルに、アプリケーションの操作でデータを消したり元の状態に戻したりするステップをレコーディングするのもよいでしょう。