浅谈如何提高PHP代码质量之单元测试

1、单元测试

通过实现单一责任原则(我们的代码应该只关注功能的单个部分),我们将确保在测试期间,我们只会同时关注项目的一小部分

通过使用 Liskov 替换原则和依赖倒置原则,我们的代码不会关心我们是否注入模拟依赖关系,只要它们实现了适当的接口

在单元测试中,我们确实希望用模拟对象替换所有依赖的服务,因此我们一次只测试一个类。但模拟是什么?它们是实现与其他对象相同的接口的对象,但它们的行为是受控的。例如,假设我们在创建一个价格比较服务,我们利用另一个服务来获取当前的汇率。在测试我们的比较器时,我们可以使用一个模拟对象来为特定的货币返回特定的汇率,因此我们的测试既不依赖也不调用真正的服务。

2、应该使用哪个框架?

有几个好的框架可以达到这个目的。最常见的可能是 PHPUnit。在我的工作中,我发现使用行为方法来编写测试会带来更好的结果,并使我更急切地编写测试。对于我们的项目,我们选择 phpspec。

安装过程相当简单 - 只需使用:

$ php composer.phar require --dev phpspec/phpspec

然后,如果你在本文的第一部分中配置了 PHing,那么你可以在 build.xml 中添加构建目标:

<target name="phpspec">
	<exec executable="bin/phpspec" passthru="true" checkreturn="true">
		<arg line="run --format=pretty" />
	</exec>
</target>...
<target name="run" depends="phpcs,phpcpd,phan,phpspec" />

然后,你必须为你想要测试的每个服务类创建一个测试类。让 PHPSpec 非常容易使用的是模型创建。你只需使用严格的输入,就可以将模拟对象声明为测试函数的参数。PHPSpec 会自动为你创建模拟。让我们看一下代码示例:

//spec/Domain/PriceComparatorSpec.php
<?php
namespace spec\Domain;
use Domain\Price;use Domain\PriceConverter;
use PhpSpec\ObjectBehavior;
class PriceComparatorSpec extends ObjectBehavior{
	public function let(PriceConverter $converter)    {
		$this->beConstructedWith($converter);
	}
	public function it_should_return_equal()    {
		$price1 = new Price(100, 'EUR');
		$price2 = new Price(100, 'EUR');
		$this->compare($price1, $price2)->shouldReturn(0);
	}
	public function it_should_convert_first(PriceConverter $converter) {
		$price1 = new Price(100, 'EUR');
		$price2 = new Price(100, 'PLN');
		$priceConverted = new Price(25, 'EUR');
		$converter->convert($price2, 'EUR')->willReturn($priceConverted);
		$this->compare($price1, $price2)->shouldReturn(1);
	}
}

这里有三个函数:

  • let( ) - 它允许使用依赖来初始化服务
  • 两个 it_* 函数实现测试。其中一种方法是使用模拟 $priceConverter 的方法实现 priceConverter 接口,该接口被注入到测试对象的创建中。

你可以看到创建模拟非常容易。你所需要做的就是将它定义为测试函数的参数,并通过指定在执行代码时应该运行哪些函数来配置 mock。如果需要,你还可以设置返回值。

所有测试的方法都是从 $this 上下文中运行的,你可以使用与模拟相同的语法来轻松地检查它们的结果。

3、如何设置测试?

Phpspec 有一个很好的文档,但是我将尝试向你展示一些在日常实践中有用的基本用例。

构建测试对象

一般来说,设置测试对象的最简单方法是调用 $this->beConstructedWith(…) 方法,该方法将所有应该传递给对象构造函数的 params 作为参数。

如果你的对象应该使用工厂方法来创建,那么你可以使用

this−>beConstructedThrough(this−>beConstructedThrough(methodName,$argumentsArray)方法。

在模拟中匹配运行时参数

你会发现 phpspec 使用一种非常类似于人类的语法来配置模拟。例如,如果你想要检查在运行时是否有一个模拟方法 someMethod 与参数“desired value”被调用,你可以在测试中定义它,如下面的例子:

$mockObject->someMethod("desired value")->shouldBeCalled();

如果你想要测试代码的行为,当一些 mock 的函数返回“some value”时,你可以通过调用来轻松地设置它:

$mockObject->someFunction("some input")->willReturn("some value");

有时我们并不真正关心传递给 mock 的确切参数。然后可以写这段代码:

use Prophecy\Argument\Token\AnyValueToken;
$mockObject->someFunction(new AnyValueToken())->willReturn(true);

有时你会关心一些参数,最好是写一个检查函数,它会告诉你是否正确地调用了一些方法,例如:

use Prophecy\Argument\Token\CallbackToken;
$checker = function (Message $message) use ($to, $text) {
	return $message->to === $to && $message->text === $text;
};
$msgSender->send(new CallbackToken($messageChecker))->shouldBeCalled()

匹配运行时异常

。在某些情况下,异常是代码接口的一部分。你希望它们在特定的场景被抛出。你可以通过编写以下代码来完成这项工作:

$this->shouldThrow(\DomainException::class)->during('execute', [$command, $responder]);

传给 during() 的第一个参数是将要调用的方法的名称,第二个参数是将传递给我们的方法的参数数组。

4、在哪里可以找到更多的例子?

在本文中,我们只介绍了一些基本的用例。请参考 phpspec 的文档,以找到更多的示例,这些示例将使你的测试代码变得漂亮!

代码覆盖率

PHPSpec 附带了扩展子系统,它允许例如创建代码覆盖率报告。如果您想要检查在测试中执行了多少代码,它们是很有帮助的。

你可以通过以下来安装这个扩展:

$ php composer.phar require --dev leanphp/phpspec-code-coverage

然后通过创建 phpspec 来启用它。yml 文件内容:

1 extensions: LeanPHP\PhpSpec\CodeCoverage\CodeCoverageExtension: ~

默认情况下,这个扩展会使用 PHP 的 Xdebug 扩展生成代码覆盖率信息,但是 PHP 的本机调试器 - phpdbg 会更快速一些:

$ phpdbg -qrr phpspec run

现在,你可以在 build 中更改 phpspec 的构建目标。xml:

<target name="phpspec">
	<exec executable="phpdbg" passthru="true" checkreturn="true">
		<arg line="-qrr bin/phpspec run --format=pretty" />
	</exec>
</target>...
<target name="run" depends="phpcs,phpcpd,phan,phpspec" />

报告在覆盖率 / 目录中生成,作为漂亮的 HTML 页面,可以浏览以检查测试覆盖率。

以上就是浅谈如何提高PHP代码质量之单元测试的详细内容,更多关于如何提高PHP代码质量之单元测试的资料请关注我们其它相关文章!

(0)

相关推荐

  • PHPUnit 单元测试安装与使用入门教程

    本文实例讲述了PHPUnit 单元测试安装与使用.分享给大家供大家参考,具体如下: 一.官网下载对应 PHP 版本的代码库 https://phpunit.de/getting-started-with-phpunit.html 二.安装 PHPUnit 官网提供了两种方法安装 1. PHP Archive (PHAR) ➜ wget -O phpunit https://phar.phpunit.de/phpunit-8.phar ➜ chmod +x phpunit ➜ ./phpunit

  • PHP单元测试配置与使用方法详解

    本文实例讲述了PHP单元测试配置与使用方法.分享给大家供大家参考,具体如下: php与其他语言不太一样,单元测试需要自己安装和配置,相对麻烦一点,不过单元测试对于提高库的稳定性和健壮性还是非常给力的,下面教大家怎么配置PHP单元测试 注意:php需升级到7.1版本以上 配置说明 1.全局安装phpunit命令脚本 $ wget https://phar.phpunit.de/phpunit-7.0.phar $ chmod +x phpunit-7.0.phar $ sudo mv phpuni

  • PHP单元测试框架PHPUnit用法详解

    本文实例讲述了PHP单元测试框架PHPUnit用法.分享给大家供大家参考,具体如下: 以前在学习IOS开发时有专门写过Objective-C的单元测试的文章,IOS开发学习之单元测试,今天再总结下怎么在PHP中使用单元测试. 一.前言 在这篇文章中,我们使用 composer 的依赖包管理工具进行phpunit包安装和管理,composer 官方地址 https://getcomposer.org/,按照提示进行全局安装即可,另外,我们也会使用一个非常好用的Monolog记录日志组件记录日志,方

  • PHP使用phpunit进行单元测试示例

    本文实例讲述了PHP使用phpunit进行单元测试.分享给大家供大家参考,具体如下: 1. linux服务器上安装phpunit wget https://phar.phpunit.de/phpunit.phar chmod +x phpunit.phar sudo mv phpunit.phar /usr/local/bin/phpunit 建立phpunit短命令 phpunit --version [root@dongzi phpunit_test]# phpunit --version

  • thinkPHP框架单元测试库tpunit用法示例

    本文实例讲述了thinkPHP框架单元测试库tpunit用法.分享给大家供大家参考,具体如下: thinkphp本身并没有提供相应的单元测试支持,所以这里介绍一个可以对tp进行单元测试的库tpunit. Tpunit这个库是依赖于phpunit的,其特点是易用.方便和非入侵式. 使用TPUNIT很简单,只需要定义一个路径常量和导入要被测试的文件即可. Home模块下有个控制器如下: namespace Home\Controller; use Think\Controller; class In

  • 使用PHPUnit进行单元测试并生成代码覆盖率报告的方法

    安装PHPUnit 使用 Composer 安装 PHPUnit #查看composer的全局bin目录 将其加入系统 path 路径 方便后续直接运行安装的命令 composer global config bin-dir --absolute #全局安装 phpunit composer global require --dev phpunit/phpunit #查看版本 phpunit --version 使用Composer构建你的项目 我们将新建一个unit项目用于演示单元测试的基本工

  • ThinkPHP5与单元测试PHPUnit使用详解

    thinkphp5.0 是 tp 发展路线第一个支持 composer 的.tp 有自己的载入机制,composer 也有自己的载入机制. 官方提供了 think-testing 组件可以通过 composer require topthink/think-testing 1.* 安装,但我对这个测试组件不是很满意,原因是它每个测试都是模拟成 http 请求.这也就意味着对于一些特定函数,还得封装到控制器中或者路由,该控制器还得控制它生产环境不能对外开放.thinkphp5.0 是 tp 发展路

  • PHPUnit + Laravel单元测试常用技能

    1. 数据供给器 用来提供参数和结果,使用 @dataProvider 标注来指定使用哪个数据供给器方法.例如检测app升级数据是否符合预期,addProviderAppUpdateData()提供测试的参数和结果.testAppUpdateData()检测appUpdateData()返回的结果是否和给定的预期结果相等,即如果$appId='apple_3.3.2_117', $result=['status' => 0, 'isIOS' => false], 则$data中如果含有['st

  • PHPStorm中如何对nodejs项目进行单元测试详解

    安装必要的包 nodejs的单元测试最常用的是使用mocha包.首先确保你本地安装nodejs,之后按照mocha包. npm install mocha -g 然后还需要安装相关的断言工具,Node.js中常用的断言库有: assert: TDD风格 should: BDD风格 expect: BDD风格 chai: BDD/TDD风格 使用npm install安装这些断言库其中之一即可. PHPStorm配置nodejs单元测试环境 在PHPStorm中选择菜单:Run -> Edit C

  • 浅谈如何提高PHP代码质量之单元测试

    1.单元测试 通过实现单一责任原则(我们的代码应该只关注功能的单个部分),我们将确保在测试期间,我们只会同时关注项目的一小部分 通过使用 Liskov 替换原则和依赖倒置原则,我们的代码不会关心我们是否注入模拟依赖关系,只要它们实现了适当的接口 在单元测试中,我们确实希望用模拟对象替换所有依赖的服务,因此我们一次只测试一个类.但模拟是什么?它们是实现与其他对象相同的接口的对象,但它们的行为是受控的.例如,假设我们在创建一个价格比较服务,我们利用另一个服务来获取当前的汇率.在测试我们的比较器时,我

  • 浅谈如何提高PHP代码质量之端到端集成测试

    概述 在这里,我们可以使用为行为驱动开发构建的工具--官方 PHP 的 Cucumber 实现--Behat.我们可以通过运行以下代码来安装它: $ php composer.phar require --dev behat/behat 增加一个目标到 build.xml(在本文的第一部分中描述了 Phing 设置) <target name="behat"> <exec executable="bin/behat" passthru="

  • 浅谈如何提高PHP代码的质量

    概述 我们可以将此归咎于许多原因,但这肯定不仅仅是因为 PHP 生态系统缺乏适当的测试工具.在本文中,我想向您展示一个简单的设置,用于项目的基本质量测试. 我不会详述任何特定的工具,而是专注于设定测试环境. 本文中有一个演示代码可以在 GitHub 上找到:https://github.com/mkosiedowski/php-testing-demo如果你对这篇文章中的例子有任何问题,可以参考. 1 必备条件 我假设您熟悉 PHP 7.1 语法,您可以使用 Composer 和 PSR-4 来

  • 浅谈一段java代码是如何执行的

    本文分享自华为云社区<一段java代码是如何执行的>,原文作者:技术火炬手 . 当你学会了java语言之后,你写了一些代码,然后你想要执行你的代码,来达成某些功能.那么,你都知道这段代码都是如何执行的吗? 1. 编译成class 众所周知,java代码是不能直接在jvm上执行的,执行的是class文件,将java代码编程class文件,需要编译 常用的编译方法是:javac xxx.java 但目前常见的java编辑工具,如eclipse和ideal都自带自动编译动能 2. jvm的构成 让我

  • 浅谈如何测试Python代码

    目录 一.介绍 二.测试范围 三.单元测试 四.第一个测试用例 五.异常测试 六.mounttab.py 七.测试覆盖率 八.总结 一.介绍 编写测试检验应用程序所有不同的功能.每一个测试集中在一个关注点上验证结果是不是期望的.定期执行测试确保应用程序按预期的工作.当测试覆盖很大的时候,通过运行测试你就有自信确保修改点和新增点不会影响应用程序. 知识点 单元测试概念 使用 unittest 模块 测试用例的编写 异常测试 测试覆盖率概念 使用 coverage 模块 二.测试范围 如果可能的话,

  • 提高团队代码质量利器ESLint及Prettier详解

    目录 正文 ESLint VUE 项目的规则 Prettier ESLint 与 Prettier 正文 每个开发人员都有独特的代码编写风格和不同的文本编辑器.在团队项目开发过程,不能强迫每个团队成员都写一样的代码风格. 可能会看到以下部分(或全部)内容: 缺少分号: 有单引号.双引号,风格不一致: 一些行之间有大量的空格,而其他行之间没有空格: 在使向右滚动多年以查看其中包含的所有内容的行上运行: 看似随意的缩进: 注释掉代码块: 初始化但未使用的变量: 一些使用“严格”JS 的文件和其他不使

  • 使用JSLint提高JS代码质量方法分享

    随着富 Web 前端应用的出现,开发人员不得不重新审视并重视 JavaScript 语言的能力和使用,抛弃过去那种只靠"复制 / 粘贴"常用脚本完成简单前端任务的模式.JavaScript 语言本身是一种弱类型脚本语言,具有相对于 C++ 或 Java 语言更为松散的限制,一切以函数为中心的函数式编程思想也为开发人员提供了更加灵活的语法实现.然而,这种灵活性在带来高效的同时,也成为初学或者经验不足的 JavaScript 开发人员的噩梦.形式各异的代码风格.隐含错误的代码行为,严重影响

  • 很让人受教的 提高php代码质量36计

    1.不要使用相对路径 常常会看到: require_once('../../lib/some_class.php'); 该方法有很多缺点: 它首先查找指定的php包含路径, 然后查找当前目录. 因此会检查过多路径. 如果该脚本被另一目录的脚本包含, 它的基本目录变成了另一脚本所在的目录. 另一问题, 当定时任务运行该脚本, 它的上级目录可能就不是工作目录了. 因此最佳选择是使用绝对路径: define('ROOT' , '/var/www/project/'); require_once(ROO

  • 浅谈让你的代码更简短,更整洁,更易读的ES6小技巧

    写在文章前面 这篇文章翻译自ES6 tips and tricks to make your code cleaner, shorter, and easier to read!. 文章就代码整洁方面对es6进行了总结.如有错误欢迎指出. template literals 模板字符串 模板字符串使字符串的使用变得比以前更简单了,他们以反引号开始(`),并且能过使用${变量}来插入变量.我们来比较一下下面两行代码. var fName = 'Peter', sName = 'Smith', ag

  • 浅谈Java代码的 微信长链转短链接口使用 post 请求封装Json(实例)

    废话不多说,直接上代码 String longUrl = "https://open.weixin.qq.com/connect/oauth2/authorize?appid=" + MpUtil.APPID + "&redirect_uri=" + MpUtil.HOMEPAGE + "/nweixinLoginPc.fo%3Frandomcode=" + randomcode + "&response_type=co

随机推荐