Merge pull request #656 from alphagov/add-cancel-job-endpoint

Add an endpoint to cancel a job

tests/app/conftest.py

@@ -1,5 +1,5 @@
 import uuid
-from datetime import (datetime, date)
+from datetime import (datetime, date, timedelta)
 
 import requests_mock
 import pytest
@@ -287,6 +287,22 @@ def sample_job_with_placeholdered_template(
     )
 
 
+@pytest.fixture(scope='function')
+def sample_scheduled_job(
+    notify_db,
+    notify_db_session,
+    service=None
+):
+    return sample_job(
+        notify_db,
+        notify_db_session,
+        service=service,
+        template=sample_template_with_placeholders(notify_db, notify_db_session),
+        scheduled_for=(datetime.utcnow() + timedelta(minutes=60)).isoformat(),
+        job_status='scheduled'
+    )
+
+
 @pytest.fixture(scope='function')
 def sample_email_job(notify_db,
                      notify_db_session,

tests/app/dao/test_jobs_dao.py

@@ -7,6 +7,7 @@ from app.dao.jobs_dao import (
     dao_update_job,
     dao_get_jobs_by_service_id,
     dao_get_scheduled_jobs,
+    dao_get_future_scheduled_job_by_id_and_service_id,
     dao_get_notification_outcomes_for_job
 )
 
@@ -246,8 +247,11 @@ def test_get_scheduled_jobs_gets_ignores_jobs_not_scheduled(notify_db, notify_db
     assert jobs[0].id == job_scheduled.id
 
 
-def test_get_scheduled_jobs_gets_ignores_jobs_scheduled_in_the_future(notify_db, notify_db_session):
-    one_minute_in_the_future = datetime.utcnow() + timedelta(minutes=1)
-    sample_job(notify_db, notify_db_session, scheduled_for=one_minute_in_the_future, job_status='scheduled')
+def test_get_scheduled_jobs_gets_ignores_jobs_scheduled_in_the_future(sample_scheduled_job):
     jobs = dao_get_scheduled_jobs()
     assert len(jobs) == 0
+
+
+def test_get_future_scheduled_job_gets_a_job_yet_to_send(sample_scheduled_job):
+    result = dao_get_future_scheduled_job_by_id_and_service_id(sample_scheduled_job.id, sample_scheduled_job.service_id)
+    assert result.id == sample_scheduled_job.id

tests/app/job/test_rest.py

@@ -109,6 +109,31 @@ def test_get_job_by_id(notify_api, sample_job):
             assert resp_json['data']['created_by']['name'] == 'Test User'
 
 
+def test_cancel_job(notify_api, sample_scheduled_job):
+    job_id = str(sample_scheduled_job.id)
+    service_id = sample_scheduled_job.service.id
+    with notify_api.test_request_context(), notify_api.test_client() as client:
+        path = '/service/{}/job/{}/cancel'.format(service_id, job_id)
+        auth_header = create_authorization_header(service_id=service_id)
+        response = client.post(path, headers=[auth_header])
+        assert response.status_code == 200
+        resp_json = json.loads(response.get_data(as_text=True))
+        assert resp_json['data']['id'] == job_id
+        assert resp_json['data']['job_status'] == 'cancelled'
+
+
+def test_cant_cancel_normal_job(notify_api, sample_job, mocker):
+    job_id = str(sample_job.id)
+    service_id = sample_job.service.id
+    with notify_api.test_request_context(), notify_api.test_client() as client:
+        mock_update = mocker.patch('app.dao.jobs_dao.dao_update_job')
+        path = '/service/{}/job/{}/cancel'.format(service_id, job_id)
+        auth_header = create_authorization_header(service_id=service_id)
+        response = client.post(path, headers=[auth_header])
+        assert response.status_code == 404
+        assert mock_update.call_count == 0
+
+
 def test_create_unscheduled_job(notify_api, sample_template, mocker, fake_uuid):
     with notify_api.test_request_context():
         with notify_api.test_client() as client: