time-travel

python time libraries mocking

time-travel is the fun and easy way to unit-test time sensetive modules.

Can write determenistic test for long and even infinite time scenarios.

Usage

TimeTravel is context manager patching all time modules currently patched in a single line.

Examples

Skip timeouts

Tests are determenistic and take no time with time travel.

with TimeTravel():  
    assert time.time() == 0
    time.sleep(3600)
    assert time.time() == 3600    

with TimeTravel():
    assert datetime.today() == datetime.fromtimestamp(0)
    time.sleep(3600)
    assert datetime.today() == datetime.fromtimestamp(3600)

Patching event based modules

Can Patch and determine future events for event based modules using select:

with TimeTravel() as t:
    event = mock.MagicMock()
    t.events_pool.add_future_event(2, event, t.events_types.select.WRITE)
    assert select.select([], [event], []) == ([], [event], [])
    assert time.time() == 2

List of currently patched modules and functions

• time.time
• time.sleep
• datetime.datetime.today
• select.select

Add your own patches to time-travel

time-travel uses python "entry points" to add external patches to it.

Example

my_new_patcher.py:

from time_travel.patchers.basic_patcher import BasicPatcher

class MyNewPatcher(BasicPatcher):
    def __init__(self, *args, **kwargs):
        pass

To add the new patcher automatically to time-travel, only add the new class to the "time_travel.patchers" entry point in your setup.py:

from setuptools import setup

setup(
    name=...
    .
    .
    .
    entry_points={
        'time_travel.patchers' : [
            'my_new_patcher = my_new_patcher:MyNewPatcher',
        ],
    }
)