fopen/fwrite 链的 PHPUnit 测试
PHPUnit Test for chain of fopen/fwrite
在一个项目中我发现了这样的代码行:
protected function save($content, $path)
{
// ...
if (($handler = @fopen($path, 'w')) === false) {
throw new Exception('...');
}
// ...
if (@fwrite($handler, $content) === false) {
throw new Exception('...');
}
// ...
@fclose($handler);
}
我想用 PHPUnit 测试这个方法,但我有点卡在正确的测试用例上。如果我将传递不正确的 $path
或具有不正确权限的正确 $path
(例如 0444
),那么一切都会在第一个异常处停止。如果我以正确的权限传递正确的 $path
,那么 PHP 也将能够写入文件,并且不会达到第二个异常。
那么有什么方法可以在不重写这个方法的情况下测试第二个异常呢?
或者最好在一种情况下同时检查 fopen
和 fwrite
并且两者只使用一个例外?
或者最好的办法是把这个方法一分为二,一个打开,一个写入,分别测试?
实现目标的最佳方法是使用模拟文件系统。我建议使用 vfsStream:
$ composer require mikey179/vfsStream
首先我要提到的是,fread 只有 returns false无效的论点。如果发生任何其他错误,它将 return 已写入的字节数。所以你必须添加另一张支票:
class SomeClass {
public function save($content, $path)
{
// ...
if (($handler = @fopen($path, 'w')) === false) {
throw new Exception('...');
}
$result = @fwrite($handler, $content);
// ...
if ($result === false) { // this will only happen when passing invalid arguments to fwrite
throw new Exception('...');
}
// ...
if ($result < strlen($content)) { // additional check if all bytes could have been written to disk
throw new Exception('...');
}
// ...
@fclose($handler);
}
}
该方法的测试用例可能如下所示:
class SomeClassTest extends \PHPUnit_Framework_TestCase {
/**
* @var vfsStreamDirectory
*/
private $fs_mock;
/**
* @var vfsStreamFile
*/
private $file_mock;
/**
* @var $sut System under test
*/
private $sut;
public function setUp() {
$this->fs_mock = vfsStream::setup();
$this->file_mock = new vfsStreamFile('filename.ext');
$this->fs_mock->addChild($this->file_mock);
$this->sut = new SomeClass();
}
public function testSaveThrowsExceptionOnMissingWritePermissionOnFile() {
$this->expectException(\Exception::class);
$this->file_mock->chmod(0);
$this->sut->save(
'content',
$this->file_mock->url()
);
}
public function testSaveThrowsExceptionOnMissingWritePermissionOnDirectory() {
$this->expectException(\Exception::class);
$this->fs_mock->chmod(0);
$this->sut->save(
'content',
$this->fs_mock->url().'/new_file.ext'
);
}
public function testSaveThrowsExceptionOnInvalidContentType() {
$this->expectException(\Exception::class);
$this->fs_mock->chmod(0);
$this->sut->save(
$this,
$this->file_mock->url()
);
}
public function testSaveThrowsExceptionOnDiskFull() {
$this->expectException(\Exception::class);
$this->fs_mock->chmod(0777); // to be sure
$this->file_mock->chmod(0777); // to be sure
vfsStream::setQuota(1); // set disk quota to 1 byte
$this->sut->save(
'content',
$this->file_mock->url()
);
}
}
希望能帮到你...
在一个项目中我发现了这样的代码行:
protected function save($content, $path)
{
// ...
if (($handler = @fopen($path, 'w')) === false) {
throw new Exception('...');
}
// ...
if (@fwrite($handler, $content) === false) {
throw new Exception('...');
}
// ...
@fclose($handler);
}
我想用 PHPUnit 测试这个方法,但我有点卡在正确的测试用例上。如果我将传递不正确的 $path
或具有不正确权限的正确 $path
(例如 0444
),那么一切都会在第一个异常处停止。如果我以正确的权限传递正确的 $path
,那么 PHP 也将能够写入文件,并且不会达到第二个异常。
那么有什么方法可以在不重写这个方法的情况下测试第二个异常呢?
或者最好在一种情况下同时检查 fopen
和 fwrite
并且两者只使用一个例外?
或者最好的办法是把这个方法一分为二,一个打开,一个写入,分别测试?
实现目标的最佳方法是使用模拟文件系统。我建议使用 vfsStream:
$ composer require mikey179/vfsStream
首先我要提到的是,fread 只有 returns false无效的论点。如果发生任何其他错误,它将 return 已写入的字节数。所以你必须添加另一张支票:
class SomeClass {
public function save($content, $path)
{
// ...
if (($handler = @fopen($path, 'w')) === false) {
throw new Exception('...');
}
$result = @fwrite($handler, $content);
// ...
if ($result === false) { // this will only happen when passing invalid arguments to fwrite
throw new Exception('...');
}
// ...
if ($result < strlen($content)) { // additional check if all bytes could have been written to disk
throw new Exception('...');
}
// ...
@fclose($handler);
}
}
该方法的测试用例可能如下所示:
class SomeClassTest extends \PHPUnit_Framework_TestCase {
/**
* @var vfsStreamDirectory
*/
private $fs_mock;
/**
* @var vfsStreamFile
*/
private $file_mock;
/**
* @var $sut System under test
*/
private $sut;
public function setUp() {
$this->fs_mock = vfsStream::setup();
$this->file_mock = new vfsStreamFile('filename.ext');
$this->fs_mock->addChild($this->file_mock);
$this->sut = new SomeClass();
}
public function testSaveThrowsExceptionOnMissingWritePermissionOnFile() {
$this->expectException(\Exception::class);
$this->file_mock->chmod(0);
$this->sut->save(
'content',
$this->file_mock->url()
);
}
public function testSaveThrowsExceptionOnMissingWritePermissionOnDirectory() {
$this->expectException(\Exception::class);
$this->fs_mock->chmod(0);
$this->sut->save(
'content',
$this->fs_mock->url().'/new_file.ext'
);
}
public function testSaveThrowsExceptionOnInvalidContentType() {
$this->expectException(\Exception::class);
$this->fs_mock->chmod(0);
$this->sut->save(
$this,
$this->file_mock->url()
);
}
public function testSaveThrowsExceptionOnDiskFull() {
$this->expectException(\Exception::class);
$this->fs_mock->chmod(0777); // to be sure
$this->file_mock->chmod(0777); // to be sure
vfsStream::setQuota(1); // set disk quota to 1 byte
$this->sut->save(
'content',
$this->file_mock->url()
);
}
}
希望能帮到你...