聊一聊PHP中单元测试工具PHPUnit的用法

单元测试是指对软件中的最小可测试单元进行检查和验证。本篇文章带大家了解一下php如何实现单元测试,介绍一下安装单元测试工具PHPUnit并使用的方法。

聊一聊PHP中单元测试工具PHPUnit的用法

朋友,你听说过安。。。不是,写过单元测试吗。

单元测试是开发过程中必不可少的一环,一个项目有良好的单元测试代码,重构的勇气都大很多。这次写一篇小文来介绍一下 PHP 的单元测试工具 PHPUnit 的使用。

安装

安装 PHPUnit 的方式很简单,使用 composer 可以一行代码就可以安装。

composer require --dev phpunit/phpunit

登录后复制

安装之后,在 vendor/bin 目录下有一个 phpunit 的可执行文件,这个就是 phpunit 本体了。假设我们项目的目录结构如下:

➜  phpunit tree .

├── controller
├── model
├── service
├── test
└── vendor
├── composer.json

登录后复制

其中我们的单元测试代码都放在 test 目录下。使用 composer 来为我们解决 autoload 的问题。

{
  "autoload": {
    "psr-4": {
      "Controller\\\\": "controller/",
      "Model\\\\": "model/",
      "Service\\\\": "service/",
      "Test\\\\": "test/",
    }
  },
}

登录后复制

如果你还不懂 composer 自动加载的使用,可以参考这篇文章。最后执行 composer dumpautoload -o 让自动加载生效。

到这里我们的安装就算结束了。如果你使用 phpstorm 进行开发,那么你需要进行如下的配置:

1.gif

这里指明了从哪里加载 PHPUnit,由于我们使用 composer 安装,所以,这里的文件选择 composer 生成的 autoload.php 文件即可。

使用

好了,假设我们现在进行开发,在 service 目录中添加了一个 CalculateService 的文件,并且编写了一个 abs 的函数。

namespace Service;

class CalculateService
{
    public function abs($num)
    {
        return abs($num);
    }
}

登录后复制

现在我们对 abs 函数进行单元测试,PHPUnit 规定了一个测试类必须遵守如下的规定:

  • 单元测试类名必须以 Test 结尾,必须继承 \\PHPUnit\\Framework\\TestCase 基类。
  • 每个测试函数必须以 test 开头。

上面的规定是必须遵守的,如果代码没有遵守规定 PHPUnit 不会把他当做单元测试代码。除了以上的两条,还有一些良好的编码习惯可以参考:

  • 单元测试代码都放在 test 目录下。
  • 每个单元测试类以被测试的类名开头。例如被测试类为 CalculateService,那么单元测试类应该为 CalculateServiceTest
  • 每个单元测试函数应该为被测试函数名结尾。例如被测试函数为 abs,那么单元测试函数应该为 testAbs

根据上面的规范,编写单元测试代码

class UserServiceTest extends \\PHPUnit\\Framework\\TestCase
{
    public function testAbs()
    {
        $userService = new \\Service\\CalculateService();
        $this->assertEquals(4, $userService->abs(4));
    }
}

登录后复制

在上面的测试代码中,调用了我们要测试的函数 abs,然后断言 $userService->abs(4) 的结果为 4。在 phpstorm 中直接在 testAbs 函数处右键选择 run UserServiceTest 执行:

2.gif

发现在控制台会输出如下内容

Time: 17 ms, Memory: 4.00MB

OK (1 test, 1 assertion)

登录后复制

表明 abs 通过了 $userService->abs(4) == 4 的测试用例。这里注意一点,这里并不表明 abs 函数已经通过测试,一个良好的测试应该包含多个测试用例来覆盖尽可能多的可能性。

现在 PHPUnit 基本的单元测试已经运行成功了,在 PHPUnit 的文档中,有更多关于测试的用法。由于 PHPUnit 的用法过多,这里不能一一说明,这里提一些其他用法。

  • PHPUnit 提供了 @test 的注解,如果一个测试函数添加了 @test 注解,那么测试函数名字就不必以 test 开头。

  • \\PHPUnit\\Framework\\TestCase 有一个 setUp 函数,如果自己编写的测试类重写了这个函数,那么每次在开始执行测试函数之前,会先执行 setUp 进行测试之前的初始化。同样,也有一个 tearDown 的函数,如果重写,那么在测试函数执行完毕之后调用 tearDown 函数。

  • .... 更多的内容需参考 PHPUnit 的文档。

phpunit.xml 文件

在上面的例子中,我们使用 phpstorm 逐个执行测试函数,但是如果我们需要一次性执行所有的单元测试,那么我们可以编写 phpunit.xml 文件来实现。

给出一个 phpunit.xml 的编写例子来讲解 phpunit.xml 的作用

<?xml version="1.0" encoding="UTF-8"?>
<phpunit>
    <testsuites>
        <testsuite>
            <directory>test</directory>
        </testsuite>
    </testsuites>
</phpunit>

登录后复制

这里 <directory>test</directory> 指定了测试代码都放在 test 目录下,在 phpstorm 下右键点击 phpunit.xml 文件选择 Run phpunit.xml,phpunit 就会到 test 目录下查找所有单元测试并逐个执行。

除了使用 phpunit.xml 来一次性执行所有的单元测试,还可以在 phpunit.xml 中配置单元测试结果的输出日志。

<?xml version="1.0" encoding="UTF-8"?>
<phpunit>
	.....
    <logging>
        <log type="testdox-html" target="tmp/log.html"/>
    </logging>
</phpunit>

登录后复制

此时在执行 phpunit.xml 文件,就会在项目目录下生成一个 tmp/log.html 文件,这个文件记录了所有单元测试的结果。

当然,,,更多 phpunit.xml 配置相关的内容,还是需要查看文档。 :laughing:

Mock 测试

PHPUnit 还提供了 Mock 测试。这里先介绍一下什么是 Mock 测试。

假设 foo 函数调用了 bar 函数,那么在对 foo 函数进行单元测试会有两个问题:

  • foo 函数依赖于 bar 函数的结果,那么在对 foo 进行单元测试的时候必然会引入 bar ,那么这样子单元测试就没意义了,如果测试不通过,那么无法保证 bug 出在 foo 还是 bar。
  • bar 函数可能在测试环境不可执行,那么 foo 无法获取 bar 的执行结果,从而无法对 foo 进行单元测试。

Mock 测试就是为了解决上面的问题而出现的,使用 Mock 我们可以虚拟出一个 bar 的调用,并且假设 bar 调用返回结果。如果还是听不懂,上一段代码就知道了。

class MockTest extends \\PHPUnit\\Framework\\TestCase {
	public function testGet()
	{  
		$stub = $this->createMock(\\App\\UserService::class);     //1
		$stub->method('get')->willReturn(3); 					//2
		$this->assertEquals(3,$stub->get(1));  					//3
	} 
}

登录后复制

上面的测试函数就使用到了 Mock,一行一行代码来分析:

  • 第一行创建了一个虚拟的 UserService 对象。
  • 第二行假设 UserService 中的 get 函数的返回值为 3。
  • 第三行调用 $stub->get(1) 不会真的去执行 get 函数,而是根据第二行的 willReturn 函数直接返回 3。

关于聊一聊PHP中单元测试工具PHPUnit的用法的文章就分享到这,如果对你有帮助欢迎继续关注我们哦

本文来自投稿,不代表重蔚自留地立场,如若转载,请注明出处https://www.cwhello.com/244251.html

如有侵犯您的合法权益请发邮件951076433@qq.com联系删除

(0)
php学习php学习订阅用户
上一篇 2023年3月29日 23:10
下一篇 2023年3月29日 23:10

相关推荐

  • PHP入门指南:PHP和Haskell。

    PHP和Haskell是两种非常不同的编程语言,它们的设计思路和用途都不同。在本文中,我们将会介绍PHP和Haskell,以及它们各自的优缺点。同时,我们还将分别介绍如何入门这两种编程语言,并给出一些学习的建议。PHP是一…

    2023年5月22日
    00
  • php使用ftp实现文件上传与下载功能(附代码)

    ftp文件上传 php自带有ftp操作的函数包,一个比较简单实现的ftp文件上传操作可以通过以下几个步骤来完成: 1、确认ftp server的ip地址与port端口信息(如果使用的是默认端口则可以不关心); 2、进行ftp_connect操…

    2018年3月22日
    0306
  • 如何在PHP中实现轮播图。

    随着互联网的发展,轮播图已经成为了网页设计中必不可少的一部分。在很多网页中,轮播图经常被用作展示企业文化、最新产品或是推广活动等场景。本篇文章将会分享如何使用PHP来实现轮播图的功能。一、轮播图的概念轮…

    2023年5月23日
    095
  • PHP与数据流处理的集成。

    随着数据处理需求不断升级,以及大数据应用的普及,数据流处理技术在近年来得到了广泛的应用。数据流处理技术的目的是在数据流中实时处理数据,以及在处理过程中同时产生新的数据流结果。PHP是一种非常流行的Web编…

    2023年5月21日
    01
  • 如何用PHP实现微信支付对账单查询

    随着移动支付的流行,微信支付成为了一个不可忽视的支付方式。作为开发人员,在使用微信支付时,对账单查询是必不可少的环节。本文将介绍如何利用PHP语言实现微信支付对账单的查询。获取微信支付账号信息在使用微信…

    2023年5月18日
    02
  • PHP中的MD5加密技术指南。

    PHP 是一门非常强大的编程语言,广泛应用于 Web 开发领域。随着 Web 网站日益壮大,网站安全问题成为 Web 开发中不可忽视的因素。其中,密码安全是最为重要的一环。为了保护用户密码,Web 开发人员常常使用加密技术…

    2023年5月23日
    02
  • 实现PHP+Mysql无限分类的方法

    无限分类是个老话题了,来看看PHP结合Mysql如何实现。【

    2022年6月17日
    0132
  • php如何使用Symfony6框架。

    Symfony6是一款流行的PHP框架,它提供了一种快速、安全和可靠的方式来建立Web应用程序。如果你是一名开发人员,你需要学会如何使用Symfony6框架。在本文中,我们将为您介绍Symfony6框架,并提供有关如何在PHP中使用…

    2023年6月3日
    02

联系我们

QQ:951076433

在线咨询:点击这里给我发消息邮件:951076433@qq.com工作时间:周一至周五,9:30-18:30,节假日休息