[Flutter] Golden File Test 的原理

测试的重要性就不在这里赘述了,本篇重点想聊一下Flutter的Widget测试(其他框架称为组件测试)中的Golden File test。

那么什么是Golden File Test呢?

Golden File Testing are like unit tests, except the expected output is stored in a separate file. -- Max Grigorev at ZuriHac

如果有前端经验的童鞋可以理解Flutter的Golden File Testing相当于Jest的快照测试。Flutter将期望的结果存储在图片文件(Golden Image)中。

Widget测试的目标是验证小部件的UI如预期那样的外观和交互。所以Golden File Testing 不等价Widget测试,但通过它可以很方便的测试Widget的UI是否如预期的外观一致。

Golden File Test怎么写,官方有很多例子,这里就不细讲。

和快照测试类似,工作流程如下:


work flow
  1. 第一次生成Golden Image
  2. 人工检查图片,更新对比基线
  3. 当产品代码发生改变时,再次运行测试,测试通过Finder找到当前Widget,通过expectLater与基线进行对比
  4. 如果测试通过,并且UI预期不变,测试通过
  5. 如果测试通过,并且UI预期需要变,测试失败,需找出原因并修复
  6. 如果测试失败,并且UI预期不变,测试失败,需找出原因并修复
  7. 如果测试失败,并且UI预期需要变,人工检查图片是否与预期一致,
    • 如果是,则更新对比基线
    • 如果否,需找出原因并修复

在整个工作流程中,有3个关键点:

  1. 怎么更新基线的?
  2. 第一张golden image是怎么生成的?
  3. 对比时是怎么对比的?

那我们接下来一个一个的看这三个问题。

  1. 怎么更新基线的?

生成和更新基线,Flutter提供了命令行:
flutter test --update-goldens

只跑某个测试文件可以指定文件路径:
flutter test --update-goldens <path_to_test_file>

不实用--update-goldens参数,会直接生成新的图片

通过它,可以在运行测试的同时,生成/更新图片。

test
  1. 第一张golden image是怎么生成的?

理解以下内容,需要对Flutter 渲染流程及相关的概念有了解,此处赘述,如果不了解请移步
architectural-overview
element
render object
isRepaintBoundary, layer
scene

当测试在执行断言的过程:

  1. 通过expectLater第一个参数找到的element
  2. 将element对应的render object所在最近的 RepaintBoundary 以下的内容在engine中合成到scene里
  3. Flutter engine 在后台线程上执行创建栅格图像(这个过程很慢),将未压缩的原始RGBA字节输出到图片中
  4. 将图片保存到指定路径
capture image
toImage
  1. 对比时是怎么对比的?
    LocalFileComparator是flutter提供的默认对比器,用于根据渲染创建/更新磁盘上的图片文件。当跑测试时,它会先将编码后的图片从系统文件中读取到内存,然后进行像素对比。如果像素完全相同,则返回true。但是需注意的是,技术图片像素相同,而图片编码方式不同,测试也会返回false。
    compare

根据需要,可以继承LocalFileComparator并复写的compareupdate方法得到你想要的对比器,并通过flutter_test_config.dart指定对比器。

了解Flutter Golden File Test的原理,可以帮组我们更好的去思考什么时候需要使用它。

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

推荐阅读更多精彩内容