如何在PHP框架中进行单元测试_PHP框架单元测试入门指南

使用PHPUnit进行PHP单元测试,需安装框架并创建测试类继承TestCase,通过setUp初始化对象,编写test方法验证逻辑,如assertEquals断言结果、expectException检测异常;利用Mockery模拟依赖避免外部耦合,通过@dataProvider实现多组数据驱动测试,并运行phpunit命令执行测试生成覆盖率报告。

如何在php框架中进行单元测试_php框架单元测试入门指南

单元测试,简单来说,就是在最小的单元级别(通常是函数或方法)验证代码是否按照预期工作。对于PHP框架来说,单元测试是保证代码质量、可维护性和可靠性的关键。它能帮你尽早发现bug,减少后期集成和部署的风险。

在PHP框架中进行单元测试,你需要选择一个合适的测试框架,比如PHPUnit。然后,针对你的代码编写测试用例,运行这些用例,并根据结果进行调试和改进。

解决方案

  1. 选择测试框架:PHPUnit

    立即学习PHP免费学习笔记(深入)”;

    PHPUnit是PHP世界中最流行的单元测试框架,它提供了丰富的断言方法、测试运行器和代码覆盖率分析等功能。你可以通过Composer轻松安装PHPUnit:

    composer require --dev phpunit/phpunit
    登录后复制
  2. 编写测试用例

    在你的项目中创建一个tests目录(或者任何你喜欢的目录),并为你要测试的类创建对应的测试类。测试类应该继承自PHPUnit/Framework/TestCase

    假设你有一个名为Calculator的类,位于src目录下:

    <?php
    namespace App;
    
    class Calculator {
        public function add(int $a, int $b): int {
            return $a + $b;
        }
    
        public function divide(int $a, int $b): float {
            if ($b === 0) {
                throw new /InvalidArgumentException("Cannot divide by zero.");
            }
            return $a / $b;
        }
    }
    登录后复制

    那么,你的测试类可能如下所示:

    <?php
    namespace Tests;
    
    use App/Calculator;
    use PHPUnit/Framework/TestCase;
    
    class CalculatorTest extends TestCase {
        private Calculator $calculator;
    
        protected function setUp(): void {
            $this->calculator = new Calculator();
        }
    
        public function testAdd(): void {
            $result = $this->calculator->add(2, 3);
            $this->assertEquals(5, $result);
        }
    
        public function testDivide(): void {
            $result = $this->calculator->divide(10, 2);
            $this->assertEquals(5.0, $result);
        }
    
        public function testDivideByZero(): void {
            $this->expectException(/InvalidArgumentException::class);
            $this->calculator->divide(10, 0);
        }
    }
    登录后复制
    • setUp()方法:在每个测试方法执行之前运行,用于初始化测试环境。
    • testAdd()testDivide():测试Calculator类的add()divide()方法。
    • PHPUnit/Framework/TestCase0:PHPUnit提供的断言方法,用于比较实际结果和预期结果。
    • PHPUnit/Framework/TestCase1:测试divide()方法在除数为零时是否抛出异常。PHPUnit/Framework/TestCase3用于声明期望抛出的异常类型。
  3. 运行测试

    在项目根目录下,运行以下命令:

    ./vendor/bin/phpunit tests
    登录后复制

    PHPUnit会执行tests目录下的所有测试用例,并输出结果。

  4. 代码覆盖率

    PHPUnit可以生成代码覆盖率报告,帮助你了解哪些代码被测试覆盖,哪些没有。要生成代码覆盖率报告,你需要安装PHPUnit/Framework/TestCase5扩展,并在运行PHPUnit时加上PHPUnit/Framework/TestCase6选项:

    青柚面试

    青柚面试

    简单好用的日语面试辅助工具

    青柚面试57


    查看详情
    青柚面试

    ./vendor/bin/phpunit --coverage-html coverage tests
    登录后复制

    这将在PHPUnit/Framework/TestCase7目录下生成HTML格式的代码覆盖率报告。

如何Mock依赖项以进行隔离测试?

在单元测试中,我们经常需要Mock(模拟)依赖项,以隔离被测试的代码,避免外部依赖的影响。比如,如果Calculator类依赖于一个数据库连接,我们不希望在单元测试中真正连接数据库。

PHPUnit本身并没有内置的Mocking框架,但你可以使用Mockery或者Prophecy等第三方库。

使用Mockery:

首先,通过Composer安装Mockery:

composer require --dev mockery/mockery
登录后复制

然后,在你的测试用例中使用Mockery来创建Mock对象:

<?php
namespace Tests;

use App/Calculator;
use PHPUnit/Framework/TestCase;
use Mockery;

class CalculatorTest extends TestCase {
    public function testAddWithMockedDependency(): void {
        // 创建一个Mock对象,模拟一个依赖项
        $dependency = Mockery::mock('MyDependency');

        // 设置Mock对象的行为:当调用某个方法时,返回特定的值
        $dependency->shouldReceive('getValue')->andReturn(10);

        // 创建被测试的对象,并将Mock对象作为依赖项注入
        $calculator = new Calculator($dependency);

        // 执行测试
        $result = $calculator->add($dependency->getValue(), 5);

        // 断言结果
        $this->assertEquals(15, $result);
    }

    public function tearDown(): void {
        Mockery::close();
    }
}
登录后复制
  • PHPUnit/Framework/TestCase9:创建一个名为Calculator0的类的Mock对象。
  • Calculator1:设置Mock对象的行为:当调用Calculator2方法时,返回Calculator3。
  • Calculator4:在测试结束后,清理Mockery创建的Mock对象。

如何测试异常?

测试异常是单元测试中一个重要的方面,它可以确保你的代码在遇到错误情况时能够正确处理。

在PHPUnit中,你可以使用PHPUnit/Framework/TestCase3、Calculator6和Calculator7等方法来测试异常。

<?php
namespace Tests;

use App/Calculator;
use PHPUnit/Framework/TestCase;

class CalculatorTest extends TestCase {
    public function testDivideByZero(): void {
        // 声明期望抛出的异常类型
        $this->expectException(/InvalidArgumentException::class);

        // 声明期望抛出的异常消息
        $this->expectExceptionMessage("Cannot divide by zero.");

        // 执行可能抛出异常的代码
        $calculator = new Calculator();
        $calculator->divide(10, 0);
    }
}
登录后复制
  • Calculator8:声明期望抛出的异常类型为Calculator9。
  • src0:声明期望抛出的异常消息为src1。

如果divide()方法没有抛出Calculator9异常,或者抛出的异常消息不匹配,PHPUnit将会报错。

如何进行数据提供者测试?

数据提供者是一种在PHPUnit中运行相同测试用例,但使用不同输入数据的方法。这可以减少重复代码,并提高测试效率。

你可以使用src4注解来指定一个数据提供者方法。数据提供者方法必须返回一个数组,数组中的每个元素都是一个包含测试数据的数组。

<?php
namespace Tests;

use App/Calculator;
use PHPUnit/Framework/TestCase;

class CalculatorTest extends TestCase {
    /**
     * @dataProvider addDataProvider
     */
    public function testAdd(int $a, int $b, int $expected): void {
        $calculator = new Calculator();
        $result = $calculator->add($a, $b);
        $this->assertEquals($expected, $result);
    }

    public static function addDataProvider(): array {
        return [
            [2, 3, 5],
            [5, 5, 10],
            [0, 0, 0],
            [-1, 1, 0],
        ];
    }
}
登录后复制
  • src5:指定src6方法作为testAdd()测试用例的数据提供者。
  • src6:返回一个数组,数组中的每个元素都是一个包含三个元素的数组,分别表示src9、setUp()0和setUp()1的值。

PHPUnit会多次运行testAdd()测试用例,每次使用src6返回的不同数据。

以上就是如何在PHP框架中进行单元测试_PHP框架单元测试入门指南的详细内容,更多请关注php中文网其它相关文章!

https://www.php.cn/faq/1599263.html

发表回复

Your email address will not be published. Required fields are marked *