mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-21 16:01:15 -05:00
adbe02783d
moved api_key secret manipulation (generating and getting) into authentiation/utils, and added a property on the model, to facilitate easier matching of authenticated requests and the api keys they used
99 lines
4.0 KiB
Python
99 lines
4.0 KiB
Python
from datetime import datetime
|
|
|
|
import pytest
|
|
from sqlalchemy.exc import IntegrityError
|
|
from sqlalchemy.orm.exc import NoResultFound
|
|
|
|
from app.authentication.utils import get_secret
|
|
from app.dao.api_key_dao import (save_model_api_key,
|
|
get_model_api_keys,
|
|
get_unsigned_secrets,
|
|
get_unsigned_secret,
|
|
expire_api_key)
|
|
from app.models import ApiKey, KEY_TYPE_NORMAL
|
|
|
|
|
|
def test_save_api_key_should_create_new_api_key_and_history(sample_service):
|
|
api_key = ApiKey(**{'service': sample_service,
|
|
'name': sample_service.name,
|
|
'created_by': sample_service.created_by,
|
|
'key_type': KEY_TYPE_NORMAL})
|
|
save_model_api_key(api_key)
|
|
|
|
all_api_keys = get_model_api_keys(service_id=sample_service.id)
|
|
assert len(all_api_keys) == 1
|
|
assert all_api_keys[0] == api_key
|
|
assert api_key.version == 1
|
|
|
|
all_history = api_key.get_history_model().query.all()
|
|
assert len(all_history) == 1
|
|
assert all_history[0].id == api_key.id
|
|
assert all_history[0].version == api_key.version
|
|
|
|
|
|
def test_expire_api_key_should_update_the_api_key_and_create_history_record(notify_api,
|
|
sample_api_key):
|
|
expire_api_key(service_id=sample_api_key.service_id, api_key_id=sample_api_key.id)
|
|
all_api_keys = get_model_api_keys(service_id=sample_api_key.service_id)
|
|
assert len(all_api_keys) == 1
|
|
assert all_api_keys[0].expiry_date <= datetime.utcnow()
|
|
assert all_api_keys[0].secret == sample_api_key.secret
|
|
assert all_api_keys[0].id == sample_api_key.id
|
|
assert all_api_keys[0].service_id == sample_api_key.service_id
|
|
|
|
all_history = sample_api_key.get_history_model().query.all()
|
|
assert len(all_history) == 2
|
|
assert all_history[0].id == sample_api_key.id
|
|
assert all_history[1].id == sample_api_key.id
|
|
sorted_all_history = sorted(all_history, key=lambda hist: hist.version)
|
|
sorted_all_history[0].version = 1
|
|
sorted_all_history[1].version = 2
|
|
|
|
|
|
def test_get_api_key_should_raise_exception_when_api_key_does_not_exist(sample_service, fake_uuid):
|
|
with pytest.raises(NoResultFound):
|
|
get_model_api_keys(sample_service.id, id=fake_uuid)
|
|
|
|
|
|
def test_should_return_api_key_for_service(notify_api, notify_db, notify_db_session, sample_api_key):
|
|
api_key = get_model_api_keys(service_id=sample_api_key.service_id, id=sample_api_key.id)
|
|
assert api_key == sample_api_key
|
|
|
|
|
|
def test_should_return_unsigned_api_keys_for_service_id(sample_api_key):
|
|
unsigned_api_key = get_unsigned_secrets(sample_api_key.service_id)
|
|
assert len(unsigned_api_key) == 1
|
|
assert sample_api_key.secret != unsigned_api_key[0]
|
|
assert unsigned_api_key[0] == get_secret(sample_api_key.secret)
|
|
|
|
|
|
def test_get_unsigned_secret_returns_key(sample_api_key):
|
|
unsigned_api_key = get_unsigned_secret(sample_api_key.id)
|
|
assert sample_api_key.secret != unsigned_api_key
|
|
assert unsigned_api_key == get_secret(sample_api_key.secret)
|
|
|
|
|
|
def test_should_not_allow_duplicate_key_names_per_service(sample_api_key, fake_uuid):
|
|
api_key = ApiKey(**{'id': fake_uuid,
|
|
'service': sample_api_key.service,
|
|
'name': sample_api_key.name,
|
|
'created_by': sample_api_key.created_by,
|
|
'key_type': KEY_TYPE_NORMAL})
|
|
with pytest.raises(IntegrityError):
|
|
save_model_api_key(api_key)
|
|
|
|
|
|
def test_save_api_key_should_not_create_new_service_history(sample_service):
|
|
from app.models import Service
|
|
|
|
assert Service.query.count() == 1
|
|
assert Service.get_history_model().query.count() == 1
|
|
|
|
api_key = ApiKey(**{'service': sample_service,
|
|
'name': sample_service.name,
|
|
'created_by': sample_service.created_by,
|
|
'key_type': KEY_TYPE_NORMAL})
|
|
save_model_api_key(api_key)
|
|
|
|
assert Service.get_history_model().query.count() == 1
|