Basic use of PHP testing framework PHPUnit

1. Foreword

In this article, we use composer’s dependency package management tool to install and manage phpunit packages. Composer’s official address is https: //getcomposer.org/, just follow the prompts to install it globally. In addition, we will also use a very easy-to-use Monolog logging component to record logs for our convenience.

Create the configuration file of coomposer.json in the root directory and enter the following content:

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

The above means to load all the class files in the root directory and execute it on the command line After composer install, a vendor folder will be generated in the root directory. Any third-party code we install through composer in the future will be generated here.

2. Why unit testing?

Any time you think of typing something into a print statement or debug expression, replace it with a test. --Martin Fowler

PHPUnit is an open source software developed in the PHP programming language and is a unit testing framework. PHPUnit was created by Sebastian Bergmann, derived from Kent Beck's SUnit, and is one of the frameworks of the xUnit family.

Unit testing is the process of testing individual code objects, such as testing functions, classes, and methods. Unit testing can use any piece of test code that has been written, or you can use some existing testing frameworks, such as JUnit, PHPUnit or Cantata. The unit testing framework provides a series of common and useful functions to help people write automated detection units. , such as an assertion that checks whether an actual value matches the expected value. Unit testing frameworks often include reports for each test and give you the code coverage you have covered.

In a word, using phpunit for automatic testing will make your code more robust and reduce the cost of later maintenance. It is also a relatively standard specification. Today's popular PHP frameworks all come with unit testing. Such as Laraval, Symfony, Yii2, etc., unit testing has become standard.

In addition, unit test cases control the test script through commands instead of accessing the URL through the browser.

3. Install PHPUnit

Use composer method to install PHPUnit. For other installation methods, please see here

composer require --dev phpunit/phpunit ^6.2

Install Monolog log Package, used for phpunit testing and logging.

composer require monolog/monolog

After installation, we can see that the coomposer.json file already has these two expansion packages:

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

4. Simple usage of PHPUnit

1. Single file test

Create the directory tests, create a new file StackTest.php, edit it as follows:

<?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;
    }
}

Code explanation:

StackTest is a test class

StackTest inherits from PHPUnit\Framework\TestCase

The test method testPushAndPop(), the test method must have public permissions, usually starting with test, or you can choose Annotate it with @test to indicate

Within the test method, assertion methods similar to assertEquals() are used to assert that the actual value matches the expected value.

Command line execution:

phpunit command test file naming

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

Execution results:

➜  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)

We can view what we printed in the app.log file Log information.

2. Class file introduction

Calculator.php

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

Unit test class:

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));
    }
}

Command execution:

> ./vendor/bin/phpunit tests/CalculatorTest

Execution result:

PHPUnit 6.4.1 by Sebastian Bergmann and contributors.
F                                                                   1 / 1 (100%)
Time: 117 ms, Memory: 4.00MB
There was 1 failure:

If we deliberately write the assertion here wrong, $this->assertEquals(1, $obj->sum(0 , 0));

Look at the execution results:

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.

will directly report the method error message and line number, which helps us quickly find the bug

3. Advanced Usage

Are you tired of adding "test" in front of each test method name? Are you struggling to write multiple test cases because only the parameters of the call are different? My favorite advanced feature, which I now recommend to you, is called the Frame Builder.

Calculator.php

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

Command line to start the test case, use the keyword --skeleton

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

Execution result:

PHPUnit 6.4.1 by Sebastian Bergmann and contributors.
Wrote test class skeleton for Calculator to CalculatorTest.php.

Isn’t it very simple? Because there is no test data, add test data here, and then re-execute the above command

<?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;  
    }  
}  
?>

Every method in the original class is tested for the @assert annotation. These are converted into test code, like this

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

Execution results:

Copy after login

Recommended tutorial: "PHP Tutorial"

The above is the detailed content of Basic use of PHP testing framework PHPUnit. For more information, please follow other related articles on the PHP Chinese website!