def test_generate_headers_sets_request_id_if_in_request_context(app_):
api_client = NotifyAdminAPIClient('api_key', 'base_url', 'service_id')
with app_.test_request_context() as request_context:
headers = api_client.generate_headers('api_token')
assert set(headers.keys()) == {'Authorization', 'Content-type', 'User-agent', 'NotifyRequestID'}
assert headers['NotifyRequestID'] == request_context.request.request_id
def test_generate_headers_sets_standard_headers():
api_client = NotifyAdminAPIClient('api_key', 'base_url', 'service_id')
# 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'}
assert headers['Authorization'] == 'Bearer api_token'
assert headers['Content-type'] == 'application/json'
assert headers['User-agent'].startswith('NOTIFY-API-PYTHON-CLIENT')
def test_generate_headers_sets_request_id_if_in_request_context(app_):
api_client = NotifyAdminAPIClient(SAMPLE_API_KEY, 'base_url')
with app_.test_request_context() as request_context:
headers = api_client.generate_headers('api_token')
assert set(headers.keys()) == {
'Authorization', 'Content-type', 'User-agent', 'NotifyRequestID'
}
assert headers['NotifyRequestID'] == request_context.request.request_id
def test_generate_headers_sets_standard_headers():
api_client = NotifyAdminAPIClient(SAMPLE_API_KEY, 'base_url')
# 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'}
assert headers['Authorization'] == 'Bearer api_token'
assert headers['Content-type'] == 'application/json'
assert headers['User-agent'].startswith('NOTIFY-API-PYTHON-CLIENT')
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',
'X-B3-TraceId',
'X-B3-SpanId',
}
assert headers['X-B3-TraceId'] == request_context.request.request_id
assert headers['X-B3-SpanId'] == request_context.request.span_id
def test_generate_headers_sets_request_id_if_in_request_context(app_):
api_client = NotifyAdminAPIClient()
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",
"X-B3-TraceId",
"X-B3-SpanId",
}
assert headers["X-B3-TraceId"] == request_context.request.request_id
assert headers["X-B3-SpanId"] == request_context.request.span_id
def test_generate_headers_sets_standard_headers(app_):
api_client = NotifyAdminAPIClient()
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_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
def test_active_service_can_be_modified(app_, method, user, service):
api_client = NotifyAdminAPIClient()
with app_.test_request_context() as request_context, app_.test_client(
) as client:
client.login(user)
request_context.service = 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
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_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
def test_inactive_service_can_be_modified_by_platform_admin(
app_, platform_admin_user, method):
api_client = NotifyAdminAPIClient()
with app_.test_request_context() as request_context, app_.test_client(
) as client:
client.login(platform_admin_user)
request_context.service = 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_inactive_service_cannot_be_modified_by_normal_user(
app_, api_user_active, method):
api_client = NotifyAdminAPIClient()
with app_.test_request_context() as request_context, app_.test_client(
) as client:
client.login(api_user_active)
request_context.service = 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
def test_logging_enabled_for_admin_users(app_, platform_admin_user, method,
caplog):
api_client = NotifyAdminAPIClient()
with app_.test_request_context() as request_context, app_.test_client(
) as client:
client.login(platform_admin_user)
request_context.service = Service(service_json(active=False))
with patch.object(api_client, "request") as request:
ret = getattr(api_client, method)("url", "data")
assert request.called
assert len(caplog.records) == 1
assert ret == request.return_value