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
|
from django.urls import reverse
from .base import AuthenticatedAPITestCase
from pydis_site.apps.api.models import Role, User
class CreationTests(AuthenticatedAPITestCase):
@classmethod
def setUpTestData(cls):
cls.admins_role = Role.objects.create(
id=1,
name="Admins",
colour=1,
permissions=1,
position=4,
)
cls.developers_role = Role.objects.create(
id=4,
name="Helpers",
colour=4,
permissions=4,
position=1,
)
cls.everyone_role = Role.objects.create(
id=5,
name="@everyone",
colour=5,
permissions=5,
position=0,
)
cls.lowest_position_duplicate = Role.objects.create(
id=6,
name="lowest position duplicate",
colour=6,
permissions=6,
position=0,
)
cls.role_to_delete = Role.objects.create(
id=7,
name="role to delete",
colour=7,
permissions=7,
position=0,
)
cls.role_unassigned_test_user = User.objects.create(
id=8,
name="role_unassigned_test_user",
discriminator="0000",
roles=[cls.role_to_delete.id],
in_guild=True
)
def _validate_roledict(self, role_dict: dict) -> None:
"""Helper method to validate a dict representing a role."""
self.assertIsInstance(role_dict, dict)
self.assertEqual(len(role_dict), 5)
attributes = ('id', 'name', 'colour', 'permissions', 'position')
self.assertTrue(all(attribute in role_dict for attribute in attributes))
def test_role_ordering_lt(self):
"""Tests the __lt__ comparisons based on role position in the hierarchy."""
self.assertTrue(self.everyone_role < self.developers_role)
self.assertFalse(self.developers_role > self.admins_role)
def test_role_ordering_le(self):
"""Tests the __le__ comparisons based on role position in the hierarchy."""
self.assertTrue(self.everyone_role <= self.developers_role)
self.assertTrue(self.everyone_role <= self.lowest_position_duplicate)
self.assertTrue(self.everyone_role >= self.lowest_position_duplicate)
self.assertTrue(self.developers_role >= self.everyone_role)
self.assertFalse(self.developers_role >= self.admins_role)
self.assertFalse(self.developers_role <= self.everyone_role)
def test_role_min_max_ordering(self):
"""Tests the `min` and `max` operations based on the role hierarchy."""
top_role_no_duplicates = max([self.developers_role, self.admins_role, self.everyone_role])
self.assertIs(top_role_no_duplicates, self.admins_role)
top_role_duplicates = max([self.developers_role, self.admins_role, self.admins_role])
self.assertIs(top_role_duplicates, self.admins_role)
bottom_role_no_duplicates = min(
[self.developers_role, self.admins_role, self.everyone_role]
)
self.assertIs(bottom_role_no_duplicates, self.everyone_role)
bottom_role_duplicates = min(
[self.lowest_position_duplicate, self.admins_role, self.everyone_role]
)
self.assertIs(bottom_role_duplicates, self.lowest_position_duplicate)
def test_role_list(self):
"""Tests the GET list-view and validates the contents."""
url = reverse('api:bot:role-list')
response = self.client.get(url)
self.assertContains(response, text="id", count=5, status_code=200)
roles = response.json()
self.assertIsInstance(roles, list)
self.assertEqual(len(roles), 5)
for role in roles:
self._validate_roledict(role)
def test_role_get_detail_success(self):
"""Tests GET detail view of an existing role."""
url = reverse('api:bot:role-detail', args=(self.admins_role.id, ))
response = self.client.get(url)
self.assertContains(response, text="id", count=1, status_code=200)
role = response.json()
self._validate_roledict(role)
admins_role = Role.objects.get(id=role["id"])
self.assertEqual(admins_role.name, role["name"])
self.assertEqual(admins_role.colour, role["colour"])
self.assertEqual(admins_role.permissions, role["permissions"])
self.assertEqual(admins_role.position, role["position"])
def test_role_post_201(self):
"""Tests creation of a role with a valid request."""
url = reverse('api:bot:role-list')
data = {
"id": 1234567890,
"name": "Role Creation Test",
"permissions": 0b01010010101,
"colour": 1,
"position": 10,
}
response = self.client.post(url, data=data)
self.assertEqual(response.status_code, 201)
def test_role_post_invalid_request_body(self):
"""Tests creation of a role with an invalid request body."""
url = reverse('api:bot:role-list')
data = {
"name": "Role Creation Test",
"permissions": 0b01010010101,
"colour": 1,
"position": 10,
}
response = self.client.post(url, data=data)
self.assertEqual(response.status_code, 400)
self.assertJSONEqual(response.content, '{"id": ["This field is required."]}')
def test_role_put_200(self):
"""Tests PUT role request with valid request body."""
url = reverse('api:bot:role-detail', args=(self.admins_role.id,))
data = {
"id": 123454321,
"name": "Role Put Alteration Test",
"permissions": 255,
"colour": 999,
"position": 20,
}
response = self.client.put(url, data=data)
self.assertEqual(response.status_code, 200)
admins_role = Role.objects.get(id=data["id"])
self.assertEqual(admins_role.name, data["name"])
self.assertEqual(admins_role.permissions, data["permissions"])
self.assertEqual(admins_role.colour, data["colour"])
self.assertEqual(admins_role.position, data["position"])
def test_role_put_invalid_request_body(self):
"""Tests PUT role request with invalid request body."""
url = reverse('api:bot:role-detail', args=(self.admins_role.id,))
data = {
"name": "Role Put Alteration Test",
"permissions": 255,
"colour": 999,
"position": 20,
}
response = self.client.put(url, data=data)
self.assertEqual(response.status_code, 400)
def test_role_patch_200(self):
"""Tests PATCH role request with valid request body."""
url = reverse('api:bot:role-detail', args=(self.admins_role.id,))
data = {
"name": "Owners"
}
response = self.client.patch(url, data=data)
self.assertEqual(response.status_code, 200)
admins_role = Role.objects.get(id=self.admins_role.id)
self.assertEqual(admins_role.name, data["name"])
def test_role_delete_200(self):
"""Tests DELETE requests for existing role."""
url = reverse('api:bot:role-detail', args=(self.admins_role.id,))
response = self.client.delete(url)
self.assertEqual(response.status_code, 204)
def test_role_delete_unassigned(self):
"""Tests if the deleted Role gets unassigned from the user."""
self.role_to_delete.delete()
self.role_unassigned_test_user.refresh_from_db()
self.assertEqual(self.role_unassigned_test_user.roles, [])
def test_role_detail_404_all_methods(self):
"""Tests detail view with non-existing ID."""
url = reverse('api:bot:role-detail', args=(20190815,))
for method in ('get', 'put', 'patch', 'delete'):
response = getattr(self.client, method)(url)
self.assertEqual(response.status_code, 404)
self.assertJSONEqual(
response.content,
'{"detail": "No Role matches the given query."}',
)
|
