带注释的方法风格

@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 文档

对于使用 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

请注意，您需要将 cucumber-core jar 及其所有传递依赖项添加到您的类路径中，以及您的编译 .class 文件的位置。您可以在 Maven 中央仓库 中找到这些 jar 包。

您还需要通过 --glue 选项，后面跟其包名，以及功能文件（s）的文件路径，向 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 这两个格式化程序插件，可以这样指定

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 运算符组合在一起。换句话说，两个表达式都需要匹配。