Rework handling of non-pass results

[davidjgoss]

🤔 What's changed?

This PR reworks our handling of non-passing scenarios, in particular the different statuses of responsible step. Previously, we generically showed any exception or message that was present on a result, regardless of the status. Here, we've spun out separate rendering paths for each status:

Status	Behaviour
SKIPPED	TBA
PENDING	TBA
UNDEFINED	Short note, and snippets
AMBIGUOUS	Short note, and list of matched step definitions
FAILED	Show exception or message if present

⚡️ What's your motivation?

• Fixes Rendering differences of Skipped Scenarios in v24 #421
• Part of Messages from Javascript missing exception.type and .message messages#317
• Part of Add suggestions/snippets to the model common#2272

🏷️ What kind of change is this?

• 🐛 Bug fix (non-breaking change which fixes a defect)
• ⚡ New feature (non-breaking change which adds new behaviour)
• 💥 Breaking change (incompatible changes to the API)

📋 Checklist:

• I agree to respect and uphold the Cucumber Community Code of Conduct
• I've changed the behaviour of the code
  • I have added/updated tests to cover my changes.
• My change requires a change to the documentation.
  • I have updated the documentation accordingly.
• Users should know about my change
  • I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

---

This text was originally generated from a template, then edited by hand. You can modify the template here.

[netlify]

✅ Deploy Preview for cucumber-react-preview ready!

Name	Link
🔨 Latest commit	e9170d8
🔍 Latest deploy log	https://app.netlify.com/projects/cucumber-react-preview/deploys/6984d706e989120008451d69
😎 Deploy Preview	https://deploy-preview-426--cucumber-react-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[davidjgoss]

So far:

[davidjgoss]

@mpkorstanje @clrudolphi @luke-hill picking up from #421, what presentation do we want for skipped and pending steps where there is something in TestStepResult.exception or TestStepResult.message - I'm aware that in some (but not all) implementations those statuses are triggered by an exception, but I'm not sure if it encodes any useful information. If so, perhaps it should be presented more subtly than the FAILED one, and without the stack trace?

[luke-hill]

Added a comment on the related issue, as I noticed something diff in cucumber-ruby recently. Not sure if it helps or not.

My 0.02c was in there. TL;DR - Old skipped logic where everything was greyed out (Scenario/steps), is preferred imo for skipped/bypassed scenarios. The reason being is there should be a reason they're skipped, and the user can investigate

[davidjgoss]

@luke-hill can you raise a separate issue for that and we can discuss there? This is specifically about handling output at the step level.

[clrudolphi]

@mpkorstanje @clrudolphi @luke-hill picking up from #421, what presentation do we want for skipped and pending steps where there is something in TestStepResult.exception or TestStepResult.message - I'm aware that in some (but not all) implementations those statuses are triggered by an exception, but I'm not sure if it encodes any useful information. If so, perhaps it should be presented more subtly than the FAILED one, and without the stack trace?

Yes, in Reqnroll, the skip and pending behaviors are triggered by exceptions. It does provide a mechanism for a message to accompany the exception. So, I would like to see the message included. The exception stack trace is of no interest.

[mpkorstanje]

@mpkorstanje @clrudolphi @luke-hill picking up from #421, what presentation do we want for skipped and pending steps where there is something in TestStepResult.exception or TestStepResult.message - I'm aware that in some (but not all) implementations those statuses are triggered by an exception, but I'm not sure if it encodes any useful information. If so, perhaps it should be presented more subtly than the FAILED one, and without the stack trace?

For Cucumber JVM it encodes useful information. I.e. the reason why the test was skipped and in the stacktrace where the skip came from. But I think users can life without the stacktrace.