Adds a warning if the Server method of a TestFixture is called before Finalize
#2047
Conversation
before `Finalize This commit adds a warning if someone were to call `Server()` before `Finalize`. The rationale for this is because I made the mistake of not calling `Finalize` ina program I was writing. It took me some time to track down the root cause of the problem. I figure if we warn users it should be immediately obvious. Signed-off-by: Arjo Chakravarty <[email protected]>
Codecov Report
@@ Coverage Diff @@
## ign-gazebo3 #2047 +/- ##
===============================================
+ Coverage 70.73% 70.77% +0.03%
===============================================
Files 262 262
Lines 16760 16764 +4
===============================================
+ Hits 11856 11865 +9
+ Misses 4904 4899 -5
|
| @@ -210,6 +210,13 @@ TestFixture &TestFixture::OnPostUpdate(std::function<void( | |||
| ////////////////////////////////////////////////// | |||
| std::shared_ptr<Server> TestFixture::Server() const | |||
| { | |||
| if (!this->dataPtr->finalized) | |||
| { | |||
| ignwarn << "Fixture has not been finalized, any functions you attempted" | |||
There was a problem hiding this comment.
Can we use gzwarn instead to make forward porting easier?
There was a problem hiding this comment.
I don't think gzwarn is available in citadel. It might be worth considering back porting the functionality to reduce the maintenance overhead.
There was a problem hiding this comment.
It's not. If we go ahead and do the forward port while it's "fresh" we can minimize some pain
There was a problem hiding this comment.
Ah, sorry. For some reason I thought they were. @mjcarroll would there be an issue if we added those to gz-common3 at some point?
Signed-off-by: Arjo Chakravarty <[email protected]>
Signed-off-by: Arjo Chakravarty <[email protected]>
Summary
This PR adds a warning if someone were to call
Server()beforeFinalize. The rationale for this is because I made the mistake of not callingFinalizeina program I was writing. It took me some time to track down the root cause of the problem. I figure if we warn users it should be immediately obvious.Checklist
codecheckpassed (See contributing)Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining
Signed-off-bymessages.