File: test_schedule_tools.py

package info (click to toggle)
python-aioswitcher 4.0.2-1.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 13,528 kB
  • sloc: python: 4,324; makefile: 53
file content (183 lines) | stat: -rw-r--r-- 8,007 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# Copyright Tomer Figenblat.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Switcher integration pretty next run tool test cases."""

from binascii import hexlify, unhexlify
from datetime import datetime, timedelta
from struct import pack, unpack

import time_machine
from assertpy import assert_that
from freezegun import freeze_time
from pytest import fixture, mark

from aioswitcher.schedule import Days, tools

days_by_weekdays = dict(map(lambda d: (d.weekday, d), Days))


@fixture()
def today():
    return datetime.utcnow()


@fixture
def todays_day(today):
    return days_by_weekdays[today.weekday()]


@fixture
def one_hour_from_now(today):
    return datetime.strftime(today + timedelta(hours=1), "%H:%M")


def test_pretty_next_run_with_no_selected_days_should_return_due_today(one_hour_from_now):
    expected_return = f"Due today at {one_hour_from_now}"
    assert_that(tools.pretty_next_run(one_hour_from_now)).is_equal_to(expected_return)


def test_pretty_next_run_with_todays_day_should_return_due_today(todays_day, one_hour_from_now):
    expected_return = f"Due today at {one_hour_from_now}"
    assert_that(tools.pretty_next_run(one_hour_from_now, {todays_day})).is_equal_to(expected_return)


@freeze_time("2024-01-01 23:00:00")
def test_pretty_next_run_with_specific_date_and_time_end_of_day_should_return_due_today():
    # todays_day at 2024-01-01 is Monday which is 0
    todays_day = days_by_weekdays[0]
    one_hour_from_now = "00:00"
    expected_return = f"Due today at {one_hour_from_now}"
    assert_that(tools.pretty_next_run(one_hour_from_now, {todays_day})).is_equal_to(expected_return)


def test_pretty_next_run_with_multiple_days_should_return_due_the_closest_day(today):
    two_days_from_now = today + timedelta(days=2)
    four_days_from_now = today + timedelta(days=4)

    two_days_from_now_day = days_by_weekdays[two_days_from_now.weekday()]
    four_days_from_now_day = days_by_weekdays[four_days_from_now.weekday()]

    expected_return = f"Due next {two_days_from_now_day.value} at 13:00"

    assert_that(tools.pretty_next_run("13:00", {four_days_from_now_day, two_days_from_now_day})).is_equal_to(expected_return)


def test_pretty_next_run_on_yesterday_with_todays_day_should_return_due_tomorrow(today, todays_day):
    expected_return = "Due tomorrow at 13:00"
    yesterday = today - timedelta(days=1)
    with time_machine.travel(yesterday):
        assert_that(tools.pretty_next_run("13:00", {todays_day})).is_equal_to(expected_return)


def test_pretty_next_run_on_two_days_ago_with_todays_day_should_return_due_on_next_day(today, todays_day):
    expected_return = f"Due next {todays_day.value} at 13:00"
    two_days_ago = today - timedelta(days=2)
    with time_machine.travel(two_days_ago):
        assert_that(tools.pretty_next_run("13:00", {todays_day})).is_equal_to(expected_return)


def test_pretty_next_run_on_last_sunday_with_monday_selected_should_return_due_tomorrow(today):
    expected_return = "Due tomorrow at 13:00"
    last_sunday = today - timedelta(days=((today.weekday() + 1) % 7))
    with time_machine.travel(last_sunday):
        assert_that(tools.pretty_next_run("13:00", {Days.MONDAY})).is_equal_to(expected_return)


def test_calc_duration_with_valid_start_and_end_time_should_return_the_duration():
    assert_that(tools.calc_duration("13:00", "14:00")).is_equal_to("1:00:00")


def test_calc_duration_with_greater_start_time_than_end_time_should_assume_next_day():
    assert_that(tools.calc_duration("14:00", "13:00")).is_equal_to("23:00:00")


def test_hexadecimale_timestamp_to_localtime_with_the_current_timestamp_should_return_a_time_string():
    sut_datetime = datetime.now()
    hex_timestamp = hexlify(pack("<I", round(sut_datetime.timestamp())))
    assert_that(
        tools.hexadecimale_timestamp_to_localtime(hex_timestamp)
    ).is_equal_to(sut_datetime.time().strftime("%H:%M"))


def test_hexadecimale_timestamp_to_localtime_with_wrong_value_should_throw_an_error():
    assert_that(tools.hexadecimale_timestamp_to_localtime).raises(
        ValueError
    ).when_called_with("wrongvalue".encode()).starts_with("invalid literal for int() with base 16")


@mark.parametrize("sum, expected_weekdays", [
    (2, {Days.MONDAY}),
    (6, {Days.MONDAY, Days.TUESDAY}),
    (14, {Days.MONDAY, Days.TUESDAY, Days.WEDNESDAY},),
    (30, {Days.MONDAY, Days.TUESDAY, Days.WEDNESDAY, Days.THURSDAY}),
    (62, {Days.MONDAY, Days.TUESDAY, Days.WEDNESDAY, Days.THURSDAY, Days.FRIDAY}),
    (126, {Days.MONDAY, Days.TUESDAY, Days.WEDNESDAY, Days.THURSDAY, Days.FRIDAY, Days.SATURDAY}),
    (254, {Days.MONDAY, Days.TUESDAY, Days.WEDNESDAY, Days.THURSDAY, Days.FRIDAY, Days.SATURDAY, Days.SUNDAY}),
])
def test_bit_summary_to_days_with_parameterized_sum_should_return_the_expected_weekday_set(sum, expected_weekdays):
    assert_that(tools.bit_summary_to_days(sum)).is_equal_to(expected_weekdays)


@mark.parametrize("wrong_bit_sum", [1, 255])
def test_bit_summary_to_days_with_wrong_bit_sum_parameterized_value(wrong_bit_sum):
    assert_that(tools.bit_summary_to_days).raises(
        ValueError
    ).when_called_with(wrong_bit_sum).is_equal_to("weekdays bit sum should be between 2 and 254")


@mark.parametrize("weekdays, expected_sum", [
    (Days.MONDAY, 2),
    ({Days.MONDAY, Days.TUESDAY}, 6),
    ({Days.MONDAY, Days.TUESDAY, Days.WEDNESDAY}, 14),
    ({Days.MONDAY, Days.TUESDAY, Days.WEDNESDAY, Days.THURSDAY}, 30),
    ({Days.MONDAY, Days.TUESDAY, Days.WEDNESDAY, Days.THURSDAY, Days.FRIDAY}, 62),
    ({Days.MONDAY, Days.TUESDAY, Days.WEDNESDAY, Days.THURSDAY, Days.FRIDAY, Days.SATURDAY}, 126),
    ({Days.MONDAY, Days.TUESDAY, Days.WEDNESDAY, Days.THURSDAY, Days.FRIDAY, Days.SATURDAY, Days.SUNDAY}, 254),
])
def test_weekdays_to_hexadecimal_with_parameterized_weekday_set_should_return_the_expected_sum(weekdays, expected_sum):
    sut_hex = tools.weekdays_to_hexadecimal(weekdays)
    sut_int = int(sut_hex, 16)
    assert_that(sut_int).is_equal_to(expected_sum)


@mark.parametrize("empty_collection", [set(), (), {}, []])
def test_weekdays_to_hexadecimal_with_empty_collections_should_throw_an_error(empty_collection):
    assert_that(tools.weekdays_to_hexadecimal).raises(
        ValueError
    ).when_called_with(empty_collection).is_equal_to("no days requested")


@mark.parametrize("duplicate_members", [(Days.MONDAY, Days.MONDAY), [Days.MONDAY, Days.MONDAY]])
def test_weekdays_to_hexadecimal_with_duplicate_members_should_throw_an_encoding_error(duplicate_members):
    assert_that(tools.weekdays_to_hexadecimal).raises(
        ValueError
    ).when_called_with(duplicate_members).is_equal_to("no days requested")


def test_time_to_hexadecimal_timestamp_with_correct_time_should_return_the_expected_timestamp():
    hex_timestamp = tools.time_to_hexadecimal_timestamp("21:00")

    binary_timestamp = unhexlify(hex_timestamp.encode())
    unpacked_timestamp = unpack("<I", binary_timestamp)
    sut_datetime = datetime.fromtimestamp(unpacked_timestamp[0])
    assert_that(
        sut_datetime
    ).is_equal_to_ignoring_time(datetime.now()).has_hour(21).has_minute(0)


def test_time_to_hexadecimal_timestamp_with_incorrect_time_should_throw_an_error():
    assert_that(tools.time_to_hexadecimal_timestamp).raises(
        IndexError
    ).when_called_with("2100").is_equal_to("list index out of range")