mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-02-22 03:15:07 -05:00
eb3f9aad2a
At the moment, the process for accepting the data sharing and financial agreement is: 1. download a pdf * print it out * get someone to sign it * scan it * email it back to us * we rename the file and save it in Google Drive * we then update the organisation to say the MOU is signed * sometimes we also: * print it out and get it counter-signed * scan it again * email it back to the service Let's not do that any more. When the first service for an organisation that doesn't have the agreement in place is in the process of going live, then they should be able to accept the agreement online as part of the go live flow. This commit adds the pages that let someone do that. Where the checklist shows the agreement as **[not completed]** then they can follow a link where they can download it (as happens now). From here, they should then also be able to provide some info to accept it. The info that we need is: **Version** – because we version the agreements occasionally, we need to know which version they are accepting. It may not be the latest one if they downloaded it a while ago and it took time to be signed off **Who is accepting the agreement** – this will often be someone in the finance team, and not necessarily a team member, so we should let the person either accept as themselves, or on behalf of someone else. If it's on behalf of someone else we need to the name and email address of that person so we have that on record. Obvs if it's them accepting it themselves, we have that already (so we just store their user ID and not their name or email address). We then replay the collected info back in a sort of legally binding kind of way pulling in the organisation name too. The wording we’re using is inspired by what GOV.UK Pay have. Then there’s a big green button they can click to accept the agreement, which stores their user ID and and timestamp.
582 lines
18 KiB
Python
582 lines
18 KiB
Python
import uuid
|
|
from datetime import datetime, timedelta, timezone
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
from flask import url_for
|
|
from flask.testing import FlaskClient
|
|
from flask_login import login_user
|
|
|
|
from app.models.user import User
|
|
|
|
|
|
class TestClient(FlaskClient):
|
|
def login(self, user, mocker=None, service=None):
|
|
# Skipping authentication here and just log them in
|
|
model_user = User(user)
|
|
with self.session_transaction() as session:
|
|
session['current_session_id'] = model_user.current_session_id
|
|
session['user_id'] = model_user.id
|
|
if mocker:
|
|
mocker.patch('app.user_api_client.get_user', return_value=user)
|
|
if mocker and service:
|
|
with self.session_transaction() as session:
|
|
session['service_id'] = service['id']
|
|
mocker.patch('app.service_api_client.get_service', return_value={'data': service})
|
|
|
|
with patch('app.events_api_client.create_event'):
|
|
login_user(model_user)
|
|
|
|
def logout(self, user):
|
|
self.get(url_for("main.logout"))
|
|
|
|
|
|
def sample_uuid():
|
|
return "6ce466d0-fd6a-11e5-82f5-e0accb9d11a6"
|
|
|
|
|
|
def generate_uuid():
|
|
return uuid.uuid4()
|
|
|
|
|
|
def created_by_json(id_, name='', email_address=''):
|
|
return {'id': id_, 'name': name, 'email_address': email_address}
|
|
|
|
|
|
def user_json(
|
|
id_='1234',
|
|
name='Test User',
|
|
email_address='test@gov.uk',
|
|
mobile_number='+447700900986',
|
|
password_changed_at=None,
|
|
permissions={generate_uuid(): [
|
|
'view_activity',
|
|
'send_texts',
|
|
'send_emails',
|
|
'send_letters',
|
|
'manage_users',
|
|
'manage_templates',
|
|
'manage_settings',
|
|
'manage_api_keys']
|
|
},
|
|
auth_type='sms_auth',
|
|
failed_login_count=0,
|
|
logged_in_at=None,
|
|
state='active',
|
|
max_failed_login_count=3,
|
|
platform_admin=False,
|
|
current_session_id='1234',
|
|
organisations=[],
|
|
services=None
|
|
|
|
):
|
|
return {
|
|
'id': id_,
|
|
'name': name,
|
|
'email_address': email_address,
|
|
'mobile_number': mobile_number,
|
|
'password_changed_at': password_changed_at,
|
|
'permissions': permissions,
|
|
'auth_type': auth_type,
|
|
'failed_login_count': failed_login_count,
|
|
'logged_in_at': logged_in_at or datetime.utcnow().strftime('%Y-%m-%d %H:%M:%S.%f'),
|
|
'state': state,
|
|
'max_failed_login_count': max_failed_login_count,
|
|
'platform_admin': platform_admin,
|
|
'current_session_id': current_session_id,
|
|
'organisations': organisations,
|
|
'services': list(permissions.keys()) if services is None else services
|
|
}
|
|
|
|
|
|
def invited_user(
|
|
_id='1234',
|
|
service=None,
|
|
from_user='1234',
|
|
email_address='testinviteduser@gov.uk',
|
|
permissions=None,
|
|
status='pending',
|
|
created_at=datetime.utcnow(),
|
|
auth_type='sms_auth',
|
|
organisation=None
|
|
):
|
|
data = {
|
|
'id': _id,
|
|
'from_user': from_user,
|
|
'email_address': email_address,
|
|
'status': status,
|
|
'created_at': created_at,
|
|
'auth_type': auth_type,
|
|
}
|
|
if service:
|
|
data['service'] = service
|
|
if permissions:
|
|
data['permissions'] = permissions
|
|
if organisation:
|
|
data['organisation'] = organisation
|
|
|
|
return data
|
|
|
|
|
|
def service_json(
|
|
id_='1234',
|
|
name='Test Service',
|
|
users=None,
|
|
message_limit=1000,
|
|
active=True,
|
|
restricted=True,
|
|
email_from=None,
|
|
reply_to_email_address=None,
|
|
sms_sender='GOVUK',
|
|
research_mode=False,
|
|
email_branding=None,
|
|
branding='govuk',
|
|
created_at=None,
|
|
letter_contact_block=None,
|
|
inbound_api=None,
|
|
service_callback_api=None,
|
|
permissions=None,
|
|
organisation_type='central',
|
|
prefix_sms=True,
|
|
contact_link=None,
|
|
organisation_id=None,
|
|
):
|
|
if users is None:
|
|
users = []
|
|
if permissions is None:
|
|
permissions = ['email', 'sms']
|
|
if inbound_api is None:
|
|
inbound_api = []
|
|
return {
|
|
'id': id_,
|
|
'name': name,
|
|
'users': users,
|
|
'message_limit': message_limit,
|
|
'active': active,
|
|
'restricted': restricted,
|
|
'email_from': email_from,
|
|
'reply_to_email_address': reply_to_email_address,
|
|
'sms_sender': sms_sender,
|
|
'research_mode': research_mode,
|
|
'organisation_type': organisation_type,
|
|
'email_branding': email_branding,
|
|
'branding': branding,
|
|
'created_at': created_at or str(datetime.utcnow()),
|
|
'letter_branding': None,
|
|
'letter_contact_block': letter_contact_block,
|
|
'permissions': permissions,
|
|
'inbound_api': inbound_api,
|
|
'service_callback_api': service_callback_api,
|
|
'prefix_sms': prefix_sms,
|
|
'contact_link': None,
|
|
'volume_email': 111111,
|
|
'volume_sms': 222222,
|
|
'volume_letter': 333333,
|
|
'consent_to_research': True,
|
|
'count_as_live': True,
|
|
'organisation': organisation_id,
|
|
}
|
|
|
|
|
|
def organisation_json(
|
|
id_='1234',
|
|
name=False,
|
|
users=None,
|
|
active=True,
|
|
created_at=None,
|
|
services=None,
|
|
letter_branding_id=None,
|
|
email_branding_id=None,
|
|
domains=None,
|
|
crown=True,
|
|
agreement_signed=False,
|
|
agreement_signed_version=None,
|
|
agreement_signed_on_behalf_of_name=None,
|
|
agreement_signed_on_behalf_of_email_address=None,
|
|
organisation_type='',
|
|
request_to_go_live_notes=None,
|
|
):
|
|
if users is None:
|
|
users = []
|
|
if services is None:
|
|
services = []
|
|
return {
|
|
'id': id_,
|
|
'name': 'Test Organisation' if name is False else name,
|
|
'active': active,
|
|
'users': users,
|
|
'created_at': created_at or str(datetime.utcnow()),
|
|
'email_branding_id': email_branding_id,
|
|
'letter_branding_id': letter_branding_id,
|
|
'organisation_type': organisation_type,
|
|
'crown': crown,
|
|
'agreement_signed': agreement_signed,
|
|
'agreement_signed_at': None,
|
|
'agreement_signed_by': None,
|
|
'agreement_signed_version': agreement_signed_version,
|
|
'agreement_signed_on_behalf_of_name': agreement_signed_on_behalf_of_name,
|
|
'agreement_signed_on_behalf_of_email_address': agreement_signed_on_behalf_of_email_address,
|
|
'domains': domains or [],
|
|
'request_to_go_live_notes': request_to_go_live_notes,
|
|
'count_of_live_services': len(services),
|
|
}
|
|
|
|
|
|
def template_json(service_id,
|
|
id_,
|
|
name="sample template",
|
|
type_=None,
|
|
content=None,
|
|
subject=None,
|
|
version=1,
|
|
archived=False,
|
|
process_type='normal',
|
|
redact_personalisation=None,
|
|
service_letter_contact=None,
|
|
reply_to=None,
|
|
reply_to_text=None,
|
|
is_precompiled_letter=False,
|
|
postage=None,
|
|
folder=None
|
|
):
|
|
template = {
|
|
'id': id_,
|
|
'name': name,
|
|
'template_type': type_ or "sms",
|
|
'content': content,
|
|
'service': service_id,
|
|
'version': version,
|
|
'updated_at': datetime.utcnow().strftime('%Y-%m-%d %H:%M:%S.%f'),
|
|
'archived': archived,
|
|
'process_type': process_type,
|
|
'service_letter_contact': service_letter_contact,
|
|
'reply_to': reply_to,
|
|
'reply_to_text': reply_to_text,
|
|
'is_precompiled_letter': is_precompiled_letter,
|
|
'folder': folder,
|
|
'postage': postage
|
|
}
|
|
if content is None:
|
|
template['content'] = "template content"
|
|
if subject is None and type_ != 'sms':
|
|
template['subject'] = "template subject"
|
|
if subject is not None:
|
|
template['subject'] = subject
|
|
if redact_personalisation is not None:
|
|
template['redact_personalisation'] = redact_personalisation
|
|
return template
|
|
|
|
|
|
def template_version_json(service_id,
|
|
id_,
|
|
created_by,
|
|
version=1,
|
|
created_at=None,
|
|
**kwargs):
|
|
template = template_json(service_id, id_, **kwargs)
|
|
template['created_by'] = created_by_json(
|
|
created_by['id'],
|
|
created_by['name'],
|
|
created_by['email_address'],
|
|
)
|
|
if created_at is None:
|
|
created_at = datetime.utcnow().strftime('%Y-%m-%d %H:%M:%S.%f')
|
|
template['created_at'] = created_at
|
|
template['version'] = version
|
|
return template
|
|
|
|
|
|
def api_key_json(id_, name, expiry_date=None):
|
|
return {'id': id_,
|
|
'name': name,
|
|
'expiry_date': expiry_date
|
|
}
|
|
|
|
|
|
def invite_json(id_,
|
|
from_user,
|
|
service_id,
|
|
email_address,
|
|
permissions,
|
|
created_at,
|
|
status,
|
|
auth_type,
|
|
folder_permissions):
|
|
return {
|
|
'id': id_,
|
|
'from_user': from_user,
|
|
'service': service_id,
|
|
'email_address': email_address,
|
|
'status': status,
|
|
'permissions': permissions,
|
|
'created_at': created_at,
|
|
'auth_type': auth_type,
|
|
'folder_permissions': folder_permissions,
|
|
}
|
|
|
|
|
|
def org_invite_json(id_, invited_by, org_id, email_address, created_at, status):
|
|
return {
|
|
'id': id_,
|
|
'invited_by': invited_by,
|
|
'organisation': org_id,
|
|
'email_address': email_address,
|
|
'status': status,
|
|
'created_at': created_at,
|
|
}
|
|
|
|
|
|
TEST_USER_EMAIL = 'test@user.gov.uk'
|
|
|
|
|
|
def create_test_api_user(state, permissions={}):
|
|
user_data = {'id': 1,
|
|
'name': 'Test User',
|
|
'password': 'somepassword',
|
|
'email_address': TEST_USER_EMAIL,
|
|
'mobile_number': '+441234123412',
|
|
'state': state,
|
|
'permissions': permissions
|
|
}
|
|
return user_data
|
|
|
|
|
|
def job_json(
|
|
service_id,
|
|
created_by,
|
|
job_id=None,
|
|
template_id=None,
|
|
template_version=1,
|
|
created_at=None,
|
|
bucket_name='',
|
|
original_file_name="thisisatest.csv",
|
|
notification_count=1,
|
|
notifications_sent=1,
|
|
notifications_requested=1,
|
|
job_status='finished',
|
|
scheduled_for=''
|
|
):
|
|
if job_id is None:
|
|
job_id = str(generate_uuid())
|
|
if template_id is None:
|
|
template_id = "5d729fbd-239c-44ab-b498-75a985f3198f"
|
|
if created_at is None:
|
|
created_at = str(datetime.now(timezone.utc).strftime('%Y-%m-%dT%H:%M:%S.%f%z'))
|
|
data = {
|
|
'id': job_id,
|
|
'service': service_id,
|
|
'template': template_id,
|
|
'template_version': template_version,
|
|
'original_file_name': original_file_name,
|
|
'created_at': created_at,
|
|
'notification_count': notification_count,
|
|
'notifications_sent': notifications_sent,
|
|
'notifications_requested': notifications_requested,
|
|
'job_status': job_status,
|
|
'statistics': [],
|
|
'created_by': created_by_json(
|
|
created_by['id'],
|
|
created_by['name'],
|
|
created_by['email_address'],
|
|
),
|
|
'scheduled_for': scheduled_for
|
|
}
|
|
return data
|
|
|
|
|
|
def notification_json(
|
|
service_id,
|
|
job=None,
|
|
template=None,
|
|
to=None,
|
|
status=None,
|
|
sent_at=None,
|
|
job_row_number=None,
|
|
created_at=None,
|
|
updated_at=None,
|
|
with_links=False,
|
|
rows=5,
|
|
personalisation=None,
|
|
template_type=None,
|
|
reply_to_text=None,
|
|
client_reference=None,
|
|
created_by_name=None,
|
|
postage=None,
|
|
):
|
|
if template is None:
|
|
template = template_json(service_id, str(generate_uuid()), type_=template_type)
|
|
if to is None:
|
|
if template_type == 'letter':
|
|
to = '1 Example Street'
|
|
elif template_type == 'email':
|
|
to = 'example@gov.uk'
|
|
else:
|
|
to = '07123456789'
|
|
if sent_at is None:
|
|
sent_at = str(datetime.utcnow().time())
|
|
if created_at is None:
|
|
created_at = datetime.now(timezone.utc).isoformat()
|
|
if updated_at is None:
|
|
updated_at = str((datetime.utcnow() + timedelta(minutes=1)).time())
|
|
if status is None:
|
|
status = 'delivered'
|
|
links = {}
|
|
if template_type == 'letter':
|
|
postage = postage or 'second'
|
|
|
|
if with_links:
|
|
links = {
|
|
'prev': '/service/{}/notifications?page=0'.format(service_id),
|
|
'next': '/service/{}/notifications?page=1'.format(service_id),
|
|
'last': '/service/{}/notifications?page=2'.format(service_id)
|
|
}
|
|
|
|
job_payload = None
|
|
if job:
|
|
job_payload = {'id': job['id'], 'original_file_name': job['original_file_name']}
|
|
|
|
data = {
|
|
'notifications': [{
|
|
'id': sample_uuid(),
|
|
'to': to,
|
|
'template': template,
|
|
'job': job_payload,
|
|
'sent_at': sent_at,
|
|
'status': status,
|
|
'created_at': created_at,
|
|
'created_by': None,
|
|
'updated_at': updated_at,
|
|
'job_row_number': job_row_number,
|
|
'service': service_id,
|
|
'template_version': template['version'],
|
|
'personalisation': personalisation or {},
|
|
'postage': postage,
|
|
'notification_type': template_type,
|
|
'reply_to_text': reply_to_text,
|
|
'client_reference': client_reference,
|
|
'created_by_name': created_by_name,
|
|
} for i in range(rows)],
|
|
'total': rows,
|
|
'page_size': 50,
|
|
'links': links
|
|
}
|
|
return data
|
|
|
|
|
|
def single_notification_json(
|
|
service_id,
|
|
job=None,
|
|
template=None,
|
|
status=None,
|
|
sent_at=None,
|
|
created_at=None,
|
|
updated_at=None,
|
|
notification_type='sms'
|
|
):
|
|
if template is None:
|
|
template = template_json(service_id, str(generate_uuid()))
|
|
if sent_at is None:
|
|
sent_at = str(datetime.utcnow())
|
|
if created_at is None:
|
|
created_at = str(datetime.utcnow())
|
|
if updated_at is None:
|
|
updated_at = str(datetime.utcnow() + timedelta(minutes=1))
|
|
if status is None:
|
|
status = 'delivered'
|
|
job_payload = None
|
|
if job:
|
|
job_payload = {'id': job['id'], 'original_file_name': job['original_file_name']}
|
|
|
|
data = {
|
|
'sent_at': sent_at,
|
|
'to': '07123456789',
|
|
'billable_units': 1,
|
|
'status': status,
|
|
'created_at': created_at,
|
|
'reference': None,
|
|
'updated_at': updated_at,
|
|
'template_version': 5,
|
|
'service': service_id,
|
|
'id': '29441662-17ce-4ffe-9502-fcaed73b2826',
|
|
'template': template,
|
|
'job_row_number': 0,
|
|
'notification_type': notification_type,
|
|
'api_key': None,
|
|
'job': job_payload,
|
|
'sent_by': 'mmg'
|
|
}
|
|
return data
|
|
|
|
|
|
def validate_route_permission(mocker,
|
|
app_,
|
|
method,
|
|
response_code,
|
|
route,
|
|
permissions,
|
|
usr,
|
|
service):
|
|
usr['permissions'][str(service['id'])] = permissions
|
|
usr['services'] = [service['id']]
|
|
mocker.patch(
|
|
'app.user_api_client.check_verify_code',
|
|
return_value=(True, ''))
|
|
mocker.patch(
|
|
'app.service_api_client.get_services',
|
|
return_value={'data': []})
|
|
mocker.patch('app.service_api_client.update_service', return_value=service)
|
|
mocker.patch('app.service_api_client.update_service_with_properties', return_value=service)
|
|
mocker.patch('app.user_api_client.get_user', return_value=usr)
|
|
mocker.patch('app.user_api_client.get_user_by_email', return_value=usr)
|
|
mocker.patch('app.service_api_client.get_service', return_value={'data': service})
|
|
mocker.patch('app.models.user.Users.client', return_value=[usr])
|
|
mocker.patch('app.job_api_client.has_jobs', return_value=False)
|
|
with app_.test_request_context():
|
|
with app_.test_client() as client:
|
|
client.login(usr)
|
|
resp = None
|
|
if method == 'GET':
|
|
resp = client.get(route)
|
|
elif method == 'POST':
|
|
resp = client.post(route)
|
|
else:
|
|
pytest.fail("Invalid method call {}".format(method))
|
|
if resp.status_code != response_code:
|
|
pytest.fail("Invalid permissions set for endpoint {}".format(route))
|
|
return resp
|
|
|
|
|
|
def validate_route_permission_with_client(mocker,
|
|
client,
|
|
method,
|
|
response_code,
|
|
route,
|
|
permissions,
|
|
usr,
|
|
service):
|
|
usr['permissions'][str(service['id'])] = permissions
|
|
mocker.patch(
|
|
'app.user_api_client.check_verify_code',
|
|
return_value=(True, ''))
|
|
mocker.patch(
|
|
'app.service_api_client.get_services',
|
|
return_value={'data': []})
|
|
mocker.patch('app.service_api_client.update_service', return_value=service)
|
|
mocker.patch('app.service_api_client.update_service_with_properties', return_value=service)
|
|
mocker.patch('app.user_api_client.get_user', return_value=usr)
|
|
mocker.patch('app.user_api_client.get_user_by_email', return_value=usr)
|
|
mocker.patch('app.service_api_client.get_service', return_value={'data': service})
|
|
mocker.patch('app.user_api_client.get_users_for_service', return_value=[usr])
|
|
mocker.patch('app.job_api_client.has_jobs', return_value=False)
|
|
client.login(usr)
|
|
resp = None
|
|
if method == 'GET':
|
|
resp = client.get(route)
|
|
elif method == 'POST':
|
|
resp = client.post(route)
|
|
else:
|
|
pytest.fail("Invalid method call {}".format(method))
|
|
if resp.status_code != response_code:
|
|
pytest.fail("Invalid permissions set for endpoint {}".format(route))
|
|
return resp
|