-
-
Notifications
You must be signed in to change notification settings - Fork 430
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1554bea
commit 5eb2ba9
Showing
7 changed files
with
229 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
from enum import Enum | ||
from typing import Optional | ||
|
||
from app.models import Alias, AliasAuditLog | ||
|
||
|
||
class AliasAuditLogAction(Enum): | ||
CreateAlias = "create" | ||
ChangeAliasStatus = "change_status" | ||
DeleteAlias = "delete" | ||
UpdateAlias = "update" | ||
InitiateTransferAlias = "initiate_transfer_alias" | ||
AcceptTransferAlias = "accept_transfer_alias" | ||
LoseOwnershipDueToTransferAlias = "lose_owner_due_to_transfer_alias" | ||
|
||
|
||
def emit_alias_audit_log( | ||
alias: Alias, | ||
action: AliasAuditLogAction, | ||
message: str, | ||
user_id: Optional[int] = None, | ||
commit: bool = False, | ||
): | ||
AliasAuditLog.create( | ||
user_id=user_id or alias.user_id, | ||
alias_id=alias.id, | ||
alias_email=alias.email, | ||
action=action.value, | ||
message=message, | ||
commit=commit, | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
45 changes: 45 additions & 0 deletions
45
migrations/versions/2024_101113_91ed7f46dc81_alias_audit_log.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
"""alias_audit_log | ||
Revision ID: 91ed7f46dc81 | ||
Revises: 62afa3a10010 | ||
Create Date: 2024-10-11 13:22:11.594054 | ||
""" | ||
import sqlalchemy_utils | ||
from alembic import op | ||
import sqlalchemy as sa | ||
|
||
|
||
# revision identifiers, used by Alembic. | ||
revision = '91ed7f46dc81' | ||
down_revision = '62afa3a10010' | ||
branch_labels = None | ||
depends_on = None | ||
|
||
|
||
def upgrade(): | ||
# ### commands auto generated by Alembic - please adjust! ### | ||
op.create_table('alias_audit_log', | ||
sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), | ||
sa.Column('created_at', sqlalchemy_utils.types.arrow.ArrowType(), nullable=False), | ||
sa.Column('updated_at', sqlalchemy_utils.types.arrow.ArrowType(), nullable=True), | ||
sa.Column('user_id', sa.Integer(), nullable=False), | ||
sa.Column('alias_id', sa.Integer(), nullable=False), | ||
sa.Column('alias_email', sa.String(length=255), nullable=False), | ||
sa.Column('action', sa.String(length=255), nullable=False), | ||
sa.Column('message', sa.Text(), nullable=True), | ||
sa.PrimaryKeyConstraint('id') | ||
) | ||
op.create_index('ix_alias_audit_log_alias_email', 'alias_audit_log', ['alias_email'], unique=False) | ||
op.create_index('ix_alias_audit_log_alias_id', 'alias_audit_log', ['alias_id'], unique=False) | ||
op.create_index('ix_alias_audit_log_user_id', 'alias_audit_log', ['user_id'], unique=False) | ||
# ### end Alembic commands ### | ||
|
||
|
||
def downgrade(): | ||
# ### commands auto generated by Alembic - please adjust! ### | ||
op.drop_index('ix_alias_audit_log_user_id', table_name='alias_audit_log') | ||
op.drop_index('ix_alias_audit_log_alias_id', table_name='alias_audit_log') | ||
op.drop_index('ix_alias_audit_log_alias_email', table_name='alias_audit_log') | ||
op.drop_table('alias_audit_log') | ||
# ### end Alembic commands ### |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
import random | ||
|
||
from app.alias_audit_log_utils import emit_alias_audit_log, AliasAuditLogAction | ||
from app.alias_utils import delete_alias, transfer_alias | ||
from app.models import Alias, AliasAuditLog, AliasDeleteReason | ||
from app.utils import random_string | ||
from tests.utils import create_new_user, random_email | ||
|
||
|
||
def test_emit_alias_audit_log_for_random_data(): | ||
user = create_new_user() | ||
alias = Alias.create( | ||
user_id=user.id, | ||
email=random_email(), | ||
mailbox_id=user.default_mailbox_id, | ||
) | ||
|
||
random_user_id = random.randint(1000, 2000) | ||
message = random_string() | ||
action = AliasAuditLogAction.ChangeAliasStatus | ||
emit_alias_audit_log( | ||
alias=alias, | ||
user_id=random_user_id, | ||
action=action, | ||
message=message, | ||
commit=True, | ||
) | ||
|
||
logs_for_alias = AliasAuditLog.filter_by(alias_id=alias.id).all() | ||
assert len(logs_for_alias) == 2 | ||
|
||
last_log = logs_for_alias[-1] | ||
assert last_log.alias_id == alias.id | ||
assert last_log.alias_email == alias.email | ||
assert last_log.user_id == random_user_id | ||
assert last_log.action == action.value | ||
assert last_log.message == message | ||
|
||
|
||
def test_emit_alias_audit_log_on_alias_creation(): | ||
user = create_new_user() | ||
alias = Alias.create( | ||
user_id=user.id, | ||
email=random_email(), | ||
mailbox_id=user.default_mailbox_id, | ||
) | ||
|
||
log_for_alias = AliasAuditLog.filter_by(alias_id=alias.id).all() | ||
assert len(log_for_alias) == 1 | ||
assert log_for_alias[0].alias_id == alias.id | ||
assert log_for_alias[0].alias_email == alias.email | ||
assert log_for_alias[0].user_id == user.id | ||
assert log_for_alias[0].action == AliasAuditLogAction.CreateAlias.value | ||
|
||
|
||
def test_alias_audit_log_exists_after_alias_deletion(): | ||
user = create_new_user() | ||
alias = Alias.create( | ||
user_id=user.id, | ||
email=random_email(), | ||
mailbox_id=user.default_mailbox_id, | ||
) | ||
alias_id = alias.id | ||
emit_alias_audit_log(alias, AliasAuditLogAction.UpdateAlias, "") | ||
emit_alias_audit_log(alias, AliasAuditLogAction.UpdateAlias, "") | ||
delete_alias(alias, user, AliasDeleteReason.ManualAction, commit=True) | ||
|
||
db_alias = Alias.get_by(id=alias_id) | ||
assert db_alias is None | ||
|
||
logs_for_alias = AliasAuditLog.filter_by(alias_id=alias.id).all() | ||
assert len(logs_for_alias) == 4 | ||
assert logs_for_alias[0].action == AliasAuditLogAction.CreateAlias.value | ||
assert logs_for_alias[1].action == AliasAuditLogAction.UpdateAlias.value | ||
assert logs_for_alias[2].action == AliasAuditLogAction.UpdateAlias.value | ||
assert logs_for_alias[3].action == AliasAuditLogAction.DeleteAlias.value | ||
|
||
|
||
def test_alias_audit_log_for_transfer(): | ||
original_user = create_new_user() | ||
new_user = create_new_user() | ||
alias = Alias.create( | ||
user_id=original_user.id, | ||
email=random_email(), | ||
mailbox_id=original_user.default_mailbox_id, | ||
) | ||
transfer_alias(alias, new_user, [new_user.default_mailbox]) | ||
|
||
logs_for_alias = AliasAuditLog.filter_by(alias_id=alias.id).all() | ||
assert len(logs_for_alias) == 3 | ||
assert logs_for_alias[0].action == AliasAuditLogAction.CreateAlias.value | ||
assert ( | ||
logs_for_alias[1].action | ||
== AliasAuditLogAction.LoseOwnershipDueToTransferAlias.value | ||
) | ||
assert logs_for_alias[1].user_id == original_user.id | ||
assert logs_for_alias[2].action == AliasAuditLogAction.AcceptTransferAlias.value | ||
assert logs_for_alias[2].user_id == new_user.id |