Allow invalid request examples #617
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
Specmatic validates examples that should get a 200 response according to the specification. But for an example that triggers a 400 or 422 response, don't validate it according to the contract. It may be necessary to send a contract-invalid request to trigger a 400 or 422 response.
If a contract test running from an example marked [WIP] fails, it will report the failure, but will never fail on the console or in JUnit. As a result, no build would break. This is useful for times when we'd like to put a failing example in the contract, but the failure cannot be rectified immediately as the developers are busy or have other priorities.
harikrishnan83
approved these changes
Mar 4, 2023
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.
What:
Examples can now be marked WIP. A WIP example is similar to a WIP scenario, in that if the example fails, it gets logged but is not considered a failure but Specmatic. JUnit will ignore the failure, the return value on the command-line will be 0 (if the failing test from the WIP example is the only failure) and the failure will not break any build.
Why:
There are times when we wish to add an example that should trigger a 400 but instead triggers a 500 (or even a 200 response), and commit this contract to a repo even if the resulting contract test fails. We wish to keep the example so that the feedback is not lost, but cannot afford to break the build as the developer needs time to fix the problem.
How:
Checklist:
Issue ID:
Closes: #123