README

AspectMock不是一个普通的PHP mocking框架。凭借面向方面编程和强大的Go-AOP库，AspectMock允许您在PHP代码中几乎对任何事物进行stub和mock！

动机

PHP是一种不适合测试的语言。真的。你该如何伪造time()函数以在每次测试调用时产生相同的结果？能否对类的静态方法进行stub？能否在运行时重新定义类方法？像Ruby或JavaScript这样的动态语言允许我们这样做。这些功能对于测试至关重要。AspectMock来拯救！

每天都会在PHP中编写数以千计的未测试代码。在大多数情况下，这些代码并不真正糟糕，但PHP不提供测试它们的能力。你可能建议从头开始重写它，并尽可能使用依赖注入，按照测试驱动设计实践。对于稳定工作的代码，这样做是否应该这样做？好吧，有更好的浪费时间的方法。

使用AspectMock，您可以几乎对任何OOP代码进行单元测试。PHP加上AOP结合了我们已经很久缺少的动态语言的功能。没有不测试你代码的借口。你不必从零开始重写它来使其可测试。只需安装AspectMock与PHPUnit或Codeception，并尝试编写一些测试。这真的，真的很简单！

特性

为静态方法创建测试双倍。
为任何地方调用的类方法创建测试双倍。
动态重新定义方法。
简单的语法，易于记忆。

代码要点

允许stub和mock静态方法。

让我们重新定义静态方法并在运行时验证它们的调用。

<?php
function testTableName()
{
	$this->assertEquals('users', UserModel::tableName());	
	$userModel = test::double('UserModel', ['tableName' => 'my_users']);
	$this->assertEquals('my_users', UserModel::tableName());
	$userModel->verifyInvoked('tableName');	
}
?>

允许替换类方法。

测试使用ActiveRecord模式的代码。ActiveRecord模式的使用听起来像是一种不良做法吗？不。但下面的代码在经典单元测试中是不可测试的。

<?php
class UserService {
    function createUserByName($name) {
    	$user = new User;
    	$user->setName($name);
    	$user->save();
    }
}
?>

没有AspectMock，你需要将User引入到UserService类中作为显式依赖项，以便对其进行测试。但让我们保持代码原样。它工作。尽管如此，我们仍然应该测试它，以避免回归。

我们不希望$user->save方法真正执行，因为它将击中数据库。相反，我们将用模拟代替它，并验证它是否通过createUserByName被调用。

<?php
function testUserCreate()
{
	$user = test::double('User', ['save' => null]));
	$service = new UserService;
	$service->createUserByName('davert');
	$this->assertEquals('davert', $user->getName());
	$user->verifyInvoked('save');
}
?>

拦截父类方法和魔术方法

<?php
// User extends ActiveRecord
function testUserCreate()
{
	$AR = test::double('ActiveRecord', ['save' => null]));
	test::double('User', ['findByNameAndEmail' => new User(['name' => 'jon'])])); 
	$user = User::findByNameAndEmail('jon','jon@coltrane.com'); // magic method
	$this->assertEquals('jon', $user->getName());
	$user->save(['name' => 'miles']); // ActiveRecord->save did not hit database
	$AR->verifyInvoked('save');
	$this->assertEquals('miles', $user->getName());
}
?>

覆盖甚至标准PHP函数

<?php
namespace demo;
test::func('demo', 'time', 'now');
$this->assertEquals('now', time());

简单到令人惊叹

仅需要4个方法来验证方法调用和一个方法来定义测试双倍

<?php
function testSimpleStubAndMock()
{	
	$user = test::double(new User, ['getName' => 'davert']);
	$this->assertEquals('davert', $user->getName());
	$user->verifyInvoked('getName');
	$user->verifyInvokedOnce('getName');
	$user->verifyNeverInvoked('setName');
	$user->verifyInvokedMultipleTimes('setName',1);
}
?>

检查方法setName是否以davert作为参数被调用。

<?php
$user->verifyMethodInvoked('setName', ['davert']);
?>

哇！但是它是如何工作的？

不需要PECL扩展。Go! AOP库通过动态修补自动加载的PHP类来完成重负载工作。通过引入对每个方法调用的切入点，Go!允许拦截几乎所有方法调用。AspectMock是一个非常小巧的框架，仅由8个文件组成，利用了Go! AOP框架的力量。查看面向切面编程和Go!库本身。

需求

PHP >= 5.6 + Go! AOP需求

安装

1. 将aspect-mock添加到您的composer.json中。

{
	"require-dev": {
		"adgoal/aspect-mock": "*"
	}
}

2. 将AspectMock与Go! AOP作为依赖项安装。

php composer.phar update

配置

将AspectMock\Kernel类包含到您的测试启动文件中。

使用Composer的自动加载器

<?php
include __DIR__.'/../vendor/autoload.php'; // composer autoload

$kernel = \AspectMock\Kernel::getInstance();
$kernel->init([
    'debug' => true,
    'includePaths' => [__DIR__.'/../src']
]);
?>

如果您的项目使用Composer的自动加载器，那么这就是您开始所需的全部。

使用自定义自动加载器

如果您使用自定义自动加载器（如Yii/Yii2框架中），您应明确指向AspectMock以修改它

<?php
include __DIR__.'/../vendor/autoload.php'; // composer autoload

$kernel = \AspectMock\Kernel::getInstance();
$kernel->init([
    'debug' => true,
    'includePaths' => [__DIR__.'/../src']
]);
$kernel->loadFile('YourAutoloader.php'); // path to your autoloader
?>

以这种方式加载您项目的所有自动加载器，如果您完全不依赖Composer。

无自动加载器

如果它仍然不起作用...

在测试之前显式加载所有必需的文件

<?php
include __DIR__.'/../vendor/autoload.php'; // composer autoload

$kernel = \AspectMock\Kernel::getInstance();
$kernel->init([
    'debug' => true,
    'includePaths' => [__DIR__.'/../src']
]);
require 'YourAutoloader.php';
$kernel->loadPhpFiles('/../common');
?>

自定义

有一些选项可以自定义AspectMock。它们都在Go!框架中定义。如果您仍然没有在项目中运行AspectMock，它们可能会有所帮助。

appDir定义了正在测试的Web应用程序的根目录。所有根目录外的类都将被AspectMock生成的代理替换。默认情况下，这是位于Composer的vendor目录的目录。如果您不使用Composer或您有自定义的Composer的vendor文件夹路径，您应指定appDir
cacheDir是一个存储更新源PHP文件的目录。如果未设置此目录，则代理类将在每次运行时构建。否则，所有用于测试的PHP文件都将使用方面注入进行更新并存储到cacheDir路径。
includePaths是包含应由Go Aop增强的文件的目录。应指向您的应用程序源文件以及框架文件和您使用的任何库。
excludePaths不应受方面影响的PHP文件路径。您应该排除测试文件以防止拦截。

示例

<?php
$kernel = \AspectMock\Kernel::getInstance();
$kernel->init([
    'appDir'    => __DIR__ . '/../../',
    'cacheDir'  => '/tmp/myapp',
    'includePaths' => [__DIR__.'/../src']
    'excludePaths' => [__DIR__] // tests dir should be excluded
]);
?>

针对不同框架的更多配置.

正确配置AspectMock非常重要。否则，它可能无法按预期工作或产生副作用。请确保您包含了所有需要模拟的文件，但您的测试文件以及测试框架应被排除。

在PHPUnit中的使用

在您的phpunit.xml配置中使用新创建的bootstrap。同时禁用backupGlobals

<phpunit bootstrap="bootstrap.php" backupGlobals="false">

在测试之间清除测试双注册表。

<?php
use AspectMock\Test as test;

class UserTest extends \PHPUnit_Framework_TestCase
{
    protected function tearDown()
    {
        test::clean(); // remove all registered test doubles
    }

    public function testDoubleClass()
    {
        $user = test::double('demo\UserModel', ['save' => null]);
        \demo\UserModel::tableName();
        \demo\UserModel::tableName();
        $user->verifyInvokedMultipleTimes('tableName',2);
    }

?>

在Codeception中的使用

将AspectMock\Kernel包含到tests/_bootstrap.php中。我们建议从您的CodeHelper类中调用test::clean()

<?php
namespace Codeception\Module;

class CodeHelper extends \Codeception\Module
{
	function _after(\Codeception\TestCase $test)
	{
		\AspectMock\Test::clean();
	}
}
?>

改进？

肯定有改进的空间。这个框架并不是为了做你可能会需要的每一件事而设计的（见以下注释）。但如果你觉得你需要一个功能，请提交一个Pull Request。由于代码不多，并且Go!库有很好的文档，所以这很容易。

致谢

关注@adgoal以获取更新。

由Michael Bodnarchuk开发。

许可证：MIT。

由Go! 面向切面框架提供支持

adgoal / aspect-mock

维护者

详细信息