こんにちは！SPEEDA開発チームの工藤です。
大分時間が開いてしまいましたが、Gaugeシリーズの第四回目です。
今回はe2eテスト書く際には必須であろうSet Up/Tear Down Stepsを、Gaugeではどのように実現できるのかをSPEEDA開発チームでの実例も交えてお伝えできればと思います。
過去３回分の記事はこちらから↓
GaugeにおけるSet Up/Tear Down Stepsの実現方法
Gaugeには、Set Up StepsやTear Down Stepsを実現できる手段がいくつか用意されています。
用途に合わせて下記のいずれかを選択して使います。
- Contexts
- Tear Down Steps
- Execution Hooks
上記３つについて順番にお伝えしていきます。
Contexts
GaugeではSet Up StepsをContextsと呼んでいます。 context stepsを使用することで、SpecファイルのScenarioの実行に必要な条件を指定できます。
Specファイル内先頭のScenarioの前にStepを記述すると、そのStepが全てのScenarioの最初に実行されます。（GaugeにおけるSpecやScenarioなどのワードに馴染みのない方は第一回目の記事をご覧ください）
下記例ではScenario 1の前に「ユーザーAでログイン」、「プロジェクトページに遷移する」というStepを記述していて、このStepがScenario 1、2の最初に実行されます。
# プロジェクトの削除 context steps * ユーザーAでログイン * プロジェクトページに遷移する Scenario 1 ## １つのプロジェクトを削除 * プロジェクト"project_a"を削除 * プロジェクト"project_a"が削除されていることを確認 Scenario 2 ## 複数のプロジェクトを削除 * プロジェクトリスト上の全てのプロジェクトを削除 * プロジェクトリストが空であることを確認
各Scenarioで必要だがあまり仕様的には重要ではないセットアップ処理などをContextsにまとめることで、Specificationの冗長さをなくすことができます。
SPEEDA開発ではSpecファイルをページ単位で切ることが多いのでテスト対象のページに遷移するステップや、ログイン処理をここに書くことが多いです。
Tear Down Steps
Tear Down StepsはSpecファイル内最後のScenarioの後に記載します。 Scenarioの実行を終えるために必要なStepがあればTear Down Stepsとして定義します。
３つ以上のアンダースコアを記述することでTear Down Stepsを指定することができます。
___ * Tear down step 1 * Tear down step 2 * Tear down step 3
下記の例では、アンダースコアの後に記述されている「ユーザーAでログアウト」と「ユーザーAを削除」がTear Down Stepsになります。このSpecificationが実行されると、下記の順で実行されます。
- Contextsの実行
１つのプロジェクトを削除のScenarioの実行- Tear Down Stepsの実行
- Contextsの実行
複数のプロジェクトを削除のScenarioの実行- Tear Down Stepsの実行
# プロジェクトの削除 * ユーザーAを作成 * ユーザーAでログイン Scenario 1 ## １つのプロジェクトを削除 * プロジェクト"project_a"を削除 * プロジェクト"project_a"が削除されていることを確認 Scenario 2 ## 複数のプロジェクトを削除 * プロジェクトリスト上の全てのプロジェクトを削除 * プロジェクトリストが空であることを確認 ___ ここからTear Down Steps * ユーザーAでログアウト * ユーザーAを削除
SPEEDA開発では実はあまりTear Down Stepsは使っていません、Tear Downとしては後述するExecution Hooksを使う方が多いです。
Execution hooks
Execution hooksを使うとSuite,Spec,Scenario,Stepの単位で任意のテストコードを実行することができます。
ContextsやTear DownはSpecファイル毎且つScenarioにしか定義できませんが、Execution HooksはSpecファイルを跨いで且つ様々な単位で定義できます。
import com.thoughtworks.gauge.*
class ExecutionHooksExample {
@BeforeSuite
fun beforeSuite() {
// 全てのテスト実施前の最初に一度だけ実行される処理
}
@AfterSuite
fun afterSuite() {
// 全てのテスト実施後の最後に一度だけ実行される処理
}
@BeforeSpec
fun beforeSpec() {
// 各Specファイルのテスト実施の先頭に一度だけ実行される処理
}
@AfterSpec
fun afterSpec() {
// 各Specファイルのテスト実施の最後に一度だけ実行される処理
}
@BeforeScenario
fun beforeScenario() {
// 各Scenario実施前に実行される処理
}
@AfterScenario
fun afterScenario() {
// 各Scenario実施後に実行される処理
}
@BeforeStep
fun beforeStep() {
// 各Step実施前に実行される処理
}
@AfterStep
fun afterStep() {
// 各Scenario実施後に実施される処理
}
}
SPEEDAでは下記のような処理はBefore Suiteで実行しています
- 一度だけ設定ファイルを読み込む
- Read-Onlyデータの投入
また下記のような処理はAfter Scenarioで実行しています
- ログアウト
- WebdriverのClose処理
その他にもDBやモックのセットアップ処理もExecution Hooksを使用して任意のタイミングで実行しています。
Execution hooksを特定のTagが指定されている場合のみ実行されるようにすることも可能です。その場合は下記のように指定します。
// tag1 または tag2がついているScenarioでのみ前処理として下記を実行
@BeforeScenario(tags = {"tag1, tag2"})
fun setupDataBase() {
// Code for before scenario
}
まとめ
GaugeはExecutable Specificationを謳っていてSpecファイルやScenarioは実行可能な"仕様書"である必要があります。
SPEEDA開発では今回ご紹介した機能を使ってSpecificationファイルの記述を出来るだけ簡潔にして、より仕様書として読みやすくするよう心がけています。
