TEST_CASE_FIXTURE: A new fixture macro for allowing persistent fixtures throughout a TEST_CASE #2885
Conversation
… of the existing documentation around the existing test fixture macros.
docs/other-macros.md
Outdated
There was a problem hiding this comment.
I have removed this section and placed it in with the test-fixtures documentation since it is a macro for creating a test fixture.
examples/CMakeLists.txt
Outdated
There was a problem hiding this comment.
I couldn't find out what the naming scheme of examples is... Happy to rename this once I know what the name should be!
Ignore all files with the name CMakeUserPresets.json
Add unapproved files to gitignore
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## devel #2885 +/- ##
==========================================
- Coverage 91.14% 91.13% -0.01%
==========================================
Files 198 198
Lines 8487 8512 +25
==========================================
+ Hits 7735 7757 +22
- Misses 752 755 +3 |
docs/test-fixtures.md
Outdated
| } | ||
| } | ||
| ``` | ||
| This test case will be executed twice as there are two leaf sections. On the first run `val` will be `0` and on the second run `val` will be `1`. This is useful if you would like to share some expensive setup code with all runs of your test case which can't be done at static initialization time. |
There was a problem hiding this comment.
I am not particularly happy about the example/explanation combo. My first reaction was "well, how's that different from using static variable here".
I can't give you better version right now, but I think this should be focused on the performance difference from TEST_CASE_METHOD, maybe have something like
// Pretend doing hard work
std::this_thread::sleep_for(2s);in the fixture constructor and explain that TEST_CASE_FIXTURE takes 2 seconds, while TEST_CASE_METHOD needs 2/4/6/8/... seconds to execute.
There was a problem hiding this comment.
This should probably also explain that two different TEST_CASE_FIXTUREs have separate instances of fixture, i.e., the fixture is not static globally, just for the paths defined in one TEST_CASE.
There was a problem hiding this comment.
I have redone the example and the documentation for this feature now. I feel like it now better highlights why a test writer would use this over TEST_CASE_METHOD.
|
As an FYI, I am (rather obviously) not finished with the review, but my bus ride is over and I'll have to return to this later. |
src/catch2/catch_test_case_info.hpp
Outdated
| @@ -112,6 +112,14 @@ namespace Catch { | |||
| TestCaseHandle(TestCaseInfo* info, ITestInvoker* invoker) : | |||
| m_info(info), m_invoker(invoker) {} | |||
|
|
|||
| void testCaseStarting() const { | |||
There was a problem hiding this comment.
Not a big fan of this name. It is consistent with the event names, but it does not describe the reason why it exists well. How about "prepareTestCase" instead?
(And same for testCaseEnding below.)
There was a problem hiding this comment.
Yup as below, I have renamed these prepareTestCase and tearDownTestCase
…licence to Fixture example
Fix the license on the file Improve the example to make the use cases much clearer. Also fix up the documentation
… to tearDownTestCase
…ASE_PERSISTENT_FIXTURE. Also adding the example to the list of examples
|
Thanks |
Description
This PR introduces a new
TEST_CASEmacro calledTEST_CASE_FIXTURE.TEST_CASE_FIXTUREoffers the same functionality asTEST_CASE_METHODexcept for one difference. The object on which the test method is invoked is only created once for all invocations of the test case. The object is created just after thetestCaseStartingevent is broadcast and the object is destroyed just before thetestCaseEndingevent is broadcast.The main motivation for this new functionality is to allow
TEST_CASEs to do expensive setup and teardown once perTEST_CASE, without having to resort to abusing event listeners or static function variables with manual initialization.GitHub Issues
This PR hopes to be an implementation of #1602