darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-02-04 10:21:14 -05:00
Code Issues Packages Projects Releases Wiki Activity

Remove parameters from fixtures

Browse Source 
Since Pytest 4, we can't call fixtures as if they were functions. This
change removes the parameters from the fixtures (since we can't use
them), except for when the parameter is another fixture.
This commit is contained in:
Katie Smith
2019-11-01 14:34:15 +00:00
parent 6411e10d7b
commit 544a7a2311
1 changed files with 97 additions and 283 deletions
Download Patch File Download Diff File Expand all files Collapse all files

380
tests/app/conftest.py
View File

@@ -34,17 +34,13 @@ from app.models import (
ProviderDetails, ProviderDetails,
ProviderDetailsHistory, ProviderDetailsHistory,
ProviderRates, ProviderRates,
ScheduledNotification,
ServiceWhitelist, ServiceWhitelist,
KEY_TYPE_NORMAL, KEY_TYPE_NORMAL,
KEY_TYPE_TEST, KEY_TYPE_TEST,
KEY_TYPE_TEAM, KEY_TYPE_TEAM,
MOBILE_TYPE,
EMAIL_TYPE, EMAIL_TYPE,
INBOUND_SMS_TYPE,
SMS_TYPE, SMS_TYPE,
LETTER_TYPE, LETTER_TYPE,
NOTIFICATION_STATUS_TYPES_COMPLETED,
SERVICE_PERMISSION_TYPES, SERVICE_PERMISSION_TYPES,
ServiceEmailReplyTo ServiceEmailReplyTo
) )
@@ -115,50 +111,29 @@ def notify_user(notify_db_session):
) )
def create_code(notify_db, notify_db_session, code_type, usr=None, code=None): def create_code(notify_db_session, code_type):
if code is None: code = create_secret_code()
code = create_secret_code() usr = create_user()
if usr is None:
usr = create_user()
return create_user_code(usr, code, code_type), code return create_user_code(usr, code, code_type), code
@pytest.fixture(scope='function') @pytest.fixture(scope='function')
def sample_sms_code(notify_db, def sample_sms_code(notify_db_session):
notify_db_session, code, txt_code = create_code(notify_db_session, code_type="sms")
code=None,
code_type="sms",
usr=None):
code, txt_code = create_code(notify_db,
notify_db_session,
code_type,
usr=usr,
code=code)
code.txt_code = txt_code code.txt_code = txt_code
return code return code
@pytest.fixture(scope='function') @pytest.fixture(scope='function')
def sample_service( def sample_service(notify_db_session):
notify_db, user = create_user()
notify_db_session, service_name = 'Sample service'
service_name="Sample service", email_from = service_name.lower().replace(' ', '.')
user=None,
restricted=False,
limit=1000,
email_from=None,
permissions=None,
research_mode=None
):
if user is None:
user = create_user()
if email_from is None:
email_from = service_name.lower().replace(' ', '.')
data = { data = {
'name': service_name, 'name': service_name,
'message_limit': limit, 'message_limit': 1000,
'restricted': restricted, 'restricted': False,
'email_from': email_from, 'email_from': email_from,
'created_by': user, 'created_by': user,
'crown': True 'crown': True
@@ -166,18 +141,11 @@ def sample_service(
service = Service.query.filter_by(name=service_name).first() service = Service.query.filter_by(name=service_name).first()
if not service: if not service:
service = Service(**data) service = Service(**data)
dao_create_service(service, user, service_permissions=permissions) dao_create_service(service, user, service_permissions=None)
if research_mode:
service.research_mode = research_mode
else: else:
if user not in service.users: if user not in service.users:
dao_add_user_to_service(service, user) dao_add_user_to_service(service, user)
if permissions and INBOUND_SMS_TYPE in permissions:
create_inbound_number('12345', service_id=service.id)
return service return service
@@ -199,46 +167,20 @@ def _sample_service_custom_letter_contact_block(sample_service):
@pytest.fixture(scope='function') @pytest.fixture(scope='function')
def sample_template( def sample_template(notify_db_session):
notify_db, user = create_user()
notify_db_session, service = create_service(service_permissions=[EMAIL_TYPE, SMS_TYPE], check_if_service_exists=True)
template_name="Template Name",
template_type="sms",
content="This is a template:\nwith a newline",
archived=False,
hidden=False,
subject_line='Subject',
user=None,
service=None,
created_by=None,
process_type='normal',
permissions=[EMAIL_TYPE, SMS_TYPE]
):
if user is None:
user = create_user()
if service is None:
service = Service.query.filter_by(name='Sample service').first()
if not service:
service = create_service(service_permissions=permissions, check_if_service_exists=True)
if created_by is None:
created_by = create_user()
data = { data = {
'name': template_name, 'name': 'Template Name',
'template_type': template_type, 'template_type': 'sms',
'content': content, 'content': 'This is a template:\nwith a newline',
'service': service, 'service': service,
'created_by': created_by, 'created_by': user,
'archived': archived, 'archived': False,
'hidden': hidden, 'hidden': False,
'process_type': process_type 'process_type': 'normal'
} }
if template_type in ['email', 'letter']:
data.update({
'subject': subject_line
})
if template_type == 'letter':
data['postage'] = 'second'
template = Template(**data) template = Template(**data)
dao_create_template(template) dao_create_template(template)
@@ -264,27 +206,16 @@ def sample_sms_template_with_html(sample_service):
@pytest.fixture(scope='function') @pytest.fixture(scope='function')
def sample_email_template( def sample_email_template(notify_db_session):
notify_db, user = create_user()
notify_db_session, service = create_service(user=user, service_permissions=[EMAIL_TYPE, SMS_TYPE], check_if_service_exists=True)
template_name="Email Template Name",
template_type="email",
user=None,
content="This is a template",
subject_line='Email Subject',
service=None,
permissions=[EMAIL_TYPE, SMS_TYPE]):
if user is None:
user = create_user()
if service is None:
service = create_service(user=user, service_permissions=permissions, check_if_service_exists=True)
data = { data = {
'name': template_name, 'name': 'Email Template Name',
'template_type': template_type, 'template_type': EMAIL_TYPE,
'content': content, 'content': 'This is a template',
'service': service, 'service': service,
'created_by': user, 'created_by': user,
'subject': subject_line 'subject': 'Email Subject'
} }
template = Template(**data) template = Template(**data)
dao_create_template(template) dao_create_template(template)
@@ -298,8 +229,8 @@ def sample_template_without_email_permission(notify_db_session):
@pytest.fixture @pytest.fixture
def sample_letter_template(sample_service_full_permissions, postage="second"): def sample_letter_template(sample_service_full_permissions):
return create_template(sample_service_full_permissions, template_type=LETTER_TYPE, postage=postage) return create_template(sample_service_full_permissions, template_type=LETTER_TYPE, postage='second')
@pytest.fixture @pytest.fixture
@@ -329,14 +260,9 @@ def sample_email_template_with_html(sample_service):
@pytest.fixture(scope='function') @pytest.fixture(scope='function')
def sample_api_key(notify_db, def sample_api_key(notify_db_session):
notify_db_session, service = create_service(check_if_service_exists=True)
service=None, data = {'service': service, 'name': uuid.uuid4(), 'created_by': service.created_by, 'key_type': KEY_TYPE_NORMAL}
key_type=KEY_TYPE_NORMAL,
name=None):
if service is None:
service = create_service(check_if_service_exists=True)
data = {'service': service, 'name': name or uuid.uuid4(), 'created_by': service.created_by, 'key_type': key_type}
api_key = ApiKey(**data) api_key = ApiKey(**data)
save_model_api_key(api_key) save_model_api_key(api_key)
return api_key return api_key
@@ -363,37 +289,23 @@ def sample_team_api_key(sample_api_key):
@pytest.fixture(scope='function') @pytest.fixture(scope='function')
def sample_job( def sample_job(notify_db_session):
notify_db, service = create_service(check_if_service_exists=True)
notify_db_session, template = create_template(service=service)
service=None,
template=None,
notification_count=1,
created_at=None,
job_status='pending',
scheduled_for=None,
processing_started=None,
original_file_name='some.csv',
archived=False
):
if service is None:
service = create_service(check_if_service_exists=True)
if template is None:
template = create_template(service=service)
data = { data = {
'id': uuid.uuid4(), 'id': uuid.uuid4(),
'service_id': service.id, 'service_id': service.id,
'service': service, 'service': service,
'template_id': template.id, 'template_id': template.id,
'template_version': template.version, 'template_version': template.version,
'original_file_name': original_file_name, 'original_file_name': 'some.csv',
'notification_count': notification_count, 'notification_count': 1,
'created_at': created_at or datetime.utcnow(), 'created_at': datetime.utcnow(),
'created_by': service.created_by, 'created_by': service.created_by,
'job_status': job_status, 'job_status': 'pending',
'scheduled_for': scheduled_for, 'scheduled_for': None,
'processing_started': processing_started, 'processing_started': None,
'archived': archived 'archived': False
} }
job = Job(**data) job = Job(**data)
dao_create_job(job) dao_create_job(job)
@@ -439,12 +351,13 @@ def sample_letter_job(sample_letter_template):
@pytest.fixture(scope='function') @pytest.fixture(scope='function')
def sample_notification_with_job( def sample_notification_with_job(notify_db_session):
notify_db, service = create_service(check_if_service_exists=True)
notify_db_session, template = create_template(service=service)
service=None, job = create_job(template=template)
template=None, return create_notification(
job=None, template=template,
job=job,
job_row_number=None, job_row_number=None,
to_field=None, to_field=None,
status='created', status='created',
@@ -455,113 +368,51 @@ def sample_notification_with_job(
personalisation=None, personalisation=None,
api_key=None, api_key=None,
key_type=KEY_TYPE_NORMAL key_type=KEY_TYPE_NORMAL
):
if not service:
service = create_service(check_if_service_exists=True)
if not template:
template = create_template(service=service)
if job is None:
job = create_job(template=template)
return create_notification(
template=template,
job=job,
job_row_number=job_row_number if job_row_number is not None else None,
to_field=to_field,
status=status,
reference=reference,
created_at=created_at,
sent_at=sent_at,
billable_units=billable_units,
personalisation=personalisation,
api_key=api_key,
key_type=key_type
) )
@pytest.fixture(scope='function') @pytest.fixture(scope='function')
def sample_notification( def sample_notification(notify_db_session):
notify_db, created_at = datetime.utcnow()
notify_db_session, service = create_service(check_if_service_exists=True)
service=None, template = create_template(service=service)
template=None,
job=None,
job_row_number=None,
to_field=None,
status='created',
reference=None,
created_at=None,
sent_at=None,
billable_units=1,
personalisation=None,
api_key=None,
key_type=KEY_TYPE_NORMAL,
sent_by=None,
international=False,
client_reference=None,
rate_multiplier=1.0,
scheduled_for=None,
normalised_to=None,
postage=None,
):
if created_at is None:
created_at = datetime.utcnow()
if service is None:
service = create_service(check_if_service_exists=True)
if template is None:
template = create_template(service=service)
if job is None and api_key is None: api_key = ApiKey.query.filter(ApiKey.service == template.service, ApiKey.key_type == KEY_TYPE_NORMAL).first()
# we didn't specify in test - lets create it if not api_key:
api_key = ApiKey.query.filter(ApiKey.service == template.service, ApiKey.key_type == key_type).first() api_key = create_api_key(template.service, key_type=KEY_TYPE_NORMAL)
if not api_key:
api_key = create_api_key(template.service, key_type=key_type)
notification_id = uuid.uuid4() notification_id = uuid.uuid4()
to = '+447700900855'
if to_field:
to = to_field
else:
to = '+447700900855'
data = { data = {
'id': notification_id, 'id': notification_id,
'to': to, 'to': to,
'job_id': job.id if job else None, 'job_id': None,
'job': job, 'job': None,
'service_id': service.id, 'service_id': service.id,
'service': service, 'service': service,
'template_id': template.id, 'template_id': template.id,
'template_version': template.version, 'template_version': template.version,
'status': status, 'status': 'created',
'reference': reference, 'reference': None,
'created_at': created_at, 'created_at': created_at,
'sent_at': sent_at, 'sent_at': None,
'billable_units': billable_units, 'billable_units': 1,
'personalisation': personalisation, 'personalisation': None,
'notification_type': template.template_type, 'notification_type': template.template_type,
'api_key': api_key, 'api_key': api_key,
'api_key_id': api_key and api_key.id, 'api_key_id': api_key and api_key.id,
'key_type': api_key.key_type if api_key else key_type, 'key_type': api_key.key_type,
'sent_by': sent_by, 'sent_by': None,
'updated_at': created_at if status in NOTIFICATION_STATUS_TYPES_COMPLETED else None, 'updated_at': None,
'client_reference': client_reference, 'client_reference': None,
'rate_multiplier': rate_multiplier, 'rate_multiplier': 1.0,
'normalised_to': normalised_to, 'normalised_to': None,
'postage': postage, 'postage': None,
} }
if job_row_number is not None:
data['job_row_number'] = job_row_number
notification = Notification(**data) notification = Notification(**data)
dao_create_notification(notification) dao_create_notification(notification)
if scheduled_for:
scheduled_notification = ScheduledNotification(id=uuid.uuid4(),
notification_id=notification.id,
scheduled_for=datetime.strptime(scheduled_for,
"%Y-%m-%d %H:%M"))
if status != 'created':
scheduled_notification.pending = False
db.session.add(scheduled_notification)
db.session.commit()
return notification return notification
@@ -616,38 +467,21 @@ def sample_email_notification(notify_db_session):
@pytest.fixture(scope='function') @pytest.fixture(scope='function')
def sample_notification_history( def sample_notification_history(notify_db, notify_db_session, sample_template):
notify_db, created_at = datetime.utcnow()
notify_db_session, sent_at = datetime.utcnow()
sample_template, notification_type = sample_template.template_type
status='created', api_key = create_api_key(sample_template.service, key_type=KEY_TYPE_NORMAL)
created_at=None,
notification_type=None,
key_type=KEY_TYPE_NORMAL,
sent_at=None,
api_key=None
):
if created_at is None:
created_at = datetime.utcnow()
if sent_at is None:
sent_at = datetime.utcnow()
if notification_type is None:
notification_type = sample_template.template_type
if not api_key:
api_key = create_api_key(sample_template.service, key_type=key_type)
notification_history = NotificationHistory( notification_history = NotificationHistory(
id=uuid.uuid4(), id=uuid.uuid4(),
service=sample_template.service, service=sample_template.service,
template_id=sample_template.id, template_id=sample_template.id,
template_version=sample_template.version, template_version=sample_template.version,
status=status, status='created',
created_at=created_at, created_at=created_at,
notification_type=notification_type, notification_type=notification_type,
key_type=key_type, key_type=KEY_TYPE_NORMAL,
api_key=api_key, api_key=api_key,
api_key_id=api_key and api_key.id, api_key_id=api_key and api_key.id,
sent_at=sent_at sent_at=sent_at
@@ -664,15 +498,9 @@ def mock_encryption(mocker):
@pytest.fixture(scope='function') @pytest.fixture(scope='function')
def sample_invited_user(notify_db, def sample_invited_user(notify_db_session):
notify_db_session, service = create_service(check_if_service_exists=True)
service=None, to_email_address = 'invited_user@digital.gov.uk'
to_email_address=None):
if service is None:
service = create_service(check_if_service_exists=True)
if to_email_address is None:
to_email_address = 'invited_user@digital.gov.uk'
from_user = service.users[0] from_user = service.users[0]
@@ -689,23 +517,16 @@ def sample_invited_user(notify_db,
@pytest.fixture(scope='function') @pytest.fixture(scope='function')
def sample_invited_org_user( def sample_invited_org_user(sample_user, sample_organisation):
notify_db,
notify_db_session,
sample_user,
sample_organisation
):
return create_invited_org_user(sample_organisation, sample_user) return create_invited_org_user(sample_organisation, sample_user)
@pytest.fixture(scope='function') @pytest.fixture(scope='function')
def sample_user_service_permission( def sample_user_service_permission(notify_db_session):
notify_db, notify_db_session, service=None, user=None, permission="manage_settings" user = create_user()
): service = create_service(user=user, check_if_service_exists=True)
if user is None: permission = 'manage_settings'
user = create_user()
if service is None:
service = create_service(user=user, check_if_service_exists=True)
data = { data = {
'user': user, 'user': user,
'service': service, 'service': service,
@@ -747,9 +568,9 @@ def mmg_provider():
@pytest.fixture(scope='function') @pytest.fixture(scope='function')
def mock_firetext_client(mocker, statsd_client=None): def mock_firetext_client(mocker):
client = FiretextClient() client = FiretextClient()
statsd_client = statsd_client or mocker.Mock() statsd_client = mocker.Mock()
current_app = mocker.Mock(config={ current_app = mocker.Mock(config={
'FIRETEXT_URL': 'https://example.com/firetext', 'FIRETEXT_URL': 'https://example.com/firetext',
'FIRETEXT_API_KEY': 'foo', 'FIRETEXT_API_KEY': 'foo',
@@ -1003,16 +824,9 @@ def notify_service(notify_db, notify_db_session):
@pytest.fixture(scope='function') @pytest.fixture(scope='function')
def sample_service_whitelist(notify_db, notify_db_session, service=None, email_address=None, mobile_number=None): def sample_service_whitelist(notify_db, notify_db_session):
if service is None: service = create_service(check_if_service_exists=True)
service = create_service(check_if_service_exists=True) whitelisted_user = ServiceWhitelist.from_string(service.id, EMAIL_TYPE, 'whitelisted_user@digital.gov.uk')
if email_address:
whitelisted_user = ServiceWhitelist.from_string(service.id, EMAIL_TYPE, email_address)
elif mobile_number:
whitelisted_user = ServiceWhitelist.from_string(service.id, MOBILE_TYPE, mobile_number)
else:
whitelisted_user = ServiceWhitelist.from_string(service.id, EMAIL_TYPE, 'whitelisted_user@digital.gov.uk')
notify_db.session.add(whitelisted_user) notify_db.session.add(whitelisted_user)
notify_db.session.commit() notify_db.session.commit()
@@ -1020,7 +834,7 @@ def sample_service_whitelist(notify_db, notify_db_session, service=None, email_a
@pytest.fixture @pytest.fixture
def sample_inbound_numbers(notify_db, notify_db_session, sample_service): def sample_inbound_numbers(sample_service):
service = create_service(service_name='sample service 2', check_if_service_exists=True) service = create_service(service_name='sample service 2', check_if_service_exists=True)
inbound_numbers = list() inbound_numbers = list()
inbound_numbers.append(create_inbound_number(number='1', provider='mmg')) inbound_numbers.append(create_inbound_number(number='1', provider='mmg'))
@@ -1030,7 +844,7 @@ def sample_inbound_numbers(notify_db, notify_db_session, sample_service):
@pytest.fixture @pytest.fixture
def sample_organisation(notify_db, notify_db_session): def sample_organisation(notify_db_session):
org = Organisation(name='sample organisation') org = Organisation(name='sample organisation')
dao_create_organisation(org) dao_create_organisation(org)
return org return org