• Breaking changes
  • None
• New features
  • None
• Bug fixes
  • None
• Fixed compilation warnings
  • Fix compiler warning C4459 in MSVC with /W4 (See #193)
  • Fix compilation failure with clang13 due to -Werror/-Wdeprecated-copy-with-dtor (#194)

• Breaking changes
  • None
• New features
  • None
• Bug fixes
  • Using kdiff3 as diff tool, users no longer have to specify name of output file after merge (#191 - thanks @bjosv)
• Other changes
  • None

• Breaking changes
  • None
• New features
  • EmptyFileCreatorByType::registerCreator() - new approved file creation is now customizable for individual file extensions.
• Bug fixes
  • None
• Other changes
  • None

• Breaking changes
  • None
• New features
  • You can now customize how Test Names are Converted to Valid FileNames (#97)
  • You can now customize how Empty file are created. This is useful when verifying binary files. (#172)
• Bug fixes
  • None
• Other changes
  • Add a copyright statement to the released single header (#189)
  • All code snippets in documentation include the ApprovalTests:: qualification, so example code can be copied and pasted more easily. (#115)

• Breaking changes
  • None
• New features
  • Storyboard:
    Print the changes to an object over time
  • Grid:
    Create 2D text in a grid format
  • Vcpkg integration added:
    See Vcpkg Integration docs (vcpkg #18338 - thanks @strega-nil!)
• Bug fixes
  • None
• Other changes
  • CygWin and MinGW CI builds moved to GitHub Actions (#181)

See also the v.10.9.0 changelog for the full list of major new features, bug fixes and other improvements.

• Breaking changes
  • None
• New features
  • None
• Bug fixes
  • Fix compilation error with fmt library integration that was introduced in the v.10.9.0 release (#180)
• Other changes
  • None

• Breaking changes
  • None
• New features
  • Custom template namer: see TemplatedCustomNamer. (#149)
    • This gives great flexibility
    • It also introduces the ability to run Approval Tests on machines that do not have the source code, such as when doing cross-compilation.
  • Options.withNamer(): Options now has the ability to specify a custom namer.
  • New Path utility class: see Path.h and Path.cpp
• Bug fixes
  • Calls to Approvals::verify() and related methods no longer spuriously pass if the received and approved filenames are identical (#178)
  • TextDiffReporter no longer throws when reporting that files differ.
    • This improves the content of logs when running Approval Tests in CI builds. (#106)
  • ApprovalTests.cpp's tests and examples should now never be built when used as a sub-project. (#179)
• Other changes
  • Added new documentation sections:
    • Code to copy for your first Boost.Test Approvals test
    • Code to copy for your first Catch2 Approvals test
    • Code to copy for your first CppUTest Approvals test
    • Code to copy for your first doctest Approvals test
    • Code to copy for your first Google Test Approvals test
    • Code to copy for your first [Boost].UT Approvals test
  • Removed CI builds for clang and gcc < v9
  • Some of our internal tests now use gulrak's filesystem. Thanks @gulrak!

• Breaking changes
  • None
• New features
  • None
• Bug fixes
  • Ninja builds now work when inside source tree. (#171)
    • The entire Misconfigured Builds page of workarounds is no needed, but is retained for those using older releases.
• Other changes
  • None

• Breaking changes
  • None
• New features
  • None
• Bug fixes
  • Fix incorrect line '#include <ApprovalTests.hpp>' in single header, that was present in v.10.6.0 and v.10.7.0 (#170)
• Other changes
  • None

• Breaking changes
  • None
• New features
  • Optional header argument added to CombinationApprovals
• Bug fixes
  • None
• Other changes
  • None

• Breaking changes
  • None
• New features
  • Approvals::verify() counts as an assertion in test frameworks. (#148)
    • This works in all currently-supported test frameworks.
    • Previously, Approvals wouldn't register as an assertion, giving misleading messages and reporting, and sometimes causing a test framework to complain that there were no assertions.
  • FrameworkIntegrations class
    • We now have a centralised portal, FrameworkIntegrations, to all the places that you need to use, in order to add support for a new test framework.
• Bug fixes
  • None
• Other changes
  • None

• Breaking changes
  • None
• New features
  • None
• Bug fixes
• Other changes
  • Update Boost.ut integration to work with latest version of that library.
    (A change after Boost.ut v1.1.8 resulted in a build error - this is now fixed)
  • GitHub Actions CI build added for our Python code (#165)
  • VS2017 Debug x64 build of ApprovalTests.cpp.StarterProject gave "C1128: number of sections exceeded object file format limit: compile with /bigobj" (ApprovalTests.cpp.StarterProject#16)
  • Removed undocumented ability to verify std::wstring and wchar_t*. This gave compiler warnings on C++17 and above, and did not work on Visual Studio. (#154, which contains the deleted code for future reference)

• Breaking changes
  • None
• New features
  • Support for selecting Reporter at run-time.
    See How to Select a Reporter with an Environment Variable . (#99, thanks @alepez)
• Bug fixes
  • None
• Other changes
  • Fix -Wdeprecated-copy-dtor warnings (#163, thanks @nlohmann)

• Breaking changes
  • None
• New features
  • Add support for CppUTest. See Using Approval Tests With CppUTest (#159, thanks to @jwgrenning and @basvodde)
• Bug fixes
  • None
• Other changes
  • Easier maintenance of documentation: Files in the User Guide can now be edited directly, instead of needing to find the matching mdsource/Blah.source.md file (#158)

• Breaking changes

  • None

• New features

  • Add initializer_list support to Approvals::verifyAll() (#152, thanks @alepez)
    For example:

        Approvals::verifyAll({10, 20, 30});
  

• Bug fixes

  • None

• Other changes

  • Overloads of Approvals::verifyAll() that previously only accepted std::vector now accept all container types (#152, thanks @alepez)
  • Better readability of the groups of member methods on Read the Docs, for example in Approving Objects (#153)

Note: because DateUtilities is brand-new and barely used, we are releasing this as a patch release, to properly convey risk.

• Breaking changes
  • time_t DateUtilities::toUTC(std::tm& timeinfo) renamed to DateUtilities::toUtc()
• New features
  • Added tm DateUtilities::toUtc(time_t& tt)
• Bug fixes
  • Fix Visual Studio compiler warning C4996 due to use of gmtime() (#150)
    • This also fixes the Visual Studio builds of the Starter Project, which failed to compile due to the C4996 warning being treated as an error
• Other changes
  • None

• Breaking changes
  • None
• New features
  • Add DateUtils to easily create and print dates. See DateUtils
• Bug fixes
  • Fix infinite loop with empty regex (#147)
• Other changes
  • Visual Studio improvements in ApprovalTests.cpp.StarterProject:
    • Visual Studio 2017: Fix build failures in several configurations (#12)
    • Visual Studio 2017: Add Tutorial.cpp (#14)
    • Visual Studio 2019: Add build files for Visual Studio 2019 (#13)
    • Build all VS 2017 and VS 2019 configurations in GitHub actions (#15)

• Breaking changes
  • None
• New features
  • None
• Bug fixes
  • Fix confusing compiler error messages when porting to Options (#140)
  • Add help message to top of release header, to help when misconfigured main gives missing symbols (#144)
• Other changes
  • The User Guide on GitHub now has (manually maintained):
    • table of contents
    • new "C++ Reference" section, with links to the API documentation on Read the Docs.
  • Improved documentation pages:
    • Conan Integration
    • How to Release now has a picture of the steps executed, as we update 3 repos when releasing now
  • New documentation pages:
    • Maintaining the Docs
    • Building the Docs

• Breaking changes
  • None
• New features
  • None
• Bug fixes
  • None
• Other changes
  • Improved Compilation Speeds (#142)

• Breaking changes
  • None
• New features
  • ApprovalTests::verifyExistingFile() now supports scrubbers (#141)
• Bug fixes
  • None
• Other changes
  • None

• Breaking changes
  • None
• New features
  • None
• Bug fixes
  • Fixed compilation error with Approvals::verify(writer, Options) (#139)
• Other changes
  • None

DON'T PANIC!

We expect most of our users to have no problem with this upgrade. Changes are only needed when:

1. you are passing in a specific reporter, which is usually an infrequent and temporary coding state,
2. you call verifyWithExtension(object, ".json") is now
   Approvals::verify(object, Options().fileOptions().withFileExtension(".json"))

Removing verify(..., Reporter)

This is the fourth and final of a series of rapid releases, to make small steps in deprecating passing in a Reporter object, in favor of an Options object, to the verify*() methods. See Why We Are Converting To Options for easy ways to update your code.

1. deprecation warnings are off: users can opt-in (v.8.7.0)
2. deprecation warnings are on: users can opt-out (v.8.9.1)
3. deprecation warnings are forced, code still exists (v.8.9.2)
4. the deprecated methods are hidden: users can opt-in (v.9.0.0)
5. the deprecated methods are removed (v.10.0.0) <== you are here

• Breaking changes

  • Removed methods:
    • Approvals::verify(..., Reporter)
    • Approvals::verifyAll(..., Reporter)
    • Approvals::verifyExistingFile(..., Reporter)
    • Approvals::verifyExceptionMessage(..., Reporter)
    • Approvals::verifyWithExtension(...)
    • CombinationApprovals::verifyAllCombinations(Reporter, ...)
  • Removed macros:
    • APPROVAL_TESTS_HIDE_DEPRECATED_CODE
    • APPROVALTESTS_VERSION
    • APPROVALTESTS_VERSION_MAJOR
    • APPROVALTESTS_VERSION_MINOR
    • APPROVALTESTS_VERSION_PATCH
    • APPROVALTESTS_VERSION_STR
    • APPROVALS_CATCH_DISABLE_FILE_MACRO_CHECK
  • The following macros have been changed.

| Old (removed) | New | | ------------------------------------------ | ----------------------------------------- | | APPROVALTESTS_VERSION | APPROVAL_TESTS_VERSION | | APPROVALTESTS_VERSION_MAJOR | APPROVAL_TESTS_VERSION_MAJOR | | APPROVALTESTS_VERSION_MINOR | APPROVAL_TESTS_VERSION_MINOR | | APPROVALTESTS_VERSION_PATCH | APPROVAL_TESTS_VERSION_PATCH | | APPROVALTESTS_VERSION_STR | APPROVAL_TESTS_VERSION_STR | | APPROVALS_CATCH_DISABLE_FILE_MACRO_CHECK | APPROVAL_TESTS_DISABLE_FILE_MACRO_CHECK |

• New features
  • None
• Bug fixes
  • None
• Other changes
  • None

DON'T PANIC!

We expect most of our users to have no problem with this upgrade. Changes are only needed when:

1. you are passing in a specific reporter, which is usually an infrequent and temporary coding state,
2. you call verifyWithExtension(object, ".json") is now
   Approvals::verify(object, Options().fileOptions().withFileExtension(".json"))

Deprecating verify(..., Reporter)

This is the third of a series of rapid releases, to make small steps in deprecating passing in a Reporter object, in favor of an Options object, to the verify*() methods. See Why We Are Converting To Options for easy ways to update your code.

1. deprecation warnings are off: users can opt-in (v.8.7.0)
2. deprecation warnings are on: users can opt-out (v.8.9.1)
3. deprecation warnings are forced, code still exists (v.8.9.2)
4. the deprecated methods are hidden: users can opt-in (v.9.0.0) <== you are here
5. the deprecated methods are removed

• Breaking changes
  • Hidden methods:
    • Approvals::verify(..., Reporter)
    • Approvals::verifyAll(..., Reporter)
    • Approvals::verifyExistingFile(..., Reporter)
    • Approvals::verifyExceptionMessage(..., Reporter)
    • Approvals::verifyWithExtension(...)
    • CombinationApprovals::verifyAllCombinations(Reporter, ...)
  • Hidden macros:
    • APPROVAL_TESTS_HIDE_DEPRECATED_CODE
    • APPROVALTESTS_VERSION
    • APPROVALTESTS_VERSION_MAJOR
    • APPROVALTESTS_VERSION_MINOR
    • APPROVALTESTS_VERSION_PATCH
    • APPROVALTESTS_VERSION_STR
    • APPROVALS_CATCH_DISABLE_FILE_MACRO_CHECK
  • The following macros have been changed.

| Old (hidden) | New | | ------------------------------------------ | ----------------------------------------- | | APPROVALTESTS_VERSION | APPROVAL_TESTS_VERSION | | APPROVALTESTS_VERSION_MAJOR | APPROVAL_TESTS_VERSION_MAJOR | | APPROVALTESTS_VERSION_MINOR | APPROVAL_TESTS_VERSION_MINOR | | APPROVALTESTS_VERSION_PATCH | APPROVAL_TESTS_VERSION_PATCH | | APPROVALTESTS_VERSION_STR | APPROVAL_TESTS_VERSION_STR | | APPROVALS_CATCH_DISABLE_FILE_MACRO_CHECK | APPROVAL_TESTS_DISABLE_FILE_MACRO_CHECK |

• New features
  • None
• Bug fixes
  • None
• Other changes
  • APPROVAL_TESTS_HIDE_DEPRECATED_CODE is now enabled by default.

DON'T PANIC!

We expect most of our users to have no problem with this upgrade. Source code is totally backwards-compatible, as long as you don't treat compiler warnings as errors. Even if you do, it only applies when:

1. you are passing in a specific reporter, which is usually an infrequent and temporary coding state,
2. you call verifyWithExtension().

Deprecating verify(..., Reporter)

This is the second of a series of rapid releases, to make small steps in deprecating passing in a Reporter object, in favor of an Options object, to the verify*() methods. See Why We Are Converting To Options for easy ways to update your code.

1. deprecation warnings are off: users can opt-in (v.8.7.0)
2. deprecation warnings are on: users can opt-out (v.8.9.1)
3. deprecation warnings are forced, code still exists (v.8.9.2) <== you are here
4. the deprecated methods are hidden: users can opt-in
5. the deprecated methods are removed

• Breaking changes
  • None
• New features
  • None
• Bug fixes
  • None
• Other changes
  • APPROVAL_TESTS_SHOW_DEPRECATION_WARNINGS is now ignored. Warnings are always shown when using the verify*() methods that took a Reporter.

DON'T PANIC!

We expect most of our users to have no problem with this upgrade. Source code is totally backwards-compatible, as long as you don't treat compiler warnings as errors. Even if you do, it only applies when:

1. you are passing in a specific reporter, which is usually an infrequent and temporary coding state,
2. you call verifyWithExtension().

Deprecating verify(..., Reporter)

This is the first of a series of rapid releases, to make small steps in deprecating passing in a Reporter object, in favor of an Options object, to the verify*() methods. See Why We Are Converting To Options for easy ways to update your code.

1. deprecation warnings are off: users can opt-in (v.8.7.0)
2. deprecation warnings are on: users can opt-out (v.8.9.1) <== you are here
3. deprecation warnings are forced, code still exists
4. the deprecated methods are hidden: users can opt-in
5. the deprecated methods are removed

• Breaking changes
  • None
• New features
  • None
• Bug fixes
  • None
• Other changes
  • APPROVAL_TESTS_SHOW_DEPRECATION_WARNINGS is now enabled by default.

• Breaking changes
  • None
• New features
  • Added Scrubbing using Regular Expressions (regex).
  • Add support for CLion diff tool on Mac and Linux. See #138 for limitations.
• Bug fixes
  • None
• Other changes
  • None

• Breaking changes
  • None
• New features
  • None
• Bug fixes
  • None
• Other changes
  • Add support for doctest 2.3.8 (#135, thank you @YarikTH)
  • This project can now be built using a {fmt} source tree (#136)

• Breaking changes
  • None
• New features
  • FmtApprovals (#124) Added integration with the {fmt} library.
    See How to Use the Fmt Library To Print Objects.
    Thanks @alepez
• Bug fixes
  • None
• Other changes
  • None

• Breaking changes
  • None
• New features
  • None
• Bug fixes
  • Fix compilation of TCombinationApprovals on C++14 and above, when deprecation warnings are enabled (#132)
• Other changes
  • None

See the v.8.7.0 milestone for the full list of changes.

• Breaking changes
  • Planned deprecation: The overloads of verify(), verifyAll() and verifyAllCombinations() which take a Reporter have been deprecated.
    • The Reporter argument is replaced by Options - see below.
    • By default, there is currently no change, but this release marks the start of the plan to remove the deprecated methods.
  • If you happen to have specialised StringUtils::toString(), you would now need to specialize StringMaker::toString() instead.
    • Note: this was previously unsupported behavior, so we are not bumping the major version number.
    • Here is how to update your code:

template <>
-std::string ApprovalTests::StringUtils::toString(const StringMakerPrintable& printable)
+std::string ApprovalTests::StringMaker::toString(const StringMakerPrintable& printable)

• New features
  • New Scrubber feature for working with non-deterministic output. (#126, thank you @abdulg, @haraldreingruber, @jawn)
  • New Options class provides consistent interface for customising the following in all verify(), verifyAll() and verifyAllCombinations() calls:
    • Reporter: see Why We Are Converting To Options
    • Scrubber: see How to Scrub Non-Deterministic Output
    • File extensions now customizable with verifyAll() and verifyAllCombinations(): See File Extensions (#127)
  • New mechanics for String conversions (thank you @alepez)
    • The class Approvals is now an alias for TApprovals< ToStringCompileTimeOptions< StringMaker > >
    • CombinationApprovals is now an alias for the class TCombinationApprovals< ToStringCompileTimeOptions<APPROVAL_TESTS_DEFAULT_STREAM_CONVERTER > >, instead of being a namespace.
    • This is a completely backwards-compatible feature.
    • It has been done to support a new feature in a future release. (#124)
  • Our Conan.io package now supports our Boost.Test integration (#121)
• Bug fixes
  • None
• Other changes
  • User Guide available on Read the Docs
    • This is more easily searchable and better formatted than on GitHub, and a PDF download is available. (#129)
  • Documented workarounds for when running Catch2 tests in CLion gives 'unexpected exception' (#131)
  • Consistent macro names
    • All our Macros now start with APPROVAL_TESTS_.
    • We have kept the old macros, redirecting to the new ones, for backwards compatibility.

| Old | New | | ------------------------------------------ | ----------------------------------------- | | APPROVALTESTS_VERSION | APPROVAL_TESTS_VERSION | | APPROVALTESTS_VERSION_MAJOR | APPROVAL_TESTS_VERSION_MAJOR | | APPROVALTESTS_VERSION_MINOR | APPROVAL_TESTS_VERSION_MINOR | | APPROVALTESTS_VERSION_PATCH | APPROVAL_TESTS_VERSION_PATCH | | APPROVALTESTS_VERSION_STR | APPROVAL_TESTS_VERSION_STR | | APPROVALS_CATCH_DISABLE_FILE_MACRO_CHECK | APPROVAL_TESTS_DISABLE_FILE_MACRO_CHECK |