README

AspectMock不是一个普通的PHP mocking框架。凭借面向切面编程（AOP）的力量和惊人的Go-AOP库，AspectMock允许你在PHP代码中几乎对任何事物进行stub和mock！

动机

PHP是一种并非为可测试性而设计的语言。真的。你如何伪造time()函数以在每个测试调用中产生相同的结果？有没有任何方法可以stub一个类的静态方法？你能在运行时重新定义一个类方法吗？像Ruby或JavaScript这样的动态语言允许我们这样做。这些特性对于测试至关重要。AspetMock来拯救！

每天都有数千行未测试的PHP代码被编写。在大多数情况下，这些代码实际上并不糟糕，但PHP没有提供测试它的功能。你可能建议从头开始重写它，遵循测试驱动设计实践，并在可能的情况下使用依赖注入。对于稳定的运行代码，这样做值得吗？好吧，有更好的浪费时间的方法。

使用AspectMock你可以对几乎任何OOP代码进行单元测试。PHP加上AOP结合了动态语言长期缺失的特性。没有理由不测试你的代码。你不必从头开始重写它以使其可测试。只需安装AspectMock与PHPUnit或Codeception，然后尝试编写一些测试。这真的，真的很简单！

功能

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

代码摘要

允许stub和mock静态方法。

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

<?php

function testTableName()
{
	$this->assertSame('users', UserModel::tableName());	
	$userModel = test::double('UserModel', ['tableName' => 'my_users']);
	$this->assertSame('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->assertSame('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->assertSame('jon', $user->getName());
	$user->save(['name' => 'miles']); // ActiveRecord->save did not hit database
	$AR->verifyInvoked('save');
	$this->assertSame('miles', $user->getName());
}

覆盖标准PHP函数

<?php

namespace demo;
test::func('demo', 'time', 'now');
$this->assertSame('now', time());

简洁之美

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

<?php

function testSimpleStubAndMock()
{
	$user = test::double(new User, ['getName' => 'davert']);
	$this->assertSame('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! AOP通过向每个方法调用引入切入点，允许拦截几乎任何方法调用。AspectMock是一个非常小巧的框架，仅由8个文件组成，利用Go! AOP框架的力量。查看面向方面开发以及Go!库本身。

要求

PHP 7.4.
Go! AOP 3.0

安装

1. 在你的composer.json中添加aspect-mock。

{
	"require-dev": {
		"codeception/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!库有很好的文档，所以这很容易做到。

致谢

关注@codeception获取更新。

由Michael Bodnarchuk开发。

许可证：MIT。

由Go! Aspect-Oriented Framework提供支持

vasilevit / aspect-mock

维护者

详细信息