darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-02-04 18:31:13 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3545 from alphagov/remove-unused-function

Browse Source 
Remove redundant DAO function / consolidate tests
This commit is contained in:
Ben Thorner
2022-05-26 11:03:30 +01:00
committed by GitHub
parent a6d25154d9 d153603c5c
commit aa20064f3f
2 changed files with 14 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
app/dao/services_dao.py
View File

@@ -54,7 +54,6 @@ from app.utils import (
escape_special_characters, escape_special_characters,
get_archived_db_column_value, get_archived_db_column_value,
get_london_midnight_in_utc, get_london_midnight_in_utc,
midnight_n_days_ago,
) )
DEFAULT_SERVICE_PERMISSIONS = [ DEFAULT_SERVICE_PERMISSIONS = [
@@ -422,34 +421,22 @@ def delete_service_and_all_associated_db_objects(service):
db.session.commit() db.session.commit()
def dao_fetch_stats_for_service(service_id, limit_days):
# We always want between seven and eight days
start_date = midnight_n_days_ago(limit_days)
return _stats_for_service_query(service_id).filter(
Notification.created_at >= start_date
).all()
def dao_fetch_todays_stats_for_service(service_id): def dao_fetch_todays_stats_for_service(service_id):
today = date.today() today = date.today()
start_date = get_london_midnight_in_utc(today) start_date = get_london_midnight_in_utc(today)
return _stats_for_service_query(service_id).filter(
Notification.created_at >= start_date
).all()
def _stats_for_service_query(service_id):
return db.session.query( return db.session.query(
Notification.notification_type, Notification.notification_type,
Notification.status, Notification.status,
func.count(Notification.id).label('count') func.count(Notification.id).label('count')
).filter( ).filter(
Notification.service_id == service_id, Notification.service_id == service_id,
Notification.key_type != KEY_TYPE_TEST Notification.key_type != KEY_TYPE_TEST,
Notification.created_at >= start_date
).group_by( ).group_by(
Notification.notification_type, Notification.notification_type,
Notification.status, Notification.status,
) ).all()
def dao_fetch_todays_stats_for_all_services(include_from_test_key=True, only_active=True): def dao_fetch_todays_stats_for_all_services(include_from_test_key=True, only_active=True):

46
tests/app/dao/test_services_dao.py
View File

@@ -31,7 +31,6 @@ from app.dao.services_dao import (
dao_fetch_live_services_data, dao_fetch_live_services_data,
dao_fetch_service_by_id, dao_fetch_service_by_id,
dao_fetch_service_by_inbound_number, dao_fetch_service_by_inbound_number,
dao_fetch_stats_for_service,
dao_fetch_todays_stats_for_all_services, dao_fetch_todays_stats_for_all_services,
dao_fetch_todays_stats_for_service, dao_fetch_todays_stats_for_service,
dao_find_services_sending_to_tv_numbers, dao_find_services_sending_to_tv_numbers,
@@ -789,7 +788,7 @@ def test_fetch_stats_filters_on_service(notify_db_session):
message_limit=1000) message_limit=1000)
dao_create_service(service_two, service_one.created_by) dao_create_service(service_two, service_one.created_by)
stats = dao_fetch_stats_for_service(service_two.id, 7) stats = dao_fetch_todays_stats_for_service(service_two.id)
assert len(stats) == 0 assert len(stats) == 0
@@ -799,11 +798,11 @@ def test_fetch_stats_ignores_historical_notification_data(sample_template):
assert Notification.query.count() == 0 assert Notification.query.count() == 0
assert NotificationHistory.query.count() == 1 assert NotificationHistory.query.count() == 1
stats = dao_fetch_stats_for_service(sample_template.service_id, 7) stats = dao_fetch_todays_stats_for_service(sample_template.service_id)
assert len(stats) == 0 assert len(stats) == 0
def test_fetch_stats_counts_correctly(notify_db_session): def test_dao_fetch_todays_stats_for_service(notify_db_session):
service = create_service() service = create_service()
sms_template = create_template(service=service) sms_template = create_template(service=service)
email_template = create_template(service=service, template_type='email') email_template = create_template(service=service, template_type='email')
@@ -813,7 +812,7 @@ def test_fetch_stats_counts_correctly(notify_db_session):
create_notification(template=email_template, status='technical-failure') create_notification(template=email_template, status='technical-failure')
create_notification(template=sms_template, status='created') create_notification(template=sms_template, status='created')
stats = dao_fetch_stats_for_service(sms_template.service_id, 7) stats = dao_fetch_todays_stats_for_service(service.id)
stats = sorted(stats, key=lambda x: (x.notification_type, x.status)) stats = sorted(stats, key=lambda x: (x.notification_type, x.status))
assert len(stats) == 3 assert len(stats) == 3
@@ -830,7 +829,7 @@ def test_fetch_stats_counts_correctly(notify_db_session):
assert stats[2].count == 1 assert stats[2].count == 1
def test_fetch_stats_counts_should_ignore_team_key(notify_db_session): def test_dao_fetch_todays_stats_for_service_should_ignore_test_key(notify_db_session):
service = create_service() service = create_service()
template = create_template(service=service) template = create_template(service=service)
live_api_key = create_api_key(service=service, key_type=KEY_TYPE_NORMAL) live_api_key = create_api_key(service=service, key_type=KEY_TYPE_NORMAL)
@@ -843,14 +842,14 @@ def test_fetch_stats_counts_should_ignore_team_key(notify_db_session):
create_notification(template=template, api_key=team_api_key, key_type=team_api_key.key_type) create_notification(template=template, api_key=team_api_key, key_type=team_api_key.key_type)
create_notification(template=template) create_notification(template=template)
stats = dao_fetch_stats_for_service(template.service_id, 7) stats = dao_fetch_todays_stats_for_service(service.id)
assert len(stats) == 1 assert len(stats) == 1
assert stats[0].notification_type == 'sms' assert stats[0].notification_type == 'sms'
assert stats[0].status == 'created' assert stats[0].status == 'created'
assert stats[0].count == 3 assert stats[0].count == 3
def test_fetch_stats_for_today_only_includes_today(notify_db_session): def test_dao_fetch_todays_stats_for_service_only_includes_today(notify_db_session):
template = create_template(service=create_service()) template = create_template(service=create_service())
# two created email, one failed email, and one created sms # two created email, one failed email, and one created sms
with freeze_time('2001-01-01T23:59:00'): with freeze_time('2001-01-01T23:59:00'):
@@ -873,7 +872,7 @@ def test_fetch_stats_for_today_only_includes_today(notify_db_session):
assert stats['created'] == 1 assert stats['created'] == 1
def test_fetch_stats_for_today_only_includes_today_when_clocks_spring_forward(notify_db_session): def test_dao_fetch_todays_stats_for_service_only_includes_today_when_clocks_spring_forward(notify_db_session):
template = create_template(service=create_service()) template = create_template(service=create_service())
with freeze_time('2021-03-27T23:59:59'): with freeze_time('2021-03-27T23:59:59'):
# just before midnight yesterday in UTC -- not included # just before midnight yesterday in UTC -- not included
@@ -895,7 +894,7 @@ def test_fetch_stats_for_today_only_includes_today_when_clocks_spring_forward(no
assert not stats.get('temporary-failure') assert not stats.get('temporary-failure')
def test_fetch_stats_for_today_only_includes_today_during_bst(notify_db_session): def test_dao_fetch_todays_stats_for_service_only_includes_today_during_bst(notify_db_session):
template = create_template(service=create_service()) template = create_template(service=create_service())
with freeze_time('2021-03-28T22:59:59'): with freeze_time('2021-03-28T22:59:59'):
# just before midnight BST -- not included # just before midnight BST -- not included
@@ -916,7 +915,7 @@ def test_fetch_stats_for_today_only_includes_today_during_bst(notify_db_session)
assert not stats.get('permanent-failure') assert not stats.get('permanent-failure')
def test_fetch_stats_for_today_only_includes_today_when_clocks_fall_back(notify_db_session): def test_dao_fetch_todays_stats_for_service_only_includes_today_when_clocks_fall_back(notify_db_session):
template = create_template(service=create_service()) template = create_template(service=create_service())
with freeze_time('2021-10-30T22:59:59'): with freeze_time('2021-10-30T22:59:59'):
# just before midnight BST -- not included # just before midnight BST -- not included
@@ -938,7 +937,7 @@ def test_fetch_stats_for_today_only_includes_today_when_clocks_fall_back(notify_
assert not stats.get('permanent-failure') assert not stats.get('permanent-failure')
def test_fetch_stats_for_today_only_includes_during_utc(notify_db_session): def test_dao_fetch_todays_stats_for_service_only_includes_during_utc(notify_db_session):
template = create_template(service=create_service()) template = create_template(service=create_service())
with freeze_time('2021-10-30T12:59:59'): with freeze_time('2021-10-30T12:59:59'):
# just before midnight UTC -- not included # just before midnight UTC -- not included
@@ -960,29 +959,6 @@ def test_fetch_stats_for_today_only_includes_during_utc(notify_db_session):
assert not stats.get('permanent-failure') assert not stats.get('permanent-failure')
@pytest.mark.parametrize('created_at, limit_days, rows_returned', [
('Sunday 8th July 2018 12:00', 7, 0),
('Sunday 8th July 2018 22:59', 7, 0),
('Sunday 1th July 2018 12:00', 10, 0),
('Sunday 8th July 2018 23:00', 7, 1),
('Monday 9th July 2018 09:00', 7, 1),
('Monday 9th July 2018 15:00', 7, 1),
('Monday 16th July 2018 12:00', 7, 1),
('Sunday 8th July 2018 12:00', 10, 1),
])
def test_fetch_stats_should_not_gather_notifications_older_than_7_days(
sample_template, created_at, limit_days, rows_returned
):
# It's monday today. Things made last monday should still show
with freeze_time(created_at):
create_notification(sample_template, )
with freeze_time('Monday 16th July 2018 12:00'):
stats = dao_fetch_stats_for_service(sample_template.service_id, limit_days)
assert len(stats) == rows_returned
def test_dao_fetch_todays_stats_for_all_services_includes_all_services(notify_db_session): def test_dao_fetch_todays_stats_for_all_services_includes_all_services(notify_db_session):
# two services, each with an email and sms notification # two services, each with an email and sms notification
service1 = create_service(service_name='service 1', email_from='service.1') service1 = create_service(service_name='service 1', email_from='service.1')