Support to imperatively skip scenario Fixes #873

[jshifflet]

First pull request ever.

Let me know if I need to fix anything.

This is for issue #873

Thanks.

[charlierudolph]

Looks great!

Can we add a description to the feature to describe the use case?

I think we should also update some documentation. Probably here alongside pending step definitions: https://github.com/cucumber/cucumber-js/blob/08c138ac61f7517c0ea9d0dce59928163cb954d0/docs/support_files/step_definitions.md and in hooks. We should also clearly define the intended for this so people know when they should be using it.

[charlierudolph]

pending -> skipped

[charlierudolph]

pending -> skipped

[charlierudolph]

pending -> skipped

[jshifflet]

Please see updates.

I have updated the step_definitions.md and added some feature text to the top of the added feature file.

I also added a cucumber test to verify that skipped can be used in a hook.

Where in hooks.md should I add the documentation for this feature?

[charlierudolph]

Looks great! How about on hooks.md between the tagged hooks section and before / after all section.

[jshifflet]

Added an example to hooks.md.

Let me know of any changes needed.

[aslakhellesoy]

Hi @jshifflet,

Thanks for your making your first contribution to Cucumber, and welcome to the Cucumber committers team! You can now push directly to this repo and all other repos under the cucumber organization! 🍾

In return for this generous offer we hope you will:

• ✅ Continue to use branches and pull requests. When someone on the core team approves a pull request (yours or someone else's), you're welcome to merge it yourself.
• 💚 Commit to setting a good example by following and upholding our code of conduct in your interactions with other collaborators and users.
• 💬 Join the community Slack channel to meet the rest of the team and make yourself at home.
• ℹ️ Don't feel obliged to help, just do what you can if you have the time and the energy.
• 🙋 Ask if you need anything. We're looking for feedback about how to make the project more welcoming, so please tell us!

On behalf of the Cucumber core team,
Aslak Hellesøy
Creator of Cucumber

[jshifflet]

Thanks and thanks @charlierudolph for the help on this pull request.

[charlierudolph]

@jshifflet something I was debating around this. Currently the step is marked as skipped but the output doesn't say anything about why its skipped.

We may need to add the ability to return a reason why it skipped and then update the output to reflect that why. I personally don't intend on using this, so please let me know how its like to use this. I'm preparing a release now

[jshifflet]

@charlierudolph would this just be a custom message that appears during test execution?

[charlierudolph]

I was just thinking of reporting this the same way a pending step is reported. In order to allow a message we could open up the API to be something like

// skipping without a reason
return 'skipped' 
// skipping with a reason
return {status: 'skipped', reason: 'x resource is missing'}

[jshifflet]

@charlierudolph sounds good.

Is there an example of a pending step giving a reason?

I was looking here: https://github.com/cucumber/cucumber-js/blob/master/features/pending_steps.feature and at the event protocol.

Thanks.

[charlierudolph]

The reason would be a new feature (pending steps do not support currently support it). I was primarily referring to the progress / progress-bar / summary formatters for pending steps are reported.

[jshifflet]

Got it. I will try to get a proof-of-concept done.

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.