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

Document the syntax for providing a skip reason in metadata #2770

Merged
merged 1 commit into from Sep 29, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 21 additions & 0 deletions features/pending_and_skipped_examples/skipped_examples.feature
Expand Up @@ -110,3 +110,24 @@ Feature: `skip` examples
# No reason given
# ./skipped_spec.rb:2
"""

Scenario: Skipping using metadata with a reason
Given a file named "skipped_with_reason_spec.rb" with:
"""ruby
RSpec.describe "an example" do
example "is skipped", :skip => "waiting for planets to align" do
raise "this line is never executed"
end
end
"""
When I run `rspec skipped_with_reason_spec.rb`
Then the exit status should be 0
And the output should contain "1 example, 0 failures, 1 pending"
And the output should contain:
"""
Pending: (Failures listed here are expected and do not affect your suite's status)

1) an example is skipped
# waiting for planets to align
# ./skipped_with_reason_spec.rb:2
"""