mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-02-26 13:20:54 -05:00
acfe8092fc
Currently requests to the API made from the admin app are going from PaaS admin app to the nginx router ELB, which then routes them back to the api app on PaaS. This makes sense for external requests, but for requests made from the admin app we could skip nginx and go directly to the api PaaS host, which should reduce load on the nginx instances and potentially reduce latency of the api requests. API apps on PaaS are checking the X-Custom-Forwarder header (which is set by nginx on proxy_pass requests) to only allow requests going through the proxy. This adds the custom header to the API client requests, so that they can pass that header check without going through nginx.
105 lines
3.5 KiB
Python
105 lines
3.5 KiB
Python
import uuid
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
import werkzeug
|
|
from tests import service_json
|
|
from tests.conftest import api_user_active, platform_admin_user, set_config
|
|
|
|
from app.notify_client import NotifyAdminAPIClient
|
|
|
|
SAMPLE_API_KEY = '{}-{}'.format('a' * 36, 's' * 36)
|
|
|
|
|
|
@pytest.mark.parametrize('method', [
|
|
'put',
|
|
'post',
|
|
'delete'
|
|
])
|
|
@pytest.mark.parametrize('user', [
|
|
api_user_active(str(uuid.uuid4())),
|
|
platform_admin_user(str(uuid.uuid4()))
|
|
], ids=['api_user', 'platform_admin'])
|
|
@pytest.mark.parametrize('service', [
|
|
service_json(active=True),
|
|
None
|
|
], ids=['active_service', 'no_service'])
|
|
def test_active_service_can_be_modified(app_, method, user, service):
|
|
api_client = NotifyAdminAPIClient(SAMPLE_API_KEY, 'base_url')
|
|
|
|
with app_.test_request_context() as request_context, app_.test_client() as client:
|
|
client.login(user)
|
|
request_context.service = service
|
|
|
|
with patch.object(api_client, 'request') as request:
|
|
ret = getattr(api_client, method)('url', 'data')
|
|
|
|
assert request.called
|
|
assert ret == request.return_value
|
|
|
|
|
|
@pytest.mark.parametrize('method', [
|
|
'put',
|
|
'post',
|
|
'delete'
|
|
])
|
|
def test_inactive_service_cannot_be_modified_by_normal_user(app_, api_user_active, method):
|
|
api_client = NotifyAdminAPIClient(SAMPLE_API_KEY, 'base_url')
|
|
|
|
with app_.test_request_context() as request_context, app_.test_client() as client:
|
|
client.login(api_user_active)
|
|
request_context.service = service_json(active=False)
|
|
|
|
with patch.object(api_client, 'request') as request:
|
|
with pytest.raises(werkzeug.exceptions.Forbidden):
|
|
getattr(api_client, method)('url', 'data')
|
|
|
|
assert not request.called
|
|
|
|
|
|
@pytest.mark.parametrize('method', [
|
|
'put',
|
|
'post',
|
|
'delete'
|
|
])
|
|
def test_inactive_service_can_be_modified_by_platform_admin(app_, platform_admin_user, method):
|
|
api_client = NotifyAdminAPIClient(SAMPLE_API_KEY, 'base_url')
|
|
|
|
with app_.test_request_context() as request_context, app_.test_client() as client:
|
|
client.login(platform_admin_user)
|
|
request_context.service = service_json(active=False)
|
|
|
|
with patch.object(api_client, 'request') as request:
|
|
ret = getattr(api_client, method)('url', 'data')
|
|
|
|
assert request.called
|
|
assert ret == request.return_value
|
|
|
|
|
|
def test_generate_headers_sets_standard_headers(app_):
|
|
api_client = NotifyAdminAPIClient(SAMPLE_API_KEY, 'base_url')
|
|
with set_config(app_, 'ROUTE_SECRET_KEY_1', 'proxy-secret'):
|
|
api_client.init_app(app_)
|
|
|
|
# with patch('app.notify_client.has_request_context', return_value=False):
|
|
headers = api_client.generate_headers('api_token')
|
|
|
|
assert set(headers.keys()) == {'Authorization', 'Content-type', 'User-agent', 'X-Custom-Forwarder'}
|
|
assert headers['Authorization'] == 'Bearer api_token'
|
|
assert headers['Content-type'] == 'application/json'
|
|
assert headers['User-agent'].startswith('NOTIFY-API-PYTHON-CLIENT')
|
|
assert headers['X-Custom-Forwarder'] == 'proxy-secret'
|
|
|
|
|
|
def test_generate_headers_sets_request_id_if_in_request_context(app_):
|
|
api_client = NotifyAdminAPIClient(SAMPLE_API_KEY, 'base_url')
|
|
api_client.init_app(app_)
|
|
|
|
with app_.test_request_context() as request_context:
|
|
headers = api_client.generate_headers('api_token')
|
|
|
|
assert set(headers.keys()) == {
|
|
'Authorization', 'Content-type', 'User-agent', 'X-Custom-Forwarder', 'NotifyRequestID'
|
|
}
|
|
assert headers['NotifyRequestID'] == request_context.request.request_id
|