README_EN.MD

• English

项目名称

线上UI自动化巡检项目

简介

本项目是一个线上UI自动化巡检工具，旨在帮助开发人员和测试人员快速、高效地检测线上Web应用的UI界面是否存在异常。通过自动化巡检，可以及时发现并修复潜在的问题，提升用户体验和产品质量。

demo

• 地址：https://check.itest.ren/ @zdx0122
• 欢迎各位开发者提供已部署的项目供大家访问使用，共享巡检资源

功能特点

• 自动化巡检：定时或实时执行巡检任务，无需人工干预。
• 多种巡检规则：支持标题对比，页面视觉回归。
• 实时反馈：巡检结果实时展示，包括问题截图、问题描述和定位信息。
• 跨平台支持：支持主流浏览器和操作系统，满足不同环境需求。

使用说明

安装与部署

• 克隆本项目至本地。
• Docker部署，参考 doc/docker 部署手册.md
• 本地启动
  • 基础环境：nodejs、jdk1.8、maven
  • mysql: 建表语句db/ddl.sql
  • online-server springboot项目，安装依赖后，一键启动即可，访问地址：访问地址：http://127.0.0.1:9091/
  • online-client vue项目，访问地址：http://127.0.0.1:5173/

  npm install    //安装依赖
  npm run dev    // 启动
  

巡检用例录入

• 点击左侧菜单“H5用例”
• 点击“新增”按钮
• 填写用例信息，包括H5页面标题、巡检URL地址、业务线、钉钉/企微/飞书告警群机器人的key值等
• 提交

巡检规则

• 每5分钟执行一次巡检任务
• 巡检内容
  • 页面可用性检测（白屏）
  • 页面像素比对（相似度<60%）
  • 用例执行时长统计

巡检结果

• 巡检结果将实时展示在指定页面中。
• 菜单“巡检记录”，可以查看今日巡检记录。
• 菜单“数据看板”，可以近一段时间用例执行数据。

异常用例告警

• 页面标题比对错误，告警通知（需配置群机器人key）
• 页面像素比对相似度<60%，告警通知（需配置群机器人key）

技术栈

• 编程语言：JAVA
• 框架：SpringBoot
• 自动化测试工具：playwright + testNg
• 数据库：MySQL(5.7)
• 前端技术：vue3

贡献指南

欢迎各位开发者贡献代码、文档和建议。在提交贡献之前，请遵循以下步骤：

Fork本项目至你的GitHub仓库。 在你的仓库中创建并切换到新的开发分支。 进行代码修改、添加文档或提交其他贡献。 提交你的更改并推送至你的GitHub仓库。 发起Pull Request至本项目的主分支。 我们将对提交的Pull Request进行审查和测试，一旦通过，将合并至主分支并发布新版本。

贡献巡检资源

受机器资源限制，demo站点仅能使用少量URL供大家体验，欢迎各位开发者提供已部署的项目供大家访问使用，共享巡检资源

联系方式

如有任何疑问、建议或需求，欢迎通过以下方式与我们联系：

• GitHub仓库提交ISSUE

• 邮箱：[email protected]

• 微信群交流

  

Star History

许可证

本项目采用Apache许可证。在使用本项目时，请遵守相关许可协议。