mirror of
https://github.com/catchorg/Catch2.git
synced 2025-07-30 18:57:35 +02:00
Updated
Updated What's the CATCH? (markdown)
8
Home.md
8
Home.md
@ -11,8 +11,9 @@ There are a number of decent C++ unit testing frameworks out there, including (b
|
||||
Here's a list of core features of Catch that, collectively, make Catch stand out:
|
||||
|
||||
* Implemented entirely in headers. Just #include "catch.hpp" and you're away.
|
||||
* Minimal dependencies - just C++98 with basic STL.
|
||||
* Write test cases as functions or methods. Functions are self registering.
|
||||
* Minimal dependencies - just C++03 with basic STL.
|
||||
* Write test cases as functions or methods.
|
||||
* All test cases are self registering (even for methods).
|
||||
* No context to pass around. Call through non test code and back into test code and assertions still work (useful for mocks)
|
||||
* Only one core assertion macro for comparisons. Standard C/C++ operators are used for the comparison - yet the full expression is decomposed and lhs and rhs values are logged.
|
||||
* Tests are named hierarchically and can be run by matching the entire name or partially to provide one way of grouping tests.
|
||||
@ -21,6 +22,7 @@ Here's a list of core features of Catch that, collectively, make Catch stand out
|
||||
* Floating point tolerance comparisons are built in using an expressive Approx() syntax.
|
||||
* Test cases can be described from a TDD or BDD mindset, with support for nested SECTIONs in the latter.
|
||||
* Output is through reporter objects. basic textual and XML reporters are included. Custom reporters can easily be added.
|
||||
* JUnit xml output is supported for integration with third-party tools, such as CI servers.
|
||||
* Output can be to any stream.
|
||||
* A default main() function is provided (in a header), but you can supply your own for complete control (e.g. integration into your own test runner GUI).
|
||||
* A command line parser is provided and can still be used if you choose to provided your own main() function.
|
||||
@ -31,5 +33,5 @@ Here's a list of core features of Catch that, collectively, make Catch stand out
|
||||
|
||||
## What state is CATCH in - can I use it now?
|
||||
|
||||
Currently CATCH should be considered a "developer preview". You can try it out and see what you think but it is still undergoing heavy development and names and interfaces are subject to change. I wouldn't recommend it for commercial projects - or anything beyond small scale test projects for now.
|
||||
Currently CATCH should be considered a "developer preview". You can try it out and see what you think but it is still undergoing heavy development and names and interfaces are subject to change (the macro names should be stable now). I wouldn't recommend it for commercial projects - or anything beyond small scale test projects for now.
|
||||
of course if you want to contribute then you are very welcome.
|
Reference in New Issue
Block a user