2016-01-07 04:26:29 +00:00
|
|
|
# Copyright 2015, 2016 OpenMarket Ltd
|
2015-02-04 12:24:20 +00:00
|
|
|
#
|
|
|
|
# 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.
|
2018-07-09 06:09:20 +00:00
|
|
|
import re
|
2023-05-24 12:59:31 +00:00
|
|
|
from typing import Any, Generator
|
2021-04-09 17:44:38 +00:00
|
|
|
from unittest.mock import Mock
|
2015-02-04 12:24:20 +00:00
|
|
|
|
2016-08-17 16:20:50 +00:00
|
|
|
from twisted.internet import defer
|
|
|
|
|
2021-12-14 17:02:46 +00:00
|
|
|
from synapse.appservice import ApplicationService, Namespace
|
2015-02-04 12:24:20 +00:00
|
|
|
|
2018-07-09 06:09:20 +00:00
|
|
|
from tests import unittest
|
2022-02-01 17:45:13 +00:00
|
|
|
from tests.test_utils import simple_async_mock
|
2017-03-28 12:03:50 +00:00
|
|
|
|
2015-02-04 12:24:20 +00:00
|
|
|
|
2021-12-14 17:02:46 +00:00
|
|
|
def _regex(regex: str, exclusive: bool = True) -> Namespace:
|
2022-05-26 13:04:34 +00:00
|
|
|
return Namespace(exclusive, re.compile(regex))
|
2015-02-27 11:10:48 +00:00
|
|
|
|
|
|
|
|
2015-02-04 12:24:20 +00:00
|
|
|
class ApplicationServiceTestCase(unittest.TestCase):
|
2023-02-06 12:49:06 +00:00
|
|
|
def setUp(self) -> None:
|
2015-02-04 12:24:20 +00:00
|
|
|
self.service = ApplicationService(
|
2016-01-14 14:34:01 +00:00
|
|
|
id="unique_identifier",
|
2020-10-29 15:58:44 +00:00
|
|
|
sender="@as:test",
|
2015-02-04 12:24:20 +00:00
|
|
|
url="some_url",
|
|
|
|
token="some_token",
|
|
|
|
)
|
|
|
|
self.event = Mock(
|
2022-03-03 18:14:09 +00:00
|
|
|
event_id="$abc:xyz",
|
|
|
|
type="m.something",
|
|
|
|
room_id="!foo:bar",
|
|
|
|
sender="@someone:somewhere",
|
2015-02-04 12:24:20 +00:00
|
|
|
)
|
|
|
|
|
2016-08-17 16:20:50 +00:00
|
|
|
self.store = Mock()
|
2022-02-07 18:26:42 +00:00
|
|
|
self.store.get_aliases_for_room = simple_async_mock([])
|
2022-10-27 18:29:23 +00:00
|
|
|
self.store.get_local_users_in_room = simple_async_mock([])
|
2016-08-17 16:20:50 +00:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
2023-02-06 12:49:06 +00:00
|
|
|
def test_regex_user_id_prefix_match(
|
|
|
|
self,
|
2023-05-24 12:59:31 +00:00
|
|
|
) -> Generator["defer.Deferred[Any]", object, None]:
|
2018-08-10 13:54:09 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_USERS].append(_regex("@irc_.*"))
|
2015-02-04 12:24:20 +00:00
|
|
|
self.event.sender = "@irc_foobar:matrix.org"
|
2020-07-30 11:27:39 +00:00
|
|
|
self.assertTrue(
|
2022-02-07 18:26:42 +00:00
|
|
|
(
|
2023-05-24 12:59:31 +00:00
|
|
|
yield self.service.is_interested_in_event(
|
|
|
|
self.event.event_id, self.event, self.store
|
2022-02-07 18:26:42 +00:00
|
|
|
)
|
|
|
|
)
|
2020-07-30 11:27:39 +00:00
|
|
|
)
|
2015-02-04 12:24:20 +00:00
|
|
|
|
2016-08-17 16:20:50 +00:00
|
|
|
@defer.inlineCallbacks
|
2023-02-06 12:49:06 +00:00
|
|
|
def test_regex_user_id_prefix_no_match(
|
|
|
|
self,
|
2023-05-24 12:59:31 +00:00
|
|
|
) -> Generator["defer.Deferred[Any]", object, None]:
|
2018-08-10 13:54:09 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_USERS].append(_regex("@irc_.*"))
|
2015-02-04 12:24:20 +00:00
|
|
|
self.event.sender = "@someone_else:matrix.org"
|
2020-07-30 11:27:39 +00:00
|
|
|
self.assertFalse(
|
2022-02-07 18:26:42 +00:00
|
|
|
(
|
2023-05-24 12:59:31 +00:00
|
|
|
yield self.service.is_interested_in_event(
|
|
|
|
self.event.event_id, self.event, self.store
|
2022-02-07 18:26:42 +00:00
|
|
|
)
|
|
|
|
)
|
2020-07-30 11:27:39 +00:00
|
|
|
)
|
2015-02-04 12:24:20 +00:00
|
|
|
|
2016-08-17 16:20:50 +00:00
|
|
|
@defer.inlineCallbacks
|
2023-02-06 12:49:06 +00:00
|
|
|
def test_regex_room_member_is_checked(
|
|
|
|
self,
|
2023-05-24 12:59:31 +00:00
|
|
|
) -> Generator["defer.Deferred[Any]", object, None]:
|
2018-08-10 13:54:09 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_USERS].append(_regex("@irc_.*"))
|
2015-02-04 12:24:20 +00:00
|
|
|
self.event.sender = "@someone_else:matrix.org"
|
|
|
|
self.event.type = "m.room.member"
|
|
|
|
self.event.state_key = "@irc_foobar:matrix.org"
|
2020-07-30 11:27:39 +00:00
|
|
|
self.assertTrue(
|
2022-02-07 18:26:42 +00:00
|
|
|
(
|
2023-05-24 12:59:31 +00:00
|
|
|
yield self.service.is_interested_in_event(
|
|
|
|
self.event.event_id, self.event, self.store
|
2022-02-07 18:26:42 +00:00
|
|
|
)
|
|
|
|
)
|
2020-07-30 11:27:39 +00:00
|
|
|
)
|
2015-02-04 15:21:03 +00:00
|
|
|
|
2016-08-17 16:20:50 +00:00
|
|
|
@defer.inlineCallbacks
|
2023-02-06 12:49:06 +00:00
|
|
|
def test_regex_room_id_match(
|
|
|
|
self,
|
2023-05-24 12:59:31 +00:00
|
|
|
) -> Generator["defer.Deferred[Any]", object, None]:
|
2015-02-04 15:21:03 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_ROOMS].append(
|
2015-02-27 11:10:48 +00:00
|
|
|
_regex("!some_prefix.*some_suffix:matrix.org")
|
2015-02-04 15:21:03 +00:00
|
|
|
)
|
|
|
|
self.event.room_id = "!some_prefixs0m3th1nGsome_suffix:matrix.org"
|
2020-07-30 11:27:39 +00:00
|
|
|
self.assertTrue(
|
2022-02-07 18:26:42 +00:00
|
|
|
(
|
2023-05-24 12:59:31 +00:00
|
|
|
yield self.service.is_interested_in_event(
|
|
|
|
self.event.event_id, self.event, self.store
|
2022-02-07 18:26:42 +00:00
|
|
|
)
|
|
|
|
)
|
2020-07-30 11:27:39 +00:00
|
|
|
)
|
2015-02-04 15:21:03 +00:00
|
|
|
|
2016-08-17 16:20:50 +00:00
|
|
|
@defer.inlineCallbacks
|
2023-02-06 12:49:06 +00:00
|
|
|
def test_regex_room_id_no_match(
|
|
|
|
self,
|
2023-05-24 12:59:31 +00:00
|
|
|
) -> Generator["defer.Deferred[Any]", object, None]:
|
2015-02-04 15:21:03 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_ROOMS].append(
|
2015-02-27 11:10:48 +00:00
|
|
|
_regex("!some_prefix.*some_suffix:matrix.org")
|
2015-02-04 15:21:03 +00:00
|
|
|
)
|
|
|
|
self.event.room_id = "!XqBunHwQIXUiqCaoxq:matrix.org"
|
2020-07-30 11:27:39 +00:00
|
|
|
self.assertFalse(
|
2022-02-07 18:26:42 +00:00
|
|
|
(
|
2023-05-24 12:59:31 +00:00
|
|
|
yield self.service.is_interested_in_event(
|
|
|
|
self.event.event_id, self.event, self.store
|
2022-02-07 18:26:42 +00:00
|
|
|
)
|
|
|
|
)
|
2020-07-30 11:27:39 +00:00
|
|
|
)
|
2015-02-04 15:21:03 +00:00
|
|
|
|
2016-08-17 16:20:50 +00:00
|
|
|
@defer.inlineCallbacks
|
2023-05-24 12:59:31 +00:00
|
|
|
def test_regex_alias_match(self) -> Generator["defer.Deferred[Any]", object, None]:
|
2015-02-04 15:21:03 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_ALIASES].append(
|
2015-02-27 11:10:48 +00:00
|
|
|
_regex("#irc_.*:matrix.org")
|
2015-02-04 15:21:03 +00:00
|
|
|
)
|
2022-02-01 17:45:13 +00:00
|
|
|
self.store.get_aliases_for_room = simple_async_mock(
|
2020-07-30 11:27:39 +00:00
|
|
|
["#irc_foobar:matrix.org", "#athing:matrix.org"]
|
|
|
|
)
|
2022-10-27 18:29:23 +00:00
|
|
|
self.store.get_local_users_in_room = simple_async_mock([])
|
2020-07-30 11:27:39 +00:00
|
|
|
self.assertTrue(
|
|
|
|
(
|
2023-05-24 12:59:31 +00:00
|
|
|
yield self.service.is_interested_in_event(
|
|
|
|
self.event.event_id, self.event, self.store
|
2020-07-30 11:27:39 +00:00
|
|
|
)
|
|
|
|
)
|
|
|
|
)
|
2015-02-04 15:21:03 +00:00
|
|
|
|
2023-02-06 12:49:06 +00:00
|
|
|
def test_non_exclusive_alias(self) -> None:
|
2015-02-27 11:51:06 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_ALIASES].append(
|
|
|
|
_regex("#irc_.*:matrix.org", exclusive=False)
|
|
|
|
)
|
2018-08-10 13:54:09 +00:00
|
|
|
self.assertFalse(self.service.is_exclusive_alias("#irc_foobar:matrix.org"))
|
2015-02-27 11:51:06 +00:00
|
|
|
|
2023-02-06 12:49:06 +00:00
|
|
|
def test_non_exclusive_room(self) -> None:
|
2015-02-27 11:51:06 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_ROOMS].append(
|
|
|
|
_regex("!irc_.*:matrix.org", exclusive=False)
|
|
|
|
)
|
2018-08-10 13:54:09 +00:00
|
|
|
self.assertFalse(self.service.is_exclusive_room("!irc_foobar:matrix.org"))
|
2015-02-27 11:51:06 +00:00
|
|
|
|
2023-02-06 12:49:06 +00:00
|
|
|
def test_non_exclusive_user(self) -> None:
|
2015-02-27 11:51:06 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_USERS].append(
|
|
|
|
_regex("@irc_.*:matrix.org", exclusive=False)
|
|
|
|
)
|
2018-08-10 13:54:09 +00:00
|
|
|
self.assertFalse(self.service.is_exclusive_user("@irc_foobar:matrix.org"))
|
2015-02-27 11:51:06 +00:00
|
|
|
|
2023-02-06 12:49:06 +00:00
|
|
|
def test_exclusive_alias(self) -> None:
|
2015-02-27 11:51:06 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_ALIASES].append(
|
|
|
|
_regex("#irc_.*:matrix.org", exclusive=True)
|
|
|
|
)
|
2018-08-10 13:54:09 +00:00
|
|
|
self.assertTrue(self.service.is_exclusive_alias("#irc_foobar:matrix.org"))
|
2015-02-27 11:51:06 +00:00
|
|
|
|
2023-02-06 12:49:06 +00:00
|
|
|
def test_exclusive_user(self) -> None:
|
2015-02-27 11:51:06 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_USERS].append(
|
|
|
|
_regex("@irc_.*:matrix.org", exclusive=True)
|
|
|
|
)
|
2018-08-10 13:54:09 +00:00
|
|
|
self.assertTrue(self.service.is_exclusive_user("@irc_foobar:matrix.org"))
|
2015-02-27 11:51:06 +00:00
|
|
|
|
2023-02-06 12:49:06 +00:00
|
|
|
def test_exclusive_room(self) -> None:
|
2015-02-27 11:51:06 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_ROOMS].append(
|
|
|
|
_regex("!irc_.*:matrix.org", exclusive=True)
|
|
|
|
)
|
2018-08-10 13:54:09 +00:00
|
|
|
self.assertTrue(self.service.is_exclusive_room("!irc_foobar:matrix.org"))
|
2015-02-27 11:51:06 +00:00
|
|
|
|
2016-08-17 16:20:50 +00:00
|
|
|
@defer.inlineCallbacks
|
2023-02-06 12:49:06 +00:00
|
|
|
def test_regex_alias_no_match(
|
|
|
|
self,
|
2023-05-24 12:59:31 +00:00
|
|
|
) -> Generator["defer.Deferred[Any]", object, None]:
|
2015-02-04 15:21:03 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_ALIASES].append(
|
2015-02-27 11:10:48 +00:00
|
|
|
_regex("#irc_.*:matrix.org")
|
2015-02-04 15:21:03 +00:00
|
|
|
)
|
2022-02-01 17:45:13 +00:00
|
|
|
self.store.get_aliases_for_room = simple_async_mock(
|
2020-07-30 11:27:39 +00:00
|
|
|
["#xmpp_foobar:matrix.org", "#athing:matrix.org"]
|
|
|
|
)
|
2022-10-27 18:29:23 +00:00
|
|
|
self.store.get_local_users_in_room = simple_async_mock([])
|
2020-07-30 11:27:39 +00:00
|
|
|
self.assertFalse(
|
|
|
|
(
|
|
|
|
yield defer.ensureDeferred(
|
2022-03-03 18:14:09 +00:00
|
|
|
self.service.is_interested_in_event(
|
|
|
|
self.event.event_id, self.event, self.store
|
|
|
|
)
|
2020-07-30 11:27:39 +00:00
|
|
|
)
|
|
|
|
)
|
|
|
|
)
|
2015-02-04 15:21:03 +00:00
|
|
|
|
2016-08-17 16:20:50 +00:00
|
|
|
@defer.inlineCallbacks
|
2023-02-06 12:49:06 +00:00
|
|
|
def test_regex_multiple_matches(
|
|
|
|
self,
|
2023-05-24 12:59:31 +00:00
|
|
|
) -> Generator["defer.Deferred[Any]", object, None]:
|
2015-02-04 15:21:03 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_ALIASES].append(
|
2015-02-27 11:10:48 +00:00
|
|
|
_regex("#irc_.*:matrix.org")
|
2015-02-04 15:21:03 +00:00
|
|
|
)
|
2018-08-10 13:54:09 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_USERS].append(_regex("@irc_.*"))
|
2015-02-04 15:21:03 +00:00
|
|
|
self.event.sender = "@irc_foobar:matrix.org"
|
2022-02-01 17:45:13 +00:00
|
|
|
self.store.get_aliases_for_room = simple_async_mock(["#irc_barfoo:matrix.org"])
|
2022-10-27 18:29:23 +00:00
|
|
|
self.store.get_local_users_in_room = simple_async_mock([])
|
2020-07-30 11:27:39 +00:00
|
|
|
self.assertTrue(
|
|
|
|
(
|
2023-05-24 12:59:31 +00:00
|
|
|
yield self.service.is_interested_in_event(
|
|
|
|
self.event.event_id, self.event, self.store
|
2020-07-30 11:27:39 +00:00
|
|
|
)
|
|
|
|
)
|
|
|
|
)
|
2015-02-11 10:36:08 +00:00
|
|
|
|
2016-08-17 16:20:50 +00:00
|
|
|
@defer.inlineCallbacks
|
2023-05-24 12:59:31 +00:00
|
|
|
def test_interested_in_self(self) -> Generator["defer.Deferred[Any]", object, None]:
|
2015-03-31 15:43:49 +00:00
|
|
|
# make sure invites get through
|
|
|
|
self.service.sender = "@appservice:name"
|
2018-08-10 13:54:09 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_USERS].append(_regex("@irc_.*"))
|
2015-03-31 15:43:49 +00:00
|
|
|
self.event.type = "m.room.member"
|
2018-08-10 13:54:09 +00:00
|
|
|
self.event.content = {"membership": "invite"}
|
2015-03-31 15:43:49 +00:00
|
|
|
self.event.state_key = self.service.sender
|
2020-07-30 11:27:39 +00:00
|
|
|
self.assertTrue(
|
2022-02-07 18:26:42 +00:00
|
|
|
(
|
2023-05-24 12:59:31 +00:00
|
|
|
yield self.service.is_interested_in_event(
|
|
|
|
self.event.event_id, self.event, self.store
|
2022-02-07 18:26:42 +00:00
|
|
|
)
|
|
|
|
)
|
2020-07-30 11:27:39 +00:00
|
|
|
)
|
2015-03-31 15:43:49 +00:00
|
|
|
|
2016-08-17 16:20:50 +00:00
|
|
|
@defer.inlineCallbacks
|
2023-05-24 12:59:31 +00:00
|
|
|
def test_member_list_match(self) -> Generator["defer.Deferred[Any]", object, None]:
|
2018-08-10 13:54:09 +00:00
|
|
|
self.service.namespaces[ApplicationService.NS_USERS].append(_regex("@irc_.*"))
|
2020-07-30 11:27:39 +00:00
|
|
|
# Note that @irc_fo:here is the AS user.
|
2022-10-27 18:29:23 +00:00
|
|
|
self.store.get_local_users_in_room = simple_async_mock(
|
2020-07-30 11:27:39 +00:00
|
|
|
["@alice:here", "@irc_fo:here", "@bob:here"]
|
|
|
|
)
|
2022-02-01 17:45:13 +00:00
|
|
|
self.store.get_aliases_for_room = simple_async_mock([])
|
2015-02-11 10:36:08 +00:00
|
|
|
|
|
|
|
self.event.sender = "@xmpp_foobar:matrix.org"
|
2018-08-10 13:54:09 +00:00
|
|
|
self.assertTrue(
|
2020-07-30 11:27:39 +00:00
|
|
|
(
|
2023-05-24 12:59:31 +00:00
|
|
|
yield self.service.is_interested_in_event(
|
|
|
|
self.event.event_id, self.event, self.store
|
2020-07-30 11:27:39 +00:00
|
|
|
)
|
|
|
|
)
|
2018-08-10 13:54:09 +00:00
|
|
|
)
|