mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-23 00:41:35 -05:00
6181c60f75
* notify_db fixture creates the database connection and ensures the test db exists and has migrations applied etc. It will run once per session (test run). * notify_db_session fixture runs after your test finishes and deletes all non static (eg type table) data. In unit tests that hit the database (ie: most of them), 99% of the time we will need to use notify_db_session to ensure everything is reset. The only time we don't need to use it is when we're querying things such as "ensure get X works when database is empty". This is such a low percentage of tests that it's easier for us to just use notify_db_session every time, and ensure that all our tests run much more consistently, at the cost of a small bit of performance when running tests. We used to use notify_db to access the session object for manually adding, committing, etc. To dissuade usage of that fixture I've moved that to the `notify_db_session`. I've then removed all uses of notify_db that I could find in the codebase. As a note, if you're writing a test that uses a `sample_x` fixture, all of those fixtures rely on notify_db_session so you'll get the teardown functionality for free. If you're just calling eg `create_x` db.py functions, then you'll need to make you add notify_db_session fixture to your test, even if you aren't manually accessing the session.
134 lines
5.3 KiB
Python
134 lines
5.3 KiB
Python
from datetime import datetime, timedelta
|
|
|
|
import pytest
|
|
from sqlalchemy.exc import IntegrityError
|
|
from sqlalchemy.orm.exc import NoResultFound
|
|
|
|
from app.dao.api_key_dao import (
|
|
expire_api_key,
|
|
get_model_api_keys,
|
|
get_unsigned_secret,
|
|
get_unsigned_secrets,
|
|
save_model_api_key,
|
|
)
|
|
from app.models import KEY_TYPE_NORMAL, ApiKey
|
|
|
|
|
|
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_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] == 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 == 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_can_create_key_with_same_name_if_other_is_expired(sample_service):
|
|
expired_api_key = ApiKey(**{'service': sample_service,
|
|
'name': "normal api key",
|
|
'created_by': sample_service.created_by,
|
|
'key_type': KEY_TYPE_NORMAL,
|
|
'expiry_date': datetime.utcnow()})
|
|
save_model_api_key(expired_api_key)
|
|
api_key = ApiKey(**{'service': sample_service,
|
|
'name': "normal api key",
|
|
'created_by': sample_service.created_by,
|
|
'key_type': KEY_TYPE_NORMAL})
|
|
save_model_api_key(api_key)
|
|
keys = ApiKey.query.all()
|
|
assert len(keys) == 2
|
|
|
|
|
|
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
|
|
|
|
|
|
@pytest.mark.parametrize('days_old, expected_length', [(5, 1), (8, 0)])
|
|
def test_should_not_return_revoked_api_keys_older_than_7_days(
|
|
sample_service,
|
|
days_old,
|
|
expected_length
|
|
):
|
|
expired_api_key = ApiKey(**{'service': sample_service,
|
|
'name': sample_service.name,
|
|
'created_by': sample_service.created_by,
|
|
'key_type': KEY_TYPE_NORMAL,
|
|
'expiry_date': datetime.utcnow() - timedelta(days=days_old)})
|
|
save_model_api_key(expired_api_key)
|
|
|
|
all_api_keys = get_model_api_keys(service_id=sample_service.id)
|
|
|
|
assert len(all_api_keys) == expected_length
|