FAQ.md

Frequently Asked Questions

Contents

• Overview
  • What are approval tests?
  • How do they differ from unit tests?
  • Why are approval tests particularly good for testing legacy code?
• Test Frameworks
  • Do I need to use the Catch2 in the Approval Tests repo?
  • Does it integrate with other unit testing libraries?
• Writing Tests
  • I wrote a test, but the output file has loads of stuff I'm not interested in

If you would like us to add any more questions here, please contact us via the Contributing page.

Overview

What are approval tests?

How do they differ from unit tests?

Why are approval tests particularly good for testing legacy code?

Test Frameworks

Do I need to use the Catch2 in the Approval Tests repo?

No, you can use your own. We use this copy of Catch2 to run our own tests.

Does it integrate with other unit testing libraries?

Writing Tests

I wrote a test, but the output file has loads of stuff I'm not interested in

Things to say:

• Yes, it's a common problem
• Readability of the output is important
• Someone reviewing a test failure needs to understand the purpose and intent of the test
• Recommendation: write your own formatting that's specific to particular tests - see To String for examples.

--

Back to User Guide