test_time_machine.py

from __future__ import annotations

import asyncio
import datetime as dt
import os
import subprocess
import sys
import time
import typing
import uuid
from contextlib import contextmanager
from importlib.util import module_from_spec, spec_from_file_location
from textwrap import dedent
from unittest import SkipTest, TestCase, mock
from zoneinfo import ZoneInfo

import freezegun
import pytest
from dateutil import tz

import time_machine

NANOSECONDS_PER_SECOND = time_machine.NANOSECONDS_PER_SECOND
EPOCH_DATETIME = dt.datetime(1970, 1, 1, tzinfo=dt.timezone.utc)
EPOCH = EPOCH_DATETIME.timestamp()
EPOCH_PLUS_ONE_YEAR_DATETIME = dt.datetime(1971, 1, 1, tzinfo=dt.timezone.utc)
EPOCH_PLUS_ONE_YEAR = EPOCH_PLUS_ONE_YEAR_DATETIME.timestamp()
LIBRARY_EPOCH_DATETIME = dt.datetime(2020, 4, 29)  # The day this library was made
LIBRARY_EPOCH = LIBRARY_EPOCH_DATETIME.timestamp()

py_have_clock_gettime = pytest.mark.skipif(
    not hasattr(time, "clock_gettime"), reason="Doesn't have clock_gettime"
)


def sleep_one_cycle(clock: int) -> None:
    time.sleep(time.clock_getres(clock))


@contextmanager
def change_local_timezone(local_tz: str | None) -> typing.Iterator[None]:
    orig_tz = os.environ["TZ"]
    if local_tz:
        os.environ["TZ"] = local_tz
    else:
        del os.environ["TZ"]
    time.tzset()
    try:
        yield
    finally:
        os.environ["TZ"] = orig_tz
        time.tzset()


@pytest.mark.skipif(
    not hasattr(time, "CLOCK_REALTIME"), reason="No time.CLOCK_REALTIME"
)
def test_import_without_clock_realtime():
    orig = time.CLOCK_REALTIME
    del time.CLOCK_REALTIME
    try:
        # Recipe for importing from path as documented in importlib
        spec = spec_from_file_location(
            f"{__name__}.time_machine_without_clock_realtime", time_machine.__file__
        )
        assert spec is not None
        module = module_from_spec(spec)
        # typeshed says exec_module does not always exist:
        spec.loader.exec_module(module)  # type: ignore[union-attr]

    finally:
        time.CLOCK_REALTIME = orig  # type: ignore[misc]

    # No assertions - testing for coverage only


# datetime module


def test_datetime_now_no_args():
    with time_machine.travel(EPOCH):
        now = dt.datetime.now()
        assert now.year == 1970
        assert now.month == 1
        assert now.day == 1
        # Not asserting on hour/minute because local timezone could shift it
        assert now.second == 0
        assert now.microsecond == 0
    assert dt.datetime.now() >= LIBRARY_EPOCH_DATETIME


def test_datetime_now_no_args_no_tick():
    with time_machine.travel(EPOCH, tick=False):
        now = dt.datetime.now()
        assert now.microsecond == 0
    assert dt.datetime.now() >= LIBRARY_EPOCH_DATETIME


def test_datetime_now_arg():
    with time_machine.travel(EPOCH):
        now = dt.datetime.now(tz=dt.timezone.utc)
        assert now.year == 1970
        assert now.month == 1
        assert now.day == 1
    assert dt.datetime.now(dt.timezone.utc) >= LIBRARY_EPOCH_DATETIME.replace(
        tzinfo=dt.timezone.utc
    )


def test_datetime_utcnow():
    with time_machine.travel(EPOCH):
        now = dt.datetime.utcnow()
        assert now.year == 1970
        assert now.month == 1
        assert now.day == 1
        assert now.hour == 0
        assert now.minute == 0
        assert now.second == 0
        assert now.microsecond == 0
        assert now.tzinfo is None
    assert dt.datetime.utcnow() >= LIBRARY_EPOCH_DATETIME


def test_datetime_utcnow_no_tick():
    with time_machine.travel(EPOCH, tick=False):
        now = dt.datetime.utcnow()
        assert now.microsecond == 0


def test_date_today():
    with time_machine.travel(EPOCH):
        today = dt.date.today()
        assert today.year == 1970
        assert today.month == 1
        assert today.day == 1
    assert dt.datetime.today() >= LIBRARY_EPOCH_DATETIME


# time module


@py_have_clock_gettime
def test_time_clock_gettime_realtime():
    with time_machine.travel(EPOCH + 180.0):
        now = time.clock_gettime(time.CLOCK_REALTIME)
        assert isinstance(now, float)
        assert now == EPOCH + 180.0

    now = time.clock_gettime(time.CLOCK_REALTIME)
    assert isinstance(now, float)
    assert now >= LIBRARY_EPOCH


@py_have_clock_gettime
def test_time_clock_gettime_monotonic_unaffected():
    start = time.clock_gettime(time.CLOCK_MONOTONIC)
    sleep_one_cycle(time.CLOCK_MONOTONIC)
    with time_machine.travel(EPOCH + 180.0):
        frozen = time.clock_gettime(time.CLOCK_MONOTONIC)
        sleep_one_cycle(time.CLOCK_MONOTONIC)
        assert isinstance(frozen, float)
        assert frozen > start

    now = time.clock_gettime(time.CLOCK_MONOTONIC)
    assert isinstance(now, float)
    assert now > frozen


@py_have_clock_gettime
def test_time_clock_gettime_ns_realtime():
    with time_machine.travel(EPOCH + 190.0):
        first = time.clock_gettime_ns(time.CLOCK_REALTIME)
        sleep_one_cycle(time.CLOCK_REALTIME)
        assert isinstance(first, int)
        assert first == int((EPOCH + 190.0) * NANOSECONDS_PER_SECOND)
        second = time.clock_gettime_ns(time.CLOCK_REALTIME)
        assert first < second < int((EPOCH + 191.0) * NANOSECONDS_PER_SECOND)

    now = time.clock_gettime_ns(time.CLOCK_REALTIME)
    assert isinstance(now, int)
    assert now >= int(LIBRARY_EPOCH * NANOSECONDS_PER_SECOND)


@py_have_clock_gettime
def test_time_clock_gettime_ns_monotonic_unaffected():
    start = time.clock_gettime_ns(time.CLOCK_MONOTONIC)
    sleep_one_cycle(time.CLOCK_MONOTONIC)
    with time_machine.travel(EPOCH + 190.0):
        frozen = time.clock_gettime_ns(time.CLOCK_MONOTONIC)
        sleep_one_cycle(time.CLOCK_MONOTONIC)
        assert isinstance(frozen, int)
        assert frozen > start

    now = time.clock_gettime_ns(time.CLOCK_MONOTONIC)
    assert isinstance(now, int)
    assert now > frozen


def test_time_gmtime_no_args():
    with time_machine.travel(EPOCH):
        local_time = time.gmtime()
        assert local_time.tm_year == 1970
        assert local_time.tm_mon == 1
        assert local_time.tm_mday == 1
    now_time = time.gmtime()
    assert now_time.tm_year >= 2020


def test_time_gmtime_no_args_no_tick():
    with time_machine.travel(EPOCH, tick=False):
        local_time = time.gmtime()
        assert local_time.tm_sec == 0


def test_time_gmtime_arg():
    with time_machine.travel(EPOCH):
        local_time = time.gmtime(EPOCH_PLUS_ONE_YEAR)
        assert local_time.tm_year == 1971
        assert local_time.tm_mon == 1
        assert local_time.tm_mday == 1


def test_time_localtime():
    with time_machine.travel(EPOCH):
        local_time = time.localtime()
        assert local_time.tm_year == 1970
        assert local_time.tm_mon == 1
        assert local_time.tm_mday == 1
    now_time = time.localtime()
    assert now_time.tm_year >= 2020


def test_time_localtime_no_tick():
    with time_machine.travel(EPOCH, tick=False):
        local_time = time.localtime()
        assert local_time.tm_sec == 0


def test_time_localtime_arg():
    with time_machine.travel(EPOCH):
        local_time = time.localtime(EPOCH_PLUS_ONE_YEAR)
        assert local_time.tm_year == 1971
        assert local_time.tm_mon == 1
        assert local_time.tm_mday == 1


def test_time_strftime_format():
    with time_machine.travel(EPOCH):
        assert time.strftime("%Y-%m-%d") == "1970-01-01"
    assert int(time.strftime("%Y")) >= 2020


def test_time_strftime_format_no_tick():
    with time_machine.travel(EPOCH, tick=False):
        assert time.strftime("%S") == "00"


def test_time_strftime_format_t():
    with time_machine.travel(EPOCH):
        assert (
            time.strftime("%Y-%m-%d", time.localtime(EPOCH_PLUS_ONE_YEAR))
            == "1971-01-01"
        )


def test_time_time():
    with time_machine.travel(EPOCH):
        first = time.time()
        sleep_one_cycle(time.CLOCK_MONOTONIC)
        assert isinstance(first, float)
        assert first == EPOCH
        second = time.time()
        assert first < second < EPOCH + 1.0

    now = time.time()
    assert isinstance(now, float)
    assert now >= LIBRARY_EPOCH


windows_epoch_in_posix = -11_644_445_222


@mock.patch.object(
    time_machine,
    "SYSTEM_EPOCH_TIMESTAMP_NS",
    (windows_epoch_in_posix * NANOSECONDS_PER_SECOND),
)
def test_time_time_windows():
    with time_machine.travel(EPOCH):
        first = time.time()
        sleep_one_cycle(time.CLOCK_MONOTONIC)
        assert isinstance(first, float)
        assert first == windows_epoch_in_posix

        second = time.time()
        assert isinstance(second, float)
        assert windows_epoch_in_posix < second < windows_epoch_in_posix + 1.0


def test_time_time_no_tick():
    with time_machine.travel(EPOCH, tick=False):
        assert time.time() == EPOCH


def test_time_time_ns():
    with time_machine.travel(EPOCH + 150.0):
        first = time.time_ns()
        sleep_one_cycle(time.CLOCK_MONOTONIC)
        assert isinstance(first, int)
        assert first == int((EPOCH + 150.0) * NANOSECONDS_PER_SECOND)
        second = time.time_ns()
        assert first < second < int((EPOCH + 151.0) * NANOSECONDS_PER_SECOND)

    now = time.time_ns()
    assert isinstance(now, int)
    assert now >= int(LIBRARY_EPOCH * NANOSECONDS_PER_SECOND)


def test_time_time_ns_no_tick():
    with time_machine.travel(EPOCH, tick=False):
        assert time.time_ns() == int(EPOCH * NANOSECONDS_PER_SECOND)


# all supported forms


def test_nestable():
    with time_machine.travel(EPOCH + 55.0):
        assert time.time() == EPOCH + 55.0
        with time_machine.travel(EPOCH + 50.0):
            assert time.time() == EPOCH + 50.0


def test_unsupported_type():
    with pytest.raises(TypeError) as excinfo, time_machine.travel([]):  # type: ignore[arg-type]
        pass  # pragma: no cover

    assert excinfo.value.args == ("Unsupported destination []",)


def test_exceptions_dont_break_it():
    with pytest.raises(ValueError), time_machine.travel(0.0):
        raise ValueError("Hi")
    # Unreachable code analysis doesn’t work with raises being caught by
    # context manager
    with time_machine.travel(0.0):
        pass


@time_machine.travel(EPOCH_DATETIME + dt.timedelta(seconds=70))
def test_destination_datetime():
    assert time.time() == EPOCH + 70.0


@time_machine.travel(EPOCH_DATETIME.replace(tzinfo=tz.gettz("America/Chicago")))
def test_destination_datetime_tzinfo_non_zoneinfo():
    assert time.time() == EPOCH + 21600.0


def test_destination_datetime_tzinfo_zoneinfo():
    orig_timezone = time.timezone
    orig_altzone = time.altzone
    orig_tzname = time.tzname
    orig_daylight = time.daylight

    dest = LIBRARY_EPOCH_DATETIME.replace(tzinfo=ZoneInfo("Africa/Addis_Ababa"))
    with time_machine.travel(dest):
        assert time.timezone == -3 * 3600
        assert time.altzone == -3 * 3600
        assert time.tzname == ("EAT", "EAT")
        assert time.daylight == 0

        assert time.localtime() == time.struct_time(
            (
                2020,
                4,
                29,
                0,
                0,
                0,
                2,
                120,
                0,
            )
        )

    assert time.timezone == orig_timezone
    assert time.altzone == orig_altzone
    assert time.tzname == orig_tzname
    assert time.daylight == orig_daylight


def test_destination_datetime_tzinfo_zoneinfo_nested():
    orig_tzname = time.tzname

    dest = LIBRARY_EPOCH_DATETIME.replace(tzinfo=ZoneInfo("Africa/Addis_Ababa"))
    with time_machine.travel(dest):
        assert time.tzname == ("EAT", "EAT")

        dest2 = LIBRARY_EPOCH_DATETIME.replace(tzinfo=ZoneInfo("Pacific/Auckland"))
        with time_machine.travel(dest2):
            assert time.tzname == ("NZST", "NZDT")

        assert time.tzname == ("EAT", "EAT")

    assert time.tzname == orig_tzname


def test_destination_datetime_tzinfo_zoneinfo_no_orig_tz():
    with change_local_timezone(None):
        orig_tzname = time.tzname
        dest = LIBRARY_EPOCH_DATETIME.replace(tzinfo=ZoneInfo("Africa/Addis_Ababa"))

        with time_machine.travel(dest):
            assert time.tzname == ("EAT", "EAT")

        assert time.tzname == orig_tzname


def test_destination_datetime_tzinfo_zoneinfo_utc_no_orig_tz():
    with change_local_timezone(None):
        orig_tzname = time.tzname
        dest = LIBRARY_EPOCH_DATETIME.replace(tzinfo=ZoneInfo("UTC"))

        with time_machine.travel(dest):
            assert time.tzname == ("UTC", "UTC")

        assert time.tzname == orig_tzname


def test_destination_datetime_tzinfo_datetime_timezone_utc_no_orig_tz():
    with change_local_timezone(None):
        orig_tzname = time.tzname
        dest = LIBRARY_EPOCH_DATETIME.replace(tzinfo=dt.timezone.utc)

        with time_machine.travel(dest):
            assert time.tzname == ("UTC", "UTC")

        assert time.tzname == orig_tzname


@pytest.mark.skipif(
    sys.version_info < (3, 11), reason="datetime.UTC was introduced in Python 3.11"
)
def test_destination_datetime_tzinfo_datetime_utc_no_orig_tz():
    with change_local_timezone(None):
        orig_tzname = time.tzname
        dest = LIBRARY_EPOCH_DATETIME.replace(tzinfo=dt.UTC)

        with time_machine.travel(dest):
            assert time.tzname == ("UTC", "UTC")

        assert time.tzname == orig_tzname


def test_destination_datetime_tzinfo_zoneinfo_windows():
    orig_timezone = time.timezone

    pretend_windows_no_tzset = mock.patch.object(time_machine, "tzset", new=None)
    mock_have_tzset_false = mock.patch.object(time_machine, "HAVE_TZSET", new=False)

    dest = LIBRARY_EPOCH_DATETIME.replace(tzinfo=ZoneInfo("Africa/Addis_Ababa"))
    with pretend_windows_no_tzset, mock_have_tzset_false, time_machine.travel(dest):
        assert time.timezone == orig_timezone


@time_machine.travel(int(EPOCH + 77))
def test_destination_int():
    assert time.time() == int(EPOCH + 77)


@time_machine.travel(EPOCH_DATETIME.replace(tzinfo=None) + dt.timedelta(seconds=120))
def test_destination_datetime_naive():
    assert time.time() == EPOCH + 120.0


@time_machine.travel(EPOCH_DATETIME.date())
def test_destination_date():
    assert time.time() == EPOCH


def test_destination_timedelta():
    now = time.time()
    with time_machine.travel(dt.timedelta(seconds=3600)):
        assert now + 3600 <= time.time() <= now + 3601


def test_destination_timedelta_first_travel_in_process():
    # Would previously segfault
    subprocess.run(
        [
            sys.executable,
            "-c",
            dedent(
                """
                from datetime import timedelta
                import time_machine
                with time_machine.travel(timedelta()):
                    pass
                """
            ),
        ],
        check=True,
    )


def test_destination_timedelta_negative():
    now = time.time()
    with time_machine.travel(dt.timedelta(seconds=-3600)):
        assert now - 3600 <= time.time() <= now - 3599


def test_destination_timedelta_nested():
    with time_machine.travel(EPOCH), time_machine.travel(dt.timedelta(seconds=10)):
        assert time.time() == EPOCH + 10.0


def test_destination_string_no_dateutil_unparsable():
    with (
        mock.patch.object(time_machine, "HAVE_DATEUTIL", new=False),
        pytest.raises(ValueError) as excinfo,
        time_machine.travel("the future"),
    ):
        pass  # pragma: no cover
    assert excinfo.value.args == ("Invalid isoformat string: 'the future'",)


@pytest.mark.parametrize(
    ("string", "expected_time"),
    [
        ("1970-01-01 00:00:00", EPOCH),
        ("1970-01-01 00:01:01", EPOCH + 61.0),
        ("1970-01-01", EPOCH),
    ],
)
def test_destination_string_no_dateutil(string, expected_time):
    with (
        mock.patch.object(time_machine, "HAVE_DATEUTIL", new=False),
        time_machine.travel(string),
    ):
        assert time.time() == expected_time


@pytest.mark.skipif(
    sys.version_info < (3, 11),
    reason="datetime.fromisoformat extended formats added in 3.11",
)
@pytest.mark.parametrize(
    ("string", "expected_time"),
    [
        ("19700101T000102", EPOCH + 62.0),
        ("1970-01-01T00:00:05+01:00", EPOCH - 3600.0 + 5),
    ],
)
def test_destination_string_no_dateutil_extended_formats(string, expected_time):
    with (
        mock.patch.object(time_machine, "HAVE_DATEUTIL", new=False),
        time_machine.travel(string),
    ):
        assert time.time() == expected_time


def test_destination_string_unparsable_dateutil():
    with (
        pytest.raises(ValueError) as excinfo,
        time_machine.travel("the future"),
    ):
        pass  # pragma: no cover
    assert excinfo.value.args == ("Unknown string format: %s", "the future")


@pytest.mark.parametrize(
    ("string", "expected_time"),
    [
        ("1st January 1970 00:03:03", EPOCH + 183.0),
        ("1st Jan 1970", EPOCH),
    ],
)
def test_destination_string_dateutil(string, expected_time):
    with time_machine.travel(string):
        assert time.time() == expected_time


@pytest.mark.parametrize(
    ["local_tz", "expected_offset"],
    [
        ("UTC", 0),
        ("Europe/Amsterdam", -3600),
        ("US/Eastern", 5 * 3600),
    ],
)
@pytest.mark.parametrize("destination", ["1970-01-01 00:00", "1970-01-01"])
def test_destination_string_naive(local_tz, expected_offset, destination):
    # MIXED mode (default) - strings are interpreted as local time
    with change_local_timezone(local_tz), time_machine.travel(destination):
        assert time.time() == EPOCH + expected_offset


@time_machine.travel(lambda: EPOCH + 140.0)
def test_destination_callable_lambda_float():
    assert time.time() == EPOCH + 140.0


@time_machine.travel(lambda: "1970-01-01 00:02 +0000")
def test_destination_callable_lambda_string():
    assert time.time() == EPOCH + 120.0


@time_machine.travel(EPOCH + 13.0 for _ in range(1))  # pragma: no branch
def test_destination_generator():
    assert time.time() == EPOCH + 13.0


def test_traveller_object():
    traveller = time_machine.travel(EPOCH + 10.0)
    assert time.time() >= LIBRARY_EPOCH
    try:
        traveller.start()
        assert time.time() == EPOCH + 10.0
    finally:
        traveller.stop()
    assert time.time() >= LIBRARY_EPOCH


@time_machine.travel(EPOCH + 15.0)
def test_function_decorator():
    assert time.time() == EPOCH + 15.0


def test_coroutine_decorator():
    recorded_time = None

    @time_machine.travel(EPOCH + 140.0)
    async def record_time() -> None:
        nonlocal recorded_time
        recorded_time = time.time()

    asyncio.run(record_time())

    assert recorded_time == EPOCH + 140.0


def test_async_context_manager():
    recorded_time = None

    async def record_time() -> None:
        nonlocal recorded_time
        async with time_machine.travel(EPOCH + 150.0):
            recorded_time = time.time()

    asyncio.run(record_time())

    assert recorded_time == EPOCH + 150.0


def test_async_context_manager_stops_properly():
    recorded_times = []

    async def record_times() -> None:
        recorded_times.append(time.time())

        async with time_machine.travel(EPOCH + 160.0):
            recorded_times.append(time.time())

        recorded_times.append(time.time())

    asyncio.run(record_times())

    assert recorded_times[0] >= LIBRARY_EPOCH
    assert recorded_times[1] == EPOCH + 160.0
    assert recorded_times[2] >= LIBRARY_EPOCH


def test_async_context_manager_traveller():
    recorded_time = None
    shifted_time = None

    async def test_traveller() -> None:
        nonlocal recorded_time, shifted_time
        async with time_machine.travel(EPOCH + 170.0, tick=False) as traveller:
            recorded_time = time.time()
            traveller.shift(10.0)
            shifted_time = time.time()

    asyncio.run(test_traveller())

    assert recorded_time == EPOCH + 170.0
    assert shifted_time == EPOCH + 180.0


def test_class_decorator_fails_non_testcase():
    with pytest.raises(TypeError) as excinfo:

        @time_machine.travel(EPOCH)
        class Something:
            pass

    assert excinfo.value.args == ("Can only decorate unittest.TestCase subclasses.",)


@time_machine.travel(EPOCH)
class ClassDecoratorInheritanceBase(TestCase):
    prop: bool

    @classmethod
    def setUpClass(cls):
        super().setUpClass()
        cls.setUpTestData()

    @classmethod
    def setUpTestData(cls) -> None:
        cls.prop = True


class ClassDecoratorInheritanceTests(ClassDecoratorInheritanceBase):
    @classmethod
    def setUpTestData(cls) -> None:
        super().setUpTestData()
        cls.prop = False

    def test_ineheritance_correctly_rebound(self):
        assert self.prop is False


class TestMethodDecorator:
    @time_machine.travel(EPOCH + 95.0)
    def test_method_decorator(self):
        assert time.time() == EPOCH + 95.0


class UnitTestMethodTests(TestCase):
    @time_machine.travel(EPOCH + 25.0)
    def test_method_decorator(self):
        assert time.time() == EPOCH + 25.0


@time_machine.travel(EPOCH + 95.0)
class UnitTestClassTests(TestCase):
    def test_class_decorator(self):
        sleep_one_cycle(time.CLOCK_MONOTONIC)
        assert EPOCH + 95.0 < time.time() < EPOCH + 96.0

    @time_machine.travel(EPOCH + 25.0)
    def test_stacked_method_decorator(self):
        assert time.time() == EPOCH + 25.0


@time_machine.travel(EPOCH + 95.0)
class UnitTestClassCustomSetUpClassTests(TestCase):
    custom_setupclass_ran: bool

    @classmethod
    def setUpClass(cls):
        super().setUpClass()
        cls.custom_setupclass_ran = True

    def test_class_decorator(self):
        sleep_one_cycle(time.CLOCK_MONOTONIC)
        assert EPOCH + 95.0 < time.time() < EPOCH + 96.0
        assert self.custom_setupclass_ran


@time_machine.travel(EPOCH + 110.0)
class UnitTestClassSetUpClassSkipTests(TestCase):
    @classmethod
    def setUpClass(cls):
        raise SkipTest("Not today")
        # Other tests would fail if the travel() wasn't stopped

    def test_thats_always_skipped(self):  # pragma: no cover
        pass


# shift() tests


def test_shift_with_timedelta():
    with time_machine.travel(EPOCH, tick=False) as traveller:
        traveller.shift(dt.timedelta(days=1))
        assert time.time() == EPOCH + (3600.0 * 24)


def test_shift_integer_delta():
    with time_machine.travel(EPOCH, tick=False) as traveller:
        traveller.shift(10)
        assert time.time() == EPOCH + 10


def test_shift_negative_delta():
    with time_machine.travel(EPOCH, tick=False) as traveller:
        traveller.shift(-10)

        assert time.time() == EPOCH - 10


def test_shift_wrong_delta():
    with (
        time_machine.travel(EPOCH, tick=False) as traveller,
        pytest.raises(TypeError) as excinfo,
    ):
        traveller.shift(delta="1.1")  # type: ignore[arg-type]

    assert excinfo.value.args == ("Unsupported type for delta argument: '1.1'",)


def test_shift_when_tick():
    with time_machine.travel(EPOCH, tick=True) as traveller:
        traveller.shift(10.0)
        assert EPOCH + 10.0 <= time.time() < EPOCH + 20.0


# move_to() tests


def test_move_to_datetime():
    with time_machine.travel(EPOCH) as traveller:
        assert time.time() == EPOCH

        traveller.move_to(EPOCH_PLUS_ONE_YEAR_DATETIME)

        first = time.time()
        sleep_one_cycle(time.CLOCK_MONOTONIC)
        assert first == EPOCH_PLUS_ONE_YEAR

        second = time.time()
        assert first < second < first + 1.0


def test_move_to_datetime_no_tick():
    with time_machine.travel(EPOCH, tick=False) as traveller:
        traveller.move_to(EPOCH_PLUS_ONE_YEAR_DATETIME)
        assert time.time() == EPOCH_PLUS_ONE_YEAR
        assert time.time() == EPOCH_PLUS_ONE_YEAR


def test_move_to_past_datetime():
    with time_machine.travel(EPOCH_PLUS_ONE_YEAR) as traveller:
        assert time.time() == EPOCH_PLUS_ONE_YEAR
        traveller.move_to(EPOCH_DATETIME)
        assert time.time() == EPOCH


def test_move_to_datetime_with_tzinfo_zoneinfo():
    orig_timezone = time.timezone
    orig_altzone = time.altzone
    orig_tzname = time.tzname
    orig_daylight = time.daylight

    with time_machine.travel(EPOCH) as traveller:
        assert time.time() == EPOCH
        assert time.timezone == orig_timezone
        assert time.altzone == orig_altzone
        assert time.tzname == orig_tzname
        assert time.daylight == orig_daylight

        dest = EPOCH_PLUS_ONE_YEAR_DATETIME.replace(
            tzinfo=ZoneInfo("Africa/Addis_Ababa")
        )
        traveller.move_to(dest)

        assert time.timezone == -3 * 3600
        assert time.altzone == -3 * 3600
        assert time.tzname == ("EAT", "EAT")
        assert time.daylight == 0

        assert time.localtime() == time.struct_time(
            (
                1971,
                1,
                1,
                0,
                0,
                0,
                4,
                1,
                0,
            )
        )

    assert time.timezone == orig_timezone
    assert time.altzone == orig_altzone
    assert time.tzname == orig_tzname
    assert time.daylight == orig_daylight


def test_move_to_datetime_change_tick_on():
    with time_machine.travel(EPOCH, tick=False) as traveller:
        traveller.move_to(EPOCH_PLUS_ONE_YEAR_DATETIME, tick=True)
        assert time.time() == EPOCH_PLUS_ONE_YEAR
        sleep_one_cycle(time.CLOCK_MONOTONIC)
        assert time.time() > EPOCH_PLUS_ONE_YEAR


def test_move_to_datetime_change_tick_off():
    with time_machine.travel(EPOCH, tick=True) as traveller:
        traveller.move_to(EPOCH_PLUS_ONE_YEAR_DATETIME, tick=False)
        assert time.time() == EPOCH_PLUS_ONE_YEAR
        assert time.time() == EPOCH_PLUS_ONE_YEAR


# uuid tests


def time_from_uuid1(value: uuid.UUID) -> dt.datetime:
    return dt.datetime(1582, 10, 15) + dt.timedelta(microseconds=value.time // 10)


def time_from_uuid7(value: uuid.UUID) -> dt.datetime:
    return dt.datetime.fromtimestamp(value.time / 1000)


def test_uuid1():
    """
    Test that the uuid.uuid1() methods generate values for the destination.
    They are a known location in the stdlib that can make system calls to find
    the current datetime.
    """
    destination = dt.datetime(2017, 2, 6, 14, 8, 21)

    with time_machine.travel(destination, tick=False):
        assert time_from_uuid1(uuid.uuid1()) == destination


@pytest.mark.skipif(
    sys.version_info < (3, 14),
    reason="Only valid on Python 3.14+",
)
def test_uuid7() -> None:
    """
    Test that we can go back in time after setting a future date.
    Normally UUID7 would disallow this, since it keeps track of
    the _last_timestamp_v7, but we override that now.
    """
    if not hasattr(uuid, "uuid7"):
        pytest.skip("uuid.uuid7 is not available")

    destination_future = dt.datetime(2056, 2, 6, 14, 3, 21)
    destination_present = dt.datetime(2025, 1, 1)
    destination_past = dt.datetime(1978, 7, 6, 23, 6, 31)

    with time_machine.travel(destination_future, tick=False):
        assert time_from_uuid7(uuid.uuid7()) == destination_future

    with time_machine.travel(destination_past, tick=False):
        assert time_from_uuid7(uuid.uuid7()) == destination_past

    # Verify stack does not interfere
    with time_machine.travel(destination_present, tick=False):
        with time_machine.travel(destination_future, tick=False):
            assert time_from_uuid7(uuid.uuid7()) == destination_future

        with time_machine.travel(destination_past, tick=False):
            assert time_from_uuid7(uuid.uuid7()) == destination_past


# error handling tests


def test_c_extension_init_import_error():
    code = dedent(
        """\
        import sys
        sys.modules["datetime"] = None
        try:
            import _time_machine
        except ImportError as exc:
            print(exc.args[0])
        """
    )

    result = subprocess.run(
        [sys.executable, "-c", code],
        check=True,
        stdout=subprocess.PIPE,
        text=True,
    )

    assert result.stdout == "import of datetime halted; None in sys.modules\n"


@pytest.mark.parametrize(
    "func, args",
    [
        (dt.datetime.now, ()),
        (dt.datetime.utcnow, ()),
        (time.gmtime, ()),
        (time.clock_gettime, (time.CLOCK_REALTIME,)),
        (time.clock_gettime_ns, (time.CLOCK_REALTIME,)),
        (time.localtime, ()),
        (time.strftime, ("%Y-%m-%d",)),
        (time.time, ()),
        (time.time_ns, ()),
    ],
)
def test_time_machine_import_error(func, args):
    with (
        time_machine.travel(EPOCH),
        mock.patch.dict(sys.modules, {"time_machine": None}),
        pytest.raises(ModuleNotFoundError) as excinfo,
    ):
        func(*args)

    assert excinfo.value.args == ("import of time_machine halted; None in sys.modules",)


@pytest.mark.parametrize(
    "func, args",
    [
        (dt.datetime.now, ()),
        (dt.datetime.utcnow, ()),
        (time.gmtime, ()),
        (time.clock_gettime, (time.CLOCK_REALTIME,)),
        (time.clock_gettime_ns, (time.CLOCK_REALTIME,)),
        (time.localtime, ()),
        (time.strftime, ("%Y-%m-%d",)),
        (time.time, ()),
        (time.time_ns, ()),
    ],
)
def test_time_machine_attribute_error(func, args):
    with (
        time_machine.travel(EPOCH),
        mock.patch.dict(sys.modules, {"time_machine": ()}),
        pytest.raises(AttributeError) as excinfo,
    ):
        func(*args)

    assert excinfo.value.args == (f"'tuple' object has no attribute '{func.__name__}'",)


# freeezegun conflict tests


def test_errors_if_freezegun_active_first():
    with (
        freezegun.freeze_time("2000-01-01"),
        pytest.raises(RuntimeError) as excinfo,
        time_machine.travel(EPOCH),
    ):
        pass  # pragma: no cover

    assert excinfo.value.args == (
        "time-machine cannot start when freezegun is active.",
    )


# naive_mode tests


def test_naive_mode_default_is_mixed():
    # MIXED for backwards compatibility
    assert time_machine.naive_mode == time_machine.NaiveMode.MIXED


def test_naive_mode_mixed_datetime():
    naive_dt = dt.datetime(1970, 1, 1, 0, 2, 0)
    with (
        mock.patch.object(time_machine, "naive_mode", time_machine.NaiveMode.MIXED),
        time_machine.travel(naive_dt),
    ):
        assert time.time() == EPOCH + 120.0


def test_naive_mode_mixed_date():
    date = dt.date(1970, 1, 1)
    with (
        mock.patch.object(time_machine, "naive_mode", time_machine.NaiveMode.MIXED),
        time_machine.travel(date),
    ):
        assert time.time() == EPOCH


@pytest.mark.parametrize(
    "local_tz", ["UTC", "America/Chicago", "Europe/London", "Asia/Tokyo"]
)
def test_naive_mode_mixed_string(local_tz):
    naive_string = "1970-01-01 00:00:00"

    with change_local_timezone(local_tz):
        expected_timestamp = dt.datetime(1970, 1, 1, 0, 0, 0).timestamp()

    with (
        change_local_timezone(local_tz),
        mock.patch.object(time_machine, "naive_mode", time_machine.NaiveMode.MIXED),
        time_machine.travel(naive_string),
    ):
        assert time.time() == expected_timestamp


def test_naive_mode_utc_datetime():
    naive_dt = dt.datetime(1970, 1, 1, 0, 2, 0)
    with (
        mock.patch.object(time_machine, "naive_mode", time_machine.NaiveMode.UTC),
        time_machine.travel(naive_dt),
    ):
        assert time.time() == EPOCH + 120.0


def test_naive_mode_utc_date():
    date = dt.date(1970, 1, 1)
    with (
        mock.patch.object(time_machine, "naive_mode", time_machine.NaiveMode.UTC),
        time_machine.travel(date),
    ):
        assert time.time() == EPOCH


@pytest.mark.parametrize(
    "local_tz", ["UTC", "America/Chicago", "Europe/London", "Asia/Tokyo"]
)
def test_naive_mode_local_datetime(local_tz):
    naive_dt = dt.datetime(1970, 1, 1, 0, 0, 0)
    with change_local_timezone(local_tz):
        expected_timestamp = naive_dt.timestamp()

    with (
        change_local_timezone(local_tz),
        mock.patch.object(time_machine, "naive_mode", time_machine.NaiveMode.LOCAL),
        time_machine.travel(naive_dt),
    ):
        assert time.time() == expected_timestamp


@pytest.mark.parametrize(
    "local_tz", ["UTC", "America/Chicago", "Europe/London", "Asia/Tokyo"]
)
def test_naive_mode_local_date(local_tz):
    date = dt.date(1970, 1, 1)

    with change_local_timezone(local_tz):
        expected_timestamp = dt.datetime.combine(date, dt.time()).timestamp()

    with (
        change_local_timezone(local_tz),
        mock.patch.object(time_machine, "naive_mode", time_machine.NaiveMode.LOCAL),
        time_machine.travel(date),
    ):
        assert time.time() == expected_timestamp


def test_naive_mode_error_datetime():
    naive_dt = dt.datetime(1970, 1, 1, 0, 2, 0)
    with (
        mock.patch.object(time_machine, "naive_mode", time_machine.NaiveMode.ERROR),
        pytest.raises(
            RuntimeError,
            match="Naive datetime provided while time_machine.naive_mode is set to ERROR",
        ),
    ):
        time_machine.travel(naive_dt).start()


def test_naive_mode_error_date():
    date = dt.date(1970, 1, 1)
    with (
        mock.patch.object(time_machine, "naive_mode", time_machine.NaiveMode.ERROR),
        pytest.raises(
            RuntimeError,
            match="date object provided while time_machine.naive_mode is set to ERROR",
        ),
    ):
        time_machine.travel(date).start()


def test_naive_mode_error_aware_datetime_works():
    aware_dt = dt.datetime(1970, 1, 1, 0, 2, 0, tzinfo=dt.timezone.utc)
    with (
        mock.patch.object(time_machine, "naive_mode", time_machine.NaiveMode.ERROR),
        time_machine.travel(aware_dt),
    ):
        assert time.time() == EPOCH + 120.0


def test_naive_mode_utc_string():
    naive_string = "1970-01-01 00:02:00"
    with (
        mock.patch.object(time_machine, "naive_mode", time_machine.NaiveMode.UTC),
        time_machine.travel(naive_string),
    ):
        assert time.time() == EPOCH + 120.0


@pytest.mark.parametrize(
    "local_tz", ["UTC", "America/Chicago", "Europe/London", "Asia/Tokyo"]
)
def test_naive_mode_local_string(local_tz):
    naive_string = "1970-01-01 00:00:00"

    # Calculate what timestamp we expect by using Python's normal behavior
    with change_local_timezone(local_tz):
        expected_timestamp = dt.datetime(1970, 1, 1, 0, 0, 0).timestamp()

    with (
        change_local_timezone(local_tz),
        mock.patch.object(time_machine, "naive_mode", time_machine.NaiveMode.LOCAL),
        time_machine.travel(naive_string),
    ):
        assert time.time() == expected_timestamp


def test_naive_mode_error_string():
    naive_string = "1970-01-01 00:02:00"
    with (
        mock.patch.object(time_machine, "naive_mode", time_machine.NaiveMode.ERROR),
        pytest.raises(
            RuntimeError,
            match="Naive datetime string provided while time_machine.naive_mode is set to ERROR",
        ),
    ):
        time_machine.travel(naive_string).start()


def test_naive_mode_error_string_aware_works():
    aware_string = "1970-01-01 00:02:00+00:00"
    with (
        mock.patch.object(time_machine, "naive_mode", time_machine.NaiveMode.ERROR),
        time_machine.travel(aware_string),
    ):
        assert time.time() == EPOCH + 120.0


# pytest plugin tests


def test_fixture_unused(time_machine):
    assert time.time() >= LIBRARY_EPOCH


def test_fixture_used(time_machine):
    time_machine.move_to(EPOCH)
    assert time.time() == EPOCH


def test_fixture_used_tick_false(time_machine):
    time_machine.move_to(EPOCH, tick=False)
    assert time.time() == EPOCH
    assert time.time() == EPOCH


def test_fixture_used_tick_true(time_machine):
    time_machine.move_to(EPOCH, tick=True)
    original = time.time()
    sleep_one_cycle(time.CLOCK_MONOTONIC)
    assert original == EPOCH
    assert original < time.time() < EPOCH + 10.0


def test_fixture_move_to_twice(time_machine):
    time_machine.move_to(EPOCH)
    assert time.time() == EPOCH

    time_machine.move_to(EPOCH_PLUS_ONE_YEAR)
    assert time.time() == EPOCH_PLUS_ONE_YEAR


def test_fixture_move_to_and_shift(time_machine):
    time_machine.move_to(EPOCH, tick=False)
    assert time.time() == EPOCH
    time_machine.shift(100)
    assert time.time() == EPOCH + 100


def test_fixture_shift_without_move_to(time_machine):
    with pytest.raises(RuntimeError) as excinfo:
        time_machine.shift(100)

    assert excinfo.value.args == (
        "Initialize time_machine with move_to() before using shift().",
    )


@pytest.mark.skipif(
    sys.version_info < (3, 14),
    reason="Only valid on Python 3.14+",
)
def test_uuid7_fixture(time_machine):
    if not hasattr(uuid, "uuid7"):
        pytest.skip("uuid.uuid7 is not available")

    destination_future = dt.datetime(2056, 2, 6, 14, 3, 21)
    time_machine.move_to(destination_future, tick=False)
    assert time_from_uuid7(uuid.uuid7()) == destination_future

    destination_past = dt.datetime(1978, 7, 6, 23, 6, 31)
    time_machine.move_to(destination_past, tick=False)
    assert time_from_uuid7(uuid.uuid7()) == destination_past


def test_marker_function(testdir):
    testdir.makepyfile(
        """
        import pytest
        import time

        @pytest.fixture
        def current_time():
            return time.time()

        @pytest.mark.time_machine(0)
        def test(current_time):
            assert current_time < 10.0
    """
    )

    result = testdir.runpytest("-v", "-s")
    result.assert_outcomes(passed=1)


def test_marker_and_fixture(testdir):
    testdir.makepyfile(
        """
        import pytest
        import time

        @pytest.mark.time_machine(0)
        def test(time_machine):
            assert time.time() < 10.0
            time_machine.shift(100)
            assert 100.0 <= time.time() < 110.0
            time_machine.move_to(0)
            assert time.time() < 10.0
        """
    )
    result = testdir.runpytest("-v", "-s")
    result.assert_outcomes(passed=1)


def test_marker_class(testdir):
    testdir.makepyfile(
        """
        import pytest
        import time

        @pytest.mark.time_machine(0)
        class TestTimeMachine:
            def test(self):
                assert time.time() < 10.0
    """
    )

    result = testdir.runpytest("-v", "-s")
    result.assert_outcomes(passed=1)


def test_marker_module(testdir):
    testdir.makepyfile(
        """
        import pytest
        import time

        pytestmark = pytest.mark.time_machine(0)

        def test_module():
            assert time.time() < 10.0
    """
    )

    result = testdir.runpytest("-v", "-s")
    result.assert_outcomes(passed=1)


# escape hatch tests


class TestEscapeHatch:
    def test_is_travelling_false(self):
        assert time_machine.escape_hatch.is_travelling() is False

    def test_is_travelling_true(self):
        with time_machine.travel(EPOCH):
            assert time_machine.escape_hatch.is_travelling() is True

    def test_datetime_now(self):
        real_now = dt.datetime.now()

        with time_machine.travel(EPOCH):
            eh_now = time_machine.escape_hatch.datetime.datetime.now()
            assert eh_now >= real_now

        with pytest.raises(ValueError) as excinfo:
            time_machine.escape_hatch.datetime.datetime.now()
        assert excinfo.value.args == ("Not currently time-travelling.",)

    def test_datetime_now_tz(self):
        real_now = dt.datetime.now(tz=dt.timezone.utc)

        with time_machine.travel(EPOCH):
            eh_now = time_machine.escape_hatch.datetime.datetime.now(tz=dt.timezone.utc)
            assert eh_now >= real_now

    def test_datetime_utcnow(self):
        real_now = dt.datetime.utcnow()

        with time_machine.travel(EPOCH):
            eh_now = time_machine.escape_hatch.datetime.datetime.utcnow()
            assert eh_now >= real_now

        with pytest.raises(ValueError) as excinfo:
            time_machine.escape_hatch.datetime.datetime.utcnow()
        assert excinfo.value.args == ("Not currently time-travelling.",)

    @py_have_clock_gettime
    def test_time_clock_gettime(self):
        now = time.clock_gettime(time.CLOCK_REALTIME)

        with time_machine.travel(EPOCH + 180.0):
            eh_now = time_machine.escape_hatch.time.clock_gettime(time.CLOCK_REALTIME)
            assert eh_now >= now

        with pytest.raises(ValueError) as excinfo:
            time_machine.escape_hatch.time.clock_gettime(time.CLOCK_REALTIME)
        assert excinfo.value.args == ("Not currently time-travelling.",)

    @py_have_clock_gettime
    def test_time_clock_gettime_ns(self):
        now = time.clock_gettime_ns(time.CLOCK_REALTIME)

        with time_machine.travel(EPOCH + 190.0):
            eh_now = time_machine.escape_hatch.time.clock_gettime_ns(
                time.CLOCK_REALTIME
            )
            assert eh_now >= now

        with pytest.raises(ValueError) as excinfo:
            time_machine.escape_hatch.time.clock_gettime_ns(time.CLOCK_REALTIME)
        assert excinfo.value.args == ("Not currently time-travelling.",)

    def test_time_gmtime(self):
        now = time.gmtime()

        with time_machine.travel(EPOCH):
            eh_now = time_machine.escape_hatch.time.gmtime()
            assert eh_now >= now

        with pytest.raises(ValueError) as excinfo:
            time_machine.escape_hatch.time.gmtime()
        assert excinfo.value.args == ("Not currently time-travelling.",)

    def test_time_localtime(self):
        now = time.localtime()

        with time_machine.travel(EPOCH):
            eh_now = time_machine.escape_hatch.time.localtime()
            assert eh_now >= now

        with pytest.raises(ValueError) as excinfo:
            time_machine.escape_hatch.time.localtime()
        assert excinfo.value.args == ("Not currently time-travelling.",)

    def test_time_strftime_no_arg(self):
        today = dt.date.today()

        with time_machine.travel(EPOCH):
            eh_formatted = time_machine.escape_hatch.time.strftime("%Y-%m-%d")
            eh_today = dt.datetime.strptime(eh_formatted, "%Y-%m-%d").date()
            assert eh_today >= today

        with pytest.raises(ValueError) as excinfo:
            time_machine.escape_hatch.time.strftime("%Y-%m-%d")
        assert excinfo.value.args == ("Not currently time-travelling.",)

    def test_time_strftime_arg(self):
        with time_machine.travel(EPOCH):
            formatted = time_machine.escape_hatch.time.strftime(
                "%Y-%m-%d",
                time.localtime(EPOCH_PLUS_ONE_YEAR),
            )
            assert formatted == "1971-01-01"

    def test_time_time(self):
        now = time.time()

        with time_machine.travel(EPOCH):
            eh_now = time_machine.escape_hatch.time.time()
            assert eh_now >= now

        with pytest.raises(ValueError) as excinfo:
            time_machine.escape_hatch.time.time()
        assert excinfo.value.args == ("Not currently time-travelling.",)

    def test_time_time_ns(self):
        now = time.time_ns()

        with time_machine.travel(EPOCH):
            eh_now = time_machine.escape_hatch.time.time_ns()
            assert eh_now >= now

        with pytest.raises(ValueError) as excinfo:
            time_machine.escape_hatch.time.time_ns()
        assert excinfo.value.args == ("Not currently time-travelling.",)