如何提升 PHP 代码的质量？第二部分 单元测试

在“如何提升 PHP 代码的质量？”的前一部分中：咱们设置了一些自动化工具来自动检查咱们的代码。这颇有帮助，但关于咱们的代码如何知足业务需求并无给咱们留下任何印象。咱们如今须要建立特定代码域的测试。

1 单元测试

最多见的测试软件的方法多是编写单元测试。它们的目的是测试代码的特定单元，基于这样的假设：一切都按预期运行。为了可以编写适当的单元测试，咱们的代码应该遵循一些基本的设计规则。咱们应该特别关注 SOLID 原则。

• 经过实现单一责任原则（咱们的代码应该只关注功能的单个部分），咱们将确保在测试期间，咱们只会同时关注项目的一小部分
• 经过使用 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<?phpnamespace 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() 的第一个参数是将要调用的方法的名称，第二个参数是将传递给咱们的方法的参数数组。

5 在哪里能够找到更多的例子？

在本文中，咱们只介绍了一些基本的用例。请参考 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 代码的质量？第三：端到端 / 集成测试