为 Coding.net 造一个测试覆盖率徽标

GitHub 生态圈里有很多服务,在代码库中显示一排徽标(badge)非常壮观,非常方便,比如 CircleCI.com、Codecov.io,都是支持 GitHub、Bitbucket、Gitlab 这些英语系全球化的代码库,而不支持 Coding.net,那我们就自己造!

为 Coding.net 造一个测试覆盖率徽标_第1张图片
Codecov.io

在 GitHub 中,“测试覆盖率”由第三方服务商提供,比如 Codecov.io、Coveralls.io,都不支持 Coding,怎么造呢?

简易方案:本地跑完测试,获得测试覆盖率,生成徽标图片,提交到代码库。
极客方案:持续集成跑完测试,获得测试覆盖率,生成徽标图片,提交到代码库的另一个静态分支(避免死循环,比如 gh-pages 和 coding-pages)或者云存储,并且把HTML版的测试覆盖率报告发布成静态网站(这样就和 Codecov 一样了)。

本文将讲解简易方案。

获得测试覆盖率

通过各个语言的测试工具和 awk 即可。比如 PHP 是这样的:

./vendor/bin/phpunit --coverage-text=coverage.txt ./tests/
grep -m 1 'Lines:' coverage.txt | awk '{print $2}'
$ ./vendor/bin/phpunit --coverage-text=coverage.txt ./tests/
PHPUnit 8.4.1 by Sebastian Bergmann and contributors.

...........                                                       11 / 11 (100%)

Time: 7.27 seconds, Memory: 32.00 MB

OK (11 tests, 71 assertions)
ubuntu@pc:code/sinkcup/laravel-ui-socialite$ cat coverage.txt


Code Coverage Report:
  2019-10-24 06:18:45

 Summary:
  Classes: 78.57% (11/14)
  Methods: 81.08% (30/37)
  Lines:   90.31% (205/227)

AddAvatarToSocialAccountsTable
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% (  8/  8)

$ grep -m 1 'Lines:' coverage.txt | awk '{print $2}'
90.31%

根据测试覆盖率生成徽标

打开 Coding 的持续集成状态徽标,发现 SVG 格式不佳,无法直接替换字符串;而 codecov 的 SVG 格式良好,可直接替换。

为 Coding.net 造一个测试覆盖率徽标_第2张图片
coding.net CI badge SVG
为 Coding.net 造一个测试覆盖率徽标_第3张图片
codecov badge SVG

    
        
        
    
    
        
    
    
        
        
        
    
    
        coverage
        coverage
        90%
        90%
    

使用上一步获得测试覆盖率数字,对这个 SVG 进行正则替换即可。需要注意 sed 里的正则不支持 \d 等语法,参考:《sed替换字符串时,使用正则表达式的注意事项》。

sed 's/>[0-9]\+\.\?[0-9]\+%/>66.66%/g' coverage.svg

由于 SVG 在 Git 里是纯文本,无法直接显示,所以需要转换成 png。

为 Coding.net 造一个测试覆盖率徽标_第4张图片
SVG is text/plain in Git
rsvg-convert coverage.svg > coverage.png

完整代码请看:https://codes-farm.coding.net/p/laravel-demo/d/laravel-demo/git

你可能感兴趣的:(为 Coding.net 造一个测试覆盖率徽标)