Merge pull request #2759 from alphagov/delete-contact-list

Add an endpoint to delete a contact list

tests/app/dao/test_service_contact_list_dao.py

@@ -4,6 +4,11 @@ from tests.app.db import create_service_contact_list
 
 def test_dao_get_contact_lists(notify_db_session):
     contact_list = create_service_contact_list()
+    create_service_contact_list(
+        service=contact_list.service,
+        archived=True,
+    )
+
     fetched_list = dao_get_contact_lists(contact_list.service_id)
 
     assert len(fetched_list) == 1

tests/app/db.py

@@ -384,7 +384,8 @@ def create_job(
         processing_started=None,
         processing_finished=None,
         original_file_name='some.csv',
-        archived=False
+        archived=False,
+        contact_list_id=None,
 ):
     data = {
         'id': uuid.uuid4(),
@@ -400,7 +401,8 @@ def create_job(
         'scheduled_for': scheduled_for,
         'processing_started': processing_started,
         'processing_finished': processing_finished,
-        'archived': archived
+        'archived': archived,
+        'contact_list_id': contact_list_id,
     }
     job = Job(**data)
     dao_create_job(job)
@@ -974,7 +976,8 @@ def create_service_contact_list(
     original_file_name='EmergencyContactList.xls',
     row_count=100,
     template_type='email',
-    created_by_id=None
+    created_by_id=None,
+    archived=False,
 ):
     if not service:
         service = create_service(service_name='service for contact list', user=create_user())
@@ -986,6 +989,7 @@ def create_service_contact_list(
         template_type=template_type,
         created_by_id=created_by_id or service.users[0].id,
         created_at=datetime.utcnow(),
+        archived=archived,
     )
     db.session.add(contact_list)
     db.session.commit()

tests/app/job/test_rest.py

@@ -238,12 +238,21 @@ def test_create_scheduled_job(client, sample_template, mocker, fake_uuid):
     assert resp_json['data']['notification_count'] == 1
 
 
-def test_create_job_with_contact_list_id(client, mocker, sample_template, fake_uuid):
+@pytest.mark.parametrize('contact_list_archived', (
+    True, False,
+))
+def test_create_job_with_contact_list_id(
+    client,
+    mocker,
+    sample_template,
+    fake_uuid,
+    contact_list_archived,
+):
     mocker.patch('app.celery.tasks.process_job.apply_async')
     mocker.patch('app.job.rest.get_job_metadata_from_s3', return_value={
         'template_id': str(sample_template.id)
     })
-    contact_list = create_service_contact_list()
+    contact_list = create_service_contact_list(archived=contact_list_archived)
     data = {
         'id': fake_uuid,
         'valid': 'True',

tests/app/service/test_service_contact_list_rest.py

@@ -1,7 +1,12 @@
 import uuid
 
 from app.models import ServiceContactList
-from tests.app.db import create_service_contact_list, create_service
+from tests.app.db import (
+    create_job,
+    create_service_contact_list,
+    create_service,
+    create_template,
+)
 
 
 def test_create_service_contact_list(sample_service, admin_request):
@@ -70,6 +75,7 @@ def test_get_contact_list_returns_for_service(admin_request, notify_db_session):
     expected_list_2 = create_service_contact_list(service=service_1)
     # not included in results
     create_service_contact_list(service=service_2)
+    create_service_contact_list(service=service_1, archived=True)
 
     response = admin_request.get(
         'service.get_contact_list',
@@ -96,6 +102,16 @@ def test_dao_get_contact_list_by_id(admin_request, sample_service):
     assert response == expected_list_1.serialize()
 
 
+def test_dao_get_archived_contact_list_by_id(admin_request):
+    contact_list = create_service_contact_list(archived=True)
+    admin_request.get(
+        'service.get_contact_list_by_id',
+        service_id=contact_list.service.id,
+        contact_list_id=contact_list.id,
+        _expected_status=404,
+    )
+
+
 def test_dao_get_contact_list_by_id_does_not_return_if_contact_list_id_for_another_service(
     admin_request, sample_service
 ):
@@ -113,3 +129,79 @@ def test_dao_get_contact_list_by_id_does_not_return_if_contact_list_id_for_anoth
     )
 
     assert response['message'] == "No result found"
+
+
+def test_archive_contact_list_by_id(mocker, admin_request, sample_service):
+    mock_s3 = mocker.patch('app.service.rest.s3.remove_contact_list_from_s3')
+    service_1 = create_service(service_name='Service under test')
+    template_1 = create_template(service=service_1)
+    expected_list = create_service_contact_list(service=service_1)
+    other_list = create_service_contact_list(service=service_1)
+
+    # Job linked to the contact list we’re deleting
+    job_1 = create_job(template=template_1, contact_list_id=expected_list.id)
+    # Other jobs and lists shouldn’t be affected
+    job_2 = create_job(template=template_1, contact_list_id=other_list.id)
+    job_3 = create_job(template=template_1)
+
+    admin_request.delete(
+        'service.delete_contact_list_by_id',
+        service_id=service_1.id,
+        contact_list_id=expected_list.id,
+    )
+
+    assert job_1.contact_list_id == expected_list.id
+    assert expected_list.archived is True
+
+    assert job_2.contact_list_id == other_list.id
+    assert other_list.archived is False
+
+    assert job_3.contact_list_id is None
+
+    mock_s3.assert_called_once_with(
+        expected_list.service.id,
+        expected_list.id,
+    )
+
+
+def test_archive_contact_list_when_unused(mocker, admin_request, sample_service):
+    mock_s3 = mocker.patch('app.service.rest.s3.remove_contact_list_from_s3')
+    service = create_service(service_name='Service under test')
+    expected_list = create_service_contact_list(service=service)
+
+    assert ServiceContactList.query.count() == 1
+
+    admin_request.delete(
+        'service.delete_contact_list_by_id',
+        service_id=service.id,
+        contact_list_id=expected_list.id
+    )
+
+    assert ServiceContactList.query.count() == 1
+    assert expected_list.archived is True
+
+    mock_s3.assert_called_once_with(
+        expected_list.service.id,
+        expected_list.id,
+    )
+
+
+def test_archive_contact_list_by_id_for_different_service(mocker, admin_request, sample_service):
+
+    mock_s3 = mocker.patch('app.service.rest.s3.remove_contact_list_from_s3')
+
+    service_1 = create_service(service_name='Service under test')
+    service_2 = create_service(service_name='Other service')
+
+    contact_list = create_service_contact_list(service=service_1)
+    assert ServiceContactList.query.count() == 1
+
+    admin_request.delete(
+        'service.delete_contact_list_by_id',
+        service_id=service_2.id,
+        contact_list_id=contact_list.id,
+        _expected_status=404,
+    )
+
+    assert ServiceContactList.query.count() == 1
+    assert mock_s3.called is False