k2tzumi / laravel-coverage-middleware

用于获取远程服务器上 Laravel 应用程序代码覆盖率的 HTTP 中间件

0.0.6 2024-03-24 04:17 UTC

README

test passsed

laravel-coverage-middleware

用于获取远程服务器上 Laravel 应用程序代码覆盖率的 HTTP 中间件

简介

laravel-coverage-middleware 库旨在帮助开发者在远程 Laravel 应用程序的 API 测试中获取代码覆盖率。该库提供了一个中间件,可以在 API 测试期间收集代码覆盖率数据,然后用于生成报告并识别代码库中需要进一步测试的区域。

要求

下面是 laravel-coverage-middleware 的环境要求

  • PHP
    版本 8.2 或更高。
  • Laravel
    版本 9.0 或更高。
  • PHPUnit
    版本 9.0 或更高。
  • 运行
    版本 0.93.0 或更高。

安装

下面是安装 laravel-coverage-middleware 的步骤

  1. 运行以下命令将库作为开发依赖项安装
composer require --dev k2tzumi/laravel-coverage-middleware
  1. 运行以下命令发布库的配置文件
php artisan vendor:publish --provider="K2tzumi\LaravelCoverageMiddleware\Providers\CoverageServiceProvider"
  1. 运行以下命令安装覆盖率中间件
php artisan coverage:install {group}

请将 group 替换为要包含在覆盖率报告中的中间件组名称。

使用方法

下面是使用 laravel-coverage-middleware 的步骤

  1. 安装库后,启动 Laravel 应用程序,在 runn 中启用 httpRunner 跟踪,并运行 API 测试。
  2. 覆盖率数据将在 API 测试期间收集并存储在 storage/coverage 目录中。
  3. 您可以使用 phpcov 从覆盖率文件生成 HTML 报告并查看它们,以识别代码库中需要进一步测试的区域。

配置

安装 laravel-coverage-middleware 后,您可以编辑 config/coverage.php 文件来配置库。以下是可以用的配置选项

  • phpunit_config_path(默认: phpunit.xml)
    指定 PHPUnit 配置文件的路径。库收集的覆盖率数据将基于此配置文件中的源设置。
  • runn-trace-header(默认: X-Runn-Trace)
    指定 httpRunner 的跟踪头。如果您不使用 runn,您可以指定包含您的工具跟踪信息的请求头的名称。