PHP 단위 테스트 프레임워크 PHPUnit을 사용하는 방법

예전에 IOS 개발을 배울 때 Objective-C에서 유닛 테스트에 대한 글을 쓴 적이 있습니다. 오늘은 PHP에서 유닛 테스트를 활용하는 방법을 정리해 보겠습니다.

1. 서문

이 글에서는 phpunit 패키지를 설치하고 관리하기 위해 composer의 종속성 패키지 관리 도구를 사용합니다. / 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

위는 루트 디렉터리에 있는 모든 클래스 파일을 로드한다는 의미입니다. 명령줄에서 composer install을 실행하면 vendor 폴더가 루트 디렉터리에 생성됩니다. 향후 타사 코드가 여기에서 생성됩니다.

2. 왜 단위 테스트를 하는가?

인쇄 문이나 디버그 표현식에 무언가를 입력해야 한다는 생각이 들 때마다 이를 테스트로 바꾸세요. --Martin Fowler

PHPUnit은 PHP 프로그래밍 언어로 개발된 오픈 소스 소프트웨어이자 단위 테스트 프레임워크입니다. PHPUnit은 Kent Beck의 SUnit에서 파생된 Sebastian Bergmann에 의해 만들어졌으며 xUnit 제품군의 프레임워크 중 하나입니다.

단위 테스트는 함수, 클래스, 메서드 테스트와 같은 개별 코드 개체를 테스트하는 프로세스입니다. 단위 테스트는 작성된 모든 테스트 코드를 사용할 수 있으며 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 파일에 이미 두 개의 확장팩이 있음을 확인할 수 있습니다: 🎜

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

🎜Four. PHPUnit의 간단한 사용법🎜

1. >🎜tests 디렉터리를 만들고, 새 파일 StackTest.php를 만든 후 다음과 같이 편집하세요. 🎜

로그인 후 복사

🎜코드 설명: 🎜

🎜StackTest는 테스트 클래스입니다🎜

🎜StackTest는 PHPUnitFrameworkTestCase🎜

🎜test에서 상속됩니다. methodtestPushAndPop() , 테스트 메서드에는 일반적으로 test로 시작하는 public 권한이 있어야 합니다. 그렇지 않으면 로 주석을 달도록 선택할 수 있습니다. @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. 고급 사용법

🎜각 테스트 메소드 이름 앞에 테스트를 추가하는 것이 지겹나요? 단지 호출의 매개변수 때문에 너무 많이 작성해야 합니까? 테스트 케이스가 헷갈리나요? 제가 지금 여러분에게 추천하는 가장 좋아하는 고급 기능은 프레임 빌더입니다. 🎜🎜Calculator.php🎜rrreee🎜명령줄에서 테스트 케이스를 시작하고 --skeleton 키워드를 사용하세요.🎜rrreee🎜실행 결과: 🎜rrreee🎜테스트 데이터가 없기 때문에 매우 간단합니까? , 여기에 테스트 데이터를 추가한 다음 위 명령을 다시 실행하세요🎜rrreee🎜원본 클래스의 모든 메서드는 @assert 주석에 대해 테스트됩니다. 이는 다음과 같이 테스트 코드로 변환됩니다. 🎜rrreee🎜실행 결과: 🎜rrreee🎜🎜🎜🎜🎜🎜

위 내용은 PHP 단위 테스트 프레임워크 PHPUnit을 사용하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!