diff --git a/tests/rest/admin/test_user.py b/tests/rest/admin/test_user.py
index ba26895391..e58d5cf0db 100644
--- a/tests/rest/admin/test_user.py
+++ b/tests/rest/admin/test_user.py
@@ -18,7 +18,7 @@ import hmac
import json
import urllib.parse
from binascii import unhexlify
-from typing import Optional
+from typing import List, Optional
from mock import Mock
@@ -31,6 +31,7 @@ from synapse.rest.client.v2_alpha import devices, sync
from synapse.types import JsonDict
from tests import unittest
+from tests.server import FakeSite, make_request
from tests.test_utils import make_awaitable
from tests.unittest import override_config
@@ -1954,6 +1955,7 @@ class UserMediaRestTestCase(unittest.HomeserverTestCase):
]
def prepare(self, reactor, clock, hs):
+ self.store = hs.get_datastore()
self.media_repo = hs.get_media_repository_resource()
self.admin_user = self.register_user("admin", "pass", admin=True)
@@ -2024,7 +2026,7 @@ class UserMediaRestTestCase(unittest.HomeserverTestCase):
number_media = 20
other_user_tok = self.login("user", "pass")
- self._create_media(other_user_tok, number_media)
+ self._create_media_for_user(other_user_tok, number_media)
channel = self.make_request(
"GET",
@@ -2045,7 +2047,7 @@ class UserMediaRestTestCase(unittest.HomeserverTestCase):
number_media = 20
other_user_tok = self.login("user", "pass")
- self._create_media(other_user_tok, number_media)
+ self._create_media_for_user(other_user_tok, number_media)
channel = self.make_request(
"GET",
@@ -2066,7 +2068,7 @@ class UserMediaRestTestCase(unittest.HomeserverTestCase):
number_media = 20
other_user_tok = self.login("user", "pass")
- self._create_media(other_user_tok, number_media)
+ self._create_media_for_user(other_user_tok, number_media)
channel = self.make_request(
"GET",
@@ -2080,11 +2082,31 @@ class UserMediaRestTestCase(unittest.HomeserverTestCase):
self.assertEqual(len(channel.json_body["media"]), 10)
self._check_fields(channel.json_body["media"])
- def test_limit_is_negative(self):
+ def test_invalid_parameter(self):
"""
- Testing that a negative limit parameter returns a 400
+ If parameters are invalid, an error is returned.
"""
+ # unkown order_by
+ channel = self.make_request(
+ "GET",
+ self.url + "?order_by=bar",
+ access_token=self.admin_user_tok,
+ )
+
+ self.assertEqual(400, int(channel.result["code"]), msg=channel.result["body"])
+ self.assertEqual(Codes.UNKNOWN, channel.json_body["errcode"])
+ # invalid search order
+ channel = self.make_request(
+ "GET",
+ self.url + "?dir=bar",
+ access_token=self.admin_user_tok,
+ )
+
+ self.assertEqual(400, int(channel.result["code"]), msg=channel.result["body"])
+ self.assertEqual(Codes.UNKNOWN, channel.json_body["errcode"])
+
+ # negative limit
channel = self.make_request(
"GET",
self.url + "?limit=-5",
@@ -2094,11 +2116,7 @@ class UserMediaRestTestCase(unittest.HomeserverTestCase):
self.assertEqual(400, int(channel.result["code"]), msg=channel.result["body"])
self.assertEqual(Codes.INVALID_PARAM, channel.json_body["errcode"])
- def test_from_is_negative(self):
- """
- Testing that a negative from parameter returns a 400
- """
-
+ # negative from
channel = self.make_request(
"GET",
self.url + "?from=-5",
@@ -2115,7 +2133,7 @@ class UserMediaRestTestCase(unittest.HomeserverTestCase):
number_media = 20
other_user_tok = self.login("user", "pass")
- self._create_media(other_user_tok, number_media)
+ self._create_media_for_user(other_user_tok, number_media)
# `next_token` does not appear
# Number of results is the number of entries
@@ -2193,7 +2211,7 @@ class UserMediaRestTestCase(unittest.HomeserverTestCase):
number_media = 5
other_user_tok = self.login("user", "pass")
- self._create_media(other_user_tok, number_media)
+ self._create_media_for_user(other_user_tok, number_media)
channel = self.make_request(
"GET",
@@ -2207,11 +2225,118 @@ class UserMediaRestTestCase(unittest.HomeserverTestCase):
self.assertNotIn("next_token", channel.json_body)
self._check_fields(channel.json_body["media"])
- def _create_media(self, user_token, number_media):
+ def test_order_by(self):
+ """
+ Testing order list with parameter `order_by`
+ """
+
+ other_user_tok = self.login("user", "pass")
+
+ # Resolution: 1×1, MIME type: image/png, Extension: png, Size: 67 B
+ image_data1 = unhexlify(
+ b"89504e470d0a1a0a0000000d4948445200000001000000010806"
+ b"0000001f15c4890000000a49444154789c63000100000500010d"
+ b"0a2db40000000049454e44ae426082"
+ )
+ # Resolution: 1×1, MIME type: image/gif, Extension: gif, Size: 35 B
+ image_data2 = unhexlify(
+ b"47494638376101000100800100000000"
+ b"ffffff2c00000000010001000002024c"
+ b"01003b"
+ )
+ # Resolution: 1×1, MIME type: image/bmp, Extension: bmp, Size: 54 B
+ image_data3 = unhexlify(
+ b"424d3a0000000000000036000000280000000100000001000000"
+ b"0100180000000000040000000000000000000000000000000000"
+ b"0000"
+ )
+
+ # create media and make sure they do not have the same timestamp
+ media1 = self._create_media_and_access(other_user_tok, image_data1, "image.png")
+ self.pump(1.0)
+ media2 = self._create_media_and_access(other_user_tok, image_data2, "image.gif")
+ self.pump(1.0)
+ media3 = self._create_media_and_access(other_user_tok, image_data3, "image.bmp")
+ self.pump(1.0)
+
+ # Mark one media as safe from quarantine.
+ self.get_success(self.store.mark_local_media_as_safe(media2))
+ # Quarantine one media
+ self.get_success(
+ self.store.quarantine_media_by_id("test", media3, self.admin_user)
+ )
+
+ # order by default ("created_ts")
+ # default is backwards
+ self._order_test([media3, media2, media1], None)
+ self._order_test([media1, media2, media3], None, "f")
+ self._order_test([media3, media2, media1], None, "b")
+
+ # sort by media_id
+ sorted_media = sorted([media1, media2, media3], reverse=False)
+ sorted_media_reverse = sorted(sorted_media, reverse=True)
+
+ # order by media_id
+ self._order_test(sorted_media, "media_id")
+ self._order_test(sorted_media, "media_id", "f")
+ self._order_test(sorted_media_reverse, "media_id", "b")
+
+ # order by upload_name
+ self._order_test([media3, media2, media1], "upload_name")
+ self._order_test([media3, media2, media1], "upload_name", "f")
+ self._order_test([media1, media2, media3], "upload_name", "b")
+
+ # order by media_type
+ # result is ordered by media_id
+ # because of uploaded media_type is always 'application/json'
+ self._order_test(sorted_media, "media_type")
+ self._order_test(sorted_media, "media_type", "f")
+ self._order_test(sorted_media, "media_type", "b")
+
+ # order by media_length
+ self._order_test([media2, media3, media1], "media_length")
+ self._order_test([media2, media3, media1], "media_length", "f")
+ self._order_test([media1, media3, media2], "media_length", "b")
+
+ # order by created_ts
+ self._order_test([media1, media2, media3], "created_ts")
+ self._order_test([media1, media2, media3], "created_ts", "f")
+ self._order_test([media3, media2, media1], "created_ts", "b")
+
+ # order by last_access_ts
+ self._order_test([media1, media2, media3], "last_access_ts")
+ self._order_test([media1, media2, media3], "last_access_ts", "f")
+ self._order_test([media3, media2, media1], "last_access_ts", "b")
+
+ # order by quarantined_by
+ # one media is in quarantine, others are ordered by media_ids
+
+ # Different sort order of SQlite and PostreSQL
+ # If a media is not in quarantine `quarantined_by` is NULL
+ # SQLite considers NULL to be smaller than any other value.
+ # PostreSQL considers NULL to be larger than any other value.
+
+ # self._order_test(sorted([media1, media2]) + [media3], "quarantined_by")
+ # self._order_test(sorted([media1, media2]) + [media3], "quarantined_by", "f")
+ # self._order_test([media3] + sorted([media1, media2]), "quarantined_by", "b")
+
+ # order by safe_from_quarantine
+ # one media is safe from quarantine, others are ordered by media_ids
+ self._order_test(sorted([media1, media3]) + [media2], "safe_from_quarantine")
+ self._order_test(
+ sorted([media1, media3]) + [media2], "safe_from_quarantine", "f"
+ )
+ self._order_test(
+ [media2] + sorted([media1, media3]), "safe_from_quarantine", "b"
+ )
+
+ def _create_media_for_user(self, user_token: str, number_media: int):
"""
Create a number of media for a specific user
+ Args:
+ user_token: Access token of the user
+ number_media: Number of media to be created for the user
"""
- upload_resource = self.media_repo.children[b"upload"]
for i in range(number_media):
# file size is 67 Byte
image_data = unhexlify(
@@ -2220,13 +2345,60 @@ class UserMediaRestTestCase(unittest.HomeserverTestCase):
b"0a2db40000000049454e44ae426082"
)
- # Upload some media into the room
- self.helper.upload_media(
- upload_resource, image_data, tok=user_token, expect_code=200
- )
+ self._create_media_and_access(user_token, image_data)
+
+ def _create_media_and_access(
+ self,
+ user_token: str,
+ image_data: bytes,
+ filename: str = "image1.png",
+ ) -> str:
+ """
+ Create one media for a specific user, access and returns `media_id`
+ Args:
+ user_token: Access token of the user
+ image_data: binary data of image
+ filename: The filename of the media to be uploaded
+ Returns:
+ The ID of the newly created media.
+ """
+ upload_resource = self.media_repo.children[b"upload"]
+ download_resource = self.media_repo.children[b"download"]
+
+ # Upload some media into the room
+ response = self.helper.upload_media(
+ upload_resource, image_data, user_token, filename, expect_code=200
+ )
+
+ # Extract media ID from the response
+ server_and_media_id = response["content_uri"][6:] # Cut off 'mxc://'
+ media_id = server_and_media_id.split("/")[1]
+
+ # Try to access a media and to create `last_access_ts`
+ channel = make_request(
+ self.reactor,
+ FakeSite(download_resource),
+ "GET",
+ server_and_media_id,
+ shorthand=False,
+ access_token=user_token,
+ )
+
+ self.assertEqual(
+ 200,
+ channel.code,
+ msg=(
+ "Expected to receive a 200 on accessing media: %s" % server_and_media_id
+ ),
+ )
- def _check_fields(self, content):
- """Checks that all attributes are present in content"""
+ return media_id
+
+ def _check_fields(self, content: JsonDict):
+ """Checks that the expected user attributes are present in content
+ Args:
+ content: List that is checked for content
+ """
for m in content:
self.assertIn("media_id", m)
self.assertIn("media_type", m)
@@ -2237,6 +2409,38 @@ class UserMediaRestTestCase(unittest.HomeserverTestCase):
self.assertIn("quarantined_by", m)
self.assertIn("safe_from_quarantine", m)
+ def _order_test(
+ self,
+ expected_media_list: List[str],
+ order_by: Optional[str],
+ dir: Optional[str] = None,
+ ):
+ """Request the list of media in a certain order. Assert that order is what
+ we expect
+ Args:
+ expected_media_list: The list of media_ids in the order we expect to get
+ back from the server
+ order_by: The type of ordering to give the server
+ dir: The direction of ordering to give the server
+ """
+
+ url = self.url + "?"
+ if order_by is not None:
+ url += "order_by=%s&" % (order_by,)
+ if dir is not None and dir in ("b", "f"):
+ url += "dir=%s" % (dir,)
+ channel = self.make_request(
+ "GET",
+ url.encode("ascii"),
+ access_token=self.admin_user_tok,
+ )
+ self.assertEqual(200, channel.code, msg=channel.json_body)
+ self.assertEqual(channel.json_body["total"], len(expected_media_list))
+
+ returned_order = [row["media_id"] for row in channel.json_body["media"]]
+ self.assertEqual(expected_media_list, returned_order)
+ self._check_fields(channel.json_body["media"])
+
class UserTokenRestTestCase(unittest.HomeserverTestCase):
"""Test for /_synapse/admin/v1/users/<user>/login"""
|
