自动化测试框架cucumber-java操作手册_从配置到生成测报


一、cucumber简介

cucumber是BDD(Behavior-driven development,行为驱动开发)的一个自动化测试框架产品。cucumber使用自然语言来描述测试,通过设置中文描述可以连通业务人员和开发人员,使得需求清晰明了,实现需求的实例化。Gherkin是这种自然语言测试的简单语法,Cucumber是可以执行它们的工具。

本文主要从实际的项目角度,将cucumber应用于自动化业务验收测试,结合图例介绍java对应的cucumber配置搭建至生成业务验收测试报告的操作步骤。具体BDD及cucumber的语法及介绍可参考cucumber官网链接或其他文档,如自动化测试之cucumber(一)

二、实现cucumber业务验收测试

2.1 配置IDEA插件

本项目为maven项目,开发的IDE为idea。

首先,在idea中加入Gherkin、Cucumber for Groovy、Cucumber for java三个插件。

idea中cucumber插件

2.2 配置pom文件

本项目java版本是1.8,使用的cucumber版本是6.8.1(此处说明:不同版本的cucumber对于代码生成、配置文件格式等差异较大,需提前关注好cucumber的版本,笔者在此处踩过许多坑)。

pom.xml中加入cucumber依赖,如下:

<properties>

    <java.version>1.8</java.version>

    <cucumber.version>6.8.1</cucumber.version>

</properties>


<!--cucumber测试-->

    <dependency>

    <groupId>io.cucumber</groupId>

    <artifactId>cucumber-java</artifactId>

    <version>${cucumber.version}</version>

    <scope>test</scope>

</dependency>


<dependency>

    <groupId>io.cucumber</groupId>

    <artifactId>cucumber-junit</artifactId>

    <version>${cucumber.version}</version>

    <scope>test</scope>

</dependency>


<dependency>

    <groupId>io.cucumber</groupId>

    <artifactId>cucumber-spring</artifactId>

    <version>${cucumber.version}</version>

    <scope>test</scope>

</dependency>


<dependency>

    <groupId>junit</groupId>

    <artifactId>junit</artifactId>

    <version>4.12</version>

    <scope>test</scope>

</dependency>

2.3 编辑feature和步骤定义文件

根据业务需求,在src/test/resources目录下编辑.feature文件,在src/test/java目录下撰写每一个step对应的步骤定义java文件。

需要注意的是,cucumber可以支持多种语言,包括中文。本文仅介绍中文实现方式,具体关键字及其他语言的使用见官方文档

中文实现方式:在feature文件中加入:

# language:zh-CN

在对应的步骤定义文件中加入:(tips:不同的cucumber版本,import的方式不同)

import io.cucumber.java.zh_cn.*;

feature文件中文的关键字对照表如下:

feature文件中文对应的关键字

2.3.1 编辑feature文件

feature可以使用自然语言描述业务需求,实现业务需求的实例化,便于业务人员与开发人员的沟通与理解。

feature文件编辑示例

一个feature文件中可以有多个功能(Feature),一个功能(Feature)下可包含多个场景(Scenario)。但每个场景(Scenario)都是独立存在的,不依赖于其他场景(Scenario),即放在任何feature文件中都可以独立运行成功。

feature文件中功能(Feature)及场景(Scenario)示例

feature文件中可以通过标点区分step中的string、int等基础参数字段类型(如上图双引号内的"张三"默认为string类型),并在生成步骤定义时自动识别为到方法的输入参数。

当场景(Scenario)中具有多个参数,且参数的不同会导致不同的测试结果,这时可以使用场景大纲(Scenario outline)将所有参数排列组合的测试结果全部罗列下来,形成实例化需求。

Tips:Scenario Outline(场景轮廓)中可以使用多个Examples(例子),但是尽量不要将表格写得太长,因为应把实例的说明性代表性作为目标,而不是详尽。在cucumber的验收测试中,可读性是最重要的。

场景大纲(Scenario outline)  示例

上图示例中使用到了数据表(step:假如 准入名单内已有下列的客户),Gherkin可以传递List、Map,称为DataTable,具体例子查看该github上的文档

2.3.2 撰写步骤定义文件

步骤定义文件即StepDefine文件,又称为胶水代码,是连接feature文件和后端服务的桥梁,实现了将feature文件中业务需求的自然语言转化为java代码,通过发送请求对后端逻辑进行测试。

步骤定义中的方法通过@关键字与feature文件的step语句进行唯一匹配。也就是说,如果多个step描述相同,在步骤定义中是共用一个方法的,而如果我们想实现step与方法一一对应,需要在编写feature文件时,对每一个step的描述仔细斟酌。

对应的步骤定义文件

在步骤定义java文件中,部分低版本的cucumber是通过正则表达式匹配feature文件中的step,但在本项目中6.8.1版本的cucumber可以直接使用双引号及{string}的方式匹配step,更加便于理解了。

2.3.2.1 安全认证

在本项目中,由于加入了Security,在向后端发送请求时需要先进行安全认证,所以在验收测试案例执行前需要先定义好登录用户。

"username"为"zhoutr"

"password"为"123456"

安全认证

2.3.2.2 清空数据表

在铺数前,需要先清空数据表,防止已有数据的干扰对测试结果产生影响。

//清除数据表 

this.deleteAll("customer_info");


void deleteAll(final String tableName) {

    this.apply(deleteAllFrom(tableName));

}

//执行数据库操作

void apply(final Operation operation) {

    new DbSetup(databaseDestianton, operation).launch();

}

2.3.2.3 铺数

在某个测试案例的所有数据获取完成后,发送请求前的最后一步是集中铺数,即向数据库中插入测试案例中的数据。下图中这个场景下有5个字段,即客户名称、证件类型、证件号码、客户类型、客户状态。

铺数代码

Tips:本项目中使用了DbSetup for Ningjia实现数据库操作。

2.3.2.4 发送请求至后端

在铺好数据后,就可以向数据库发送post请求了。

在发送前需要先确认后端对于返回码的定义,例如本项目中返回码code为0,msg为“成功”时,代表发送请求成功,返回该客户允许准入。若返回码code为1,msg为“失败”时,代表发送请求成功,返回该客户由于命中黑名单而不允许准入。

发送请求至后端

Tips:

1、判断成功与否应使用唯一标识返回码,如本项目中的code取值0、1、2、3等,不可以使用msg取值“成功”、“失败”,因为失败的情况有很多种,msg的返回并不唯一。

2、如果想对比校验接口是否成功以及成功的返回信息,可以使用postman对比测试。

2.4 cucumber测试运行

2.4.1 运行前提

在运行前,需要有两个先决条件,如果有一个条件未满足,测试就无法运行:

1、服务器已处于成功运行状态

2、用于测试的数据库已连接

建议新建一个单独用于cucumber业务验收测试的数据库(本项目使用的是本地MySQL数据库),因为在测试前会先清空数据表,然后铺数、最后再测试。如果与开发或生产共用同一个数据库,数据删除后可能会导致不可预估的后果。

在src/test/java目录下,一般会有一个主运行函数CucumberTest.java,其中@CucumberOptions是对测试运行方式进行配置,具体介绍见Cucumber之五Cucumber Options详解,本项目中仅设置了feature文件所在位置(features)和生成基础测报的格式(plugin)。测报的生成会在下文中具体介绍。

CucumberTest.java

此处需要注意的是,不同版本的cucumber对@CucumberOptions内参数的编写格式不同,如果写错了,运行时会报错(笔者在此处踩过坑 QAQ)。

2.4.2 cucumber测试运行

一切准备就绪后,测试的运行就变得很简单啦~

可以整体运行,也可以单独运行:

1、整个项目的测试案例运行:点击CucumberTest中的运行按钮,或者右键Run CucumberTest.java,即可运行。

2、某个feature文件或某个场景(Scenario)单独运行:点击feature文件中功能(Feature)或场景(Scenario)前面的运行箭头,即可运行。

遇到的问题及解决方法

1、无法通过点击feature文件中的运行箭头直接运行。即,明明是passd的steps,但通过该方式点击运行显示都是undefined。

解决方法:在IDEA的Run Configuration中,对于该场景的运行设置Glue路径,即该feature文件匹配的步骤定义文件路径。

Run Configuration配置

三、生成cucumber测试报告

3.1 本地官方测报

在CucumberTest.java文件的@CucumberOptions中,写入生成json及html报告。

plugin = {"pretty",

               "json:target/cucumber-report/json-files/cucumber.json",

                "html:target/cucumber-report/cucumber.html"},    //生成本地json和html测试报告

注意:不同的cucumber版本写入格式不同。

本地官方测报配置

运行后,根据配置好的路径,在target文件下可看到生成的本地官方测报。

本地官方测报生成路径

HTML格式测试报告:

本地官方html测试报告样式

JSON格式测试报告:

本地官方json测试报告样式  

3.2 远程官方测报

在src/test/resources目录下新建cucumber.properties文件,文件中写入

#生成远程官方测试报告

cucumber.publish.enabled=true

运行测试后,即可在官网上生成远程测试报告:

生成远程官方测试报告

测报样式如下图,但该测报生成必须联网,且该测报生成后只能保留24小时。

远程官方测试报告样式

3.3 cluecumber测试报告

cluecumber为生成测试报告的第三方插件,可以生成html测报,该测报生成需以本地json测报的生成为基础(见本文3.1章节),官方介绍连接cluecumber-reporting

pom.xml中加入依赖:

<dependency>

    <groupId>com.trivago.rta</groupId>

    <artifactId>cluecumber-report-plugin</artifactId>

    <version>2.5.0</version>

</dependency>

<!--cucumber test:cluecumber-report-->

<plugin>

<groupId>com.trivago.rta</groupId>

<artifactId>cluecumber-report-plugin</artifactId>

<version>2.5.0</version>

<executions>

<execution>

<id>report</id>

<phase>post-integration-test</phase>

<goals>

<goal>reporting</goal>

</goals>

</execution>

</executions>

<configuration>

<!--获取json报告的路径&生成html报告的路径,注意修改为本地 {project.build.directory}-->

<sourceJsonReportDirectory>d:/CMIS/Legend/target/cucumber-report/json-files</sourceJsonReportDirectory>

<generatedHtmlReportDirectory>d:/CMIS/Legend/target/cluecumber-generated-report</generatedHtmlReportDirectory>

<customPageTitle>Cmis-Server Report</customPageTitle>

</configuration>

</plugin>

添加依赖后,执行

mvn cluecumber-report:reporting

然后再Run CucumberTest.java,就可以在指定目录下(target/cluecumber-generated-report)看到生成的html报告。

生成测报

打开index.html就可以看到cluecumber的测报,该测报可以从Scenarios、Scenario Sequence、Tags、Steps、Features等多种维度分析测试结果。

Scenarios


Steps
Features

cluecumber生成的测报更关注用图形化表示整体结果,而本地测报能够从细节看出每一个step的内容和执行情况,在具体的项目中,可以将两种测报结合使用。

Tips:更多的测试报告可参考官方测试报告

后续计划研究下cucumber的标签功能(Tags),尝试结合selenium进行前端页面的测试,并完善验收测试报告的优化,本文将持续更新。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,723评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,485评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,998评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,323评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,355评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,079评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,389评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,019评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,519评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,971评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,100评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,738评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,293评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,289评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,517评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,547评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,834评论 2 345

推荐阅读更多精彩内容