action #45410
openAllow adding clarification messages for all assertions/checks
0%
Description
Motivation¶
As a job reviewer or developer taking a look on openQA job I would like to have general understanding of the test module steps without reading code. As it's done for the unit tests frameworks, one can write expectation, and message what is checked. Similarly in openQA, it's not always clear what we check and what was expected. With such functionality test developers could provide information (e.g. assert_screen 'generic-desctop', msg => "Verify that window is closed).
Updated by riafarov over 5 years ago
As implementation will be straight-forward, Y-subteam most likely will pick it up.
Updated by coolo over 5 years ago
I don't see it as straight-forward as you most likely don't want to read the logs either, so it needs some kind of UI support. But go ahead and experiment with it.
Updated by riafarov over 5 years ago
We have it for assert_script_run, so I thought it should be easy to reuse that functionality. I guess we simply override/extend message for the failing screen. As for successful run we started to use record_info more often to provide such info, so it's more for the investigation when something fails. Thanks for the feedback!
Updated by coolo over 5 years ago
So you just create a 2nd text result on failure? That only makes the test easier to understand on failures. But if that's what you need, it's straight forward :)
Updated by riafarov over 5 years ago
coolo wrote:
So you just create a 2nd text result on failure? That only makes the test easier to understand on failures. But if that's what you need, it's straight forward :)
That would be enough, as we rarely take a look a the working tests. Other part can be achieved with record_info, but I guess adding text when needle matching fails shouldn't be hard either.
Updated by okurz over 4 years ago
- Subject changed from [tools] Allow adding clarification messages for all assertions/checks to Allow adding clarification messages for all assertions/checks
- Priority changed from Normal to Low
- Target version set to future