1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
|
import datetime as dt
import ddf
import pytest
from django.contrib.auth.models import User
from django.core.exceptions import FieldDoesNotExist
from django.db import transaction
from django.db.utils import NotSupportedError
import pgtrigger
from pgtrigger import core
from pgtrigger.tests import models, utils
def test_func():
"""Tests using custom Func object"""
trigger = pgtrigger.Trigger(
name="example",
when=pgtrigger.After,
operation=pgtrigger.Delete,
func=pgtrigger.Func("SELECT {columns.int_field} FROM {meta.db_table}"),
)
assert trigger.render_func(models.TestModel) == "SELECT int_field FROM tests_testmodel"
@pytest.mark.django_db
def test_partition():
p1 = ddf.G(models.PartitionModel, timestamp=dt.datetime(2019, 1, 3))
p2 = ddf.G(models.PartitionModel, timestamp=dt.datetime(2019, 2, 4))
p3 = ddf.G(models.PartitionModel, timestamp=dt.datetime(2019, 3, 5))
default = ddf.G(models.PartitionModel, timestamp=dt.datetime(2019, 4, 5))
with utils.raises_trigger_error(match="Cannot delete"):
p1.delete()
with utils.raises_trigger_error(match="Cannot delete"):
p2.delete()
with utils.raises_trigger_error(match="Cannot delete"):
p3.delete()
with utils.raises_trigger_error(match="Cannot delete"):
default.delete()
with pgtrigger.ignore("tests.PartitionModel:protect_delete"):
p1.delete()
p2.delete()
p3.delete()
default.delete()
@pytest.mark.django_db
def test_through_model():
"""
Tests the "ThroughTrigger" model to verify that triggers execute on M2M through models
"""
test_trigger = ddf.G(models.TestTrigger)
test_trigger.m2m_field.add(ddf.G("auth.User"))
with utils.raises_trigger_error(match="Cannot delete"):
test_trigger.m2m_field.clear()
@pytest.mark.django_db
def test_statement_row_level_logging():
"""
Updates "ToLogModel" entries, which have statement, row-level,
and referencing statement triggers that create log entries.
"""
ddf.G(models.ToLogModel, n=5, field="old_field")
assert models.ToLogModel.objects.count() == 5
assert not models.LogEntry.objects.exists()
models.ToLogModel.objects.update(field="new_field")
# The statement-level trigger without references should have produced
# one log entry
assert models.LogEntry.objects.filter(level="STATEMENT", old_field__isnull=True).count() == 1
# Verify that we can ignore statement-level triggers. The `ToLogModel` should still update, but
# no triggers should fire
with pgtrigger.ignore(
"tests.ToLogModel:after_update_statement_test",
"tests.ToLogModel:update_of_statement_test",
"tests.ToLogModel:after_update_row_test",
):
models.ToLogModel.objects.update(field="new_field2")
assert set(models.ToLogModel.objects.values_list("field", flat=True)) == {"new_field2"}
assert (
models.LogEntry.objects.filter(level="STATEMENT", old_field__isnull=True).count() == 1
)
# The statement-level trigger with references should have made log
# entries for all of the old values and the new updated values
assert models.LogEntry.objects.filter(level="STATEMENT", old_field__isnull=False).count() == 5
assert (
models.LogEntry.objects.filter(
level="STATEMENT", old_field="old_field", new_field="new_field"
).count()
== 5
)
# The row-level trigger should have produced five entries
assert models.LogEntry.objects.filter(level="ROW").count() == 5
obj = models.ToLogModel.objects.first()
obj.save()
# A duplicate update shouldn't fire any more row-level log entries
assert models.LogEntry.objects.filter(level="ROW").count() == 5
@pytest.mark.django_db(transaction=True)
def test_deferred_trigger():
"""
Tests deferrable execution of a trigger
"""
# Make the LogEntry model a soft delete model where
# "level" is set to "inactive"
trigger = pgtrigger.Protect(
name="protect_delete",
when=pgtrigger.After,
operation=pgtrigger.Delete,
timing=pgtrigger.Deferred,
)
with trigger.register(models.TestModel), trigger.install(models.TestModel):
obj = ddf.G(models.TestModel)
deferring_worked = False
with utils.raises_trigger_error(match="Cannot delete"):
with transaction.atomic():
obj.delete()
# Deletion works within the transaction, but fails
# when the transaction commits.
assert not models.TestModel.objects.exists()
deferring_worked = True
assert deferring_worked
assert models.TestModel.objects.exists()
obj = models.TestModel.objects.get()
# Verify that we can ignore deferrable triggers
with pgtrigger.ignore("tests.TestModel:protect_delete"):
with transaction.atomic():
obj.delete()
assert not models.TestModel.objects.exists()
# The object should still not exist outside of the transaction
assert not models.TestModel.objects.exists()
@pytest.mark.django_db
def test_updating_trigger_condition():
"""
Tests re-installing a trigger when the condition changes
"""
# Make the LogEntry model a soft delete model where
# "level" is set to "inactive"
trigger = pgtrigger.Protect(name="protect_delete", operation=pgtrigger.Delete)
with trigger.install(models.LogEntry):
le = ddf.G(models.LogEntry, level="good")
with utils.raises_trigger_error(match="Cannot delete"):
le.delete()
# Protect deletes when "level" is "bad". The trigger should be reinstalled
# appropriately
trigger.condition = pgtrigger.Q(old__level="bad")
with trigger.install(models.LogEntry):
le.delete()
def test_declaration_rendering():
"""Verifies that triggers with a DECLARE are rendered correctly"""
class DeclaredTrigger(pgtrigger.Trigger):
def get_declare(self, model):
return [("var_name", "UUID")]
rendered = DeclaredTrigger(
name="test", when=pgtrigger.Before, operation=pgtrigger.Insert
).render_declare(None)
assert rendered == "DECLARE var_name UUID;"
class DeclaredTriggerMultiple(pgtrigger.Trigger):
def get_declare(self, model):
return [("var_name", "UUID"), ("var2_name", "UUID")]
rendered = DeclaredTriggerMultiple(
name="test", when=pgtrigger.Before, operation=pgtrigger.Insert
).render_declare(None)
assert rendered == "DECLARE var_name UUID; var2_name UUID;"
def test_f():
"""Tests various properties of the pgtrigger.F object"""
with pytest.raises(ValueError, match="must reference"):
pgtrigger.F("bad_value")
assert pgtrigger.F("old__value").resolved_name == 'OLD."value"'
@pytest.mark.django_db
def test_is_distinct_from_condition():
"""Tests triggers where the old and new are distinct from one another
Note that distinct is the not the same as not being equal since nulls
are never equal
"""
test_model = ddf.G(models.TestTrigger, int_field=0)
# Protect a field from being updated to a different value
trigger = pgtrigger.Protect(
name="protect",
when=pgtrigger.Before,
operation=pgtrigger.Update,
condition=pgtrigger.Q(old__int_field__df=pgtrigger.F("new__int_field"))
| pgtrigger.Q(new__nullable__df=pgtrigger.F("old__nullable")),
)
with trigger.install(models.TestTrigger):
with utils.raises_trigger_error(match="Cannot update rows"):
test_model.int_field = 1
test_model.save()
# Ensure the null case works
with utils.raises_trigger_error(match="Cannot update rows"):
test_model.nullable = "1"
test_model.save()
# Saving the same values should work fine
test_model.int_field = 0
test_model.nullable = None
test_model.save()
@pytest.mark.django_db
def test_invalid_trigger():
"""Ensures triggers with invalid syntax are not installed"""
# Truncates can only be used on statement level triggers
trigger = pgtrigger.Protect(
name="test_invalid",
operation=pgtrigger.Truncate,
)
with pytest.raises(NotSupportedError, match="are not supported"):
trigger.install(models.TestTrigger)
@pytest.mark.django_db
def test_is_distinct_from_condition_fk_field():
"""Tests triggers where the old and new are distinct from one another
on a foreign key field
Django doesnt support custom lookups by default, and this tests some
of the overridden behavior
"""
test_int_fk_model = ddf.G(models.TestTrigger, fk_field=None)
# Protect a foreign key from being updated to a different value
trigger = pgtrigger.Protect(
name="test_is_distinct_from_condition_fk_field1",
when=pgtrigger.Before,
operation=pgtrigger.Update,
condition=pgtrigger.Q(old__fk_field__df=pgtrigger.F("new__fk_field")),
)
with trigger.install(models.TestTrigger):
with utils.raises_trigger_error(match="Cannot update rows"):
test_int_fk_model.fk_field = User(id=1)
test_int_fk_model.save()
# Saving the same values should work fine
test_int_fk_model.fk_field = None
test_int_fk_model.save()
# Protect a non-int foreign key from being updated to a different value
char_pk = ddf.G(models.CharPk)
test_char_fk_model = ddf.G(models.TestTrigger, char_pk_fk_field=char_pk)
trigger = pgtrigger.Protect(
name="test_is_distinct_from_condition_fk_field2",
when=pgtrigger.Before,
operation=pgtrigger.Update,
condition=pgtrigger.Q(old__char_pk_fk_field__df=pgtrigger.F("new__char_pk_fk_field")),
)
with trigger.install(models.TestTrigger):
with utils.raises_trigger_error(match="Cannot update rows"):
test_char_fk_model.char_pk_fk_field = None
test_char_fk_model.save()
# Saving the same values should work fine
test_char_fk_model.char_pk_fk_field = char_pk
test_char_fk_model.save()
@pytest.mark.django_db
def test_is_not_distinct_from_condition():
"""Tests triggers where the old and new are not distinct from one another
Note that distinct is the not the same as not being equal since nulls
are never equal
"""
test_model = ddf.G(models.TestTrigger, int_field=0)
# Protect a field from being updated to the same value. In this case,
# both int_field and nullable need to change in order for the update to
# happen
trigger = pgtrigger.Protect(
name="test_is_not_distinct_from_condition1",
when=pgtrigger.Before,
operation=pgtrigger.Update,
condition=pgtrigger.Q(old__int_field__ndf=pgtrigger.F("new__int_field"))
| pgtrigger.Q(old__nullable__ndf=pgtrigger.F("new__nullable")),
)
with trigger.install(models.TestTrigger):
with utils.raises_trigger_error(match="Cannot update rows"):
test_model.int_field = 1
test_model.save()
# Ensure the null case works
with utils.raises_trigger_error(match="Cannot update rows"):
test_model.int_field = 0
test_model.nullable = "1"
test_model.save()
# Updating both fields will ignore the trigger
test_model.int_field = 1
test_model.nullable = "1"
test_model.save()
def test_max_name_length(mocker):
"""
Verifies that a trigger with the exact MAX_NAME_LENGTH can be installed
fine. Also checks that going above this by one character results in
a database error
"""
# Protect a field from being updated to the same value. In this case,
# both int_field and nullable need to change in order for the update to
# happen
trigger = pgtrigger.Protect(
name="t" * core.MAX_NAME_LENGTH,
operation=pgtrigger.Update,
)
assert trigger.get_pgid(models.TestTrigger)
mocker.patch.object(pgtrigger.Protect, "validate_name")
with pytest.raises(ValueError):
trigger = pgtrigger.Protect(
name="a" * (core.MAX_NAME_LENGTH + 1),
operation=pgtrigger.Update,
)
trigger.get_pgid(models.TestTrigger)
def test_invalid_name_characters(mocker):
"""
Verifies that trigger names must contain only alphanumeric
characters, hyphens, or underscores
"""
pgtrigger.Protect(
name="hello_world-111",
operation=pgtrigger.Update,
)
with pytest.raises(ValueError, match="alphanumeric"):
pgtrigger.Protect(
name="hello.world",
operation=pgtrigger.Update,
)
@pytest.mark.django_db
def test_complex_conditions():
"""Tests complex OLD and NEW trigger conditions"""
zero_to_one = ddf.G(models.TestModel, int_field=0)
# Dont let intfield go from 0 -> 1
trigger = pgtrigger.Protect(
name="test_complex_conditions1",
when=pgtrigger.Before,
operation=pgtrigger.Update,
condition=pgtrigger.Q(old__int_field=0, new__int_field=1),
)
with trigger.install(models.TestModel):
with utils.raises_trigger_error(match="Cannot update rows"):
zero_to_one.int_field = 1
zero_to_one.save()
# Test a condition with a datetime field
test_model = ddf.G(models.TestTrigger, int_field=0, dt_field=dt.datetime(2020, 1, 1))
trigger = pgtrigger.Protect(
name="test_complex_conditions2",
when=pgtrigger.Before,
operation=pgtrigger.Update,
condition=(
pgtrigger.Q(old__int_field=0, new__int_field=1)
| pgtrigger.Q(new__dt_field__lt=dt.datetime(2020, 1, 1))
),
)
with trigger.install(models.TestTrigger):
with utils.raises_trigger_error(match="Cannot update rows"):
test_model.int_field = 1
test_model.save()
test_model.int_field = 2
test_model.save()
with utils.raises_trigger_error(match="Cannot update rows"):
test_model.dt_field = dt.datetime(2019, 1, 1)
test_model.save()
def test_referencing_rendering():
"""Verifies the rendering of the Referencing construct"""
assert (
str(pgtrigger.Referencing(old="old_table")).strip() == "REFERENCING OLD TABLE AS old_table"
)
assert (
str(pgtrigger.Referencing(new="new_table")).strip() == "REFERENCING NEW TABLE AS new_table"
)
assert (
str(pgtrigger.Referencing(old="old_table", new="new_table")).strip()
== "REFERENCING OLD TABLE AS old_table NEW TABLE AS new_table"
)
def test_arg_checks():
"""
There are quite a few places that check arguments in the trigger module.
Enumerate these cases here to make sure they work
"""
with pytest.raises(ValueError, match='Must provide either "old" and/or "new"'):
pgtrigger.Referencing()
with pytest.raises(ValueError, match="Must provide SQL"):
pgtrigger.Condition()
with pytest.raises(ValueError, match="Must provide at least one"):
pgtrigger.UpdateOf()
with pytest.raises(ValueError, match='must have "name"'):
pgtrigger.Trigger(when=pgtrigger.Before, operation=pgtrigger.Update)
with pytest.raises(ValueError, match='Invalid "level"'):
pgtrigger.Trigger(level="invalid")
with pytest.raises(ValueError, match='Invalid "when"'):
pgtrigger.Trigger(when="invalid")
with pytest.raises(ValueError, match='Invalid "operation"'):
pgtrigger.Trigger(when=pgtrigger.Before, operation="invalid")
with pytest.raises(ValueError, match='Invalid "timing"'):
pgtrigger.Trigger(when=pgtrigger.Before, operation=pgtrigger.Update, timing="timing")
with pytest.raises(ValueError, match="Row-level triggers cannot have"):
pgtrigger.Trigger(
when=pgtrigger.Before,
operation=pgtrigger.Update,
referencing=pgtrigger.Referencing(old="old_table"),
)
with pytest.raises(ValueError, match='must have "level" attribute'):
pgtrigger.Trigger(
level=pgtrigger.Statement,
when=pgtrigger.After,
operation=pgtrigger.Update,
timing=pgtrigger.Immediate,
)
with pytest.raises(ValueError, match='must have "when" attribute'):
pgtrigger.Trigger(
level=pgtrigger.Row,
when=pgtrigger.Before,
operation=pgtrigger.Update,
timing=pgtrigger.Immediate,
)
with pytest.raises(ValueError, match="Must define func"):
pgtrigger.Trigger(name="test", when=pgtrigger.Before, operation=pgtrigger.Update).get_func(
None
)
with pytest.raises(ValueError, match="> 47"):
pgtrigger.Trigger( # noqa
when=pgtrigger.Before, operation=pgtrigger.Update, name="1" * 48
).pgid
def test_operations():
"""Tests Operation objects and ORing them together"""
assert str(pgtrigger.Update) == "UPDATE"
assert str(pgtrigger.UpdateOf("col1")) == 'UPDATE OF "col1"'
assert str(pgtrigger.UpdateOf("c1", "c2")) == 'UPDATE OF "c1", "c2"'
assert str(pgtrigger.Update | pgtrigger.Delete) == "UPDATE OR DELETE"
assert (
str(pgtrigger.Update | pgtrigger.Delete | pgtrigger.Insert) == "UPDATE OR DELETE OR INSERT"
)
assert str(pgtrigger.Delete | pgtrigger.Update) == "DELETE OR UPDATE"
@pytest.mark.django_db
def test_custom_trigger_definitions():
"""Test a variety of custom trigger definitions"""
test_model = ddf.G(models.TestTrigger)
# Protect against inserts or updates
# Note: Although we could use the "protect" trigger for this,
# we manually provide the trigger code to test manual declarations
trigger = pgtrigger.Trigger(
name="test_custom_definition1",
when=pgtrigger.Before,
operation=pgtrigger.Insert | pgtrigger.Update,
func="RAISE EXCEPTION 'no no no!';",
)
with trigger.install(test_model):
# Inserts and updates are no longer available
with utils.raises_trigger_error(match="no no no!"):
models.TestTrigger.objects.create()
with utils.raises_trigger_error(match="no no no!"):
test_model.save()
# Inserts and updates should work again
ddf.G(models.TestTrigger)
test_model.save()
# Protect updates of a single column
trigger = pgtrigger.Trigger(
name="test_custom_definition2",
when=pgtrigger.Before,
operation=pgtrigger.UpdateOf("int_field"),
func="RAISE EXCEPTION 'no no no!';",
)
with trigger.install(models.TestTrigger):
# "field" should be able to be updated, but other_field should not
test_model.save(update_fields=["field"])
with utils.raises_trigger_error(match="no no no!"):
test_model.save(update_fields=["int_field"])
# Protect statement-level creates
trigger = pgtrigger.Trigger(
name="test_custom_definition3",
level=pgtrigger.Statement,
when=pgtrigger.Before,
operation=pgtrigger.Update,
func="RAISE EXCEPTION 'bad statement!';",
)
with trigger.install(models.TestTrigger):
with utils.raises_trigger_error(match="bad statement!"):
test_model.save()
@pytest.mark.django_db
def test_trigger_conditions():
"""Tests triggers with custom conditions"""
test_model = ddf.G(models.TestTrigger)
# Protect against inserts only when "field" is "hello"
trigger = pgtrigger.Trigger(
name="test_condition1",
when=pgtrigger.Before,
operation=pgtrigger.Insert,
func="RAISE EXCEPTION 'no no no!';",
condition=pgtrigger.Q(new__field="hello"),
)
with trigger.install(test_model):
ddf.G(models.TestTrigger, field="hi!")
with utils.raises_trigger_error(match="no no no!"):
models.TestTrigger.objects.create(field="hello")
# Protect updates where nothing is actually updated
trigger = pgtrigger.Trigger(
name="test_condition2",
when=pgtrigger.Before,
operation=pgtrigger.Update,
func="RAISE EXCEPTION 'no no no!';",
condition=pgtrigger.Condition("OLD.* IS NOT DISTINCT FROM NEW.*"),
)
with trigger.install(test_model):
test_model.int_field = test_model.int_field + 1
test_model.save()
# Saving the same fields again will cause an error
with utils.raises_trigger_error(match="no no no!"):
test_model.save()
# Make a model readonly when the int_field is -1
read_only = ddf.G(models.TestModel, int_field=-1)
non_read_only = ddf.G(models.TestModel, int_field=-2)
trigger = pgtrigger.Trigger(
name="test_condition3",
when=pgtrigger.Before,
operation=pgtrigger.Update | pgtrigger.Delete,
func="RAISE EXCEPTION 'no no no!';",
condition=pgtrigger.Q(old__int_field=-1),
)
with trigger.install(models.TestModel):
with utils.raises_trigger_error(match="no no no!"):
read_only.save()
with utils.raises_trigger_error(match="no no no!"):
read_only.delete()
non_read_only.save()
non_read_only.delete()
@pytest.mark.parametrize(
"condition, expected_sql",
[
(pgtrigger.AnyChange(), "OLD.* IS DISTINCT FROM NEW.*"),
(pgtrigger.AnyDontChange(), "OLD.* IS NOT DISTINCT FROM NEW.*"),
(
pgtrigger.AllChange(),
'(OLD."char_pk_fk_field_id" IS DISTINCT FROM (NEW."char_pk_fk_field_id") AND OLD."dt_field" IS DISTINCT FROM (NEW."dt_field") AND OLD."field" IS DISTINCT FROM (NEW."field") AND OLD."fk_field_id" IS DISTINCT FROM (NEW."fk_field_id") AND OLD."id" IS DISTINCT FROM (NEW."id") AND OLD."int_field" IS DISTINCT FROM (NEW."int_field") AND OLD."nullable" IS DISTINCT FROM (NEW."nullable"))', # noqa
),
(
pgtrigger.AllDontChange(),
'(OLD."char_pk_fk_field_id" IS NOT DISTINCT FROM (NEW."char_pk_fk_field_id") AND OLD."dt_field" IS NOT DISTINCT FROM (NEW."dt_field") AND OLD."field" IS NOT DISTINCT FROM (NEW."field") AND OLD."fk_field_id" IS NOT DISTINCT FROM (NEW."fk_field_id") AND OLD."id" IS NOT DISTINCT FROM (NEW."id") AND OLD."int_field" IS NOT DISTINCT FROM (NEW."int_field") AND OLD."nullable" IS NOT DISTINCT FROM (NEW."nullable"))', # noqa
),
(~pgtrigger.AnyChange(), "NOT (OLD.* IS DISTINCT FROM NEW.*)"),
(
~pgtrigger.AllChange(),
'NOT ((OLD."char_pk_fk_field_id" IS DISTINCT FROM (NEW."char_pk_fk_field_id") AND OLD."dt_field" IS DISTINCT FROM (NEW."dt_field") AND OLD."field" IS DISTINCT FROM (NEW."field") AND OLD."fk_field_id" IS DISTINCT FROM (NEW."fk_field_id") AND OLD."id" IS DISTINCT FROM (NEW."id") AND OLD."int_field" IS DISTINCT FROM (NEW."int_field") AND OLD."nullable" IS DISTINCT FROM (NEW."nullable")))', # noqa
),
(pgtrigger.AnyChange("field"), 'OLD."field" IS DISTINCT FROM (NEW."field")'),
(pgtrigger.AllChange("field"), 'OLD."field" IS DISTINCT FROM (NEW."field")'),
(~pgtrigger.AnyChange("field"), 'NOT (OLD."field" IS DISTINCT FROM (NEW."field"))'),
(~pgtrigger.AllChange("field"), 'NOT (OLD."field" IS DISTINCT FROM (NEW."field"))'),
(
pgtrigger.AnyChange("int_field", "dt_field"),
'(OLD."dt_field" IS DISTINCT FROM (NEW."dt_field") OR OLD."int_field" IS DISTINCT FROM (NEW."int_field"))', # noqa
),
(
pgtrigger.AnyDontChange("dt_field", "fk_field"),
'(OLD."dt_field" IS NOT DISTINCT FROM (NEW."dt_field") OR OLD."fk_field_id" IS NOT DISTINCT FROM (NEW."fk_field_id"))', # noqa
),
(
pgtrigger.AllChange("int_field", "dt_field"),
'(OLD."dt_field" IS DISTINCT FROM (NEW."dt_field") AND OLD."int_field" IS DISTINCT FROM (NEW."int_field"))', # noqa
),
(
pgtrigger.AllDontChange("int_field", "dt_field"),
'(OLD."dt_field" IS NOT DISTINCT FROM (NEW."dt_field") AND OLD."int_field" IS NOT DISTINCT FROM (NEW."int_field"))', # noqa
),
(
pgtrigger.AnyChange("int_field", "dt_field", exclude=["int_field"]),
'OLD."dt_field" IS DISTINCT FROM (NEW."dt_field")',
),
(
pgtrigger.AnyChange(
"fk_field",
"char_pk_fk_field",
"int_field",
"dt_field",
exclude=["char_pk_fk_field", "field"],
exclude_auto=True,
),
'(OLD."fk_field_id" IS DISTINCT FROM (NEW."fk_field_id") OR OLD."int_field" IS DISTINCT FROM (NEW."int_field"))', # noqa
),
(
pgtrigger.AnyChange(exclude_auto=True),
'(OLD."char_pk_fk_field_id" IS DISTINCT FROM (NEW."char_pk_fk_field_id") OR OLD."field" IS DISTINCT FROM (NEW."field") OR OLD."fk_field_id" IS DISTINCT FROM (NEW."fk_field_id") OR OLD."id" IS DISTINCT FROM (NEW."id") OR OLD."int_field" IS DISTINCT FROM (NEW."int_field") OR OLD."nullable" IS DISTINCT FROM (NEW."nullable"))', # noqa
),
(
pgtrigger.AllChange(exclude_auto=True),
'(OLD."char_pk_fk_field_id" IS DISTINCT FROM (NEW."char_pk_fk_field_id") AND OLD."field" IS DISTINCT FROM (NEW."field") AND OLD."fk_field_id" IS DISTINCT FROM (NEW."fk_field_id") AND OLD."id" IS DISTINCT FROM (NEW."id") AND OLD."int_field" IS DISTINCT FROM (NEW."int_field") AND OLD."nullable" IS DISTINCT FROM (NEW."nullable"))', # noqa
),
],
)
def test_changed_condition(condition, expected_sql):
"""Tests the pgtrigger.Changed condition utility"""
assert condition.resolve(models.ChangedCondition) == expected_sql
def test_changed_condition_bad_field():
"""Verifies incorrect fields aren't allowed in changed conditions"""
with pytest.raises(FieldDoesNotExist, match="has no field"):
pgtrigger.AnyChange("bad_field").resolve(models.ChangedCondition)
with pytest.raises(ValueError, match="many-to-many field"):
pgtrigger.AnyChange("m2m_field").resolve(models.ChangedCondition)
with pytest.raises(FieldDoesNotExist, match="has no field"):
pgtrigger.AnyChange(exclude=["bad_field"]).resolve(models.ChangedCondition)
# Abstract inheritance should work
pgtrigger.AnyChange("field").resolve(models.AbstractChild)
# Referencing foreign key IDs should work
pgtrigger.AnyChange("fk_field_id").resolve(models.ChangedCondition)
@pytest.mark.django_db(databases=["default", "other"], transaction=True)
@pytest.mark.order(-2) # This is a leaky test that modifies the schema. Always run last
def test_trigger_management(mocker):
"""Verifies dropping and recreating triggers works"""
deletion_protected_model = ddf.G(models.TestTrigger)
# Triggers should be installed initially
with utils.raises_trigger_error(match="Cannot delete rows"):
deletion_protected_model.delete()
# Deactivate triggers. Deletions should happen without issue.
# Note: run twice for idempotency checks
pgtrigger.disable()
pgtrigger.disable()
deletion_protected_model.delete()
# Reactivate triggers. Deletions should be protected
pgtrigger.enable()
pgtrigger.enable()
deletion_protected_model = ddf.G(models.TestTrigger)
with utils.raises_trigger_error(match="Cannot delete rows"):
deletion_protected_model.delete()
# Do the same tests again, except this time uninstall and reinstall
# triggers
pgtrigger.uninstall()
pgtrigger.uninstall()
deletion_protected_model.delete()
# Reactivate triggers. Deletions should be protected
pgtrigger.install()
pgtrigger.install()
deletion_protected_model = ddf.G(models.TestTrigger)
with utils.raises_trigger_error(match="Cannot delete rows"):
deletion_protected_model.delete()
# Pruning triggers should do nothing at the moment
pgtrigger.prune()
pgtrigger.prune()
with utils.raises_trigger_error(match="Cannot delete rows"):
deletion_protected_model.delete()
# However, changing the trigger name will cause the old triggers to
# be pruned
mocker.patch(
"pgtrigger.Protect.name",
new_callable=mocker.PropertyMock,
return_value="hi",
)
pgtrigger.prune()
pgtrigger.prune()
deletion_protected_model.delete()
|