File: test_collision_resolver.py

package info (click to toggle)
python-django-extensions 4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,820 kB
  • sloc: python: 18,601; javascript: 7,354; makefile: 108; xml: 17
file content (528 lines) | stat: -rw-r--r-- 18,530 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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# -*- coding: utf-8 -*-
import sys
from django.contrib.auth.models import Group, Permission
from django.test import override_settings

from django_extensions.collision_resolvers import (
    AppNameCR,
    AppsOrderCR,
    BaseCR,
    PathBasedCR,
)
from tests.collisions.models import Group as Group_Col
from tests.collisions.models import Name as Name_Col
from tests.collisions.models import Note as Note_Col
from tests.collisions.models import SystemUser, UniqueModel
from tests.management.commands.shell_plus_tests.test_utils import (
    AutomaticShellPlusImportsTestCase,
)
from tests.testapp.models import Name, Note, UniqueTestAppModel
from tests.testapp.models import Permission as TAPermission


# Bad user defined collision resolvers:


class TestAppsOrderCR(AppsOrderCR):
    pass


class TestAppNameCR(AppNameCR):
    pass


def collision_resolver_which_is_not_class():
    pass


class CRNotExtendingFromBase:
    pass


class CRNoFunction(BaseCR):
    pass


class CRNoArguments(BaseCR):
    def resolve_collisions(self):
        pass


class CRBadResult(BaseCR):
    def resolve_collisions(self, namespace):
        return 1


class CRBadKey(BaseCR):
    def resolve_collisions(self, namespace):
        return {1: "a"}


class CRBadValue(BaseCR):
    def resolve_collisions(self, namespace):
        return {"a": 1}


class CRBadTransformPath(PathBasedCR):
    def transform_import(self, module_path):
        return 1


class CRTestCase(AutomaticShellPlusImportsTestCase):
    def _assert_models_present_under_names(
        self,
        group,
        group_col,
        name,
        name_col,
        note,
        note_col,
        system_user,
        unique_model,
        permission,
        test_app_permission,
        unique_test_app_model,
    ):
        self.run_shell_plus()
        self.assert_imported_under_names(Group, group)
        self.assert_imported_under_names(Group_Col, group_col)
        self.assert_imported_under_names(Name, name)
        self.assert_imported_under_names(Name_Col, name_col)
        self.assert_imported_under_names(Note, note)
        self.assert_imported_under_names(Note_Col, note_col)
        self.assert_imported_under_names(SystemUser, system_user)
        self.assert_imported_under_names(UniqueModel, unique_model)
        self.assert_imported_under_names(Permission, permission)
        self.assert_imported_under_names(TAPermission, test_app_permission)
        self.assert_imported_under_names(UniqueTestAppModel, unique_test_app_model)

    def test_legacy_collision_resolver(self):
        self._assert_models_present_under_names(
            set(),
            {"Group"},
            {"Name"},
            set(),
            {"Note"},
            set(),
            {"SystemUser"},
            {"UniqueModel"},
            set(),
            {"Permission"},
            {"UniqueTestAppModel"},
        )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="django_extensions.collision_resolvers.AppNamePrefixCR",
    )
    def test_app_name_prefix_collision_resolver(self):
        self._assert_models_present_under_names(
            {"django_contrib_auth_Group"},
            {"tests_collisions_Group", "Group"},
            {"django_extensions_Name", "Name"},
            {"tests_collisions_Name"},
            {"django_extensions_Note", "Note"},
            {"tests_collisions_Note"},
            {"SystemUser"},
            {"UniqueModel"},
            {"django_contrib_auth_Permission"},
            {"tests_testapp_Permission", "Permission"},
            {"UniqueTestAppModel"},
        )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="django_extensions.collision_resolvers.AppNameSuffixCR",
    )
    def test_app_name_suffix_collision_resolver(self):
        self._assert_models_present_under_names(
            {"Group_django_contrib_auth"},
            {"Group_tests_collisions", "Group"},
            {"Name_django_extensions", "Name"},
            {"Name_tests_collisions"},
            {"Note_django_extensions", "Note"},
            {"Note_tests_collisions"},
            {"SystemUser"},
            {"UniqueModel"},
            {"Permission_django_contrib_auth"},
            {"Permission_tests_testapp", "Permission"},
            {"UniqueTestAppModel"},
        )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="django_extensions.collision_resolvers.AppLabelPrefixCR",
    )
    def test_app_label_prefix_collision_resolver(self):
        self._assert_models_present_under_names(
            {"auth_Group"},
            {"collisions_Group", "Group"},
            {"django_extensions_Name", "Name"},
            {"collisions_Name"},
            {"django_extensions_Note", "Note"},
            {"collisions_Note"},
            {"SystemUser"},
            {"UniqueModel"},
            {"auth_Permission"},
            {"testapp_Permission", "Permission"},
            {"UniqueTestAppModel"},
        )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="django_extensions.collision_resolvers.AppLabelSuffixCR",
    )
    def test_app_label_suffix_collision_resolver(self):
        self._assert_models_present_under_names(
            {"Group_auth"},
            {"Group_collisions", "Group"},
            {"Name_django_extensions", "Name"},
            {"Name_collisions"},
            {"Note_django_extensions", "Note"},
            {"Note_collisions"},
            {"SystemUser"},
            {"UniqueModel"},
            {"Permission_auth"},
            {"Permission_testapp", "Permission"},
            {"UniqueTestAppModel"},
        )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="django_extensions.collision_resolvers.FullPathCR",
    )
    def test_full_path_collision_resolver(self):
        self._assert_models_present_under_names(
            {"django_contrib_auth_Group"},
            {"tests_collisions_Group", "Group"},
            {"tests_testapp_Name", "Name"},
            {"tests_collisions_Name"},
            {"tests_testapp_Note", "Note"},
            {"tests_collisions_Note"},
            {"SystemUser"},
            {"UniqueModel"},
            {"django_contrib_auth_Permission"},
            {"tests_testapp_Permission", "Permission"},
            {"UniqueTestAppModel"},
        )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="django_extensions.collision_resolvers.InstalledAppsOrderCR",
    )
    def test_installed_apps_order_collision_resolver(self):
        self._assert_models_present_under_names(
            {"Group"},
            set(),
            set(),
            {"Name"},
            set(),
            {"Note"},
            {"SystemUser"},
            {"UniqueModel"},
            {"Permission"},
            set(),
            {"UniqueTestAppModel"},
        )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="tests.management.commands.shell_plus_tests.test_collision_resolver.TestAppsOrderCR",
    )
    def test_installed_bad_order_collision_resolver(self):
        with self.assertRaisesRegex(
            AssertionError, "You must define APP_PRIORITIES in your resolver class!"
        ):
            self._assert_models_present_under_names(
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
            )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="tests.management.commands.shell_plus_tests.test_collision_resolver.TestAppNameCR",
    )
    def test_installed_apps_bad_name_collision_resolver(self):
        with self.assertRaisesRegex(
            AssertionError,
            "You must define MODIFICATION_STRING in your resolver class!",
        ):
            self._assert_models_present_under_names(
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
            )

    def _assert_bad_resolver(self, message):
        with self.assertRaisesRegex(AssertionError, message):
            self._assert_models_present_under_names(
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
            )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="tests.management.commands.shell_plus_tests.test_collision_resolver.collision_resolver_which_is_not_class",
    )
    def test_installed_apps_not_class_collision_resolver(self):
        self._assert_bad_resolver(
            "SHELL_PLUS_MODEL_IMPORTS_RESOLVER must be subclass of BaseCR!"
        )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="tests.management.commands.shell_plus_tests.test_collision_resolver.CRNotExtendingFromBase",
    )
    def test_installed_apps_not_subclass_of_base(self):
        self._assert_bad_resolver(
            "SHELL_PLUS_MODEL_IMPORTS_RESOLVER must be subclass of BaseCR!"
        )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="tests.management.commands.shell_plus_tests.test_collision_resolver.CRNoFunction",
    )
    def test_installed_apps_no_resolve_conflicts_function(self):
        exception_msg = "Can't instantiate abstract class CRNoFunction with abstract methods resolve_collisions"

        if sys.version_info[:2] >= (3, 12):
            exception_msg = "Can't instantiate abstract class CRNoFunction without an implementation for abstract method 'resolve_collisions'"
        elif sys.version_info[:2] >= (3, 9):
            exception_msg = exception_msg.replace("methods", "method")
        with self.assertRaisesRegex(TypeError, exception_msg):
            self._assert_models_present_under_names(
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
                set(),
            )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="tests.management.commands.shell_plus_tests.test_collision_resolver.CRNoArguments",
    )
    def test_installed_apps_no_arguments_resolve_conflicts(self):
        self._assert_bad_resolver("resolve_collisions function must take one argument!")

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="tests.management.commands.shell_plus_tests.test_collision_resolver.CRBadResult",
    )
    def test_installed_apps_bad_result(self):
        self._assert_bad_resolver(
            "Result of resolve_collisions function must be a dict!"
        )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="tests.management.commands.shell_plus_tests.test_collision_resolver.CRBadKey",
    )
    def test_installed_apps_bad_key(self):
        self._assert_bad_resolver(
            "key in collision resolver result should be str not 1"
        )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="tests.management.commands.shell_plus_tests.test_collision_resolver.CRBadValue",
    )
    def test_installed_apps_bad_value(self):
        self._assert_bad_resolver(
            "value in collision resolver result should be str not 1"
        )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="tests.management.commands.shell_plus_tests.test_collision_resolver.CRBadTransformPath"
    )
    def test_bad_transform_path(self):
        self._assert_bad_resolver("result of transform_import must be str!")

    @override_settings(
        SHELL_PLUS_MODEL_ALIASES={"testapp": {"Note": "MyFunnyNote"}},
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="django_extensions.collision_resolvers.AppNamePrefixCR",
    )
    def test_app_name_prefix_collision_resolver_with_model_alias(self):
        self._assert_models_present_under_names(
            {"django_contrib_auth_Group"},
            {"tests_collisions_Group", "Group"},
            {"django_extensions_Name", "Name"},
            {"tests_collisions_Name"},
            {"MyFunnyNote"},
            {"Note"},
            {"SystemUser"},
            {"UniqueModel"},
            {"django_contrib_auth_Permission"},
            {"tests_testapp_Permission", "Permission"},
            {"UniqueTestAppModel"},
        )

    @override_settings(
        SHELL_PLUS_MODEL_ALIASES={"testapp": {"Note": "Name"}},
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="django_extensions.collision_resolvers.AppNamePrefixCR",
    )
    def test_app_name_prefix_collision_resolver_with_clash_because_of_model_alias(self):
        self._assert_models_present_under_names(
            {"django_contrib_auth_Group"},
            {"tests_collisions_Group", "Group"},
            {"django_extensions_Name"},
            {"tests_collisions_Name"},
            {"django_extensions_Note", "Name"},
            {"Note"},
            {"SystemUser"},
            {"UniqueModel"},
            {"django_contrib_auth_Permission"},
            {"tests_testapp_Permission", "Permission"},
            {"UniqueTestAppModel"},
        )

    @override_settings(
        SHELL_PLUS_APP_PREFIXES={"testapp": "main_app"},
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="django_extensions.collision_resolvers.AppNamePrefixCR",
    )
    def test_app_name_prefix_collision_resolver_with_app_prefixes(self):
        self._assert_models_present_under_names(
            {"django_contrib_auth_Group"},
            {"tests_collisions_Group", "Group"},
            {"main_app_Name"},
            {"Name"},
            {"main_app_Note"},
            {"Note"},
            {"SystemUser"},
            {"UniqueModel"},
            {"Permission"},
            {"main_app_Permission"},
            {"main_app_UniqueTestAppModel"},
        )

    @override_settings(
        SHELL_PLUS_APP_PREFIXES={"testapp": "main_app", "collisions": "main_app"},
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="django_extensions.collision_resolvers.AppNamePrefixCR",
    )
    def test_app_name_prefix_collision_resolver_with_clashing_app_prefixes(self):
        self._assert_models_present_under_names(
            {"Group"},
            {"main_app_Group"},
            {"django_extensions_Name", "main_app_Name"},
            {"tests_collisions_Name"},
            {"django_extensions_Note", "main_app_Note"},
            {"tests_collisions_Note"},
            {"main_app_SystemUser"},
            {"main_app_UniqueModel"},
            {"Permission"},
            {"main_app_Permission"},
            {"main_app_UniqueTestAppModel"},
        )

    @override_settings(
        SHELL_PLUS_APP_PREFIXES={"testapp": "main_app", "auth": "main_app"},
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="django_extensions.collision_resolvers.AppNamePrefixCR",
    )
    def test_app_name_prefix_collision_resolver_clash_with_3rd_party(self):
        self._assert_models_present_under_names(
            {"main_app_Group"},
            {"Group"},
            {"main_app_Name"},
            {"Name"},
            {"main_app_Note"},
            {"Note"},
            {"SystemUser"},
            {"UniqueModel"},
            {"django_contrib_auth_Permission"},
            {"main_app_Permission", "tests_testapp_Permission"},
            {"main_app_UniqueTestAppModel"},
        )

    @override_settings(
        SHELL_PLUS_APP_PREFIXES={
            "testapp": "testapp",
            "auth": "auth",
            "collisions": "collisions",
        },
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="django_extensions.collision_resolvers.AppNamePrefixCR",
    )
    def test_no_collisions_because_of_app_prefixes(self):
        self._assert_models_present_under_names(
            {"auth_Group"},
            {"collisions_Group"},
            {"testapp_Name"},
            {"collisions_Name"},
            {"testapp_Note"},
            {"collisions_Note"},
            {"collisions_SystemUser"},
            {"collisions_UniqueModel"},
            {"auth_Permission"},
            {"testapp_Permission"},
            {"testapp_UniqueTestAppModel"},
        )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="django_extensions.collision_resolvers.AppNamePrefixCustomOrderCR",
    )
    def test_app_name_prefix_custom_order_collision_resolver(self):
        self._assert_models_present_under_names(
            {"django_contrib_auth_Group", "Group"},
            {"tests_collisions_Group"},
            {"django_extensions_Name"},
            {"tests_collisions_Name", "Name"},
            {"django_extensions_Note"},
            {"tests_collisions_Note", "Note"},
            {"SystemUser"},
            {"UniqueModel"},
            {"django_contrib_auth_Permission", "Permission"},
            {"tests_testapp_Permission"},
            {"UniqueTestAppModel"},
        )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="django_extensions.collision_resolvers.AppNameSuffixCustomOrderCR",
    )
    def test_app_name_suffix_custom_order_collision_resolver(self):
        self._assert_models_present_under_names(
            {"Group_django_contrib_auth", "Group"},
            {"Group_tests_collisions"},
            {"Name_django_extensions"},
            {"Name_tests_collisions", "Name"},
            {"Note_django_extensions"},
            {"Note_tests_collisions", "Note"},
            {"SystemUser"},
            {"UniqueModel"},
            {"Permission_django_contrib_auth", "Permission"},
            {"Permission_tests_testapp"},
            {"UniqueTestAppModel"},
        )

    @override_settings(
        SHELL_PLUS_MODEL_IMPORTS_RESOLVER="django_extensions.collision_resolvers.FullPathCustomOrderCR",
    )
    def test_full_path_custom_order_collision_resolver(self):
        self._assert_models_present_under_names(
            {"django_contrib_auth_Group", "Group"},
            {"tests_collisions_Group"},
            {"tests_testapp_Name"},
            {"tests_collisions_Name", "Name"},
            {"tests_testapp_Note"},
            {"tests_collisions_Note", "Note"},
            {"SystemUser"},
            {"UniqueModel"},
            {"django_contrib_auth_Permission", "Permission"},
            {"tests_testapp_Permission"},
            {"UniqueTestAppModel"},
        )