在 Cucumber 测试中自动将 Cucumber 数据表映射到 Java 对象
作为 Java 开发人员,使用 Cucumber 进行行为驱动开发 (BDD) 是一种很好的方法,可以通过使用通俗易懂的语言编写测试来确保代码满足业务要求。Cucumber 最强大的功能之一是能够在功能文件中使用数据表。但是,手动将这些表映射到 Java 对象可能是重复的,并且容易出错。
为了简化此过程,库 cucumber-datatable-to-bean mapping 旨在自动将 Cucumber 数据表映射到 Java 对象。在本文中,我将向您介绍该库的功能,以及如何轻松地将其集成到 Cucumber 项目中,以节省时间并减少样板代码。
如何使用 cucumber-datatable-to-bean 映射
让我们深入了解如何在项目中使用此库。
第 1 步:将库添加到您的项目中
首先,您需要将 cucumber-datatable-to-bean 映射库添加到您的 Maven 或 Gradle 项目中。
对于 Maven,请将以下依赖项添加到您的 pom.xml:
XML 格式
<dependency>
<groupId>io.github.deblockt</groupId>
<artifactId>cucumber-datatable-to-bean-mapping</artifactId>
<version>1.1.2</version>
</dependency>
对于 Gradle,请将以下内容添加到您的 build.gradle 中:
槽的
implementation 'io.github.deblockt:cucumber-datatable-to-bean-mapping:1.1.2'
第 2 步:定义 Java Bean
创建一个 Java Bean 类,该类表示要从 Cucumber 数据表映射的数据结构。使用 Java 注释来指定表头和 Bean 字段之间的映射。
例如,假设您有一个特征文件,其中包含如下所示的数据表:
小黄瓜
Given the following users exist
| first name | last name | email |
| John | Doe | john.doe@example.com |
| Jane | Smith | jane.smith@example.com |
您可以为User
爪哇岛
import com.deblock.cucumber.datatable.annotations.DataTableWithHeader;
import com.deblock.cucumber.datatable.annotations.Column;
@DataTableWithHeader
public class User {
@Column
private String firstName;
@Column
private String lastName;
@Column
private String email;
// Getter / Setter
}
// Or use a record
@DataTableWithHeader
public record User(@Column String firstName, @Column String lastName, @Column String email) {}
步骤 3:注释您的步骤定义
现在,您可以在步骤定义中使用此类。
例如:
爪哇岛
import io.cucumber.java.en.Given;
import java.util.List;
public class UserStepDefinitions {
@Given("the following users exist")
public void theFollowingUsersExist(List<User> users) {
for (User user : users) {
System.out.println("Creating user: " + user.getFirstName() + " " + user.getLastName());
// Logic to handle user creation
}
}
}
第 4 步:运行 Cucumber 测试
就这样:您现在可以运行 Cucumber 测试,该库会自动将数据表映射到对象列表。步骤定义中的 s 参数将填充特征文件中的数据,并且您可以轻松地迭代用户并执行任何必要的逻辑。User
User
配置
Column Extra 配置
前面的示例使用默认库配置。但是,您可以在注释中提供更多详细信息,例如设置字段描述、定义字段是否为必填字段或指定列的默认值。@Column
爪哇岛
@DataTableWithHeader
public class User {
@Column(mandatory = false, description = "The custom first name")
private String firstName;
@Column(defaultValue = "Doe")
private String lastName;
@Column(value = "overridden email name")
private String email;
// Getters and Setters
}
库配置
默认情况下,列名是使用人类可读格式(驼峰式命名法转换为带空格的单词)从字段名生成的。您可以通过向文件添加特定属性来覆盖此行为。cucumber.properties
属性文件
cucumber.datatable.mapper.name-builder-class=com.deblock.cucumber.datatable.mapper.name.UseFieldNameColumnNameBuilder
使用此配置,列名称将直接使用字段名称,而无需将其转换为人类可读的格式。
此外,虽然通常建议使用注释注释所有 Data Table 列,但您可以将库配置为自动将所有类字段用作 Data Table 列。@Column
属性文件
cucumber.datatable.mapper.field-resolver-class=com.deblock.cucumber.datatable.mapper.datatable.fieldresolvers.ImplicitFieldResolver
使用此配置,您可以更简洁地定义 Java bean:
爪哇岛
@DataTableWithHeader
public class User {
private String firstName;
private String lastName;
private String email;
@Ignore
private String externalInformation;
// Getters and Setters
}
通过以这种方式配置库,除非使用注释明确忽略,否则所有字段都将自动作为 Data Table 列包含在内。@Ignore
为什么使用 cucumber-datatable-to-bean 映射?
自动映射:通过使用注释定义一次映射规则,您可以自动将数据表转换为 Java 对象。
减少样板代码:此库最大限度地减少了映射数据表所需的代码量,使您的步骤定义更简洁、更易于维护。
提高可读性:由于步骤定义中的映射代码越来越少,您的测试将变得更易于阅读和理解,这是 BDD 的核心原则之一。
增强映射错误处理:如果数据表存在问题,例如缺少列或数据类型不正确,该库会提供详细的错误消息,以帮助进行调试和测试。
cucumber-datatable-to-bean-mapping 库简化了将 Cucumber 数据表转换为 Java 对象的过程,从而节省了时间并降低了 BDD 测试中出现错误的可能性。通过将此库添加到您的项目中,您可以简化步骤定义,并将更多精力放在编写有意义的测试而不是样板代码上。
原文地址:https://blog.csdn.net/u013528853/article/details/142203018
免责声明:本站文章内容转载自网络资源,如本站内容侵犯了原著者的合法权益,可联系本站删除。更多内容请关注自学内容网(zxcms.com)!