PHP単体テストフレームワークPHPUnitの使い方

以前、IOS開発を学習していた時に、Objective-Cでの単体テストに特化した記事を書きましたが、今日はPHPでの単体テストの使い方をまとめます。

1. 前書き

この記事では、composer の依存関係パッケージ管理ツールを使用して、phpunit パッケージをインストールおよび管理します。Composer の正式なアドレスは https:/ です。 /getcomposer.org/ にアクセスし、プロンプトに従ってグローバルにインストールします。さらに、非常に使いやすい Monolog ロギング コンポーネントを使用してログを記録します。 composer 的依赖包管理工具进行phpunit包安装和管理，composer 官方地址 https://getcomposer.org/，按照提示进行全局安装即可，另外，我们也会使用一个非常好用的Monolog记录日志组件记录日志，方便我们查看。

在根目录下建立 coomposer.json 的配置文件,输入以下内容:

{
    "autoload": {
        "classmap": [
            "./"
        ]
    }
}

上面的意思是将根目录下的所有的类文件都加载进来， 在命令行执行 composer install 后，在根目录会生成出一个vendor的文件夹，我们以后通过 composer 安装的任何第三方代码都会被生成在这里。

二、为什么要单元测试？

只要你想到输入一些东西到print语句或调试表达式中，就用测试代替它。  --Martin Fowler

PHPUnit 是一个用PHP编程语言开发的开源软件，是一个单元测试框架。PHPUnit由Sebastian Bergmann创建，源于Kent Beck的SUnit，是xUnit家族的框架之一。

单元测试是对单独的代码对象进行测试的过程，比如对函数、类、方法进行测试。单元测试可以使用任意一段已经写好的测试代码，也可以使用一些已经存在的测试框架，比如JUnit、PHPUnit或者Cantata++，单元测试框架提供了一系列共同、有用的功能来帮助人们编写自动化的检测单元，例如检查一个实际的值是否符合我们期望的值的断言。单元测试框架经常会包含每个测试的报告，以及给出你已经覆盖到的代码覆盖率。

总之一句话，使用 phpunit 进行自动测试，会使你的代码更健壮，减少后期维护的成本，也是一种比较标准的规范，现如今流行的PHP框架都带了单元测试，如Laraval,Symfony,Yii2等，单元测试已经成了标配。

另外，单元测试用例是通过命令操控测试脚本的，而不是通过浏览器访问URL的。

三、安装PHPUnit

使用 composer 方式安装 PHPUnit，其他安装方式请看这里

composer require --dev phpunit/phpunit ^6.2

安装 Monolog 日志包,做 phpunit 测试记录日志用。

composer require monolog/monolog

安装好之后，我们可以看coomposer.json 文件已经有这两个扩展包了：

 "require": {  
     "monolog/monolog": "^1.23",
    },

 "require-dev": {
        "phpunit/phpunit": "^6.2"
    },

四、PHPUnit简单用法

1、单个文件测试

创建目录tests，新建文件 StackTest.php，编辑如下：

<?php
/**
 * 1、composer 安装Monolog日志扩展，安装phpunit单元测试扩展包
 * 2、引入autoload.php文件
 * 3、测试案例
 *
 *
 */
namespace App\tests;
require_once __DIR__ . &#39;/../vendor/autoload.php&#39;;
define("ROOT_PATH", dirname(__DIR__) . "/");

use Monolog\Logger;
use Monolog\Handler\StreamHandler;

use PHPUnit\Framework\TestCase;


class StackTest extends TestCase
{
    public function testPushAndPop()
    {
        $stack = [];
        $this->assertEquals(0, count($stack));

        array_push($stack, &#39;foo&#39;);

        // 添加日志文件,如果没有安装monolog，则有关monolog的代码都可以注释掉
        $this->Log()->error(&#39;hello&#39;, $stack);

        $this->assertEquals(&#39;foo&#39;, $stack[count($stack)-1]);
        $this->assertEquals(1, count($stack));

        $this->assertEquals(&#39;foo&#39;, array_pop($stack));
        $this->assertEquals(0, count($stack));
    }

    public function Log()
    {
        // create a log channel
        $log = new Logger(&#39;Tester&#39;);
        $log->pushHandler(new StreamHandler(ROOT_PATH . &#39;storage/logs/app.log&#39;, Logger::WARNING));
        $log->error("Error");
        return $log;
    }
}

代码解释：

1. StackTest为测试类

2. StackTest 继承于 PHPUnitFrameworkTestCase

3. 测试方法testPushAndPop()，测试方法必须为public权限，一般以test开头，或者你也可以选择给其加注释@test来表

4. 在测试方法内，类似于 assertEquals() 这样的断言方法用来对实际值与预期值的匹配做出断言。

命令行执行:
phpunit 命令 测试文件命名

➜  framework#  ./vendor/bin/phpunit tests/StackTest.php

// 或者可以省略文件后缀名
//  ./vendor/bin/phpunit tests/StackTest

执行结果：

➜  framework# ./vendor/bin/phpunit tests/StackTest.php
PHPUnit 6.4.1 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 56 ms, Memory: 4.00MB

OK (1 test, 5 assertions)

我们可以在app.log文件中查看我们打印的日志信息。

2、类文件引入

Calculator.php

<?php  
class Calculator  
{  
    public function sum($a, $b)  
    {  
        return $a + $b;  
    }  
}  
?>

单元测试类：
CalculatorTest.php

<?php

namespace App\tests;
require_once __DIR__ . &#39;/../vendor/autoload.php&#39;;
require "Calculator.php";

use PHPUnit\Framework\TestCase;


class CalculatorTest extends TestCase
{
    public function testSum()
    {
        $obj = new Calculator;
        $this->assertEquals(0, $obj->sum(0, 0));

    }

}

命令执行：

> ./vendor/bin/phpunit tests/CalculatorTest

执行结果：

PHPUnit 6.4.1 by Sebastian Bergmann and contributors.

F                                                                   1 / 1 (100%)

Time: 117 ms, Memory: 4.00MB

There was 1 failure:

如果我们把这里的断言故意写错，$this->assertEquals(1, $obj->sum(0, 0));
看执行结果：

PHPUnit 6.4.1 by Sebastian Bergmann and contributors.

F                                                                   1 / 1 (100%)

Time: 117 ms, Memory: 4.00MB

There was 1 failure:

1) App\tests\CalculatorTest::testSum
Failed asserting that 0 matches expected 1.

/Applications/XAMPP/xamppfiles/htdocs/web/framework/tests/CalculatorTest.php:22

FAILURES!
Tests: 1, Assertions: 1, Failures: 1.

会直接报出方法错误信息及行号，有助于我们快速找出bug

3、高级用法

你是否已经厌烦了在每一个测试方法命名前面加一个test，是否因为只是调用的参数不同，却要写多个测试用例而纠结？我最喜欢的高级功能，现在隆重推荐给你，叫做框架生成器。

Calculator.php

<?php  
class Calculator  
{  
    public function sum($a, $b)  
    {  
        return $a + $b;  
    }  
}  
?>

命令行启动测试用例，使用关键字 --skeleton

ルート ディレクトリに coomposer.json 設定ファイルを作成し、次の内容を入力します:

> ./vendor/bin/phpunit --skeleton Calculator.php

上記は、ルート ディレクトリにあるすべての class ファイル をロードすることを意味します。コマンドラインで composer install を実行すると、composer を通じてインストールしたファイルがルート ディレクトリに生成されます。将来のサードパーティのコードはここで生成されます。

2. なぜ単体テストをするのか?

print ステートメントやデバッグ式に何かを入力しようと思ったら、それをテストに置き換えてください。 --Martin Fowler

PHPUnit は、PHP プログラミング言語で開発されたオープン ソース ソフトウェアであり、単体テスト フレームワークです。 PHPUnit は Sebastian Bergmann によって作成され、Kent Beck の SUnit から派生したもので、xUnit ファミリのフレームワークの 1 つです。

単体テストは、関数、クラス、メソッドのテストなど、個々のコード オブジェクトをテストするプロセスです。単体テストでは、作成済みの任意のテスト コードを使用することも、JUnit、PHPUnit、Cantata++ などの既存のテスト フレームワークを使用することもできます。単体テスト フレームワークは、自動検出ユニットの作成に役立つ一連の一般的で便利な関数を提供します。 . 、実際の値が期待値と一致するかどうかを確認するアサーションなど。単体テスト フレームワークには多くの場合、各テストのレポートが含まれており、カバーしたコード カバレッジが示されます。

つまり、自動テストに phpunit を使用すると、コードがより堅牢になり、後のメンテナンスのコストが削減されます。これは、今日の人気のある PHP フレームワークに含まれている比較的標準的な仕様でもあります。 Laraval、Symfony、Yii2 など、単体テストは標準となっています。 🎜🎜さらに、単体テスト ケースは、ブラウザーを通じて URL にアクセスするのではなく、コマンドを通じてテスト スクリプトを制御します。 🎜🎜3. PHPUnit をインストールします🎜🎜composer を使用して PHPUnit をインストールします。他のインストール方法については、こちらを参照してください🎜

PHPUnit 6.4.1 by Sebastian Bergmann and contributors.

Wrote test class skeleton for Calculator to CalculatorTest.php.

🎜 phpunit のテストとログに使用される Monolog ログ パッケージをインストールします。 🎜

<?php  
class Calculator  
{  
    /** 
     * @assert (0, 0) == 0 
     * @assert (0, 1) == 1 
     * @assert (1, 0) == 1 
     * @assert (1, 1) == 2 
     */  
    public function sum($a, $b)  
    {  
        return $a + $b;  
    }  
}  
?>

🎜 インストール後、coomposer.json ファイルに次の 2 つの拡張パックが含まれていることがわかります: 🎜

    /**
     * Generated from @assert (0, 0) == 0.
     */
    public function testSum() {
        $obj = new Calculator;
        $this->assertEquals(0, $obj->sum(0, 0));
    }

🎜 4. PHPUnit の簡単な使用法🎜

1. >🎜ディレクトリ tests を作成し、新しいファイル StackTest.php を作成して、次のように編集します: 🎜

🎜コードの説明: 🎜

🎜StackTest はテストクラスです🎜

🎜StackTest は PHPUnitFrameworkTestCase を継承します🎜

🎜test MethodtestPushAndPop() の場合、テスト メソッドには public 権限が必要です。通常は test で始まります。または、 で注釈を付けることもできます。 @test テーブル 🎜

🎜 テスト メソッド内では、assertEquals() のようなアサーション メソッドを使用して、実際の値が期待値と一致することをアサートします。 🎜

🎜コマンド ラインの実行:🎜phpunit コマンド テスト ファイルの名前付け 🎜rrreee🎜 実行結果: 🎜rrreee🎜 app.log で確認できます。 code> file 出力したログ情報を表示します。 🎜

2. クラスファイルの紹介

🎜Calculator.php🎜rrreee🎜単体テストクラス: 🎜CalculatorTest.php🎜rrreee🎜 コマンド実行: 🎜rrreee🎜 実行結果: 🎜rrreee🎜ここに意図的にアサーションを入れた場合間違った書き方です。 $this->assertEquals(1, $obj->sum(0, 0));🎜実行結果を見てください: 🎜rrreee🎜 はメソッドのエラー メッセージを直接報告し、行番号はバグを素早く見つけるのに役立ちます🎜

3. 高度な使用法

🎜 各テスト メソッド名の前にテストを追加することにうんざりしていませんか?テストケースについて混乱していますか?私が今お勧めするお気に入りの高度な機能は、Frame Builder と呼ばれるものです。 🎜🎜Calculator.php🎜rrreee🎜コマンドラインからテストケースを開始し、キーワード--skeletonを使用します🎜rrreee🎜実行結果: 🎜rrreee🎜テストデータがないため非常に簡単ですか?なので、ここにテストデータを追加してから、上記のコマンドを再実行します🎜rrreee🎜元のクラスのすべてのメソッドが @assert アノテーションについてテストされます。これらは次のようなテストコードに変換されます 🎜rrreee🎜 実行結果: 🎜rrreee🎜🎜🎜🎜🎜🎜

以上がPHP単体テストフレームワークPHPUnitの使い方の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。