Skip to content

Single Hpp File - v.8.0.0
Compare
Choose a tag to compare
@claremacrae claremacrae released this 22 Jan 20:35
· 2733 commits to master since this release
v.8.0.0
2dc70a5

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

  • Breaking changes
    • We have fully standardised the way that Approval Tests looks for 3rd-party headers, so users should no longer need to modify their search paths for include directories. This means that:
    • If you are using Catch (#62), and you get build failures, you'll need to change your #include lines like this: 
      -#include <catch.hpp>
+#include <catch2/catch.hpp>
    • If you are using doctest (#68), and you get build failures, you'll need to change your #include lines like this: 
      -#include <doctest.h>
+#include <doctest/doctest.h>
    • If you are using [Boost].UT (#65), and you get build failures, you'll need to change your #include lines like this: 
      -#include <ut.hpp>
+#include <boost/ut.hpp>
    • In order for this to work with our third_party directory, our copies of these header files are now in:
      • third_party/catch2/include/catch2/
      • third_party/doctest/include/doctest
      • third_party/ut/include/boost
    • Catch1 is no longer supported as a test framework, in order to better support more CMake build layouts. (#64)
      • Catch2 remains fully supported.
      • Catch1's main benefit was that it supported pre-C++11 compilers, but as ApprovalTests.cpp requires C++11 or newer, this wasn't useful in practice
  • New features
    • Greatly improved and documented CMake Integration (#69):
      • Approval Tests can now be added to other projects with any of CMake's add_subdirectory(), FetchContent and ExternalProject. (#62, #65, #68, #75, #70, #88, #89)
      • Created wrapper ApprovalTests.hpp
        so that code can work interchangeably with the single header and via CMake integration (#89)
      • Made CMake targets for targets in third_party consistent with those of the original projects, adding Catch2::Catch2, doctest::doctest and boost.ut (#70)
      • Created a namespaced CMake target for ApprovalTests ApprovalTests::ApprovalTests (#75)
      • Don't create third_party targets if they have been created already (#88)
  • Bug fixes
    • Significant effort to improve behaviour with the Ninja build tool:
      • Understood, work-around and documented issues with the Ninja generator. See Troubleshooting Misconfigured Build if you have test failures in your Ninja builds. (#74 - thanks @jwillikers)
      • Added compile-time checks for GoogleTest, Catch2 and doctest, to detect problems with __FILE__ macro caused by the Ninja generator on all platforms (#79 - thanks @jwillikers).
      • Added option to disable the __FILE__ compile-time check (#86)
    • Project now works with Unity builds (#86)
  • Other changes
Assets 3
Loading