註解方法樣式

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

註解方法樣式

@Before
public void doSomethingBefore() {
}

Lambda 風格

Before(() -> {
});

如果需要，您可以為鉤子指定明確的順序。

註解方法樣式

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

Lambda 風格

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

註解方法樣式

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

Lambda 風格

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

註解方法樣式

@BeforeStep
public void doSomethingBeforeStep(Scenario scenario){
}

Lambda 風格

BeforeStep((Scenario scenario) -> {

});

註解方法樣式

@AfterStep
public void doSomethingAfterStep(Scenario scenario){
}

Lambda 風格

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

註解方法樣式

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

Lambda 風格

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 文件

對於 JUnit 4 和 TestNG，請使用 JVM 系統屬性

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 Runner) 是一個可從命令列執行的 Java 可執行類別。

java io.cucumber.core.cli.Main

請注意，除了已編譯的 .class 檔案的位置外，您還需要將 cucumber-core jar 及其所有可轉移的相依性新增至您的類別路徑。您可以在 Maven Central 中找到這些 jar。

您還需要透過 --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 {
}

這將預設執行與執行器位於相同套件中的所有情境，glue 程式碼也假設位於相同的套件中。

@CucumberOptions 可用於為執行器提供額外的設定。

使用外掛程式

例如，如果您想要告訴 Cucumber 使用兩個格式器外掛程式 pretty 和 html，您可以這樣指定

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 {
}

指定物件工廠

例如，如果您將 Cucumber 與 DI 架構搭配使用，並想要使用自訂的物件工廠，您可以這樣指定

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 的屬性是由 Junit Platform 而非 Cucumber 提供。請參閱 junit-platform-engine 配置選項 以取得更多資訊。

例如，如果您使用 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 運算符組合的。換句話說，兩個表達式都需要匹配。