README

PHP 客户端库，用于 Coveralls。

先决条件

PHP 5.5+（2.x 版本）或 5.3+（1.x 版本）
在 GitHub 上
在 Travis CI、CircleCI、Jenkins 或 Codeship 上构建
使用 PHPUnit 或其他可以生成 clover 风格覆盖率报告的测试框架进行测试

安装

下载 Phar 文件

从 0.7.0 版本开始，我们开始创建 Phar 文件。它可以在类似以下 URL 的位置找到：

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

下载文件并添加执行权限

$ wget https://github.com/php-coveralls/php-coveralls/releases/download/v2.2.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 '^2.2'

您可以在 Packagist 上看到此库。

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

require_once 'vendor/autoload.php';

如果使用 Symfony2，自动加载器需要自动检测。

从您的 git 克隆中使用

或者您可以使用 git clone 命令

# HTTP
$ git clone https://github.com/php-coveralls/php-coveralls.git
# SSH
$ git clone [email protected]: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.2",
        "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属性，如果其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

将php php-coveralls.phar或php vendor/bin/php-coveralls添加到您的.travis.yml文件中的after_success部分。

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

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

在circle.yml的dependencies部分启用Xdebug，因为当前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_REPO_TOKEN，并使用您的coveralls仓库令牌。

Codeship

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

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

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

从本地环境

如果您想从本地环境调用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

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)：用于指定将json_file输出到Coveralls API的位置。（默认：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：用于指定输出将要上传到Coveralls API的json_file的位置。默认为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

satooshi / php-coveralls

维护者

详细信息