アノテーション付きメソッドスタイル

@Given("the following animals:")
public void the_following_animals(List<String> animals) {
}

アノテーション付きメソッドスタイル

@Before
public void doSomethingBefore() {
}

ラムダスタイル

Before(() -> {
});

必要に応じて、フックの明示的な順序を指定できます。

アノテーション付きメソッドスタイル

@Before(order = 10)
public void doSomething(){
    // Do something before each scenario
}

ラムダスタイル

Before(10, () -> {
    // Do something before each scenario
});

アノテーション付きメソッドスタイル

@After
public void doSomethingAfter(Scenario scenario){
    // Do something after after scenario
}

ラムダスタイル

After((Scenario scenario) -> {
});

アノテーション付きメソッドスタイル

@BeforeStep
public void doSomethingBeforeStep(Scenario scenario){
}

ラムダスタイル

BeforeStep((Scenario scenario) -> {

});

アノテーション付きメソッドスタイル

@AfterStep
public void doSomethingAfterStep(Scenario scenario){
}

ラムダスタイル

AfterStep((Scenario scenario) -> {
});

アノテーション付きメソッドスタイル

@After("@browser and not @headless")
public void doSomethingAfter(Scenario scenario){
}

ラムダスタイル

After("@browser and not @headless", (Scenario scenario) -> {
});

アノテーション付きメソッドスタイル

@BeforeAll
public static void beforeAll() {
    // Runs before all scenarios
}

アノテーション付きメソッドスタイル

@AfterAll
public static void afterAll() {
    // Runs after all scenarios
}

JUnit 5については、cucumber-junit-platform-engineのドキュメントを参照してください。

JVMシステムプロパティを使用するJUnit 4およびTestNGの場合

mvn test -Dcucumber.filter.tags="@smoke and @fast"

または環境変数

# Linux / OS X:
CUCUMBER_FILTER_TAGS="@smoke and @fast" mvn test

# Windows:
set CUCUMBER_FILTER_TAGS="@smoke and @fast"
mvn test

または、JUnit 4/TestNGランナークラスを変更する

@CucumberOptions(tags = "@smoke and @fast")
public class RunCucumberTest {}

JUnitランナークラスを使用する

@CucumberOptions(tags = "not @smoke")
public class RunCucumberTest {}

Cucumber は、さまざまなツールやプラットフォーム向けの拡張機能を備えた Java ライブラリです。JUnit 4、JUnit 5、ビルドツール、IDE、または CLI を実行することで起動されます。

コマンドラインインターフェースランナー (CLI ランナー) は、コマンドラインから実行できる実行可能な Java クラスです。

java io.cucumber.core.cli.Main

コンパイルされた .class ファイルの場所に加えて、cucumber-core jar とそのすべての推移的な依存関係をクラスパスに追加する必要があることに注意してください。これらの jar は、Maven Central で見つけることができます。

また、--glue オプションの後にパッケージ名とフィーチャーファイルのファイルパスを指定して、CLI にステップ定義を提供する必要があります。

例えば

java -cp "path/to/each/jar:path/to/compiled/.class/files" io.cucumber.core.cli.Main /path/to/your/feature/files --glue hellocucumber --glue anotherpackage

または、Maven プロジェクトを使用している場合は、Exec Maven プラグインを使用して CLI を実行できます。

mvn exec:java                                  \
    -Dexec.classpathScope=test                 \
    -Dexec.mainClass=io.cucumber.core.cli.Main \
    -Dexec.args="/path/to/your/feature/files --glue hellocucumber --glue anotherpackage"

詳細については、cucumber-junit-platform-engine ドキュメントを参照してください。

JUnit を使用して Cucumber シナリオを実行するには、cucumber-junit 依存関係を pom に追加します。

<dependencies>
  [...]
    <dependency>
        <groupId>io.cucumber</groupId>
        <artifactId>cucumber-junit</artifactId>
        <version>${cucumber.version}</version>
        <scope>test</scope>
    </dependency>
  [...]
</dependencies>

cucumber-junit は JUnit 4 に基づいていることに注意してください。JUnit 5 を使用している場合は、cucumber-junit-platform-engine を使用するか、junit-vintage-engine 依存関係を含めます。詳細については、JUnit 5 ドキュメントを参照してください。

Cucumber JUnit ランナーを使用する空のクラスを作成します。

package com.example;

import io.cucumber.junit.Cucumber;
import io.cucumber.junit.CucumberOptions;
import org.junit.runner.RunWith;

@RunWith(Cucumber.class)
@CucumberOptions()
public class RunCucumberTest {
}

package com.example

import io.cucumber.junit.Cucumber
import io.cucumber.junit.CucumberOptions
import org.junit.runner.RunWith

@RunWith(Cucumber::class)
@CucumberOptions()
class RunCucumberTest {
}

package com.example

import io.cucumber.junit.Cucumber
import io.cucumber.junit.CucumberOptions
import org.junit.runner.RunWith

@RunWith(classOf[Cucumber])
@CucumberOptions()
class RunCucumberTest {
}

これにより、デフォルトでは、ランナーと同じパッケージ内のすべてのシナリオが実行されます。グルーコードも同じパッケージ内にあると想定されます。

@CucumberOptions を使用して、ランナーに追加の構成を提供できます。

プラグインの使用

たとえば、Cucumber に pretty と html の 2 つのフォーマッタプラグインを使用するように指示する場合は、次のように指定できます。

package com.example;

import io.cucumber.junit.Cucumber;
import io.cucumber.junit.CucumberOptions;
import org.junit.runner.RunWith;

@RunWith(Cucumber.class)
@CucumberOptions(plugin = {"pretty", "html:target/cucumber.html"})
public class RunCucumberTest {
}

たとえば、Cucumber に欠落しているステップ定義のコードスニペットを印刷するように指示する場合は、summary プラグインを使用すると、次のように指定できます。

package com.example;

import io.cucumber.junit.Cucumber;
import io.cucumber.junit.CucumberOptions;
import org.junit.runner.RunWith;

@RunWith(Cucumber.class)
@CucumberOptions(plugin = {"pretty", "summary"}, snippets = SnippetType.CAMELCASE)
public class RunCucumberTest {
}

snippets のデフォルトオプションは UNDERSCORE です。この設定は、Cucumber がコードスニペットを作成する方法を指定するために使用できます。

ドライランの実行

たとえば、すべてのフィーチャーファイルのステップに対応するステップ定義があるかどうかを確認する場合は、次のように指定できます。

package com.example;

import io.cucumber.junit.Cucumber;
import io.cucumber.junit.CucumberOptions;
import org.junit.runner.RunWith;

@RunWith(Cucumber.class)
@CucumberOptions(dryRun=true)
public class RunCucumberTest {
}

dryRun のデフォルトオプションは false です。

コンソール出力のフォーマット

たとえば、Cucumber からのコンソール出力を読みやすい形式にしたい場合は、次のように指定できます。

package com.example;

import io.cucumber.junit.Cucumber;
import io.cucumber.junit.CucumberOptions;
import org.junit.runner.RunWith;

@RunWith(Cucumber.class)
@CucumberOptions(monochrome=true)
public class RunCucumberTest {
}

monochrome のデフォルトオプションは false です。

タグを使用したシナリオの選択

たとえば、Cucumber に特定のタグで指定されたシナリオのみを実行するように指示する場合は、次のように指定できます。

package com.example;

import io.cucumber.junit.Cucumber;
import io.cucumber.junit.CucumberOptions;
import org.junit.runner.RunWith;

@RunWith(Cucumber.class)
@CucumberOptions(tags = "@foo and not @bar")
public class RunCucumberTest {
}

オブジェクトファクトリの指定

たとえば、DI フレームワークで Cucumber を使用していて、カスタムオブジェクトファクトリを使用したい場合は、次のように指定できます。

package com.example;

import io.cucumber.junit.Cucumber;
import io.cucumber.junit.CucumberOptions;
import org.junit.runner.RunWith;

@RunWith(Cucumber.class)
@CucumberOptions(objectFactory = FooFactory.class)
public class RunCucumberTest {
}

objectFactory のデフォルトオプションは、デフォルトのオブジェクトファクトリを使用することです。カスタムオブジェクトファクトリの使用に関する詳細については、こちらをご覧ください。

@CucumberOptions アノテーションには、追加のオプションを使用できます。

通常、テストクラスは空になります。ただし、いくつかの JUnit ルールを指定できます。

Cucumber ランナーは、JUnit テストのスイートのように機能します。そのため、カテゴリ、カスタム JUnit リスナー、レポーターなどの他の JUnit 機能もすべて動作すると予想できます。

JUnit の詳細については、JUnit ウェブサイトを参照してください。

--help オプションを渡して、利用可能なすべての構成オプションを出力します。

java io.cucumber.core.cli.Main --help

Cucumberは、システムプロパティ、環境変数、cucumber.propertiesファイルの順に、優先順位に従ってプロパティを解析します。

@CucumberOptionsで提供されるオプションはプロパティファイルよりも優先され、CLI引数はすべてに優先されることに注意してください。

cucumber-junit-platform-engineには、CucumberではなくJunit Platformによってプロパティが提供されることに注意してください。詳細については、junit-platform-engine Configuration Optionsを参照してください。

たとえば、Mavenを使用しており、@smokeタグが付いたシナリオのサブセットを実行したい場合。

mvn test -Dcucumber.filter.tags="@smoke"

サポートされているプロパティは次のとおりです。

cucumber.ansi-colors.disabled=  # true or false. default: false
cucumber.execution.dry-run=     # true or false. default: false
cucumber.execution.limit=       # number of scenarios to execute (CLI only).
cucumber.execution.order=       # lexical, reverse, random or random:[seed] (CLI only). default: lexical
cucumber.execution.wip=         # true or false. default: false.
cucumber.features=              # comma separated paths to feature files. example: path/to/example.feature, path/to/other.feature
cucumber.filter.name=           # regex. example: .*Hello.*
cucumber.filter.tags=           # tag expression. example: @smoke and not @slow
cucumber.glue=                  # comma separated package names. example: com.example.glue
cucumber.plugin=                # comma separated plugin strings. example: pretty, json:path/to/report.json
cucumber.object-factory=        # object factory class name. example: com.example.MyObjectFactory
cucumber.snippet-type=          # underscore or camelcase. default: underscore

フィルターオプションであるcucumber.filter.nameとcucumber.filter.tagsは、and演算を使用して結合されることに注意してください。つまり、両方の式が一致する必要があります。