rregeer/phpunit-coverage-check

使用phpunit的clover报告检查代码覆盖率

0.3.1 2019-10-14 07:04 UTC

This package is auto-updated.

Last update: 2024-09-13 02:08:58 UTC


README

Build Status

phpunit-coverage-check

此PHP脚本将读取phpunit生成的clover xml报告并计算覆盖率分数。根据给定的阈值,如果覆盖率高于阈值则脚本正常退出,如果覆盖率低于阈值则脚本以代码1退出。此脚本可用于持续部署环境或添加到pre-commit钩子中。

安装

可以使用composer安装此脚本。将此存储库作为依赖项添加到composer.json文件中。

composer require --dev rregeer/phpunit-coverage-check

使用方法

脚本需要两个参数来返回代码覆盖率。

  1. clover xml文件的位置,由phpunit生成。
  2. 可接受的覆盖率阈值。最小值=1,最大值=100

使用phpunit生成clover.xml文件,并运行覆盖率检查脚本:运行脚本

vendor/bin/phpunit --coverage-clover clover.xml
vendor/bin/coverage-check clover.xml 80
vendor/bin/coverage-check clover.xml 80 --only-percentage

启用--only-percentage,CLI命令将仅返回生成的覆盖率百分比。

还可以将覆盖率报告生成添加到phpunit.xml.dist,将以下行添加到<coverage>标签内的xml文件中

<report>
    <clover outputFile="clover.xml" />
</report>

更多详细信息请参阅phpunit文档。有关配置文件命令行选项的信息。