synapse/tests/appservice/test_appservice.py

212 lines
7.8 KiB
Python
Raw Normal View History

2016-01-07 05:26:29 +01:00
# Copyright 2015, 2016 OpenMarket Ltd
#
# 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 08:09:20 +02:00
import re
2021-04-09 19:44:38 +02:00
from unittest.mock import Mock
2016-08-17 18:20:50 +02:00
from twisted.internet import defer
2018-07-09 08:09:20 +02:00
from synapse.appservice import ApplicationService
2018-07-09 08:09:20 +02:00
from tests import unittest
2017-03-28 14:03:50 +02:00
2015-02-27 12:10:48 +01:00
def _regex(regex, exclusive=True):
2018-08-10 15:54:09 +02:00
return {"regex": re.compile(regex), "exclusive": exclusive}
2015-02-27 12:10:48 +01:00
class ApplicationServiceTestCase(unittest.TestCase):
def setUp(self):
self.service = ApplicationService(
id="unique_identifier",
sender="@as:test",
url="some_url",
token="some_token",
2017-11-16 19:22:40 +01:00
hostname="matrix.org", # only used by get_groups_for_user
namespaces={
ApplicationService.NS_USERS: [],
ApplicationService.NS_ROOMS: [],
2018-08-10 15:54:09 +02:00
ApplicationService.NS_ALIASES: [],
},
)
self.event = Mock(
type="m.something", room_id="!foo:bar", sender="@someone:somewhere"
)
2016-08-17 18:20:50 +02:00
self.store = Mock()
@defer.inlineCallbacks
def test_regex_user_id_prefix_match(self):
2018-08-10 15:54:09 +02:00
self.service.namespaces[ApplicationService.NS_USERS].append(_regex("@irc_.*"))
self.event.sender = "@irc_foobar:matrix.org"
2020-07-30 13:27:39 +02:00
self.assertTrue(
(yield defer.ensureDeferred(self.service.is_interested(self.event)))
)
2016-08-17 18:20:50 +02:00
@defer.inlineCallbacks
def test_regex_user_id_prefix_no_match(self):
2018-08-10 15:54:09 +02:00
self.service.namespaces[ApplicationService.NS_USERS].append(_regex("@irc_.*"))
self.event.sender = "@someone_else:matrix.org"
2020-07-30 13:27:39 +02:00
self.assertFalse(
(yield defer.ensureDeferred(self.service.is_interested(self.event)))
)
2016-08-17 18:20:50 +02:00
@defer.inlineCallbacks
def test_regex_room_member_is_checked(self):
2018-08-10 15:54:09 +02:00
self.service.namespaces[ApplicationService.NS_USERS].append(_regex("@irc_.*"))
self.event.sender = "@someone_else:matrix.org"
self.event.type = "m.room.member"
self.event.state_key = "@irc_foobar:matrix.org"
2020-07-30 13:27:39 +02:00
self.assertTrue(
(yield defer.ensureDeferred(self.service.is_interested(self.event)))
)
2016-08-17 18:20:50 +02:00
@defer.inlineCallbacks
def test_regex_room_id_match(self):
self.service.namespaces[ApplicationService.NS_ROOMS].append(
2015-02-27 12:10:48 +01:00
_regex("!some_prefix.*some_suffix:matrix.org")
)
self.event.room_id = "!some_prefixs0m3th1nGsome_suffix:matrix.org"
2020-07-30 13:27:39 +02:00
self.assertTrue(
(yield defer.ensureDeferred(self.service.is_interested(self.event)))
)
2016-08-17 18:20:50 +02:00
@defer.inlineCallbacks
def test_regex_room_id_no_match(self):
self.service.namespaces[ApplicationService.NS_ROOMS].append(
2015-02-27 12:10:48 +01:00
_regex("!some_prefix.*some_suffix:matrix.org")
)
self.event.room_id = "!XqBunHwQIXUiqCaoxq:matrix.org"
2020-07-30 13:27:39 +02:00
self.assertFalse(
(yield defer.ensureDeferred(self.service.is_interested(self.event)))
)
2016-08-17 18:20:50 +02:00
@defer.inlineCallbacks
def test_regex_alias_match(self):
self.service.namespaces[ApplicationService.NS_ALIASES].append(
2015-02-27 12:10:48 +01:00
_regex("#irc_.*:matrix.org")
)
2020-07-30 13:27:39 +02:00
self.store.get_aliases_for_room.return_value = defer.succeed(
["#irc_foobar:matrix.org", "#athing:matrix.org"]
)
self.store.get_users_in_room.return_value = defer.succeed([])
self.assertTrue(
(
yield defer.ensureDeferred(
self.service.is_interested(self.event, self.store)
)
)
)
def test_non_exclusive_alias(self):
self.service.namespaces[ApplicationService.NS_ALIASES].append(
_regex("#irc_.*:matrix.org", exclusive=False)
)
2018-08-10 15:54:09 +02:00
self.assertFalse(self.service.is_exclusive_alias("#irc_foobar:matrix.org"))
def test_non_exclusive_room(self):
self.service.namespaces[ApplicationService.NS_ROOMS].append(
_regex("!irc_.*:matrix.org", exclusive=False)
)
2018-08-10 15:54:09 +02:00
self.assertFalse(self.service.is_exclusive_room("!irc_foobar:matrix.org"))
def test_non_exclusive_user(self):
self.service.namespaces[ApplicationService.NS_USERS].append(
_regex("@irc_.*:matrix.org", exclusive=False)
)
2018-08-10 15:54:09 +02:00
self.assertFalse(self.service.is_exclusive_user("@irc_foobar:matrix.org"))
def test_exclusive_alias(self):
self.service.namespaces[ApplicationService.NS_ALIASES].append(
_regex("#irc_.*:matrix.org", exclusive=True)
)
2018-08-10 15:54:09 +02:00
self.assertTrue(self.service.is_exclusive_alias("#irc_foobar:matrix.org"))
def test_exclusive_user(self):
self.service.namespaces[ApplicationService.NS_USERS].append(
_regex("@irc_.*:matrix.org", exclusive=True)
)
2018-08-10 15:54:09 +02:00
self.assertTrue(self.service.is_exclusive_user("@irc_foobar:matrix.org"))
def test_exclusive_room(self):
self.service.namespaces[ApplicationService.NS_ROOMS].append(
_regex("!irc_.*:matrix.org", exclusive=True)
)
2018-08-10 15:54:09 +02:00
self.assertTrue(self.service.is_exclusive_room("!irc_foobar:matrix.org"))
2016-08-17 18:20:50 +02:00
@defer.inlineCallbacks
def test_regex_alias_no_match(self):
self.service.namespaces[ApplicationService.NS_ALIASES].append(
2015-02-27 12:10:48 +01:00
_regex("#irc_.*:matrix.org")
)
2020-07-30 13:27:39 +02:00
self.store.get_aliases_for_room.return_value = defer.succeed(
["#xmpp_foobar:matrix.org", "#athing:matrix.org"]
)
self.store.get_users_in_room.return_value = defer.succeed([])
self.assertFalse(
(
yield defer.ensureDeferred(
self.service.is_interested(self.event, self.store)
)
)
)
2016-08-17 18:20:50 +02:00
@defer.inlineCallbacks
def test_regex_multiple_matches(self):
self.service.namespaces[ApplicationService.NS_ALIASES].append(
2015-02-27 12:10:48 +01:00
_regex("#irc_.*:matrix.org")
)
2018-08-10 15:54:09 +02:00
self.service.namespaces[ApplicationService.NS_USERS].append(_regex("@irc_.*"))
self.event.sender = "@irc_foobar:matrix.org"
2020-07-30 13:27:39 +02:00
self.store.get_aliases_for_room.return_value = defer.succeed(
["#irc_barfoo:matrix.org"]
)
self.store.get_users_in_room.return_value = defer.succeed([])
self.assertTrue(
(
yield defer.ensureDeferred(
self.service.is_interested(self.event, self.store)
)
)
)
2016-08-17 18:20:50 +02:00
@defer.inlineCallbacks
def test_interested_in_self(self):
# make sure invites get through
self.service.sender = "@appservice:name"
2018-08-10 15:54:09 +02:00
self.service.namespaces[ApplicationService.NS_USERS].append(_regex("@irc_.*"))
self.event.type = "m.room.member"
2018-08-10 15:54:09 +02:00
self.event.content = {"membership": "invite"}
self.event.state_key = self.service.sender
2020-07-30 13:27:39 +02:00
self.assertTrue(
(yield defer.ensureDeferred(self.service.is_interested(self.event)))
)
2016-08-17 18:20:50 +02:00
@defer.inlineCallbacks
def test_member_list_match(self):
2018-08-10 15:54:09 +02:00
self.service.namespaces[ApplicationService.NS_USERS].append(_regex("@irc_.*"))
2020-07-30 13:27:39 +02:00
# Note that @irc_fo:here is the AS user.
self.store.get_users_in_room.return_value = defer.succeed(
["@alice:here", "@irc_fo:here", "@bob:here"]
)
self.store.get_aliases_for_room.return_value = defer.succeed([])
self.event.sender = "@xmpp_foobar:matrix.org"
2018-08-10 15:54:09 +02:00
self.assertTrue(
2020-07-30 13:27:39 +02:00
(
yield defer.ensureDeferred(
self.service.is_interested(event=self.event, store=self.store)
)
)
2018-08-10 15:54:09 +02:00
)