Awesome

<img src="/src/icon.png" height="30px"> Verify.QuestPDF

Extends Verify to allow verification of documents via QuestPDF.

See Milestones for release notes.

Designed to help assert the output of projects using QuestPDF to generate PDFs.

NuGet package

https://nuget.org/packages/Verify.QuestPDF/

Usage

<a id='snippet-enable'></a>

[ModuleInitializer]
public static void Init()
{
    VerifyImageMagick.RegisterComparers(0.015);
    VerifyQuestPdf.Initialize();
}

^{<a href='/src/Tests/ModuleInitializer.cs#L3-L12' title='Snippet source file'>snippet source</a> | <a href='#snippet-enable' title='Start of snippet'>anchor</a>}

This sample uses Verify.ImageMagick to ignore small rendering differences that are expected between differens operating systesm.

Other compares options:

• https://github.com/VerifyTests/Verify.ImageHash
• https://github.com/VerifyTests/Verify.ImageMagick
• https://github.com/VerifyTests/Verify.Phash
• https://github.com/VerifyTests/Verify.ImageSharp.Compare

Code that generates a document

<a id='snippet-GenerateDocument'></a>

static IDocument GenerateDocument() =>
    Document.Create(container =>
    {
        container.Page(AddPage);
        container.Page(AddPage);
    });

static void AddPage(PageDescriptor page)
{
    page.Size(PageSizes.A5);
    page.Margin(1, Unit.Centimetre);
    page.PageColor(Colors.Grey.Lighten3);
    page.DefaultTextStyle(_ => _.FontSize(20));

    page.Header()
        .Text("Hello PDF!")
        .SemiBold().FontSize(36);

    page.Content()
        .Column(_ => _.Item()
            .Text(Placeholders.LoremIpsum()));

    page.Footer()
        .AlignCenter()
        .Text(_ =>
        {
            _.Span("Page ");
            _.CurrentPageNumber();
        });
}

^{<a href='/src/Tests/Samples.cs#L39-L72' title='Snippet source file'>snippet source</a> | <a href='#snippet-GenerateDocument' title='Start of snippet'>anchor</a>}

Verify a Document

<a id='snippet-VerifyDocument'></a>

[Test]
public Task VerifyDocument()
{
    var document = GenerateDocument();
    return Verify(document);
}

^{<a href='/src/Tests/Samples.cs#L4-L13' title='Snippet source file'>snippet source</a> | <a href='#snippet-VerifyDocument' title='Start of snippet'>anchor</a>}

Results

Metadata

<a id='snippet-Samples.VerifyDocument.verified.txt'></a>

{
  Pages: 2,
  Metadata: {
    CreationDate: DateTimeOffset_1,
    ModifiedDate: DateTimeOffset_2
  },
  Settings: {
    ContentDirection: LeftToRight,
    PdfA: false,
    ImageCompressionQuality: High,
    ImageRasterDpi: 288
  }
}

^{<a href='/src/Tests/Samples.VerifyDocument.verified.txt#L1-L13' title='Snippet source file'>snippet source</a> | <a href='#snippet-Samples.VerifyDocument.verified.txt' title='Start of snippet'>anchor</a>}

Pdf as image

PagesToInclude

To render only a defined number of pages at the start of a document:

<a id='snippet-PagesToInclude'></a>

[Test]
public Task PagesToInclude()
{
    var document = GenerateDocument();
    return Verify(document)
        .PagesToInclude(1);
}

^{<a href='/src/Tests/Samples.cs#L15-L25' title='Snippet source file'>snippet source</a> | <a href='#snippet-PagesToInclude' title='Start of snippet'>anchor</a>}

Dynamic

To dynamically control what pages are rendered:

<a id='snippet-PagesToIncludeDynamic'></a>

[Test]
public Task PagesToIncludeDynamic()
{
    var document = GenerateDocument();
    return Verify(document)
        .PagesToInclude(pageNumber => pageNumber == 2);
}

^{<a href='/src/Tests/Samples.cs#L27-L37' title='Snippet source file'>snippet source</a> | <a href='#snippet-PagesToIncludeDynamic' title='Start of snippet'>anchor</a>}