mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-03-03 08:51:39 -05:00
The data flow of other bits of our application looks like this:
```
API (returns JSON)
⬇
API client (returns a built in type, usually `dict`)
⬇
Model (returns an instance, eg of type `Service`)
⬇
View (returns HTML)
```
The user API client was architected weirdly, in that it returned a model
directly, like this:
```
API (returns JSON)
⬇
API client (returns a model, of type `User`, `InvitedUser`, etc)
⬇
View (returns HTML)
```
This mixing of different layers of the application is bad because it
makes it hard to write model code that doesn’t have circular
dependencies. As our application gets more complicated we will be
relying more on models to manage this complexity, so we should make it
easy, not hard to write them.
It also means that most of our mocking was of the User model, not just
the underlying JSON. So it would have been easy to introduce subtle bugs
to the user model, because it wasn’t being comprehensively tested. A lot
of the changed lines of code in this commit mean changing the tests to
mock only the JSON, which means that the model layer gets implicitly
tested.
For those reasons this commit changes the user API client to return
JSON, not an instance of `User` or other models.
168 lines
5.6 KiB
Python
168 lines
5.6 KiB
Python
import json
|
||
import uuid
|
||
|
||
from bs4 import BeautifulSoup
|
||
from flask import url_for
|
||
from itsdangerous import SignatureExpired
|
||
|
||
from tests.conftest import normalize_spaces
|
||
|
||
|
||
def test_should_return_verify_template(
|
||
client,
|
||
api_user_active,
|
||
mock_send_verify_code,
|
||
):
|
||
# TODO this lives here until we work out how to
|
||
# reassign the session after it is lost mid register process
|
||
with client.session_transaction() as session:
|
||
session['user_details'] = {'email_address': api_user_active['email_address'], 'id': api_user_active['id']}
|
||
response = client.get(url_for('main.verify'))
|
||
assert response.status_code == 200
|
||
|
||
page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
|
||
assert page.h1.text == 'Check your phone'
|
||
message = page.find_all('p')[1].text
|
||
assert message == "We’ve sent you a text message with a security code."
|
||
|
||
|
||
def test_should_redirect_to_add_service_when_sms_code_is_correct(
|
||
client,
|
||
api_user_active,
|
||
mocker,
|
||
mock_update_user_attribute,
|
||
mock_check_verify_code,
|
||
mock_create_event,
|
||
fake_uuid,
|
||
):
|
||
api_user_active['current_session_id'] = str(uuid.UUID(int=1))
|
||
mocker.patch('app.user_api_client.get_user', return_value=api_user_active)
|
||
|
||
with client.session_transaction() as session:
|
||
session['user_details'] = {'email_address': api_user_active['email_address'], 'id': api_user_active['id']}
|
||
# user's only just created their account so no session in the cookie
|
||
session.pop('current_session_id', None)
|
||
|
||
response = client.post(url_for('main.verify'),
|
||
data={'sms_code': '12345'})
|
||
assert response.status_code == 302
|
||
assert response.location == url_for('main.add_service', first='first', _external=True)
|
||
|
||
# make sure the current_session_id has changed to what the API returned
|
||
with client.session_transaction() as session:
|
||
assert session['current_session_id'] == str(uuid.UUID(int=1))
|
||
|
||
mock_check_verify_code.assert_called_once_with(api_user_active['id'], '12345', 'sms')
|
||
|
||
|
||
def test_should_activate_user_after_verify(
|
||
client,
|
||
mocker,
|
||
api_user_pending,
|
||
mock_send_verify_code,
|
||
mock_check_verify_code,
|
||
mock_create_event,
|
||
mock_activate_user,
|
||
):
|
||
mocker.patch('app.user_api_client.get_user', return_value=api_user_pending)
|
||
with client.session_transaction() as session:
|
||
session['user_details'] = {
|
||
'email_address': api_user_pending['email_address'],
|
||
'id': api_user_pending['id']
|
||
}
|
||
client.post(url_for('main.verify'),
|
||
data={'sms_code': '12345'})
|
||
assert mock_activate_user.called
|
||
|
||
|
||
def test_should_return_200_when_sms_code_is_wrong(
|
||
client_request,
|
||
api_user_active,
|
||
mock_check_verify_code_code_not_found,
|
||
):
|
||
with client_request.session_transaction() as session:
|
||
session['user_details'] = {
|
||
'email_address': api_user_active['email_address'],
|
||
'id': api_user_active['id'],
|
||
}
|
||
|
||
page = client_request.post(
|
||
'main.verify',
|
||
_data={'sms_code': '12345'},
|
||
_expected_status=200,
|
||
)
|
||
|
||
assert len(page.select('.error-message')) == 1
|
||
assert normalize_spaces(page.select_one('.error-message').text) == (
|
||
'Code not found'
|
||
)
|
||
|
||
|
||
def test_verify_email_redirects_to_verify_if_token_valid(
|
||
client,
|
||
mocker,
|
||
api_user_pending,
|
||
mock_get_user_pending,
|
||
mock_send_verify_code,
|
||
mock_check_verify_code,
|
||
):
|
||
token_data = {"user_id": api_user_pending['id'], "secret_code": 'UNUSED'}
|
||
mocker.patch('app.main.views.verify.check_token', return_value=json.dumps(token_data))
|
||
|
||
with client.session_transaction() as session:
|
||
session['user_details'] = {
|
||
'email_address': api_user_pending['email_address'],
|
||
'id': api_user_pending['id'],
|
||
}
|
||
|
||
response = client.get(url_for('main.verify_email', token='notreal'))
|
||
|
||
assert response.status_code == 302
|
||
assert response.location == url_for('main.verify', _external=True)
|
||
|
||
assert not mock_check_verify_code.called
|
||
mock_send_verify_code.assert_called_once_with(api_user_pending['id'], 'sms', api_user_pending['mobile_number'])
|
||
|
||
with client.session_transaction() as session:
|
||
assert session['user_details'] == {'email': api_user_pending['email_address'], 'id': api_user_pending['id']}
|
||
|
||
|
||
def test_verify_email_redirects_to_email_sent_if_token_expired(
|
||
client,
|
||
mocker,
|
||
api_user_pending,
|
||
):
|
||
mocker.patch('app.main.views.verify.check_token', side_effect=SignatureExpired('expired'))
|
||
|
||
response = client.get(url_for('main.verify_email', token='notreal'))
|
||
|
||
assert response.status_code == 302
|
||
assert response.location == url_for('main.resend_email_verification', _external=True)
|
||
|
||
|
||
def test_verify_email_redirects_to_sign_in_if_user_active(
|
||
client,
|
||
mocker,
|
||
api_user_active,
|
||
mock_get_user,
|
||
mock_send_verify_code,
|
||
mock_check_verify_code,
|
||
):
|
||
token_data = {"user_id": api_user_active['id'], "secret_code": 12345}
|
||
mocker.patch('app.main.views.verify.check_token', return_value=json.dumps(token_data))
|
||
|
||
response = client.get(url_for('main.verify_email', token='notreal'), follow_redirects=True)
|
||
page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
|
||
assert page.h1.text == 'Sign in'
|
||
flash_banner = page.find('div', class_='banner-dangerous').string.strip()
|
||
assert flash_banner == "That verification link has expired."
|
||
|
||
|
||
def test_verify_redirects_to_sign_in_if_not_logged_in(
|
||
client
|
||
):
|
||
response = client.get(url_for('main.verify'))
|
||
|
||
assert response.location == url_for('main.sign_in', _external=True)
|
||
assert response.status_code == 302
|