mirror of
https://github.com/DRYTRIX/TimeTracker.git
synced 2026-05-21 05:40:26 -05:00
Dries Peeters
b0809e2f90
- Add optional embedding of EN 16931 UBL XML in invoice PDFs (ZugFerd/Factur-X) when 'Embed EN 16931 XML in invoice PDFs' is enabled in Admin > Peppol e-Invoicing. Exported PDFs then contain ZUGFeRD-invoice.xml for hybrid human- and machine-readable invoices; same UBL as Peppol, usable via Peppol or email. - New setting invoices_zugferd_pdf (migration 128), pikepdf dependency, and app.utils.zugferd helper (best-effort supplier/customer from Settings and client). - Wire embed in export_invoice_pdf (and fallback path); admin checkbox and persistence. - Docs: PEPPOL_EINVOICING.md retitled to 'Peppol and ZugFerd', new section for ZugFerd embedding; README and CHANGELOG updated; migration 128 noted. - Tests: test_zugferd.py (embed adds attachment with expected XML; invalid PDF returns original bytes and error).
132 lines
4.6 KiB
Python
132 lines
4.6 KiB
Python
"""Tests for ZugFerd/Factur-X: embedding EN 16931 UBL in invoice PDFs."""
|
|
from datetime import date, timedelta
|
|
from decimal import Decimal
|
|
import io
|
|
|
|
import pytest
|
|
|
|
from app import db
|
|
from app.models import Client, Invoice, InvoiceItem, Project, User
|
|
from app.utils.zugferd import ZUGFERD_EMBEDDED_FILENAME, embed_zugferd_xml_in_pdf
|
|
|
|
|
|
@pytest.mark.unit
|
|
def test_embed_zugferd_xml_in_pdf_adds_attachment_and_xml_content(app):
|
|
"""Embed step adds ZUGFeRD-invoice.xml to PDF and XML contains invoice data."""
|
|
try:
|
|
import pikepdf
|
|
except ImportError:
|
|
pytest.skip("pikepdf not installed")
|
|
|
|
with app.app_context():
|
|
user = User(username="zugferduser", role="user", email="zugferd@example.com")
|
|
user.is_active = True
|
|
user.set_password("password123")
|
|
db.session.add(user)
|
|
|
|
client = Client(name="ZugFerd Client", email="client@example.com", address="Addr 1")
|
|
client.set_custom_field("peppol_endpoint_id", "9915:DE123456789")
|
|
client.set_custom_field("peppol_scheme_id", "9915")
|
|
db.session.add(client)
|
|
db.session.commit()
|
|
|
|
project = Project(
|
|
name="ZugFerd Project",
|
|
client_id=client.id,
|
|
billable=True,
|
|
hourly_rate=Decimal("80.00"),
|
|
)
|
|
project.status = "active"
|
|
db.session.add(project)
|
|
db.session.commit()
|
|
|
|
inv = Invoice(
|
|
invoice_number="INV-ZUG-001",
|
|
project_id=project.id,
|
|
client_name=client.name,
|
|
client_id=client.id,
|
|
issue_date=date.today(),
|
|
due_date=date.today() + timedelta(days=30),
|
|
created_by=user.id,
|
|
currency_code="EUR",
|
|
subtotal=Decimal("100.00"),
|
|
tax_rate=Decimal("20.00"),
|
|
tax_amount=Decimal("20.00"),
|
|
total_amount=Decimal("120.00"),
|
|
)
|
|
db.session.add(inv)
|
|
db.session.add(
|
|
InvoiceItem(
|
|
invoice_id=inv.id,
|
|
description="Consulting",
|
|
quantity=Decimal("1"),
|
|
unit_price=Decimal("100.00"),
|
|
total_amount=Decimal("100.00"),
|
|
)
|
|
)
|
|
db.session.commit()
|
|
|
|
settings = __import__("app.models", fromlist=["Settings"]).Settings.get_settings()
|
|
if not getattr(settings, "company_name", None):
|
|
settings.company_name = "Test Company"
|
|
if not getattr(settings, "peppol_sender_endpoint_id", None):
|
|
settings.peppol_sender_endpoint_id = "9915:BE111111111"
|
|
if not getattr(settings, "peppol_sender_scheme_id", None):
|
|
settings.peppol_sender_scheme_id = "9915"
|
|
db.session.commit()
|
|
|
|
# Minimal valid PDF (one blank page)
|
|
pdf = pikepdf.Pdf.new()
|
|
pdf.add_blank_page(page_size=(595, 842))
|
|
buf = io.BytesIO()
|
|
pdf.save(buf)
|
|
pdf.close()
|
|
pdf_bytes = buf.getvalue()
|
|
|
|
out_bytes, err = embed_zugferd_xml_in_pdf(pdf_bytes, inv, settings)
|
|
assert err is None
|
|
assert len(out_bytes) > len(pdf_bytes)
|
|
|
|
# Open result and check embedded file
|
|
result = pikepdf.open(io.BytesIO(out_bytes))
|
|
assert ZUGFERD_EMBEDDED_FILENAME in result.attachments
|
|
attached = result.attachments[ZUGFERD_EMBEDDED_FILENAME].get_file()
|
|
xml_content = attached.read().decode("utf-8")
|
|
result.close()
|
|
|
|
assert "<Invoice" in xml_content or "Invoice" in xml_content
|
|
assert "INV-ZUG-001" in xml_content
|
|
assert "120" in xml_content
|
|
|
|
|
|
@pytest.mark.unit
|
|
def test_embed_zugferd_returns_original_pdf_on_embed_failure(app):
|
|
"""When embedding fails (e.g. invalid PDF), return original bytes and error message."""
|
|
with app.app_context():
|
|
from types import SimpleNamespace
|
|
settings = __import__("app.models", fromlist=["Settings"]).Settings.get_settings()
|
|
# Minimal invoice-like object; build_peppol_ubl_invoice_xml only needs a few attrs
|
|
inv = SimpleNamespace(
|
|
id=1,
|
|
invoice_number="INV-X",
|
|
issue_date=date.today(),
|
|
due_date=date.today(),
|
|
currency_code="EUR",
|
|
subtotal=Decimal("0"),
|
|
tax_rate=Decimal("0"),
|
|
tax_amount=Decimal("0"),
|
|
total_amount=Decimal("0"),
|
|
notes=None,
|
|
buyer_reference=None,
|
|
project=None,
|
|
client=None,
|
|
items=[],
|
|
expenses=[],
|
|
extra_goods=[],
|
|
)
|
|
invalid_pdf_bytes = b"not a valid pdf"
|
|
|
|
out_bytes, err = embed_zugferd_xml_in_pdf(invalid_pdf_bytes, inv, settings)
|
|
assert err is not None
|
|
assert out_bytes == invalid_pdf_bytes
|