模拟单元测试的 default=timezone.now

Question

我正在尝试为执行大量日期时间操作的 django 应用程序编写单元测试。我已经为我的测试安装了mock 到猴子补丁 django 的timezone.now。

虽然我能够在正常调用timezone.now 时成功模拟它（实际上在我的代码中调用timezone.now()，但我无法模拟使用DateTimeField 和default=timezone.now 创建的模型。

---

我有一个 User 模型，其中包含以下内容：

from django.utils import timezone
...
timestamp = models.DateTimeField(default=timezone.now)
modified = models.DateTimeField(default=timezone.now)
...
def save(self, *args, **kwargs):
    if kwargs.pop('modified', True):
        self.modified = timezone.now()
    super(User, self).save(*args, **kwargs)

---

我的单元测试如下所示：

from django.utils import timezone

def test_created(self):
    dt = datetime(2010, 1, 1, tzinfo=timezone.utc)
    with patch.object(timezone, 'now', return_value=dt):
        user = User.objects.create(username='test')
        self.assertEquals(user.modified, dt)
        self.assertEquals(user.timestamp, dt)

---

assertEquals(user.modified, dt) 通过，但 assertEquals(user.timestamp, dt) 不通过。

我如何模拟 timezone.now 以便即使在我的模型中的 default=timezone.now 也会创建模拟时间？

---

编辑

我知道我可以更改我的单元测试以通过我选择的timestamp（可能由模拟的timezone.now 生成）...很好奇是否有办法避免这种情况。

Answer 1

还有另一种简单的方法可以完成上述操作。

import myapp.models.timezone
from unittest.mock import patch

@patch('django.utils.timezone.now')
def test_created(self, mock_timezone):
    dt = datetime(2010, 1, 1, tzinfo=timezone.utc)
    mock_timezone.return_value = dt
    user = User.objects.create(username='test')

    self.assertEquals(user.modified, dt)
    self.assertEquals(user.timestamp, dt)

这是模拟 timezone.now 的最佳方式。

Answer 2

这是一种无需更改非测试代码即可使用的方法。只需修补您想要影响的字段的default 属性。比如——

field = User._meta.get_field('timestamp')
mock_now = lambda: datetime(2010, 1, 1)
with patch.object(field, 'default', new=mock_now):
    # Your code here

您可以编写辅助函数来减少冗长。比如下面的代码--

@contextmanager
def patch_field(cls, field_name, dt):
    field = cls._meta.get_field(field_name)
    mock_now = lambda: dt
    with patch.object(field, 'default', new=mock_now):
        yield

会让你写——

with patch_field(User, 'timestamp', dt):
    # Your code here

同样，您可以编写帮助上下文管理器来一次修补多个字段。

Answer 3

我自己也遇到了这个问题。问题是模型是在 mock 修补 timezone 模块之前加载的，所以在计算表达式 default=timezone.now 时，它将 default kwarg 设置为真正的 timezone.now 函数。

解决方法如下：

class MyModel(models.Model):
    timestamp = models.DateTimeField(default=lambda: timezone.now())

Answer 4

看起来您正在修补wrong place. 中的时区

假设您的 User 模型位于 myapp\models.py 中，并且您想在该文件中测试 save()。问题是当你在顶部from django.utils import timezone 时，它会从django.utils 导入它。在您的测试中，您正在本地修补timezone，它对您的测试没有影响，因为模块myapp\models.py 已经引用了真正的timezone，看起来我们的修补没有效果。

尝试从myapp\models.py 修补timezone，类似于：

import myapp.models.timezone

def test_created(self):
    with patch('myapp.models.timezone') as mock_timezone:
        dt = datetime(2010, 1, 1, tzinfo=timezone.utc)
        mock_timezone.now.return_value = dt

        assert myapp.models.timezone.now() == dt

        user = User.objects.create(username='test')
        self.assertEquals(user.modified, dt)
        self.assertEquals(user.timestamp, dt)