Compare PDF Documents

Compares the text of two PDF files and reports their differences in a test run.

Behaviour

Risk: Low · Idempotent: Yes · Safe to retry: Yes · Recovery: Not replayed after a crash

Package Testing activities VeloPhex.Testing.Activities 0.7.1-rc.7 · Supported (Core profile) · type id velophex.testing.comparePdfDocuments

Properties#

Input#

Baseline Path#

BaselinePath · String · Required · Default: Not specified in package metadata

The expected PDF file.

Target Path#

TargetPath · String · Required · Default: Not specified in package metadata

The PDF file compared with the baseline.

Comparison Type#

ComparisonType · String · Optional · Default: Line

Compare line by line, word by word (spacing ignored) or character by character.

Allowed values: Line, Word, Character.

Rules#

Rules · IEnumerable<ComparisonRule> · Optional · Default: Not specified in package metadata

Comparison rules whose matches are left out of both texts before they are compared.

Continue On Failure#

ContinueOnFailure · Boolean · Optional · Default: Not specified in package metadata

Record a failed comparison and go on instead of ending the run.

Output File Path#

OutputFilePath · String · Optional · Default: Not specified in package metadata

A text file the differences are written to, one per line.

Output#

Differences#

Differences · List<TextDifference> · Output

What only the baseline has (Deleted) and what only the target has (Inserted).

Result#

Result · Boolean · Output

Whether the two are the same after the rules.

Retry and risk#

This activity is safe to retry: running it again after a transient failure does not repeat a side effect. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.

Every activity also has the engine's common properties: Timeout and Continue On Error.

Related activities#

• Attach Document
• Compare Text
• Create Comparison Rule
• Verify Expression
• Verify Expression With Operator
• Verify Range

Generated from VeloPhex.Testing.Activities 0.7.1-rc.7. Category: Testing. Keywords: compare, diff, pdf, document, baseline, verify, assert.

Properties

Input

Output

Retry and risk

Related activities