Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: Option to display skipped user interactions in the Serenity Report #1892

Closed
githubble01 opened this issue Dec 9, 2019 · 5 comments

Comments

@githubble01
Copy link

githubble01 commented Dec 9, 2019

Hi!

Current behaviour
When a test fails, the skipped low level user interaction steps are omitted in the Serenity Report.

Problem
Omitting the skipped low level user interactions steps makes the Living Documentation incomplete. To get around this issue our team provides all the steps as java doc to ensure a complete documentation even though tests are failing. The drawback of this is off course extra maintenance.

Suggested behaviour
To fully leverage the concept of the Living Documentation, we would like to have the option of displaying all skipped steps, including the low level user interactions. Below is a suggestion on how to this option could be managed from the serenity.conf.

serenity.reports.show.step.interactions.skipped = "true".

References

Any thoughts?

@wakaleo
Copy link
Member

wakaleo commented Dec 9, 2019

Could you give an example of what you mean? Any @step interaction will be reported, as will any Screenplay task or interaction. Low level WebDriver interactions are intentionally skipped after a failure because it would slow down the tests and not be meaningful, but WebDriver interactions aren’t normally reported except in Screenplay. So I’m not sure what you are after.

@githubble01
Copy link
Author

githubble01 commented Dec 12, 2019

It's indeed the Low Level WebDriver interactions of the Screenplay reporting I'm after. Thanks for sorting the terminology out :).

So if there would be a way to have the Screenplay reporting show skipped Low Level WebDriver interactions as well, the report would be more usable as (living) documentation to us.

Perhaps a more suitable name for the option would be:
serenity.screenplay.reports.show.lowlevelwebdriverinteractions.skipped = "true".

@githubble01
Copy link
Author

@wakaleo: Thanks for considering this as an enhancement! Hope some more people are interested.. :)

@dianacarmen-art
Copy link

I am also missing this feature.
Especially because the reports are listing some of the Skipped tests after a test failure, it's very confusing and I didn't realize that there should have been additional steps.
Is there a workaround until the enhancement is implemented?
Thanks

@globalworming
Copy link
Collaborator

I would definitely be interested, but that's a very hard problem to solve, so i don't have high hopes of this being a thing.

@wakaleo wakaleo closed this as completed Feb 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants