File: test_types.py

package info (click to toggle)
django-dynamic-preferences 1.17.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 476 kB
  • sloc: python: 3,040; makefile: 3
file content (295 lines) | stat: -rw-r--r-- 8,433 bytes parent folder | download
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
import os
import decimal
import pickle

import pytest

from datetime import date, timedelta, datetime, time
from django import forms
from django.db.models import signals
from django.core.files.uploadedfile import SimpleUploadedFile
from django.conf import settings

from dynamic_preferences.models import GlobalPreferenceModel
from dynamic_preferences.settings import preferences_settings
from dynamic_preferences.registries import global_preferences_registry
from dynamic_preferences import types

from .test_app.models import BlogEntry


@pytest.fixture
def no_validate_names(settings):
    settings.DYNAMIC_PREFERENCES = {"VALIDATE_NAMES": False}


@pytest.fixture
def blog_entry(db):
    return BlogEntry.objects.create(title="Hello", content="World")


def test_default_accepts_callable(no_validate_names):
    class P(types.IntPreference):
        def get_default(self):
            return 4

    assert P().get("default") == 4


def test_getter(no_validate_names):
    class PNoGetter(types.IntPreference):
        default = 1
        help_text = "Hello"

    class PGetter(types.IntPreference):
        def get_default(self):
            return 1

        def get_help_text(self):
            return "Hello"

    p_no_getter = PNoGetter()
    p_getter = PGetter()
    for attribute, expected in [("default", 1), ("help_text", "Hello")]:
        assert p_no_getter.get(attribute) == expected
        assert p_getter.get(attribute) == expected


def test_field(no_validate_names):
    class P(types.IntPreference):
        default = 1
        verbose_name = "P"

    p = P()

    assert p.field.initial == 1
    assert p.field.label == "P"
    assert p.field.__class__ == forms.IntegerField


def test_boolean_field_class_instantiation(no_validate_names):
    class P(types.BooleanPreference):
        default = False

    preference = P()
    assert preference.field.initial is False


def test_char_field_class_instantiation(no_validate_names):
    class P(types.StringPreference):
        default = "hello world!"

    preference = P()

    assert preference.field.initial == "hello world!"


def test_longstring_preference_widget(no_validate_names):
    class P(types.LongStringPreference):
        default = "hello world!"

    preference = P()

    assert isinstance(preference.field.widget, forms.Textarea) is True


def test_decimal_preference(no_validate_names):
    class P(types.DecimalPreference):
        default = decimal.Decimal("2.5")

    preference = P()

    assert preference.field.initial == decimal.Decimal("2.5")


def test_float_preference(no_validate_names):
    class P(types.FloatPreference):
        default = 0.35

    preference = P()

    assert preference.field.initial == 0.35
    assert preference.field.initial != 0.3
    assert preference.field.initial != 0.3001


def test_duration_preference(no_validate_names):
    class P(types.DurationPreference):
        default = timedelta(0)

    preference = P()

    assert preference.field.initial == timedelta(0)


def test_date_preference(no_validate_names):
    class P(types.DatePreference):
        default = date.today()

    preference = P()

    assert preference.field.initial == date.today()


def test_datetime_preference(no_validate_names):
    initial_date_time = datetime(2017, 10, 4, 23, 7, 20, 682380)

    class P(types.DateTimePreference):
        default = initial_date_time

    preference = P()

    assert preference.field.initial == initial_date_time


def test_time_preference(no_validate_names):
    class P(types.TimePreference):
        default = time(0)

    preference = P()

    assert preference.field.initial == time(0)


def test_file_preference_defaults_to_none(no_validate_names):
    class P(types.FilePreference):
        pass

    preference = P()

    assert preference.field.initial is None


def test_can_get_upload_path(no_validate_names):
    class P(types.FilePreference):
        pass

    p = P()

    assert p.get_upload_path() == (
        preferences_settings.FILE_PREFERENCE_UPLOAD_DIR + "/" + p.identifier()
    )


def test_file_preference_store_file_path(db):
    f = SimpleUploadedFile(
        "test_file_1ce410e5-6814-4910-afd7-be1486d3644f.txt",
        "hello world".encode("utf-8"),
    )
    p = global_preferences_registry.get(section="blog", name="logo")
    manager = global_preferences_registry.manager()
    manager["blog__logo"] = f
    assert manager["blog__logo"].read() == b"hello world"
    assert manager["blog__logo"].url == os.path.join(
        settings.MEDIA_URL, p.get_upload_path(), f.name
    )

    assert manager["blog__logo"].path == os.path.join(
        settings.MEDIA_ROOT, p.get_upload_path(), f.name
    )


def test_file_preference_conflicting_file_names(db):
    """
    f2 should have a different file name to f, since Django storage needs
    to differentiate between the two
    """
    f = SimpleUploadedFile(
        "test_file_c95d02ef-0e5d-4d36-98c0-1b54505860d0.txt",
        "hello world".encode("utf-8"),
    )
    f2 = SimpleUploadedFile(
        "test_file_c95d02ef-0e5d-4d36-98c0-1b54505860d0.txt",
        "hello world 2".encode("utf-8"),
    )
    manager = global_preferences_registry.manager()

    manager["blog__logo"] = f
    manager["blog__logo2"] = f2

    assert manager["blog__logo2"].read() == b"hello world 2"
    assert manager["blog__logo"].read() == b"hello world"

    assert manager["blog__logo"].url != manager["blog__logo2"].url
    assert manager["blog__logo"].path != manager["blog__logo2"].path


def test_can_delete_file_preference(db):
    f = SimpleUploadedFile(
        "test_file_bf2e72ef-092f-4a71-9cda-f2442d6166d0.txt",
        "hello world".encode("utf-8"),
    )
    p = global_preferences_registry.get(section="blog", name="logo")
    manager = global_preferences_registry.manager()
    manager["blog__logo"] = f
    path = os.path.join(settings.MEDIA_ROOT, p.get_upload_path(), f.name)
    assert os.path.exists(path) is True
    manager["blog__logo"].delete()
    assert os.path.exists(path) is False


def test_file_preference_api_repr_returns_path(db):
    f = SimpleUploadedFile(
        "test_file_24485a80-8db9-4191-ae49-da7fe2013794.txt",
        "hello world".encode("utf-8"),
    )
    p = global_preferences_registry.get(section="blog", name="logo")
    manager = global_preferences_registry.manager()
    manager["blog__logo"] = f

    f = manager["blog__logo"]
    assert p.api_repr(f) == f.url


def test_file_preference_if_pickleable(db):
    manager = global_preferences_registry.manager()
    f = SimpleUploadedFile(
        "test_file_24485a80-8db9-4191-ae49-da7fe2013794.txt",
        "hello world".encode("utf-8"),
    )
    try:
        manager["blog__logo"] = f
        pickle.dumps(manager["blog__logo"])
    except Exception:
        pytest.fail("FilePreference not pickleable")


def test_choice_preference(fake_user):
    fake_user.preferences["user__favorite_vegetable"] = "C"
    assert fake_user.preferences["user__favorite_vegetable"] == "C"
    fake_user.preferences["user__favorite_vegetable"] = "P"
    assert fake_user.preferences["user__favorite_vegetable"] == "P"

    with pytest.raises(forms.ValidationError):
        fake_user.preferences["user__favorite_vegetable"] = "Nope"


def test_multiple_choice_preference(fake_user):
    fake_user.preferences["user__favorite_vegetables"] = ["C", "T"]
    assert fake_user.preferences["user__favorite_vegetables"] == ["C", "T"]
    fake_user.preferences["user__favorite_vegetables"] = ["P"]
    assert fake_user.preferences["user__favorite_vegetables"] == ["P"]

    with pytest.raises(forms.ValidationError):
        fake_user.preferences["user__favorite_vegetables"] = ["Nope", "C"]


def test_model_choice_preference(blog_entry):
    global_preferences = global_preferences_registry.manager()
    global_preferences["blog__featured_entry"] = blog_entry

    in_db = GlobalPreferenceModel.objects.get(section="blog", name="featured_entry")
    assert in_db.value == blog_entry
    assert in_db.raw_value == str(blog_entry.pk)


def test_deleting_model_also_delete_preference(blog_entry):
    global_preferences = global_preferences_registry.manager()
    global_preferences["blog__featured_entry"] = blog_entry

    assert len(signals.pre_delete.receivers) > 0

    blog_entry.delete()

    with pytest.raises(GlobalPreferenceModel.DoesNotExist):
        GlobalPreferenceModel.objects.get(section="blog", name="featured_entry")