Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 432a174

Browse files
authored
Remove unnecessary json.dumps from tests.rest.admin (#11461)
The tests helpers automatically convert dictionaries to JSON payloads, no need to do it manually for each test.
1 parent b14f8a1 commit 432a174

File tree

2 files changed

+21
-41
lines changed

2 files changed

+21
-41
lines changed

changelog.d/11461.misc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Remove unnecessary `json.dumps` from `tests.rest.admin`.

tests/rest/admin/test_room.py

+20-41
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
import json
1615
import urllib.parse
1716
from http import HTTPStatus
1817
from typing import List, Optional
@@ -118,12 +117,11 @@ def test_new_room_user_does_not_exist(self):
118117
"""
119118
Tests that the user ID must be from local server but it does not have to exist.
120119
"""
121-
body = json.dumps({"new_room_user_id": "@unknown:test"})
122120

123121
channel = self.make_request(
124122
"DELETE",
125123
self.url,
126-
content=body,
124+
content={"new_room_user_id": "@unknown:test"},
127125
access_token=self.admin_user_tok,
128126
)
129127

@@ -137,12 +135,11 @@ def test_new_room_user_is_not_local(self):
137135
"""
138136
Check that only local users can create new room to move members.
139137
"""
140-
body = json.dumps({"new_room_user_id": "@not:exist.bla"})
141138

142139
channel = self.make_request(
143140
"DELETE",
144141
self.url,
145-
content=body,
142+
content={"new_room_user_id": "@not:exist.bla"},
146143
access_token=self.admin_user_tok,
147144
)
148145

@@ -156,12 +153,11 @@ def test_block_is_not_bool(self):
156153
"""
157154
If parameter `block` is not boolean, return an error
158155
"""
159-
body = json.dumps({"block": "NotBool"})
160156

161157
channel = self.make_request(
162158
"DELETE",
163159
self.url,
164-
content=body,
160+
content={"block": "NotBool"},
165161
access_token=self.admin_user_tok,
166162
)
167163

@@ -172,12 +168,11 @@ def test_purge_is_not_bool(self):
172168
"""
173169
If parameter `purge` is not boolean, return an error
174170
"""
175-
body = json.dumps({"purge": "NotBool"})
176171

177172
channel = self.make_request(
178173
"DELETE",
179174
self.url,
180-
content=body,
175+
content={"purge": "NotBool"},
181176
access_token=self.admin_user_tok,
182177
)
183178

@@ -198,12 +193,10 @@ def test_purge_room_and_block(self):
198193
# Assert one user in room
199194
self._is_member(room_id=self.room_id, user_id=self.other_user)
200195

201-
body = json.dumps({"block": True, "purge": True})
202-
203196
channel = self.make_request(
204197
"DELETE",
205198
self.url.encode("ascii"),
206-
content=body,
199+
content={"block": True, "purge": True},
207200
access_token=self.admin_user_tok,
208201
)
209202

@@ -231,12 +224,10 @@ def test_purge_room_and_not_block(self):
231224
# Assert one user in room
232225
self._is_member(room_id=self.room_id, user_id=self.other_user)
233226

234-
body = json.dumps({"block": False, "purge": True})
235-
236227
channel = self.make_request(
237228
"DELETE",
238229
self.url.encode("ascii"),
239-
content=body,
230+
content={"block": False, "purge": True},
240231
access_token=self.admin_user_tok,
241232
)
242233

@@ -265,12 +256,10 @@ def test_block_room_and_not_purge(self):
265256
# Assert one user in room
266257
self._is_member(room_id=self.room_id, user_id=self.other_user)
267258

268-
body = json.dumps({"block": True, "purge": False})
269-
270259
channel = self.make_request(
271260
"DELETE",
272261
self.url.encode("ascii"),
273-
content=body,
262+
content={"block": True, "purge": False},
274263
access_token=self.admin_user_tok,
275264
)
276265

@@ -342,7 +331,7 @@ def test_shutdown_room_consent(self):
342331
channel = self.make_request(
343332
"DELETE",
344333
self.url,
345-
json.dumps({"new_room_user_id": self.admin_user}),
334+
{"new_room_user_id": self.admin_user},
346335
access_token=self.admin_user_tok,
347336
)
348337

@@ -372,7 +361,7 @@ def test_shutdown_room_block_peek(self):
372361
channel = self.make_request(
373362
"PUT",
374363
url.encode("ascii"),
375-
json.dumps({"history_visibility": "world_readable"}),
364+
{"history_visibility": "world_readable"},
376365
access_token=self.other_user_tok,
377366
)
378367
self.assertEqual(HTTPStatus.OK, channel.code, msg=channel.json_body)
@@ -388,7 +377,7 @@ def test_shutdown_room_block_peek(self):
388377
channel = self.make_request(
389378
"DELETE",
390379
self.url,
391-
json.dumps({"new_room_user_id": self.admin_user}),
380+
{"new_room_user_id": self.admin_user},
392381
access_token=self.admin_user_tok,
393382
)
394383

@@ -1782,12 +1771,11 @@ def test_requester_is_no_admin(self):
17821771
"""
17831772
If the user is not a server admin, an error HTTPStatus.FORBIDDEN is returned.
17841773
"""
1785-
body = json.dumps({"user_id": self.second_user_id})
17861774

17871775
channel = self.make_request(
17881776
"POST",
17891777
self.url,
1790-
content=body,
1778+
content={"user_id": self.second_user_id},
17911779
access_token=self.second_tok,
17921780
)
17931781

@@ -1798,12 +1786,11 @@ def test_invalid_parameter(self):
17981786
"""
17991787
If a parameter is missing, return an error
18001788
"""
1801-
body = json.dumps({"unknown_parameter": "@unknown:test"})
18021789

18031790
channel = self.make_request(
18041791
"POST",
18051792
self.url,
1806-
content=body,
1793+
content={"unknown_parameter": "@unknown:test"},
18071794
access_token=self.admin_user_tok,
18081795
)
18091796

@@ -1814,12 +1801,11 @@ def test_local_user_does_not_exist(self):
18141801
"""
18151802
Tests that a lookup for a user that does not exist returns a HTTPStatus.NOT_FOUND
18161803
"""
1817-
body = json.dumps({"user_id": "@unknown:test"})
18181804

18191805
channel = self.make_request(
18201806
"POST",
18211807
self.url,
1822-
content=body,
1808+
content={"user_id": "@unknown:test"},
18231809
access_token=self.admin_user_tok,
18241810
)
18251811

@@ -1830,12 +1816,11 @@ def test_remote_user(self):
18301816
"""
18311817
Check that only local user can join rooms.
18321818
"""
1833-
body = json.dumps({"user_id": "@not:exist.bla"})
18341819

18351820
channel = self.make_request(
18361821
"POST",
18371822
self.url,
1838-
content=body,
1823+
content={"user_id": "@not:exist.bla"},
18391824
access_token=self.admin_user_tok,
18401825
)
18411826

@@ -1849,13 +1834,12 @@ def test_room_does_not_exist(self):
18491834
"""
18501835
Check that unknown rooms/server return error HTTPStatus.NOT_FOUND.
18511836
"""
1852-
body = json.dumps({"user_id": self.second_user_id})
18531837
url = "/_synapse/admin/v1/join/!unknown:test"
18541838

18551839
channel = self.make_request(
18561840
"POST",
18571841
url,
1858-
content=body,
1842+
content={"user_id": self.second_user_id},
18591843
access_token=self.admin_user_tok,
18601844
)
18611845

@@ -1866,13 +1850,12 @@ def test_room_is_not_valid(self):
18661850
"""
18671851
Check that invalid room names, return an error HTTPStatus.BAD_REQUEST.
18681852
"""
1869-
body = json.dumps({"user_id": self.second_user_id})
18701853
url = "/_synapse/admin/v1/join/invalidroom"
18711854

18721855
channel = self.make_request(
18731856
"POST",
18741857
url,
1875-
content=body,
1858+
content={"user_id": self.second_user_id},
18761859
access_token=self.admin_user_tok,
18771860
)
18781861

@@ -1886,12 +1869,11 @@ def test_join_public_room(self):
18861869
"""
18871870
Test joining a local user to a public room with "JoinRules.PUBLIC"
18881871
"""
1889-
body = json.dumps({"user_id": self.second_user_id})
18901872

18911873
channel = self.make_request(
18921874
"POST",
18931875
self.url,
1894-
content=body,
1876+
content={"user_id": self.second_user_id},
18951877
access_token=self.admin_user_tok,
18961878
)
18971879

@@ -1917,12 +1899,11 @@ def test_join_private_room_if_not_member(self):
19171899
self.creator, tok=self.creator_tok, is_public=False
19181900
)
19191901
url = f"/_synapse/admin/v1/join/{private_room_id}"
1920-
body = json.dumps({"user_id": self.second_user_id})
19211902

19221903
channel = self.make_request(
19231904
"POST",
19241905
url,
1925-
content=body,
1906+
content={"user_id": self.second_user_id},
19261907
access_token=self.admin_user_tok,
19271908
)
19281909

@@ -1960,12 +1941,11 @@ def test_join_private_room_if_member(self):
19601941
# Join user to room.
19611942

19621943
url = f"/_synapse/admin/v1/join/{private_room_id}"
1963-
body = json.dumps({"user_id": self.second_user_id})
19641944

19651945
channel = self.make_request(
19661946
"POST",
19671947
url,
1968-
content=body,
1948+
content={"user_id": self.second_user_id},
19691949
access_token=self.admin_user_tok,
19701950
)
19711951
self.assertEqual(HTTPStatus.OK, channel.code, msg=channel.json_body)
@@ -1990,12 +1970,11 @@ def test_join_private_room_if_owner(self):
19901970
self.admin_user, tok=self.admin_user_tok, is_public=False
19911971
)
19921972
url = f"/_synapse/admin/v1/join/{private_room_id}"
1993-
body = json.dumps({"user_id": self.second_user_id})
19941973

19951974
channel = self.make_request(
19961975
"POST",
19971976
url,
1998-
content=body,
1977+
content={"user_id": self.second_user_id},
19991978
access_token=self.admin_user_tok,
20001979
)
20011980

0 commit comments

Comments
 (0)