mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-20 23:41:17 -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.
174 lines
7.0 KiB
Python
174 lines
7.0 KiB
Python
import uuid
|
|
|
|
import pytest
|
|
from sqlalchemy.exc import SQLAlchemyError
|
|
|
|
from app import encryption
|
|
from app.dao.service_callback_api_dao import (
|
|
get_service_callback_api,
|
|
get_service_delivery_status_callback_api_for_service,
|
|
reset_service_callback_api,
|
|
save_service_callback_api,
|
|
)
|
|
from app.models import ServiceCallbackApi
|
|
from tests.app.db import create_service_callback_api
|
|
|
|
|
|
def test_save_service_callback_api(sample_service):
|
|
service_callback_api = ServiceCallbackApi(
|
|
service_id=sample_service.id,
|
|
url="https://some_service/callback_endpoint",
|
|
bearer_token="some_unique_string",
|
|
updated_by_id=sample_service.users[0].id
|
|
)
|
|
|
|
save_service_callback_api(service_callback_api)
|
|
|
|
results = ServiceCallbackApi.query.all()
|
|
assert len(results) == 1
|
|
callback_api = results[0]
|
|
assert callback_api.id is not None
|
|
assert callback_api.service_id == sample_service.id
|
|
assert callback_api.updated_by_id == sample_service.users[0].id
|
|
assert callback_api.url == "https://some_service/callback_endpoint"
|
|
assert callback_api.bearer_token == "some_unique_string"
|
|
assert callback_api._bearer_token != "some_unique_string"
|
|
assert callback_api.updated_at is None
|
|
|
|
versioned = ServiceCallbackApi.get_history_model().query.filter_by(id=callback_api.id).one()
|
|
assert versioned.id == callback_api.id
|
|
assert versioned.service_id == sample_service.id
|
|
assert versioned.updated_by_id == sample_service.users[0].id
|
|
assert versioned.url == "https://some_service/callback_endpoint"
|
|
assert encryption.decrypt(versioned._bearer_token) == "some_unique_string"
|
|
assert versioned.updated_at is None
|
|
assert versioned.version == 1
|
|
|
|
|
|
def test_save_service_callback_api_fails_if_service_does_not_exist(notify_db_session):
|
|
service_callback_api = ServiceCallbackApi(
|
|
service_id=uuid.uuid4(),
|
|
url="https://some_service/callback_endpoint",
|
|
bearer_token="some_unique_string",
|
|
updated_by_id=uuid.uuid4()
|
|
)
|
|
|
|
with pytest.raises(SQLAlchemyError):
|
|
save_service_callback_api(service_callback_api)
|
|
|
|
|
|
def test_update_service_callback_api_unique_constraint(sample_service):
|
|
service_callback_api = ServiceCallbackApi(
|
|
service_id=sample_service.id,
|
|
url="https://some_service/callback_endpoint",
|
|
bearer_token="some_unique_string",
|
|
updated_by_id=sample_service.users[0].id,
|
|
callback_type='delivery_status'
|
|
)
|
|
save_service_callback_api(service_callback_api)
|
|
another = ServiceCallbackApi(
|
|
service_id=sample_service.id,
|
|
url="https://some_service/another_callback_endpoint",
|
|
bearer_token="different_string",
|
|
updated_by_id=sample_service.users[0].id,
|
|
callback_type='delivery_status'
|
|
)
|
|
with pytest.raises(expected_exception=SQLAlchemyError):
|
|
save_service_callback_api(another)
|
|
|
|
|
|
def test_update_service_callback_can_add_two_api_of_different_types(sample_service):
|
|
delivery_status = ServiceCallbackApi(
|
|
service_id=sample_service.id,
|
|
url="https://some_service/callback_endpoint",
|
|
bearer_token="some_unique_string",
|
|
updated_by_id=sample_service.users[0].id,
|
|
callback_type='delivery_status'
|
|
)
|
|
save_service_callback_api(delivery_status)
|
|
complaint = ServiceCallbackApi(
|
|
service_id=sample_service.id,
|
|
url="https://some_service/another_callback_endpoint",
|
|
bearer_token="different_string",
|
|
updated_by_id=sample_service.users[0].id,
|
|
callback_type='complaint'
|
|
)
|
|
save_service_callback_api(complaint)
|
|
results = ServiceCallbackApi.query.order_by(ServiceCallbackApi.callback_type).all()
|
|
assert len(results) == 2
|
|
assert results[0].serialize() == complaint.serialize()
|
|
assert results[1].serialize() == delivery_status.serialize()
|
|
|
|
|
|
def test_update_service_callback_api(sample_service):
|
|
service_callback_api = ServiceCallbackApi(
|
|
service_id=sample_service.id,
|
|
url="https://some_service/callback_endpoint",
|
|
bearer_token="some_unique_string",
|
|
updated_by_id=sample_service.users[0].id
|
|
)
|
|
|
|
save_service_callback_api(service_callback_api)
|
|
results = ServiceCallbackApi.query.all()
|
|
assert len(results) == 1
|
|
saved_callback_api = results[0]
|
|
|
|
reset_service_callback_api(saved_callback_api, updated_by_id=sample_service.users[0].id,
|
|
url="https://some_service/changed_url")
|
|
updated_results = ServiceCallbackApi.query.all()
|
|
assert len(updated_results) == 1
|
|
updated = updated_results[0]
|
|
assert updated.id is not None
|
|
assert updated.service_id == sample_service.id
|
|
assert updated.updated_by_id == sample_service.users[0].id
|
|
assert updated.url == "https://some_service/changed_url"
|
|
assert updated.bearer_token == "some_unique_string"
|
|
assert updated._bearer_token != "some_unique_string"
|
|
assert updated.updated_at is not None
|
|
|
|
versioned_results = ServiceCallbackApi.get_history_model().query.filter_by(id=saved_callback_api.id).all()
|
|
assert len(versioned_results) == 2
|
|
for x in versioned_results:
|
|
if x.version == 1:
|
|
assert x.url == "https://some_service/callback_endpoint"
|
|
assert not x.updated_at
|
|
elif x.version == 2:
|
|
assert x.url == "https://some_service/changed_url"
|
|
assert x.updated_at
|
|
else:
|
|
pytest.fail("version should not exist")
|
|
assert x.id is not None
|
|
assert x.service_id == sample_service.id
|
|
assert x.updated_by_id == sample_service.users[0].id
|
|
assert encryption.decrypt(x._bearer_token) == "some_unique_string"
|
|
|
|
|
|
def test_get_service_callback_api(sample_service):
|
|
service_callback_api = ServiceCallbackApi(
|
|
service_id=sample_service.id,
|
|
url="https://some_service/callback_endpoint",
|
|
bearer_token="some_unique_string",
|
|
updated_by_id=sample_service.users[0].id
|
|
)
|
|
save_service_callback_api(service_callback_api)
|
|
|
|
callback_api = get_service_callback_api(service_callback_api.id, sample_service.id)
|
|
assert callback_api.id is not None
|
|
assert callback_api.service_id == sample_service.id
|
|
assert callback_api.updated_by_id == sample_service.users[0].id
|
|
assert callback_api.url == "https://some_service/callback_endpoint"
|
|
assert callback_api.bearer_token == "some_unique_string"
|
|
assert callback_api._bearer_token != "some_unique_string"
|
|
assert callback_api.updated_at is None
|
|
|
|
|
|
def test_get_service_delivery_status_callback_api_for_service(sample_service):
|
|
service_callback_api = create_service_callback_api(service=sample_service)
|
|
result = get_service_delivery_status_callback_api_for_service(sample_service.id)
|
|
assert result.id == service_callback_api.id
|
|
assert result.url == service_callback_api.url
|
|
assert result.bearer_token == service_callback_api.bearer_token
|
|
assert result.created_at == service_callback_api.created_at
|
|
assert result.updated_at == service_callback_api.updated_at
|
|
assert result.updated_by_id == service_callback_api.updated_by_id
|