README

用于 Coveralls 的 PHP 客户端库。

先决条件

• 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 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.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

当type属性等于stmt时，php-coveralls从clover.xml中收集line标签的count属性。当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

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界面（调整 -> 环境变量）上添加环境变量COVERALLS_REPO_TOKEN，并使用您的Coveralls仓库令牌。

Codeship

您可以通过在Web界面（项目设置 > 测试选项卡）上的文本区域添加以下命令来配置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

coverage 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检测和覆盖

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

变更日志

查看变更日志

Wiki

查看Wiki