gotrendier/phpunit-coverage-check

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

维护者

详细信息

github.com/gotrendier/phpunit-coverage-check

源代码

问题

安装: 214

依赖项: 0

建议者: 0

安全: 0

星星: 0

关注者: 1

分支: 0

公开问题: 0

1.0.0 2023-06-12 09:44 UTC

Requires

  • php: >=7.0.0

MIT e133615855e5040e79680b538989edd2e1ccb61e

  • Richard Regeer <rich2309.woop@gmail.com>
  • Javier De Juan <javier.dejuan.woop@gotrendier.com>

This package is auto-updated.

Last update: 2024-09-02 09:41:53 UTC

README

Build Status

phpunit-coverage-check

此php脚本将读取phpunit的clover xml报告并计算覆盖率分数。根据给定的阈值，如果覆盖率高于阈值，则脚本将以ok退出；如果覆盖率低于阈值，则脚本将以代码1退出。此脚本可用于您的持续部署环境或例如添加到预提交钩子。

安装

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

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

使用方法

此脚本需要2个参数才能返回代码覆盖率，这些参数是必需的。

  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 app
vendor/bin/coverage-check clover.xml 80 --only-percentage
vendor/bin/coverage-check clover.xml 80 --only-percentage app

启用--only-percentage后，CLI命令将仅返回结果覆盖率百分比。

默认情况下，将测量chictrend文件夹。如果您在百分比参数或--only-percentage参数之后传递一个文件夹，例如app，则将测量该文件夹。

还可以将覆盖率报告生成添加到phpunit.xml.dist中，将以下行添加到xml文件中

<logging>
    <log type="coverage-clover" target="clover.xml"/>
</logging>

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