ApprovalTests

Contents

• Features
• How Tos
• Reference
• Configuration
• Explanations
• Main concepts for ApprovalTests

Features

New Features documented here

How Tos

• use Printable Wrappers
• use Parameterized Tests
• use MachineNameSpecific Tests
• verify Images
• remove inconsistent output using Scrubbers
• have Consistent Time Zones in your tests
• separate and test Data Access and Rendering
• show nulls in verifyAsJson
• test a variety of values
• capture .received. files from CI
• Create customized verify methods

Reference

• AWTApprovals
• Approval File Names
• CombinationApprovals
• FrontLoadedReporters
• Naming of .approved. files
• Options
• PackageSettings
• Story Boards
• The Verify API

Configuration

Configuration of ApprovalTests mainly occurs via @Annotations, PackageSettings, and Options. Read More about it here

Note: We are following Daniele Procida's theory of documentation

Explanations

• Why we don't use checked exceptions
• Best configuration practices
• Benefits of different reporters

Main concepts for ApprovalTests

1. Verify verify(object) is the main pattern to use in ApprovalTests.
2. Options allow you to configure many aspects of Approvals
3. Reporters (often diff tools) are called on test failure to help you determine what went wrong.
4. Writers write to a file
5. Namers figure out what the file should be called and where it is located

---

Back to User Guide