Initial commit

env/lib/python3.10/site-packages/wagtail/admin/tests/api/test_documents.py

@@ -0,0 +1,151 @@
+import json
+
+from django.urls import reverse
+
+from wagtail.api.v2.tests.test_documents import (
+    TestDocumentDetail,
+    TestDocumentListing,
+    TestDocumentListingSearch,
+)
+from wagtail.documents.models import Document
+
+from .utils import AdminAPITestCase
+
+
+class TestAdminDocumentListing(AdminAPITestCase, TestDocumentListing):
+    fixtures = ["demosite.json"]
+
+    def get_response(self, **params):
+        return self.client.get(reverse("wagtailadmin_api:documents:listing"), params)
+
+    def get_document_id_list(self, content):
+        return [document["id"] for document in content["items"]]
+
+    # BASIC TESTS
+
+    def test_basic(self):
+        response = self.get_response()
+
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response["Content-type"], "application/json")
+
+        # Will crash if the JSON is invalid
+        content = json.loads(response.content.decode("UTF-8"))
+
+        # Check that the meta section is there
+        self.assertIn("meta", content)
+        self.assertIsInstance(content["meta"], dict)
+
+        # Check that the total count is there and correct
+        self.assertIn("total_count", content["meta"])
+        self.assertIsInstance(content["meta"]["total_count"], int)
+        self.assertEqual(content["meta"]["total_count"], Document.objects.count())
+
+        # Check that the items section is there
+        self.assertIn("items", content)
+        self.assertIsInstance(content["items"], list)
+
+        # Check that each document has a meta section with type, detail_url and tags attributes
+        for document in content["items"]:
+            self.assertIn("meta", document)
+            self.assertIsInstance(document["meta"], dict)
+            self.assertEqual(
+                set(document["meta"].keys()),
+                {"type", "detail_url", "download_url", "tags"},
+            )
+
+            # Type should always be wagtaildocs.Document
+            self.assertEqual(document["meta"]["type"], "wagtaildocs.Document")
+
+            # Check detail_url
+            self.assertEqual(
+                document["meta"]["detail_url"],
+                "http://localhost/admin/api/main/documents/%d/" % document["id"],
+            )
+
+            # Check download_url
+            self.assertTrue(
+                document["meta"]["download_url"].startswith(
+                    "http://localhost/documents/%d/" % document["id"]
+                )
+            )
+
+    # FIELDS
+
+    def test_fields_default(self):
+        response = self.get_response()
+        content = json.loads(response.content.decode("UTF-8"))
+
+        for document in content["items"]:
+            self.assertEqual(set(document.keys()), {"id", "meta", "title"})
+            self.assertEqual(
+                set(document["meta"].keys()),
+                {"type", "detail_url", "download_url", "tags"},
+            )
+
+
+class TestAdminDocumentListingSearch(AdminAPITestCase, TestDocumentListingSearch):
+    fixtures = ["demosite.json"]
+
+    def get_response(self, **params):
+        return self.client.get(reverse("wagtailadmin_api:documents:listing"), params)
+
+    def get_document_id_list(self, content):
+        return [document["id"] for document in content["items"]]
+
+
+class TestAdminDocumentDetail(AdminAPITestCase, TestDocumentDetail):
+    fixtures = ["demosite.json"]
+
+    def get_response(self, image_id, **params):
+        return self.client.get(
+            reverse("wagtailadmin_api:documents:detail", args=(image_id,)), params
+        )
+
+    def test_basic(self):
+        response = self.get_response(1)
+
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response["Content-type"], "application/json")
+
+        # Will crash if the JSON is invalid
+        content = json.loads(response.content.decode("UTF-8"))
+
+        # Check the id field
+        self.assertIn("id", content)
+        self.assertEqual(content["id"], 1)
+
+        # Check that the meta section is there
+        self.assertIn("meta", content)
+        self.assertIsInstance(content["meta"], dict)
+
+        # Check the meta type
+        self.assertIn("type", content["meta"])
+        self.assertEqual(content["meta"]["type"], "wagtaildocs.Document")
+
+        # Check the meta detail_url
+        self.assertIn("detail_url", content["meta"])
+        self.assertEqual(
+            content["meta"]["detail_url"],
+            "http://localhost/admin/api/main/documents/1/",
+        )
+
+        # Check the meta download_url
+        self.assertIn("download_url", content["meta"])
+        self.assertEqual(
+            content["meta"]["download_url"],
+            "http://localhost/documents/1/wagtail_by_markyharky.jpg",
+        )
+
+        # Check the title field
+        self.assertIn("title", content)
+        self.assertEqual(content["title"], "Wagtail by mark Harkin")
+
+        # Check the tags field
+        self.assertIn("tags", content["meta"])
+        self.assertEqual(content["meta"]["tags"], [])
+
+
+# Overwrite imported test cases do Django doesn't run them
+TestDocumentDetail = None
+TestDocumentListing = None

env/lib/python3.10/site-packages/wagtail/admin/tests/api/test_images.py

@@ -0,0 +1,269 @@
+import json
+
+from django.urls import reverse
+
+from wagtail.api.v2.tests.test_images import (
+    TestImageDetail,
+    TestImageListing,
+    TestImageListingSearch,
+)
+from wagtail.images import get_image_model
+from wagtail.images.tests.utils import get_test_image_file
+
+from .utils import AdminAPITestCase
+
+
+class TestAdminImageListing(AdminAPITestCase, TestImageListing):
+    fixtures = ["demosite.json"]
+
+    def get_response(self, **params):
+        return self.client.get(reverse("wagtailadmin_api:images:listing"), params)
+
+    def get_image_id_list(self, content):
+        return [image["id"] for image in content["items"]]
+
+    # BASIC TESTS
+
+    def test_basic(self):
+        response = self.get_response()
+
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response["Content-type"], "application/json")
+
+        # Will crash if the JSON is invalid
+        content = json.loads(response.content.decode("UTF-8"))
+
+        # Check that the meta section is there
+        self.assertIn("meta", content)
+        self.assertIsInstance(content["meta"], dict)
+
+        # Check that the total count is there and correct
+        self.assertIn("total_count", content["meta"])
+        self.assertIsInstance(content["meta"]["total_count"], int)
+        self.assertEqual(
+            content["meta"]["total_count"], get_image_model().objects.count()
+        )
+
+        # Check that the items section is there
+        self.assertIn("items", content)
+        self.assertIsInstance(content["items"], list)
+
+        # Check that each image has a meta section with type, detail_url and tags attributes
+        for image in content["items"]:
+            self.assertIn("meta", image)
+            self.assertIsInstance(image["meta"], dict)
+            self.assertEqual(
+                set(image["meta"].keys()),
+                {"type", "detail_url", "tags", "download_url"},
+            )
+
+            # Type should always be wagtailimages.Image
+            self.assertEqual(image["meta"]["type"], "wagtailimages.Image")
+
+            # Check detail url
+            self.assertEqual(
+                image["meta"]["detail_url"],
+                "http://localhost/admin/api/main/images/%d/" % image["id"],
+            )
+
+    #  FIELDS
+
+    def test_fields_default(self):
+        response = self.get_response()
+        content = json.loads(response.content.decode("UTF-8"))
+
+        for image in content["items"]:
+            self.assertEqual(
+                set(image.keys()),
+                {"id", "meta", "title", "width", "height", "thumbnail"},
+            )
+            self.assertEqual(
+                set(image["meta"].keys()),
+                {"type", "detail_url", "download_url", "tags"},
+            )
+
+    def test_fields(self):
+        response = self.get_response(fields="width,height")
+        content = json.loads(response.content.decode("UTF-8"))
+
+        for image in content["items"]:
+            self.assertEqual(
+                set(image.keys()),
+                {"id", "meta", "title", "width", "height", "thumbnail"},
+            )
+            self.assertEqual(
+                set(image["meta"].keys()),
+                {"type", "detail_url", "download_url", "tags"},
+            )
+
+    def test_remove_fields(self):
+        response = self.get_response(fields="-title")
+        content = json.loads(response.content.decode("UTF-8"))
+
+        for image in content["items"]:
+            self.assertEqual(
+                set(image.keys()), {"id", "meta", "width", "height", "thumbnail"}
+            )
+
+    def test_remove_meta_fields(self):
+        response = self.get_response(fields="-tags")
+        content = json.loads(response.content.decode("UTF-8"))
+
+        for image in content["items"]:
+            self.assertEqual(
+                set(image.keys()),
+                {"id", "meta", "title", "width", "height", "thumbnail"},
+            )
+            self.assertEqual(
+                set(image["meta"].keys()), {"type", "detail_url", "download_url"}
+            )
+
+    def test_remove_all_meta_fields(self):
+        response = self.get_response(fields="-type,-detail_url,-tags")
+        content = json.loads(response.content.decode("UTF-8"))
+
+        for image in content["items"]:
+            self.assertEqual(
+                set(image.keys()),
+                {"id", "title", "width", "height", "thumbnail", "meta"},
+            )
+
+    def test_remove_id_field(self):
+        response = self.get_response(fields="-id")
+        content = json.loads(response.content.decode("UTF-8"))
+
+        for image in content["items"]:
+            self.assertEqual(
+                set(image.keys()), {"meta", "title", "width", "height", "thumbnail"}
+            )
+
+    def test_all_fields(self):
+        response = self.get_response(fields="*")
+        content = json.loads(response.content.decode("UTF-8"))
+
+        for image in content["items"]:
+            self.assertEqual(
+                set(image.keys()),
+                {"id", "meta", "title", "width", "height", "thumbnail"},
+            )
+            self.assertEqual(
+                set(image["meta"].keys()),
+                {"type", "detail_url", "tags", "download_url"},
+            )
+
+    def test_all_fields_then_remove_something(self):
+        response = self.get_response(fields="*,-title,-tags")
+        content = json.loads(response.content.decode("UTF-8"))
+
+        for image in content["items"]:
+            self.assertEqual(
+                set(image.keys()), {"id", "meta", "width", "height", "thumbnail"}
+            )
+            self.assertEqual(
+                set(image["meta"].keys()), {"type", "detail_url", "download_url"}
+            )
+
+    def test_fields_tags(self):
+        response = self.get_response(fields="tags")
+        content = json.loads(response.content.decode("UTF-8"))
+
+        for image in content["items"]:
+            self.assertEqual(
+                set(image.keys()),
+                {"id", "meta", "title", "width", "height", "thumbnail"},
+            )
+            self.assertEqual(
+                set(image["meta"].keys()),
+                {"type", "detail_url", "tags", "download_url"},
+            )
+            self.assertIsInstance(image["meta"]["tags"], list)
+
+
+class TestAdminImageListingSearch(AdminAPITestCase, TestImageListingSearch):
+    fixtures = ["demosite.json"]
+
+    def get_response(self, **params):
+        return self.client.get(reverse("wagtailadmin_api:images:listing"), params)
+
+    def get_image_id_list(self, content):
+        return [image["id"] for image in content["items"]]
+
+
+class TestAdminImageDetail(AdminAPITestCase, TestImageDetail):
+    fixtures = ["demosite.json"]
+
+    def get_response(self, image_id, **params):
+        return self.client.get(
+            reverse("wagtailadmin_api:images:detail", args=(image_id,)), params
+        )
+
+    def test_basic(self):
+        response = self.get_response(5)
+
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response["Content-type"], "application/json")
+
+        # Will crash if the JSON is invalid
+        content = json.loads(response.content.decode("UTF-8"))
+
+        # Check the id field
+        self.assertIn("id", content)
+        self.assertEqual(content["id"], 5)
+
+        # Check that the meta section is there
+        self.assertIn("meta", content)
+        self.assertIsInstance(content["meta"], dict)
+
+        # Check the meta type
+        self.assertIn("type", content["meta"])
+        self.assertEqual(content["meta"]["type"], "wagtailimages.Image")
+
+        # Check the meta detail_url
+        self.assertIn("detail_url", content["meta"])
+        self.assertEqual(
+            content["meta"]["detail_url"], "http://localhost/admin/api/main/images/5/"
+        )
+
+        # Check the thumbnail
+
+        # Note: This is None because the source image doesn't exist
+        #       See test_thumbnail below for working example
+        self.assertIn("thumbnail", content)
+        self.assertEqual(content["thumbnail"], {"error": "SourceImageIOError"})
+
+        # Check the title field
+        self.assertIn("title", content)
+        self.assertEqual(content["title"], "James Joyce")
+
+        # Check the width and height fields
+        self.assertIn("width", content)
+        self.assertIn("height", content)
+        self.assertEqual(content["width"], 500)
+        self.assertEqual(content["height"], 392)
+
+        # Check the tags field
+        self.assertIn("tags", content["meta"])
+        self.assertEqual(content["meta"]["tags"], [])
+
+    def test_thumbnail(self):
+        # Add a new image with source file
+        image = get_image_model().objects.create(
+            title="Test image",
+            file=get_test_image_file(),
+        )
+
+        response = self.get_response(image.id)
+        content = json.loads(response.content.decode("UTF-8"))
+
+        self.assertIn("thumbnail", content)
+        self.assertEqual(content["thumbnail"]["width"], 165)
+        self.assertEqual(content["thumbnail"]["height"], 123)
+        self.assertTrue(content["thumbnail"]["url"].startswith("/media/images/test"))
+
+        # Check that source_image_error didn't appear
+        self.assertNotIn("source_image_error", content["meta"])
+
+
+# Overwrite imported test cases do Django doesn't run them
+TestImageDetail = None
+TestImageListing = None

env/lib/python3.10/site-packages/wagtail/admin/tests/api/utils.py

@@ -0,0 +1,9 @@
+from django.test import TransactionTestCase
+
+from wagtail.test.utils import WagtailTestUtils
+
+
+class AdminAPITestCase(WagtailTestUtils, TransactionTestCase):
+    def setUp(self):
+        super().setUp()
+        self.user = self.login()