Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorMartin Hořeňovský2019-10-13 20:37:07 +0200
committerMartin Hořeňovský2019-10-13 20:37:07 +0200
commit2cc0c718562d41a9900daca3ba53b6753515ee49 (patch)
tree399afaed97c2611b11371c8ac2d20b1942c654b5 /docs
parent28663fb9594ae60109255625d8e6020a36331105 (diff)
downloadcatch3-2cc0c718562d41a9900daca3ba53b6753515ee49.tar.gz
Add a matcher that checks exception's message
Only works for exceptions that publicly derive from `std::exception` and the matching is done exactly, including case and whitespace. Closes #1649 Closes #1728 # Please enter the commit message for your changes. Lines starting # with '#' will be ignored, and an empty message aborts the commit. # On branch master # Your branch is up-to-date with 'origin/master'. # # Changes to be committed: # modified: ../docs/matchers.md # modified: ../include/internal/catch_capture_matchers.h # modified: ../projects/CMakeLists.txt # modified: ../projects/SelfTest/Baselines/compact.sw.approved.txt # modified: ../projects/SelfTest/Baselines/console.std.approved.txt # modified: ../projects/SelfTest/Baselines/console.sw.approved.txt # modified: ../projects/SelfTest/Baselines/junit.sw.approved.txt # modified: ../projects/SelfTest/Baselines/xml.sw.approved.txt # modified: ../projects/SelfTest/UsageTests/Matchers.tests.cpp # # Untracked files: # ./ # ../clang-full/ # ../clang-test/ # ../clang10-build/ # ../coverage-build/ # ../gcc-build/ # ../gcc-full/ # ../include/internal/catch_matchers_exception.cpp # ../include/internal/catch_matchers_exception.hpp # ../misc-build/ # ../msvc-sln/ # ../notes.txt # ../test-install/ #
Diffstat (limited to 'docs')
-rw-r--r--docs/matchers.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/matchers.md b/docs/matchers.md
index f0fe06a2..3d7f0c1e 100644
--- a/docs/matchers.md
+++ b/docs/matchers.md
@@ -81,6 +81,22 @@ The second argument is an optional description of the predicate, and is
used only during reporting of the result.
+### Exception matchers
+Catch2 also provides an exception matcher that can be used to verify
+that an exception's message exactly matches desired string. The matcher
+is `ExceptionMessageMatcher`, and we also provide a helper function
+`Message`.
+
+The matched exception must publicly derive from `std::exception` and
+the message matching is done _exactly_, including case.
+
+> `ExceptionMessageMatcher` was introduced in Catch X.Y.Z
+
+Example use:
+```cpp
+REQUIRE_THROWS_MATCHES(throwsDerivedException(), DerivedException, Message("DerivedException::what"));
+```
+
## Custom matchers
It's easy to provide your own matchers to extend Catch or just to work with your own types.