PHPUnit 安装步骤与单元测试例子

由于我们项目涉及到php,因此需要对php代码进行单元测试。经过一番了解,决定用PHPUnit来测试php。PHPUnit花了不少时间摸索如何配置PHPUnit,看官网的文档也是一把泪。但知道怎么配置后,其实还是很简单的。

1、概述及配置
Laravel
中集成了PHPUnit进行单元测试,实际上,使用PHPUnit进行单元测试在Laravel中是开箱即用的,测试的配置文件为根目录下的phpunit.xml,该配置文件为我们做好了所有配置工作:

phpunit介绍

  • 系统:Windows 10 专业版
  • PHP版本:PHP 5.5.12
  • 服务器工具:WAMPSERVER 2.5
  • PHPUnit版本:PHPUnit 4.8

<?xml version=”1.0″ encoding=”UTF-8″?>
<phpunit backupGlobals=”false”
         backupStaticAttributes=”false”
         bootstrap=”bootstrap/autoload.php”
         colors=”true”
         convertErrorsToExceptions=”true”
         convertNoticesToExceptions=”true”
         convertWarningsToExceptions=”true”
         processIsolation=”false”
         stopOnFailure=”false”
         syntaxCheck=”false”>
    <testsuites>
        <testsuite name=”Application Test Suite”>
            <directory>./tests/</directory>
        </testsuite>
    </testsuites>
    <filter>
        <whitelist>
            <directory suffix=”.php”>app/</directory>
        </whitelist>
    </filter>
    <php>
        <env name=”APP_ENV” value=”testing”/>
        <env name=”CACHE_DRIVER” value=”array”/>
        <env name=”SESSION_DRIVER” value=”array”/>
        <env name=”QUEUE_DRIVER” value=”sync”/>
    </php>
</phpunit>
testsuites中定义了测试文件存放路径为根目录下的tests目录。

PHPUnit是一个面向PHP程序员的测试框架,这是一个xUnit的体系结构的单元测试框架。

一、配置PHPUnit

首先到PHPUnit官网(点此进入)下载相应的版本。我们使用的是php
5.5,于是选择PHPUnit
4.8。得到 .phar 文件,并把名字改为 phpunit.phar 。

把该文件放到任意位置。以我自己为例,我把它放到我们项目的目录下,即D:repositoryCourseManagementmobile_api_test 。

右键 我的电脑 ,选择 属性 。点击左侧的 高级系统设置 。此时弹出 系统属性 ,选择 高级 选项卡,点击右下角的 环境变量 。
在用户变量里面,双击 PATH ,在 变量值 后面添加;D:repositoryCourseManagementmobile_api_test (注意最前面的分号,路径填存放phpunit.phar的路径)。配置这个是为了在任意位置都能使用PHPUnit,不配置的话,需要在phpunit.phar的路径下才能使用PHPUnit。

官方文档里有一点没有提到,就是php的环境变量也要设置。比如我的 php.exe 在E:softwarewampbinphpphp5.5.12 里,那么也要在 PATH 后面添加;E:softwarewampbinphpphp5.5.12 。PS:可能是因为我没有安装PHP的IDE,所以一直没有配置它,偶然之间才想到可能要添加这个环境变量。

按快捷键 Win + R ,输入cmd并回车。进入存放phpunit.phar的路径。输入 echo @php "%~dp0phpunit.phar" %* > phpunit.cmd 并回车。接着输入 phpunit --version 并回车。如果得到输出 PHPUnit x.y.z by Sebastian Bergmann and contributors. 则表示配置好了(如果有误,输入exit 并回车,重新来一遍)。如下图:

图片 1

filter中定义了需要进行单元测试的PHP文件存放位置。

phpunit环境搭建

二、使用PHPUnit进行测试

使用PHPUnit,必须使用  。以login.php为例(位置在D:repositoryCourseManagementmobile_api ),我们的初始版本是这样的(欢迎吐槽本博客内的代码):

<?php

    error_reporting(0);

    $workNumber = $_POST["login-user"];
    $password = $_POST["login-password"];
    $tableName = $_POST["ident"];

    $con = mysqli_connect("localhost", "root", "", "teacher_class_system");
    if (!$con) {
        die('Could not connect: ' . mysql_error());
    } else {
        mysqli_query($con, "SET NAMES utf8");

        $result = mysqli_query($con, "SELECT * FROM $tableName where workNumber = $workNumber and password = $password");
        if (mysqli_num_rows($result) < 1) {
                echo "false";
        } else {
                $result_arr = mysqli_fetch_assoc($result);
                echo json_encode($result_arr, JSON_UNESCAPED_UNICODE);
        }
    }

    ?>

这样没法测试,于是进行一翻修改。首先在 login.php 所在文件夹里建立一个文件夹 classes,并在里面新建 class_login.php ,内容为 login.php 修改后的版本:

 <?php

    class Login {
        // 测试工具PHPUnit要求一定要在这里给变量默认值,于是默认为空。
        public function login($workNumber = "",$password = "",$tableName = "") {        
            $con = mysqli_connect("localhost", "root", "", "teacher_class_system");
            if (!$con) {
                die('Could not connect: ' . mysqli_error());
            } else {
                mysqli_query($con, "SET NAMES utf8");

                $result = mysqli_query($con, "SELECT * FROM $tableName where workNumber = $workNumber and password = $password");
                if (!$result || mysqli_num_rows($result) == 0) {
                    return "false";
                } else {
                    $result_arr = mysqli_fetch_assoc($result);
                    return json_encode($result_arr, JSON_UNESCAPED_UNICODE);
                }
            }
        }
    }

    ?>

除此之外,也要修改原来那个 login.php 的内容,修改后如下:

  <?php
    error_reporting(0);

    require_once './classes/class_login.php';

    $workNumber = $_POST["login-user"];
    $password = $_POST["login-password"];
    $tableName = $_POST["ident"];

    $log = new Login;
    $response = $log->login($workNumber,$password,$tableName);

    if($response != "false") {
        session_start();
        $_SESSION['id']=$tableName;
    }

    echo $response;

    ?>

开始写测试文件

我把测试文件放在 D:repositoryCourseManagementmobile_api_test 这个文件夹内。新建一个文件
`login_test.php’ ,并写入以下代码:

  <?php 
    require_once dirname(__FILE__).'/../mobile_api/classes/class_login.php';

    class LoginTest extends PHPUnit_Framework_TestCase {
        public function testLoginSuccess() {
            $expected = '{"workNumber":"00001","password":"00001","name":"西瓜","sex":"男","birthday":"20151201","department":"计算机","telephone":"110","email":"git@github.com"}';

            $workNumber = '00001';
            $password = '00001';
            $tableName = 'user_teacher';
            $lg = new Login;
            $actual = $lg->login($workNumber,$password,$tableName);

            $this->assertEquals($expected,$actual);
        }

        function testLoginFail() {
            $expected = 'false';

            $workNumber = '11111';
            $password = '11111';
            $tableName = 'user_teacher';

            $lg = new Login;
            $actual = $lg->login($workNumber,$password,$tableName);
            $this->assertEquals($expected,$actual);
        }
    }

    ?>

执行测试文件

快捷键 Win + R
,输入cmd并回车。进入该测试文件的目录,输入 phpunit login_test.php 执行测试。

图片 2

简单的测试就完成了。

php中配置了测试环境的环境变量,默认APP_ENV为testing,缓存驱动被设置为array,Session驱动被设置为array,队列驱动被设置为sync。

这里介绍两种搭建方法:

三、摸索过程

一开始下载PHPUnit,得到 .phar 文件,以为要解压,囧。找了半天才发现有一个能够解压这种文件的网站(点此进入)。然而并没有什么用……

照着官方文档来做,运行时出现错误:

‘php’ 不是内部或外部命令,也不是可运行的程序
或批处理文件。

Google搜索,必应搜索,StackOverFlow搜索,百度搜索,搜到的答案都没有用。

主要是因为他们都默认你已经配置好了PHP环境变量……

最后想着是不是之前生成的 phpunit.cmd 有问题?于是查看一下这个文件的内容。突然想到是不是PHP环境变量没设置的原因?打开cmd,输入 php --version 。得到:

‘php’ 不是内部或外部命令,也不是可运行的程序
或批处理文件。

和上面的错误一样!果然是这里的问题。于是把 ;E:softwarewampbinphpphp5.5.12 添加到环境变量中。再运行 php --version 得到:

PHP 5.5.12 (cli) (built: Apr 30 2014 11:20:58)
Copyright (c) 1997-2014 The PHP Group
Zend Engine v2.5.0, Copyright (c) 1998-2014 Zend Technologies
with Xdebug v2.2.5, Copyright (c) 2002-2014, by Derick Rethans

再进入 phpunit.cmd 所在文件夹,运行 phpunit --version。得到:

PHPUnit 4.8.18 by Sebastian Bergmann and contributors.

问题解决!

经过这次的探索,以后碰到”找不到xxx”这种问题的时候,首先会想起环境变量的设置。

比如解决这个问题的同一天下午,我想使用Visual Studio
Code的Git功能,但是却得到提示:

图片 3

第一个反应是:我明明安装了msysgit啊。

第二个反应是:会不会是环境变量没配置?打开环境变量配置,果然没有。于是将 git.exe 所在文件夹的路径添加进去。重启Visual
Studio Code,问题解决!

2、安装PHPUnit
使用Laravel的测试功能之前需要先安装PHPUnit,以Homestead虚拟机为例,安装步骤如下:

第一种:直接使用xampp,里面集成了phpunit

wget
https://phar.phpunit.de/phpunit.phar
chmod +x phpunit.phar
sudo mv phpunit.phar /usr/local/bin/phpunit
然后查看PHPUnit的版本验证是否安装成功:

地址:

phpunit –version
3、使用PHPUnit实现简单测试
接下来我们使用Laravel提供的ExampleTest.php实现简单单元测试,首先我们修改tests目录下的ExampleTest.php文件如下:

帮助:

<?php

第二种:

use IlluminateFoundationTestingWithoutMiddleware;
use IlluminateFoundationTestingDatabaseMigrations;
use IlluminateFoundationTestingDatabaseTransactions;

1、安装好php,并配置到系统环境变量path里

class ExampleTest extends TestCase
{
    /**
     * A basic functional test example.
     *
     * @return void
     */
    public function testBasicExample()
    {
        $this->visit(‘/’)
            ->see(‘Laravel学院’);
    }
}
其中visit方法用于访问指定路由页面,see方法则判断返回响应中是否包含指定字符串。

2、下载phpunit:

然后在routes.php中确保包含如下路由(如果没有的话添加该路由):

3、把phpunit.phar放到工程目录下

Route::get(‘/’,function(){
    return view(‘welcome’);
});
访问

4、cmd命令行,进入工程所在目录,运行命令:echo @php “%~dp0phpunit.phar”
%* > phpunit.cmd 可以看到生产了一个phpunit.cmd

Laravel学院测试应用首页

5、关闭之前打开的cmd,重新打开一个,然后输入phpunit –version,结果如下

然后到项目根目录下运行如下命令:

php开发工具

phpunit
输出结果如下:

比较专业的可以选择PhpStorm,只需简单配置即可使用,具体的方法大家自行google一下。由于我环境的限制,我这里就直接用notepad++来编写了。

图片 4

资料获取

表示测试通过。

后续涉及到的代码可以通过如下方式获取(代码会逐步发放,不要着急):

接下来我们修改ExampleTest.php测试方法如下:

点击链接加入群
522720170(共享里有):

public function testBasicExample()
{
    $this->visit(‘/’)
        ->see(‘LaravelAcademy’);
}
再次运行phpunit,则显示测试失败信息(部分截图):

 

图片 5

 

……

 

图片 6

测试结果会显示错误数目,错误位置及错误原因,方便我们快速定位错误并进行修复。

发表评论

电子邮件地址不会被公开。 必填项已用*标注