PHP-Coveralls 使用指南

最新推荐文章于 2024-09-05 08:45:28 发布

原创最新推荐文章于 2024-09-05 08:45:28 发布 · 406 阅读

9 ·

CC 4.0 BY-SA版权

PHP-Coveralls 使用指南

php-coverallsPHP client library for Coveralls API.项目地址:https://gitcode.com/gh_mirrors/ph/php-coveralls

1. 项目介绍

PHP-Coveralls 是一个用于 Coveralls API 的 PHP 客户端库，它允许您从 PHP 项目中收集代码覆盖率数据并将其提交到 Coveralls 服务。这对于持续集成和监控代码测试覆盖情况至关重要。Coveralls 提供了一个统一的界面来查看跨多个分支和环境的代码覆盖率报告。

2. 快速启动

环境配置

首先，确保您的开发环境中安装了 PHP 和 Git。接下来，遵循以下步骤以快速启动项目：

安装 PHP-Coveralls

通过 Composer 添加依赖到您的项目:

# 在项目根目录下运行
composer require php-coveralls/php-coveralls --dev

或全局安装以便在多个项目间共享：

composer global require php-coveralls/php-coveralls

配置PHPUnit及Clover报告

修改 phpunit.xml.dist 文件，添加 Clover 格式的覆盖率报告生成：

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

运行测试并生成覆盖率报告

执行 PHPUnit 测试并生成报告：

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

提交至 Coveralls

设置本地环境变量以允许本地提交，并指定repo_token（在Coveralls项目页面获取）：

export COVERALLS_RUN_LOCALLY=1
export COVERALLS_REPO_TOKEN=你的令牌

然后调用 PHP-Coveralls 来发送报告：

php vendor/bin/php-coveralls

对于GitHub Actions，您可以将这些环境变量安全地设置在仓库的Secrets中，并在工作流中这样使用：

jobs:
  test_and_coveralls:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Install Dependencies
        run: composer install --dev --no-interaction
      - name: Run Tests and Generate Coverage
        run: vendor/bin/phpunit
      - name: Upload Coverage Results to Coveralls
        env:
          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: vendor/bin/php-coveralls