README

phpspec-code-coverage是一个PhpSpec扩展，用于生成PhpSpec测试的代码覆盖率报告。

生成代码覆盖率报告可以让你分析代码库中哪些部分被测试以及测试的效果如何。然而，代码覆盖率不应单独作为衡量测试好坏的唯一指标。

注意！这是一个维护分支，基于henrikbjorn/phpspec-code-coverage包，并具有兼容的版本号以供稳定发布使用。

要求

PHP 7+（用于PhpSpec v4+）或PHP 5.6+（用于PhpSpec v3）
启用Xdebug或phpdbg扩展（PHP 7+需要代码生成与phpdbg一起工作）。

变更日志

有关最近更改的信息，请参阅CHANGELOG.md。

安装

将此包作为开发依赖项安装到项目中

$ composer require --dev leanphp/phpspec-code-coverage

通过编辑项目中的phpspec.yml文件启用扩展

extensions:
  LeanPHP\PhpSpec\CodeCoverage\CodeCoverageExtension: ~

这将足以通过扩展提供的默认值启用代码覆盖率生成。此扩展支持各种配置选项。要查看完全注释的示例配置文件，请参阅配置部分。

用法

如果你执行phpspec run命令，你将在coverage目录（以html格式）中看到生成的代码覆盖率

$ bin/phpspec run

注意！生成代码覆盖率报告时，请确保PHP进程通过CLI运行时不受内存限制（即，在/etc/php/cli/php.ini中将memory_limit设置为-1）。

使用phpdbg运行

此扩展现在支持phpdbg，这在使用较新版本的PHP时可以加快执行速度。通过phpdbg运行phpspec

$ phpdbg -qrr phpspec run

注意！代码生成要与phpdbg一起工作，需要PHP 7+。

配置

下面是一个完全注释的phpspec.yml示例文件，它可以作为一个起点来进一步自定义扩展的默认值。下面的配置文件包含了所有的配置选项。

# phpspec.yml
# ...
extensions:
  # ... other extensions ...
  # leanphp/phpspec-code-coverage
  LeanPHP\PhpSpec\CodeCoverage\CodeCoverageExtension:
    # Specify a list of formats in which code coverage report should be
    # generated.
    # Default: [html]
    format:
      - text
      - html
      #- clover
      #- php
      #- xml
    #
    # Specify output file/directory where code coverage report will be
    # generated. You can configure different output file/directory per
    # enabled format.
    # Default: coverage
    output:
      html: coverage
      #clover: coverage.xml
      #php: coverage.php
      #xml: coverage
    #
    # Should uncovered files be included in the reports?
    # Default: true
    #show_uncovered_files: true
    #
    # Set lower upper bound for code coverage
    # Default: 35
    #lower_upper_bound: 35
    #
    # Set high lower bound for code coverage
    # Default: 70
    #high_lower_bound: 70
    #
    # Whilelist directories for which code generation should be done
    # Default: [src, lib]
    #
    whitelist:
      - src
      - lib
    #
    # Whiltelist files for which code generation should be done
    # Default: empty
    #whilelist_files:
      #- app/bootstrap.php
      #- web/index.php
    #
    # Blacklist directories for which code generation should NOT be done
    #blacklist:
      #- src/legacy
    #
    # Blacklist files for which code generation should NOT be done
    #blacklist_files:
      #- lib/bootstrap.php

选项

format（可选）生成代码覆盖率所使用的格式列表。可以是以下之一或多个：clover、php、text、html、xml（默认 html）注意：当使用 clover 格式选项时，您必须为 clover 格式配置特定的 output 文件（见下文）。
output（可选）设置生成特定代码覆盖率格式的输出文件/目录。如果您配置了多个格式，则使用 format:output 的哈希值（例如，clover:coverage.xml）（默认 coverage）
show_uncovered_files（可选）用于在覆盖率报告中包含未覆盖的文件（默认 true）
lower_upper_bound（可选）设置代码覆盖率的下限（默认 35）。
high_lower_bound（可选）设置代码覆盖率的上限（默认 70）
whitelist接受要白名单的目录数组（默认：lib、src）。
whitelist_files接受要白名单的文件数组（默认：无）。
blacklist接受要黑名单的目录数组（默认：test、vendor、spec）
blacklist_files接受要黑名单的文件数组

作者

许可

许可协议为 MIT 许可证。

drupol/ phpspec-code-coverage

维护者

详细信息

README

要求

变更日志

安装

用法

使用phpdbg运行

配置

选项

作者

许可