如何自动化分析代码覆盖率(How to Use the Code Coverage Analysis Tool)

由于项目CI方面需求,前段时间学习和使用了微软的代码覆盖率(Code Coverage)分析工具,当时着手做时,发现网上资料非常欠缺,遇到了不少坑,在此做个总结,希望能帮到有这方面需求的人。
Code Coverage,代码覆盖率,是CI的需求一部分。微软VS ultimate版本提供了测试Code Coverage的选项,也提供了相应的命令行工具。

使用微软命令行工具分析Code Coverage

image
  1. Instrument,可以理解为配备或准备的意思,这一步使用的工具Vsinstr.exe,它需要将被测程序集名称作为参数,主要作用是将需要测量的程序集分块,并插入监听程序,在这个工程中,需要程序集对应的PDB文件。
  2. 开启监听,并收集覆盖率。这一步用到的工具是Vsperfcmd.exe,它会开启一个监听程序Vsperfmon.exe,当Instrumented的程序集被覆盖到时,会Vsperfmon.exe会收到通知。
  3. 运行测试用例。
  4. 使用Vsperfcmd,输入与上面不同的参数,停止监听,生成Code Coverage报告。

遵循这四步的Workflow

  1. 首先安装需要分析Code Coverage的产品
  2. 将PDB拷贝到程序集所在的目录,这里需要注意的是,我们需要分析Code Coverage的程序集有可能并不是都在一个目录,这时,需要我们将PDB文件拷贝到多个地方。
  3. 编写脚本
  • Instrumt
Vsinstr -coverage <myprojectbinary  the dll/exe>
...
Vsinstr -coverage <myprojectbinary the dll/exe>
  • 开始脚本
VSPerfCmd.exe /start:coverage /output:"*.Coverage"
或
Start vsperfmon -coverage -output:mytestrun.coverage
  • 结束脚本
vsperfcmd –shutdown
  1. 运行开始脚本,这一步做的是Instrumt,并且开始监控
  2. 运行测试用例
  3. 运行结束脚本,这一步的作用是结束监听,并且生成报告

最后值得注意的事项

  1. 在分析Code Coverage的过程中,后台会启动一个VSPerfMon.exed的进程,用于收集Code Coverage信息,只要这个进程结束,收集会终止,所以在这个过程中,关机或者手动关闭这个进程,都会影响分析结果的准确性。
  2. 得到的*.coverage文件是与Instrumented的程序集以及PDB文件相关联的,如果需要保存和转移,微软官网给我们的建议是通过VS转换成XML格式。
  3. Instrument过程中需要程序集的名字作为参数,这意味着,如果我们项目工程增多了,需要对新增加的程序集进行分析,就需要修改脚本。
  4. 第四点值得开发人员注意,微软根据Block的概念计算Code Coverage,而Block的概念是与Instrumented 程序集中的CIL对应的,并不是我们实际的Code,所以我们如果我们从Code文本出发来理解VS中Code Coverage百分比时,往往会比较迷惑。实际上,我们也没有必要这样去做。
  5. Last but not least, 最权威的资料
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容