代码覆盖率 on Yison's Blog

在Yii2框架上使用PHPUnit做单元测试与代码覆盖率

Fri, 11 May 2018 00:00:00 +0000

PHPUnit 是一个很不错的测试框架，既能做自动化单元测试，也能同时检测代码覆盖率。自己在 Yii 框架上经过一番尝试，总结了这篇配置指南。

目录结构约定

在 Yii2 项目下，需要创建 phpunit 目录：

yii2-project/
├── phpunit/
│ ├── README.md # 说明文档
│ ├── _bootstrap.php # 框架初始化文件
│ ├── phpunit.xml # 配置文件
│ └── tests/
│ ├── UserAuthTest.php
│ └── ...
├── frontend/
├── backend/
└── common/

_bootstrap.php 引导文件

参考 frontend/web/index.php，创建引导文件：

<?php
// phpunit/_bootstrap.php

// 定义测试环境常量
defined('YII_DEBUG') or define('YII_DEBUG', true);
defined('YII_ENV') or define('YII_ENV', 'test');

// 引入 Composer 自动加载
require_once dirname(__DIR__) . '/vendor/autoload.php';

// 引入 Yii 入口文件
require_once dirname(__DIR__) . '/frontend/web/index.php';

// 返回应用实例（而不是运行）
return Yii::$app;

phpunit.xml 配置

<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
 bootstrap="_bootstrap.php"
 backupGlobals="false"
 backupStaticAttributes="false"
 beStrictAboutCoversAnnotation="true"
 beStrictAboutOutputDuringTests="true"
 beStrictAboutTestsThatDoNotTestAnything="true"
 beStrictAboutTodoAnnotatedTests="true"
 forceCoversAnnotation="true"
 verbose="true"
 colors="true">
 
 <!-- 测试套件配置 -->
 <testsuites>
 <testsuite name="Application Test Suite">
 <directory suffix="Test.php">./tests</directory>
 </testsuite>
 </testsuites>

 <!-- 代码覆盖率配置 -->
 <coverage>
 <include>
 <directory suffix=".php">../frontend/controllers</directory>
 <directory suffix=".php">../backend/controllers</directory>
 <directory suffix=".php">../common</directory>
 <directory suffix=".php">../console</directory>
 </include>
 <exclude>
 <directory suffix=".php">../common/mail</directory>
 <directory suffix=".php">../common/config</directory>
 </exclude>
 </coverage>

 <!-- 日志配置 -->
 <logging>
 <log type="coverage-html" target="coverage"/>
 <log type="coverage-clover" target="logs/clover.xml"/>
 <log type="coverage-crap4j" target="logs/crap4j.xml"/>
 <log type="junit" target="logs/junit.xml"/>
 <log type="testdox-html" target="testdox/index.html"/>
 </logging>
</phpunit>

安装 PHPUnit

使用 Composer 安装

# 进入项目目录
cd your-yii2-project

# 安装 PHPUnit（建议作为开发依赖）
composer require --dev phpunit/phpunit:^9.0

# 或者安装带 PHP 版本支持的版本
composer require --dev phpunit/phpunit:"^9.0" --ignore-platform-reqs

# 安装代码覆盖率扩展
composer require --dev phpunit/php-code-coverage

验证安装

# 检查 PHPUnit 版本
./vendor/bin/phpunit --version

# PHPUnit 9.x 输出
# PHPUnit 9.6.x by Sebastian Bergmann and contributors.

测试命令

运行测试

# 进入测试目录
cd phpunit/

# 运行所有测试
../vendor/bin/phpunit --configuration phpunit.xml

# 指定测试文件
../vendor/bin/phpunit --configuration phpunit.xml tests/UserAuthTest.php

# 运行测试套件
../vendor/bin/phpunit --configuration phpunit.xml --testsuite "Application Test Suite"

生成覆盖率报告

# 生成 HTML 覆盖率报告
../vendor/bin/phpunit --configuration phpunit.xml --coverage-html coverage

# 生成 Clover XML 格式报告（可导入 CI 系统）
../vendor/bin/phpunit --configuration phpunit.xml --coverage-clover logs/clover.xml

编写单元测试

基本测试示例

<?php
// tests/UserAuthTest.php

namespace tests;

use PHPUnit\Framework\TestCase;
use common\models\User;

class UserAuthTest extends TestCase
{
 /**
 * @covers \common\models\User
 */
 public function testUserCanBeCreated()
 {
 $user = new User();
 $user->username = 'testuser';
 $user->email = 'test@example.com';
 
 $this->assertInstanceOf(User::class, $user);
 $this->assertEquals('testuser', $user->username);
 }

 /**
 * @covers \common\models\User::validatePassword()
 */
 public function testPasswordValidation()
 {
 $user = new User();
 $user->password_hash = password_hash('secret', PASSWORD_DEFAULT);
 
 $this->assertTrue($user->validatePassword('secret'));
 $this->assertFalse($user->validatePassword('wrong'));
 }

 /**
 * @covers \common\models\User::getId()
 */
 public function testUserIdReturnsInteger()
 {
 $user = new User();
 $user->id = 123;
 
 $this->assertIsInt($user->getId());
 $this->assertEquals(123, $user->getId());
 }
}

Yii2 ActiveRecord 测试

<?php
// tests/UserModelTest.php

namespace tests;

use Yii;
use Codeception\Specify;
use common\fixtures\UserFixture;
use common\models\User;

class UserModelTest extends \yii\codeception\TestCase
{
 // 加载测试数据
 public $fixtures = [
 'user' => [
 'class' => UserFixture::class,
 'dataFile' => '@tests/fixtures/data/user.php',
 ],
 ];

 public function testUserLogin()
 {
 $user = User::findByUsername('erau');
 
 $this->assertNotNull($user);
 $this->assertTrue($user->validatePassword('password_0'));
 }

 public function testUserNotFound()
 {
 $user = User::findByUsername('nonexistent');
 
 $this->assertNull($user);
 }
}

Fixture 数据文件

<?php
// tests/fixtures/data/user.php

return [
 'user1' => [
 'id' => 1,
 'username' => 'erau',
 'auth_key' => 'testAuthKey_0',
 'password_hash' => '$2y$13$qFS7HXXkJb9V5KjZ8xX7EOYKvW7YQZ1xX7EOYKvW7YQZ1xX7EO',
 'email' => 'erau@example.com',
 'status' => 10,
 'created_at' => 1500000000,
 'updated_at' => 1500000000,
 ],
];

常用注解

注解	说明
`@covers ClassName`	指定测试覆盖的类
`@covers ClassName::method`	指定测试覆盖的方法
`@coversNothing`	该测试不计入覆盖率
`@depends`	依赖另一个测试
`@dataProvider`	数据供给器

/**
 * @covers \common\models\User::findByUsername()
 * @covers \common\models\User::validatePassword()
 */
public function testLoginWithValidCredentials()
{
 // ...
}

CI 集成

GitHub Actions

# .github/workflows/phpunit.yml
name: PHPUnit Tests

on: [push, pull_request]

jobs:
 test:
 runs-on: ubuntu-latest
 
 steps:
 - uses: actions/checkout@v3
 
 - name: Setup PHP
 uses: shivammathur/setup-php@v2
 with:
 php-version: '8.1'
 extensions: pdo_mysql, intl
 coverage: xdebug
 
 - name: Install Dependencies
 run: composer install --prefer-dist
 
 - name: Run PHPUnit
 run: ./vendor/bin/phpunit --configuration phpunit.xml --colors=never

最佳实践

遵循 AAA 模式（Arrange-Act-Assert）
测试单一职责 - 每个测试只验证一个行为

PHP代码覆盖率入门指南

Fri, 04 May 2018 00:00:00 +0000

最近在玩 PHP 的单元测试，以及代码覆盖率这块，遇到一些问题，记录下来作为简单入门参考。

安装 PHPUnit

Composer 安装（推荐）

# 进入项目目录
cd your-project

# 安装 PHPUnit
composer require --dev phpunit/phpunit:^10.0

# 安装代码覆盖率扩展
composer require --dev phpunit/php-code-coverage

PHP Archive (PHAR)

# 下载 PHPUnit
wget https://phar.phpunit.de/phpunit-10.phar

# 添加执行权限
chmod +x phpunit-10.phar

# 全局安装
sudo mv phpunit-10.phar /usr/local/bin/phpunit

# 验证
phpunit --version

基础单元测试示例

编写测试

<?php
// tests/StackTest.php

namespace tests;

use PHPUnit\Framework\TestCase;

class StackTest extends TestCase
{
 /**
 * 测试空栈
 */
 public function testEmpty(): void
 {
 $stack = [];
 $this->assertEmpty($stack);

 return $stack;
 }

 /**
 * 测试压栈
 * @depends testEmpty
 */
 public function testPush(array $stack): array
 {
 array_push($stack, 'foo');
 $this->assertEquals('foo', $stack[count($stack) - 1]);
 $this->assertNotEmpty($stack);

 return $stack;
 }

 /**
 * 测试弹栈
 * @depends testPush
 */
 public function testPop(array $stack): void
 {
 $this->assertEquals('foo', array_pop($stack));
 $this->assertEmpty($stack);
 }
}

运行测试

# 运行所有测试
phpunit --verbose tests/

# 运行指定测试文件
phpunit --verbose tests/StackTest.php

# 运行指定测试方法
phpunit --verbose tests/StackTest.php --filter testPush

输出示例

PHPUnit 10.0 by Sebastian Bergmann and contributors.

Runtime: PHP 8.2.0 with Xdebug 3.2.0

... 3 / 3 (100%)

Time: 149 ms, Memory: 10.00MB

OK (3 tests, 5 assertions)

代码覆盖率配置

phpunit.xml 配置

<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
 bootstrap="vendor/autoload.php"
 colors="true"
 executionOrder="depends,defects"
 beStrictAboutOutputDuringTests="true"
 cacheResultFile=".phpunit.cache/test-results">
 
 <testsuites>
 <testsuite name="Unit Tests">
 <directory suffix="Test.php">./tests</directory>
 </testsuite>
 </testsuites>

 <coverage>
 <include>
 <directory suffix=".php">./src</directory>
 </include>
 <exclude>
 <directory suffix=".php">./src/Exceptions</directory>
 <file>./src/bootstrap.php</file>
 </exclude>
 
 <!-- HTML 报告 -->
 <report>
 <html outputDirectory="coverage"/>
 </report>
 
 <!-- Clover XML 报告（CI 集成） -->
 <report>
 <clover outputFile="coverage/clover.xml"/>
 </report>
 </coverage>
</phpunit>

运行覆盖率测试

# 生成覆盖率报告
phpunit --coverage-html coverage/

# 指定覆盖率输出目录
phpunit --coverage-html ./report/coverage/

# 生成 Clover XML 格式
phpunit --coverage-clover coverage/clover.xml

常用断言方法

断言	说明
`assertEquals($expected, $actual)`	值相等
`assertSame($expected, $actual)`	同一对象/值
`assertTrue($condition)`	条件为真
`assertFalse($condition)`	条件为假
`assertNull($value)`	值为空
`assertContains($needle, $haystack)`	数组/字符串包含
`assertCount($expected, $actual)`	元素数量
`assertEmpty($actual)`	值为空
`assertThrows($exception, $callable)`	抛出异常
`assertMatchesRegularExpression($pattern, $string)`	正则匹配

测试依赖

@depends 依赖

public function testCreate(): array
{
 $entity = new Entity();
 $entity->create(['name' => 'test']);
 $this->assertNotNull($entity->getId());
 
 return ['id' => $entity->getId()];
}

/**
 * @depends testCreate
 */
public function testFind(array $data): void
{
 $entity = new Entity();
 $found = $entity->find($data['id']);
 
 $this->assertNotNull($found);
 $this->assertEquals('test', $found->name);
}

数据供给器

@dataProvider

/**
 * @dataProvider additionProvider
 */
public function testAddition(int $a, int $b, int $expected): void
{
 $this->assertEquals($expected, $a + $b);
}

public function additionProvider(): array
{
 return [
 'zero plus zero' => [0, 0, 0],
 'positive numbers' => [1, 2, 3],
 'negative numbers' => [-1, -1, -2],
 ];
}

Mock 对象

创建 Mock

use PHPUnit\Framework\TestCase;
use App\Services\UserService;
use App\Repositories\UserRepository;

class UserServiceTest extends TestCase
{
 public function testGetUserName(): void
 {
 // 创建 Mock 对象
 $repository = $this->createMock(UserRepository::class);
 
 // 配置 Mock 行为
 $repository->method('find')
 ->with(1)
 ->willReturn(['id' => 1, 'name' => 'John']);
 
 // 使用 Mock
 $service = new UserService($repository);
 $name = $service->getUserName(1);
 
 $this->assertEquals('John', $name);
 }
}

Mock 方法链

$mock = $this->getMockBuilder(stdClass::class)
 ->addMethods(['getName', 'setName'])
 ->getMock();

$mock->method('getName')->willReturn('Test');

数据集测试

use PHPUnit\Framework\TestCase;

class DataProviderTest extends TestCase
{
 /**
 * @dataProvider additionProvider
 */
 public function testAdditions(int $a, int $b, int $expected): void
 {
 $this->assertEquals($expected, $a + $b);
 }

 public static function additionProvider(): array
 {
 return [
 'integers' => [1, 2, 3],
 'floats' => [0.1, 0.2, 0.3],
 ];
 }
}

CI 集成

GitHub Actions

# .github/workflows/phpunit.yml
name: PHPUnit Tests

on: [push, pull_request]

jobs:
 test:
 runs-on: ubuntu-latest
 
 steps:
 - uses: actions/checkout@v3
 
 - name: Setup PHP
 uses: shivammathur/setup-php@v2
 with:
 php-version: '8.2'
 extensions: xdebug
 coverage: xdebug
 
 - name: Install Dependencies
 run: composer install --prefer-dist
 
 - name: Run Tests with Coverage
 run: |
 ./vendor/bin/phpunit \n --coverage-text \n --coverage-clover coverage/clover.xml
 env:
 XDEBUG_MODE: coverage

常见问题

Q: Xdebug 版本不兼容

# PHPUnit 10 需要 Xdebug 3.x
composer require --dev phpunit/phpunit:^10.0
pecl install xdebug

# Xdebug 2.x 适配 PHPUnit 9
composer require --dev phpunit/phpunit:^9.0
pecl install xdebug-2.9.8

Q: 覆盖率不准确

检查 phpunit.xml 中的 include/exclude 配置是否正确：

<coverage>
 <include>
 <directory suffix=".php">./src</directory>
 </include>
</coverage>

最佳实践

每个发布单元（类/模块）至少覆盖一条主路径与一条异常路径，优先保证核心业务与错误分支可被测试执行到。
单元测试避免直连真实数据库、MQ、第三方 HTTP，可用接口抽象 + 内存实现或 Mock，使覆盖率反映的是「你的代码」而非外部环境。
在 CI 中固定 PHPUnit、Xdebug 主版本，并通过环境变量注入 XDEBUG_MODE=coverage，避免本地与流水线结果不一致。
覆盖率是手段不是目的：不必盲目追求 100%；对复杂条件分支优先补测试用例或重构降低圈复杂度。
结合静态分析与 CR：将 Clover/XML 输出接入 SonarQube、Codecov 等工具，对新增未覆盖代码做团队约定（例如 Diff Coverage 阈值）。

代码覆盖率 on Yison's Blog

在Yii2框架上使用PHPUnit做单元测试与代码覆盖率

目录结构约定

_bootstrap.php 引导文件

phpunit.xml 配置

安装 PHPUnit

使用 Composer 安装

验证安装

测试命令

运行测试

生成覆盖率报告

编写单元测试

基本测试示例

Yii2 ActiveRecord 测试

Fixture 数据文件

常用注解

CI 集成

GitHub Actions

最佳实践

PHP代码覆盖率入门指南

安装 PHPUnit

Composer 安装（推荐）

PHP Archive (PHAR)

基础单元测试示例

编写测试

运行测试

输出示例

代码覆盖率配置

phpunit.xml 配置

运行覆盖率测试

常用断言方法

测试依赖

@depends 依赖

数据供给器

@dataProvider

Mock 对象

创建 Mock

Mock 方法链

数据集测试

CI 集成

GitHub Actions

常见问题

Q: Xdebug 版本不兼容

Q: 覆盖率不准确

最佳实践

延伸阅读