mirror of
https://github.com/ansible-collections/community.crypto.git
synced 2026-05-06 13:22:58 +00:00
Make all module_utils and plugin_utils private (#887)
* Add leading underscore. Remove deprecated module utils. * Document module and plugin utils as private. Add changelog fragment. * Convert relative to absolute imports. * Remove unnecessary imports.
This commit is contained in:
Felix Fontein
GitHub
390
tests/unit/plugins/module_utils/test__time.py
Normal file
390
tests/unit/plugins/module_utils/test__time.py
Normal file
@@ -0,0 +1,390 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import datetime
|
||||
import typing as t
|
||||
|
||||
import pytest
|
||||
from ansible_collections.community.crypto.plugins.module_utils._time import (
|
||||
UTC,
|
||||
add_or_remove_timezone,
|
||||
convert_relative_to_datetime,
|
||||
ensure_utc_timezone,
|
||||
from_epoch_seconds,
|
||||
get_epoch_seconds,
|
||||
get_now_datetime,
|
||||
get_relative_time_option,
|
||||
remove_timezone,
|
||||
)
|
||||
from freezegun import freeze_time
|
||||
|
||||
|
||||
TIMEZONES = [
|
||||
datetime.timedelta(hours=0),
|
||||
datetime.timedelta(hours=1),
|
||||
datetime.timedelta(hours=2),
|
||||
datetime.timedelta(hours=-6),
|
||||
]
|
||||
|
||||
|
||||
if t.TYPE_CHECKING:
|
||||
_S = t.TypeVar("_S")
|
||||
_Ts = t.TypeVarTuple("_Ts")
|
||||
|
||||
|
||||
def cartesian_product(
|
||||
list1: list[_S], list2: "list[tuple[*_Ts]]"
|
||||
) -> "list[tuple[_S, *_Ts]]":
|
||||
result: "list[tuple[_S, *_Ts]]" = []
|
||||
for item1 in list1:
|
||||
item1_tuple = (item1,)
|
||||
for item2 in list2:
|
||||
result.append(item1_tuple + item2)
|
||||
return result
|
||||
|
||||
|
||||
ONE_HOUR_PLUS = datetime.timezone(datetime.timedelta(hours=1))
|
||||
|
||||
TEST_REMOVE_TIMEZONE: list[
|
||||
tuple[datetime.timedelta, datetime.datetime, datetime.datetime]
|
||||
] = cartesian_product(
|
||||
TIMEZONES,
|
||||
[
|
||||
(
|
||||
datetime.datetime(2024, 1, 1, 0, 1, 2, tzinfo=UTC),
|
||||
datetime.datetime(2024, 1, 1, 0, 1, 2),
|
||||
),
|
||||
(
|
||||
datetime.datetime(2024, 1, 1, 0, 1, 2),
|
||||
datetime.datetime(2024, 1, 1, 0, 1, 2),
|
||||
),
|
||||
(
|
||||
datetime.datetime(2024, 1, 1, 0, 1, 2, tzinfo=ONE_HOUR_PLUS),
|
||||
datetime.datetime(2023, 12, 31, 23, 1, 2),
|
||||
),
|
||||
],
|
||||
)
|
||||
|
||||
TEST_UTC_TIMEZONE: list[
|
||||
tuple[datetime.timedelta, datetime.datetime, datetime.datetime]
|
||||
] = cartesian_product(
|
||||
TIMEZONES,
|
||||
[
|
||||
(
|
||||
datetime.datetime(2024, 1, 1, 0, 1, 2),
|
||||
datetime.datetime(2024, 1, 1, 0, 1, 2, tzinfo=UTC),
|
||||
),
|
||||
(
|
||||
datetime.datetime(2024, 1, 1, 0, 1, 2, tzinfo=UTC),
|
||||
datetime.datetime(2024, 1, 1, 0, 1, 2, tzinfo=UTC),
|
||||
),
|
||||
(
|
||||
datetime.datetime(2024, 1, 1, 0, 1, 2, tzinfo=ONE_HOUR_PLUS),
|
||||
datetime.datetime(2023, 12, 31, 23, 1, 2, tzinfo=UTC),
|
||||
),
|
||||
],
|
||||
)
|
||||
|
||||
TEST_EPOCH_SECONDS: list[tuple[datetime.timedelta, float, dict[str, int]]] = (
|
||||
cartesian_product(
|
||||
TIMEZONES,
|
||||
[
|
||||
(
|
||||
0,
|
||||
dict(
|
||||
year=1970, day=1, month=1, hour=0, minute=0, second=0, microsecond=0
|
||||
),
|
||||
),
|
||||
(
|
||||
1e-6,
|
||||
dict(
|
||||
year=1970, day=1, month=1, hour=0, minute=0, second=0, microsecond=1
|
||||
),
|
||||
),
|
||||
(
|
||||
1e-3,
|
||||
dict(
|
||||
year=1970,
|
||||
day=1,
|
||||
month=1,
|
||||
hour=0,
|
||||
minute=0,
|
||||
second=0,
|
||||
microsecond=1000,
|
||||
),
|
||||
),
|
||||
(
|
||||
3691.2,
|
||||
dict(
|
||||
year=1970,
|
||||
day=1,
|
||||
month=1,
|
||||
hour=1,
|
||||
minute=1,
|
||||
second=31,
|
||||
microsecond=200000,
|
||||
),
|
||||
),
|
||||
],
|
||||
)
|
||||
)
|
||||
|
||||
TEST_EPOCH_TO_SECONDS: list[tuple[datetime.timedelta, datetime.datetime, int]] = (
|
||||
cartesian_product(
|
||||
TIMEZONES,
|
||||
[
|
||||
(datetime.datetime(1970, 1, 1, 0, 1, 2, 0), 62),
|
||||
(datetime.datetime(1970, 1, 1, 0, 1, 2, 0, tzinfo=UTC), 62),
|
||||
(
|
||||
datetime.datetime(1970, 1, 1, 0, 1, 2, 0, tzinfo=ONE_HOUR_PLUS),
|
||||
62 - 3600,
|
||||
),
|
||||
],
|
||||
)
|
||||
)
|
||||
|
||||
TEST_CONVERT_RELATIVE_TO_DATETIME: list[
|
||||
tuple[datetime.timedelta, str, bool, datetime.datetime, datetime.datetime]
|
||||
] = cartesian_product(
|
||||
TIMEZONES,
|
||||
[
|
||||
(
|
||||
"+0",
|
||||
False,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
),
|
||||
(
|
||||
"+1s",
|
||||
False,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0, tzinfo=UTC),
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 1),
|
||||
),
|
||||
(
|
||||
"-10w20d30h40m50s",
|
||||
False,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0, tzinfo=UTC),
|
||||
datetime.datetime(2023, 10, 1, 17, 19, 10),
|
||||
),
|
||||
(
|
||||
"+0",
|
||||
True,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0, tzinfo=UTC),
|
||||
),
|
||||
(
|
||||
"+1s",
|
||||
True,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0, tzinfo=UTC),
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 1, tzinfo=UTC),
|
||||
),
|
||||
(
|
||||
"-10w20d30h40m50s",
|
||||
True,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
datetime.datetime(2023, 10, 1, 17, 19, 10, tzinfo=UTC),
|
||||
),
|
||||
],
|
||||
)
|
||||
|
||||
TEST_GET_RELATIVE_TIME_OPTION: list[
|
||||
tuple[datetime.timedelta, str, str, bool, datetime.datetime, datetime.datetime]
|
||||
] = cartesian_product(
|
||||
TIMEZONES,
|
||||
[
|
||||
(
|
||||
"+1d2h3m4s",
|
||||
"foo",
|
||||
False,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
datetime.datetime(2024, 1, 2, 2, 3, 4),
|
||||
),
|
||||
(
|
||||
"-1w10d24h",
|
||||
"foo",
|
||||
False,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
datetime.datetime(2023, 12, 14, 0, 0, 0),
|
||||
),
|
||||
(
|
||||
"20240102040506Z",
|
||||
"foo",
|
||||
False,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
datetime.datetime(2024, 1, 2, 4, 5, 6),
|
||||
),
|
||||
(
|
||||
"202401020405Z",
|
||||
"foo",
|
||||
False,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
datetime.datetime(2024, 1, 2, 4, 5, 0),
|
||||
),
|
||||
(
|
||||
"+1d2h3m4s",
|
||||
"foo",
|
||||
True,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
datetime.datetime(2024, 1, 2, 2, 3, 4, tzinfo=UTC),
|
||||
),
|
||||
(
|
||||
"-1w10d24h",
|
||||
"foo",
|
||||
True,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
datetime.datetime(2023, 12, 14, 0, 0, 0, tzinfo=UTC),
|
||||
),
|
||||
(
|
||||
"20240102040506Z",
|
||||
"foo",
|
||||
True,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
datetime.datetime(2024, 1, 2, 4, 5, 6, tzinfo=UTC),
|
||||
),
|
||||
(
|
||||
"202401020405Z",
|
||||
"foo",
|
||||
True,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
datetime.datetime(2024, 1, 2, 4, 5, 0, tzinfo=UTC),
|
||||
),
|
||||
(
|
||||
"20240102040506+0100",
|
||||
"foo",
|
||||
False,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
datetime.datetime(2024, 1, 2, 3, 5, 6),
|
||||
),
|
||||
(
|
||||
"202401020405+0100",
|
||||
"foo",
|
||||
False,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
datetime.datetime(2024, 1, 2, 3, 5, 0),
|
||||
),
|
||||
(
|
||||
"20240102040506+0100",
|
||||
"foo",
|
||||
True,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
datetime.datetime(2024, 1, 2, 3, 5, 6, tzinfo=UTC),
|
||||
),
|
||||
(
|
||||
"202401020405+0100",
|
||||
"foo",
|
||||
True,
|
||||
datetime.datetime(2024, 1, 1, 0, 0, 0),
|
||||
datetime.datetime(2024, 1, 2, 3, 5, 0, tzinfo=UTC),
|
||||
),
|
||||
],
|
||||
)
|
||||
|
||||
|
||||
@pytest.mark.parametrize("timezone, input, expected", TEST_REMOVE_TIMEZONE)
|
||||
def test_remove_timezone(
|
||||
timezone: datetime.timedelta, input: datetime.datetime, expected: datetime.datetime
|
||||
) -> None:
|
||||
with freeze_time("2024-02-03 04:05:06", tz_offset=timezone):
|
||||
output_1 = remove_timezone(input)
|
||||
assert expected == output_1
|
||||
output_2 = add_or_remove_timezone(input, with_timezone=False)
|
||||
assert expected == output_2
|
||||
|
||||
|
||||
@pytest.mark.parametrize("timezone, input, expected", TEST_UTC_TIMEZONE)
|
||||
def test_utc_timezone(
|
||||
timezone: datetime.timedelta, input: datetime.datetime, expected: datetime.datetime
|
||||
) -> None:
|
||||
with freeze_time("2024-02-03 04:05:06", tz_offset=timezone):
|
||||
output_1 = ensure_utc_timezone(input)
|
||||
assert expected == output_1
|
||||
output_2 = add_or_remove_timezone(input, with_timezone=True)
|
||||
assert expected == output_2
|
||||
|
||||
|
||||
# @pytest.mark.parametrize("timezone", TIMEZONES)
|
||||
# Due to a bug in freezegun (https://github.com/spulec/freezegun/issues/348, https://github.com/spulec/freezegun/issues/553)
|
||||
# this only works with timezone = UTC
|
||||
@pytest.mark.parametrize("timezone", [datetime.timedelta(hours=0)])
|
||||
def test_get_now_datetime_w_timezone(timezone: datetime.timedelta) -> None:
|
||||
with freeze_time("2024-02-03 04:05:06", tz_offset=timezone):
|
||||
output_2 = get_now_datetime(with_timezone=True)
|
||||
assert output_2.tzinfo is not None
|
||||
assert output_2.tzinfo == UTC
|
||||
assert output_2 == datetime.datetime(2024, 2, 3, 4, 5, 6, tzinfo=UTC)
|
||||
|
||||
|
||||
@pytest.mark.parametrize("timezone", TIMEZONES)
|
||||
def test_get_now_datetime_wo_timezone(timezone: datetime.timedelta) -> None:
|
||||
with freeze_time("2024-02-03 04:05:06", tz_offset=timezone):
|
||||
output_1 = get_now_datetime(with_timezone=False)
|
||||
assert output_1.tzinfo is None
|
||||
assert output_1 == datetime.datetime(2024, 2, 3, 4, 5, 6)
|
||||
|
||||
|
||||
@pytest.mark.parametrize("timezone, seconds, timestamp", TEST_EPOCH_SECONDS)
|
||||
def test_epoch_seconds(
|
||||
timezone: datetime.timedelta, seconds: float, timestamp: dict[str, int]
|
||||
) -> None:
|
||||
with freeze_time("2024-02-03 04:05:06", tz_offset=timezone):
|
||||
ts_wo_tz: datetime.datetime = datetime.datetime(**timestamp) # type: ignore
|
||||
assert seconds == get_epoch_seconds(ts_wo_tz)
|
||||
timestamp_w_tz: dict[str, t.Any] = dict(timestamp)
|
||||
timestamp_w_tz["tzinfo"] = UTC
|
||||
ts_w_tz: datetime.datetime = datetime.datetime(**timestamp_w_tz) # type: ignore
|
||||
assert seconds == get_epoch_seconds(ts_w_tz)
|
||||
output_1 = from_epoch_seconds(seconds, with_timezone=False)
|
||||
assert ts_wo_tz == output_1
|
||||
output_2 = from_epoch_seconds(seconds, with_timezone=True)
|
||||
assert ts_w_tz == output_2
|
||||
|
||||
|
||||
@pytest.mark.parametrize("timezone, timestamp, expected_seconds", TEST_EPOCH_TO_SECONDS)
|
||||
def test_epoch_to_seconds(
|
||||
timezone: datetime.timedelta, timestamp: datetime.datetime, expected_seconds: int
|
||||
) -> None:
|
||||
with freeze_time("2024-02-03 04:05:06", tz_offset=timezone):
|
||||
assert expected_seconds == get_epoch_seconds(timestamp)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"timezone, relative_time_string, with_timezone, now, expected",
|
||||
TEST_CONVERT_RELATIVE_TO_DATETIME,
|
||||
)
|
||||
def test_convert_relative_to_datetime(
|
||||
timezone: datetime.timedelta,
|
||||
relative_time_string: str,
|
||||
with_timezone: bool,
|
||||
now: datetime.datetime,
|
||||
expected: datetime.datetime,
|
||||
) -> None:
|
||||
with freeze_time("2024-02-03 04:05:06", tz_offset=timezone):
|
||||
output = convert_relative_to_datetime(
|
||||
relative_time_string, with_timezone=with_timezone, now=now
|
||||
)
|
||||
assert expected == output
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"timezone, input_string, input_name, with_timezone, now, expected",
|
||||
TEST_GET_RELATIVE_TIME_OPTION,
|
||||
)
|
||||
def test_get_relative_time_option(
|
||||
timezone: datetime.timedelta,
|
||||
input_string: str,
|
||||
input_name: str,
|
||||
with_timezone: bool,
|
||||
now: datetime.datetime,
|
||||
expected: datetime.datetime,
|
||||
) -> None:
|
||||
with freeze_time("2024-02-03 04:05:06", tz_offset=timezone):
|
||||
output = get_relative_time_option(
|
||||
input_string,
|
||||
input_name,
|
||||
with_timezone=with_timezone,
|
||||
now=now,
|
||||
)
|
||||
assert expected == output
|
||||
Reference in New Issue
Block a user