from datetime import date, datetime, timedelta from decimal import Decimal import pytest from freezegun import freeze_time from app import db from app.dao.fact_billing_dao import ( delete_billing_data_for_service_for_day, fetch_billing_data_for_day, fetch_billing_totals_for_year, fetch_daily_sms_provider_volumes_for_platform, fetch_daily_volumes_for_platform, fetch_monthly_billing_for_year, fetch_sms_billing_for_all_services, fetch_sms_free_allowance_remainder_until_date, fetch_usage_year_for_organization, fetch_volumes_by_service, get_rate, get_rates_for_billing, query_organization_sms_usage_for_year, ) from app.dao.organization_dao import dao_add_service_to_organization from app.models import NOTIFICATION_STATUS_TYPES, FactBilling from tests.app.db import ( create_annual_billing, create_ft_billing, create_notification, create_notification_history, create_organization, create_rate, create_service, create_service_data_retention, create_template, set_up_usage_data, ) def set_up_yearly_data(): service = create_service() sms_template = create_template(service=service, template_type="sms") email_template = create_template(service=service, template_type="email") # use different rates for adjacent financial years to make sure the query # doesn't accidentally bleed over into them for dt in (date(2015, 12, 31), date(2017, 1, 1)): create_ft_billing(local_date=dt, template=sms_template, rate=0.163) create_ft_billing(local_date=dt, template=email_template, rate=0, billable_unit=0) # a selection of dates that represent the extreme ends of the financial year # and some arbitrary dates in between for dt in (date(2016, 1, 1), date(2016, 1, 31), date(2016, 12, 6), date(2016, 12, 31)): create_ft_billing(local_date=dt, template=sms_template, rate=0.162) create_ft_billing(local_date=dt, template=email_template, rate=0, billable_unit=0) return service def set_up_yearly_data_variable_rates(): service = create_service() sms_template = create_template(service=service, template_type="sms") create_ft_billing(local_date='2018-05-16', template=sms_template, rate=0.162) create_ft_billing(local_date='2018-05-17', template=sms_template, rate_multiplier=2, rate=0.0150, billable_unit=2) create_ft_billing(local_date='2018-05-16', template=sms_template, rate_multiplier=2, rate=0.162, billable_unit=2) return service def test_fetch_billing_data_for_today_includes_data_with_the_right_key_type(notify_db_session): service = create_service() template = create_template(service=service, template_type="email") for key_type in ['normal', 'test', 'team']: create_notification(template=template, status='delivered', key_type=key_type) today = datetime.utcnow() results = fetch_billing_data_for_day(today.date()) assert len(results) == 1 assert results[0].notifications_sent == 2 @pytest.mark.parametrize("notification_type", ["email", "sms"]) def test_fetch_billing_data_for_day_only_calls_query_for_permission_type(notify_db_session, notification_type): service = create_service(service_permissions=[notification_type]) email_template = create_template(service=service, template_type="email") sms_template = create_template(service=service, template_type="sms") create_notification(template=email_template, status='delivered') create_notification(template=sms_template, status='delivered') today = datetime.utcnow() results = fetch_billing_data_for_day(process_day=today.date(), check_permissions=True) assert len(results) == 1 @pytest.mark.parametrize("notification_type", ["email", "sms"]) def test_fetch_billing_data_for_day_only_calls_query_for_all_channels(notify_db_session, notification_type): service = create_service(service_permissions=[notification_type]) email_template = create_template(service=service, template_type="email") sms_template = create_template(service=service, template_type="sms") create_notification(template=email_template, status='delivered') create_notification(template=sms_template, status='delivered') today = datetime.utcnow() results = fetch_billing_data_for_day(process_day=today.date(), check_permissions=False) assert len(results) == 2 @freeze_time('2018-04-02 01:20:00') def test_fetch_billing_data_for_today_includes_data_with_the_right_date(notify_db_session): process_day = datetime(2018, 4, 1, 13, 30, 0) service = create_service() template = create_template(service=service, template_type="email") create_notification(template=template, status='delivered', created_at=process_day) create_notification(template=template, status='delivered', created_at=datetime(2018, 4, 1, 4, 23, 23)) create_notification(template=template, status='delivered', created_at=datetime(2018, 4, 1, 0, 23, 23)) create_notification(template=template, status='sending', created_at=process_day + timedelta(days=1)) day_under_test = process_day results = fetch_billing_data_for_day(day_under_test.date()) assert len(results) == 1 assert results[0].notifications_sent == 3 def test_fetch_billing_data_for_day_is_grouped_by_template_and_notification_type(notify_db_session): service = create_service() email_template = create_template(service=service, template_type="email") sms_template = create_template(service=service, template_type="sms") create_notification(template=email_template, status='delivered') create_notification(template=sms_template, status='delivered') today = datetime.utcnow() results = fetch_billing_data_for_day(today.date()) assert len(results) == 2 assert results[0].notifications_sent == 1 assert results[1].notifications_sent == 1 def test_fetch_billing_data_for_day_is_grouped_by_service(notify_db_session): service_1 = create_service() service_2 = create_service(service_name='Service 2') email_template = create_template(service=service_1) sms_template = create_template(service=service_2) create_notification(template=email_template, status='delivered') create_notification(template=sms_template, status='delivered') today = datetime.utcnow() results = fetch_billing_data_for_day(today.date()) assert len(results) == 2 assert results[0].notifications_sent == 1 assert results[1].notifications_sent == 1 def test_fetch_billing_data_for_day_is_grouped_by_provider(notify_db_session): service = create_service() template = create_template(service=service) create_notification(template=template, status='delivered', sent_by='sns') create_notification(template=template, status='delivered', sent_by='sns') today = datetime.utcnow() results = fetch_billing_data_for_day(today.date()) assert len(results) == 1 assert results[0].notifications_sent == 2 # assert results[1].notifications_sent == 1 def test_fetch_billing_data_for_day_is_grouped_by_rate_mulitplier(notify_db_session): service = create_service() template = create_template(service=service) create_notification(template=template, status='delivered', rate_multiplier=1) create_notification(template=template, status='delivered', rate_multiplier=2) today = datetime.utcnow() results = fetch_billing_data_for_day(today.date()) assert len(results) == 2 assert results[0].notifications_sent == 1 assert results[1].notifications_sent == 1 def test_fetch_billing_data_for_day_is_grouped_by_international(notify_db_session): service = create_service() sms_template = create_template(service=service) create_notification(template=sms_template, status='delivered', international=True) create_notification(template=sms_template, status='delivered', international=False) today = datetime.utcnow() results = fetch_billing_data_for_day(today.date()) assert len(results) == 2 assert all(result.notifications_sent == 1 for result in results) def test_fetch_billing_data_for_day_is_grouped_by_notification_type(notify_db_session): service = create_service() sms_template = create_template(service=service, template_type='sms') email_template = create_template(service=service, template_type='email') create_notification(template=sms_template, status='delivered') create_notification(template=sms_template, status='delivered') create_notification(template=sms_template, status='delivered') create_notification(template=email_template, status='delivered') create_notification(template=email_template, status='delivered') today = datetime.utcnow() results = fetch_billing_data_for_day(today.date()) assert len(results) == 2 notification_types = [x.notification_type for x in results] assert len(notification_types) == 2 def test_fetch_billing_data_for_day_returns_empty_list(notify_db_session): today = datetime.utcnow() results = fetch_billing_data_for_day(today.date()) assert results == [] def test_fetch_billing_data_for_day_uses_correct_table(notify_db_session): service = create_service() create_service_data_retention(service, notification_type='email', days_of_retention=3) sms_template = create_template(service=service, template_type='sms') email_template = create_template(service=service, template_type='email') five_days_ago = datetime.utcnow() - timedelta(days=5) create_notification(template=sms_template, status='delivered', created_at=five_days_ago) create_notification_history(template=email_template, status='delivered', created_at=five_days_ago) results = fetch_billing_data_for_day(process_day=five_days_ago.date(), service_id=service.id) assert len(results) == 2 assert results[0].notification_type == 'sms' assert results[0].notifications_sent == 1 assert results[1].notification_type == 'email' assert results[1].notifications_sent == 1 def test_fetch_billing_data_for_day_returns_list_for_given_service(notify_db_session): service = create_service() service_2 = create_service(service_name='Service 2') template = create_template(service=service) template_2 = create_template(service=service_2) create_notification(template=template, status='delivered') create_notification(template=template_2, status='delivered') today = datetime.utcnow() results = fetch_billing_data_for_day(process_day=today.date(), service_id=service.id) assert len(results) == 1 assert results[0].service_id == service.id def test_fetch_billing_data_for_day_bills_correctly_for_status(notify_db_session): service = create_service() sms_template = create_template(service=service, template_type='sms') email_template = create_template(service=service, template_type='email') for status in NOTIFICATION_STATUS_TYPES: create_notification(template=sms_template, status=status) create_notification(template=email_template, status=status) today = datetime.utcnow() results = fetch_billing_data_for_day(process_day=today.date(), service_id=service.id) sms_results = [x for x in results if x.notification_type == 'sms'] email_results = [x for x in results if x.notification_type == 'email'] # we expect as many rows as we check for notification types assert 6 == sms_results[0].notifications_sent assert 4 == email_results[0].notifications_sent def test_get_rates_for_billing(notify_db_session): create_rate(start_date=datetime.utcnow(), value=12, notification_type='email') create_rate(start_date=datetime.utcnow(), value=22, notification_type='sms') create_rate(start_date=datetime.utcnow(), value=33, notification_type='email') rates = get_rates_for_billing() assert len(rates) == 3 @freeze_time('2017-06-01 12:00') def test_get_rate(notify_db_session): create_rate(start_date=datetime(2017, 5, 30, 23, 0), value=1.2, notification_type='email') create_rate(start_date=datetime(2017, 5, 30, 23, 0), value=2.2, notification_type='sms') create_rate(start_date=datetime(2017, 5, 30, 23, 0), value=3.3, notification_type='email') rates = get_rates_for_billing() rate = get_rate(rates, notification_type='sms', date=date(2017, 6, 1)) assert rate == 2.2 @pytest.mark.parametrize("date,expected_rate", [(datetime(2018, 9, 30), 1.2), (datetime(2018, 10, 1), 2.2)]) def test_get_rate_chooses_right_rate_depending_on_date(notify_db_session, date, expected_rate): create_rate(start_date=datetime(2016, 1, 1, 0, 0), value=1.2, notification_type='sms') create_rate(start_date=datetime(2018, 9, 30, 23, 0), value=2.2, notification_type='sms') rates = get_rates_for_billing() rate = get_rate(rates, "sms", date) assert rate == expected_rate def test_fetch_monthly_billing_for_year(notify_db_session): service = set_up_yearly_data() create_annual_billing(service_id=service.id, free_sms_fragment_limit=1, financial_year_start=2016) results = fetch_monthly_billing_for_year(service.id, 2016) assert len(results) == 4 # 3 billed months for each type print(f"RESULTS {results}") assert str(results[0].month) == "2016-01-01" assert results[0].notification_type == 'email' assert results[0].notifications_sent == 2 assert results[0].chargeable_units == 0 assert results[0].rate == Decimal('0') assert results[0].cost == Decimal('0') assert results[0].free_allowance_used == 0 assert results[0].charged_units == 0 assert str(results[1].month) == "2016-01-01" assert results[1].notification_type == 'sms' assert results[1].notifications_sent == 2 assert results[1].chargeable_units == 2 assert results[1].rate == Decimal('0.162') # free allowance is 1 assert results[1].cost == Decimal('0.162') assert results[1].free_allowance_used == 1 assert results[1].charged_units == 1 assert str(results[2].month) == "2016-12-01" def test_fetch_monthly_billing_for_year_variable_rates(notify_db_session): service = set_up_yearly_data_variable_rates() create_annual_billing(service_id=service.id, free_sms_fragment_limit=6, financial_year_start=2018) results = fetch_monthly_billing_for_year(service.id, 2018) # Test data is only for the month of May assert len(results) == 2 assert str(results[0].month) == "2018-05-01" assert results[0].notification_type == 'sms' assert results[0].notifications_sent == 1 assert results[0].chargeable_units == 4 assert results[0].rate == Decimal('0.015') # 1 free units on the 17th assert results[0].cost == Decimal('0.045') assert results[0].free_allowance_used == 1 assert results[0].charged_units == 3 assert str(results[1].month) == "2018-05-01" assert results[1].notification_type == 'sms' assert results[1].notifications_sent == 2 assert results[1].chargeable_units == 5 assert results[1].rate == Decimal('0.162') # 5 free units on the 16th assert results[1].cost == Decimal('0') assert results[1].free_allowance_used == 5 assert results[1].charged_units == 0 @freeze_time('2018-08-01 13:30:00') def test_fetch_monthly_billing_for_year_adds_data_for_today(notify_db_session): service = create_service() template = create_template(service=service, template_type="sms") create_rate(start_date=datetime.utcnow() - timedelta(days=1), value=0.158, notification_type='sms') create_annual_billing(service_id=service.id, free_sms_fragment_limit=1000, financial_year_start=2018) for i in range(1, 32): create_ft_billing(local_date='2018-07-{}'.format(i), template=template) create_notification(template=template, status='delivered') assert db.session.query(FactBilling.local_date).count() == 31 results = fetch_monthly_billing_for_year(service_id=service.id, year=2018) assert db.session.query(FactBilling.local_date).count() == 32 assert len(results) == 2 def test_fetch_billing_totals_for_year(notify_db_session): service = set_up_yearly_data() create_annual_billing(service_id=service.id, free_sms_fragment_limit=1000, financial_year_start=2016) results = fetch_billing_totals_for_year(service_id=service.id, year=2016) assert len(results) == 2 assert results[0].notification_type == 'email' assert results[0].notifications_sent == 4 assert results[0].chargeable_units == 0 assert results[0].rate == Decimal('0') assert results[0].cost == Decimal('0') assert results[0].free_allowance_used == 0 assert results[0].charged_units == 0 assert results[1].notification_type == 'sms' assert results[1].notifications_sent == 4 assert results[1].chargeable_units == 4 assert results[1].rate == Decimal('0.162') assert results[1].cost == Decimal('0') assert results[1].free_allowance_used == 4 assert results[1].charged_units == 0 def test_fetch_billing_totals_for_year_uses_current_annual_billing(notify_db_session): service = set_up_yearly_data() create_annual_billing(service_id=service.id, free_sms_fragment_limit=400, financial_year_start=2016) create_annual_billing(service_id=service.id, free_sms_fragment_limit=0, financial_year_start=2017) result = next( result for result in fetch_billing_totals_for_year(service_id=service.id, year=2016) if result.notification_type == 'sms' ) assert result.chargeable_units == 4 # No charge for 2016 because we have free sms fragments. # There would be a charge for 2017, # but we are only billing for 2016 so cost is zero assert result.cost == 0 def test_fetch_billing_totals_for_year_variable_rates(notify_db_session): service = set_up_yearly_data_variable_rates() create_annual_billing(service_id=service.id, free_sms_fragment_limit=6, financial_year_start=2018) results = fetch_billing_totals_for_year(service_id=service.id, year=2018) assert len(results) == 2 assert results[0].notification_type == 'sms' assert results[0].notifications_sent == 1 assert results[0].chargeable_units == 4 assert results[0].rate == Decimal('0.015') # 1 free unit on the 17th assert results[0].cost == Decimal('0.045') assert results[0].free_allowance_used == 1 assert results[0].charged_units == 3 assert results[1].notification_type == 'sms' assert results[1].notifications_sent == 2 assert results[1].chargeable_units == 5 assert results[1].rate == Decimal('0.162') # 5 free units on the 16th assert results[1].cost == Decimal('0') assert results[1].free_allowance_used == 5 assert results[1].charged_units == 0 def test_delete_billing_data(notify_db_session): service_1 = create_service(service_name='1') service_2 = create_service(service_name='2') sms_template = create_template(service_1, 'sms') email_template = create_template(service_1, 'email') other_service_template = create_template(service_2, 'sms') existing_rows_to_delete = [ # noqa create_ft_billing('2018-01-01', sms_template, billable_unit=1), create_ft_billing('2018-01-01', email_template, billable_unit=2) ] other_day = create_ft_billing('2018-01-02', sms_template, billable_unit=3) other_service = create_ft_billing('2018-01-01', other_service_template, billable_unit=4) delete_billing_data_for_service_for_day('2018-01-01', service_1.id) current_rows = FactBilling.query.all() assert sorted(x.billable_units for x in current_rows) == sorted( [other_day.billable_units, other_service.billable_units] ) def test_fetch_sms_free_allowance_remainder_until_date_with_two_services(notify_db_session): service = create_service(service_name='has free allowance') template = create_template(service=service) org = create_organization(name="Org for {}".format(service.name)) dao_add_service_to_organization(service=service, organization_id=org.id) create_annual_billing(service_id=service.id, free_sms_fragment_limit=10, financial_year_start=2016) create_ft_billing(template=template, local_date=datetime(2016, 4, 20), billable_unit=2, rate=0.11) create_ft_billing(template=template, local_date=datetime(2016, 5, 20), billable_unit=3, rate=0.11) service_2 = create_service(service_name='used free allowance') template_2 = create_template(service=service_2) org_2 = create_organization(name="Org for {}".format(service_2.name)) dao_add_service_to_organization(service=service_2, organization_id=org_2.id) create_annual_billing(service_id=service_2.id, free_sms_fragment_limit=20, financial_year_start=2016) create_ft_billing(template=template_2, local_date=datetime(2016, 4, 20), billable_unit=12, rate=0.11) create_ft_billing(template=template_2, local_date=datetime(2016, 4, 22), billable_unit=10, rate=0.11) create_ft_billing(template=template_2, local_date=datetime(2016, 5, 20), billable_unit=3, rate=0.11) results = fetch_sms_free_allowance_remainder_until_date(datetime(2016, 5, 1)).all() assert len(results) == 2 service_result = [row for row in results if row[0] == service.id] assert service_result[0] == (service.id, 10, 2, 8) service_2_result = [row for row in results if row[0] == service_2.id] assert service_2_result[0] == (service_2.id, 20, 22, 0) def test_fetch_sms_billing_for_all_services_for_first_quarter(notify_db_session): # This test is useful because the inner query resultset is empty. service = create_service(service_name='a - has free allowance') template = create_template(service=service) org = create_organization(name="Org for {}".format(service.name)) dao_add_service_to_organization(service=service, organization_id=org.id) create_annual_billing(service_id=service.id, free_sms_fragment_limit=25000, financial_year_start=2019) create_ft_billing(template=template, local_date=datetime(2019, 4, 20, 12), billable_unit=44, rate=0.11) results = fetch_sms_billing_for_all_services(datetime(2019, 4, 1, 12), datetime(2019, 5, 30, 12)) assert len(results) == 1 assert results[0] == (org.name, org.id, service.name, service.id, 25000, Decimal('0.11'), 24956, 44, 0, Decimal('0')) def test_fetch_sms_billing_for_all_services_with_remainder(notify_db_session): service_1 = create_service(service_name='a - has free allowance') template = create_template(service=service_1) org = create_organization(name="Org for {}".format(service_1.name)) dao_add_service_to_organization(service=service_1, organization_id=org.id) create_annual_billing(service_id=service_1.id, free_sms_fragment_limit=10, financial_year_start=2019) create_ft_billing(template=template, local_date=datetime(2019, 4, 20), billable_unit=2, rate=0.11) create_ft_billing(template=template, local_date=datetime(2019, 5, 20), billable_unit=2, rate=0.11) create_ft_billing(template=template, local_date=datetime(2019, 5, 22), billable_unit=1, rate=0.11) service_2 = create_service(service_name='b - used free allowance') template_2 = create_template(service=service_2) org_2 = create_organization(name="Org for {}".format(service_2.name)) dao_add_service_to_organization(service=service_2, organization_id=org_2.id) create_annual_billing(service_id=service_2.id, free_sms_fragment_limit=10, financial_year_start=2019) create_ft_billing(template=template_2, local_date=datetime(2019, 4, 20), billable_unit=12, rate=0.11) create_ft_billing(template=template_2, local_date=datetime(2019, 5, 20), billable_unit=3, rate=0.11) service_3 = create_service(service_name='c - partial allowance') template_3 = create_template(service=service_3) org_3 = create_organization(name="Org for {}".format(service_3.name)) dao_add_service_to_organization(service=service_3, organization_id=org_3.id) create_annual_billing(service_id=service_3.id, free_sms_fragment_limit=10, financial_year_start=2019) create_ft_billing(template=template_3, local_date=datetime(2019, 4, 20), billable_unit=5, rate=0.11) create_ft_billing(template=template_3, local_date=datetime(2019, 5, 20), billable_unit=7, rate=0.11) service_4 = create_service(service_name='d - email only') email_template = create_template(service=service_4, template_type='email') org_4 = create_organization(name="Org for {}".format(service_4.name)) dao_add_service_to_organization(service=service_4, organization_id=org_4.id) create_annual_billing(service_id=service_4.id, free_sms_fragment_limit=10, financial_year_start=2019) create_ft_billing(template=email_template, local_date=datetime(2019, 5, 22), notifications_sent=5, billable_unit=0, rate=0) results = fetch_sms_billing_for_all_services(datetime(2019, 5, 1), datetime(2019, 5, 31)) assert len(results) == 3 expected_results = [ # sms_remainder is 5, because "service_1" has 5 sms_billing_units. 2 of them for a period before # the requested report's start date. { "organization_name": org.name, "organization_id": org.id, "service_name": service_1.name, "service_id": service_1.id, "free_sms_fragment_limit": 10, "sms_rate": Decimal('0.11'), "sms_remainder": 5, "sms_billable_units": 3, "chargeable_billable_sms": 0, "sms_cost": Decimal('0.00') }, # sms remainder is 0, because this service sent SMS worth 15 billable units, 12 of which were sent # before requested report's start date { "organization_name": org_2.name, "organization_id": org_2.id, "service_name": service_2.name, "service_id": service_2.id, "free_sms_fragment_limit": 10, "sms_rate": Decimal('0.11'), "sms_remainder": 0, "sms_billable_units": 3, "chargeable_billable_sms": 3, "sms_cost": Decimal('0.33') }, # sms remainder is 0, because this service sent SMS worth 12 billable units, 5 of which were sent # before requested report's start date { "organization_name": org_3.name, "organization_id": org_3.id, "service_name": service_3.name, "service_id": service_3.id, "free_sms_fragment_limit": 10, "sms_rate": Decimal('0.11'), "sms_remainder": 0, "sms_billable_units": 7, "chargeable_billable_sms": 2, "sms_cost": Decimal('0.22') }, ] assert [dict(result) for result in results] == expected_results def test_fetch_sms_billing_for_all_services_without_an_organization_appears(notify_db_session): fixtures = set_up_usage_data(datetime(2019, 5, 1)) results = fetch_sms_billing_for_all_services(datetime(2019, 5, 1), datetime(2019, 5, 31)) assert len(results) == 3 expected_results = [ # sms_remainder is 5, because service_1_sms_and_letter has 5 sms_billing_units. 2 of them for a period before # the requested report's start date. { "organization_name": fixtures["org_1"].name, "organization_id": fixtures["org_1"].id, "service_name": fixtures["service_1_sms_and_letter"].name, "service_id": fixtures["service_1_sms_and_letter"].id, "free_sms_fragment_limit": 10, "sms_rate": Decimal('0.11'), "sms_remainder": 5, "sms_billable_units": 3, "chargeable_billable_sms": 0, "sms_cost": Decimal('0.00') }, # sms remainder is 0, because this service sent SMS worth 15 billable units, 12 of which were sent # before requested report's start date { "organization_name": None, "organization_id": None, "service_name": fixtures["service_with_sms_without_org"].name, "service_id": fixtures["service_with_sms_without_org"].id, "free_sms_fragment_limit": 10, "sms_rate": Decimal('0.11'), "sms_remainder": 0, "sms_billable_units": 3, "chargeable_billable_sms": 3, "sms_cost": Decimal('0.33') }, { "organization_name": None, "organization_id": None, "service_name": fixtures["service_with_sms_within_allowance"].name, "service_id": fixtures["service_with_sms_within_allowance"].id, "free_sms_fragment_limit": 10, "sms_rate": Decimal('0.11'), "sms_remainder": 8, "sms_billable_units": 2, "chargeable_billable_sms": 0, "sms_cost": Decimal('0.00') }, ] assert [dict(result) for result in results] == expected_results @freeze_time('2019-06-01 13:30') def test_fetch_usage_year_for_organization(notify_db_session): fixtures = set_up_usage_data(datetime(2019, 5, 1)) service_with_emails_for_org = create_service(service_name='Service with emails for org') create_annual_billing(service_with_emails_for_org.id, free_sms_fragment_limit=0, financial_year_start=2019) dao_add_service_to_organization( service=service_with_emails_for_org, organization_id=fixtures["org_1"].id ) template = create_template(service=service_with_emails_for_org, template_type='email') create_ft_billing(local_date=datetime(2019, 5, 1), template=template, notifications_sent=1100) results = fetch_usage_year_for_organization(fixtures["org_1"].id, 2019) assert len(results) == 3 first_row = results[str(fixtures["service_1_sms_and_letter"].id)] assert first_row['service_id'] == fixtures["service_1_sms_and_letter"].id assert first_row['service_name'] == fixtures["service_1_sms_and_letter"].name assert first_row['free_sms_limit'] == 10 assert first_row['sms_remainder'] == 5 # because there are 5 billable units assert first_row['chargeable_billable_sms'] == 0 assert first_row['sms_cost'] == 0.0 assert first_row['emails_sent'] == 0 second_row = results[str(service_with_emails_for_org.id)] assert second_row['service_id'] == service_with_emails_for_org.id assert second_row['service_name'] == service_with_emails_for_org.name assert second_row['free_sms_limit'] == 0 assert second_row['sms_remainder'] == 0 assert second_row['chargeable_billable_sms'] == 0 assert second_row['sms_cost'] == 0 assert second_row['emails_sent'] == 1100 third_row = results[str(fixtures["service_with_out_ft_billing_this_year"].id)] assert third_row['service_id'] == fixtures["service_with_out_ft_billing_this_year"].id assert third_row['service_name'] == fixtures["service_with_out_ft_billing_this_year"].name assert third_row['free_sms_limit'] == 10 assert third_row['sms_remainder'] == 10 assert third_row['chargeable_billable_sms'] == 0 assert third_row['sms_cost'] == 0 assert third_row['emails_sent'] == 0 def test_fetch_usage_year_for_organization_populates_ft_billing_for_today(notify_db_session): create_rate(start_date=datetime.utcnow() - timedelta(days=1), value=0.65, notification_type='sms') new_org = create_organization(name='New organization') service = create_service() template = create_template(service=service) dao_add_service_to_organization(service=service, organization_id=new_org.id) current_year = datetime.utcnow().year create_annual_billing(service_id=service.id, free_sms_fragment_limit=10, financial_year_start=current_year) assert FactBilling.query.count() == 0 create_notification(template=template, status='delivered') results = fetch_usage_year_for_organization(organization_id=new_org.id, year=current_year) assert len(results) == 1 assert FactBilling.query.count() == 1 @freeze_time('2022-05-01 13:30') def test_fetch_usage_year_for_organization_calculates_cost_from_multiple_rates(notify_db_session): old_rate_date = date(2022, 4, 29) new_rate_date = date(2022, 5, 1) current_year = datetime.utcnow().year org = create_organization(name='Organization 1') service_1 = create_service(restricted=False, service_name="Service 1") dao_add_service_to_organization(service=service_1, organization_id=org.id) sms_template_1 = create_template(service=service_1) create_ft_billing( local_date=old_rate_date, template=sms_template_1, rate=2, billable_unit=4, notifications_sent=4 ) create_ft_billing( local_date=new_rate_date, template=sms_template_1, rate=3, billable_unit=2, notifications_sent=2 ) create_annual_billing(service_id=service_1.id, free_sms_fragment_limit=3, financial_year_start=current_year) results = fetch_usage_year_for_organization(organization_id=org.id, year=current_year) assert len(results) == 1 assert results[str(service_1.id)]['free_sms_limit'] == 3 assert results[str(service_1.id)]['sms_remainder'] == 0 assert results[str(service_1.id)]['sms_billable_units'] == 6 assert results[str(service_1.id)]['chargeable_billable_sms'] == 3 assert results[str(service_1.id)]['sms_cost'] == 8.0 @freeze_time('2022-05-01 13:30') def test_fetch_usage_year_for_organization_when_no_usage(notify_db_session): current_year = datetime.utcnow().year org = create_organization(name='Organization 1') service_1 = create_service(restricted=False, service_name="Service 1") dao_add_service_to_organization(service=service_1, organization_id=org.id) create_annual_billing(service_id=service_1.id, free_sms_fragment_limit=3, financial_year_start=current_year) results = fetch_usage_year_for_organization(organization_id=org.id, year=current_year) assert len(results) == 1 assert results[str(service_1.id)]['free_sms_limit'] == 3 assert results[str(service_1.id)]['sms_remainder'] == 3 assert results[str(service_1.id)]['sms_billable_units'] == 0 assert results[str(service_1.id)]['chargeable_billable_sms'] == 0 assert results[str(service_1.id)]['sms_cost'] == 0.0 @freeze_time('2022-05-01 13:30') def test_fetch_usage_year_for_organization_only_queries_present_year(notify_db_session): current_year = datetime.utcnow().year last_year = current_year - 1 date_two_years_ago = date(2021, 3, 31) date_in_last_financial_year = date(2022, 3, 31) date_in_this_year = datetime.utcnow().date() org = create_organization(name='Organization 1') service_1 = create_service(restricted=False, service_name="Service 1") dao_add_service_to_organization(service=service_1, organization_id=org.id) sms_template_1 = create_template(service=service_1) create_ft_billing( local_date=date_two_years_ago, template=sms_template_1, rate=1, billable_unit=2, notifications_sent=2 ) create_ft_billing( local_date=date_in_last_financial_year, template=sms_template_1, rate=1, billable_unit=4, notifications_sent=4 ) create_ft_billing( local_date=date_in_this_year, template=sms_template_1, rate=1, billable_unit=8, notifications_sent=8 ) create_annual_billing(service_id=service_1.id, free_sms_fragment_limit=4, financial_year_start=last_year - 1) create_annual_billing(service_id=service_1.id, free_sms_fragment_limit=0, financial_year_start=last_year) create_annual_billing(service_id=service_1.id, free_sms_fragment_limit=8, financial_year_start=current_year) results = fetch_usage_year_for_organization(organization_id=org.id, year=last_year) assert len(results) == 1 assert results[str(service_1.id)]['sms_billable_units'] == 2 assert results[str(service_1.id)]['chargeable_billable_sms'] == 2 assert results[str(service_1.id)]['sms_cost'] == 2.0 @freeze_time('2020-02-27 13:30') def test_fetch_usage_year_for_organization_only_returns_data_for_live_services(notify_db_session): org = create_organization(name='Organization without live services') live_service = create_service(restricted=False) sms_template = create_template(service=live_service) trial_service = create_service(restricted=True, service_name='trial_service') email_template = create_template(service=trial_service, template_type='email') trial_sms_template = create_template(service=trial_service, template_type='sms') dao_add_service_to_organization(service=live_service, organization_id=org.id) dao_add_service_to_organization(service=trial_service, organization_id=org.id) create_ft_billing(local_date=datetime.utcnow().date(), template=sms_template, rate=0.0158, billable_unit=19, notifications_sent=19) create_ft_billing(local_date=datetime.utcnow().date(), template=email_template, billable_unit=0, notifications_sent=100) create_ft_billing(local_date=datetime.utcnow().date(), template=trial_sms_template, billable_unit=200, rate=0.0158, notifications_sent=100) create_annual_billing(service_id=live_service.id, free_sms_fragment_limit=0, financial_year_start=2020) create_annual_billing(service_id=trial_service.id, free_sms_fragment_limit=0, financial_year_start=2020) results = fetch_usage_year_for_organization(organization_id=org.id, year=2020) assert len(results) == 1 assert results[str(live_service.id)]['sms_billable_units'] == 19 assert results[str(live_service.id)]['emails_sent'] == 0 @freeze_time('2022-04-27 13:30') def test_query_organization_sms_usage_for_year_handles_multiple_services(notify_db_session): today = datetime.utcnow().date() yesterday = datetime.utcnow().date() - timedelta(days=1) current_year = datetime.utcnow().year org = create_organization(name='Organization 1') service_1 = create_service(restricted=False, service_name="Service 1") dao_add_service_to_organization(service=service_1, organization_id=org.id) sms_template_1 = create_template(service=service_1) create_ft_billing( local_date=yesterday, template=sms_template_1, rate=1, billable_unit=4, notifications_sent=4 ) create_ft_billing( local_date=today, template=sms_template_1, rate=1, billable_unit=2, notifications_sent=2 ) create_annual_billing(service_id=service_1.id, free_sms_fragment_limit=5, financial_year_start=current_year) service_2 = create_service(restricted=False, service_name="Service 2") dao_add_service_to_organization(service=service_2, organization_id=org.id) sms_template_2 = create_template(service=service_2) create_ft_billing( local_date=yesterday, template=sms_template_2, rate=1, billable_unit=16, notifications_sent=16 ) create_ft_billing( local_date=today, template=sms_template_2, rate=1, billable_unit=8, notifications_sent=8 ) create_annual_billing(service_id=service_2.id, free_sms_fragment_limit=10, financial_year_start=current_year) # ---------- result = query_organization_sms_usage_for_year(org.id, 2022).all() service_1_rows = [row for row in result if row.service_id == service_1.id] service_2_rows = [row for row in result if row.service_id == service_2.id] assert len(service_1_rows) == 2 assert len(service_2_rows) == 2 # service 1 has allowance of 5 # four fragments in total, all are used assert service_1_rows[0]['local_date'] == date(2022, 4, 26) assert service_1_rows[0]['chargeable_units'] == 4 assert service_1_rows[0]['charged_units'] == 0 # two in total - one is free, one is charged assert service_1_rows[1]['local_date'] == date(2022, 4, 27) assert service_1_rows[1]['chargeable_units'] == 2 assert service_1_rows[1]['charged_units'] == 1 # service 2 has allowance of 10 # sixteen fragments total, allowance is used and six are charged assert service_2_rows[0]['local_date'] == date(2022, 4, 26) assert service_2_rows[0]['chargeable_units'] == 16 assert service_2_rows[0]['charged_units'] == 6 # eight fragments total, all are charged assert service_2_rows[1]['local_date'] == date(2022, 4, 27) assert service_2_rows[1]['chargeable_units'] == 8 assert service_2_rows[1]['charged_units'] == 8 # assert total costs are accurate assert float(sum(row.cost for row in service_1_rows)) == 1 # rows with 2 and 4, allowance of 5 assert float(sum(row.cost for row in service_2_rows)) == 14 # rows with 8 and 16, allowance of 10 @freeze_time('2022-05-01 13:30') def test_query_organization_sms_usage_for_year_handles_multiple_rates(notify_db_session): old_rate_date = date(2022, 4, 29) new_rate_date = date(2022, 5, 1) current_year = datetime.utcnow().year org = create_organization(name='Organization 1') service_1 = create_service(restricted=False, service_name="Service 1") dao_add_service_to_organization(service=service_1, organization_id=org.id) sms_template_1 = create_template(service=service_1) create_ft_billing( local_date=old_rate_date, template=sms_template_1, rate=2, billable_unit=4, notifications_sent=4 ) create_ft_billing( local_date=new_rate_date, template=sms_template_1, rate=3, billable_unit=2, notifications_sent=2 ) create_annual_billing(service_id=service_1.id, free_sms_fragment_limit=3, financial_year_start=current_year) result = query_organization_sms_usage_for_year(org.id, 2022).all() # al lthe free allowance is used on the first day assert result[0]['local_date'] == date(2022, 4, 29) assert result[0]['charged_units'] == 1 assert result[0]['cost'] == 2 assert result[1]['local_date'] == date(2022, 5, 1) assert result[1]['charged_units'] == 2 assert result[1]['cost'] == 6 def test_fetch_daily_volumes_for_platform( notify_db_session, sample_template, sample_email_template ): create_ft_billing(local_date='2022-02-03', template=sample_template, notifications_sent=10, billable_unit=10) create_ft_billing(local_date='2022-02-03', template=sample_template, notifications_sent=10, billable_unit=30, international=True) create_ft_billing(local_date='2022-02-03', template=sample_email_template, notifications_sent=10) create_ft_billing(local_date='2022-02-04', template=sample_template, notifications_sent=20, billable_unit=40) create_ft_billing(local_date='2022-02-04', template=sample_template, notifications_sent=10, billable_unit=20, rate_multiplier=3) create_ft_billing(local_date='2022-02-04', template=sample_email_template, notifications_sent=50) results = fetch_daily_volumes_for_platform(start_date='2022-02-03', end_date='2022-02-04') assert len(results) == 2 assert results[0].local_date == '2022-02-03' assert results[0].sms_totals == 20 assert results[0].sms_fragment_totals == 40 assert results[0].sms_chargeable_units == 40 assert results[0].email_totals == 10 assert results[1].local_date == '2022-02-04' assert results[1].sms_totals == 30 assert results[1].sms_fragment_totals == 60 assert results[1].sms_chargeable_units == 100 assert results[1].email_totals == 50 def test_fetch_daily_sms_provider_volumes_for_platform_groups_values_by_provider( notify_db_session, ): services = [ create_service(service_name='a'), create_service(service_name='b') ] templates = [ create_template(services[0]), create_template(services[1]) ] create_ft_billing('2022-02-01', templates[0], provider='foo', notifications_sent=1, billable_unit=2) create_ft_billing('2022-02-01', templates[1], provider='foo', notifications_sent=4, billable_unit=8) create_ft_billing('2022-02-01', templates[0], provider='bar', notifications_sent=16, billable_unit=32) create_ft_billing('2022-02-01', templates[1], provider='bar', notifications_sent=64, billable_unit=128) results = fetch_daily_sms_provider_volumes_for_platform(start_date='2022-02-01', end_date='2022-02-01') assert len(results) == 2 assert results[0].provider == 'bar' assert results[0].sms_totals == 80 assert results[0].sms_fragment_totals == 160 assert results[1].provider == 'foo' assert results[1].sms_totals == 5 assert results[1].sms_fragment_totals == 10 def test_fetch_daily_sms_provider_volumes_for_platform_for_platform_calculates_chargeable_units_and_costs( sample_template, ): create_ft_billing('2022-02-01', sample_template, rate_multiplier=3, rate=1.5, notifications_sent=1, billable_unit=2) results = fetch_daily_sms_provider_volumes_for_platform(start_date='2022-02-01', end_date='2022-02-01') assert len(results) == 1 assert results[0].sms_totals == 1 assert results[0].sms_fragment_totals == 2 assert results[0].sms_chargeable_units == 6 assert results[0].sms_cost == 9 def test_fetch_daily_sms_provider_volumes_for_platform_for_platform_searches_dates_inclusively(sample_template): # too early create_ft_billing('2022-02-02', sample_template) # just right create_ft_billing('2022-02-03', sample_template) create_ft_billing('2022-02-04', sample_template) create_ft_billing('2022-02-05', sample_template) # too late create_ft_billing('2022-02-06', sample_template) results = fetch_daily_sms_provider_volumes_for_platform(start_date='2022-02-03', end_date='2022-02-05') assert len(results) == 3 assert results[0].local_date == date(2022, 2, 3) assert results[-1].local_date == date(2022, 2, 5) def test_fetch_daily_sms_provider_volumes_for_platform_for_platform_only_returns_sms( sample_template, sample_email_template, ): create_ft_billing('2022-02-01', sample_template, notifications_sent=1) create_ft_billing('2022-02-01', sample_email_template, notifications_sent=2) results = fetch_daily_sms_provider_volumes_for_platform(start_date='2022-02-01', end_date='2022-02-01') assert len(results) == 1 assert results[0].sms_totals == 1 def test_fetch_volumes_by_service(notify_db_session): set_up_usage_data(datetime(2022, 2, 1)) results = fetch_volumes_by_service(start_date=datetime(2022, 2, 1), end_date=datetime(2022, 2, 28)) # since we are using a pre-set up fixture, we only care about some of the results assert len(results) == 5 assert results[0].service_name == 'a - with sms and letter' assert results[0].organization_name == 'Org for a - with sms and letter' assert results[0].free_allowance == 10 assert results[0].sms_notifications == 2 assert results[0].sms_chargeable_units == 3 assert results[0].email_totals == 0 assert results[1].service_name == 'f - without ft_billing' assert results[1].organization_name == 'Org for a - with sms and letter' assert results[1].free_allowance == 10 assert results[1].sms_notifications == 0 assert results[1].sms_chargeable_units == 0 assert results[1].email_totals == 0 assert results[3].service_name == 'b - chargeable sms' assert not results[3].organization_name assert results[3].free_allowance == 10 assert results[3].sms_notifications == 2 assert results[3].sms_chargeable_units == 3 assert results[3].email_totals == 0 assert results[4].service_name == 'e - sms within allowance' assert not results[4].organization_name assert results[4].free_allowance == 10 assert results[4].sms_notifications == 1 assert results[4].sms_chargeable_units == 2 assert results[4].email_totals == 0