Loki

Storybook 的视觉回归测试

在 Github 上查看

Storybook 的视觉回归测试

GitHub license Tests npm version npm downloads

基本原理

网络上有一些视觉回归工具,但大多数要么无法无头运行,要么使用已弃用的 phantomjs,而这个浏览器实际上没人用。它们通常还需要维护测试用例。使用 React Native,现在可以使用单个代码库来针对多个平台,但据我所知,还没有一个工具可以测试所有平台。

Loki 旨在易于设置,维护成本低或无需维护,测试结果独立于运行它们的 OS,可以在 CI 上运行,并支持 Storybook 支持的所有平台。

支持的平台

  • Docker 中的 Chrome(推荐)
  • AWS Lambda 中的 Chrome
  • 本地 Chrome 应用程序
  • iOS 模拟器
  • Android 模拟器

先决条件

可选依赖项

  • GraphicsMagick 用于 gm 差异引擎,brew install graphicsmagick
  • Docker 用于 chrome.docker 目标。
  • Chrome 59+ 用于 chrome.app 目标,brew cask install google-chrome-canary

安装

yarn add loki --dev
yarn loki init

工作流程

Loki 不会为您启动任何服务器,因此请确保在运行测试之前 Storybook 和任何模拟器/仿真器都已启动并正在运行。

  1. 启动 Storybook 服务器 yarn storybook
  2. 添加第一组参考文件 yarn loki update
  3. 对组件进行一些更改
  4. 针对参考进行测试 yarn loki test
  5. 查看 diff 文件夹中的更改
  6. 批准更改并更新参考 yarn loki approve

文档

示例

开发

# Install dependencies
yarn
# Start example storybook
yarn workspace @loki/example-react run storybook
# Run example visual tests
yarn workspace @loki/example-react run test
# Run unit tests
yarn test
# Run cli integration tests
cd test/cli && yarn test

维护者

许可证

MIT 许可证。© Joel Arvidsson 2017 年至今