| 1 |
from django.core.exceptions import FieldError |
| 2 |
from django.db import connection |
| 3 |
from django.db.models import F |
| 4 |
from django.test import TestCase |
| 5 |
|
| 6 |
from .models import Comment, Tenant, TimeStamped, Token, User |
| 7 |
|
| 8 |
|
| 9 |
class CompositePKUpdateTests(TestCase): |
| 10 |
maxDiff = None |
| 11 |
|
| 12 |
@classmethod |
| 13 |
def setUpTestData(cls): |
| 14 |
cls.tenant_1 = Tenant.objects.create(name="A") |
| 15 |
cls.tenant_2 = Tenant.objects.create(name="B") |
| 16 |
cls.user_1 = User.objects.create( |
| 17 |
tenant=cls.tenant_1, |
| 18 |
id=1, |
| 19 |
email="[email protected]", |
| 20 |
) |
| 21 |
cls.user_2 = User.objects.create( |
| 22 |
tenant=cls.tenant_1, |
| 23 |
id=2, |
| 24 |
email="[email protected]", |
| 25 |
) |
| 26 |
cls.user_3 = User.objects.create( |
| 27 |
tenant=cls.tenant_2, |
| 28 |
id=3, |
| 29 |
email="[email protected]", |
| 30 |
) |
| 31 |
cls.comment_1 = Comment.objects.create(id=1, user=cls.user_1) |
| 32 |
cls.comment_2 = Comment.objects.create(id=2, user=cls.user_1) |
| 33 |
cls.comment_3 = Comment.objects.create(id=3, user=cls.user_2) |
| 34 |
cls.token_1 = Token.objects.create(id=1, tenant=cls.tenant_1) |
| 35 |
cls.token_2 = Token.objects.create(id=2, tenant=cls.tenant_2) |
| 36 |
cls.token_3 = Token.objects.create(id=3, tenant=cls.tenant_1) |
| 37 |
cls.token_4 = Token.objects.create(id=4, tenant=cls.tenant_2) |
| 38 |
|
| 39 |
def test_update_user(self): |
| 40 |
email = "[email protected]" |
| 41 |
result = User.objects.filter(pk=self.user_1.pk).update(email=email) |
| 42 |
self.assertEqual(result, 1) |
| 43 |
user = User.objects.get(pk=self.user_1.pk) |
| 44 |
self.assertEqual(user.email, email) |
| 45 |
|
| 46 |
def test_save_user(self): |
| 47 |
count = User.objects.count() |
| 48 |
email = "[email protected]" |
| 49 |
user = User.objects.get(pk=self.user_1.pk) |
| 50 |
user.email = email |
| 51 |
with self.assertNumQueries(1) as ctx: |
| 52 |
user.save() |
| 53 |
sql = ctx[0]["sql"] |
| 54 |
self.assertEqual(sql.count(connection.ops.quote_name("tenant_id")), 1) |
| 55 |
self.assertEqual(sql.count(connection.ops.quote_name("id")), 1) |
| 56 |
user.refresh_from_db() |
| 57 |
self.assertEqual(user.email, email) |
| 58 |
user = User.objects.get(pk=self.user_1.pk) |
| 59 |
self.assertEqual(user.email, email) |
| 60 |
self.assertEqual(count, User.objects.count()) |
| 61 |
|
| 62 |
def test_update_fields_deferred(self): |
| 63 |
c = Comment.objects.defer("text", "user_id").get(pk=self.comment_1.pk) |
| 64 |
c.text = "Hello" |
| 65 |
|
| 66 |
with self.assertNumQueries(1) as ctx: |
| 67 |
c.save() |
| 68 |
|
| 69 |
sql = ctx[0]["sql"] |
| 70 |
self.assertEqual(sql.count(connection.ops.quote_name("tenant_id")), 1) |
| 71 |
self.assertEqual(sql.count(connection.ops.quote_name("comment_id")), 1) |
| 72 |
|
| 73 |
c = Comment.objects.get(pk=self.comment_1.pk) |
| 74 |
self.assertEqual(c.text, "Hello") |
| 75 |
|
| 76 |
def test_update_fields_pk_field(self): |
| 77 |
msg = ( |
| 78 |
"The following fields do not exist in this model, are m2m fields, " |
| 79 |
"primary keys, or are non-concrete fields: id" |
| 80 |
) |
| 81 |
with self.assertRaisesMessage(ValueError, msg): |
| 82 |
self.user_1.save(update_fields=["id"]) |
| 83 |
|
| 84 |
def test_bulk_update_comments(self): |
| 85 |
comment_1 = Comment.objects.get(pk=self.comment_1.pk) |
| 86 |
comment_2 = Comment.objects.get(pk=self.comment_2.pk) |
| 87 |
comment_3 = Comment.objects.get(pk=self.comment_3.pk) |
| 88 |
comment_1.text = "foo" |
| 89 |
comment_2.text = "bar" |
| 90 |
comment_3.text = "baz" |
| 91 |
|
| 92 |
result = Comment.objects.bulk_update( |
| 93 |
[comment_1, comment_2, comment_3], ["text"] |
| 94 |
) |
| 95 |
|
| 96 |
self.assertEqual(result, 3) |
| 97 |
comment_1 = Comment.objects.get(pk=self.comment_1.pk) |
| 98 |
comment_2 = Comment.objects.get(pk=self.comment_2.pk) |
| 99 |
comment_3 = Comment.objects.get(pk=self.comment_3.pk) |
| 100 |
self.assertEqual(comment_1.text, "foo") |
| 101 |
self.assertEqual(comment_2.text, "bar") |
| 102 |
self.assertEqual(comment_3.text, "baz") |
| 103 |
|
| 104 |
def test_bulk_update_primary_key_fields(self): |
| 105 |
message = "bulk_update() cannot be used with primary key fields." |
| 106 |
with self.assertRaisesMessage(ValueError, message): |
| 107 |
Comment.objects.bulk_update([self.comment_1, self.comment_2], ["id"]) |
| 108 |
|
| 109 |
def test_update_or_create_user(self): |
| 110 |
test_cases = ( |
| 111 |
{ |
| 112 |
"pk": self.user_1.pk, |
| 113 |
"defaults": {"email": "[email protected]"}, |
| 114 |
}, |
| 115 |
{ |
| 116 |
"pk": (self.tenant_1.id, self.user_1.id), |
| 117 |
"defaults": {"email": "[email protected]"}, |
| 118 |
}, |
| 119 |
{ |
| 120 |
"tenant": self.tenant_1, |
| 121 |
"id": self.user_1.id, |
| 122 |
"defaults": {"email": "[email protected]"}, |
| 123 |
}, |
| 124 |
{ |
| 125 |
"tenant_id": self.tenant_1.id, |
| 126 |
"id": self.user_1.id, |
| 127 |
"defaults": {"email": "[email protected]"}, |
| 128 |
}, |
| 129 |
) |
| 130 |
|
| 131 |
for fields in test_cases: |
| 132 |
with self.subTest(fields=fields): |
| 133 |
count = User.objects.count() |
| 134 |
user, created = User.objects.update_or_create(**fields) |
| 135 |
self.assertIs(created, False) |
| 136 |
self.assertEqual(user.id, self.user_1.id) |
| 137 |
self.assertEqual(user.pk, (self.tenant_1.id, self.user_1.id)) |
| 138 |
self.assertEqual(user.tenant_id, self.tenant_1.id) |
| 139 |
self.assertEqual(user.email, fields["defaults"]["email"]) |
| 140 |
self.assertEqual(count, User.objects.count()) |
| 141 |
|
| 142 |
def test_update_or_create_with_pre_save_pk_field(self): |
| 143 |
t = TimeStamped.objects.create(id=1) |
| 144 |
self.assertEqual(TimeStamped.objects.count(), 1) |
| 145 |
t, created = TimeStamped.objects.update_or_create( |
| 146 |
pk=t.pk, defaults={"text": "new text"} |
| 147 |
) |
| 148 |
self.assertIs(created, False) |
| 149 |
self.assertEqual(TimeStamped.objects.count(), 1) |
| 150 |
self.assertEqual(t.text, "new text") |
| 151 |
|
| 152 |
def test_update_comment_by_user_email(self): |
| 153 |
result = Comment.objects.filter(user__email=self.user_1.email).update( |
| 154 |
text="foo" |
| 155 |
) |
| 156 |
|
| 157 |
self.assertEqual(result, 2) |
| 158 |
comment_1 = Comment.objects.get(pk=self.comment_1.pk) |
| 159 |
comment_2 = Comment.objects.get(pk=self.comment_2.pk) |
| 160 |
self.assertEqual(comment_1.text, "foo") |
| 161 |
self.assertEqual(comment_2.text, "foo") |
| 162 |
|
| 163 |
def test_update_token_by_tenant_name(self): |
| 164 |
result = Token.objects.filter(tenant__name="A").update(secret="bar") |
| 165 |
|
| 166 |
self.assertEqual(result, 2) |
| 167 |
token_1 = Token.objects.get(pk=self.token_1.pk) |
| 168 |
self.assertEqual(token_1.secret, "bar") |
| 169 |
token_3 = Token.objects.get(pk=self.token_3.pk) |
| 170 |
self.assertEqual(token_3.secret, "bar") |
| 171 |
|
| 172 |
def test_cant_update_to_unsaved_object(self): |
| 173 |
msg = ( |
| 174 |
"Unsaved model instance <User: User object ((None, None))> cannot be used " |
| 175 |
"in an ORM query." |
| 176 |
) |
| 177 |
|
| 178 |
with self.assertRaisesMessage(ValueError, msg): |
| 179 |
Comment.objects.update(user=User()) |
| 180 |
|
| 181 |
def test_cant_update_pk_field(self): |
| 182 |
qs = Comment.objects.filter(user__email=self.user_1.email) |
| 183 |
msg = "Composite primary key fields must be updated individually." |
| 184 |
with self.assertRaisesMessage(FieldError, msg): |
| 185 |
qs.update(pk=(1, 10)) |
| 186 |
|
| 187 |
def test_update_value_not_composite(self): |
| 188 |
msg = ( |
| 189 |
"Composite primary keys expressions are not allowed in this " |
| 190 |
"query (text=F('pk'))." |
| 191 |
) |
| 192 |
with self.assertRaisesMessage(FieldError, msg): |
| 193 |
Comment.objects.update(text=F("pk")) |