PHPUnit在Windows下的配置及使用

时间：2021-11-05 06:51:04

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

系统：Windows 10 专业版

PHP版本：PHP 5.5.12

服务器工具：WAMPSERVER 2.5

PHPUnit版本：PHPUnit 4.8

一、配置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，所以一直没有配置它，偶然之间才想到可能要添加这个环境变量。

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

    PHPUnit在Windows下的配置及使用

二、使用PHPUnit进行测试

  1. 使用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;

	?>

  2. 开始写测试文件

    我把测试文件放在 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);
    
		}
    
	}

	?>

  3. 执行测试文件

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

    PHPUnit在Windows下的配置及使用

    简单的测试就完成了。

三、摸索过程

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

  • 照着官方文档来做，运行时出现错误：

    'php' 不是内部或外部命令，也不是可运行的程序

    或批处理文件。

  • Google搜索，必应搜索，*搜索，百度搜索，搜到的答案都没有用。

    主要是因为他们都默认你已经配置好了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功能，但是却得到提示：

    PHPUnit在Windows下的配置及使用

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

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

相关文章