Add to PDF tests: Fix testing guideline infractions

Assisted-by: Codex

Author: datalogics-cgreen

tests/live/test_live_add_image_to_pdf.py

@@ -108,3 +108,25 @@ def test_live_add_image_to_pdf_invalid_page(
             page=1,
             extra_body={"page": 0},
         )
+
+
+@pytest.mark.asyncio
+async def test_live_async_add_image_to_pdf_invalid_page(
+    pdfrest_api_key: str,
+    pdfrest_live_base_url: str,
+    uploaded_pdf_for_image_addition: PdfRestFile,
+    uploaded_image: PdfRestFile,
+) -> None:
+    async with AsyncPdfRestClient(
+        api_key=pdfrest_api_key,
+        base_url=pdfrest_live_base_url,
+    ) as client:
+        with pytest.raises(PdfRestApiError, match=r"(?i)page"):
+            await client.add_image_to_pdf(
+                uploaded_pdf_for_image_addition,
+                image=uploaded_image,
+                x=0,
+                y=0,
+                page=1,
+                extra_body={"page": 0},
+            )

tests/live/test_live_add_text_to_pdf.py

@@ -103,3 +103,28 @@ def test_live_add_text_to_pdf_invalid_page(
                 ]
             },
         )
+
+
+@pytest.mark.asyncio
+async def test_live_async_add_text_to_pdf_invalid_page(
+    pdfrest_api_key: str,
+    pdfrest_live_base_url: str,
+    uploaded_pdf_for_text: PdfRestFile,
+) -> None:
+    async with AsyncPdfRestClient(
+        api_key=pdfrest_api_key,
+        base_url=pdfrest_live_base_url,
+    ) as client:
+        with pytest.raises(PdfRestApiError, match=r"(?i)page"):
+            await client.add_text_to_pdf(
+                uploaded_pdf_for_text,
+                text_objects=[_default_text_object()],
+                extra_body={
+                    "text_objects": [
+                        {
+                            **_default_text_object(),
+                            "page": 0,
+                        }
+                    ]
+                },
+            )

tests/test_add_attachment_to_pdf.py

@@ -1,15 +1,13 @@
 from __future__ import annotations
 
 import json
-from collections.abc import Callable
 
 import httpx
 import pytest
 from pydantic import ValidationError
 
 from pdfrest import AsyncPdfRestClient, PdfRestClient
 from pdfrest.models import PdfRestFile, PdfRestFileBasedResponse, PdfRestFileID
-from pdfrest.models._internal import PdfAddAttachmentPayload
 
 from .graphics_test_helpers import (
     ASYNC_API_KEY,
@@ -33,10 +31,6 @@ def test_add_attachment_to_pdf_success(monkeypatch: pytest.MonkeyPatch) -> None:
     attachment = make_attachment_file(str(PdfRestFileID.generate()), "notes.txt")
     output_id = str(PdfRestFileID.generate())
 
-    payload_dump = PdfAddAttachmentPayload.model_validate(
-        {"files": [input_file], "attachments": [attachment], "output": "attached"}
-    ).model_dump(mode="json", by_alias=True, exclude_none=True, exclude_unset=True)
-
     seen: dict[str, int] = {"post": 0, "get": 0}
 
     def handler(request: httpx.Request) -> httpx.Response:
@@ -46,7 +40,9 @@ def handler(request: httpx.Request) -> httpx.Response:
         ):
             seen["post"] += 1
             payload = json.loads(request.content.decode("utf-8"))
-            assert payload == payload_dump
+            assert payload["id"] == str(input_file.id)
+            assert payload["id_to_attach"] == str(attachment.id)
+            assert payload["output"] == "attached"
             return httpx.Response(
                 200,
                 json={
@@ -303,33 +299,45 @@ def test_add_attachment_to_pdf_requires_pdf_file(
         client.add_attachment_to_pdf(not_pdf, attachment=attachment)
 
 
-@pytest.mark.parametrize(
-    "payload_data",
-    [
-        pytest.param(
-            lambda pdf, attachment: {
-                "files": [pdf, make_pdf_file(PdfRestFileID.generate())],
-                "attachments": [attachment],
-            },
-            id="multiple-input-files",
-        ),
-        pytest.param(
-            lambda pdf, attachment: {
-                "files": [pdf],
-                "attachments": [
-                    attachment,
-                    make_attachment_file(str(PdfRestFileID.generate())),
-                ],
-            },
-            id="multiple-attachments",
-        ),
-    ],
-)
-def test_add_attachment_to_pdf_rejects_multiple_files(
-    payload_data: Callable[[PdfRestFile, PdfRestFile], dict[str, object]],
+def test_add_attachment_to_pdf_rejects_multiple_input_files(
+    monkeypatch: pytest.MonkeyPatch,
 ) -> None:
-    input_file = make_pdf_file(PdfRestFileID.generate())
-    attachment = make_attachment_file(str(PdfRestFileID.generate()))
+    monkeypatch.delenv("PDFREST_API_KEY", raising=False)
 
-    with pytest.raises(ValidationError):
-        PdfAddAttachmentPayload.model_validate(payload_data(input_file, attachment))
+    def handler(_: httpx.Request) -> httpx.Response:
+        pytest.fail("Request should not be sent when validation fails.")
+
+    transport = httpx.MockTransport(handler)
+    with (
+        PdfRestClient(api_key=VALID_API_KEY, transport=transport) as client,
+        pytest.raises(ValidationError, match="at most 1 item"),
+    ):
+        client.add_attachment_to_pdf(
+            [
+                make_pdf_file(PdfRestFileID.generate(1)),
+                make_pdf_file(PdfRestFileID.generate(2)),
+            ],
+            attachment=make_attachment_file(str(PdfRestFileID.generate())),
+        )
+
+
+def test_add_attachment_to_pdf_rejects_multiple_attachments(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    monkeypatch.delenv("PDFREST_API_KEY", raising=False)
+
+    def handler(_: httpx.Request) -> httpx.Response:
+        pytest.fail("Request should not be sent when validation fails.")
+
+    transport = httpx.MockTransport(handler)
+    with (
+        PdfRestClient(api_key=VALID_API_KEY, transport=transport) as client,
+        pytest.raises(ValidationError, match="at most 1 item"),
+    ):
+        client.add_attachment_to_pdf(
+            make_pdf_file(PdfRestFileID.generate(1)),
+            attachment=[
+                make_attachment_file(str(PdfRestFileID.generate(2))),
+                make_attachment_file(str(PdfRestFileID.generate(3)), "more.txt"),
+            ],
+        )

tests/test_add_image_to_pdf.py

@@ -9,7 +9,6 @@
 
 from pdfrest import AsyncPdfRestClient, PdfRestClient
 from pdfrest.models import PdfRestFileBasedResponse, PdfRestFileID
-from pdfrest.models._internal import PdfAddImagePayload
 
 from .graphics_test_helpers import (
     ASYNC_API_KEY,
@@ -28,25 +27,19 @@ def test_add_image_to_pdf_success(monkeypatch: pytest.MonkeyPatch) -> None:
     )
     output_id = str(PdfRestFileID.generate())
 
-    request_payload = PdfAddImagePayload.model_validate(
-        {
-            "files": [pdf_file],
-            "image": [image_file],
-            "x": 12,
-            "y": 34,
-            "page": 3,
-            "output": "with-image",
-        }
-    ).model_dump(mode="json", by_alias=True, exclude_none=True, exclude_unset=True)
-
     seen: dict[str, int] = {"post": 0, "get": 0}
 
     def handler(request: httpx.Request) -> httpx.Response:
         if request.method == "POST" and request.url.path == "/pdf-with-added-image":
             seen["post"] += 1
             assert request.headers["wsn"] == "pdfrest-python"
             payload = json.loads(request.content.decode("utf-8"))
-            assert payload == request_payload
+            assert payload["id"] == str(pdf_file.id)
+            assert payload["image_id"] == str(image_file.id)
+            assert payload["x"] == 12
+            assert payload["y"] == 34
+            assert payload["page"] == 3
+            assert payload["output"] == "with-image"
             return httpx.Response(
                 200,
                 json={
@@ -222,6 +215,56 @@ def handler(_: httpx.Request) -> httpx.Response:
         )
 
 
+def test_add_image_to_pdf_rejects_multiple_input_files(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    monkeypatch.delenv("PDFREST_API_KEY", raising=False)
+
+    def handler(_: httpx.Request) -> httpx.Response:
+        pytest.fail("Request should not be sent when validation fails.")
+
+    transport = httpx.MockTransport(handler)
+    with (
+        PdfRestClient(api_key=VALID_API_KEY, transport=transport) as client,
+        pytest.raises(ValidationError, match="at most 1 item"),
+    ):
+        client.add_image_to_pdf(
+            [
+                make_pdf_file(PdfRestFileID.generate(1)),
+                make_pdf_file(PdfRestFileID.generate(2)),
+            ],
+            image=make_image_file(PdfRestFileID.generate(3)),
+            x=1,
+            y=1,
+            page=1,
+        )
+
+
+def test_add_image_to_pdf_rejects_multiple_images(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    monkeypatch.delenv("PDFREST_API_KEY", raising=False)
+
+    def handler(_: httpx.Request) -> httpx.Response:
+        pytest.fail("Request should not be sent when validation fails.")
+
+    transport = httpx.MockTransport(handler)
+    with (
+        PdfRestClient(api_key=VALID_API_KEY, transport=transport) as client,
+        pytest.raises(ValidationError, match="at most 1 item"),
+    ):
+        client.add_image_to_pdf(
+            make_pdf_file(PdfRestFileID.generate(1)),
+            image=[
+                make_image_file(PdfRestFileID.generate(2)),
+                make_image_file(PdfRestFileID.generate(3), name="secondary.png"),
+            ],
+            x=1,
+            y=1,
+            page=1,
+        )
+
+
 @pytest.mark.asyncio
 async def test_async_add_image_to_pdf_success(
     monkeypatch: pytest.MonkeyPatch,
@@ -231,23 +274,17 @@ async def test_async_add_image_to_pdf_success(
     image_file = make_image_file(PdfRestFileID.generate(2), mime_type="image/gif")
     output_id = str(PdfRestFileID.generate())
 
-    request_payload = PdfAddImagePayload.model_validate(
-        {
-            "files": [pdf_file],
-            "image": [image_file],
-            "x": 5,
-            "y": 6,
-            "page": 7,
-        }
-    ).model_dump(mode="json", by_alias=True, exclude_none=True, exclude_unset=True)
-
     seen: dict[str, int] = {"post": 0, "get": 0}
 
     def handler(request: httpx.Request) -> httpx.Response:
         if request.method == "POST" and request.url.path == "/pdf-with-added-image":
             seen["post"] += 1
             payload = json.loads(request.content.decode("utf-8"))
-            assert payload == request_payload
+            assert payload["id"] == str(pdf_file.id)
+            assert payload["image_id"] == str(image_file.id)
+            assert payload["x"] == 5
+            assert payload["y"] == 6
+            assert payload["page"] == 7
             return httpx.Response(
                 200,
                 json={
@@ -289,6 +326,7 @@ async def test_async_add_image_to_pdf_request_customization(
     pdf_file = make_pdf_file(PdfRestFileID.generate(1))
     image_file = make_image_file(PdfRestFileID.generate(2))
     output_id = str(PdfRestFileID.generate())
+    captured_timeout: dict[str, float | dict[str, float] | None] = {}
 
     def handler(request: httpx.Request) -> httpx.Response:
         if request.method == "POST" and request.url.path == "/pdf-with-added-image":
@@ -297,6 +335,7 @@ def handler(request: httpx.Request) -> httpx.Response:
             payload = json.loads(request.content.decode("utf-8"))
             assert payload["x"] == 15
             assert payload["y"] == 25
+            captured_timeout["value"] = request.extensions.get("timeout")
             return httpx.Response(
                 200,
                 json={
@@ -331,6 +370,14 @@ def handler(request: httpx.Request) -> httpx.Response:
         )
 
     assert response.output_files[0].name == "async-custom-with-image.pdf"
+    timeout_value = captured_timeout["value"]
+    assert timeout_value is not None
+    if isinstance(timeout_value, dict):
+        assert all(
+            component == pytest.approx(1.0) for component in timeout_value.values()
+        )
+    else:
+        assert timeout_value == pytest.approx(1.0)
 
 
 @pytest.mark.asyncio