Ruby: Example of how awesome inline expectations test are #13
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
But you _should_ be keeping your .expected file for such tests empty at all times, such that changes are recorded in the annotations in the code.
It's a nightmare to review the `HttpClients.expected` file, but everything just works with the inline expectation tests. Note: Since I added that fake SPURIOUS annotation to highlight what you _can_ do with this testing framework, there is actually one change to the .expected output, but again, you should keep that file without results by changing the inline annotations in the test file.
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.
This PR is an example of how inline expectation tests can make your life sweet and nice.
Notice that's it's based on the change in github#8524 (partly because I was lazy and already had that branch checked out, partly because it allowed me to copy the inline expectation test verbatim from Python 😉)
I have only changed one framework in (
Excon.rb), and only the part about what URL is requested and whether certificate check is disabled (so not what the request body is). Hopefully that should be enough to show off what it can do 😉Please see this commit-by-commit
I can also recommend reading the documentation of the framework in https://github.com/github/codeql/blob/main/ruby/ql/test/TestUtilities/InlineExpectationsTest.qll