Improve failure messages from output matchers #546
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Aruba depends on rspec-expectations >= 3.4, so these version checks will always pass.
The include_an_object matcher is not part of Aruba's public API so should not be described in the feature files.
This is a replacement for the feature file which was removed.
olleolleolle
approved these changes
Mar 5, 2018
| When I run `cucumber` | ||
| Then the features should not all pass with: | ||
| """ | ||
| expected `aruba-test-cli` to have output string includes: "goodbye world" |
There was a problem hiding this comment.
Narrator: I was missing something.
Perhaps I am missing something, but line 61 and line 56 have mismatched wording.
expected `aruba-test-cli` to have output string includes: "goodbye world"
"to have output string including" would be my personal expectation (just reading the line)
| Then the features should all pass | ||
| Then the features should not all pass with: | ||
| """ | ||
| expected `aruba-test-cli` to have output output string is eq: "hello\nworld" |
There was a problem hiding this comment.
...but now I understand there's more to it, we're surfacing RSpec matchers more directly in these messages.
There was a problem hiding this comment.
Please disregard my first comment.
| if RSpec::Expectations::Version::STRING >= '3.1' | ||
| RSpec::Matchers.define_negated_matcher :have_failed_running, :be_successfully_executed | ||
| end | ||
| RSpec::Matchers.define_negated_matcher :have_failed_running, :be_successfully_executed |
|
Right. I still think this is an improvement, but it didn't improve the case for negative failures of |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Make the message from the output matchers/steps provide enough information to figure out what went wrong.
Details
have_outputmatcher failure message print the command name and the full actual output.include_an_objectmatcher not print boiler plate when the collection has exactly one member.include_an_objectsince it is non-public API.Motivation and Context
The build failures for #544 do not provide enough information to see what failed because the actual output is truncated to a single-line string.
How Has This Been Tested?
Features and specs were added.
Types of changes
Checklist: