From fc58547be30f5fe7b09fa8b7c538815b94e458e4 Mon Sep 17 00:00:00 2001 From: Chris Hill-Scott Date: Mon, 16 Mar 2020 17:00:34 +0000 Subject: [PATCH] =?UTF-8?q?Tell=20the=20API=20which=20contact=20list=20a?= =?UTF-8?q?=20job=E2=80=99s=20come=20from?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit So that we can make enhancements to the UI in the future, for example grouping jobs within their associated contact list. --- app/main/views/send.py | 4 ++- app/notify_client/job_api_client.py | 5 ++- app/templates/views/check/ok.html | 1 + tests/app/main/views/test_send.py | 38 ++++++++++++++++++++-- tests/app/notify_client/test_job_client.py | 15 +++++++++ tests/conftest.py | 2 +- 6 files changed, 60 insertions(+), 5 deletions(-) diff --git a/app/main/views/send.py b/app/main/views/send.py index bde1b3a85..7784dd902 100644 --- a/app/main/views/send.py +++ b/app/main/views/send.py @@ -530,6 +530,7 @@ def send_from_contact_list(service_id, template_id, contact_list_id): template_id=template_id, upload_id=contact_list.copy_to_uploads(), original_file_name=contact_list.original_file_name, + contact_list_id=contact_list.id, )) @@ -742,7 +743,8 @@ def start_job(service_id, upload_id): job_api_client.create_job( upload_id, service_id, - scheduled_for=request.form.get('scheduled_for', '') + scheduled_for=request.form.get('scheduled_for', ''), + contact_list_id=request.form.get('contact_list_id', ''), ) session.pop('sender_id', None) diff --git a/app/notify_client/job_api_client.py b/app/notify_client/job_api_client.py index 803bbe26e..f143da94b 100644 --- a/app/notify_client/job_api_client.py +++ b/app/notify_client/job_api_client.py @@ -78,12 +78,15 @@ class JobApiClient(NotifyAdminAPIClient): def has_jobs(self, service_id): return bool(self.get_jobs(service_id)['data']) - def create_job(self, job_id, service_id, scheduled_for=None): + def create_job(self, job_id, service_id, scheduled_for=None, contact_list_id=None): data = {"id": job_id} if scheduled_for: data.update({'scheduled_for': scheduled_for}) + if contact_list_id: + data.update({'contact_list_id': contact_list_id}) + data = _attach_current_user(data) job = self.post(url='/service/{}/job'.format(service_id), data=data) diff --git a/app/templates/views/check/ok.html b/app/templates/views/check/ok.html index 3ec9d2ac9..7554f18c0 100644 --- a/app/templates/views/check/ok.html +++ b/app/templates/views/check/ok.html @@ -37,6 +37,7 @@
+ {% if choose_time_form and template.template_type != 'letter' %} {{ radio_select( choose_time_form.scheduled_for, diff --git a/tests/app/main/views/test_send.py b/tests/app/main/views/test_send.py index 3a4b671ee..f5a582b2b 100644 --- a/tests/app/main/views/test_send.py +++ b/tests/app/main/views/test_send.py @@ -2264,6 +2264,31 @@ def test_upload_csvfile_with_international_validates( assert mock_recipients.call_args[1]['international_sms'] == should_allow_international +def test_job_from_contact_list_knows_where_its_come_from( + client_request, + mocker, + service_one, + mock_get_service_template, + mock_s3_download, + mock_get_users_by_service, + mock_get_service_statistics, + mock_get_job_doesnt_exist, + mock_get_jobs, + mock_s3_set_metadata, + fake_uuid +): + page = client_request.get( + 'main.check_messages', + service_id=service_one['id'], + upload_id=fake_uuid, + template_id=fake_uuid, + contact_list_id=unchanging_fake_uuid, + ) + assert page.select_one( + 'form input[type=hidden][name=contact_list_id]' + )['value'] == str(unchanging_fake_uuid) + + def test_test_message_can_only_be_sent_now( client_request, mocker, @@ -2352,6 +2377,9 @@ def test_send_button_is_correctly_labelled( @pytest.mark.parametrize('when', [ '', '2016-08-25T13:04:21.767198' ]) +@pytest.mark.parametrize('contact_list_id', [ + '', unchanging_fake_uuid, +]) def test_create_job_should_call_api( client_request, mock_create_job, @@ -2361,7 +2389,8 @@ def test_create_job_should_call_api( mock_get_service_data_retention, mocker, fake_uuid, - when + when, + contact_list_id, ): data = mock_get_job(SERVICE_ONE_ID, fake_uuid)['data'] job_id = data['id'] @@ -2382,7 +2411,10 @@ def test_create_job_should_call_api( service_id=SERVICE_ONE_ID, upload_id=job_id, original_file_name=original_file_name, - _data={'scheduled_for': when}, + _data={ + 'scheduled_for': when, + 'contact_list_id': contact_list_id, + }, _follow_redirects=True, _expected_status=200, ) @@ -2393,6 +2425,7 @@ def test_create_job_should_call_api( job_id, SERVICE_ONE_ID, scheduled_for=when, + contact_list_id=str(contact_list_id), ) @@ -4009,6 +4042,7 @@ def test_send_from_contact_list( template_id=fake_uuid, upload_id=new_uuid, original_file_name='EmergencyContactList.xls', + contact_list_id=fake_uuid, _external=True, ) ) diff --git a/tests/app/notify_client/test_job_client.py b/tests/app/notify_client/test_job_client.py index b3bffbbe2..e85f4c4c2 100644 --- a/tests/app/notify_client/test_job_client.py +++ b/tests/app/notify_client/test_job_client.py @@ -50,6 +50,21 @@ def test_client_schedules_job(mocker, fake_uuid): assert mock_post.call_args[1]['data']['scheduled_for'] == when +def test_client_links_job_to_contact_list(mocker, fake_uuid): + + mocker.patch('app.notify_client.current_user', id='1') + + contact_list_id = uuid.uuid4() + + mock_post = mocker.patch('app.notify_client.job_api_client.JobApiClient.post') + + JobApiClient().create_job( + fake_uuid, 1, contact_list_id=contact_list_id + ) + + assert mock_post.call_args[1]['data']['contact_list_id'] == contact_list_id + + def test_client_gets_job_by_service_and_job(mocker): service_id = 'service_id' job_id = 'job_id' diff --git a/tests/conftest.py b/tests/conftest.py index c4360c140..123437186 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1638,7 +1638,7 @@ def mock_check_verify_code_code_expired(mocker): @pytest.fixture(scope='function') def mock_create_job(mocker, api_user_active): - def _create(job_id, service_id, scheduled_for=None): + def _create(job_id, service_id, scheduled_for=None, contact_list_id=None): return job_json( service_id, api_user_active,