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

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

使用 phpdbg 运行

此扩展现在支持 phpdbg，在更近版本的 PHP 中使用时可以提高执行速度。通过 phpdbg 运行 phpspec。

$ phpdbg -qrr phpspec run

注意！ PHP 7+ 是使用 phpdbg 生成代码的必要条件。

配置

以下是一个完全注释的 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许可证授权。

leanphp / phpspec-code-coverage

维护者

详细信息

README

要求

变更日志

安装

用法

使用 phpdbg 运行

配置

选项

作者

许可证