Merge pull request #4206 from alphagov/daily-sms-vols-reports

add new daily sms provider volumes report

tests/app/main/views/test_platform_admin.py

@@ -854,14 +854,14 @@ def test_get_live_services_report(
     )
     report = response.get_data(as_text=True)
     assert report.strip() == (
-        'Service ID,Organisation,Organisation type,Service name,Consent to research,Main contact,Contact email,'
-        + 'Contact mobile,Live date,SMS volume intent,Email volume intent,Letter volume intent,SMS sent this year,'
-        + 'Emails sent this year,Letters sent this year,Free sms allowance\r\n'
+        'Service ID,Organisation,Organisation type,Service name,Consent to research,Main contact,Contact email,' +
+        'Contact mobile,Live date,SMS volume intent,Email volume intent,Letter volume intent,SMS sent this year,' +
+        'Emails sent this year,Letters sent this year,Free sms allowance\r\n' +
 
-        + '1,Forest,Ecosystem,jessie the oak tree,True,Forest fairy,forest.fairy@digital.cabinet-office.gov.uk,'
-        + '+447700900986,29-03-2014,100,50,20,300,1200,0,100\r\n'
+        '1,Forest,Ecosystem,jessie the oak tree,True,Forest fairy,forest.fairy@digital.cabinet-office.gov.uk,' +
+        '+447700900986,29-03-2014,100,50,20,300,1200,0,100\r\n' +
 
-        + '2,Forest,Ecosystem,james the pine tree,,,,,,,60,0,0,0,0,200'
+        '2,Forest,Ecosystem,james the pine tree,,,,,,,60,0,0,0,0,200'
     )
 
 
@@ -920,7 +920,7 @@ def test_get_billing_report_when_no_results_for_date(client_request, platform_ad
     assert normalize_spaces(error.text) == 'No results for dates'
 
 
-def test_get_billing_report_when_calls_api_and_download_data(
+def test_get_billing_report_calls_api_and_download_data(
     client_request,
     platform_admin_user,
     mocker
@@ -957,10 +957,9 @@ def test_get_billing_report_when_calls_api_and_download_data(
     )
 
     assert response.get_data(as_text=True) == (
-        'organisation_id,organisation_name,service_id,service_name,sms_cost,sms_chargeable_units' +
-        ',total_letters,letter_cost,letter_breakdown,purchase_order_number,contact_names,contact_email_addresses' +
-
-        ',billing_reference\r\n' +
+        'organisation_id,organisation_name,service_id,service_name,sms_cost,sms_chargeable_units,' +
+        'total_letters,letter_cost,letter_breakdown,purchase_order_number,contact_names,contact_email_addresses,' +
+        'billing_reference\r\n' +
 
         '7832a1be-a1f0-4f2a-982f-05adfd3d6354,' +
         'Org for a - with sms and letter,' +
@@ -973,7 +972,7 @@ def test_get_billing_report_when_calls_api_and_download_data(
         '"6 second class letters at 45p' +
         '\n' +
         '2 first class letters at 35p",' +
-        'PO1234,"Anne, Marie, Josh","billing@example.com, accounts@example.com",Notify2020'
+        'PO1234,"Anne, Marie, Josh","billing@example.com, accounts@example.com",Notify2020' +
 
         '\r\n'
     )
@@ -1008,15 +1007,16 @@ def test_get_notifications_sent_by_service_calls_api_and_downloads_data(
         'attachment; filename="{} to {} notification status per service report.csv"'.format(start_date, end_date)
     )
     assert response.get_data(as_text=True) == (
-        'date_created,service_id,service_name,notification_type,count_sending,count_delivered,count_technical_failure,'
-        'count_temporary_failure,count_permanent_failure,count_sent\r\n'
-        '2019-01-01,596364a0-858e-42c8-9062-a8fe822260eb,service one,email,191,0,0,14,0,0\r\n'
-        '2019-01-01,596364a0-858e-42c8-9062-a8fe822260eb,service one,sms,42,0,0,8,0,0\r\n'
+        'date_created,service_id,service_name,notification_type,count_sending,count_delivered,' +
+        'count_technical_failure,count_temporary_failure,count_permanent_failure,count_sent\r\n' +
+
+        '2019-01-01,596364a0-858e-42c8-9062-a8fe822260eb,service one,email,191,0,0,14,0,0\r\n' +
+        '2019-01-01,596364a0-858e-42c8-9062-a8fe822260eb,service one,sms,42,0,0,8,0,0\r\n' +
         '2019-01-01,147ad62a-2951-4fa1-9ca0-093cd1a52c52,service two,email,3,1,0,2,0,0\r\n'
     )
 
 
-def test_get_volumes_by_service_report_when_calls_api_and_download_data(
+def test_get_volumes_by_service_report_calls_api_and_download_data(
     client_request,
     platform_admin_user,
     mocker
@@ -1064,13 +1064,13 @@ def test_get_volumes_by_service_report_when_calls_api_and_download_data(
         '8,' +
         '10,' +
         '4.5,' +
-        '10'
+        '10' +
 
         '\r\n'
     )
 
 
-def test_get_daily_volumes_report_when_calls_api_and_download_data(
+def test_get_daily_volumes_report_calls_api_and_download_data(
     client_request,
     platform_admin_user,
     mocker
@@ -1109,7 +1109,50 @@ def test_get_daily_volumes_report_when_calls_api_and_download_data(
         '60,' +
         '100,' +
         '10,' +
-        '20'
+        '20' +
+
+        '\r\n'
+    )
+
+
+def test_get_daily_sms_provider_volumes_report_calls_api_and_download_data(
+    client_request,
+    platform_admin_user,
+    mocker
+):
+    mocker.patch(
+        "app.main.views.platform_admin.billing_api_client.get_data_for_daily_sms_provider_volumes_report",
+        return_value=[{
+            "day": '2019-01-01',
+            "provider": 'foo',
+            "sms_totals": 20,
+            "sms_fragment_totals": 40,
+            "sms_chargeable_units": 60,
+            "sms_cost": 80,
+        }]
+    )
+
+    client_request.login(platform_admin_user)
+    response = client_request.post_response(
+        'main.get_daily_sms_provider_volumes',
+        _data={'start_date': '2019-01-01', 'end_date': '2019-03-31'},
+        _expected_status=200,
+    )
+
+    assert response.content_type == 'text/csv; charset=utf-8'
+    assert response.headers['Content-Disposition'] == (
+        'attachment; filename="Daily SMS provider volumes report from {} to {}.csv"'.format('2019-01-01', '2019-03-31')
+    )
+
+    assert response.get_data(as_text=True) == (
+        "day,provider,sms totals,sms fragment totals,sms chargeable units,sms cost\r\n" +
+
+        '2019-01-01,' +
+        'foo,' +
+        '20,' +
+        '40,' +
+        '60,' +
+        '80' +
 
         '\r\n'
     )

tests/app/notify_client/test_billing_client.py

@@ -1,5 +1,7 @@
 import uuid
 
+import pytest
+
 from app.notify_client.billing_api_client import BillingAPIClient
 
 
@@ -43,19 +45,18 @@ def test_post_free_sms_fragment_limit_for_year_endpoint(mocker, api_user_active)
     )
 
 
-def test_get_data_for_volumes_by_service_report(mocker, api_user_active):
+@pytest.mark.parametrize('func, expected_url', [
+    (BillingAPIClient.get_data_for_volumes_by_service_report, '/platform-stats/volumes-by-service'),
+    (BillingAPIClient.get_data_for_daily_volumes_report, '/platform-stats/daily-volumes-report'),
+    (
+        BillingAPIClient.get_data_for_daily_sms_provider_volumes_report,
+        '/platform-stats/daily-sms-provider-volumes-report'
+    ),
+])
+def test_get_data_for_volume_reports(mocker, api_user_active, func, expected_url):
     mock_get = mocker.patch('app.notify_client.billing_api_client.BillingAPIClient.get')
     client = BillingAPIClient()
 
-    client.get_data_for_volumes_by_service_report('2022-03-01', '2022-03-31')
-    mock_get.assert_called_once_with(url='/platform-stats/volumes-by-service',
-                                     params={'start_date': '2022-03-01', 'end_date': '2022-03-31'})
+    func(client, '2022-03-01', '2022-03-31')
 
-
-def test_get_data_for_daily_volumes_report(mocker, api_user_active):
-    mock_get = mocker.patch('app.notify_client.billing_api_client.BillingAPIClient.get')
-    client = BillingAPIClient()
-
-    client.get_data_for_daily_volumes_report('2022-03-01', '2022-03-31')
-    mock_get.assert_called_once_with(url='/platform-stats/daily-volumes-report',
-                                     params={'start_date': '2022-03-01', 'end_date': '2022-03-31'})
+    mock_get.assert_called_once_with(url=expected_url, params={'start_date': '2022-03-01', 'end_date': '2022-03-31'})

tests/app/test_navigation.py

@@ -131,6 +131,7 @@ EXCLUDED_ENDPOINTS = tuple(map(Navigation.get_endpoint_with_blueprint, {
     'forgot_password',
     'get_billing_report',
     'get_daily_volumes',
+    'get_daily_sms_provider_volumes',
     'get_volumes_by_service',
     'get_example_csv',
     'get_notifications_as_json',