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
|
import pytest
from dynamic_preferences.registries import (
MissingPreference,
global_preferences_registry,
)
from dynamic_preferences import preferences, exceptions
from dynamic_preferences.types import IntegerPreference, StringPreference
from dynamic_preferences.signals import preference_updated
from .test_app import dynamic_preferences_registry as prefs
from .test_app.models import BlogEntry
try:
from unittest.mock import MagicMock
except ImportError:
from mock import MagicMock
def test_can_retrieve_preference_using_dotted_notation(db):
registration_allowed = global_preferences_registry.get(
name="registration_allowed", section="user"
)
dotted_result = global_preferences_registry.get("user__registration_allowed")
assert registration_allowed == dotted_result
def test_can_register_and_retrieve_preference_with_section_none(db):
no_section_pref = global_preferences_registry.get(name="no_section")
assert no_section_pref.section == preferences.EMPTY_SECTION
def test_cannot_instanciate_preference_or_section_with_invalid_name():
invalid_names = ["with space", "with__separator", "with-hyphen"]
for n in invalid_names:
with pytest.raises(ValueError):
preferences.Section(n)
with pytest.raises(ValueError):
class P(IntegerPreference):
name = n
P()
def test_preference_order_match_register_call():
expected = [
"registration_allowed",
"max_users",
"items_per_page",
"featured_entry",
]
assert [p.name for p in global_preferences_registry.preferences()][:4] == expected
def test_preferences_manager_get(db):
global_preferences = global_preferences_registry.manager()
assert global_preferences["no_section"] is False
def test_preferences_manager_set(db):
global_preferences = global_preferences_registry.manager()
global_preferences["no_section"] = True
assert global_preferences["no_section"] is True
def test_can_cache_single_preference(db, django_assert_num_queries):
manager = global_preferences_registry.manager()
manager["no_section"]
with django_assert_num_queries(0):
manager["no_section"]
manager["no_section"]
manager["no_section"]
def test_can_bypass_cache_in_get(db, settings, django_assert_num_queries):
settings.DYNAMIC_PREFERENCES = {"ENABLE_CACHE": False}
manager = global_preferences_registry.manager()
manager["no_section"]
with django_assert_num_queries(3):
manager["no_section"]
manager["no_section"]
manager["no_section"]
def test_can_bypass_cache_in_get_all(db, settings):
settings.DYNAMIC_PREFERENCES = {"ENABLE_CACHE": False}
settings.DEBUG = True
from django.db import connection
manager = global_preferences_registry.manager()
queries_before = len(connection.queries)
manager.all()
manager_queries = len(connection.queries) - queries_before
manager.all()
assert len(connection.queries) > manager_queries
def test_can_cache_all_preferences(db, django_assert_num_queries):
BlogEntry.objects.create(title="test", content="test")
manager = global_preferences_registry.manager()
manager.all()
with django_assert_num_queries(3):
# one request each time we retrieve the blog entry
manager.all()
manager.all()
manager.all()
def test_preferences_manager_by_name(db):
manager = global_preferences_registry.manager()
assert manager.by_name()["max_users"] == manager["user__max_users"]
assert len(manager.all()) == len(manager.by_name())
def test_cache_invalidate_on_save(db, django_assert_num_queries):
manager = global_preferences_registry.manager()
model_instance = manager.create_db_pref(
section=None, name="no_section", value=False
)
with django_assert_num_queries(0):
assert not manager["no_section"]
manager["no_section"]
model_instance.value = True
model_instance.save()
with django_assert_num_queries(0):
assert manager["no_section"]
manager["no_section"]
def test_can_get_single_pref_with_cache_disabled(settings, db):
settings.DYNAMIC_PREFERENCES = {"ENABLE_CACHE": False}
manager = global_preferences_registry.manager()
v = manager["no_section"]
assert isinstance(v, bool) is True
def test_can_get_single_pref_bypassing_cache(db):
manager = global_preferences_registry.manager()
v = manager.get("no_section", no_cache=True)
assert isinstance(v, bool) is True
def test_do_not_crash_if_preference_is_missing_in_registry(db):
"""see #41"""
manager = global_preferences_registry.manager()
instance = manager.create_db_pref(section=None, name="bad_pref", value="something")
assert isinstance(instance.preference, MissingPreference) is True
assert instance.preference.section is None
assert instance.preference.name == "bad_pref"
assert instance.value == "something"
def test_can_get_to_string_notation(db):
pref = global_preferences_registry.get("user__registration_allowed")
assert pref.identifier() == "user__registration_allowed"
def test_preference_requires_default_value():
with pytest.raises(exceptions.MissingDefault):
prefs.NoDefault()
def test_modelchoicepreference_requires_model_value():
with pytest.raises(exceptions.MissingModel):
prefs.NoModel()
def test_get_field_uses_field_kwargs():
class P(StringPreference):
name = "test"
default = ""
field_kwargs = {"required": False}
p = P()
kwargs = p.get_field_kwargs()
assert kwargs["required"] is False
def test_preferences_manager_signal(db):
global_preferences = global_preferences_registry.manager()
global_preferences["no_section"] = False
pref = global_preferences.get_db_pref(name="no_section", section=None)
receiver = MagicMock()
preference_updated.connect(receiver)
global_preferences["no_section"] = True
assert receiver.call_count == 1
call_args = receiver.call_args[1]
assert {
"sender": global_preferences.__class__,
"section": None,
"name": "no_section",
"old_value": False,
"new_value": True,
"instance": pref
}.items() <= call_args.items()
|
