问题模拟 Laravel 可引导模型特征

Issue Mocking a Laravel Bootable Model Trait

我正在使用 bootable model trait 为使用我的特征的模型注册某些事件。但是,我 运行 遇到了一个问题,试图模拟使用该特征的模型。具体来说,当模型的 Mockery 版本被实例化时,它的启动代码同意它应该有一个 bootMyTrait 方法,但是当它试图调用它时找不到它。

Sample Repository 对于下面的,用命令来重现。

例如,这里有一个特征:

namespace App;
trait MyTrait
{
    public static function bootMyTrait()
    {
        print("Booting MyTrait\n");
    }
}

以及使用它的模型:

namespace App;
use Illuminate\Database\Eloquent\Model;
class MyModel extends Model
{
    use MyTrait;
}

定期实例化模型效果很好。这显示了所需的输出:

$model = new MyModel();

然而,试图模拟这个模型并不合作。这个:

use Illuminate\Foundation\Testing\WithoutMiddleware;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Illuminate\Foundation\Testing\DatabaseTransactions;


    class ExampleTest extends TestCase
    {
        /**
         * A basic functional test example.
         *
         * @return void
         */
        public function testTraitBooting()
        {
            $model = $this->getMock('App\MyModel');
        }
    }


Fails. Adding some debugging to Eloquent:


    /**
     * Boot all of the bootable traits on the model.
     *
     * @return void
     */
    protected static function bootTraits()
    {
        $class = static::class;

        foreach (class_uses_recursive($class) as $trait) {
            print("\nTesting that class: $class has method: " . $method = 'boot'.class_basename($trait) . " because of Trait: $trait\n");
            if (method_exists($class, $method = 'boot'.class_basename($trait))) {
                print("Class: $class has method: $method \n");
                try {
                    forward_static_call([$class, $method]);
                } catch (\PHPUnit_Framework_MockObject_BadMethodCallException $e) {
                    print("Class: $class failed calling $method\n");
                    throw $e;
                }
            }
        }
    }

给了我们这个失败:

PHPUnit 5.1.0 by Sebastian Bergmann and contributors.

E                                                                   1 / 1 (100%)
Testing that class: Mock_MyModel_9ee820db has method: bootMyTrait because of Trait: App\MyTrait
Class: Mock_MyModel_9ee820db has method: bootMyTrait
Class: Mock_MyModel_9ee820db failed calling bootMyTrait


Time: 129 ms, Memory: 18.00Mb

There was 1 error:

1) ExampleTest::testTraitBooting
PHPUnit_Framework_MockObject_BadMethodCallException:

mock-bootable-laravel-model-trait/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php:326
mock-bootable-laravel-model-trait/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php:309
mock-bootable-laravel-model-trait/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php:296
mock-bootable-laravel-model-trait/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php:277
mock-bootable-laravel-model-trait/tests/ExampleTest.php:16

我也尝试过用几种不同的方式创建模拟。以DatabaseSoftDeletingTraitTest为例:

use Illuminate\Foundation\Testing\WithoutMiddleware;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Illuminate\Foundation\Testing\DatabaseTransactions;
use Mockery as m;

class ExampleTest extends TestCase
{
    /**
     * A basic functional test example.
     *
     * @return void
     */
    public function testTraitBooting()
    {
        $mock = m::mock('App\MyModel');
        $mock->shouldReceive('bootMyTrait')->once();
    }
}

但在这里,bootMyTrait 从未被调用:

PHPUnit 5.1.0 by Sebastian Bergmann and contributors.

E                                                                   1 / 1 (100%)

Time: 149 ms, Memory: 19.25Mb

There was 1 error:

1) ExampleTest::testTraitBooting
Mockery\Exception\InvalidCountException: Method bootMyTrait() from Mockery_0_App_MyModel should be called
 exactly 1 times but called 0 times.

mock-bootable-laravel-model-trait/vendor/mockery/mockery/library/Mockery/CountValidator/Exact.php:37
mock-bootable-laravel-model-trait/vendor/mockery/mockery/library/Mockery/Expectation.php:271
mock-bootable-laravel-model-trait/vendor/mockery/mockery/library/Mockery/ExpectationDirector.php:120
mock-bootable-laravel-model-trait/vendor/mockery/mockery/library/Mockery/Container.php:297
mock-bootable-laravel-model-trait/vendor/mockery/mockery/library/Mockery/Container.php:282
mock-bootable-laravel-model-trait/vendor/mockery/mockery/library/Mockery.php:142
mock-bootable-laravel-model-trait/vendor/laravel/framework/src/Illuminate/Foundation/Testing/TestCase.php:122

因此,我可以将我在引导方法中执行的代码移动到 ServiceProvider,但随后我需要注册使用该特征的每个模型。这个感觉很脏,用boot方式好像也合适。所以我想我要么遇到了一个错误,要么错误地模拟了特征使用模型。我看过 getMockForTrait 但我还需要模拟实例来扩展 Eloquent (特征的一些方法调用 eloquent 方法)

如果有人看到我遗漏的东西(或者如果我完全以错误的方式接近它),非常感谢

经过一些测试,我相信这样的方法足以测试它:

$mock = m::mock('App\MyModel')->makePartial();
$mock->shouldReceive('bootMyTrait')->once();
$mock->__construct();

解释:

  1. $mock = m::mock('App\MyModel')->makePartial();

    我们创建了模拟,但我们将其设为部分,因为我们想使用默认的 class 构造函数和其他方法。使其成为部分意味着我们不覆盖的所有方法都将使用原始 App\MyModel class

  2. $mock->shouldReceive('bootMyTrait')->once();

    这应该很明显 - 我们要验证 bootMyTrait 方法是否 运行 恰好 1 次

  3. $mock->__construct();

    这样我们就可以运行 默认class 构造函数。创建 mock 时似乎没有使用构造函数,因此我们无法以其他方式对其进行测试。如果要确保启动原始 class 构造函数,我们需要手动启动对象构造函数方法。