如何用 phpunit 模拟 Laravel Eloquent 模型？

Question

我有一个基于 Illuminate\Database\Eloquent\Model 的 Laravel User 模型。

它在我要进行单元测试的服务中使用。这就是为什么我想模拟具有某些属性的User，在这种情况下，它是关于应该设置为23 的id。

我通过以下方式创建我的模拟：

/**
 * @param int $id
 * @return User|\PHPUnit\Framework\MockObject\MockObject
 */
protected function createMockUser(int $id): \PHPUnit\Framework\MockObject\MockObject|User
{
    $user = $this
        ->getMockBuilder(User::class)
        ->disableOriginalConstructor()
        ->getMock();
    $user->id = $id;

    return $user;
}

我也试过了：

$user->setAttribute('id', $id);

但在这两种情况下，模拟上的 id 属性将是 null。

如何在 Laravel 模型的 mock 上设置属性？

Answer 1

正如我在评论中所说，您不应该模拟用户。 Laravel 有多种工具可以解决这个问题，主要原因是您必须模拟不必要的长调用链，静态函数和部分模拟不适用于表命名和保存操作。 Laravel 有很好的测试文档，例如。 testing with a database，它回答了Laravel 中的大多数测试最佳实践。

---

这里有两种方法，您可以创建工厂来创建永远不会保存在数据库中的用户。对工厂调用 create() 会将其保存到数据库中，但调用 make() 会用数据填充模型而不是保存它。

class UserFactory extends Factory
{
    public function definition()
    {
        return [
            'name' => $this->faker->name(),
            'email' => $this->faker->unique()->safeEmail(),
        ];
    }
}

// id is normally set by database, set it to something.
$user = User::factory()->make(['id' => 42]);

---

取而代之的是单元测试和更多面向功能的测试。为了性能和测试环境中的易用性，默认使用 sqlite 会更容易。

添加以下内容。

config/database.php

'sqlite' => [
    'driver' => 'sqlite',
    'url' => env('DATABASE_URL'),
    'database' => ':memory:',
    'prefix' => '',
    'foreign_key_constraints' => env('DB_FOREIGN_KEYS', true),
],

phpunit.xml

<server name="DB_CONNECTION" value="sqlite"/>

在你的测试中使用这个特性。

use RefreshDatabase;

现在您应该可以使用以下内容了。这将提供一个完整的用户模型，其中包含您需要的所有功能。 sqlite 的唯一缺点是您使用的版本，不支持外键和奇怪的数据库特定功能。

public function test_your_service()
{
    $result = resolve(YourService::class)->saveUserData(User::factory()->create());

    // assert
}