Add Convert to PDF tests

Assisted-by: Codex

Author: datalogics-cgreen

tests/live/test_live_convert_to_pdf.py

@@ -0,0 +1,163 @@
+from __future__ import annotations
+
+import pytest
+
+from pdfrest import AsyncPdfRestClient, PdfRestApiError, PdfRestClient
+from pdfrest.models import PdfRestFile
+
+from ..resources import get_test_resource_path
+
+
+@pytest.fixture(scope="module")
+def uploaded_docx_for_pdf(
+    pdfrest_api_key: str,
+    pdfrest_live_base_url: str,
+) -> PdfRestFile:
+    resource = get_test_resource_path("report.docx")
+    with PdfRestClient(
+        api_key=pdfrest_api_key,
+        base_url=pdfrest_live_base_url,
+    ) as client:
+        return client.files.create_from_paths([resource])[0]
+
+
+@pytest.fixture(scope="module")
+def uploaded_html_url_for_pdf(
+    pdfrest_api_key: str,
+    pdfrest_live_base_url: str,
+) -> str:
+    resource = get_test_resource_path("sample.html")
+    with PdfRestClient(
+        api_key=pdfrest_api_key,
+        base_url=pdfrest_live_base_url,
+    ) as client:
+        uploaded = client.files.create_from_paths([resource])[0]
+        return str(uploaded.url)
+
+
+@pytest.mark.parametrize(
+    ("output_name", "compression", "downsample"),
+    [
+        pytest.param(None, None, None, id="defaults"),
+        pytest.param("live-docx", "lossless", 600, id="customized"),
+    ],
+)
+def test_live_convert_to_pdf_success(
+    pdfrest_api_key: str,
+    pdfrest_live_base_url: str,
+    uploaded_docx_for_pdf: PdfRestFile,
+    output_name: str | None,
+    compression: str | None,
+    downsample: int | None,
+) -> None:
+    kwargs: dict[str, object] = {}
+    if output_name is not None:
+        kwargs["output"] = output_name
+    if compression is not None:
+        kwargs["compression"] = compression
+    if downsample is not None:
+        kwargs["downsample"] = downsample
+
+    with PdfRestClient(
+        api_key=pdfrest_api_key,
+        base_url=pdfrest_live_base_url,
+    ) as client:
+        response = client.convert_to_pdf(uploaded_docx_for_pdf, **kwargs)
+
+    assert response.output_files
+    output_file = response.output_file
+    assert output_file.type == "application/pdf"
+    assert output_file.size > 0
+    assert response.warning is None
+    assert str(response.input_id) == str(uploaded_docx_for_pdf.id)
+    if output_name is not None:
+        assert output_file.name.startswith(output_name)
+    else:
+        assert output_file.name.endswith(".pdf")
+
+
+@pytest.mark.asyncio
+async def test_live_async_convert_to_pdf_success(
+    pdfrest_api_key: str,
+    pdfrest_live_base_url: str,
+    uploaded_docx_for_pdf: PdfRestFile,
+) -> None:
+    async with AsyncPdfRestClient(
+        api_key=pdfrest_api_key,
+        base_url=pdfrest_live_base_url,
+    ) as client:
+        response = await client.convert_to_pdf(
+            uploaded_docx_for_pdf,
+            output="async-docx",
+            tagged_pdf=True,
+        )
+
+    assert response.output_files
+    output_file = response.output_file
+    assert output_file.name.startswith("async-docx")
+    assert output_file.type == "application/pdf"
+    assert output_file.size > 0
+    assert response.warning is None
+    assert str(response.input_id) == str(uploaded_docx_for_pdf.id)
+
+
+def test_live_convert_urls_to_pdf_success(
+    pdfrest_api_key: str,
+    pdfrest_live_base_url: str,
+    uploaded_html_url_for_pdf: str,
+) -> None:
+    with PdfRestClient(
+        api_key=pdfrest_api_key,
+        base_url=pdfrest_live_base_url,
+    ) as client:
+        response = client.convert_urls_to_pdf(
+            [uploaded_html_url_for_pdf],
+            output="live-html",
+            page_size="letter",
+            page_margin="8mm",
+            page_orientation="portrait",
+            web_layout="desktop",
+        )
+
+    assert response.output_files
+    output_file = response.output_file
+    assert output_file.type == "application/pdf"
+    assert output_file.size > 0
+    assert response.warning is None
+    assert str(response.input_id)
+    assert output_file.name.startswith("live-html")
+
+
+def test_live_convert_to_pdf_invalid_downsample(
+    pdfrest_api_key: str,
+    pdfrest_live_base_url: str,
+    uploaded_docx_for_pdf: PdfRestFile,
+) -> None:
+    with (
+        PdfRestClient(
+            api_key=pdfrest_api_key,
+            base_url=pdfrest_live_base_url,
+        ) as client,
+        pytest.raises(PdfRestApiError, match=r"(?i)downsample"),
+    ):
+        client.convert_to_pdf(
+            uploaded_docx_for_pdf,
+            extra_body={"downsample": 0},
+        )
+
+
+@pytest.mark.asyncio
+async def test_live_async_convert_urls_to_pdf_invalid_page_size(
+    pdfrest_api_key: str,
+    pdfrest_live_base_url: str,
+    uploaded_html_url_for_pdf: str,
+) -> 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_size|page size"):
+            await client.convert_urls_to_pdf(
+                [uploaded_html_url_for_pdf],
+                extra_body={"page_size": "poster"},
+            )

tests/resources/sample.html

@@ -0,0 +1,10 @@
+<!doctype html>
+<html>
+  <head>
+    <title>pdfRest HTML Sample</title>
+  </head>
+  <body>
+    <h1>Hello from pdfRest</h1>
+    <p>This is a sample HTML page used for live convert-to-pdf testing.</p>
+  </body>
+</html>