darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-05-07 01:28:26 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #901 from alphagov/update-the-notification-with-dvla-id

Browse Source 
Added the random string reference to the letter
This commit is contained in:
minglis
2017-04-18 15:12:55 +01:00
committed by GitHub
parent f0811ca55e 81f0942f57
commit 2d4bcde0a8
8 changed files with 35 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
app/__init__.py
View File

@@ -1,4 +1,6 @@
import os
import random
import string
import uuid
from flask import Flask, _request_ctx_stack
@@ -204,6 +206,10 @@ def create_uuid():
return str(uuid.uuid4())
def create_random_identifier():
return ''.join(random.choice(string.ascii_letters + string.digits) for _ in range(16))
def process_user_agent(user_agent_string):
if user_agent_string and user_agent_string.lower().startswith("notify"):
components = user_agent_string.split("/")

10
app/celery/tasks.py
View File

@@ -10,6 +10,7 @@ from notifications_utils.template import SMSMessageTemplate, WithSubjectTemplate
from sqlalchemy.exc import SQLAlchemyError
from app import (
create_uuid,
create_random_identifier,
DATETIME_FORMAT,
notify_celery,
encryption
@@ -262,7 +263,8 @@ def persist_letter(
created_at=created_at,
job_id=notification['job'],
job_row_number=notification['row_number'],
notification_id=notification_id
notification_id=notification_id,
reference=create_random_identifier()
)
current_app.logger.info("Letter {} created at {}".format(saved_notification.id, created_at))
@@ -311,10 +313,8 @@ def create_dvla_file_contents(job_id):
str(LetterDVLATemplate(
notification.template.__dict__,
notification.personalisation,
# This unique id is a 7 digits requested by DVLA, not known
# if this number needs to be sequential.
numeric_id=random.randint(1, int('9' * 7)),
contact_block=notification.service.letter_contact_block,
notification_reference=notification.reference,
contact_block=notification.service.letter_contact_block
))
for notification in dao_get_all_notifications_for_job(job_id)
)

2
app/dao/jobs_dao.py
View File

@@ -43,7 +43,7 @@ def all_notifications_are_created_for_job(job_id):
@statsd(namespace="dao")
def dao_get_all_notifications_for_job(job_id):
return db.session.query(Notification).filter(Notification.job_id == job_id).all()
return db.session.query(Notification).filter(Notification.job_id == job_id).order_by(Notification.created_at).all()
def dao_get_job_by_service_id_and_job_id(service_id, job_id):

4
app/notifications/process_notifications.py
View File

@@ -36,6 +36,7 @@ def persist_notification(template_id,
job_id=None,
job_row_number=None,
reference=None,
client_reference=None,
notification_id=None,
simulated=False):
# if simulated create a Notification model to return but do not persist the Notification to the dB
@@ -53,7 +54,8 @@ def persist_notification(template_id,
created_at=created_at or datetime.utcnow(),
job_id=job_id,
job_row_number=job_row_number,
client_reference=reference
client_reference=client_reference,
reference=reference
)
if not simulated:
dao_create_notification(notification)

2
app/v2/notifications/post_notifications.py
View File

@@ -47,7 +47,7 @@ def post_notification(notification_type):
notification_type=notification_type,
api_key_id=api_user.id,
key_type=api_user.key_type,
reference=form.get('reference', None),
client_reference=form.get('reference', None),
simulated=simulated)
if not simulated:
queue_name = 'priority' if template.process_type == PRIORITY else None

2
requirements.txt
View File

@@ -29,6 +29,6 @@ notifications-python-client>=3.1,<3.2
awscli>=1.11,<1.12
awscli-cwlogs>=1.4,<1.5
git+https://github.com/alphagov/notifications-utils.git@15.1.2#egg=notifications-utils==15.1.2
git+https://github.com/alphagov/notifications-utils.git@15.2.1#egg=notifications-utils==15.2.1
git+https://github.com/alphagov/boto.git@2.43.0-patch3#egg=boto==2.43.0-patch3

27
tests/app/celery/test_tasks.py
View File

@@ -907,6 +907,9 @@ def test_send_sms_does_not_send_duplicate_and_does_not_put_in_retry_queue(sample
def test_persist_letter_saves_letter_to_database(sample_letter_job, mocker):
mocker.patch('app.celery.tasks.create_random_identifier', return_value="this-is-random-in-real-life")
personalisation = {
'addressline1': 'Foo',
'addressline2': 'Bar',
@@ -945,6 +948,7 @@ def test_persist_letter_saves_letter_to_database(sample_letter_job, mocker):
assert notification_db.sent_at is None
assert notification_db.sent_by is None
assert notification_db.personalisation == personalisation
assert notification_db.reference == "this-is-random-in-real-life"
def test_should_cancel_job_if_service_is_inactive(sample_service,
@@ -1013,24 +1017,27 @@ def test_build_dvla_file_retries_if_all_notifications_are_not_created(sample_let
def test_create_dvla_file_contents(sample_letter_template, mocker):
mocker.patch("app.celery.tasks.random.randint", return_value=999)
job = create_job(template=sample_letter_template, notification_count=2)
create_notification(template=job.template, job=job)
create_notification(template=job.template, job=job)
create_notification(template=job.template, job=job, reference=1)
create_notification(template=job.template, job=job, reference=2)
mocked_letter_template = mocker.patch("app.celery.tasks.LetterDVLATemplate")
mocked_letter_template_instance = mocked_letter_template.return_value
mocked_letter_template_instance.__str__.return_value = "dvla|string"
create_dvla_file_contents(job.id)
calls = mocked_letter_template.call_args_list
# Template
assert mocked_letter_template.call_args[0][0]['subject'] == 'Template subject'
assert mocked_letter_template.call_args[0][0]['content'] == 'Dear Sir/Madam, Hello. Yours Truly, The Government.'
assert calls[0][0][0]['subject'] == 'Template subject'
assert calls[0][0][0]['content'] == 'Dear Sir/Madam, Hello. Yours Truly, The Government.'
# Personalisation
assert mocked_letter_template.call_args[0][1] is None
assert not calls[0][0][1]
assert not calls[1][0][1]
# Named arguments
assert mocked_letter_template.call_args[1]['numeric_id'] == 999
assert mocked_letter_template.call_args[1]['contact_block'] == 'London,\nSW1A 1AA'
assert calls[1][1]['contact_block'] == 'London,\nSW1A 1AA'
assert calls[0][1]['notification_reference'] == '1'
assert calls[1][1]['notification_reference'] == '2'
@freeze_time("2017-03-23 11:09:00.061258")
@@ -1039,8 +1046,8 @@ def test_dvla_letter_template(sample_letter_notification):
"subject": sample_letter_notification.template.subject}
letter = LetterDVLATemplate(t,
sample_letter_notification.personalisation,
12345)
assert str(letter) == "140|500|001||201703230012345|||||||||||||A1||A2|A3|A4|A5|A6|A_POST|||||||||23 March 2017<cr><cr><h1>Template subject<normal><cr><cr>Dear Sir/Madam, Hello. Yours Truly, The Government.<cr><cr>" # noqa
"random-string")
assert str(letter) == "140|500|001||random-string|||||||||||||A1||A2|A3|A4|A5|A6|A_POST|||||||||23 March 2017<cr><cr><h1>Template subject<normal><cr><cr>Dear Sir/Madam, Hello. Yours Truly, The Government.<cr><cr>" # noqa
def test_update_job_to_sent_to_dvla(sample_letter_template, sample_letter_job):

2
tests/app/notifications/test_process_notification.py
View File

@@ -179,7 +179,7 @@ def test_persist_notification_with_optionals(sample_job, sample_api_key, mocker)
created_at=created_at,
job_id=sample_job.id,
job_row_number=10,
reference="ref from client",
client_reference="ref from client",
notification_id=n_id)
assert Notification.query.count() == 1
assert NotificationHistory.query.count() == 1