bridgy-fed/tests/test_models.py

# coding=utf-8
"""Unit tests for models.py."""
from unittest import mock

from oauth_dropins.webutil.testutil import requests_response
from oauth_dropins.webutil.util import json_dumps, json_loads

from app import app
from models import User, Activity
from . import testutil


class UserTest(testutil.TestCase):

    def setUp(self):
        super(UserTest, self).setUp()
        self.user = User.get_or_create('y.z')

    def test_get_or_create(self):
        assert self.user.mod
        assert self.user.public_exponent
        assert self.user.private_exponent

        same = User.get_or_create('y.z')
        self.assertEqual(same, self.user)

    def test_href(self):
        href = self.user.href()
        self.assertTrue(href.startswith('data:application/magic-public-key,RSA.'), href)
        self.assertIn(self.user.mod, href)
        self.assertIn(self.user.public_exponent, href)

    def test_public_pem(self):
        pem = self.user.public_pem()
        self.assertTrue(pem.decode().startswith('-----BEGIN PUBLIC KEY-----\n'), pem)
        self.assertTrue(pem.decode().endswith('-----END PUBLIC KEY-----'), pem)

    def test_private_pem(self):
        pem = self.user.private_pem()
        self.assertTrue(pem.decode().startswith('-----BEGIN RSA PRIVATE KEY-----\n'), pem)
        self.assertTrue(pem.decode().endswith('-----END RSA PRIVATE KEY-----'), pem)

    def test_address(self):
        self.assertEqual('@y.z@y.z', self.user.address())

        self.user.actor_as2 = '{"type": "Person"}'
        self.assertEqual('@y.z@y.z', self.user.address())

        self.user.actor_as2 = '{"url": "http://foo"}'
        self.assertEqual('@y.z@y.z', self.user.address())

        self.user.actor_as2 = '{"urls": ["http://foo", "acct:bar@foo", "acct:baz@y.z"]}'
        self.assertEqual('@baz@y.z', self.user.address())

    def _test_verify(self, redirects, hcard, actor, redirects_error=None):
        with app.test_request_context('/'):
            self.user.verify()
        with self.subTest(redirects=redirects, hcard=hcard, actor=actor,
                          redirects_error=redirects_error):
            self.assert_equals(redirects, bool(self.user.has_redirects))
            self.assert_equals(hcard, bool(self.user.has_hcard))
            if actor is None:
                self.assertIsNone(self.user.actor_as2)
            else:
                got = {k: v for k, v in json_loads(self.user.actor_as2).items()
                       if k in actor}
                self.assert_equals(actor, got)
            self.assert_equals(redirects_error, self.user.redirects_error)

    @mock.patch('requests.get')
    def test_verify_neither(self, mock_get):
        empty = requests_response('')
        mock_get.side_effect = [empty, empty]
        self._test_verify(False, False, None)

    @mock.patch('requests.get')
    def test_verify_redirect_strips_query_params(self, mock_get):
        half_redir = requests_response(
            status=302, redirected_url='http://localhost/.well-known/webfinger')
        no_hcard = requests_response('<html><body></body></html>')
        mock_get.side_effect = [half_redir, no_hcard]
        self._test_verify(False, False, None, """\
Current vs expected:<pre>- http://localhost/.well-known/webfinger
+ https://fed.brid.gy/.well-known/webfinger?resource=acct:y.z@y.z</pre>""")

    @mock.patch('requests.get')
    def test_verify_multiple_redirects(self, mock_get):
        two_redirs = requests_response(
            status=302, redirected_url=[
                'https://www.y.z/.well-known/webfinger?resource=acct:y.z@y.z',
                'http://localhost/.well-known/webfinger?resource=acct:y.z@y.z',
            ])
        no_hcard = requests_response('<html><body></body></html>')
        mock_get.side_effect = [two_redirs, no_hcard]
        self._test_verify(True, False, None)

    @mock.patch('requests.get')
    def test_verify_non_representative_hcard(self, mock_get):
        full_redir = requests_response(
            status=302,
            redirected_url='http://localhost/.well-known/webfinger?resource=acct:y.z@y.z')
        bad_hcard = requests_response(
            '<html><body><a class="h-card u-url" href="https://a.b/">acct:me@y.z</a></body></html>',
            url='https://y.z/',
        )
        mock_get.side_effect = [full_redir, bad_hcard]
        self._test_verify(True, False, None)

    @mock.patch('requests.get')
    def test_verify_both_work(self, mock_get):
        full_redir = requests_response(
            status=302,
            redirected_url='http://localhost/.well-known/webfinger?resource=acct:y.z@y.z')
        hcard = requests_response("""
<html><body class="h-card">
  <a class="u-url p-name" href="/">me</a>
  <a class="u-url" href="acct:myself@y.z">Masto</a>
</body></html>""",
            url='https://y.z/',
        )
        mock_get.side_effect = [full_redir, hcard]
        self._test_verify(True, True, {
            'type': 'Person',
            'name': 'me',
            'url': 'http://localhost/r/https://y.z/',
            'preferredUsername': 'y.z',
        })


class ActivityTest(testutil.TestCase):

    def test_constructor(self):
        activity = Activity('abc', 'xyz')
        self.assertEqual('abc xyz', activity.key.id())

        activity = Activity('abc#1', 'xyz#Z')
        self.assertEqual('abc__1 xyz__Z', activity.key.id())

    def test_get_or_create(self):
        activity = Activity.get_or_create('abc', 'xyz')
        self.assertEqual('abc xyz', activity.key.id())

        activity = Activity.get_or_create('abc#1', 'xyz#Z')
        self.assertEqual('abc__1 xyz__Z', activity.key.id())

    def test_proxy_url(self):
        with app.test_request_context('/'):
            activity = Activity.get_or_create('abc', 'xyz')
            self.assertIsNone(activity.proxy_url())

            activity.source_as2 = 'as2'
            self.assertEqual('http://localhost/render?source=abc&target=xyz',
                             activity.proxy_url())
add MagicKey datastore model 2017-08-19 15:36:55 +00:00			`# coding=utf-8`
			`"""Unit tests for models.py."""`
add User.verify(), checks redirects and home page representative h-card for #276 2022-11-19 02:46:27 +00:00			`from unittest import mock`

			`from oauth_dropins.webutil.testutil import requests_response`
show fediverse address on user page UI, including custom username for #281 2022-11-20 17:38:46 +00:00			`from oauth_dropins.webutil.util import json_dumps, json_loads`
add User.verify(), checks redirects and home page representative h-card for #276 2022-11-19 02:46:27 +00:00
flask: port /.well-known/host-meta*, other misc tweaks all tests pass! 2021-07-11 23:50:44 +00:00			`from app import app`
noop, rename Domain => User 2022-11-16 06:00:28 +00:00			`from models import User, Activity`
migrate to the app engine standard python 3 runtime! https://cloud.google.com/appengine/docs/standard/python3/python-differences https://cloud.google.com/appengine/docs/standard/python/migrate-to-python3/ 2019-12-26 06:20:57 +00:00			`from . import testutil`
add MagicKey datastore model 2017-08-19 15:36:55 +00:00

noop, rename Domain => User 2022-11-16 06:00:28 +00:00			`class UserTest(testutil.TestCase):`
add MagicKey datastore model 2017-08-19 15:36:55 +00:00
add MagicKey.private_pem() and public_pem() 2017-09-19 14:13:35 +00:00			`def setUp(self):`
noop, rename Domain => User 2022-11-16 06:00:28 +00:00			`super(UserTest, self).setUp()`
			`self.user = User.get_or_create('y.z')`
add MagicKey.private_pem() and public_pem() 2017-09-19 14:13:35 +00:00
show fediverse address on user page UI, including custom username for #281 2022-11-20 17:38:46 +00:00			`def test_get_or_create(self):`
noop, rename Domain => User 2022-11-16 06:00:28 +00:00			`assert self.user.mod`
			`assert self.user.public_exponent`
			`assert self.user.private_exponent`
add MagicKey datastore model 2017-08-19 15:36:55 +00:00
noop, rename Domain => User 2022-11-16 06:00:28 +00:00			`same = User.get_or_create('y.z')`
			`self.assertEqual(same, self.user)`
MagicKey: generate data: URI for href value also fix indentation 2017-08-19 16:15:29 +00:00
			`def test_href(self):`
noop, rename Domain => User 2022-11-16 06:00:28 +00:00			`href = self.user.href()`
MagicKey: generate data: URI for href value also fix indentation 2017-08-19 16:15:29 +00:00			`self.assertTrue(href.startswith('data:application/magic-public-key,RSA.'), href)`
noop, rename Domain => User 2022-11-16 06:00:28 +00:00			`self.assertIn(self.user.mod, href)`
			`self.assertIn(self.user.public_exponent, href)`
add MagicKey.private_pem() and public_pem() 2017-09-19 14:13:35 +00:00
			`def test_public_pem(self):`
noop, rename Domain => User 2022-11-16 06:00:28 +00:00			`pem = self.user.public_pem()`
migrate to the app engine standard python 3 runtime! https://cloud.google.com/appengine/docs/standard/python3/python-differences https://cloud.google.com/appengine/docs/standard/python/migrate-to-python3/ 2019-12-26 06:20:57 +00:00			`self.assertTrue(pem.decode().startswith('-----BEGIN PUBLIC KEY-----\n'), pem)`
			`self.assertTrue(pem.decode().endswith('-----END PUBLIC KEY-----'), pem)`
add MagicKey.private_pem() and public_pem() 2017-09-19 14:13:35 +00:00
migrate to the app engine standard python 3 runtime! https://cloud.google.com/appengine/docs/standard/python3/python-differences https://cloud.google.com/appengine/docs/standard/python/migrate-to-python3/ 2019-12-26 06:20:57 +00:00			`def test_private_pem(self):`
noop, rename Domain => User 2022-11-16 06:00:28 +00:00			`pem = self.user.private_pem()`
migrate to the app engine standard python 3 runtime! https://cloud.google.com/appengine/docs/standard/python3/python-differences https://cloud.google.com/appengine/docs/standard/python/migrate-to-python3/ 2019-12-26 06:20:57 +00:00			`self.assertTrue(pem.decode().startswith('-----BEGIN RSA PRIVATE KEY-----\n'), pem)`
			`self.assertTrue(pem.decode().endswith('-----END RSA PRIVATE KEY-----'), pem)`
activitypub: use proxy mf2 URLs for likes and reposts/boosts for #4 2017-10-11 05:42:19 +00:00
show fediverse address on user page UI, including custom username for #281 2022-11-20 17:38:46 +00:00			`def test_address(self):`
			`self.assertEqual('@y.z@y.z', self.user.address())`

			`self.user.actor_as2 = '{"type": "Person"}'`
			`self.assertEqual('@y.z@y.z', self.user.address())`

bug fix for custom username in fediverse address on user page UI should come from acct: actor URL, not preferredUsername field, which always has to be user's domain for AP interop. in the process, refactored common.get_username() into User.username(). for #281 2022-11-27 00:05:02 +00:00			`self.user.actor_as2 = '{"url": "http://foo"}'`
			`self.assertEqual('@y.z@y.z', self.user.address())`

			`self.user.actor_as2 = '{"urls": ["http://foo", "acct:bar@foo", "acct:baz@y.z"]}'`
			`self.assertEqual('@baz@y.z', self.user.address())`
show fediverse address on user page UI, including custom username for #281 2022-11-20 17:38:46 +00:00
user verification: follow multiple redirects 2022-11-28 21:10:51 +00:00			`def _test_verify(self, redirects, hcard, actor, redirects_error=None):`
			`with app.test_request_context('/'):`
			`self.user.verify()`
			`with self.subTest(redirects=redirects, hcard=hcard, actor=actor,`
			`redirects_error=redirects_error):`
			`self.assert_equals(redirects, bool(self.user.has_redirects))`
			`self.assert_equals(hcard, bool(self.user.has_hcard))`
			`if actor is None:`
			`self.assertIsNone(self.user.actor_as2)`
			`else:`
			`got = {k: v for k, v in json_loads(self.user.actor_as2).items()`
			`if k in actor}`
			`self.assert_equals(actor, got)`
			`self.assert_equals(redirects_error, self.user.redirects_error)`

add User.verify(), checks redirects and home page representative h-card for #276 2022-11-19 02:46:27 +00:00			`@mock.patch('requests.get')`
user verification: follow multiple redirects 2022-11-28 21:10:51 +00:00			`def test_verify_neither(self, mock_get):`
			`empty = requests_response('')`
add User.verify(), checks redirects and home page representative h-card for #276 2022-11-19 02:46:27 +00:00			`mock_get.side_effect = [empty, empty]`
user verification: follow multiple redirects 2022-11-28 21:10:51 +00:00			`self._test_verify(False, False, None)`
add User.verify(), checks redirects and home page representative h-card for #276 2022-11-19 02:46:27 +00:00
user verification: follow multiple redirects 2022-11-28 21:10:51 +00:00			`@mock.patch('requests.get')`
			`def test_verify_redirect_strips_query_params(self, mock_get):`
add User.verify(), checks redirects and home page representative h-card for #276 2022-11-19 02:46:27 +00:00			`half_redir = requests_response(`
user verification: follow multiple redirects 2022-11-28 21:10:51 +00:00			`status=302, redirected_url='http://localhost/.well-known/webfinger')`
add User.verify(), checks redirects and home page representative h-card for #276 2022-11-19 02:46:27 +00:00			`no_hcard = requests_response('<html><body></body></html>')`
			`mock_get.side_effect = [half_redir, no_hcard]`
user verification: follow multiple redirects 2022-11-28 21:10:51 +00:00			`self._test_verify(False, False, None, """\`
user page UI redirects warning: show diff of current vs expected for #305 2022-11-28 01:45:16 +00:00			`Current vs expected:<pre>- http://localhost/.well-known/webfinger`
			`+ https://fed.brid.gy/.well-known/webfinger?resource=acct:y.z@y.z</pre>""")`
add User.verify(), checks redirects and home page representative h-card for #276 2022-11-19 02:46:27 +00:00
user verification: follow multiple redirects 2022-11-28 21:10:51 +00:00			`@mock.patch('requests.get')`
			`def test_verify_multiple_redirects(self, mock_get):`
			`two_redirs = requests_response(`
			`status=302, redirected_url=[`
			`'https://www.y.z/.well-known/webfinger?resource=acct:y.z@y.z',`
			`'http://localhost/.well-known/webfinger?resource=acct:y.z@y.z',`
			`])`
			`no_hcard = requests_response('<html><body></body></html>')`
			`mock_get.side_effect = [two_redirs, no_hcard]`
			`self._test_verify(True, False, None)`

			`@mock.patch('requests.get')`
			`def test_verify_non_representative_hcard(self, mock_get):`
add User.verify(), checks redirects and home page representative h-card for #276 2022-11-19 02:46:27 +00:00			`full_redir = requests_response(`
user verification: follow multiple redirects 2022-11-28 21:10:51 +00:00			`status=302,`
add User.verify(), checks redirects and home page representative h-card for #276 2022-11-19 02:46:27 +00:00			`redirected_url='http://localhost/.well-known/webfinger?resource=acct:y.z@y.z')`
			`bad_hcard = requests_response(`
show fediverse address on user page UI, including custom username for #281 2022-11-20 17:38:46 +00:00			`'<html><body><a class="h-card u-url" href="https://a.b/">acct:me@y.z</a></body></html>',`
user verification: follow multiple redirects 2022-11-28 21:10:51 +00:00			`url='https://y.z/',`
add User.verify(), checks redirects and home page representative h-card for #276 2022-11-19 02:46:27 +00:00			`)`
			`mock_get.side_effect = [full_redir, bad_hcard]`
user verification: follow multiple redirects 2022-11-28 21:10:51 +00:00			`self._test_verify(True, False, None)`
add User.verify(), checks redirects and home page representative h-card for #276 2022-11-19 02:46:27 +00:00
user verification: follow multiple redirects 2022-11-28 21:10:51 +00:00			`@mock.patch('requests.get')`
			`def test_verify_both_work(self, mock_get):`
			`full_redir = requests_response(`
			`status=302,`
			`redirected_url='http://localhost/.well-known/webfinger?resource=acct:y.z@y.z')`
show fediverse address on user page UI, including custom username for #281 2022-11-20 17:38:46 +00:00			`hcard = requests_response("""`
			`<html><body class="h-card">`
			`<a class="u-url p-name" href="/">me</a>`
			`<a class="u-url" href="acct:myself@y.z">Masto</a>`
			`</body></html>""",`
user verification: follow multiple redirects 2022-11-28 21:10:51 +00:00			`url='https://y.z/',`
add User.verify(), checks redirects and home page representative h-card for #276 2022-11-19 02:46:27 +00:00			`)`
			`mock_get.side_effect = [full_redir, hcard]`
user verification: follow multiple redirects 2022-11-28 21:10:51 +00:00			`self._test_verify(True, True, {`
show fediverse address on user page UI, including custom username for #281 2022-11-20 17:38:46 +00:00			`'type': 'Person',`
			`'name': 'me',`
			`'url': 'http://localhost/r/https://y.z/',`
fix preferredUsername regression, it needs to be domain for Webfinger originally added in 65f3ef3cc71b4a5dea56f47ba61736a5b44f1fdf. fixes #302. props to @fancypantalons for debugging! 2022-11-22 22:46:39 +00:00			`'preferredUsername': 'y.z',`
show fediverse address on user page UI, including custom username for #281 2022-11-20 17:38:46 +00:00			`})`
add User.verify(), checks redirects and home page representative h-card for #276 2022-11-19 02:46:27 +00:00
activitypub: use proxy mf2 URLs for likes and reposts/boosts for #4 2017-10-11 05:42:19 +00:00
rename MagicKey => Domain, Response => Activity the Python classes, but not (yet) the kinds in the datastore. maybe eventually. 2022-11-12 23:27:59 +00:00			`class ActivityTest(testutil.TestCase):`
activitypub: use proxy mf2 URLs for likes and reposts/boosts for #4 2017-10-11 05:42:19 +00:00
switch incoming salmon/activitypub to overwrite Response 2017-10-13 06:13:54 +00:00			`def test_constructor(self):`
noop, rename resp => activity 2022-11-13 17:33:40 +00:00			`activity = Activity('abc', 'xyz')`
			`self.assertEqual('abc xyz', activity.key.id())`
switch incoming salmon/activitypub to overwrite Response 2017-10-13 06:13:54 +00:00
noop, rename resp => activity 2022-11-13 17:33:40 +00:00			`activity = Activity('abc#1', 'xyz#Z')`
			`self.assertEqual('abc__1 xyz__Z', activity.key.id())`
switch incoming salmon/activitypub to overwrite Response 2017-10-13 06:13:54 +00:00
convert # to __ in source, target URLs in Response key ids ...since some fedsocnet like ids (eg Mastodon) include fragments, which webmention receivers (eg wordpress) strip from source before fetching, even when they're URL-encoded in bridgy fed proxy URLs. also add Response.get_or_create() that handles concatenating source and target. 2017-10-12 04:07:47 +00:00			`def test_get_or_create(self):`
noop, rename resp => activity 2022-11-13 17:33:40 +00:00			`activity = Activity.get_or_create('abc', 'xyz')`
			`self.assertEqual('abc xyz', activity.key.id())`
convert # to __ in source, target URLs in Response key ids ...since some fedsocnet like ids (eg Mastodon) include fragments, which webmention receivers (eg wordpress) strip from source before fetching, even when they're URL-encoded in bridgy fed proxy URLs. also add Response.get_or_create() that handles concatenating source and target. 2017-10-12 04:07:47 +00:00
noop, rename resp => activity 2022-11-13 17:33:40 +00:00			`activity = Activity.get_or_create('abc#1', 'xyz#Z')`
			`self.assertEqual('abc__1 xyz__Z', activity.key.id())`
convert # to __ in source, target URLs in Response key ids ...since some fedsocnet like ids (eg Mastodon) include fragments, which webmention receivers (eg wordpress) strip from source before fetching, even when they're URL-encoded in bridgy fed proxy URLs. also add Response.get_or_create() that handles concatenating source and target. 2017-10-12 04:07:47 +00:00
activitypub: use proxy mf2 URLs for likes and reposts/boosts for #4 2017-10-11 05:42:19 +00:00			`def test_proxy_url(self):`
flask: port /.well-known/host-meta*, other misc tweaks all tests pass! 2021-07-11 23:50:44 +00:00			`with app.test_request_context('/'):`
noop, rename resp => activity 2022-11-13 17:33:40 +00:00			`activity = Activity.get_or_create('abc', 'xyz')`
			`self.assertIsNone(activity.proxy_url())`
activitypub: use proxy mf2 URLs for likes and reposts/boosts for #4 2017-10-11 05:42:19 +00:00
noop, rename resp => activity 2022-11-13 17:33:40 +00:00			`activity.source_as2 = 'as2'`
flask: port /.well-known/host-meta*, other misc tweaks all tests pass! 2021-07-11 23:50:44 +00:00			`self.assertEqual('http://localhost/render?source=abc&target=xyz',`
noop, rename resp => activity 2022-11-13 17:33:40 +00:00			`activity.proxy_url())`