如何在不添加参数的情况下对基于时间的函数进行单元测试答案

【问题标题】：How to unit test time based functions without adding parameters如何在不添加参数的情况下对基于时间的函数进行单元测试
【发布时间】：2018-11-12 14:29:03
【问题描述】：

我创建了一个函数，它返回距离下一次出现该时间还剩几秒的时间，但我遇到了为它编写单元测试的问题。人们如何测试这种调用 datetime.now() 的函数？

添加另一个参数 (current_time) 只是为了测试它似乎是错误的，因为它改变了函数的初始要求。

要测试的函数是。

from datetime import datetime, time, timedelta

def get_time_left(target_time):
    '''return float of number of seconds left until the target_time'''

    if not isinstance( target_time, time ):
        raise TypeError("target_time must be datetime.time")

    curr_time = datetime.now()
    target_datetime = datetime.combine( datetime.today(), target_time )
    if curr_time > target_datetime:
        target_datetime = curr_time + timedelta(1)

    seconds_left = (curr_time - target_datetime).total_seconds()

    return seconds_left

对它的测试是。

class TestDTime(unittest.TestCase):

    def test_time_left(self):
        dt_now = datetime.now()
        tm_5sec_future = ( dt_now + timedelta(0,5) ).time()
        self.assertEqual( dtime.get_time_left(tm_5sec_future), 5.0)

结果是。

======================================================================
FAIL: test_time_left (__main__.TestDTime)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "tests/ctatest.py", line 37, in test_time_left
    self.assertEqual( dtime.get_time_left(tm_5sec_future), 5.0)
AssertionError: -4.999985 != 5.0

在不向函数添加任何参数的情况下对此类内容进行单元测试的最佳方法是什么？

【问题讨论】：

标签： python unit-testing datetime mocking assert

【解决方案1】：

您需要使用模拟框架将您的 UT 与依赖项隔离开来，以便您的 UT 具有一致性行为。

Freezegun - 是我使用过的一个很好的模拟库。

只需安装这个库：pip install freezegun

在你的 UT 中使用了装饰器 @freeze_time，如下所示：

@freeze_time("2018-06-03") 
def test_time_left(self):
    dt_now = datetime.now()
    tm_5sec_future = (dt_now + timedelta(0, 5)).time()
    self.assertEqual(dtime.get_time_left(tm_5sec_future), -5.0)

【讨论】：