Moves shelf tests into subdirectory

bookwyrm/tests/views/shelf/__init__.py

@@ -0,0 +1 @@
+from . import *

bookwyrm/tests/views/shelf/test_shelf.py

@@ -0,0 +1,316 @@
+""" test for app action functionality """
+import json
+from unittest.mock import patch
+
+from django.contrib.auth.models import AnonymousUser
+from django.core.exceptions import PermissionDenied
+from django.template.response import TemplateResponse
+from django.test import TestCase
+from django.test.client import RequestFactory
+
+from bookwyrm import forms, models, views
+from bookwyrm.activitypub import ActivitypubResponse
+from bookwyrm.tests.validate_html import validate_html
+
+
+@patch("bookwyrm.models.activitypub_mixin.broadcast_task.delay")
+@patch("bookwyrm.suggested_users.rerank_suggestions_task.delay")
+@patch("bookwyrm.activitystreams.populate_stream_task.delay")
+@patch("bookwyrm.activitystreams.add_book_statuses_task.delay")
+@patch("bookwyrm.activitystreams.remove_book_statuses_task.delay")
+class ShelfViews(TestCase):
+    """tag views"""
+
+    def setUp(self):
+        """we need basic test data and mocks"""
+        self.factory = RequestFactory()
+        with patch("bookwyrm.suggested_users.rerank_suggestions_task.delay"), patch(
+            "bookwyrm.activitystreams.populate_stream_task.delay"
+        ):
+            self.local_user = models.User.objects.create_user(
+                "mouse@local.com",
+                "mouse@mouse.com",
+                "mouseword",
+                local=True,
+                localname="mouse",
+                remote_id="https://example.com/users/mouse",
+            )
+        self.work = models.Work.objects.create(title="Test Work")
+        self.book = models.Edition.objects.create(
+            title="Example Edition",
+            remote_id="https://example.com/book/1",
+            parent_work=self.work,
+        )
+        with patch("bookwyrm.models.activitypub_mixin.broadcast_task.delay"):
+            self.shelf = models.Shelf.objects.create(
+                name="Test Shelf", identifier="test-shelf", user=self.local_user
+            )
+        models.SiteSettings.objects.create()
+
+        self.anonymous_user = AnonymousUser
+        self.anonymous_user.is_authenticated = False
+
+    def test_shelf_page_all_books(self, *_):
+        """there are so many views, this just makes sure it LOADS"""
+        view = views.Shelf.as_view()
+        request = self.factory.get("")
+        request.user = self.local_user
+        with patch("bookwyrm.views.shelf.shelf.is_api_request") as is_api:
+            is_api.return_value = False
+            result = view(request, self.local_user.username)
+        self.assertIsInstance(result, TemplateResponse)
+        validate_html(result.render())
+        self.assertEqual(result.status_code, 200)
+
+    def test_shelf_page_all_books_anonymous(self, *_):
+        """there are so many views, this just makes sure it LOADS"""
+        view = views.Shelf.as_view()
+        request = self.factory.get("")
+        request.user = self.anonymous_user
+        with patch("bookwyrm.views.shelf.shelf.is_api_request") as is_api:
+            is_api.return_value = False
+            result = view(request, self.local_user.username)
+        self.assertIsInstance(result, TemplateResponse)
+        validate_html(result.render())
+        self.assertEqual(result.status_code, 200)
+
+    def test_shelf_page_sorted(self, *_):
+        """there are so many views, this just makes sure it LOADS"""
+        view = views.Shelf.as_view()
+        shelf = self.local_user.shelf_set.first()
+        request = self.factory.get("", {"sort": "author"})
+        request.user = self.local_user
+        with patch("bookwyrm.views.shelf.shelf.is_api_request") as is_api:
+            is_api.return_value = False
+            result = view(request, self.local_user.username, shelf.identifier)
+        self.assertIsInstance(result, TemplateResponse)
+        validate_html(result.render())
+        self.assertEqual(result.status_code, 200)
+
+    def test_shelf_page(self, *_):
+        """there are so many views, this just makes sure it LOADS"""
+        view = views.Shelf.as_view()
+        shelf = self.local_user.shelf_set.first()
+        request = self.factory.get("")
+        request.user = self.local_user
+        with patch("bookwyrm.views.shelf.shelf.is_api_request") as is_api:
+            is_api.return_value = False
+            result = view(request, self.local_user.username, shelf.identifier)
+        self.assertIsInstance(result, TemplateResponse)
+        validate_html(result.render())
+        self.assertEqual(result.status_code, 200)
+
+        with patch("bookwyrm.views.shelf.shelf.is_api_request") as is_api:
+            is_api.return_value = True
+            result = view(request, self.local_user.username, shelf.identifier)
+        self.assertIsInstance(result, ActivitypubResponse)
+        self.assertEqual(result.status_code, 200)
+
+        request = self.factory.get("/?page=1")
+        request.user = self.local_user
+        with patch("bookwyrm.views.shelf.shelf.is_api_request") as is_api:
+            is_api.return_value = True
+            result = view(request, self.local_user.username, shelf.identifier)
+        self.assertIsInstance(result, ActivitypubResponse)
+        self.assertEqual(result.status_code, 200)
+
+    def test_edit_shelf_privacy(self, *_):
+        """set name or privacy on shelf"""
+        view = views.Shelf.as_view()
+        shelf = self.local_user.shelf_set.get(identifier="to-read")
+        self.assertEqual(shelf.privacy, "public")
+
+        request = self.factory.post(
+            "",
+            {
+                "privacy": "unlisted",
+                "user": self.local_user.id,
+                "name": "To Read",
+            },
+        )
+        request.user = self.local_user
+        view(request, self.local_user.username, shelf.identifier)
+        shelf.refresh_from_db()
+
+        self.assertEqual(shelf.privacy, "unlisted")
+
+    def test_edit_shelf_name(self, *_):
+        """change the name of an editable shelf"""
+        view = views.Shelf.as_view()
+        shelf = models.Shelf.objects.create(name="Test Shelf", user=self.local_user)
+        self.assertEqual(shelf.privacy, "public")
+
+        request = self.factory.post(
+            "", {"privacy": "public", "user": self.local_user.id, "name": "cool name"}
+        )
+        request.user = self.local_user
+        with patch("bookwyrm.models.activitypub_mixin.broadcast_task.delay"):
+            view(request, request.user.username, shelf.identifier)
+        shelf.refresh_from_db()
+
+        self.assertEqual(shelf.name, "cool name")
+        self.assertEqual(shelf.identifier, f"testshelf-{shelf.id}")
+
+    def test_edit_shelf_name_not_editable(self, *_):
+        """can't change the name of an non-editable shelf"""
+        view = views.Shelf.as_view()
+        shelf = self.local_user.shelf_set.get(identifier="to-read")
+        self.assertEqual(shelf.privacy, "public")
+
+        request = self.factory.post(
+            "", {"privacy": "public", "user": self.local_user.id, "name": "cool name"}
+        )
+        request.user = self.local_user
+        with patch("bookwyrm.models.activitypub_mixin.broadcast_task.delay"):
+            view(request, request.user.username, shelf.identifier)
+
+        self.assertEqual(shelf.name, "To Read")
+
+    def test_shelve(self, *_):
+        """shelve a book"""
+        request = self.factory.post(
+            "", {"book": self.book.id, "shelf": self.shelf.identifier}
+        )
+        request.user = self.local_user
+        with patch("bookwyrm.models.activitypub_mixin.broadcast_task.delay") as mock:
+            views.shelve(request)
+
+        self.assertEqual(mock.call_count, 1)
+        activity = json.loads(mock.call_args[0][1])
+        self.assertEqual(activity["type"], "Add")
+
+        item = models.ShelfBook.objects.get()
+        self.assertEqual(activity["object"]["id"], item.remote_id)
+        # make sure the book is on the shelf
+        self.assertEqual(self.shelf.books.get(), self.book)
+
+    def test_shelve_to_read(self, *_):
+        """special behavior for the to-read shelf"""
+        shelf = models.Shelf.objects.get(identifier="to-read")
+        request = self.factory.post(
+            "", {"book": self.book.id, "shelf": shelf.identifier}
+        )
+        request.user = self.local_user
+
+        with patch("bookwyrm.models.activitypub_mixin.broadcast_task.delay"):
+            views.shelve(request)
+        # make sure the book is on the shelf
+        self.assertEqual(shelf.books.get(), self.book)
+
+    def test_shelve_reading(self, *_):
+        """special behavior for the reading shelf"""
+        shelf = models.Shelf.objects.get(identifier="reading")
+        request = self.factory.post(
+            "", {"book": self.book.id, "shelf": shelf.identifier}
+        )
+        request.user = self.local_user
+
+        with patch("bookwyrm.models.activitypub_mixin.broadcast_task.delay"):
+            views.shelve(request)
+        # make sure the book is on the shelf
+        self.assertEqual(shelf.books.get(), self.book)
+
+    def test_shelve_read(self, *_):
+        """special behavior for the read shelf"""
+        shelf = models.Shelf.objects.get(identifier="read")
+        request = self.factory.post(
+            "", {"book": self.book.id, "shelf": shelf.identifier}
+        )
+        request.user = self.local_user
+
+        with patch("bookwyrm.models.activitypub_mixin.broadcast_task.delay"):
+            views.shelve(request)
+        # make sure the book is on the shelf
+        self.assertEqual(shelf.books.get(), self.book)
+
+    def test_unshelve(self, *_):
+        """remove a book from a shelf"""
+        with patch("bookwyrm.models.activitypub_mixin.broadcast_task.delay"):
+            models.ShelfBook.objects.create(
+                book=self.book, user=self.local_user, shelf=self.shelf
+            )
+        item = models.ShelfBook.objects.get()
+
+        self.shelf.save()
+        self.assertEqual(self.shelf.books.count(), 1)
+        request = self.factory.post("", {"book": self.book.id, "shelf": self.shelf.id})
+        request.user = self.local_user
+        with patch("bookwyrm.models.activitypub_mixin.broadcast_task.delay") as mock:
+            views.unshelve(request)
+        activity = json.loads(mock.call_args[0][1])
+        self.assertEqual(activity["type"], "Remove")
+        self.assertEqual(activity["object"]["id"], item.remote_id)
+        self.assertEqual(self.shelf.books.count(), 0)
+
+    def test_create_shelf(self, *_):
+        """a brand new custom shelf"""
+        form = forms.ShelfForm()
+        form.data["user"] = self.local_user.id
+        form.data["name"] = "new shelf name"
+        form.data["description"] = "desc"
+        form.data["privacy"] = "unlisted"
+        request = self.factory.post("", form.data)
+        request.user = self.local_user
+
+        views.create_shelf(request)
+
+        shelf = models.Shelf.objects.get(name="new shelf name")
+        self.assertEqual(shelf.privacy, "unlisted")
+        self.assertEqual(shelf.description, "desc")
+        self.assertEqual(shelf.user, self.local_user)
+
+    def test_delete_shelf(self, *_):
+        """delete a brand new custom shelf"""
+        request = self.factory.post("")
+        request.user = self.local_user
+        shelf_id = self.shelf.id
+
+        views.delete_shelf(request, shelf_id)
+
+        self.assertFalse(models.Shelf.objects.filter(id=shelf_id).exists())
+
+    def test_delete_shelf_unauthorized(self, *_):
+        """delete a brand new custom shelf"""
+        with patch("bookwyrm.suggested_users.rerank_suggestions_task.delay"), patch(
+            "bookwyrm.activitystreams.populate_stream_task.delay"
+        ):
+            rat = models.User.objects.create_user(
+                "rat@local.com",
+                "rat@mouse.mouse",
+                "password",
+                local=True,
+                localname="rat",
+            )
+        request = self.factory.post("")
+        request.user = rat
+
+        with self.assertRaises(PermissionDenied):
+            views.delete_shelf(request, self.shelf.id)
+
+        self.assertTrue(models.Shelf.objects.filter(id=self.shelf.id).exists())
+
+    def test_delete_shelf_has_book(self, *_):
+        """delete a brand new custom shelf"""
+        with patch("bookwyrm.models.activitypub_mixin.broadcast_task.delay"):
+            models.ShelfBook.objects.create(
+                book=self.book, user=self.local_user, shelf=self.shelf
+            )
+        request = self.factory.post("")
+        request.user = self.local_user
+
+        with self.assertRaises(PermissionDenied):
+            views.delete_shelf(request, self.shelf.id)
+
+        self.assertTrue(models.Shelf.objects.filter(id=self.shelf.id).exists())
+
+    def test_delete_shelf_not_editable(self, *_):
+        """delete a brand new custom shelf"""
+        shelf = self.local_user.shelf_set.first()
+        self.assertFalse(shelf.editable)
+        request = self.factory.post("")
+        request.user = self.local_user
+
+        with self.assertRaises(PermissionDenied):
+            views.delete_shelf(request, shelf.id)
+
+        self.assertTrue(models.Shelf.objects.filter(id=shelf.id).exists())