PHPUnit 在 Windows 下的配置及使用教程

由於我們專案涉及到php，因此需要對php程式碼進行單元測試。經過一番瞭解，決定用PHPUnit來測試php。PHPUnit花了不少時間摸索如何配置PHPUnit，看官網的文件也是一把淚。但知道怎麼配置後，其實還是很簡單的。

• 系統：Windows 10 專業版
• PHP版本：PHP 5.5.12
• 伺服器工具：WAMPSERVER 2.5
• PHPUnit版本：PHPUnit 4.8

一、配置PHPUnit

首先到PHPUnit官網（點此進入）下載相應的版本。我們使用的是php 5.5，於是選擇PHPUnit 4.8。得到 .phar 檔案，並把名字改為 phpunit.phar 。

把該檔案放到任意位置。以我自己為例，我把它放到我們專案的目錄下，即D:\repository\CourseManagement\mobile_api_test 。

右鍵 我的電腦 ，選擇 屬性 。點選左側的 高階系統設定 。此時彈出 系統屬性 ，選擇 高階 選項卡，點選右下角的 環境變數 。 在使用者變數裡面，雙擊 PATH ，在 變數值 後面新增;D:\repository\CourseManagement\mobile_api_test （注意最前面的分號，路徑填存放phpunit.phar的路徑）。配置這個是為了在任意位置都能使用PHPUnit，不配置的話，需要在phpunit.phar的路徑下才能使用PHPUnit。

官方文件裡有一點沒有提到，就是php的環境變數也要設定。比如我的 php.exe 在E:\software\wamp\bin\php\php5.5.12 裡，那麼也要在 PATH 後面新增;E:\software\wamp\bin\php\php5.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 並回車，重新來一遍）。如下圖：

二、使用PHPUnit進行測試

使用PHPUnit，必須使用 類 。以login.php為例（位置在D:\repository\CourseManagement\mobile_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:\repository\CourseManagement\mobile_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 執行測試。

簡單的測試就完成了。

三、摸索過程

一開始下載PHPUnit，得到 .phar 檔案，以為要解壓，囧。找了半天才發現有一個能夠解壓這種檔案的網站（點此進入）。然而並沒有什麼用……

照著官方文件來做，執行時出現錯誤：

‘php’ 不是內部或外部命令，也不是可執行的程式
或批處理檔案。

Google搜尋，必應搜尋，StackOverFlow搜尋，百度搜尋，搜到的答案都沒有用。

主要是因為他們都預設你已經配置好了PHP環境變數……

最後想著是不是之前生成的 phpunit.cmd 有問題？於是檢視一下這個檔案的內容。突然想到是不是PHP環境變數沒設定的原因？開啟cmd，輸入 php --version 。得到：

‘php’ 不是內部或外部命令，也不是可執行的程式
或批處理檔案。

和上面的錯誤一樣！果然是這裡的問題。於是把 ;E:\software\wamp\bin\php\php5.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功能，但是卻得到提示：

第一個反應是：我明明安裝了msysgit啊。

第二個反應是：會不會是環境變數沒配置？開啟環境變數配置，果然沒有。於是將 git.exe 所在資料夾的路徑新增進去。重啟Visual Studio Code，問題解決！