Use FAIL_CHECK macro to report non-fatal failures to Catch2 #350
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This avoids a two-step dance of first capturing a local variable
and then doing a roundabout CHECK(false);
The previous approach produces a somewhat cluttered error message,
that primarily describes the expression `failure.empty() == false`,
showing the real issue only as an extra "failure := "..." variable
(which is presented as a quoted value, and possible truncated).
FAILED:
CHECK( failure.empty() )
with expansion:
false
with message:
failure := "test.cpp:15
Unfulfilled expectation:
Expected mock.foo(42) to be called once, actually never called
param _1 == 42
"
Using FAIL_CHECK puts the real message up front, with no extra quoting.
Like CHECK(false) (but unlike FAIL) it allows execution to continue.
FAILED:
explicitly with message:
test.cpp:15
Unfulfilled expectation:
Expected mock.foo(42) to be called once, actually never called
param _1 == 42
FAIL_CHECK has been available since Catch2 1.8.2
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #350 +/- ##
=======================================
Coverage 99.41% 99.41%
=======================================
Files 15 15
Lines 1361 1361
Branches 22 21 -1
=======================================
Hits 1353 1353
Misses 8 8 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
The previous approach buries the list of which trompeloil requirements
were matched in the expansion of the REQUIRE expression:
PASSED:
REQUIRE( trompeloeil_mock_calls_done_correctly != 0 )
with expansion:
"spy.rowsAboutToBeInserted(QModelIndex{},1,1)"
!=
0
Using SUCCESS puts the real message up front, with no extra quoting.
PASSED:
with message:
spy.rowsAboutToBeInserted(QModelIndex{},1,1)
SUCCEED has been available since Catch2 1.2.0
puetzk
force-pushed
the
catch2-FAIL_CHECK
branch
from
3296cf6 to
6ab99d3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This avoids a two-step dance of first capturing a local variable and then doing a roundabout CHECK(false);
The previous approach produces a somewhat cluttered error message, that primarily describes the expression
failure.empty() == false, showing the real issue only as an extra "failure := "..." variable (which is presented as a quoted value, and possible truncated).Using
FAIL_CHECKputs the real message up front, with no extra quoting. LikeCHECK(false)(but unlikeFAIL) it allows execution to continue.FAIL_CHECKhas been available since Catch 1.8.2, i.e. before it was Catch2, so I don't think there's a compatibility concern.