mirrors/bookwyrm
1
0
Fork 1
mirror of https://github.com/bookwyrm-social/bookwyrm.git synced 2024-11-22 17:41:08 +00:00
Code Issues Projects Releases Wiki Activity

linting and tests

Browse source
This commit is contained in:
Hugh Rundle 2024-01-28 20:35:47 +11:00
parent a3e05254b5
commit 2c231acebe
No known key found for this signature in database
GPG key ID: A7E35779918253F9
5 changed files with 28 additions and 106 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
bookwyrm/models/bookwyrm_export_job.py
View file

@ -1,6 +1,5 @@
"""Export user account to tar.gz file for import into another Bookwyrm instance"""
import dataclasses
import logging
from uuid import uuid4
@ -191,9 +190,11 @@ class AddFileToTar(ChildJob):
def start_job(self):
"""Start the job"""
# NOTE we are doing this all in one big job, which has the potential to block a thread
# This is because we need to refer to the same s3_job or BookwyrmTarFile whilst writing
# Using a series of jobs in a loop would be better if possible
# NOTE we are doing this all in one big job,
# which has the potential to block a thread
# This is because we need to refer to the same s3_job
# or BookwyrmTarFile whilst writing
# Using a series of jobs in a loop would be better
try:
export_data = self.parent_export_job.export_data
@ -275,12 +276,6 @@ def start_export_task(**kwargs):
# prepare the initial file and base json
job.export_data = ContentFile(b"", str(uuid4()))
# BUG: this throws a MISSING class error if there is no avatar
# #3096 may fix it
if not job.user.avatar:
job.user.avatar = ""
job.user.save()
job.export_json = job.user.to_activity()
job.save(update_fields=["export_data", "export_json"])
@ -385,6 +380,7 @@ def json_export(**kwargs):
)
job.set_status("failed")
@app.task(queue=IMPORTS, base=ParentTask)
def trigger_books_jobs(**kwargs):
"""trigger tasks to get data for each book"""

2
bookwyrm/templatetags/utilities.py
View file

@ -9,7 +9,7 @@ from django.utils.translation import gettext_lazy as _
from django.templatetags.static import static
from bookwyrm.models import User
from bookwyrm.settings import INSTANCE_ACTOR_USERNAME, USE_S3
from bookwyrm.settings import INSTANCE_ACTOR_USERNAME
register = template.Library()

107
bookwyrm/tests/models/test_bookwyrm_export_job.py
View file

@ -5,13 +5,15 @@ from unittest.mock import patch
from django.core.serializers.json import DjangoJSONEncoder
from django.test import TestCase
from django.test.utils import override_settings
from django.utils import timezone
from bookwyrm import models
import bookwyrm.models.bookwyrm_export_job as export_job
class BookwyrmExport(TestCase):
class BookwyrmExportJob(TestCase):
"""testing user export functions"""
def setUp(self):
@ -141,94 +143,17 @@ class BookwyrmExport(TestCase):
book=self.edition,
)
# pylint: disable=E1121
def test_json_export_user_settings(self):
"""Test the json export function for basic user info"""
data = export_job.json_export(self.local_user)
user_data = json.loads(data)
self.assertEqual(user_data["preferredUsername"], "mouse")
self.assertEqual(user_data["name"], "Mouse")
self.assertEqual(user_data["summary"], "<p>I'm a real bookmouse</p>")
self.assertEqual(user_data["manuallyApprovesFollowers"], False)
self.assertEqual(user_data["hideFollows"], False)
self.assertEqual(user_data["discoverable"], True)
self.assertEqual(user_data["settings"]["show_goal"], False)
self.assertEqual(user_data["settings"]["show_suggested_users"], False)
self.assertEqual(
user_data["settings"]["preferred_timezone"], "America/Los Angeles"
)
self.assertEqual(user_data["settings"]["default_post_privacy"], "followers")
# pylint: disable=E1121
def test_json_export_extended_user_data(self):
"""Test the json export function for other non-book user info"""
data = export_job.json_export(self.local_user)
json_data = json.loads(data)
# goal
self.assertEqual(len(json_data["goals"]), 1)
self.assertEqual(json_data["goals"][0]["goal"], 128937123)
self.assertEqual(json_data["goals"][0]["year"], timezone.now().year)
self.assertEqual(json_data["goals"][0]["privacy"], "followers")
# saved lists
self.assertEqual(len(json_data["saved_lists"]), 1)
self.assertEqual(json_data["saved_lists"][0], "https://local.lists/9999")
# follows
self.assertEqual(len(json_data["follows"]), 1)
self.assertEqual(json_data["follows"][0], "https://your.domain.here/user/rat")
# blocked users
self.assertEqual(len(json_data["blocks"]), 1)
self.assertEqual(json_data["blocks"][0], "https://your.domain.here/user/badger")
# pylint: disable=E1121
def test_json_export_books(self):
"""Test the json export function for extended user info"""
data = export_job.json_export(self.local_user)
json_data = json.loads(data)
start_date = json_data["books"][0]["readthroughs"][0]["start_date"]
self.assertEqual(len(json_data["books"]), 1)
self.assertEqual(json_data["books"][0]["edition"]["title"], "Example Edition")
self.assertEqual(len(json_data["books"][0]["authors"]), 1)
self.assertEqual(json_data["books"][0]["authors"][0]["name"], "Sam Zhu")
self.assertEqual(
f'"{start_date}"', DjangoJSONEncoder().encode(self.readthrough_start)
)
self.assertEqual(json_data["books"][0]["shelves"][0]["name"], "Read")
self.assertEqual(len(json_data["books"][0]["lists"]), 1)
self.assertEqual(json_data["books"][0]["lists"][0]["name"], "My excellent list")
self.assertEqual(
json_data["books"][0]["lists"][0]["list_item"]["book"],
self.edition.remote_id,
self.edition.id,
)
self.assertEqual(len(json_data["books"][0]["reviews"]), 1)
self.assertEqual(len(json_data["books"][0]["comments"]), 1)
self.assertEqual(len(json_data["books"][0]["quotations"]), 1)
self.assertEqual(json_data["books"][0]["reviews"][0]["name"], "my review")
self.assertEqual(
json_data["books"][0]["reviews"][0]["content"], "<p>awesome</p>"
)
self.assertEqual(json_data["books"][0]["reviews"][0]["rating"], 5.0)
self.assertEqual(
json_data["books"][0]["comments"][0]["content"], "<p>ok so far</p>"
)
self.assertEqual(json_data["books"][0]["comments"][0]["progress"], 15)
self.assertEqual(json_data["books"][0]["comments"][0]["progress_mode"], "PG")
self.assertEqual(
json_data["books"][0]["quotations"][0]["content"], "<p>check this out</p>"
)
self.assertEqual(
json_data["books"][0]["quotations"][0]["quote"],
"<p>A rose by any other name</p>",
self.job = models.BookwyrmExportJob.objects.create(user=self.local_user)
def test_export_saved_lists_task(self):
"""test saved list task"""
with patch("bookwyrm.models.bookwyrm_export_job.json_export.delay"):
models.bookwyrm_export_job.start_export_task(
job_id=self.job.id, no_children=False
)
print(self.job.user)
print(self.job.export_data)
print(self.job.export_json)
# IDK how to test this...
pass

1
bookwyrm/tests/views/preferences/test_export_user.py
View file

@ -41,7 +41,6 @@ class ExportUserViews(TestCase):
request = self.factory.post("")
request.user = self.local_user
with patch("bookwyrm.models.bookwyrm_export_job.start_export_task.delay"):
export = views.ExportUser.as_view()(request)
self.assertIsInstance(export, HttpResponse)
self.assertEqual(export.status_code, 302)

8
bookwyrm/views/preferences/export.py
View file

@ -160,7 +160,8 @@ class ExportUser(View):
export = {"job": job}
if settings.USE_S3:
# make custom_domain None so we can sign the url (https://github.com/jschneier/django-storages/issues/944)
# make custom_domain None so we can sign the url
# see https://github.com/jschneier/django-storages/issues/944
storage = S3Boto3Storage(querystring_auth=True, custom_domain=None)
# for s3 we download directly from s3, so we need a signed url
@ -168,12 +169,13 @@ class ExportUser(View):
storage, f"/exports/{job.task_id}.tar.gz", expire=900
) # temporarily downloadable file, expires after 5 minutes
# for s3 we create a new tar file in s3, so we need to check the size of _that_ file
# for s3 we create a new tar file in s3,
# so we need to check the size of _that_ file
try:
export["size"] = S3Boto3Storage.size(
storage, f"exports/{job.task_id}.tar.gz"
)
except Exception:
except Exception: # pylint: disable=broad-except
export["size"] = 0
else: