在前端开发中,UI自动化测试是非常重要的一部分,它可以保证我们的应用程序在各种环境下都能够达到预期的效果。对于UI自动化测试,测试覆盖率的提高也是非常关键的,因此,使用像Percy这样自动化截图的工具来检查我们的UI组件是否正确渲染是非常有意义的。而@percy/react-percy-api-client
包就提供了一种非常方便快捷的操作Percy API服务的方式,本文将介绍如何使用它。
1. 安装包
在使用npm包 @percy/react-percy-api-client
之前,需要先将其安装至你的项目中,打开你的终端工具,执行以下命令:
npm install @percy/react-percy-api-client --save-dev
2. 导入包
在项目中导入包,使用以下代码:
import PercyAPI from "@percy/react-percy-api-client";
3. 使用包
使用 @percy/react-percy-api-client
包可以对于Percy API的各项服务进行操作,其中包括上传快照、更新健康检查、启用/禁用构建以及删除构建等操作。下面将列出一些常用API的使用方法:
3.1 上传快照
上传快照是我们使用 @percy/react-percy-api-client
包最常用的操作。使用下面的代码可以上传一个快照:
PercyAPI.snapshot({ name: "Homepage", // 快照名称 url: "http://www.example.com/", // 快照的URL });
除了上述配置参数,还有很多其他可选参数,你可以参考 Percy API文档 进行配置。
3.2 更新健康检查
在进行UI自动化测试时,我们使用Percy API完成了快照上传,也需要对上传结果进行监控。Percy API提供了健康检查服务,以监测上传统计数据是否正确。使用以下代码可以对健康检查进行更新:
PercyAPI.healthCheck({ percyToken: "your-percy-token", // Percy API Token buildId: "your-percy-build-id", // 构建ID status: "succeeded", // 更新后的健康检查状态 });
3.3 启用/禁用构建
使用以下代码可以将某个构建启用或禁用:
PercyAPI.setBuildEnabled({ percyToken: "your-percy-token", // Percy API Token buildId: "your-percy-build-id", // 构建ID enabled: true, // true-启用,false-禁用 });
3.4 删除构建
如果你有多个构建并且有些不再需要,可以使用以下代码删除这些构建:
PercyAPI.deleteBuild({ percyToken: "your-percy-token", // Percy API Token buildId: "your-percy-build-id", // 构建ID });
四. 总结
本文介绍了 @percy/react-percy-api-client
包的使用,可以帮助你方便快捷地使用Percy API服务,进行UI自动化测试开发。同时,使用@percy/react-percy-api-client
包还可以提高测试代码的可读性和可维护性,推动测试覆盖率的提升。希望本文对你有所帮助!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5f0c3fde403f2923b035c15f