File: TestSettingDefinitionsModel.py

package info (click to toggle)
uranium 5.0.0-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 5,304 kB
  • sloc: python: 31,765; sh: 132; makefile: 12
file content (393 lines) | stat: -rw-r--r-- 13,193 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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
from unittest.mock import MagicMock, patch

import pytest
import os
import uuid
from UM.Settings.SettingRelation import RelationType

from UM.Settings.DefinitionContainer import DefinitionContainer
from UM.Settings.Models.SettingDefinitionsModel import SettingDefinitionsModel
from PyQt6.QtCore import QVariant, QModelIndex, Qt


def createModel(definition = "multiple_settings.def.json"):
    model = SettingDefinitionsModel()

    # Get a basic definition container
    uid = str(uuid.uuid4())
    definition_container = DefinitionContainer(uid)
    with open(os.path.join(os.path.dirname(os.path.abspath(__file__)), "definitions", definition),
              encoding="utf-8") as data:
        json = data.read()
    definition_container._updateSerialized = MagicMock(return_value = json)
    definition_container.deserialize(json)
    model._container = definition_container
    with patch("UM.Application.Application.getInstance"):
        model.setShowAll(True)
    model.forceUpdate()
    model._updateVisibleRows()

    return model


test_validate_data = [
    {"attribute": "showAncestors", "value": True},
    {"attribute": "containerId", "value": "omg"},
    {"attribute": "showAll", "value": True},
    {"attribute": "visibilityHandler", "value": MagicMock()},
    {"attribute": "exclude", "value": ["yay"]},
    {"attribute": "expanded", "value": ["yay"]},
    {"attribute": "filter", "value": {"zomg": "zomg"}},
    {"attribute": "rootKey", "value": "Whatevah"}
]

@pytest.mark.parametrize("data", test_validate_data)
def test_getAndSet(data):
    model = SettingDefinitionsModel()
    model._scheduleUpdateVisibleRows = MagicMock()
    model._container = MagicMock()
    # Convert the first letter into a capital
    attribute = list(data["attribute"])
    attribute[0] = attribute[0].capitalize()
    attribute = "".join(attribute)

    # Attempt to set the value
    with patch("UM.Settings.ContainerRegistry.ContainerRegistry.getInstance"):
        getattr(model, "set" + attribute)(data["value"])

    # Ensure that the value got set
    assert getattr(model, data["attribute"]) == data["value"]


def test_setRootKeyUnknownDefinition():
    model = SettingDefinitionsModel()
    model._container = MagicMock()
    model._container.findDefinitions = MagicMock(return_value = [])
    model.rootKeyChanged = MagicMock()
    model.setRootKey("Blorp")
    assert model.rootKeyChanged.emit.call_count == 0


def test_getCount():
    model = createModel()

    assert model.count == 6
    assert model.categoryCount == 1


def test_getCountNoContainer():
    model = SettingDefinitionsModel()
    assert model.count == 0


def test_setVisible():
    model = createModel()
    assert model.visibleCount == 0

    model.show("test_setting_0")
    assert model.visibleCount == 1
    assert model.getVisible("test_setting_0")

    model.hide("test_setting_0")
    assert model.visibleCount == 0

    mocked_visibility_handler = MagicMock(name = "mocked_visibility_handler")
    mocked_visibility_handler.getVisible = MagicMock(return_value = set())
    model.setVisibilityHandler(mocked_visibility_handler)
    model.setAllVisible(True)

    # Ensure that the visibility handler got notified that things were changed.
    assert mocked_visibility_handler.setVisible.call_count == 1
    mocked_visibility_handler.setVisible.assert_called_with({'test_setting_2', 'test_setting_4', 'test_setting_3', 'test_setting_0', 'test_setting_1'})

    model.setAllVisible(False)
    assert mocked_visibility_handler.setVisible.call_count == 2
    mocked_visibility_handler.setVisible.assert_called_with(set())


def test_disconnectVisibilityHandler():
    model = SettingDefinitionsModel()
    visibility_handler = MagicMock()
    visibility_handler_2 = MagicMock()
    model.setVisibilityHandler(visibility_handler)
    assert visibility_handler.visibilityChanged.disconnect.call_count == 0

    model.setVisibilityHandler(visibility_handler_2)

    assert visibility_handler.visibilityChanged.disconnect.call_count > 0


def test_getIndex():
    model = createModel()
    # This setting doesn't exist
    assert model.getIndex("set_setting_0") == -1
    assert model.getIndex("test_setting_0") == 0


def test_getRequires():
    model = createModel("functions.def.json")

    requires = model.getRequires("test_setting_1", "value")
    assert requires[0]["key"] == "test_setting_0"


def test_getRequires_noContainer():
    model = SettingDefinitionsModel()
    assert model.getRequires("blorp", "whatever") == []


def test_getRequires_noDefinition():
    model = SettingDefinitionsModel()
    model._container = MagicMock()
    model._container.findDefinitions = MagicMock(return_value=[])

    assert model.getRequires("blorp", "whatever") == []


def test_getRequires_withRelationsSet():
    model = SettingDefinitionsModel()
    model._container = MagicMock()

    relation_1 = MagicMock()
    relation_1.type = RelationType.RequiredByTarget
    relation_2 = MagicMock()
    relation_2.type = RelationType.RequiresTarget
    relation_2.role = "HERPDERP"
    relation_3 = MagicMock()
    relation_3.type = RelationType.RequiresTarget
    relation_3.role = "yay"
    relation_3.target.key = "key_3"
    relation_3.target.label = "label_3"

    mocked_definition_1 = MagicMock()
    mocked_definition_1.relations = [relation_1, relation_2, relation_3]

    model._container.findDefinitions = MagicMock(return_value=[mocked_definition_1])
    assert model.getRequires("blorp", "yay") == [{"key": "key_3", "label": "label_3"}]


def test_getRequiredBy_withRelationsSet():
    model = SettingDefinitionsModel()
    model._container = MagicMock()

    relation_1 = MagicMock()
    relation_1.type = RelationType.RequiredByTarget
    relation_2 = MagicMock()
    relation_2.type = RelationType.RequiresTarget
    relation_2.role = "HERPDERP"
    relation_3 = MagicMock()
    relation_3.type = RelationType.RequiredByTarget
    relation_3.role = "yay"
    relation_3.target.key = "key_3"
    relation_3.target.label = "label_3"

    mocked_definition_1 = MagicMock()
    mocked_definition_1.relations = [relation_1, relation_2, relation_3]

    model._container.findDefinitions = MagicMock(return_value=[mocked_definition_1])
    assert model.getRequiredBy("blorp", "yay") == [{"key": "key_3", "label": "label_3"}]


def test_getRequiredBy():
    model = createModel("functions.def.json")

    requires = model.getRequiredBy("test_setting_0", "value")
    assert requires[0]["key"] == "test_setting_1"


def test_getRequiredBy_unknownSetting():
    model = createModel("functions.def.json")
    model._getDefinitionsByKey = MagicMock(return_value = [])

    assert model.getRequiredBy("test_setting_0", "value") == []



@patch("UM.Application.Application.getInstance")
def test_collapseExpand(application):
    model = createModel("children.def.json")

    model.expand("test_setting")
    assert "test_setting" in model.expanded
    assert "test_child_0" not in model.expanded
    assert "test_child_1" not in model.expanded

    model.expandRecursive("test_setting")
    assert "test_setting" in model.expanded
    assert "test_child_0" in model.expanded
    assert "test_child_1" in model.expanded

    model.collapseRecursive("test_child_0")
    assert "test_setting" in model.expanded
    assert "test_child_0" not in model.expanded
    assert "test_child_1" in model.expanded

    model.collapseRecursive("test_setting")
    assert "test_setting" not in model.expanded
    assert "test_child_0" not in model.expanded
    assert "test_child_1" not in model.expanded


def test_expandRecursive_noContainer():
    model = SettingDefinitionsModel()
    model.expand = MagicMock()
    model.expandRecursive("whatever")

    assert model.expanded == []
    assert model.expand.call_count == 0


def test_expandRecursive_noDefinition():
    model = SettingDefinitionsModel()
    model._container = MagicMock()
    model._container.findDefinitions = MagicMock(return_value = False)
    model.expand = MagicMock()

    model.expandRecursive("whatever")

    assert model.expanded == []
    assert model.expand.call_count == 0


def test_collapse_no_container():
    model = SettingDefinitionsModel()
    model.collapseRecursive("whatever")

    assert model.expanded == []


@patch("UM.Application.Application.getInstance")
def test_setAllExpandedVisible(application):
    model = createModel("children.def.json")
    mocked_visibility_handler = MagicMock()
    mocked_visibility_handler.getVisible = MagicMock(return_value=set())
    model.setVisibilityHandler(mocked_visibility_handler)
    model.expand("test_setting")

    model.setAllExpandedVisible(True)
    assert mocked_visibility_handler.setVisible.call_count == 1
    mocked_visibility_handler.setVisible.assert_called_with({"test_setting"})

    model.setAllExpandedVisible(False)
    assert mocked_visibility_handler.setVisible.call_count == 2
    mocked_visibility_handler.setVisible.assert_called_with(set())


def test_setAlreadyVisbleSettingVisible():
    model = createModel("children.def.json")
    mocked_visibility_handler = MagicMock()
    mocked_visibility_handler.getVisible = MagicMock(return_value={"test_setting"})
    model.setVisibilityHandler(mocked_visibility_handler)
    model.setVisible("test_setting", True) # This setting is already visible (the visibility handler says so after all!)

    assert mocked_visibility_handler.setVisible.call_count == 0


def test_hideAlreadyHiddenSetting():
    model = createModel("children.def.json")
    mocked_visibility_handler = MagicMock()
    mocked_visibility_handler.getVisible = MagicMock(return_value=set())
    model.setVisibilityHandler(mocked_visibility_handler)
    model.setVisible("test_setting", False)  # This setting is already hidden (the visibility handler says so after all!)

    assert mocked_visibility_handler.setVisible.call_count == 0


def test_showUnknownSetting():
    model = createModel("children.def.json")
    mocked_visibility_handler = MagicMock()
    model.setVisibilityHandler(mocked_visibility_handler)
    model.setVisible("HERPDERP", True)
    assert mocked_visibility_handler.setVisible.call_count == 0


def test_showKnownHiddenSetting():
    model = createModel("children.def.json")
    mocked_visibility_handler = MagicMock()
    mocked_visibility_handler.getVisible = MagicMock(return_value=set())
    model.setVisibilityHandler(mocked_visibility_handler)
    model.setVisible("test_setting", True)

    assert mocked_visibility_handler.setVisible.call_count == 1
    mocked_visibility_handler.setVisible.assert_called_with({"test_setting"})


@patch("UM.Application.Application.getInstance")
def test_setExpanded(application):
    model = createModel("children.def.json")
    model.setExpanded(["*"])
    assert "test_setting" in model.expanded
    assert "test_child_0" not in model.expanded
    assert "test_child_1" not in model.expanded


def test_dataHappy():
    model = createModel("single_setting.def.json")

    assert model.data(model.index(0, 0), model.KeyRole) == "test_setting"
    assert model.data(model.index(0, 0), model.DepthRole) == 0
    assert model.data(model.index(0, 0), model.ExpandedRole) == False
    assert model.data(model.index(0, 0), model.VisibleRole) == False


def test_dataUnhappy():
    model = createModel("single_setting.def.json")
    # Out of bounds
    assert model.data(model.index(250, 0), model.KeyRole) == QVariant()

    # Invalid index
    assert model.data(QModelIndex(), model.KeyRole) == QVariant()

    # Unknown role
    assert model.data(model.index(0, 0), Qt.ItemDataRole.UserRole + 100) == QVariant()

    empty_model = SettingDefinitionsModel()
    assert empty_model.data(model.index(0, 0), model.KeyRole) == QVariant()


def test_getIndexNoContainer():
    model = SettingDefinitionsModel()
    assert model.getIndex("blarg") == -1


def test_isDefinitionVisible_excluded():
    definition = MagicMock()
    definition.key = "blorp"
    model = createModel("single_setting.def.json")
    with patch("UM.Application.Application.getInstance"):
        model.setExclude(["blorp"])
    assert model._isDefinitionVisible(definition) == False


def test_isDefinitionVisible_excludedAncestors():
    definition = MagicMock()
    definition.key = "blorp"
    definition.getAncestors = MagicMock(return_value = {"zomg"})

    model = createModel("single_setting.def.json")
    with patch("UM.Application.Application.getInstance"):
        model.setExclude(["zomg"])

    assert model._isDefinitionVisible(definition) == False


def test_isDefinitionVisible_notExpanded():
    definition = MagicMock()
    definition.key = "blorp"

    model = createModel("single_setting.def.json")

    assert model._isDefinitionVisible(definition) == False


def test_isDefinitionVisible_settingNotVisible():
    definition = MagicMock()
    definition.key = "test_setting"
    definition.getAncestors = MagicMock(return_value=set())
    definition.parent = None
    model = createModel("single_setting.def.json")
    with patch("UM.Application.Application.getInstance"):
        model.expand("test_setting")
        model.setShowAll(False)

    assert model._isDefinitionVisible(definition) == False