PHPUnit在Windows下的配置及使用

因爲咱們項目涉及到php，所以須要對php代碼進行單元測試。通過一番瞭解，決定用PHPUnit來測試php。PHPUnit花了很多時間摸索如何配置PHPUnit，看官網的文檔也是一把淚。但知道怎麼配置後，其實仍是很簡單的。

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

1、配置PHPUnit

1. 首先到PHPUnit官網（點此進入）下載相應的版本。咱們使用的是php 5.5，因而選擇PHPUnit 4.8。獲得 .phar 文件，並把名字改成 phpunit.phar 。

2. 把該文件放到任意位置。以我本身爲例，我把它放到咱們項目的目錄下，即 D:\repository\CourseManagement\mobile_api_test 。

3. 右鍵 個人電腦 ，選擇 屬性 。點擊左側的 高級系統設置 。此時彈出 系統屬性 ，選擇 高級 選項卡，點擊右下角的 環境變量 。 在用戶變量裏面，雙擊 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，因此一直沒有配置它，偶然之間纔想到可能要添加這個環境變量。

4. 按快捷鍵 Win + R ，輸入cmd並回車。進入存放phpunit.phar的路徑。輸入 echo @php "%~dp0phpunit.phar" %* > phpunit.cmd 並回車。接着輸入 phpunit --version 並回車。若是獲得輸出 PHPUnit x.y.z by Sebastian Bergmann and contributors. 則表示配置好了（若是有誤，輸入 exit 並回車，從新來一遍）。以下圖：
   

2、使用PHPUnit進行測試

1. 使用PHPUnit，必須使用 類 。以login.php爲例（位置在 D:\repository\CourseManagement\mobile_api ），咱們的初始版本是這樣的（歡迎吐槽本博客內的代碼）：
   ```php
   <?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;
   
       ?>

2. 開始寫測試文件

   我把測試文件放在 D:\repository\CourseManagement\mobile_api_test 這個文件夾內。新建一個文件 `login_test.php' ，並寫入如下代碼：
   ```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);
        }
    }
   
    ?>

   ```

3. 執行測試文件

   快捷鍵 Win + R ，輸入cmd並回車。進入該測試文件的目錄，輸入 phpunit login_test.php 執行測試。

   簡單的測試就完成了。

3、摸索過程

• 一開始下載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，問題解決！