php單元測試進階(11)- 核心技術 - 樁件(stub) - 不使用樁件
本系列文章主要代碼與文字來源于《單元測試的藝術》,原作者:Roy Osherove。譯者:金迎。
本系列文章根據php的語法與使用習慣做了改編。所有代碼在本機測試通過。如轉載請注明出處。
上文介紹了通過創建一個局部的方法調用返回樁件,然后測試時用派生的子類來進行測試。
但是對于本文的示例來說,還有更簡單的辦法,不用樁件,也不用接口。
在被測類中,不是添加返回樁件的方法,而是添加直接返回計算結果的方法,然后在子類中覆蓋這個方法,以此來回避對文件系統等外部依賴的調用。
因為這個方法最簡單,所以可以優先考慮使用。
來對比一下上文的代碼:需要去除接口,去除測試類中的接口實現。保留文件管理器類,保留被測類。修改被測類子類,修改被測類。
上文是源代碼3個文件,測試代碼3個文件。
現在是源代碼2個文件,測試代碼2個文件。
下面是全部代碼:(所有的代碼都有改動)
源代碼
(1)t2\application\index\controller下文件管理器類,實現了上面的接口,但是實際被排除在單元測試之外,不測它。應該使用集成測試來測試此類。
FileExtensionManager.php
<?php
namespace app\index\controller;
/**
* 文件管理器類
*
*/
class FileExtensionManager
{
/**
* 根據某個配置文件的內容判斷文件名是否有效
* @param string $filename
*/
public function isValid($filename)
{
// 會使用file_get_contents函數讀取某個文件的內容
// 這里為了簡略不寫,因為不是重點。
return true;
}
}
(2)t2\application\index\controller下被測類,日志分析器。使用了調用直接返回計算結果的方式來寫代碼,便于派生類覆蓋,然后測試
LogAnalyzer.php
<?php
namespace app\index\controller;
/**
* 日志分析器類,也是被測類
*
* 注意,這是不用樁件和接口的例子。
*/
class LogAnalyzer
{
/**
* 判斷文件名是否有效,調用另一個類來實現
* @param string $filename
*/
public function isValidLogFileName($filename)
{
return $this->isValid($filename);
}
/**
* @param string $filename
* @return boolean
*/
protected function isValid($filename)
{
return (new FileExtensionManager())->isValid($filename);
}
}
測試代碼
(3)t2\tests\index\controller\下,被測試類的子類,用于覆蓋直接返回計算結果的方法,便于測試。因為這個子類測試專用,所以當然放在測試文件夾下。
LogAnalyzerExtend.php
<?php
namespace tests\index\controller;
/**
* 測試輔助類,是源代碼被測類的子類。用于覆蓋原被測類的方法,便于測試。
* 這里還允許外部注入屬性,以便于控制方法返回的結果。
*/
class LogAnalyzerExtend extends \app\index\controller\LogAnalyzer
{
/**
* @var boolean
*/
public $isSupported;
/**
* 覆蓋原方法,便于測試
* @return boolean
*/
protected function isValid($filename)
{
return $this->isSupported;
}
}
(4)t2\tests\index\controller\下,最后是測試類,但不是測試被測試類,而是測試被測試類的子類。和上文不同的是,覆蓋的是直接返回計算結果的方法。上文覆蓋返回產生樁件的方法。
LogAnalyzerTest.php
<?php
namespace tests\index\controller;
/**
* 測試用的類
*/
class LogAnalyzerTest extends \think\testing\TestCase
{
/**
* @test
* 使用覆蓋父類的直接返回計算結果的方法 進行測試
* 注意,盡量使得測試的方法名稱有意義,這非常重要,便于維護測試代碼。有規律
*/
public function isValidFileName_NameSupportedExtension_ReturnTrue()
{
//開始創建被測類的子類的對象,并注入控制的結果到字段里
$analyzer = new LogAnalyzerExtend();
$analyzer->isSupported = true;
//調用并斷言
$result = $analyzer->isValidLogFileName("short.ext");
$this->assertTrue($result);
}
}
cmd下測試通過。