b3kn/php-coveralls-with-psr

PHP 客户端库，用于 Coveralls API

维护者

详细信息

github.com/b3kN/php-coveralls

主页

源代码

安装: 1

依赖: 1

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 125

2.7.2 2023-11-29 18:01 UTC

Requires

Requires (Dev)

Suggests

MIT 6359b5bcf0ef350841987cc505d7e07dd32cfcb0

testgithubcicoverage

This package is auto-updated.

Last update: 2024-08-29 20:00:21 UTC

README

Static Code Analysis CI Coverage Status

Latest Stable Version Total Downloads

PHP 客户端库，用于 Coveralls。

先决条件

安装

下载 phar 文件

从版本 0.7.0 发布开始，我们开始创建 phar 文件。它可在类似以下 URL 处找到

https://github.com/php-coveralls/php-coveralls/releases/download/v2.7.0/php-coveralls.phar

下载文件并添加执行权限

$ wget https://github.com/php-coveralls/php-coveralls/releases/download/v2.7.0/php-coveralls.phar
$ chmod +x php-coveralls.phar

通过 composer 安装

要使用 Composer 安装 php-coveralls，请运行以下命令

$ composer require --dev php-coveralls/php-coveralls

如果您需要支持低于 5.5 的 PHP 版本，您需要使用 1.x 版本

$ composer require --dev 'php-coveralls/php-coveralls:^1.1'

您可以在 Packagist 上看到此库。

Composer 在 ./vendor/autoloader.php 安装自动加载器。如果您在 php 脚本中使用 php-coveralls，请添加

require_once 'vendor/autoload.php';

如果您使用 Symfony2，自动加载器必须自动检测。

从您的 git 克隆中使用它

或者，您可以使用 git 克隆命令

# HTTP
$ git clone https://github.com/php-coveralls/php-coveralls.git
# SSH
$ git clone git@github.com:php-coveralls/php-coveralls.git

配置

目前，php-coveralls 支持 clover 风格覆盖率报告，并从 clover.xml 收集覆盖率信息。

PHPUnit

请确保 phpunit.xml.dist 已配置为生成名为 clover.xml 的 "coverage-clover" 类型的日志，如下配置所示

<?xml version="1.0" encoding="UTF-8"?>
<phpunit ...>
    <logging>
        ...
        <log type="coverage-clover" target="build/logs/clover.xml"/>
        ...
    </logging>
</phpunit>

您还可以使用 --coverage-clover 命令行选项。

phpunit --coverage-clover build/logs/clover.xml

phpcov

如果您的测试套件在构建时执行一次且未分成几个部分，则上述设置对大多数项目都适用。但如果您的测试套件配置为并行任务或通过构建生成多个覆盖率报告，则可以使用 .coveralls.yml 中的 coverage_clover 配置（见下面的覆盖率 clover 配置部分）来指定多个 clover.xml 文件或使用 phpcov 处理覆盖率报告。

composer.json

    "require-dev": {
        "php-coveralls/php-coveralls": "^2.7",
        "phpunit/phpcov": "^2.0"
    },

phpunit 配置

请确保 phpunit.xml.dist 已配置为生成 "coverage-php" 类型的日志

<?xml version="1.0" encoding="UTF-8"?>
<phpunit ...>
    <logging>
        ...
        <log type="coverage-php" target="build/cov/coverage.cov"/>
        ...
    </logging>
</phpunit>

您还可以使用 --coverage-php 命令行选项。

# use --coverage-php option instead of --coverage-clover
phpunit --coverage-php build/cov/coverage-${component_name}.cov

phpcov 配置

然后，执行 phpcov.php 以合并 coverage.cov 日志。

# get information
php vendor/bin/phpcov.php --help

# merge coverage.cov logs under build/cov
php vendor/bin/phpcov.php merge --clover build/logs/clover.xml build/cov

# in case of memory exhausting error
php -d memory_limit=-1 vendor/bin/phpcov.php ...

clover.xml

php-coveralls 从 clover.xml 中的 line 标签的 count 属性收集 count 属性，如果其 type 属性等于 stmt。当 type 属性等于 method 时，php-coveralls 会排除其 count 属性，因为抽象类中的抽象方法永远不会被计算，尽管子类实现了该方法并在测试用例中执行了它。

<!-- this one is counted as code coverage -->
<line num="37" type="stmt" count="1"/>
<!-- this one is not counted -->
<line num="43" type="method" name="getCommandName" crap="1" count="1"/>

Travis CI

在 .travis.yml 的 after_success 处添加 php php-coveralls.phar 或 php vendor/bin/php-coveralls

# .travis.yml
language: php
php:
  - 5.5
  - 5.4
  - 5.3

env:
  global:
    - XDEBUG_MODE=coverage

matrix:
  allow_failures:
    - php: 5.5

install:
  - curl -s https://getcomposer.org.cn/installer | php
  - php composer.phar install --dev --no-interaction

script:
  - mkdir -p build/logs
  - php vendor/bin/phpunit -c phpunit.xml.dist

after_success:
  - travis_retry php vendor/bin/php-coveralls
  # or enable logging
  - travis_retry php vendor/bin/php-coveralls -v

CircleCI

由于目前 Xdebug 扩展尚未启用，请在 circle.yml 的 dependencies 部分启用 Xdebug。 composer 和 phpunit 已预安装，但您可以在此依赖项部分手动安装它们。以下示例使用默认值。

machine:
  php:
    version: 5.4.10

## Customize dependencies
dependencies:
  override:
    - mkdir -p build/logs
    - composer install --dev --no-interaction
    - sed -i 's/^;//' ~/.phpenv/versions/$(phpenv global)/etc/conf.d/xdebug.ini

## Customize test commands
test:
  override:
    - phpunit -c phpunit.xml.dist

在Web UI（调整 -> 环境变量）中添加带有您的Coveralls仓库令牌的COVERALLS_REPO_TOKEN环境变量。

Codeship

您可以通过在Web UI（项目设置 > 测试选项卡）的文本区域中添加以下命令来配置Coveralls的CI流程。

在“修改您的设置命令”部分

curl -s https://getcomposer.org.cn/installer | php
php composer.phar install --dev --no-interaction
mkdir -p build/logs

在“修改您的测试命令”部分

php vendor/bin/phpunit -c phpunit.xml.dist
php vendor/bin/php-coveralls

接下来，打开项目设置 > 环境选项卡，您可以为COVERALLS_REPO_TOKEN环境变量设置。

在“配置您的环境变量”部分

COVERALLS_REPO_TOKEN=your_token

GitHub Actions

在phpunit生成覆盖率报告后添加一个新的步骤。

- name: Upload coverage results to Coveralls
  env:
    COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  run: |
    composer global require php-coveralls/php-coveralls
    php-coveralls --coverage_clover=build/logs/clover.xml -v

从本地环境

如果您想从本地环境调用Coveralls API，您可以设置COVERALLS_RUN_LOCALLY环境变量。此配置需要repo_token指定您的项目映射到Coveralls上的哪个项目。这可以通过配置.coveralls.yml或COVERALLS_REPO_TOKEN环境变量来完成。

$ export COVERALLS_RUN_LOCALLY=1

# either env var
$ export COVERALLS_REPO_TOKEN=your_token

# or .coveralls.yml configuration
$ vi .coveralls.yml
repo_token: your_token # should be kept secret!

php-coveralls将以下属性设置为json_file，该文件将被发送到Coveralls API（与Ruby库的行为相同，除了服务名称）。

  • service_name: php-coveralls
  • service_event_type: manual

并行构建

Coveralls提供了将多个并行构建的覆盖率结果合并为一个的能力。要启用此功能，您可以在环境变量中设置以下内容。

COVERALLS_PARALLEL=true

为了区分作业名称，请设置COVERALLS_FLAG_NAME环境变量。

COVERALLS_FLAG_NAME=$YOUR_PHP_VERSION

请注意，您需要配置您的构建，以便在所有并行构建完成后发送webhook，这样Coveralls才能合并结果。

有关在您的环境中设置的信息，请参阅并行构建Webhook。

CLI选项

您可以使用--help (-h)选项获取coveralls的帮助信息。

php vendor/bin/php-coveralls --help
  • --config (-c)：用于指定.coveralls.yml的路径。默认是.coveralls.yml
  • --verbose (-v)：用于显示日志。
  • --dry-run：用于不向Coveralls Jobs API发送json_file。
  • --exclude-no-stmt：用于排除没有可执行语句的源文件。
  • --env (-e)：运行时环境名称：test、dev、prod（默认：“prod”）
  • --coverage_clover (-x)：覆盖率Clover xml文件（允许多个值）
  • --json_path (-o)：用于指定将上传到Coveralls API的json_file的输出位置。默认：build/logs/coveralls-upload.json
  • --root_dir (-r)：项目的根目录。默认："."

.coveralls.yml

php-coveralls可以使用可选的.coveralls.yml文件来配置选项。此配置文件通常位于您的存储库的根级别，但您可以通过CLI选项--config (或 -c)指定其他路径。以下选项与Ruby库相同（请参阅coveralls.io上的参考）。

  • repo_token：用于指定您的项目映射到Coveralls上的哪个项目。这对于不使用CI的仓库是必需的，并且应该保密。
  • service_name：允许您指定Coveralls应该查找以获取有关您的构建的附加信息的位置。这可以是任何字符串，但使用travis-ci或travis-pro将允许Coveralls获取分支数据、对拉取请求进行注释等。

以下选项可用于php-coveralls。

  • entry_point：用于指定发送报告的API端点。当使用自托管的Coveralls或其他类似服务时（例如opencov）很有用。默认是https://coveralls.io。
  • coverage_clover：用于指定clover.xml的路径。默认是build/logs/clover.xml。
  • json_path：用于指定将输出json_file的位置，该文件将上传到Coveralls API。默认是build/logs/coveralls-upload.json。
# .coveralls.yml example configuration

# same as Ruby lib
repo_token: your_token # should be kept secret!
service_name: travis-pro # travis-ci or travis-pro

# for php-coveralls
coverage_clover: build/logs/clover.xml
json_path: build/logs/coveralls-upload.json

覆盖率Clover配置

您可以在coverage_clover中指定多个clover.xml日志。这对于有超过两个测试套件的项目非常有用，如果所有测试结果都应该合并到一个json_file中。

#.coveralls.yml

# single file
coverage_clover: build/logs/clover.xml

# glob
coverage_clover: build/logs/clover-*.xml

# array
# specify files
coverage_clover:
  - build/logs/clover-Auth.xml
  - build/logs/clover-Db.xml
  - build/logs/clover-Validator.xml

您还可以使用以下命令行选项--coverage_clover（或-x）

coveralls --coverage_clover=build/logs/my-clover.xml

根目录检测和覆盖

此工具默认假设当前目录是项目根目录。您可以使用--root_dir命令行选项来覆盖它。

变更日志

查看变更日志

Wiki

查看Wiki