bridgy-fed/tests/test_protocol.py

"""Unit tests for protocol.py."""
from unittest.mock import patch

from flask import g
from oauth_dropins.webutil.testutil import requests_response
import requests

# import first so that Fake is defined before URL routes are registered
from .testutil import Fake, TestCase

from activitypub import ActivityPub
from app import app
from models import Follower, Object, PROTOCOLS, User
from protocol import Protocol
from web import Web

from .test_activitypub import ACTOR, REPLY

REPLY = {
    **REPLY,
    'actor': ACTOR,
    'object': {
        **REPLY['object'],
        'author': ACTOR,
    },
}


class ProtocolTest(TestCase):

    def setUp(self):
        super().setUp()
        self.user = self.make_user('foo.com', has_hcard=True)
        self.request_context.push()
        g.user = None

    def tearDown(self):
        self.request_context.pop()
        super().tearDown()

    def test_protocols_global(self):
        self.assertEqual(Fake, PROTOCOLS['fake'])
        self.assertEqual(Web, PROTOCOLS['web'])
        self.assertEqual(Web, PROTOCOLS['webmention'])

    def test_for_domain_for_request(self):
        for domain, protocol in [
                ('fake.brid.gy', Fake),
                ('ap.brid.gy', ActivityPub),
                ('activitypub.brid.gy', ActivityPub),
                ('web.brid.gy', Web),
                ('fed.brid.gy', Web),
                (None, None),
                ('', None),
                ('brid.gy', None),
                ('www.brid.gy', None),
                ('fake.fed.brid.gy', None),
                ('fake', None),
                ('fake.com', None),
        ]:
            self.assertEqual(protocol, Protocol.for_domain(domain))
            with app.test_request_context('/foo', base_url=f'https://{domain}/'):
                self.assertEqual(protocol, Protocol.for_request())

    @patch('requests.get')
    def test_receive_reply_not_feed_not_notification(self, mock_get):
        Follower.get_or_create(to=Fake.get_or_create(id=ACTOR['id']),
                               from_=Fake.get_or_create(id='foo.com'))
        other_user = self.make_user('user.com', cls=Web)

        # user.com webmention discovery
        mock_get.return_value = requests_response('<html></html>')

        Fake.receive(REPLY['id'], as2=REPLY)

        self.assert_object(REPLY['id'],
                           as2=REPLY,
                           type='post',
                           users=[other_user.key],
                           # not feed since it's a reply
                           # not notification since it doesn't involve the user
                           labels=['activity'],
                           status='complete',
                           source_protocol='fake',
                           )
        self.assert_object(REPLY['object']['id'],
                           as2=REPLY['object'],
                           type='comment',
                           source_protocol='fake',
                           )

    def test_load(self):
        Fake.objects['foo'] = {'x': 'y'}

        loaded = Fake.load('foo')
        self.assert_equals({'x': 'y'}, loaded.our_as1)
        self.assertFalse(loaded.changed)
        self.assertTrue(loaded.new)

        self.assertIsNotNone(Object.get_by_id('foo'))
        self.assertEqual(['foo'], Fake.fetched)

    def test_load_existing(self):
        stored = Object(id='foo', our_as1={'x': 'y'})
        stored.put()

        loaded = Fake.load('foo')
        self.assert_equals({'x': 'y'}, loaded.our_as1)
        self.assertFalse(loaded.changed)
        self.assertFalse(loaded.new)

        self.assertEqual([], Fake.fetched)

    def test_load_existing_empty_deleted(self):
        stored = Object(id='foo', deleted=True)
        stored.put()

        loaded = Fake.load('foo')
        self.assert_entities_equal(stored, loaded)
        self.assertFalse(loaded.changed)
        self.assertFalse(loaded.new)

        self.assertEqual([], Fake.fetched)

    def test_load_refresh_existing_empty(self):
        Fake.objects['foo'] = {'x': 'y'}
        Object(id='foo').put()

        loaded = Fake.load('foo', refresh=True)
        self.assertEqual({'x': 'y'}, loaded.as1)
        self.assertTrue(loaded.changed)
        self.assertFalse(loaded.new)
        self.assertEqual(['foo'], Fake.fetched)

    def test_load_refresh_new_empty(self):
        Fake.objects['foo'] = None
        Object(id='foo', our_as1={'x': 'y'}).put()

        loaded = Fake.load('foo', refresh=True)
        self.assertIsNone(loaded.as1)
        self.assertTrue(loaded.changed)
        self.assertFalse(loaded.new)
        self.assertEqual(['foo'], Fake.fetched)

    def test_load_refresh_unchanged(self):
        obj = Object(id='foo', our_as1={'x': 'stored'})
        obj.put()
        Fake.objects['foo'] = {'x': 'stored'}

        loaded = Fake.load('foo', refresh=True)
        self.assert_entities_equal(obj, loaded)
        self.assertFalse(obj.changed)
        self.assertFalse(obj.new)
        self.assertEqual(['foo'], Fake.fetched)

    def test_load_refresh_changed(self):
        Object(id='foo', our_as1={'content': 'stored'}).put()
        Fake.objects['foo'] = {'content': 'new'}

        loaded = Fake.load('foo', refresh=True)
        self.assert_equals({'content': 'new'}, loaded.our_as1)
        self.assertTrue(loaded.changed)
        self.assertFalse(loaded.new)
        self.assertEqual(['foo'], Fake.fetched)
don't deliver replies to followers also start new test_protocol file. fixes #444. 2023-03-14 00:25:10 +00:00			`"""Unit tests for protocol.py."""`
			`from unittest.mock import patch`

move current user into Flask g request-global 2023-03-20 21:28:14 +00:00			`from flask import g`
don't deliver replies to followers also start new test_protocol file. fixes #444. 2023-03-14 00:25:10 +00:00			`from oauth_dropins.webutil.testutil import requests_response`
			`import requests`

AP users: start parameterizing URLs, including UI pages and AP endpoints user pages now have /[protocol]/ prefix, AP endpoints have /ap/ prefix. for #512 2023-05-30 23:36:18 +00:00			`# import first so that Fake is defined before URL routes are registered`
			`from .testutil import Fake, TestCase`

AP users: add Protocol.for_domain and for_request getting ready to serve per-protocol subdomains, eg nostr.brid.gy, ap.brid.gy, etc for #512 2023-06-11 02:50:31 +00:00			`from activitypub import ActivityPub`
			`from app import app`
start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`from models import Follower, Object, PROTOCOLS, User`
AP users: add Protocol.for_domain and for_request getting ready to serve per-protocol subdomains, eg nostr.brid.gy, ap.brid.gy, etc for #512 2023-06-11 02:50:31 +00:00			`from protocol import Protocol`
rename Webmention class => Web, webmention.py => web.py 2023-05-27 00:40:29 +00:00			`from web import Web`
don't deliver replies to followers also start new test_protocol file. fixes #444. 2023-03-14 00:25:10 +00:00
			`from .test_activitypub import ACTOR, REPLY`

don't add notification label unless an activity involves the user for #442 (ish) 2023-03-14 03:38:17 +00:00			`REPLY = {`
			`**REPLY,`
			`'actor': ACTOR,`
			`'object': {`
			`**REPLY['object'],`
			`'author': ACTOR,`
			`},`
			`}`

don't deliver replies to followers also start new test_protocol file. fixes #444. 2023-03-14 00:25:10 +00:00
start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`class ProtocolTest(TestCase):`
don't deliver replies to followers also start new test_protocol file. fixes #444. 2023-03-14 00:25:10 +00:00
			`def setUp(self):`
			`super().setUp()`
			`self.user = self.make_user('foo.com', has_hcard=True)`
AP users: serve AS2 for external homepage URLs #512 2023-05-23 06:09:36 +00:00			`self.request_context.push()`
move current user into Flask g request-global 2023-03-20 21:28:14 +00:00			`g.user = None`
don't deliver replies to followers also start new test_protocol file. fixes #444. 2023-03-14 00:25:10 +00:00
			`def tearDown(self):`
AP users: serve AS2 for external homepage URLs #512 2023-05-23 06:09:36 +00:00			`self.request_context.pop()`
don't deliver replies to followers also start new test_protocol file. fixes #444. 2023-03-14 00:25:10 +00:00			`super().tearDown()`

add Protocol metaclass and protocol.protocols global for storing subclasses 2023-05-23 22:15:28 +00:00			`def test_protocols_global(self):`
start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`self.assertEqual(Fake, PROTOCOLS['fake'])`
rename Web.LABEL from 'webmention' to 'web' 2023-05-30 19:15:36 +00:00			`self.assertEqual(Web, PROTOCOLS['web'])`
rename Webmention class => Web, webmention.py => web.py 2023-05-27 00:40:29 +00:00			`self.assertEqual(Web, PROTOCOLS['webmention'])`
add Protocol metaclass and protocol.protocols global for storing subclasses 2023-05-23 22:15:28 +00:00
noop test_protocol for_domain/for_request refactoring 2023-06-12 21:17:44 +00:00			`def test_for_domain_for_request(self):`
			`for domain, protocol in [`
			`('fake.brid.gy', Fake),`
			`('ap.brid.gy', ActivityPub),`
			`('activitypub.brid.gy', ActivityPub),`
			`('web.brid.gy', Web),`
			`('fed.brid.gy', Web),`
			`(None, None),`
			`('', None),`
			`('brid.gy', None),`
			`('www.brid.gy', None),`
			`('fake.fed.brid.gy', None),`
			`('fake', None),`
			`('fake.com', None),`
			`]:`
			`self.assertEqual(protocol, Protocol.for_domain(domain))`
			`with app.test_request_context('/foo', base_url=f'https://{domain}/'):`
			`self.assertEqual(protocol, Protocol.for_request())`
AP users: add Protocol.for_domain and for_request getting ready to serve per-protocol subdomains, eg nostr.brid.gy, ap.brid.gy, etc for #512 2023-06-11 02:50:31 +00:00
don't deliver replies to followers also start new test_protocol file. fixes #444. 2023-03-14 00:25:10 +00:00			`@patch('requests.get')`
don't add notification label unless an activity involves the user for #442 (ish) 2023-03-14 03:38:17 +00:00			`def test_receive_reply_not_feed_not_notification(self, mock_get):`
AP users: start migrating Follower from string domains/ids to User keys for #512 2023-06-06 21:50:20 +00:00			`Follower.get_or_create(to=Fake.get_or_create(id=ACTOR['id']),`
			`from_=Fake.get_or_create(id='foo.com'))`
AP users: Object schema change, domains => users also for AP => wm, only try to send webmentions to domains that we already have an existing Web user for. the vast majority of targets are fediverse URLs, and we were trying to send them all wms, ie at least running wm discovery and finding nothing. harmless, but a waste. 2023-06-09 19:56:45 +00:00			`other_user = self.make_user('user.com', cls=Web)`
don't deliver replies to followers also start new test_protocol file. fixes #444. 2023-03-14 00:25:10 +00:00
tests: rename remaining test data hostnames to clarify web vs fediverse followup to f6e57276024b032b3b6ca981b64ac42e427fce12 2023-03-19 22:43:55 +00:00			`# user.com webmention discovery`
don't deliver replies to followers also start new test_protocol file. fixes #444. 2023-03-14 00:25:10 +00:00			`mock_get.return_value = requests_response('<html></html>')`

AP users: add Protocol.ABBREV, Protocol.OTHER_LABELS for #512 2023-06-11 15:14:17 +00:00			`Fake.receive(REPLY['id'], as2=REPLY)`
don't add notification label unless an activity involves the user for #442 (ish) 2023-03-14 03:38:17 +00:00
			`self.assert_object(REPLY['id'],`
			`as2=REPLY,`
don't deliver replies to followers also start new test_protocol file. fixes #444. 2023-03-14 00:25:10 +00:00			`type='post',`
AP users: Object schema change, domains => users also for AP => wm, only try to send webmentions to domains that we already have an existing Web user for. the vast majority of targets are fediverse URLs, and we were trying to send them all wms, ie at least running wm discovery and finding nothing. harmless, but a waste. 2023-06-09 19:56:45 +00:00			`users=[other_user.key],`
don't add notification label unless an activity involves the user for #442 (ish) 2023-03-14 03:38:17 +00:00			`# not feed since it's a reply`
			`# not notification since it doesn't involve the user`
			`labels=['activity'],`
don't deliver replies to followers also start new test_protocol file. fixes #444. 2023-03-14 00:25:10 +00:00			`status='complete',`
AP users: add Protocol.ABBREV, Protocol.OTHER_LABELS for #512 2023-06-11 15:14:17 +00:00			`source_protocol='fake',`
don't deliver replies to followers also start new test_protocol file. fixes #444. 2023-03-14 00:25:10 +00:00			`)`
don't add notification label unless an activity involves the user for #442 (ish) 2023-03-14 03:38:17 +00:00			`self.assert_object(REPLY['object']['id'],`
			`as2=REPLY['object'],`
don't deliver replies to followers also start new test_protocol file. fixes #444. 2023-03-14 00:25:10 +00:00			`type='comment',`
AP users: add Protocol.ABBREV, Protocol.OTHER_LABELS for #512 2023-06-11 15:14:17 +00:00			`source_protocol='fake',`
don't deliver replies to followers also start new test_protocol file. fixes #444. 2023-03-14 00:25:10 +00:00			`)`
Protocol.get_object(): store object before returning also flesh out FakeProtocol hopefully helps with https://console.cloud.google.com/errors/detail/CKCN17fmoZHraw;time=P30D?project=bridgy-federated , don't really know though 2023-03-27 21:12:06 +00:00
noop, rename Protocol.get_object => Protocol.load 2023-03-29 20:13:32 +00:00			`def test_load(self):`
start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`Fake.objects['foo'] = {'x': 'y'}`
unify Object.new/changed generation into Protocol.load also: * switch back to preserving fragments in URL ids * webmention.fetch: if URL id redirects, preserve original id in Object 2023-04-03 14:53:15 +00:00
start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`loaded = Fake.load('foo')`
unify Object.new/changed generation into Protocol.load also: * switch back to preserving fragments in URL ids * webmention.fetch: if URL id redirects, preserve original id in Object 2023-04-03 14:53:15 +00:00			`self.assert_equals({'x': 'y'}, loaded.our_as1)`
			`self.assertFalse(loaded.changed)`
			`self.assertTrue(loaded.new)`

Protocol.get_object(): store object before returning also flesh out FakeProtocol hopefully helps with https://console.cloud.google.com/errors/detail/CKCN17fmoZHraw;time=P30D?project=bridgy-federated , don't really know though 2023-03-27 21:12:06 +00:00			`self.assertIsNotNone(Object.get_by_id('foo'))`
start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`self.assertEqual(['foo'], Fake.fetched)`
Protocol.get_object(): store object before returning also flesh out FakeProtocol hopefully helps with https://console.cloud.google.com/errors/detail/CKCN17fmoZHraw;time=P30D?project=bridgy-federated , don't really know though 2023-03-27 21:12:06 +00:00
Protocol.load: bug fix, handle Object.as1 going from non-None to None fixes https://console.cloud.google.com/errors/detail/CI3L3MzXjPza9gE;time=P30D?project=bridgy-federated 2023-06-03 04:53:44 +00:00			`def test_load_existing(self):`
Protocol.get_object(): store object before returning also flesh out FakeProtocol hopefully helps with https://console.cloud.google.com/errors/detail/CKCN17fmoZHraw;time=P30D?project=bridgy-federated , don't really know though 2023-03-27 21:12:06 +00:00			`stored = Object(id='foo', our_as1={'x': 'y'})`
			`stored.put()`
unify Object.new/changed generation into Protocol.load also: * switch back to preserving fragments in URL ids * webmention.fetch: if URL id redirects, preserve original id in Object 2023-04-03 14:53:15 +00:00
start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`loaded = Fake.load('foo')`
unify Object.new/changed generation into Protocol.load also: * switch back to preserving fragments in URL ids * webmention.fetch: if URL id redirects, preserve original id in Object 2023-04-03 14:53:15 +00:00			`self.assert_equals({'x': 'y'}, loaded.our_as1)`
			`self.assertFalse(loaded.changed)`
			`self.assertFalse(loaded.new)`

start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`self.assertEqual([], Fake.fetched)`
incoming AP: when we can't load the keyId, store a deleted Object prevents re-fetching the same failing keyId actor over and over when we get the same Delete actor activity sent to all of our inboxes 2023-03-29 19:48:50 +00:00
Protocol.load: bug fix, handle Object.as1 going from non-None to None fixes https://console.cloud.google.com/errors/detail/CI3L3MzXjPza9gE;time=P30D?project=bridgy-federated 2023-06-03 04:53:44 +00:00			`def test_load_existing_empty_deleted(self):`
incoming AP: when we can't load the keyId, store a deleted Object prevents re-fetching the same failing keyId actor over and over when we get the same Delete actor activity sent to all of our inboxes 2023-03-29 19:48:50 +00:00			`stored = Object(id='foo', deleted=True)`
			`stored.put()`

start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`loaded = Fake.load('foo')`
unify Object.new/changed generation into Protocol.load also: * switch back to preserving fragments in URL ids * webmention.fetch: if URL id redirects, preserve original id in Object 2023-04-03 14:53:15 +00:00			`self.assert_entities_equal(stored, loaded)`
			`self.assertFalse(loaded.changed)`
			`self.assertFalse(loaded.new)`

start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`self.assertEqual([], Fake.fetched)`
unify Object.new/changed generation into Protocol.load also: * switch back to preserving fragments in URL ids * webmention.fetch: if URL id redirects, preserve original id in Object 2023-04-03 14:53:15 +00:00
Protocol.load: bug fix, handle Object.as1 going from non-None to None fixes https://console.cloud.google.com/errors/detail/CI3L3MzXjPza9gE;time=P30D?project=bridgy-federated 2023-06-03 04:53:44 +00:00			`def test_load_refresh_existing_empty(self):`
			`Fake.objects['foo'] = {'x': 'y'}`
			`Object(id='foo').put()`

			`loaded = Fake.load('foo', refresh=True)`
			`self.assertEqual({'x': 'y'}, loaded.as1)`
			`self.assertTrue(loaded.changed)`
			`self.assertFalse(loaded.new)`
			`self.assertEqual(['foo'], Fake.fetched)`

			`def test_load_refresh_new_empty(self):`
			`Fake.objects['foo'] = None`
			`Object(id='foo', our_as1={'x': 'y'}).put()`

			`loaded = Fake.load('foo', refresh=True)`
			`self.assertIsNone(loaded.as1)`
			`self.assertTrue(loaded.changed)`
			`self.assertFalse(loaded.new)`
			`self.assertEqual(['foo'], Fake.fetched)`

			`def test_load_refresh_unchanged(self):`
unify Object.new/changed generation into Protocol.load also: * switch back to preserving fragments in URL ids * webmention.fetch: if URL id redirects, preserve original id in Object 2023-04-03 14:53:15 +00:00			`obj = Object(id='foo', our_as1={'x': 'stored'})`
			`obj.put()`
start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`Fake.objects['foo'] = {'x': 'stored'}`
unify Object.new/changed generation into Protocol.load also: * switch back to preserving fragments in URL ids * webmention.fetch: if URL id redirects, preserve original id in Object 2023-04-03 14:53:15 +00:00
start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`loaded = Fake.load('foo', refresh=True)`
unify Object.new/changed generation into Protocol.load also: * switch back to preserving fragments in URL ids * webmention.fetch: if URL id redirects, preserve original id in Object 2023-04-03 14:53:15 +00:00			`self.assert_entities_equal(obj, loaded)`
			`self.assertFalse(obj.changed)`
			`self.assertFalse(obj.new)`
start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`self.assertEqual(['foo'], Fake.fetched)`
unify Object.new/changed generation into Protocol.load also: * switch back to preserving fragments in URL ids * webmention.fetch: if URL id redirects, preserve original id in Object 2023-04-03 14:53:15 +00:00
Protocol.load: bug fix, handle Object.as1 going from non-None to None fixes https://console.cloud.google.com/errors/detail/CI3L3MzXjPza9gE;time=P30D?project=bridgy-federated 2023-06-03 04:53:44 +00:00			`def test_load_refresh_changed(self):`
unify Object.new/changed generation into Protocol.load also: * switch back to preserving fragments in URL ids * webmention.fetch: if URL id redirects, preserve original id in Object 2023-04-03 14:53:15 +00:00			`Object(id='foo', our_as1={'content': 'stored'}).put()`
start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`Fake.objects['foo'] = {'content': 'new'}`
unify Object.new/changed generation into Protocol.load also: * switch back to preserving fragments in URL ids * webmention.fetch: if URL id redirects, preserve original id in Object 2023-04-03 14:53:15 +00:00
start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`loaded = Fake.load('foo', refresh=True)`
unify Object.new/changed generation into Protocol.load also: * switch back to preserving fragments in URL ids * webmention.fetch: if URL id redirects, preserve original id in Object 2023-04-03 14:53:15 +00:00			`self.assert_equals({'content': 'new'}, loaded.our_as1)`
			`self.assertTrue(loaded.changed)`
			`self.assertFalse(loaded.new)`
start to make User subclasses for each protocol #512 2023-05-26 23:07:36 +00:00			`self.assertEqual(['foo'], Fake.fetched)`