其他测试框架 前端开发:基于 cypress 的自动化实践

虫师 · 2021年03月23日 · 最后由 干饭狂人 回复于 2022年04月07日 · 13252 次阅读
本帖已被设为精华帖!

作为一个伪开发,在一个平台项目中负责前端的开发工作,开发框架为 vue,本文我会站在前端开发的角度介绍,我是如何使用 cypress 的。

  • [x] 如何在 vue 中使用 cypress
  • [x] 如何运行 cypress
  • [x] 如何编写测试用例
  • [x] 如何解决测试数据的问题
  • [x] 遇到的元素定位的问题
  • [x] 如何看待 cypress
  • [x] cypress 是否为最佳工具
  • [x] 测试怎么办?

如何在 vue 中使用 cypress

vue 提供了vue-cli 可以快速的创建 vue 项目。

vue create hello-world

在选择安装项里面选择: E2E testing -> cypress

如何运行测试

  1. 通过命令启动
> npm run test:e2e
  1. 开启 cyprss 管理窗口

  1. 点击Run all specs 或 某个测试文件运行

这里以项目管理 模块为例,运行 5 条用例只需要 14s,速度还是非常快的。

如何编写测试用例

站在前端开发的角度上编写 UI 自动化用例,总体感受还是非常方便的!

首先,为所有要操作的元素设置统一的属性。

<el-button cy-data="create-project" type="primary" @user1="showCreate">创建</el-button>
...
<el-button cy-data="edit-project" type="text" size="small" @user2="showEdit(scope.row)">编辑</el-button>
<el-button cy-data="delete-project" type="text" size="small" @user3="deleteProject(scope.row)">删除</el-button>
...

不建议占用 HTML 提供的的 idnameclass... 这些属性,他们一般都会有指定的用途,比如,class 是用来引用 css 样式的。 那么通过cy-data=xxxx即可以避免冲突,又更加统一和规范。

接下来,就是编写 cypress 自动化代码了

describe('项目管理', () => {
  it('添加项目', () => {
    cy.visit('/#/project')
    cy.get('[cy-data=create-project]', { timeout: 3000 }).click()
    cy.wait(1000)
    cy.get('[cy-data=project-name]', { timeout: 3000 }).type('项目名称')
    cy.get('[cy-data=project-desc]', { timeout: 3000 }).type('项目备注信息')
    cy.get('[cy-data=save-button]', { timeout: 3000 }).click()  // 保存项目
  });
  // ...
})

如何解决测试数据的问题

我们编写自动化测试用例,不管是接口还是 UI 都会面临测试数据的问题。比如,我要测试登录,得先去创建一个用户数据,我要测试搜索,先去创建一批可以搜索的数据。

为此,我们不得不在自动化里面 使用setUp/treaDown这些 fixture 去写大量的前置或后置动作,来完成这些准备工作。站在测试的角度,这无疑让我们的测试用例变得复杂,然后,也很容易因为测试数据造成自动化用例的失败。

那么,站在前端开发是如何解决的?在此之前我们要先了解一下开发过程:

在项目开发过程中。前端为了更顺利的完成开发工作,不能等到后端开发好了接口,再手写前端功能,所以,会和后端定义好接口之后,通过 mock 来模拟接口数据,--面向 mock 开发

那么在面向 mock 开发的过程中,避免不了,前后端需要调整接口参数的情况,比如,前端需要增加一个字段,或后端说需要把数据结构调整一下。我们前后端对接使用的是 YAPI 平台,定义好接口之后,他就自动的生成了一些 mock 数据,比如 id、name、date-time 等,非常方便。

你可以直接通过下面的链接来访问 mock 接口:

https://yapi.baidu.com/mock/40650/api/v1/projects/list

如何 vue 项目当中配置不同的环境?你需要去学习 vue 开发...

遇到的元素定位问题

然而,为每个元素添加定位方式,有时并不是我们想象的那么简单。

如果你是使用过前端 UI(例如 element-ui)库就会发现,并不是所有的页面元素都是通过 HTML 纯手写的。 例如,下面的弹窗。

通过 element-UI 的实现方式是这样子的。

<template>
  <el-button type="text" @click="open">点击打开 Message Box</el-button>
</template>

<script>
  export default {
    methods: {
      open() {
        this.$confirm('此操作将永久删除该文件, 是否继续?', '提示', {
          confirmButtonText: '确定',
          cancelButtonText: '取消',
          type: 'warning'
        }).then(() => {
          this.$message({ type: 'success',  message: '删除成功!' });
        }).catch(() => {
          this.$message({ type: 'info', message: '已取消删除' });          
        });
      }
    }
  }
</script>

弹窗完全通过 element-UI 渲染,我们无处给 确定取消 等按钮加上定位专用属性。 这个时候,前端开发就没什么优势了,必须老老实实的去前端页面上定位元素,写复杂的 css 定位。

然而,就算我自定义了定位,有时候元素也不是唯一的。例如

对于上面的列表,通过自定义定位得到的是一组元素。然而,如果只是一组元素的问题就就没必要单独拿出来说了,正如上图,列表中看到的是 4 个元素,通过定位方式得到的是 8 个元素,前 4 个是隐藏的,这和使用的 element-UI 库有关,因为数据是 YAPI 随机生成的,不能写死对第 5 个显示元素进行操作。 cypress 提供的 force 非常有用,他会强制对隐藏的元素进行操作。

cy.get('[cy-data=edit-project]', { timeout: 3000 }).first().click({ force: true })

如何看待 cypress

前端开发工程师视角

作为一名前端开发,客观的说,使用 cypress 的过程并没有遇到太多阻力。我来总结一下。

  1. 因为使用了 yapi,不需要考虑测试数据的准备。
  2. 不需要写依赖步骤,主要是目前的业务功能也没有太长的操作过程。
  3. 大部分情况下可以自定义元素属性,在定位上不需要花费过多的时间,也不需要写太长的定位。
  4. 测试运行速度可以接受,28 条用例运行耗时 80 秒左右。

测试工程师视角

作为一名自动化测试,如果让我使用 cypress。

  1. 为了验证数据的正确性,我不能要求开发使用 yapi 假数据,所以,还是要自己准备数据。
  2. 根据业务的情况,必须要的前置/后置动作不可避免。
  3. 虽然,说服开发统一自定义元素有点难,对来我说并不是不可办到!
  4. cypress 做 UI 自动化确实比 selenium 要快一些,但是他相比 selenium,不支持更多的浏览器,不支持 Grid 远程调用,甚至不能根据自己的熟练度选择语言。所以,cypress 优势并没有压倒性优势,具体还是要看需求。

cypress 是否为最佳工具

cypress 是否为所有 UI 自动化的最佳工具?

在面向前端的开发框架Vue/React中 确实很好的整合 cypress,使我们的使用更加方便。

在我接触到的偏后端的 django Web 框架中就很好的整合了 Selenium,同样可以达到类似的效果。 我之前看过一本《Test-Driven Development with Python》,书中就很好的将基于 Selenium 的 UI 测试与 Django 开发很好的结合起来了。

所以,结论是结合你的开发框架去选择合适的 E2E 测试工具。

测试怎么办?

一直以来,我们都天然的认为 UI 自动化测试就应该是测试来做的,并以能做 UI 自动化测试为高级目标!但从我上面的实践中,我们会发现其实开发来做 UI 自动化优势很明显。那么测试怎么办?我们只能老老实实的回去测功能了吗?当然不是。

  1. 并不是每个开发都懂得编写 UI 自动化测试,虽然,这对他们来并不是特别难,我们完全在这方面成为 “教练”,教开发如何编写 UI 自动化测试,如何设计更全面的测试用例。

  2. 并不是每个团队的开发都有时间编写 UI 自动化测试,也可能是他们不愿意写,那么我们为何不加入他们?以我前面介绍的方式,深度地参与到项目的自动化测试编写中。而不是现在这样,将项目开发和自动化测试完全割裂开分别进行。

春节期间重读了《google 测试之道》,有了新的感受,在测试开发能力足够的前提下,当团队的目标是提高产品的保证质量时,自动化测试到底由谁来做的问题变得不那么重要了。

共收到 8 条回复 时间 点赞

很好,但是不适合我司业务😂

我们也在使用这个,感觉从这个角度看起来有更深的理解和使用。

虫师 回复

可是在实际的项目中前端研发不会去加 cy-data,QA 在自动化实际中定位元素还得用其它的定位方式,比如 id/xpath/class 等

@WangYuan 这篇分享是在前端开发过程中的实践,所以,当然是自己加的,所以,大部分元素定位都很简单,而且很可靠。


cy-data="create-project" 是在代码里单独加的吗

目前我公司也在使用 cypress,站在测试角度上,个人觉得比 selenium 方便很多。比如前置的有输入用户名跟密码登录,这里就可以通过 Cypress.Command.add('loginByApi'),里面通过 request 来完成。后续如果要用到的登录的都可以通过 cy.loginByApi() 完成,方便很多。

之前也想过如何开展前端自动化,最后个人得出的结论是只有 TDD 才是可行的方式,但 TDD 的推广在大部分公司都不是件很容易的事。最后摆在 Leader 面前的是一道数学题,为了提高代码的质量,我们愿意付出多少时间和人力成本。

陈恒捷 将本帖设为了精华贴 03月23日 10:14

挺不错的实践,也是换种思路看自动化测试。加个精给更多同学看到

需要 登录 后方可回复, 如果你还没有账号请点击这里 注册