moviewyrm/bookwyrm/tests/views/test_helpers.py

209 lines
8.7 KiB
Python
Raw Normal View History

2021-03-08 16:49:10 +00:00
""" test for app action functionality """
2021-01-13 21:54:01 +00:00
import json
2020-12-30 19:37:49 +00:00
from unittest.mock import patch
2021-01-13 21:54:01 +00:00
import pathlib
from django.http import Http404
2020-12-30 19:37:49 +00:00
from django.test import TestCase
from django.test.client import RequestFactory
2021-01-13 21:54:01 +00:00
import responses
2020-12-30 19:37:49 +00:00
2021-01-13 20:18:19 +00:00
from bookwyrm import models, views
2021-01-13 20:03:27 +00:00
from bookwyrm.settings import USER_AGENT
2020-12-30 19:37:49 +00:00
2021-03-08 16:49:10 +00:00
2021-09-06 20:53:49 +00:00
@patch("bookwyrm.activitystreams.add_status_task.delay")
2021-08-03 17:25:53 +00:00
@patch("bookwyrm.suggested_users.rerank_suggestions_task.delay")
2021-09-06 21:50:33 +00:00
@patch("bookwyrm.activitystreams.populate_stream_task.delay")
2021-08-03 19:48:44 +00:00
@patch("bookwyrm.suggested_users.rerank_user_task.delay")
2021-01-13 20:18:19 +00:00
class ViewsHelpers(TestCase):
2021-04-26 16:15:42 +00:00
"""viewing and creating statuses"""
2021-03-08 16:49:10 +00:00
2020-12-30 19:37:49 +00:00
def setUp(self):
2021-04-26 16:15:42 +00:00
"""we need basic test data and mocks"""
2020-12-30 19:37:49 +00:00
self.factory = RequestFactory()
with patch("bookwyrm.suggested_users.rerank_suggestions_task.delay"), patch(
"bookwyrm.activitystreams.populate_stream_task.delay"
2021-12-09 23:03:01 +00:00
), patch("bookwyrm.lists_stream.populate_lists_task.delay"):
2021-08-03 19:27:42 +00:00
with patch("bookwyrm.suggested_users.rerank_user_task.delay"):
self.local_user = models.User.objects.create_user(
"mouse@local.com",
"mouse@mouse.com",
"mouseword",
local=True,
discoverable=True,
localname="mouse",
remote_id="https://example.com/users/mouse",
)
2021-08-02 23:05:40 +00:00
with patch("bookwyrm.models.user.set_remote_server.delay"):
2021-08-03 19:41:41 +00:00
with patch("bookwyrm.suggested_users.rerank_user_task.delay"):
self.remote_user = models.User.objects.create_user(
"rat",
"rat@rat.com",
"ratword",
local=False,
remote_id="https://example.com/users/rat",
discoverable=True,
inbox="https://example.com/users/rat/inbox",
outbox="https://example.com/users/rat/outbox",
)
2021-08-02 23:05:40 +00:00
self.work = models.Work.objects.create(title="Test Work")
self.book = models.Edition.objects.create(
title="Test Book",
remote_id="https://example.com/book/1",
parent_work=self.work,
)
2021-03-08 16:49:10 +00:00
datafile = pathlib.Path(__file__).parent.joinpath("../data/ap_user.json")
2021-01-13 21:54:01 +00:00
self.userdata = json.loads(datafile.read_bytes())
2021-03-08 16:49:10 +00:00
del self.userdata["icon"]
2021-11-12 17:17:00 +00:00
with patch("bookwyrm.models.activitypub_mixin.broadcast_task.apply_async"):
2021-02-07 06:37:19 +00:00
self.shelf = models.Shelf.objects.create(
2021-03-08 16:49:10 +00:00
name="Test Shelf", identifier="test-shelf", user=self.local_user
2021-02-07 06:37:19 +00:00
)
2021-01-13 21:54:01 +00:00
2021-08-03 17:25:53 +00:00
def test_get_edition(self, *_):
2021-04-26 16:15:42 +00:00
"""given an edition or a work, returns an edition"""
2021-03-08 16:49:10 +00:00
self.assertEqual(views.helpers.get_edition(self.book.id), self.book)
self.assertEqual(views.helpers.get_edition(self.work.id), self.book)
2021-08-03 17:25:53 +00:00
def test_get_user_from_username(self, *_):
2021-04-26 16:15:42 +00:00
"""works for either localname or username"""
self.assertEqual(
2021-03-08 16:49:10 +00:00
views.helpers.get_user_from_username(self.local_user, "mouse"),
self.local_user,
)
self.assertEqual(
2021-03-08 16:49:10 +00:00
views.helpers.get_user_from_username(self.local_user, "mouse@local.com"),
self.local_user,
)
with self.assertRaises(Http404):
2021-03-08 16:49:10 +00:00
views.helpers.get_user_from_username(self.local_user, "mojfse@example.com")
2020-12-30 19:37:49 +00:00
2021-08-03 17:25:53 +00:00
def test_is_api_request(self, *_):
2021-04-26 16:15:42 +00:00
"""should it return html or json"""
2021-03-08 16:49:10 +00:00
request = self.factory.get("/path")
request.headers = {"Accept": "application/json"}
2021-01-13 20:18:19 +00:00
self.assertTrue(views.helpers.is_api_request(request))
2020-12-30 22:57:57 +00:00
2021-03-08 16:49:10 +00:00
request = self.factory.get("/path.json")
request.headers = {"Accept": "Praise"}
2021-01-13 20:18:19 +00:00
self.assertTrue(views.helpers.is_api_request(request))
2020-12-30 22:57:57 +00:00
2021-03-08 16:49:10 +00:00
request = self.factory.get("/path")
request.headers = {"Accept": "Praise"}
2021-01-13 20:18:19 +00:00
self.assertFalse(views.helpers.is_api_request(request))
2021-08-03 17:25:53 +00:00
def test_is_api_request_no_headers(self, *_):
2021-04-26 16:15:42 +00:00
"""should it return html or json"""
request = self.factory.get("/path")
self.assertFalse(views.helpers.is_api_request(request))
2020-12-30 22:57:57 +00:00
2021-08-03 17:25:53 +00:00
def test_is_bookwyrm_request(self, *_):
2021-04-26 16:15:42 +00:00
"""checks if a request came from a bookwyrm instance"""
2021-03-08 16:49:10 +00:00
request = self.factory.get("", {"q": "Test Book"})
2021-02-23 19:34:15 +00:00
self.assertFalse(views.helpers.is_bookwyrm_request(request))
2021-01-04 18:08:45 +00:00
request = self.factory.get(
2021-03-08 16:49:10 +00:00
"",
{"q": "Test Book"},
HTTP_USER_AGENT="http.rb/4.4.1 (Mastodon/3.3.0; +https://mastodon.social/)",
2021-01-04 18:08:45 +00:00
)
2021-02-23 19:34:15 +00:00
self.assertFalse(views.helpers.is_bookwyrm_request(request))
2021-03-08 16:49:10 +00:00
request = self.factory.get("", {"q": "Test Book"}, HTTP_USER_AGENT=USER_AGENT)
2021-02-23 19:34:15 +00:00
self.assertTrue(views.helpers.is_bookwyrm_request(request))
2021-01-13 21:54:01 +00:00
2021-08-03 17:25:53 +00:00
def test_existing_user(self, *_):
2021-04-26 16:15:42 +00:00
"""simple database lookup by username"""
2021-03-08 16:49:10 +00:00
result = views.helpers.handle_remote_webfinger("@mouse@local.com")
2021-01-13 21:54:01 +00:00
self.assertEqual(result, self.local_user)
2021-03-08 16:49:10 +00:00
result = views.helpers.handle_remote_webfinger("mouse@local.com")
2021-01-13 21:54:01 +00:00
self.assertEqual(result, self.local_user)
2021-04-08 16:59:21 +00:00
result = views.helpers.handle_remote_webfinger("mOuSe@loCal.cOm")
self.assertEqual(result, self.local_user)
2021-01-13 21:54:01 +00:00
@responses.activate
2021-08-03 17:25:53 +00:00
def test_load_user(self, *_):
2021-04-26 16:15:42 +00:00
"""find a remote user using webfinger"""
2021-03-08 16:49:10 +00:00
username = "mouse@example.com"
2021-01-13 21:54:01 +00:00
wellknown = {
"subject": "acct:mouse@example.com",
2021-03-08 16:49:10 +00:00
"links": [
{
"rel": "self",
"type": "application/activity+json",
"href": "https://example.com/user/mouse",
}
],
2021-01-13 21:54:01 +00:00
}
responses.add(
responses.GET,
2021-03-08 16:49:10 +00:00
"https://example.com/.well-known/webfinger?resource=acct:%s" % username,
2021-01-13 21:54:01 +00:00
json=wellknown,
2021-03-08 16:49:10 +00:00
status=200,
)
2021-01-13 21:54:01 +00:00
responses.add(
responses.GET,
2021-03-08 16:49:10 +00:00
"https://example.com/user/mouse",
2021-01-13 21:54:01 +00:00
json=self.userdata,
2021-03-08 16:49:10 +00:00
status=200,
)
2021-08-02 23:05:40 +00:00
with patch("bookwyrm.models.user.set_remote_server.delay"):
result = views.helpers.handle_remote_webfinger("@mouse@example.com")
self.assertIsInstance(result, models.User)
self.assertEqual(result.username, "mouse@example.com")
2021-01-13 21:54:01 +00:00
2021-08-03 17:25:53 +00:00
def test_user_on_blocked_server(self, *_):
2021-04-26 16:15:42 +00:00
"""find a remote user using webfinger"""
models.FederatedServer.objects.create(
server_name="example.com", status="blocked"
)
result = views.helpers.handle_remote_webfinger("@mouse@example.com")
self.assertIsNone(result)
2021-08-03 17:25:53 +00:00
def test_handle_reading_status_to_read(self, *_):
2021-04-26 16:15:42 +00:00
"""posts shelve activities"""
2021-03-08 16:49:10 +00:00
shelf = self.local_user.shelf_set.get(identifier="to-read")
2021-11-12 17:17:00 +00:00
with patch("bookwyrm.models.activitypub_mixin.broadcast_task.apply_async"):
2021-01-13 21:54:01 +00:00
views.helpers.handle_reading_status(
2021-03-08 16:49:10 +00:00
self.local_user, shelf, self.book, "public"
)
2021-01-13 21:54:01 +00:00
status = models.GeneratedNote.objects.get()
self.assertEqual(status.user, self.local_user)
self.assertEqual(status.mention_books.first(), self.book)
2021-03-08 16:49:10 +00:00
self.assertEqual(status.content, "wants to read")
2021-01-13 21:54:01 +00:00
2021-08-03 17:25:53 +00:00
def test_handle_reading_status_reading(self, *_):
2021-04-26 16:15:42 +00:00
"""posts shelve activities"""
2021-03-08 16:49:10 +00:00
shelf = self.local_user.shelf_set.get(identifier="reading")
2021-11-12 17:17:00 +00:00
with patch("bookwyrm.models.activitypub_mixin.broadcast_task.apply_async"):
2021-01-13 21:54:01 +00:00
views.helpers.handle_reading_status(
2021-03-08 16:49:10 +00:00
self.local_user, shelf, self.book, "public"
)
2021-01-13 21:54:01 +00:00
status = models.GeneratedNote.objects.get()
self.assertEqual(status.user, self.local_user)
self.assertEqual(status.mention_books.first(), self.book)
2021-03-08 16:49:10 +00:00
self.assertEqual(status.content, "started reading")
2021-01-13 21:54:01 +00:00
2021-08-03 17:25:53 +00:00
def test_handle_reading_status_read(self, *_):
2021-04-26 16:15:42 +00:00
"""posts shelve activities"""
2021-03-08 16:49:10 +00:00
shelf = self.local_user.shelf_set.get(identifier="read")
2021-11-12 17:17:00 +00:00
with patch("bookwyrm.models.activitypub_mixin.broadcast_task.apply_async"):
2021-01-13 21:54:01 +00:00
views.helpers.handle_reading_status(
2021-03-08 16:49:10 +00:00
self.local_user, shelf, self.book, "public"
)
2021-01-13 21:54:01 +00:00
status = models.GeneratedNote.objects.get()
self.assertEqual(status.user, self.local_user)
self.assertEqual(status.mention_books.first(), self.book)
2021-03-08 16:49:10 +00:00
self.assertEqual(status.content, "finished reading")
2021-01-13 21:54:01 +00:00
2021-08-03 17:25:53 +00:00
def test_handle_reading_status_other(self, *_):
2021-04-26 16:15:42 +00:00
"""posts shelve activities"""
2021-11-12 17:17:00 +00:00
with patch("bookwyrm.models.activitypub_mixin.broadcast_task.apply_async"):
2021-01-13 21:54:01 +00:00
views.helpers.handle_reading_status(
2021-03-08 16:49:10 +00:00
self.local_user, self.shelf, self.book, "public"
)
2021-01-13 21:54:01 +00:00
self.assertFalse(models.GeneratedNote.objects.exists())