tests/app/main/test_errorhandlers.py

import pytest
from bs4 import BeautifulSoup
from flask import Response, url_for
from flask_wtf.csrf import CSRFError
from notifications_python_client.errors import HTTPError


def test_bad_url_returns_page_not_found(client):
    response = client.get('/bad_url')
    assert response.status_code == 404
    page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
    assert page.h1.string.strip() == 'Page could not be found'


def test_load_service_before_request_handles_404(client_request, mocker):
    exc = HTTPError(Response(status=404), 'Not found')
    get_service = mocker.patch('app.service_api_client.get_service', side_effect=exc)

    client_request.get(
        'main.service_dashboard',
        service_id='00000000-0000-0000-0000-000000000000',
        _expected_status=404
    )

    get_service.assert_called_once_with('00000000-0000-0000-0000-000000000000')


@pytest.mark.parametrize('url', [
    '/new-password/MALFORMED_TOKEN',
    '/user-profile/email/confirm/MALFORMED_TOKEN',
    '/verify-email/MALFORMED_TOKEN'
])
def test_malformed_token_returns_page_not_found(logged_in_client, url):
    response = logged_in_client.get(url)

    assert response.status_code == 404
    page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
    assert page.h1.string.strip() == 'Page could not be found'
    flash_banner = page.find('div', class_='banner-dangerous').string.strip()
    assert flash_banner == "There’s something wrong with the link you’ve used."


def test_csrf_returns_400(logged_in_client, mocker):
    # we turn off CSRF handling for tests, so fake a CSRF response here.
    csrf_err = CSRFError('400 Bad Request: The CSRF tokens do not match.')
    mocker.patch('app.main.views.index.render_template', side_effect=csrf_err)

    response = logged_in_client.get('/cookies')

    assert response.status_code == 400
    page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
    assert page.h1.string.strip() == 'Something went wrong, please go back and try again.'


def test_csrf_redirects_to_sign_in_page_if_not_signed_in(client, mocker):
    csrf_err = CSRFError('400 Bad Request: The CSRF tokens do not match.')
    mocker.patch('app.main.views.index.render_template', side_effect=csrf_err)

    response = client.get('/cookies')

    assert response.status_code == 302
    assert response.location == url_for('main.sign_in', next='/cookies', _external=True)


def test_405_returns_something_went_wrong_page(client, mocker):
    response = client.post('/')

    assert response.status_code == 405
    page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
    assert page.h1.string.strip() == 'Something went wrong, please go back and try again.'
-												add error handler that catches invalid tokens, and returns 404

											
										
										
											2017-11-01 15:47:05 +00:00
+								import pytest
-												Fix bug in error handlers.
Correct spelling error

											
										
										
											2016-03-11 10:16:06 +00:00
+								from bs4 import BeautifulSoup
-												Enforce order and style of imports

Done using isort[1], with the following command:
```
isort -rc ./app ./tests
```

Adds linting to the `run_tests.sh` script to stop badly-sorted imports
getting re-introduced.

Chosen style is ‘Vertical Hanging Indent’ with trailing commas, because
I think it gives the cleanest diffs, eg:
```
from third_party import (
    lib1,
    lib2,
    lib3,
    lib4,
)
```

1. https://pypi.python.org/pypi/isort

											
										
										
											2018-02-20 11:22:17 +00:00
+								from flask import Response, url_for
 								from flask_wtf.csrf import CSRFError
-												make sure load_service_before_request handles 404s

if it 404s, because the service id doesn't exist, then it should die
gracefully (showing a 404 error page), rather than what it currently
does, which is die kicking and screaming with a 500

											
										
										
											2017-10-30 16:59:24 +00:00
+								from notifications_python_client.errors import HTTPError
-												Fix bug in error handlers.
Correct spelling error

											
										
										
											2016-03-11 10:16:06 +00:00
-												Use `client` and `logged_in_client` fixtures

Wherever possible, because Don’t Repeat Yourself.

											
										
										
											2017-02-03 12:07:21 +00:00
+								def test_bad_url_returns_page_not_found(client):
 								    response = client.get('/bad_url')
 								    assert response.status_code == 404
 								    page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
 								    assert page.h1.string.strip() == 'Page could not be found'
-												make sure load_service_before_request handles 404s

if it 404s, because the service id doesn't exist, then it should die
gracefully (showing a 404 error page), rather than what it currently
does, which is die kicking and screaming with a 500

											
										
										
											2017-10-30 16:59:24 +00:00
 								def test_load_service_before_request_handles_404(client_request, mocker):
 								    exc = HTTPError(Response(status=404), 'Not found')
 								    get_service = mocker.patch('app.service_api_client.get_service', side_effect=exc)
 								    client_request.get(
 								        'main.service_dashboard',
 								        service_id='00000000-0000-0000-0000-000000000000',
 								        _expected_status=404
 								    )
 								    get_service.assert_called_once_with('00000000-0000-0000-0000-000000000000')
-												Merge branch 'master' into load-service-err
											
										
										
											2017-11-01 16:43:51 +00:00
-												add error handler that catches invalid tokens, and returns 404

											
										
										
											2017-11-01 15:47:05 +00:00
+								@pytest.mark.parametrize('url', [
 								    '/new-password/MALFORMED_TOKEN',
 								    '/user-profile/email/confirm/MALFORMED_TOKEN',
 								    '/verify-email/MALFORMED_TOKEN'
 								])
-												make sure invite tokens still check token on admin for error handler to kick in

											
										
										
											2017-11-01 16:02:05 +00:00
+								def test_malformed_token_returns_page_not_found(logged_in_client, url):
 								    response = logged_in_client.get(url)
-												add error handler that catches invalid tokens, and returns 404

											
										
										
											2017-11-01 15:47:05 +00:00
 								    assert response.status_code == 404
 								    page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
 								    assert page.h1.string.strip() == 'Page could not be found'
 								    flash_banner = page.find('div', class_='banner-dangerous').string.strip()
 								    assert flash_banner == "There’s something wrong with the link you’ve used."
-												error handlers should not raise. Not even `abort(400)`s.

Refactor csrf handler into the normal error handler area, and then add
some tests to make sure it does the right thing. Also, change it back
to a 400, because the 403 err page talks about being in the wrong
place, but this is about sending the wrong data through, even though
it's technically a 403. Will need to think about wording but this is a
fine first pass

											
										
										
											2017-11-28 12:11:29 +00:00
 								def test_csrf_returns_400(logged_in_client, mocker):
 								    # we turn off CSRF handling for tests, so fake a CSRF response here.
 								    csrf_err = CSRFError('400 Bad Request: The CSRF tokens do not match.')
 								    mocker.patch('app.main.views.index.render_template', side_effect=csrf_err)
 								    response = logged_in_client.get('/cookies')
 								    assert response.status_code == 400
 								    page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
 								    assert page.h1.string.strip() == 'Something went wrong, please go back and try again.'
 								def test_csrf_redirects_to_sign_in_page_if_not_signed_in(client, mocker):
 								    csrf_err = CSRFError('400 Bad Request: The CSRF tokens do not match.')
 								    mocker.patch('app.main.views.index.render_template', side_effect=csrf_err)
 								    response = client.get('/cookies')
 								    assert response.status_code == 302
 								    assert response.location == url_for('main.sign_in', next='/cookies', _external=True)
-												handle 405 METHOD NOT ALLOWEDs

(show the "something went wrong" error page).

also catch any other werkzeug http exceptions and show an appropriate
template, if it exists

											
										
										
											2018-06-22 17:36:58 +01:00
 								def test_405_returns_something_went_wrong_page(client, mocker):
 								    response = client.post('/')
 								    assert response.status_code == 405
 								    page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
 								    assert page.h1.string.strip() == 'Something went wrong, please go back and try again.'