Debian Codegraph @

tests_app/tests/unit/routers/nested_router_mixin/tests.py

raw
1 from rest_framework.test import APITestCase
2 from rest_framework_extensions.routers import ExtendedSimpleRouter
3 from rest_framework_extensions.utils import compose_parent_pk_kwarg_name
4 from .views import (
5 UserViewSet,
6 GroupViewSet,
7 PermissionViewSet,
8 CustomRegexUserViewSet,
9 CustomRegexGroupViewSet,
10 CustomRegexPermissionViewSet,
11 )
12
13
14 def get_regex_pattern(urlpattern):
15 return urlpattern.pattern.regex.pattern
16
17
18 class NestedRouterMixinTest(APITestCase):
19 def get_lookup_regex(self, value):
20 return '(?P<{0}>[^/.]+)'.format(value)
21
22 def get_parent_lookup_regex(self, value):
23 return '(?P<{0}>[^/.]+)'.format(compose_parent_pk_kwarg_name(value))
24
25 def get_custom_regex_lookup(self, pk_kwarg_name, lookup_value_regex):
26 """ Build lookup regex with custom regular expression. """
27 return '(?P<{pk_kwarg_name}>{lookup_value_regex})'.format(
28 pk_kwarg_name=pk_kwarg_name,
29 lookup_value_regex=lookup_value_regex
30 )
31
32 def get_custom_regex_parent_lookup(self, parent_pk_kwarg_name,
33 parent_lookup_value_regex):
34 """ Build parent lookup regex with custom regular expression. """
35 return self.get_custom_regex_lookup(
36 compose_parent_pk_kwarg_name(parent_pk_kwarg_name),
37 parent_lookup_value_regex
38 )
39
40 def test_one_route(self):
41 router = ExtendedSimpleRouter()
42 router.register(r'users', UserViewSet, 'user')
43
44 # test user list
45 self.assertEqual(router.urls[0].name, 'user-list')
46 self.assertEqual(get_regex_pattern(router.urls[0]), r'^users/$')
47
48 # test user detail
49 self.assertEqual(router.urls[1].name, 'user-detail')
50 self.assertEqual(get_regex_pattern(router.urls[1]), r'^users/{0}/$'.format(self.get_lookup_regex('pk')))
51
52 def test_nested_route(self):
53 router = ExtendedSimpleRouter()
54 (
55 router.register(r'users', UserViewSet, 'user')
56 .register(r'groups', GroupViewSet, 'users-group', parents_query_lookups=['user'])
57 )
58
59 # test user list
60 self.assertEqual(router.urls[0].name, 'user-list')
61 self.assertEqual(get_regex_pattern(router.urls[0]), r'^users/$')
62
63 # test user detail
64 self.assertEqual(router.urls[1].name, 'user-detail')
65 self.assertEqual(get_regex_pattern(router.urls[1]), r'^users/{0}/$'.format(self.get_lookup_regex('pk')))
66
67 # test users group list
68 self.assertEqual(router.urls[2].name, 'users-group-list')
69 self.assertEqual(get_regex_pattern(router.urls[2]), r'^users/{0}/groups/$'.format(
70 self.get_parent_lookup_regex('user')
71 )
72 )
73
74 # test users group detail
75 self.assertEqual(router.urls[3].name, 'users-group-detail')
76 self.assertEqual(get_regex_pattern(router.urls[3]), r'^users/{0}/groups/{1}/$'.format(
77 self.get_parent_lookup_regex('user'),
78 self.get_lookup_regex('pk')
79 ),
80 )
81
82 def test_nested_route_depth_3(self):
83 router = ExtendedSimpleRouter()
84 (
85 router.register(r'users', UserViewSet, 'user')
86 .register(r'groups', GroupViewSet, 'users-group', parents_query_lookups=['user'])
87 .register(r'permissions', PermissionViewSet, 'users-groups-permission', parents_query_lookups=[
88 'group__user',
89 'group',
90 ]
91 )
92 )
93
94 # test user list
95 self.assertEqual(router.urls[0].name, 'user-list')
96 self.assertEqual(get_regex_pattern(router.urls[0]), r'^users/$')
97
98 # test user detail
99 self.assertEqual(router.urls[1].name, 'user-detail')
100 self.assertEqual(get_regex_pattern(router.urls[1]), r'^users/{0}/$'.format(self.get_lookup_regex('pk')))
101
102 # test users group list
103 self.assertEqual(router.urls[2].name, 'users-group-list')
104 self.assertEqual(get_regex_pattern(router.urls[2]), r'^users/{0}/groups/$'.format(
105 self.get_parent_lookup_regex('user')
106 )
107 )
108
109 # test users group detail
110 self.assertEqual(router.urls[3].name, 'users-group-detail')
111 self.assertEqual(get_regex_pattern(router.urls[3]), r'^users/{0}/groups/{1}/$'.format(
112 self.get_parent_lookup_regex('user'),
113 self.get_lookup_regex('pk')
114 ),
115 )
116
117 # test users groups permission list
118 self.assertEqual(router.urls[4].name, 'users-groups-permission-list')
119 self.assertEqual(get_regex_pattern(router.urls[4]), r'^users/{0}/groups/{1}/permissions/$'.format(
120 self.get_parent_lookup_regex('group__user'),
121 self.get_parent_lookup_regex('group'),
122 )
123 )
124
125 # test users groups permission detail
126 self.assertEqual(router.urls[5].name, 'users-groups-permission-detail')
127 self.assertEqual(get_regex_pattern(router.urls[5]), r'^users/{0}/groups/{1}/permissions/{2}/$'.format(
128 self.get_parent_lookup_regex('group__user'),
129 self.get_parent_lookup_regex('group'),
130 self.get_lookup_regex('pk')
131 ),
132 )
133
134 def test_nested_route_depth_3_custom_regex(self):
135 """
136 Nested routes with over two level of depth should respect all parents'
137 `lookup_value_regex` attribute.
138 """
139 router = ExtendedSimpleRouter()
140 (
141 router.register(r'users', CustomRegexUserViewSet, 'user')
142 .register(r'groups', CustomRegexGroupViewSet, 'users-group',
143 parents_query_lookups=['user'])
144 .register(r'permissions', CustomRegexPermissionViewSet,
145 'users-groups-permission', parents_query_lookups=[
146 'group__user',
147 'group',
148 ]
149 )
150 )
151
152 # custom regex configuration
153 user_viewset_regex = CustomRegexUserViewSet.lookup_value_regex
154 group_viewset_regex = CustomRegexGroupViewSet.lookup_value_regex
155 perm_viewset_regex = CustomRegexPermissionViewSet.lookup_value_regex
156
157 # test user list
158 self.assertEqual(router.urls[0].name, 'user-list')
159 self.assertEqual(get_regex_pattern(router.urls[0]), r'^users/$')
160
161 # test user detail
162 self.assertEqual(router.urls[1].name, 'user-detail')
163 self.assertEqual(get_regex_pattern(router.urls[1]), r'^users/{0}/$'.format(
164 self.get_custom_regex_lookup('pk', user_viewset_regex))
165 )
166
167 # test users group list
168 self.assertEqual(router.urls[2].name, 'users-group-list')
169 self.assertEqual(get_regex_pattern(router.urls[2]), r'^users/{0}/groups/$'.format(
170 self.get_custom_regex_parent_lookup('user', user_viewset_regex)
171 )
172 )
173 # test users group detail
174 self.assertEqual(router.urls[3].name, 'users-group-detail')
175 self.assertEqual(get_regex_pattern(router.urls[3]), r'^users/{0}/groups/{1}/$'.format(
176 self.get_custom_regex_parent_lookup('user', user_viewset_regex),
177 self.get_custom_regex_lookup('pk', group_viewset_regex)
178 ),
179 )
180 # test users groups permission list
181 self.assertEqual(router.urls[4].name, 'users-groups-permission-list')
182 self.assertEqual(get_regex_pattern(router.urls[4]), r'^users/{0}/groups/{1}/permissions/$'.format(
183 self.get_custom_regex_parent_lookup('group__user', user_viewset_regex),
184 self.get_custom_regex_parent_lookup('group', group_viewset_regex),
185 )
186 )
187
188 # test users groups permission detail
189 self.assertEqual(router.urls[5].name, 'users-groups-permission-detail')
190 self.assertEqual(get_regex_pattern(router.urls[5]), r'^users/{0}/groups/{1}/permissions/{2}/$'.format(
191 self.get_custom_regex_parent_lookup('group__user', user_viewset_regex),
192 self.get_custom_regex_parent_lookup('group', group_viewset_regex),
193 self.get_custom_regex_lookup('pk', perm_viewset_regex)
194 ),
195 )