PHPUnit 在 Windows 下的配置及使用教程
由于我們項(xiàng)目涉及到php,因此需要對(duì)php代碼進(jìn)行單元測(cè)試。經(jīng)過一番了解,決定用PHPUnit來測(cè)試php。PHPUnit花了不少時(shí)間摸索如何配置PHPUnit,看官網(wǎng)的文檔也是一把淚。但知道怎么配置后,其實(shí)還是很簡(jiǎn)單的。
系統(tǒng):Windows 10 專業(yè)版
PHP版本:PHP 5.5.12
服務(wù)器工具:WAMPSERVER 2.5
PHPUnit版本:PHPUnit 4.8
一、配置PHPUnit
首先到PHPUnit官網(wǎng)(點(diǎn)此進(jìn)入)下載相應(yīng)的版本。我們使用的是php 5.5,于是選擇PHPUnit 4.8。得到 .phar
文件,并把名字改為 phpunit.phar
。
把該文件放到任意位置。以我自己為例,我把它放到我們項(xiàng)目的目錄下,即D:\repository\CourseManagement\mobile_api_test
。
右鍵 我的電腦 ,選擇 屬性 。點(diǎn)擊左側(cè)的 高級(jí)系統(tǒng)設(shè)置 。此時(shí)彈出 系統(tǒng)屬性 ,選擇 高級(jí) 選項(xiàng)卡,點(diǎn)擊右下角的 環(huán)境變量 。 在用戶變量里面,雙擊 PATH ,在 變量值 后面添加;D:\repository\CourseManagement\mobile_api_test
(注意最前面的分號(hào),路徑填存放phpunit.phar的路徑)。配置這個(gè)是為了在任意位置都能使用PHPUnit,不配置的話,需要在phpunit.phar的路徑下才能使用PHPUnit。
官方文檔里有一點(diǎn)沒有提到,就是php的環(huán)境變量也要設(shè)置。比如我的
php.exe
在E:\software\wamp\bin\php\php5.5.12
里,那么也要在 PATH 后面添加;E:\software\wamp\bin\php\php5.5.12
。PS:可能是因?yàn)槲覜]有安裝PHP的IDE,所以一直沒有配置它,偶然之間才想到可能要添加這個(gè)環(huán)境變量。
按快捷鍵 Win + R
,輸入cmd并回車。進(jìn)入存放phpunit.phar的路徑。輸入 echo @php "%~dp0phpunit.phar" %* > phpunit.cmd
并回車。接著輸入 phpunit --version
并回車。如果得到輸出 PHPUnit x.y.z by Sebastian Bergmann and contributors.
則表示配置好了(如果有誤,輸入exit
并回車,重新來一遍)。如下圖:
二、使用PHPUnit進(jìn)行測(cè)試
使用PHPUnit,必須使用 類 。以login.php為例(位置在D:\repository\CourseManagement\mobile_api
),我們的初始版本是這樣的(歡迎吐槽本博客內(nèi)的代碼):
- <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);
- }
- }
- >
這樣沒法測(cè)試,于是進(jìn)行一翻修改。首先在 login.php
所在文件夾里建立一個(gè)文件夾 classes
,并在里面新建 class_login.php
,內(nèi)容為 login.php
修改后的版本:
- <php
- class Login {
- // 測(cè)試工具PHPUnit要求一定要在這里給變量默認(rèn)值,于是默認(rèn)為空。
- 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);
- }
- }
- }
- }
- >
除此之外,也要修改原來那個(gè) login.php
的內(nèi)容,修改后如下:
- <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;
- >
開始寫測(cè)試文件
我把測(cè)試文件放在 D:\repository\CourseManagement\mobile_api_test
這個(gè)文件夾內(nèi)。新建一個(gè)文件 `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":"計(jì)算機(jī)","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);
- }
- }
- >
執(zhí)行測(cè)試文件
快捷鍵 Win + R ,輸入cmd并回車。進(jìn)入該測(cè)試文件的目錄,輸入 phpunit login_test.php
執(zhí)行測(cè)試。
簡(jiǎn)單的測(cè)試就完成了。
三、摸索過程
一開始下載PHPUnit,得到 .phar
文件,以為要解壓,囧。找了半天才發(fā)現(xiàn)有一個(gè)能夠解壓這種文件的網(wǎng)站(點(diǎn)此進(jìn)入)。然而并沒有什么用……
照著官方文檔來做,運(yùn)行時(shí)出現(xiàn)錯(cuò)誤:
‘php’ 不是內(nèi)部或外部命令,也不是可運(yùn)行的程序
或批處理文件。
Google搜索,必應(yīng)搜索,StackOverFlow搜索,百度搜索,搜到的答案都沒有用。
主要是因?yàn)樗麄兌寄J(rèn)你已經(jīng)配置好了PHP環(huán)境變量……
***想著是不是之前生成的 phpunit.cmd
有問題?于是查看一下這個(gè)文件的內(nèi)容。突然想到是不是PHP環(huán)境變量沒設(shè)置的原因?打開cmd,輸入 php --version
。得到:
‘php’ 不是內(nèi)部或外部命令,也不是可運(yùn)行的程序
或批處理文件。
和上面的錯(cuò)誤一樣!果然是這里的問題。于是把 ;E:\software\wamp\bin\php\php5.5.12
添加到環(huán)境變量中。再運(yùn)行 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
再進(jìn)入 phpunit.cmd
所在文件夾,運(yùn)行 phpunit --version
。得到:
PHPUnit 4.8.18 by Sebastian Bergmann and contributors.
問題解決!
經(jīng)過這次的探索,以后碰到”找不到xxx”這種問題的時(shí)候,首先會(huì)想起環(huán)境變量的設(shè)置。
比如解決這個(gè)問題的同一天下午,我想使用Visual Studio Code的Git功能,但是卻得到提示:
***個(gè)反應(yīng)是:我明明安裝了msysgit啊。
第二個(gè)反應(yīng)是:會(huì)不會(huì)是環(huán)境變量沒配置?打開環(huán)境變量配置,果然沒有。于是將 git.exe
所在文件夾的路徑添加進(jìn)去。重啟visual Studio Code,問題解決!