phpunit学习笔记2

上一章节已经介绍了phpunit的简单使用。 

        接下来我们讨论一个话题， 测试环境的搭建。 在编程语言中，有一个叫可重入函数的概念。 即任何时候，只要函数输入参数一样的时候，输出必定一样。  对于这些函数，使用上一节介绍的内容就足以使用phpunit做单元测试

          在实际过程中，有很多函数是依赖全局变量，数据库，第三方微服务提供数据来工作。 如果这些因素变化了，那么我们的测试用例代码，很可能就会出错。   为了保证我们测试用例（写的测试代码）的一致性（无论何时运行，都和第一次运行结果一致），我们需要在运行测试用例之前， 模拟出最初的环境。（即还原最早的全局变量环境，数据库环境，第三方微服务提供接口环境等）。这个还原就叫做基境建设。

         举一个依靠全局变量为例的例子。

         应用场景：

          接口1： 获取登录用户的信息。

          接口2： 退出登录。

          源码：user.php

   

<?php 
	class User{
		
		public function getUserInfo(){
			
			$userInfo=$_SESSION["userInfo"];
			if(!empty($userInfo)){
				return json_encode(array("result"=>0,"msg"=>"获取用户信息成功","userInfo"=>$userInfo));
			}else{
				return json_encode(array("result"=>1,"msg"=>"没有登录用户","userInfo"=>array()));
			}	
		}
		
		public function Logout(){
			
			$userInfo=$_SESSION["userInfo"];
			if(!empty($userInfo)){
				$_SESSION["userInfo"]="";
				return json_encode(array("result"=>0,"msg"=>"登出成功"));
			}else{
				return json_encode(array("result"=>1,"msg"=>"没有登录用户"));
			}	

			
			
		}
		
	
	}

   测试用例：userTest.php

<?php
	use PHPUnit\Framework\TestCase;
	require dirname(__DIR__)."/src/User.php";
	
	class userTest extends TestCase{
	
		/**
		@test
		*/
		public function getUserInfo(){
			$_SESSION["userInfo"]="marty";
			$instance=new User();
			$result=$instance->getUserInfo();
			$json=json_decode($result,true);
			$this->assertEquals($json["userInfo"],"marty");
			$_SESSION["userInfo"]="";
			$result=$instance->getUserInfo();
			$json=json_decode($result,true);
			$this->assertEquals($json["userInfo"],array());
		} 
		/**
		@test
		*/
		public function Logout(){
			$_SESSION["userInfo"]="marty";
			$instance=new User();
			$result=$instance->Logout();
			$json=json_decode($result,true);
			$this->assertEquals($json["result"],0);
			$_SESSION["userInfo"]="";
			$result=$instance->Logout();
			$json=json_decode($result,true);
			$this->assertEquals($json["result"],1);
			
		}
		
	}

其中：函数开头设置了 $_SESSION[" userInfo"]="marty"。就是在设置全局变量。 其他的就和上节介绍的内容一致了。

在phpunit中，提供了一个共用的方法来设置基境。

以下内容摘抄与http://www.phpunit.cn/manual/current/zh_cn/fixtures.html#fixtures.more-setup-than-teardown

PHPUnit 支持共享建立基境的代码。在运行某个测试方法前，会调用一个名叫 setUp() 的模板方法。setUp() 是创建测试所用对象的地方。当测试方法运行结束后，不管是成功还是失败，都会调用另外一个名叫 tearDown() 的模板方法。tearDown() 是清理测试所用对象的地方。

修改一

<?php
	use PHPUnit\Framework\TestCase;
	require dirname(__DIR__)."/src/User.php";
	
	class userTest extends TestCase{
		
		protected function setUp(){
			$_SESSION["userInfo"]="marty";
		}
		/**
		@test
		*/
		public function getUserInfo(){
			//$_SESSION["userInfo"]="marty";
			$instance=new User();
			$result=$instance->getUserInfo();
			$json=json_decode($result,true);
			$this->assertEquals($json["userInfo"],"marty");
			$_SESSION["userInfo"]="";
			$result=$instance->getUserInfo();
			$json=json_decode($result,true);
			$this->assertEquals($json["userInfo"],array());
		} 
		/**
		@test
		*/
		public function Logout(){
			//$_SESSION["userInfo"]="marty";
			$instance=new User();
			$result=$instance->Logout();
			$json=json_decode($result,true);
			$this->assertEquals($json["result"],0);
			$_SESSION["userInfo"]="";
			$result=$instance->Logout();
			$json=json_decode($result,true);
			$this->assertEquals($json["result"],1);
			
		}
		
	}

设置基境，可以在setUp函数中，统一设置。

修改二  代码如下：

<?php
	use PHPUnit\Framework\TestCase;
	require dirname(__DIR__)."/src/User.php";
	
	class userTest extends TestCase{
		
		protected function setUp(){
			$_SESSION["userInfo"]="marty";
		}
		/**
		@test
		*/
		public function getUserInfo(){
			//$_SESSION["userInfo"]="marty";
			$instance=new User();
			$result=$instance->getUserInfo();
			$json=json_decode($result,true);
			$this->assertEquals($json["userInfo"],"marty");
			$_SESSION["userInfo"]="";
			$result=$instance->getUserInfo();
			$json=json_decode($result,true);
			$this->assertEquals($json["userInfo"],array());
			$_SESSION["userInfo"]="";
		} 
		/**
		@test
		*/
		public function Logout(){
			//$_SESSION["userInfo"]="marty";
			$instance=new User();
			$result=$instance->Logout();
			$json=json_decode($result,true);
			$this->assertEquals($json["result"],0);
			$_SESSION["userInfo"]="";
			$result=$instance->Logout();
			$json=json_decode($result,true);
			$this->assertEquals($json["result"],1);
			
		}
		
	}

注意红色部分。 在测试函数的最后一行中，我们修改了 $_SESSION["userInfo"]=“”。相等于登录出去，这个时候，Logout测试是否为失败呢？   答案是否定，测试依然成功。 这是因为，所有测试函数执行之前都会执行 setUp，会重新设置userInfo的信息。 

修改三：

<?php
	use PHPUnit\Framework\TestCase;
	require dirname(__DIR__)."/src/User.php";
	
	class userTest extends TestCase{
		
		public static function setUpBeforeClass(){
			$_SESSION["userInfo"]="marty";
		}
		/**
		@test
		*/
		public function getUserInfo(){
			//$_SESSION["userInfo"]="marty";
			$instance=new User();
			$result=$instance->getUserInfo();
			$json=json_decode($result,true);
			$this->assertEquals($json["userInfo"],"marty");
			$_SESSION["userInfo"]="";
			$result=$instance->getUserInfo();
			$json=json_decode($result,true);
			$this->assertEquals($json["userInfo"],array());
			$_SESSION["userInfo"]="";
		} 
		/**
		@test
		*/
		public function Logout(){
			//$_SESSION["userInfo"]="marty";
			$instance=new User();
			$result=$instance->Logout();
			$json=json_decode($result,true);
			$this->assertEquals($json["result"],0);
			$_SESSION["userInfo"]="";
			$result=$instance->Logout();
			$json=json_decode($result,true);
			$this->assertEquals($json["result"],1);
			
		}
		
	}

将setUp 替换为了setUpBeforeClass，这个时候，执行成功吗？  

执行不成功。 因为setUpBeforeClass 只会在测试类开始时候执行一次， 那么在Logout的时候$_SESSION["userInfo"]="",所以执行是不成功的。

修改四：

<?php
	use PHPUnit\Framework\TestCase;
	require dirname(__DIR__)."/src/User.php";
	
	class userTest extends TestCase{
		/**
	        @backupGlobals enabled
                 */
		public static function setUpBeforeClass(){
			$_SESSION["userInfo"]="marty";
		}
		/**
		@test
		*/
		public function getUserInfo(){
			//$_SESSION["userInfo"]="marty";
			$instance=new User();
			$result=$instance->getUserInfo();
			$json=json_decode($result,true);
			$this->assertEquals($json["userInfo"],"marty");
			$_SESSION["userInfo"]="";
			$result=$instance->getUserInfo();
			$json=json_decode($result,true);
			$this->assertEquals($json["userInfo"],array());
			$_SESSION["userInfo"]="";
		} 
		/**
		@test
		*/
		public function Logout(){
			//$_SESSION["userInfo"]="marty";
			$instance=new User();
			$result=$instance->Logout();
			$json=json_decode($result,true);
			$this->assertEquals($json["result"],0);
			$_SESSION["userInfo"]="";
			$result=$instance->Logout();
			$json=json_decode($result,true);
			$this->assertEquals($json["result"],1);
			
		}
		
	}

修改后，Logout会执行成功吗？  

答案是会。  因为注释   @backupGlobals enabled 用于表示全局变量备份，虽然在getUserInfo函数中对$_SESSION["userInfo"]修改了。不过在Logout中，依然会还原$_SESSION["userInfo"]的值。

总结：
1. 在一些测试时候，我们需要建立测试基境，举例说明如何设置依靠全局变量的基境。
2. 对于统一的设置，我们可以使用setUp函数来设置,也可以用setUpBeforeClass来设置。 区别为setUp每个函数测试之前都会调用
3. 可以使用@backupGlobals enabled 来设置全局变量是否保存。 

今天内容可以参考phpunit手册http://www.phpunit.cn/manual/current/zh_cn/fixtures.html#fixtures.global-state的第四章节