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
|
from django.core.exceptions import ValidationError
from django.forms import inlineformset_factory
from django.utils import translation
from parler.forms import TranslatableModelForm
from .testapp.models import (
CleanFieldModel,
ForeignKeyTranslationModel,
IntegerPrimaryKeyModel,
IntegerPrimaryKeyRelatedModel,
ManyToManyAndOtherFieldsTranslationModel,
RegularModel,
SimpleModel,
UniqueTogetherModel,
UUIDPrimaryKeyModel,
UUIDPrimaryKeyRelatedModel,
)
from .utils import AppTestCase
class SimpleForm(TranslatableModelForm):
class Meta:
model = SimpleModel
fields = "__all__"
class CleanFieldForm(TranslatableModelForm):
class Meta:
model = CleanFieldModel
fields = "__all__"
class UniqueTogetherForm(TranslatableModelForm):
class Meta:
model = UniqueTogetherModel
fields = "__all__"
class ForeignKeyTranslationModelForm(TranslatableModelForm):
class Meta:
model = ForeignKeyTranslationModel
fields = "__all__"
class IntegerPrimaryKeyForm(TranslatableModelForm):
class Meta:
model = IntegerPrimaryKeyModel
fields = "__all__"
class UUIDPrimaryKeyForm(TranslatableModelForm):
class Meta:
model = UUIDPrimaryKeyModel
fields = "__all__"
class OverrideMetaFieldForm(TranslatableModelForm):
class Meta:
model = SimpleModel
fields = "__all__"
help_texts = {
"shared": "help_text:shared",
"tr_title": "help_text:tr_title",
}
labels = {
"shared": "label:shared",
"tr_title": "label:tr_title",
}
error_messages = {
"shared": {"max_length": "error_message:shared"},
"tr_title": {"max_length": "error_message:tr_title"},
}
class ManyToManyAndOtherFieldsTranslationModelForm(TranslatableModelForm):
class Meta:
model = ManyToManyAndOtherFieldsTranslationModel
fields = "__all__"
class FormTests(AppTestCase):
"""
Test model construction
"""
def test_form_language_validation(self):
form_instance = SimpleForm(_current_language="fr-FR")
self.assertEqual(form_instance.language_code, "fr-FR")
with self.assertRaises(ValueError):
SimpleForm(_current_language="fa")
with self.assertRaises(ValueError):
SimpleForm(_current_language="va_VN")
def test_form_fields(self):
"""
Check if the form fields exist.
"""
self.assertTrue("shared" in SimpleForm.base_fields)
self.assertTrue("tr_title" in SimpleForm.base_fields)
def test_form_save(self):
"""
Check if the form receives and stores data.
"""
with translation.override("fr"):
# Initialize form in other language.
x = SimpleForm(data={"shared": "SHARED", "tr_title": "TRANS"})
x.language_code = "nl"
self.assertFalse(x.errors)
# Data should come out
self.assertEqual(x.cleaned_data["shared"], "SHARED")
self.assertEqual(x.cleaned_data["tr_title"], "TRANS")
# Data should be saved
instance = x.save()
self.assertEqual(instance.get_current_language(), "nl")
x = SimpleModel.objects.language("nl").get(pk=instance.pk)
self.assertEqual(x.shared, "SHARED")
self.assertEqual(x.tr_title, "TRANS")
def test_form_save_clean(self):
"""
Check if the form receives and stores data.
"""
with translation.override("fr"):
# Initialize form in other language.
x = CleanFieldForm(data={"shared": "TRANS", "tr_title": "TEST"})
x.language_code = "nl"
self.assertFalse(x.errors)
# Data should come out
self.assertEqual(x.cleaned_data["shared"], "TRANS")
self.assertEqual(x.cleaned_data["tr_title"], "TEST")
# Data should be saved
instance = x.save()
self.assertEqual(instance.get_current_language(), "nl")
x = CleanFieldModel.objects.language("nl").get(pk=instance.pk)
self.assertEqual(x.shared, "TRANS_cleanchar_cleanshared")
self.assertEqual(x.tr_title, "TEST_cleanchar_cleantrans")
def test_form_save_clean_exclude(self):
"""
Check that non-form fields are properly excluded.
"""
class CleanPartialFieldForm(TranslatableModelForm):
class Meta:
model = CleanFieldModel
fields = ("shared",)
exclude = ("tr_title",)
self.assertEqual(list(CleanPartialFieldForm.base_fields.keys()), ["shared"])
with translation.override("fr"):
x = CleanPartialFieldForm(data={"shared": "TRANS"})
x.language_code = "nl"
self.assertFalse(x.errors)
def test_unique_together(self):
UniqueTogetherModel(_current_language="en", slug="foo").save()
# Different language code, no problem
form = UniqueTogetherForm(data={"slug": "foo"})
form.language_code = "fr"
self.assertTrue(form.is_valid())
# Same language code, should raise unique_together check
form = UniqueTogetherForm(data={"slug": "foo"})
form.language_code = "en"
self.assertFalse(form.is_valid())
self.assertRaises(ValidationError, lambda: form.instance.validate_unique())
def test_not_null_foreignkey_in_translation(self):
"""
Simulate scenario for model with translation field of type foreign key (not null).
1. User create model with one translation (EN)
2. Switch to another language in admin (FR)
"""
# create object with translation
r1 = RegularModel.objects.create(original_field="r1")
a = ForeignKeyTranslationModel.objects.create(translated_foreign=r1, shared="EN")
# same way as TranslatableAdmin.get_object() inicializing translation, when user switch to new translation language
a.set_current_language("fr", initialize=True)
# inicialize form
form = ForeignKeyTranslationModelForm(instance=a)
self.assertTrue(True)
def test_override_meta_fields(self):
form_instance = OverrideMetaFieldForm(_current_language="fr-FR")
self.assertEqual("help_text:shared", form_instance["shared"].help_text)
self.assertEqual("help_text:tr_title", form_instance["tr_title"].help_text)
self.assertEqual("label:shared", form_instance["shared"].label)
self.assertEqual("label:tr_title", form_instance["tr_title"].label)
# Override error messsages
form_instance = OverrideMetaFieldForm(
_current_language="fr-FR",
data={
"shared": "a" * 201,
"tr_title": "b" * 201,
},
)
self.assertEqual("error_message:shared", form_instance["shared"].errors[0])
self.assertEqual("error_message:tr_title", form_instance["tr_title"].errors[0])
def test_many_to_many_fields(self):
regular_one = RegularModel.objects.create(original_field="One")
regular_two = RegularModel.objects.create(original_field="Two")
# Create object in English
form = ManyToManyAndOtherFieldsTranslationModelForm(
data=dict(
shared="SHARED",
tr_title="TRANS",
translated_many_to_many=[regular_one.pk],
)
)
form.language_code = "en"
self.assertFalse(form.errors)
# Test cleaning
self.assertEqual(form.cleaned_data["shared"], "SHARED")
self.assertEqual(form.cleaned_data["tr_title"], "TRANS")
self.assertEqual(form.cleaned_data["translated_many_to_many"][0], regular_one)
# Save and check result
obj = form.save()
self.assertEqual(obj.shared, "SHARED")
self.assertEqual(obj.tr_title, "TRANS")
self.assertEqual(obj.translated_many_to_many.all()[0], regular_one)
# Translate the object to French
form = ManyToManyAndOtherFieldsTranslationModelForm(
instance=obj,
data=dict(
shared="SHARED",
tr_title="TRANSF",
translated_many_to_many=[regular_two.pk],
),
)
form.language_code = "fr"
self.assertFalse(form.errors)
# Test cleaning
self.assertEqual(form.cleaned_data["shared"], "SHARED")
self.assertEqual(form.cleaned_data["tr_title"], "TRANSF")
self.assertEqual(form.cleaned_data["translated_many_to_many"][0], regular_two)
# Save and check result
obj = form.save()
self.assertEqual(obj.shared, "SHARED")
self.assertEqual(obj.tr_title, "TRANSF")
self.assertEqual(obj.translated_many_to_many.all()[0], regular_two)
# Confirm English is unchanged after French translation
obj.set_current_language("en")
self.assertEqual(obj.tr_title, "TRANS")
self.assertEqual(obj.translated_many_to_many.all()[0], regular_one)
class InlineFormTests(AppTestCase):
def test_integer_primary_key(self):
parent_form = IntegerPrimaryKeyForm(data={"tr_title": "TRANS"})
self.assertTrue(parent_form.is_valid())
parent = parent_form.save(commit=False)
InlineFormSet = inlineformset_factory(
IntegerPrimaryKeyModel, IntegerPrimaryKeyRelatedModel, fields=()
)
formset = InlineFormSet(
instance=parent, data={"children-TOTAL_FORMS": 1, "children-INITIAL_FORMS": 0}
)
self.assertTrue(formset.is_valid())
parent.save()
self.assertEqual(parent.translations.count(), 1)
def test_uuid_primary_key(self):
parent_form = UUIDPrimaryKeyForm(data={"tr_title": "TRANS"})
self.assertTrue(parent_form.is_valid())
parent = parent_form.save(commit=False)
self.assertIsNotNone(parent.pk) # UUID primary key set on instantiation
InlineFormSet = inlineformset_factory(
UUIDPrimaryKeyModel, UUIDPrimaryKeyRelatedModel, fields=()
)
formset = InlineFormSet(
instance=parent, data={"children-TOTAL_FORMS": 1, "children-INITIAL_FORMS": 0}
)
self.assertTrue(formset.is_valid())
self.assertIsNone(parent.pk) # The formset above will reset the primary key
parent.save()
self.assertEqual(parent.translations.count(), 1)
|