README.md

ApprovalTests.cpp User Guide

To get the most out of ApprovalTests, start with the Tutorial. Once you're up and running, consider the following reference material.

Contents

• Preparation
  • Introduction
  • Setup
• Use
  • Writing Tests
  • Test Frameworks
  • Customising behaviour
  • Common Challenges
  • Common Scenarios
• How-to Guides
• Miscellaneous
  • Build Systems
  • Extras
  • Advanced Topics
  • Suggested Examples

Preparation

Introduction

• Overview
• Approval Testing (the concept)
• What is Approval Testing?
• Why Approval Tests?
• The Path to Approval Testing
• Glossary

Setup

There are three different places you might be starting your setup from.

Here's how to set up from:

• I have nothing
• I have code but no tests
• I have tests and code and want to add Approval Tests

Use

Writing Tests

• Tutorial
• Testing single objects
• Testing containers
• Testing exceptions
• Testing combinations - containers of containers (of containers...)
• To String
• Worked example of getting to 'make the thing; verify the thing' - 'do; verify'
• Features - recent additions

Test Frameworks

• Using Approval Tests With Catch
• Using Approval Tests With Google Tests
• Using Approval Tests With Doctest
• Using Approval Tests With [Boost].UT
• Supporting a new test framework

Customising behaviour

• Reporters
• Custom Comparators
• Writers
• Namers
• Configuration
• All Customizations of Approval Tests

Common Challenges

• Unstable output, e.g. with Dates and Times
• Non-deterministic code
• Multiple output files per test
• Testing images
• Embedded development

Common Scenarios

• Non-graphical environments
• Build Machines and Continuous Integration servers

How-to Guides

• How To Use A Custom Reporter
• How to Submit a New Reporter to ApprovalTests.

Miscellaneous

Build Systems

• CMake Integration
• Conan Integration

Extras

• Frequently Asked Questions
• Utilities
• Videos
• Troubleshooting
  • Troubleshooting Misconfigured Build
  • Troubleshooting Misconfigured Main
• 4 benefits of testing
  • Spec
  • Feedback
  • Regression
  • Granularity

Advanced Topics

• Contributing to ApprovalTests.cpp

Suggested Examples

• ApprovalTests