darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-07-12 17:34:48 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fixed linting issues

Browse Source
This commit is contained in:
alexjanousekGSA
2025-02-06 07:45:19 -05:00
parent 020374ce18
commit 10e60a9790
3 changed files with 145 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
app/dao/date_util.py
View File

@@ -111,9 +111,8 @@ def build_local_and_utc_date_range(
# Subtract (days - 1) so the entire final day is included in the range
local_start_date = local_end_date - timedelta(days=days)
# Convert to UTC for database queries
utc_start_date = local_start_date.astimezone(pytz.utc).replace(hour=0, minute=0, second=0)
utc_end_date = local_end_date.astimezone(pytz.utc).replace(hour=23, minute=59, second=59)
utc_end_date = local_end_date.astimezone(pytz.utc).replace(hour=23, minute=59, second=59)
return (local_start_date, utc_start_date, utc_end_date)

1
app/service/rest.py
View File

@@ -1,7 +1,6 @@
import itertools
from datetime import datetime
import pytz
from flask import Blueprint, current_app, jsonify, request
from sqlalchemy import select
from sqlalchemy.exc import IntegrityError

238
tests/app/dao/test_services_get_specific_days.py
View File

@@ -16,143 +16,193 @@ def generate_expected_output(requested_days, requested_sms_days):
TemplateType.SMS: {
StatisticsType.REQUESTED: 1 if day in requested_sms_days else 0,
StatisticsType.DELIVERED: 0,
StatisticsType.FAILURE: 0
StatisticsType.FAILURE: 0,
},
TemplateType.EMAIL: {
StatisticsType.REQUESTED: 0,
StatisticsType.DELIVERED: 0,
StatisticsType.FAILURE: 0
}
StatisticsType.FAILURE: 0,
},
}
return output
def create_mock_notification(notification_type, status, timestamp, count=1):
return Mock(
notification_type=notification_type,
status=status,
timestamp=timestamp,
count=count
count=count,
)
test_cases = [
# Case with normal dates that don't carry over to next day when converted to UTC
(
[create_mock_notification(TemplateType.SMS, StatisticsType.REQUESTED, datetime(2025, 1, 29, 1, 20, 18, tzinfo=pytz.utc))],
datetime(2025, 1, 28, tzinfo=pytz.utc),
2,
"America/New_York",
generate_expected_output(["2025-01-28", "2025-01-29"], ["2025-01-28"])
),
# Case where EST is saved as next day in UTC, it needs to be converted back to EST after retrieval
(
[create_mock_notification(TemplateType.SMS, StatisticsType.REQUESTED, datetime(2025, 1, 30, 4, 30, 0, tzinfo=pytz.utc))],
datetime(2025, 1, 29, tzinfo=pytz.utc),
2,
"America/New_York",
generate_expected_output(["2025-01-29", "2025-01-30"], ["2025-01-29"])
),
# Case where UTC is queryed
(
[create_mock_notification(TemplateType.SMS, StatisticsType.REQUESTED, datetime(2025, 1, 29, 10, 15, 0, tzinfo=pytz.utc))],
datetime(2025, 1, 28, tzinfo=pytz.utc),
2,
"UTC",
generate_expected_output(["2025-01-28", "2025-01-29"], ["2025-01-29"])
),
# Central time test
(
[create_mock_notification(TemplateType.SMS, StatisticsType.REQUESTED, datetime(2025, 1, 29, 3, 0, 0, tzinfo=pytz.utc))],
datetime(2025, 1, 28, tzinfo=pytz.utc),
2,
"America/Chicago",
generate_expected_output(["2025-01-28", "2025-01-29"], ["2025-01-28"])
),
# Mountain time test
(
[create_mock_notification(TemplateType.SMS, StatisticsType.REQUESTED, datetime(2025, 1, 29, 5, 0, 0, tzinfo=pytz.utc))],
datetime(2025, 1, 28, tzinfo=pytz.utc),
2,
"America/Denver",
generate_expected_output(["2025-01-28", "2025-01-29"], ["2025-01-28"])
),
# Pacific time test
(
[create_mock_notification(TemplateType.SMS, StatisticsType.REQUESTED, datetime(2025, 1, 29, 7, 30, 0, tzinfo=pytz.utc))],
datetime(2025, 1, 28, tzinfo=pytz.utc),
2,
"America/Los_Angeles",
generate_expected_output(["2025-01-28", "2025-01-29"], ["2025-01-28"])
),
# Case where no timezone is provided, ensuring it defaults to UTC
(
[create_mock_notification(TemplateType.SMS, StatisticsType.REQUESTED, datetime(2025, 1, 29, 10, 15, 0, tzinfo=pytz.utc))],
datetime(2025, 1, 28, tzinfo=pytz.utc),
2,
None, # No timezone passed
generate_expected_output(["2025-01-28", "2025-01-29"], ["2025-01-29"])
),
# Daylights savings time Spring Forward: March 10, 2024 at 2 AM EST => jumps to 3 AM EST
# Case with normal dates that don't carry over
(
[create_mock_notification(
TemplateType.SMS,
StatisticsType.REQUESTED,
datetime(2024, 3, 10, 6, 30, 0, tzinfo=pytz.utc) # UTC 6:30 AM => 1:30 AM EST (before DST kicks in)
datetime(2025, 1, 29, 1, 20, 18, tzinfo=pytz.utc),
)],
datetime(2025, 1, 28, tzinfo=pytz.utc),
2,
"America/New_York",
generate_expected_output(["2025-01-28", "2025-01-29"], ["2025-01-28"]),
),
# Case where EST is saved as next day in UTC
(
[create_mock_notification(
TemplateType.SMS,
StatisticsType.REQUESTED,
datetime(2025, 1, 30, 4, 30, 0, tzinfo=pytz.utc),
)],
datetime(2025, 1, 29, tzinfo=pytz.utc),
2,
"America/New_York",
generate_expected_output(["2025-01-29", "2025-01-30"], ["2025-01-29"]),
),
# UTC query
(
[create_mock_notification(
TemplateType.SMS,
StatisticsType.REQUESTED,
datetime(2025, 1, 29, 10, 15, 0, tzinfo=pytz.utc),
)],
datetime(2025, 1, 28, tzinfo=pytz.utc),
2,
"UTC",
generate_expected_output(["2025-01-28", "2025-01-29"], ["2025-01-29"]),
),
# Central time test
(
[create_mock_notification(
TemplateType.SMS,
StatisticsType.REQUESTED,
datetime(2025, 1, 29, 3, 0, 0, tzinfo=pytz.utc),
)],
datetime(2025, 1, 28, tzinfo=pytz.utc),
2,
"America/Chicago",
generate_expected_output(["2025-01-28", "2025-01-29"], ["2025-01-28"]),
),
# Mountain time test
(
[create_mock_notification(
TemplateType.SMS,
StatisticsType.REQUESTED,
datetime(2025, 1, 29, 5, 0, 0, tzinfo=pytz.utc),
)],
datetime(2025, 1, 28, tzinfo=pytz.utc),
2,
"America/Denver",
generate_expected_output(["2025-01-28", "2025-01-29"], ["2025-01-28"]),
),
# Pacific time test
(
[create_mock_notification(
TemplateType.SMS,
StatisticsType.REQUESTED,
datetime(2025, 1, 29, 7, 30, 0, tzinfo=pytz.utc),
)],
datetime(2025, 1, 28, tzinfo=pytz.utc),
2,
"America/Los_Angeles",
generate_expected_output(["2025-01-28", "2025-01-29"], ["2025-01-28"]),
),
# No timezone provided => defaults to UTC
(
[create_mock_notification(
TemplateType.SMS,
StatisticsType.REQUESTED,
datetime(2025, 1, 29, 10, 15, 0, tzinfo=pytz.utc),
)],
datetime(2025, 1, 28, tzinfo=pytz.utc),
2,
None,
generate_expected_output(["2025-01-28", "2025-01-29"], ["2025-01-29"]),
),
# DST Spring Forward
(
[create_mock_notification(
TemplateType.SMS,
StatisticsType.REQUESTED,
datetime(2024, 3, 10, 6, 30, 0, tzinfo=pytz.utc),
)],
datetime(2024, 3, 9, tzinfo=pytz.utc),
2,
"America/New_York",
generate_expected_output(["2024-03-09", "2024-03-10"], ["2024-03-10"]) # Should map to March 10 EST
generate_expected_output(["2024-03-09", "2024-03-10"], ["2024-03-10"]),
),
# Fall Back: November 3, 2024 at 2 AM EDT => goes back to 1 AM EST
# DST Fall Back
(
[create_mock_notification(
TemplateType.SMS,
StatisticsType.REQUESTED,
datetime(2024, 11, 3, 5, 30, 0, tzinfo=pytz.utc) # UTC 5:30 AM => 1:30 AM EST after DST ends
datetime(2024, 11, 3, 5, 30, 0, tzinfo=pytz.utc),
)],
datetime(2024, 11, 2, tzinfo=pytz.utc),
2,
"America/New_York",
generate_expected_output(["2024-11-02", "2024-11-03"], ["2024-11-03"])
generate_expected_output(["2024-11-02", "2024-11-03"], ["2024-11-03"]),
),
# There are no notifications
# No notifications
(
[],
datetime(2025, 1, 29, tzinfo=pytz.utc),
2,
"UTC",
generate_expected_output(["2025-01-29", "2025-01-30"], [])
generate_expected_output(["2025-01-29", "2025-01-30"], []),
),
# Midnight edge case
# Midnight edge case => 12:00 AM UTC => 7:00 PM previous day EST
(
[create_mock_notification(
TemplateType.SMS,
StatisticsType.REQUESTED,
datetime(2025, 1, 10, 0, 0, 0, tzinfo=pytz.utc) # 12:00 AM UTC => 7:00 PM Jan 9 EST
)],
datetime(2025, 1, 9, tzinfo=pytz.utc),
2,
"America/New_York",
generate_expected_output(["2025-01-09", "2025-01-10"], ["2025-01-09"]) # Goes back to Jan 9 EST
[create_mock_notification(
TemplateType.SMS,
StatisticsType.REQUESTED,
datetime(2025, 1, 10, 0, 0, 0, tzinfo=pytz.utc),
)],
datetime(2025, 1, 9, tzinfo=pytz.utc),
2,
"America/New_York",
generate_expected_output(["2025-01-09", "2025-01-10"], ["2025-01-09"]),
),
# Large query testing large amounts of data
# Large query (30 days)
(
[create_mock_notification(
TemplateType.SMS,
StatisticsType.REQUESTED,
datetime(2025, 1, 15, 12, 0, 0, tzinfo=pytz.utc)
)],
datetime(2025, 1, 1, tzinfo=pytz.utc),
30,
"America/New_York",
generate_expected_output(
[f"2025-01-{str(day).zfill(2)}" for day in range(1, 31)],
["2025-01-15"]
)
)
[create_mock_notification(
TemplateType.SMS,
StatisticsType.REQUESTED,
datetime(2025, 1, 15, 12, 0, 0, tzinfo=pytz.utc),
)],
datetime(2025, 1, 1, tzinfo=pytz.utc),
30,
"America/New_York",
generate_expected_output(
[f"2025-01-{str(day).zfill(2)}" for day in range(1, 31)],
["2025-01-15"],
),
),
]
@pytest.mark.parametrize("mocked_notifications, start_date, days, timezone, expected_output", test_cases)
@pytest.mark.parametrize(
"mocked_notifications, start_date, days, timezone, expected_output",
test_cases,
)
def test_get_specific_days(mocked_notifications, start_date, days, timezone, expected_output):
results = get_specific_days_stats(mocked_notifications, start_date, days, timezone=timezone)
results = get_specific_days_stats(
mocked_notifications,
start_date,
days,
timezone=timezone,
)
assert results == expected_output