Merge branch 'master' into populate-monthly-letter-usages

tests/app/celery/test_ftp_update_tasks.py

@@ -116,8 +116,8 @@ def test_update_letter_notifications_statuses_persisted(notify_api, mocker, samp
     assert failed_letter.billable_units == 2
     assert failed_letter.updated_at
 
-    calls = [call([str(failed_letter.id)], queue="notify-internal-tasks"),
-             call([str(sent_letter.id)], queue="notify-internal-tasks")]
+    calls = [call([str(failed_letter.id)], queue="service-callbacks"),
+             call([str(sent_letter.id)], queue="service-callbacks")]
     send_mock.assert_has_calls(calls, any_order=True)
 
 

tests/app/celery/test_letters_pdf_tasks.py

@@ -0,0 +1,137 @@
+import pytest
+import requests_mock
+
+from botocore.exceptions import ClientError
+from celery.exceptions import MaxRetriesExceededError
+from requests import RequestException
+from sqlalchemy.orm.exc import NoResultFound
+
+from app.celery.letters_pdf_tasks import (
+    create_letters_pdf,
+    get_letters_pdf,
+)
+from app.models import Notification
+
+from tests.conftest import set_config_values
+
+
+def test_should_have_decorated_tasks_functions():
+    assert create_letters_pdf.__wrapped__.__name__ == 'create_letters_pdf'
+
+
+@pytest.mark.parametrize('personalisation', [{'name': 'test'}, None])
+def test_get_letters_pdf_calls_notifications_template_preview_service_correctly(
+        notify_api, mocker, client, sample_letter_template, personalisation):
+    contact_block = 'Mr Foo,\n1 Test Street,\nLondon\nN1'
+    dvla_org_id = '002'
+
+    with set_config_values(notify_api, {
+        'TEMPLATE_PREVIEW_API_HOST': 'http://localhost/notifications-template-preview',
+        'TEMPLATE_PREVIEW_API_KEY': 'test-key'
+    }):
+        with requests_mock.Mocker() as request_mock:
+            mock_post = request_mock.post(
+                'http://localhost/notifications-template-preview/print.pdf', content=b'\x00\x01', status_code=200)
+
+            get_letters_pdf(
+                sample_letter_template, contact_block=contact_block, org_id=dvla_org_id, values=personalisation)
+
+    assert mock_post.last_request.json() == {
+        'values': personalisation,
+        'letter_contact_block': contact_block,
+        'dvla_org_id': dvla_org_id,
+        'template': {
+            'subject': sample_letter_template.subject,
+            'content': sample_letter_template.content
+        }
+    }
+
+
+@pytest.mark.parametrize('page_count,expected_billable_units', [
+    ('1', 1),
+    ('2', 1),
+    ('3', 2)
+])
+def test_get_letters_pdf_calculates_billing_units(
+        notify_api, mocker, client, sample_letter_template, page_count, expected_billable_units):
+    contact_block = 'Mr Foo,\n1 Test Street,\nLondon\nN1'
+    dvla_org_id = '002'
+
+    with set_config_values(notify_api, {
+        'TEMPLATE_PREVIEW_API_HOST': 'http://localhost/notifications-template-preview',
+        'TEMPLATE_PREVIEW_API_KEY': 'test-key'
+    }):
+        with requests_mock.Mocker() as request_mock:
+            request_mock.post(
+                'http://localhost/notifications-template-preview/print.pdf',
+                content=b'\x00\x01',
+                headers={'X-pdf-page-count': page_count},
+                status_code=200
+            )
+
+            _, billable_units = get_letters_pdf(
+                sample_letter_template, contact_block=contact_block, org_id=dvla_org_id, values=None)
+
+    assert billable_units == expected_billable_units
+
+
+def test_create_letters_pdf_calls_upload_letters_pdf(mocker, sample_letter_notification):
+    mocker.patch('app.celery.letters_pdf_tasks.get_letters_pdf', return_value=(b'\x00\x01', '1'))
+    mock_s3 = mocker.patch('app.celery.tasks.s3.upload_letters_pdf')
+
+    create_letters_pdf(sample_letter_notification.id)
+
+    mock_s3.assert_called_with(
+        reference=sample_letter_notification.reference,
+        crown=sample_letter_notification.service.crown,
+        filedata=b'\x00\x01'
+    )
+
+
+def test_create_letters_pdf_sets_billable_units(mocker, sample_letter_notification):
+    mocker.patch('app.celery.letters_pdf_tasks.get_letters_pdf', return_value=(b'\x00\x01', 1))
+    mocker.patch('app.celery.tasks.s3.upload_letters_pdf')
+
+    create_letters_pdf(sample_letter_notification.id)
+    noti = Notification.query.filter(Notification.reference == sample_letter_notification.reference).one()
+    assert noti.billable_units == 1
+
+
+def test_create_letters_pdf_non_existent_notification(notify_api, mocker, fake_uuid):
+    with pytest.raises(expected_exception=NoResultFound):
+        create_letters_pdf(fake_uuid)
+
+
+def test_create_letters_pdf_handles_request_errors(mocker, sample_letter_notification):
+    mock_get_letters_pdf = mocker.patch('app.celery.letters_pdf_tasks.get_letters_pdf', side_effect=RequestException)
+    mock_retry = mocker.patch('app.celery.letters_pdf_tasks.create_letters_pdf.retry')
+
+    create_letters_pdf(sample_letter_notification.id)
+
+    assert mock_get_letters_pdf.called
+    assert mock_retry.called
+
+
+def test_create_letters_pdf_handles_s3_errors(mocker, sample_letter_notification):
+    mocker.patch('app.celery.letters_pdf_tasks.get_letters_pdf', return_value=(b'\x00\x01', 1))
+    mock_s3 = mocker.patch('app.celery.tasks.s3.upload_letters_pdf', side_effect=ClientError({}, 'operation_name'))
+    mock_retry = mocker.patch('app.celery.letters_pdf_tasks.create_letters_pdf.retry')
+
+    create_letters_pdf(sample_letter_notification.id)
+
+    assert mock_s3.called
+    assert mock_retry.called
+
+
+def test_create_letters_pdf_sets_technical_failure_max_retries(mocker, sample_letter_notification):
+    mock_get_letters_pdf = mocker.patch('app.celery.letters_pdf_tasks.get_letters_pdf', side_effect=RequestException)
+    mock_retry = mocker.patch(
+        'app.celery.letters_pdf_tasks.create_letters_pdf.retry', side_effect=MaxRetriesExceededError)
+    mock_update_noti = mocker.patch('app.celery.letters_pdf_tasks.update_notification_status_by_id')
+
+    create_letters_pdf(sample_letter_notification.id)
+
+    assert mock_get_letters_pdf.called
+    assert mock_retry.called
+    assert mock_update_noti.called
+    mock_update_noti.assert_called_once_with(sample_letter_notification.id, 'technical-failure')

tests/app/celery/test_service_callback_tasks.py

@@ -55,7 +55,7 @@ def test_send_delivery_status_to_service_post_https_request_to_service(notify_db
         "to": notification.to,
         "status": notification.status,
         "created_at": datestr.strftime(DATETIME_FORMAT),  # the time GOV.UK email sent the request
-        "updated_at": datestr.strftime(DATETIME_FORMAT),  # the last time the status was updated
+        "completed_at": datestr.strftime(DATETIME_FORMAT),  # the last time the status was updated
         "sent_at": datestr.strftime(DATETIME_FORMAT),  # the time the email was sent
         "notification_type": notification_type
     }

tests/app/celery/test_tasks.py

@@ -20,6 +20,7 @@ from app.celery.scheduled_tasks import check_job_status
 from app.celery.tasks import (
     build_dvla_file,
     create_dvla_file_contents_for_job,
+    job_complete,
     process_job,
     process_row,
     save_sms,
@@ -32,7 +33,7 @@ from app.celery.tasks import (
     send_inbound_sms_to_service,
 )
 from app.config import QueueNames
-from app.dao import jobs_dao, services_dao
+from app.dao import jobs_dao, services_dao, service_permissions_dao
 from app.models import (
     Job,
     Notification,
@@ -1039,6 +1040,85 @@ def test_save_letter_saves_letter_to_database(mocker, notify_db_session):
     assert notification_db.reply_to_text == "Address contact"
 
 
+def test_save_letter_calls_update_noti_to_sent_task_with_letters_as_pdf_permission_in_research_mode(
+        mocker, notify_db_session, sample_letter_job):
+    sample_letter_job.service.research_mode = True
+    service_permissions_dao.dao_add_service_permission(sample_letter_job.service.id, 'letters_as_pdf')
+    mock_update_letter_noti_sent = mocker.patch(
+        'app.celery.tasks.update_letter_notifications_to_sent_to_dvla.apply_async')
+    mocker.patch('app.celery.tasks.create_random_identifier', return_value="this-is-random-in-real-life")
+
+    personalisation = {
+        'addressline1': 'Foo',
+        'addressline2': 'Bar',
+        'postcode': 'Flob',
+    }
+    notification_json = _notification_json(
+        template=sample_letter_job.template,
+        to='Foo',
+        personalisation=personalisation,
+        job_id=sample_letter_job.id,
+        row_number=1
+    )
+    notification_id = uuid.uuid4()
+
+    save_letter(
+        sample_letter_job.service_id,
+        notification_id,
+        encryption.encrypt(notification_json),
+    )
+
+    assert mock_update_letter_noti_sent.called
+    mock_update_letter_noti_sent.assert_called_once_with(
+        kwargs={'notification_references': ['this-is-random-in-real-life']},
+        queue=QueueNames.RESEARCH_MODE
+    )
+
+
+def test_save_letter_calls_create_letters_pdf_task_with_letters_as_pdf_permission_and_not_in_research(
+        mocker, notify_db_session, sample_letter_job):
+    service_permissions_dao.dao_add_service_permission(sample_letter_job.service.id, 'letters_as_pdf')
+    mock_create_letters_pdf = mocker.patch('app.celery.letters_pdf_tasks.create_letters_pdf.apply_async')
+
+    personalisation = {
+        'addressline1': 'Foo',
+        'addressline2': 'Bar',
+        'postcode': 'Flob',
+    }
+    notification_json = _notification_json(
+        template=sample_letter_job.template,
+        to='Foo',
+        personalisation=personalisation,
+        job_id=sample_letter_job.id,
+        row_number=1
+    )
+    notification_id = uuid.uuid4()
+
+    save_letter(
+        sample_letter_job.service_id,
+        notification_id,
+        encryption.encrypt(notification_json),
+    )
+
+    assert mock_create_letters_pdf.called
+    mock_create_letters_pdf.assert_called_once_with(
+        [str(notification_id)],
+        queue=QueueNames.CREATE_LETTERS_PDF
+    )
+
+
+def test_job_complete_does_not_call_build_dvla_file_with_letters_as_pdf_permission(
+        mocker, notify_db_session, sample_letter_job):
+    service_permissions_dao.dao_add_service_permission(sample_letter_job.service.id, 'letters_as_pdf')
+    mock_build_dvla_files = mocker.patch('app.celery.tasks.build_dvla_file.apply_async')
+
+    job_complete(sample_letter_job, sample_letter_job.service, sample_letter_job.template.template_type)
+
+    assert not sample_letter_job.service.research_mode
+    assert not mock_build_dvla_files.called
+    assert sample_letter_job.job_status == JOB_STATUS_FINISHED
+
+
 def test_should_cancel_job_if_service_is_inactive(sample_service,
                                                   sample_job,
                                                   mocker):
@@ -1436,7 +1516,6 @@ def test_process_incomplete_job_email(mocker, sample_email_template):
 
 
 def test_process_incomplete_job_letter(mocker, sample_letter_template):
-
     mocker.patch('app.celery.tasks.s3.get_job_from_s3', return_value=load_example_csv('multiple_letter'))
     mock_letter_saver = mocker.patch('app.celery.tasks.save_letter.apply_async')
     mock_build_dvla = mocker.patch('app.celery.tasks.build_dvla_file.apply_async')