增量代码覆盖率工具

背景

当存量代码较多时,项目单元测试整体覆盖率就会偏低,但这可能是正常现象,因此不能依据已有的全量单元测试覆盖率来判断项目质量。
基于这个背景,我们需要统计增量代码覆盖率作为项目质量的参考指标之一,并集成到 DevOps 平台。

方案

1、先通过 git diff 统计代码差异,根据差异代码选择运行单元测试案例,最后得到差异覆盖率报告
2、先运行全量单元测试案例来生成整体覆盖率报告,然后通过 git diff 统计差异代码,最后根据整体覆盖率报告和差异代码来形成差异覆盖率报告

通过比较方案 2 侵入性小,扩展好,能方便支持多种 java 覆盖率工具,还能支持 python 、js 等覆盖率工具,下面简单例子介绍下实现方案 2 的开源工具 diff-cover

diff-cover 介绍

diff-cover 用 python 开发的开源工具,github 地址是 https://github.com/Bachmann1234/diff-cover。它不仅能实现增量代码单元测试覆盖率统计,还能实现增量代码质量检查。
支持单元测试覆盖率工具或报告格式有:Cobertura、JaCoCo、JSCover、coverage.py、nosetests、JSCover 等。
支持代码检查工具或报告格式有:pycodestyle, pyflakes, flake8, pylint, checkstyle, checkstylexml、 findbugs。
鉴于公司用 Cobertura 生成单元测试覆盖率,因此 diff-cover 可以容易集成到 DevOps 平台。缺点是由于代码质量检查用的是 pmd 工具,可能 diff-cover 还不支持,

diff-cover 安装和使用

1、首先安装 python 环境,网上一堆,请 google
2、输入如下命令安装 diff-cover

pip install diff_cover

3、新建 git 项目 DiffDemo

  • 新建远程仓库 DiffDemo
  • 克隆代码
git clone https://github.com/scottlinlin/DiffDemo
cd DiffDemo

4、新建 maven 工程

  • 打开 idea 新建一个 maven 工程 DiffDemo,工程路径是 DiffDemo
  • 新建 Math 类,实现两个数相乘的简单功能
  • 新建 MathTest 类,使用 junit4 实现相乘的单元测试
  • git add & git commit 添加到本地仓库
  • git push 推送到远程仓库,此时远程和本地仓库代码一致
  • 然后本地运行 mvn cobertura:cobertura,生成覆盖报告路径是 ./target/site/cobertura/coverage.xml,此时覆盖率100%
  • 运行 diff-cover,
diff-cover target/site/cobertura/coverage.xml --compare-branch=origin/master
  • 结果应该为空,即没有新增代码也没有差异覆盖率


    scott.lin

diff-cover 参数说明

第一个参数是覆盖率报告文件,也可以填写多个文件
第二个参数是比较 git 分支 或 commit id,上诉比较是 origin/master 和 HEAD之间代码差异,origin/master 是远程 master 分支,HEAD 当前分支即指向本地 Master 最新提交

5、新增代码,统计差异覆盖率

  • Math 类新增除、平方功能代码
  • 本地运行 mvn cobertura:cobertura,生成覆盖报告
  • 运行 diff-cover,
diff-cover target/site/cobertura/coverage.xml --compare-branch=origin/master --html-report report.html
  • 输出差异覆盖率报告,即新增除和平台代码覆盖率为0,如下:


    scott.lin

6、demo 地址
https://github.com/scottlinlin/DiffDemo

展望

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

推荐阅读更多精彩内容