File: test_autoslug_fields.py

package info (click to toggle)
python-django-extensions 4.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,812 kB
  • sloc: python: 18,601; javascript: 7,354; makefile: 108; xml: 17
file content (317 lines) | stat: -rw-r--r-- 9,997 bytes parent folder | download | duplicates (2)
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
# -*- coding: utf-8 -*-
import pytest

from django.db import migrations, models
from django.db.migrations.writer import MigrationWriter
from django.test import TestCase
from django.utils.encoding import force_bytes

import django_extensions  # noqa
from django_extensions.db.fields import AutoSlugField

from .testapp.models import (
    ChildSluggedTestModel,
    CustomFuncPrecedenceSluggedTestModel,
    CustomFuncSluggedTestModel,
    FKSluggedTestModel,
    FKSluggedTestModelCallable,
    FunctionSluggedTestModel,
    ModelMethodSluggedTestModel,
    SluggedTestModel,
    SluggedTestNoOverwriteOnAddModel,
    OverridedFindUniqueModel,
    SluggedWithConstraintsTestModel,
    SluggedWithUniqueTogetherTestModel,
)


@pytest.mark.usefixtures("admin_user")
class AutoSlugFieldTest(TestCase):
    def tearDown(self):
        super().tearDown()

        SluggedTestModel.objects.all().delete()
        CustomFuncSluggedTestModel.objects.all().delete()
        CustomFuncPrecedenceSluggedTestModel.objects.all().delete()

    def test_auto_create_slug(self):
        m = SluggedTestModel(title="foo")
        m.save()
        self.assertEqual(m.slug, "foo")

    def test_auto_create_next_slug(self):
        m = SluggedTestModel(title="foo")
        m.save()

        m = SluggedTestModel(title="foo")
        m.save()
        self.assertEqual(m.slug, "foo-2")

    def test_auto_create_slug_with_number(self):
        m = SluggedTestModel(title="foo 2012")
        m.save()
        self.assertEqual(m.slug, "foo-2012")

    def test_auto_update_slug_with_number(self):
        m = SluggedTestModel(title="foo 2012")
        m.save()
        m.save()
        self.assertEqual(m.slug, "foo-2012")

    def test_update_slug(self):
        m = SluggedTestModel(title="foo")
        m.save()
        self.assertEqual(m.slug, "foo")

        # update m instance without using `save'
        SluggedTestModel.objects.filter(pk=m.pk).update(slug="foo-2012")
        # update m instance with new data from the db
        m = SluggedTestModel.objects.get(pk=m.pk)
        self.assertEqual(m.slug, "foo-2012")

        m.save()
        self.assertEqual(m.title, "foo")
        self.assertEqual(m.slug, "foo-2012")

        # Check slug is not overwrite
        m.title = "bar"
        m.save()
        self.assertEqual(m.title, "bar")
        self.assertEqual(m.slug, "foo-2012")

    def test_simple_slug_source(self):
        m = SluggedTestModel(title="-foo")
        m.save()
        self.assertEqual(m.slug, "foo")

        n = SluggedTestModel(title="-foo")
        n.save()
        self.assertEqual(n.slug, "foo-2")

        n.save()
        self.assertEqual(n.slug, "foo-2")

    def test_empty_slug_source(self):
        # regression test

        m = SluggedTestModel(title="")
        m.save()
        self.assertEqual(m.slug, "-2")

        n = SluggedTestModel(title="")
        n.save()
        self.assertEqual(n.slug, "-3")

        n.save()
        self.assertEqual(n.slug, "-3")

    def test_callable_method_slug_source(self):
        m = ModelMethodSluggedTestModel(title="-foo")
        m.save()
        self.assertEqual(m.slug, "the-title-is-foo")

        n = ModelMethodSluggedTestModel(title="-foo")
        n.save()
        self.assertEqual(n.slug, "the-title-is-foo-2")

        n.save()
        self.assertEqual(n.slug, "the-title-is-foo-2")

    def test_callable_function_slug_source(self):
        m = FunctionSluggedTestModel(title="-foo")
        m.save()
        self.assertEqual(m.slug, "the-title-is-foo")

        n = FunctionSluggedTestModel(title="-foo")
        n.save()
        self.assertEqual(n.slug, "the-title-is-foo-2")

        n.save()
        self.assertEqual(n.slug, "the-title-is-foo-2")

    def test_inheritance_creates_next_slug(self):
        m = SluggedTestModel(title="foo")
        m.save()

        n = ChildSluggedTestModel(title="foo")
        n.save()
        self.assertEqual(n.slug, "foo-2")

        o = SluggedTestModel(title="foo")
        o.save()
        self.assertEqual(o.slug, "foo-3")

    def test_foreign_key_populate_from_field(self):
        m_fk = SluggedTestModel(title="foo")
        m_fk.save()
        m = FKSluggedTestModel(related_field=m_fk)
        m.save()
        self.assertEqual(m.slug, "foo")

    def test_foreign_key_populate_from_callable(self):
        m_fk = ModelMethodSluggedTestModel(title="foo")
        m_fk.save()
        m = FKSluggedTestModelCallable(related_field=m_fk)
        m.save()
        self.assertEqual(m.slug, "the-title-is-foo")

    def test_copy_model_generates_new_slug(self):
        m = SluggedTestModel(title="foo")
        m.save()
        self.assertEqual(m.slug, "foo")

        m.pk = None
        m.save()
        self.assertEqual(m.slug, "foo-2")

    def test_copy_model_generates_new_slug_no_overwrite_on_add(self):
        m = SluggedTestNoOverwriteOnAddModel(title="foo")
        m.save()
        self.assertEqual(m.slug, "foo")

        m.pk = None
        m.slug = None
        m.save()
        self.assertEqual(m.slug, "foo-2")

    def test_populate_from_does_not_allow_bytes(self):
        with pytest.raises(TypeError):
            AutoSlugField(populate_from=b"bytes")

        with pytest.raises(TypeError):
            AutoSlugField(populate_from=[b"bytes"])

    def test_populate_from_must_allow_string_or_list_str_or_tuple_str(self):
        AutoSlugField(populate_from="str")
        AutoSlugField(populate_from=["str"])
        AutoSlugField(populate_from=("str",))

    def test_slug_argument_priority(self):
        m = SluggedTestModel(slug="slug", title="title")
        m.save()
        self.assertEqual(m.slug, "title")

    def test_slug_argument_priority_no_overwrite_on_add(self):
        m = SluggedTestNoOverwriteOnAddModel(slug="slug", title="title")
        m.save()
        self.assertEqual(m.slug, "slug")

    def test_overrided_find_unique_autoslug_field(self):
        m = OverridedFindUniqueModel(title="foo")
        slug_field = m._meta.fields[2]
        self.assertFalse(hasattr(slug_field, "overrided"))
        m.save()
        slug_field = m._meta.fields[2]
        self.assertTrue(slug_field.overrided)

    def test_slugify_func(self):
        to_upper = lambda c: c.upper()
        to_lower = lambda c: c.lower()

        content_n_func_n_expected = (
            ("test", to_upper, "TEST"),
            ("", to_upper, ""),
            ("TEST", to_lower, "test"),
        )

        for content, slugify_function, expected in content_n_func_n_expected:
            self.assertEqual(
                AutoSlugField.slugify_func(content, slugify_function), expected
            )

    def test_use_custom_slug_function(self):
        m = CustomFuncSluggedTestModel(title="test")
        m.save()
        self.assertEqual(m.slug, "TEST")

    def test_precedence_custom_slug_function(self):
        m = CustomFuncPrecedenceSluggedTestModel(title="test")
        m.save()
        self.assertEqual(m.slug, "TEST")
        self.assertTrue(hasattr(m._meta.get_field("slug"), "slugify_function"))
        self.assertEqual(m._meta.get_field("slug").slugify_function("TEST"), "test")

    def test_auto_create_slug_with_unique_together(self):
        m = SluggedWithUniqueTogetherTestModel(
            title="foo", category="self-introduction"
        )
        m.save()
        self.assertEqual(m.slug, "foo")

        m = SluggedWithUniqueTogetherTestModel(title="foo", category="review")
        m.save()
        self.assertEqual(m.slug, "foo")

        # check if satisfy database integrity
        m = SluggedWithUniqueTogetherTestModel(title="foo", category="review")
        m.save()
        self.assertEqual(m.slug, "foo-2")

    def test_auto_create_slug_with_constraints(self):
        m = SluggedWithConstraintsTestModel(title="foo", category="self-introduction")
        m.save()
        self.assertEqual(m.slug, "foo")

        m = SluggedWithConstraintsTestModel(title="foo", category="review")
        m.save()
        self.assertEqual(m.slug, "foo")

        # check if satisfy database integrity
        m = SluggedWithConstraintsTestModel(title="foo", category="review")
        m.save()
        self.assertEqual(m.slug, "foo-2")


class MigrationTest(TestCase):
    def safe_exec(self, string, value=None):
        dct = {}
        try:
            exec(force_bytes(string), globals(), dct)
        except Exception as e:
            if value:
                self.fail(
                    "Could not exec %r (from value %r): %s" % (string.strip(), value, e)
                )
            else:
                self.fail("Could not exec %r: %s" % (string.strip(), e))
        return dct

    def test_17_migration(self):
        """
        Tests making migrations with Django's migration framework
        """

        fields = {
            "autoslugfield": AutoSlugField(populate_from="otherfield"),
        }

        migration = type(
            str("Migration"),
            (migrations.Migration,),
            {
                "operations": [
                    migrations.CreateModel(
                        "MyModel",
                        tuple(fields.items()),
                        {"populate_from": "otherfield"},
                        (models.Model,),
                    ),
                ],
            },
        )
        writer = MigrationWriter(migration)
        output = writer.as_string()

        self.assertIsInstance(output, str, "Migration as_string returned bytes")

        # We don't test the output formatting - that's too fragile.
        # Just make sure it runs for now, and that things look alright.
        result = self.safe_exec(output)
        self.assertIn("Migration", result)

    def test_stable_deconstruct(self):
        slug_field = SluggedTestModel._meta.get_field("slug")
        construction_values = slug_field.deconstruct()
        m = SluggedTestModel(title="foo")
        m.save()
        self.assertEqual(slug_field.deconstruct(), construction_values)