cypress视觉测试

背景:在测试页面的时候,经常会遇到css变更或者某个组件有变更,但是下意识的只会在乎当前页面是否符合整体产品使用而不会去对比曾经的版本,甚至根本不会回归。所以诞生了Visual Testing,该测试方法能够帮助回归测试(当然,这里的回归肯定只包含老旧区)。

我所使用的视觉测试是集成在cypress上的,所以视觉测试也是一种辅助E2E的测试方法。

一:首先,需要安装视觉测试包

直接 npm install --save-dev cypress-image-snapshot,安装完成后会在package.json中看到包名以及版本。

安装包

二:在[root]/plugins/index.js中加包并定义方法

const {

    addMatchImageSnapshotPlugin,

} =require('cypress-image-snapshot/plugin');

导出全局方法名

module.exports = (on, config) => {

    addMatchImageSnapshotPlugin(on, config);

}

三:在[root]/support/commamd.js中引入方法

import {addMatchImageSnapshotCommand }from 'cypress-image-snapshot/command';

addMatchImageSnapshotCommand({

    failureThreshold:0.03,

    customDiffConfig: {threshold:0.1 },

    failureThresholdType:'percent',

    capture:'viewport'

});

四:最后就可以在用例中使用该方法了

以下是官方所提供的使用方法,在用例的方法中添加配置,会覆盖全局配置。

// addMatchImageSnapshotPlugin

addMatchImageSnapshotPlugin(on,config);

//addMatchImageSnapshotCommand

addMatchImageSnapshotCommand();

addMatchImageSnapshotCommand(commandName);

addMatchImageSnapshotCommand(options);

addMatchImageSnapshotCommand(commandName,options);

//matchImageSnapshot.matchImageSnapshot();

.matchImageSnapshot(name);

.matchImageSnapshot(options);

.matchImageSnapshot(name,options);

// ---or---cy.matchImageSnapshot();

cy.matchImageSnapshot(name);

cy.matchImageSnapshot(options);

cy.matchImageSnapshot(name,options);

该方法官方推荐是使用在断言之后。

用例中的使用方法

五:第一次运行该代码,会在cypress/snopshot/${spec.name}中生成一个baseImage

baseImage

六:再次运行该代码,如果两次截图不一致,会在cypress/snopshot/${cypress.spec.name}/__diff_output__中生成一个diffImage。

diffImage

下图就是diff图,左边为baseImage,右边为本次运行时截图。中间就是diff图片。

compareImage

七:参数

Updating snapshots

Run Cypress with --env updateSnapshots=true in order to update the base image files for all of your tests.

Preventing failures

Run Cypress with --env failOnSnapshotDiff=false in order to prevent test failures when an image diff does not pass.

八:diffImage加入报告

这个也是琢磨了很久才搞出来的办法,肯定不是最优的,但这是我当前能想到的办法了。。

方法还是跟上一篇文章一样,需要使用到addContext方法并且配合pipeline归档使用。但是这个diffimages的相对路径还有一点不一样,不知道则呢么去获取,只能通过捕获到错误消息去替换路径获得diff图片的相对路径。如果有更好的办法,可以评论一下哦。

在[root]/support/index.js中加入全局方法。

Cypress.on('test:after:run', (test, runnable) => {

    if (test.state ==='failed') {

// Build image path

        if(test.err.message.includes('See diff')) {

// If the test failed due to cypress-image-snapshot the message will always be the same and the plugin gives you in the message the url of the path

            const linuxDiffImages = test.err.parsedStack[1].message.replace('See diff for details: ', '').split("/").slice(-5).join("/");

            const diffImages = test.err.parsedStack[1].message.replace('See diff for details: ', '').split("/").slice(-6).join("/");

            if(navigator.userAgent.indexOf("Linux")>0){

                addContext({test}, {

                    title:'diffImage',

                    value:`${Cypress.env("jobUrl")}` +"lastSuccessfulBuild/artifact/" + `${linuxDiffImages}`

                });

            }else {

                addContext({test}, {

                    title:'diffImage',

                    value:`/${diffImages}`

                });

            }

        }

    }

});

pipeline

使用pipeline归档这个diff图片的时候,遇到了一个问题。

(先交代下背景:cypress/snapshots/${cypress.spec.name}文件夹中存在baseImage,所以我不会去删除snapshots文件夹)

所以在开始归档前,我使用了fileExists去判断__diff_output__文件夹是否存在,但是该文件夹又是存在于${cypress.spec.name}中的,所以就要写成

 if(fileExists('cypress/snapshots/**/__diff_output_') == true){

    `````code`````

}

但是fileExists不支持通配符,只能指定死文件夹(**代表无论这里有多少层,*代表仅一层)。所以fileExists方法就不可用,只能换成findFiles方法。该方法会返回一个list,所以我这里通过判断这个list的长度来确定是否存在diff图片,如果存在的话,则归档所有的.diff.png图片

// fileExists不支持通配符

script{

      def files=findFiles excludes:'',glob:'cypress/snapshots/**/*.diff.png'

        echo"${files}"

      if("${files.size()}" != "0"){

        echo"---------------存在diff失败用例截图,开始归档---------------"

        archiveArtifactsartifacts:'cypress/snapshots/**/*.diff.png'

    }

}

报告

生成了测试报告后,就可以在用例步骤里看到diffImage图片了

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

推荐阅读更多精彩内容