517 lines
18 KiB
Python
517 lines
18 KiB
Python
# Copyright 2020 Dirk Klimpel
|
|
# Copyright 2021 The Matrix.org Foundation C.I.C.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
from typing import List, Optional
|
|
|
|
from twisted.test.proto_helpers import MemoryReactor
|
|
|
|
import synapse.rest.admin
|
|
from synapse.api.errors import Codes
|
|
from synapse.rest.client import login
|
|
from synapse.server import HomeServer
|
|
from synapse.types import JsonDict
|
|
from synapse.util import Clock
|
|
|
|
from tests import unittest
|
|
from tests.test_utils import SMALL_PNG
|
|
|
|
|
|
class UserMediaStatisticsTestCase(unittest.HomeserverTestCase):
|
|
servlets = [
|
|
synapse.rest.admin.register_servlets,
|
|
login.register_servlets,
|
|
]
|
|
|
|
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
|
|
self.media_repo = hs.get_media_repository_resource()
|
|
|
|
self.admin_user = self.register_user("admin", "pass", admin=True)
|
|
self.admin_user_tok = self.login("admin", "pass")
|
|
|
|
self.other_user = self.register_user("user", "pass")
|
|
self.other_user_tok = self.login("user", "pass")
|
|
|
|
self.url = "/_synapse/admin/v1/statistics/users/media"
|
|
|
|
def test_no_auth(self) -> None:
|
|
"""
|
|
Try to list users without authentication.
|
|
"""
|
|
channel = self.make_request("GET", self.url, b"{}")
|
|
|
|
self.assertEqual(401, channel.code, msg=channel.json_body)
|
|
self.assertEqual(Codes.MISSING_TOKEN, channel.json_body["errcode"])
|
|
|
|
def test_requester_is_no_admin(self) -> None:
|
|
"""
|
|
If the user is not a server admin, an error 403 is returned.
|
|
"""
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url,
|
|
{},
|
|
access_token=self.other_user_tok,
|
|
)
|
|
|
|
self.assertEqual(403, channel.code, msg=channel.json_body)
|
|
self.assertEqual(Codes.FORBIDDEN, channel.json_body["errcode"])
|
|
|
|
def test_invalid_parameter(self) -> None:
|
|
"""
|
|
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, channel.code, msg=channel.json_body)
|
|
self.assertEqual(Codes.INVALID_PARAM, channel.json_body["errcode"])
|
|
|
|
# negative from
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?from=-5",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(400, channel.code, msg=channel.json_body)
|
|
self.assertEqual(Codes.INVALID_PARAM, channel.json_body["errcode"])
|
|
|
|
# negative limit
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?limit=-5",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(400, channel.code, msg=channel.json_body)
|
|
self.assertEqual(Codes.INVALID_PARAM, channel.json_body["errcode"])
|
|
|
|
# negative from_ts
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?from_ts=-1234",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(400, channel.code, msg=channel.json_body)
|
|
self.assertEqual(Codes.INVALID_PARAM, channel.json_body["errcode"])
|
|
|
|
# negative until_ts
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?until_ts=-1234",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(400, channel.code, msg=channel.json_body)
|
|
self.assertEqual(Codes.INVALID_PARAM, channel.json_body["errcode"])
|
|
|
|
# until_ts smaller from_ts
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?from_ts=10&until_ts=5",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(400, channel.code, msg=channel.json_body)
|
|
self.assertEqual(Codes.INVALID_PARAM, channel.json_body["errcode"])
|
|
|
|
# empty search term
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?search_term=",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(400, channel.code, msg=channel.json_body)
|
|
self.assertEqual(Codes.INVALID_PARAM, 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, channel.code, msg=channel.json_body)
|
|
self.assertEqual(Codes.INVALID_PARAM, channel.json_body["errcode"])
|
|
|
|
def test_limit(self) -> None:
|
|
"""
|
|
Testing list of media with limit
|
|
"""
|
|
self._create_users_with_media(10, 2)
|
|
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?limit=5",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(channel.json_body["total"], 10)
|
|
self.assertEqual(len(channel.json_body["users"]), 5)
|
|
self.assertEqual(channel.json_body["next_token"], 5)
|
|
self._check_fields(channel.json_body["users"])
|
|
|
|
def test_from(self) -> None:
|
|
"""
|
|
Testing list of media with a defined starting point (from)
|
|
"""
|
|
self._create_users_with_media(20, 2)
|
|
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?from=5",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(channel.json_body["total"], 20)
|
|
self.assertEqual(len(channel.json_body["users"]), 15)
|
|
self.assertNotIn("next_token", channel.json_body)
|
|
self._check_fields(channel.json_body["users"])
|
|
|
|
def test_limit_and_from(self) -> None:
|
|
"""
|
|
Testing list of media with a defined starting point and limit
|
|
"""
|
|
self._create_users_with_media(20, 2)
|
|
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?from=5&limit=10",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(channel.json_body["total"], 20)
|
|
self.assertEqual(channel.json_body["next_token"], 15)
|
|
self.assertEqual(len(channel.json_body["users"]), 10)
|
|
self._check_fields(channel.json_body["users"])
|
|
|
|
def test_next_token(self) -> None:
|
|
"""
|
|
Testing that `next_token` appears at the right place
|
|
"""
|
|
|
|
number_users = 20
|
|
self._create_users_with_media(number_users, 3)
|
|
|
|
# `next_token` does not appear
|
|
# Number of results is the number of entries
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?limit=20",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(channel.json_body["total"], number_users)
|
|
self.assertEqual(len(channel.json_body["users"]), number_users)
|
|
self.assertNotIn("next_token", channel.json_body)
|
|
|
|
# `next_token` does not appear
|
|
# Number of max results is larger than the number of entries
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?limit=21",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(channel.json_body["total"], number_users)
|
|
self.assertEqual(len(channel.json_body["users"]), number_users)
|
|
self.assertNotIn("next_token", channel.json_body)
|
|
|
|
# `next_token` does appear
|
|
# Number of max results is smaller than the number of entries
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?limit=19",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(channel.json_body["total"], number_users)
|
|
self.assertEqual(len(channel.json_body["users"]), 19)
|
|
self.assertEqual(channel.json_body["next_token"], 19)
|
|
|
|
# Set `from` to value of `next_token` for request remaining entries
|
|
# Check `next_token` does not appear
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?from=19",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(channel.json_body["total"], number_users)
|
|
self.assertEqual(len(channel.json_body["users"]), 1)
|
|
self.assertNotIn("next_token", channel.json_body)
|
|
|
|
def test_no_media(self) -> None:
|
|
"""
|
|
Tests that a normal lookup for statistics is successfully
|
|
if users have no media created
|
|
"""
|
|
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url,
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(0, channel.json_body["total"])
|
|
self.assertEqual(0, len(channel.json_body["users"]))
|
|
|
|
def test_order_by(self) -> None:
|
|
"""
|
|
Testing order list with parameter `order_by`
|
|
"""
|
|
|
|
# create users
|
|
self.register_user("user_a", "pass", displayname="UserZ")
|
|
userA_tok = self.login("user_a", "pass")
|
|
self._create_media(userA_tok, 1)
|
|
|
|
self.register_user("user_b", "pass", displayname="UserY")
|
|
userB_tok = self.login("user_b", "pass")
|
|
self._create_media(userB_tok, 3)
|
|
|
|
self.register_user("user_c", "pass", displayname="UserX")
|
|
userC_tok = self.login("user_c", "pass")
|
|
self._create_media(userC_tok, 2)
|
|
|
|
# order by user_id
|
|
self._order_test("user_id", ["@user_a:test", "@user_b:test", "@user_c:test"])
|
|
self._order_test(
|
|
"user_id",
|
|
["@user_a:test", "@user_b:test", "@user_c:test"],
|
|
"f",
|
|
)
|
|
self._order_test(
|
|
"user_id",
|
|
["@user_c:test", "@user_b:test", "@user_a:test"],
|
|
"b",
|
|
)
|
|
|
|
# order by displayname
|
|
self._order_test(
|
|
"displayname", ["@user_c:test", "@user_b:test", "@user_a:test"]
|
|
)
|
|
self._order_test(
|
|
"displayname",
|
|
["@user_c:test", "@user_b:test", "@user_a:test"],
|
|
"f",
|
|
)
|
|
self._order_test(
|
|
"displayname",
|
|
["@user_a:test", "@user_b:test", "@user_c:test"],
|
|
"b",
|
|
)
|
|
|
|
# order by media_length
|
|
self._order_test(
|
|
"media_length",
|
|
["@user_a:test", "@user_c:test", "@user_b:test"],
|
|
)
|
|
self._order_test(
|
|
"media_length",
|
|
["@user_a:test", "@user_c:test", "@user_b:test"],
|
|
"f",
|
|
)
|
|
self._order_test(
|
|
"media_length",
|
|
["@user_b:test", "@user_c:test", "@user_a:test"],
|
|
"b",
|
|
)
|
|
|
|
# order by media_count
|
|
self._order_test(
|
|
"media_count",
|
|
["@user_a:test", "@user_c:test", "@user_b:test"],
|
|
)
|
|
self._order_test(
|
|
"media_count",
|
|
["@user_a:test", "@user_c:test", "@user_b:test"],
|
|
"f",
|
|
)
|
|
self._order_test(
|
|
"media_count",
|
|
["@user_b:test", "@user_c:test", "@user_a:test"],
|
|
"b",
|
|
)
|
|
|
|
def test_from_until_ts(self) -> None:
|
|
"""
|
|
Testing filter by time with parameters `from_ts` and `until_ts`
|
|
"""
|
|
# create media earlier than `ts1` to ensure that `from_ts` is working
|
|
self._create_media(self.other_user_tok, 3)
|
|
self.pump(1)
|
|
ts1 = self.clock.time_msec()
|
|
|
|
# list all media when filter is not set
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url,
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(channel.json_body["users"][0]["media_count"], 3)
|
|
|
|
# filter media starting at `ts1` after creating first media
|
|
# result is 0
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?from_ts=%s" % (ts1,),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(channel.json_body["total"], 0)
|
|
|
|
self._create_media(self.other_user_tok, 3)
|
|
self.pump(1)
|
|
ts2 = self.clock.time_msec()
|
|
# create media after `ts2` to ensure that `until_ts` is working
|
|
self._create_media(self.other_user_tok, 3)
|
|
|
|
# filter media between `ts1` and `ts2`
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?from_ts=%s&until_ts=%s" % (ts1, ts2),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(channel.json_body["users"][0]["media_count"], 3)
|
|
|
|
# filter media until `ts2` and earlier
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?until_ts=%s" % (ts2,),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(channel.json_body["users"][0]["media_count"], 6)
|
|
|
|
def test_search_term(self) -> None:
|
|
self._create_users_with_media(20, 1)
|
|
|
|
# check without filter get all users
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url,
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(channel.json_body["total"], 20)
|
|
|
|
# filter user 1 and 10-19 by `user_id`
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?search_term=foo_user_1",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(channel.json_body["total"], 11)
|
|
|
|
# filter on this user in `displayname`
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?search_term=bar_user_10",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(channel.json_body["users"][0]["displayname"], "bar_user_10")
|
|
self.assertEqual(channel.json_body["total"], 1)
|
|
|
|
# filter and get empty result
|
|
channel = self.make_request(
|
|
"GET",
|
|
self.url + "?search_term=foobar",
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(channel.json_body["total"], 0)
|
|
|
|
def _create_users_with_media(self, number_users: int, media_per_user: int) -> None:
|
|
"""
|
|
Create a number of users with a number of media
|
|
Args:
|
|
number_users: Number of users to be created
|
|
media_per_user: Number of media to be created for each user
|
|
"""
|
|
for i in range(number_users):
|
|
self.register_user("foo_user_%s" % i, "pass", displayname="bar_user_%s" % i)
|
|
user_tok = self.login("foo_user_%s" % i, "pass")
|
|
self._create_media(user_tok, media_per_user)
|
|
|
|
def _create_media(self, user_token: str, number_media: int) -> None:
|
|
"""
|
|
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 _ in range(number_media):
|
|
# Upload some media into the room
|
|
self.helper.upload_media(
|
|
upload_resource, SMALL_PNG, tok=user_token, expect_code=200
|
|
)
|
|
|
|
def _check_fields(self, content: List[JsonDict]) -> None:
|
|
"""Checks that all attributes are present in content
|
|
Args:
|
|
content: List that is checked for content
|
|
"""
|
|
for c in content:
|
|
self.assertIn("user_id", c)
|
|
self.assertIn("displayname", c)
|
|
self.assertIn("media_count", c)
|
|
self.assertIn("media_length", c)
|
|
|
|
def _order_test(
|
|
self, order_type: str, expected_user_list: List[str], dir: Optional[str] = None
|
|
) -> None:
|
|
"""Request the list of users in a certain order. Assert that order is what
|
|
we expect
|
|
Args:
|
|
order_type: The type of ordering to give the server
|
|
expected_user_list: The list of user_ids in the order we expect to get
|
|
back from the server
|
|
dir: The direction of ordering to give the server
|
|
"""
|
|
|
|
url = self.url + "?order_by=%s" % (order_type,)
|
|
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_user_list))
|
|
|
|
returned_order = [row["user_id"] for row in channel.json_body["users"]]
|
|
self.assertListEqual(expected_user_list, returned_order)
|
|
self._check_fields(channel.json_body["users"])
|