-
Couldn't load subscription status.
- Fork 15
CLOUDP-271992: Add rule xgen-IPA-105-list-method-response-code-is-200 #501
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
163 changes: 163 additions & 0 deletions
163
tools/spectral/ipa/__tests__/listResponseCodeShouldBe200OK.test.js
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| import testRule from './__helpers__/testRule'; | ||
| import { DiagnosticSeverity } from '@stoplight/types'; | ||
|
|
||
| testRule('xgen-IPA-105-list-method-response-code-is-200', [ | ||
| { | ||
| name: 'valid methods', | ||
| document: { | ||
| paths: { | ||
| '/resource': { | ||
| get: { | ||
| responses: { | ||
| 200: {}, | ||
| 400: {}, | ||
| 500: {}, | ||
| }, | ||
| }, | ||
| }, | ||
| '/resource/{id}': { | ||
| get: { | ||
| responses: { | ||
| 400: {}, | ||
| 500: {}, | ||
| }, | ||
| }, | ||
| }, | ||
| '/resource/{id}:customMethod': { | ||
| get: { | ||
| responses: { | ||
| 400: {}, | ||
| 500: {}, | ||
| }, | ||
| }, | ||
| }, | ||
| '/resource/{id}/singleton': { | ||
| get: { | ||
| responses: { | ||
| 400: {}, | ||
| 500: {}, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| { | ||
| name: 'invalid methods', | ||
| document: { | ||
| paths: { | ||
| '/resourceOne': { get: { responses: {} } }, | ||
| '/resourceTwo': { | ||
| get: { | ||
| responses: { | ||
| 201: {}, | ||
| 400: {}, | ||
| 500: {}, | ||
| }, | ||
| }, | ||
| }, | ||
| '/resourceThree': { | ||
| get: { | ||
| responses: { | ||
| 400: {}, | ||
| 500: {}, | ||
| }, | ||
| }, | ||
| }, | ||
| '/resourceFour': { | ||
| get: { | ||
| responses: { | ||
| 200: {}, | ||
| 201: {}, | ||
| 400: {}, | ||
| 500: {}, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [ | ||
| { | ||
| code: 'xgen-IPA-105-list-method-response-code-is-200', | ||
| message: | ||
| 'The List method must return a 200 OK response. This method either lacks a 200 OK response or defines a different 2xx status code. http://go/ipa/105', | ||
| path: ['paths', '/resourceOne', 'get'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-105-list-method-response-code-is-200', | ||
| message: | ||
| 'The List method must return a 200 OK response. This method either lacks a 200 OK response or defines a different 2xx status code. http://go/ipa/105', | ||
| path: ['paths', '/resourceTwo', 'get'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-105-list-method-response-code-is-200', | ||
| message: | ||
| 'The List method must return a 200 OK response. This method either lacks a 200 OK response or defines a different 2xx status code. http://go/ipa/105', | ||
| path: ['paths', '/resourceThree', 'get'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-105-list-method-response-code-is-200', | ||
| message: | ||
| 'The List method must return a 200 OK response. This method either lacks a 200 OK response or defines a different 2xx status code. http://go/ipa/105', | ||
| path: ['paths', '/resourceFour', 'get'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| name: 'invalid method with exception', | ||
| document: { | ||
| paths: { | ||
| '/resourceOne': { | ||
| get: { | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-105-list-method-response-code-is-200': 'reason', | ||
| }, | ||
| responses: {}, | ||
| }, | ||
| }, | ||
| '/resourceTwo': { | ||
| get: { | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-105-list-method-response-code-is-200': 'reason', | ||
| }, | ||
| responses: { | ||
| 201: {}, | ||
| 400: {}, | ||
| 500: {}, | ||
| }, | ||
| }, | ||
| }, | ||
| '/resourceThree': { | ||
| get: { | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-105-list-method-response-code-is-200': 'reason', | ||
| }, | ||
| responses: { | ||
| 400: {}, | ||
| 500: {}, | ||
| }, | ||
| }, | ||
| }, | ||
| '/resourceFour': { | ||
| get: { | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-105-list-method-response-code-is-200': 'reason', | ||
| }, | ||
| responses: { | ||
| 200: {}, | ||
| 201: {}, | ||
| 400: {}, | ||
| 500: {}, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| ]); |
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # IPA-105: List | ||
| # http://go/ipa/105 | ||
|
|
||
| functions: | ||
| - listResponseCodeShouldBe200OK | ||
|
|
||
| rules: | ||
| xgen-IPA-105-list-method-response-code-is-200: | ||
| description: 'The List method must return a 200 OK response. http://go/ipa/105' | ||
| message: '{{error}} http://go/ipa/105' | ||
| severity: warn | ||
| given: '$.paths[*].get' | ||
| then: | ||
| function: 'listResponseCodeShouldBe200OK' |
This file contains hidden or 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
51 changes: 51 additions & 0 deletions
51
tools/spectral/ipa/rulesets/functions/listResponseCodeShouldBe200OK.js
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| import { hasException } from './utils/exceptions.js'; | ||
| import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js'; | ||
| import { | ||
| getResourcePathItems, | ||
| isResourceCollectionIdentifier, | ||
| isSingletonResource, | ||
| } from './utils/resourceEvaluation.js'; | ||
|
|
||
| const RULE_NAME = 'xgen-IPA-105-list-method-response-code-is-200'; | ||
| const ERROR_MESSAGE = | ||
| 'The List method must return a 200 OK response. This method either lacks a 200 OK response or defines a different 2xx status code.'; | ||
|
|
||
| export default (input, _, { path, documentInventory }) => { | ||
| const resourcePath = path[1]; | ||
| const oas = documentInventory.resolved; | ||
|
|
||
| if ( | ||
| !isResourceCollectionIdentifier(resourcePath) || | ||
| (isResourceCollectionIdentifier(resourcePath) && isSingletonResource(getResourcePathItems(resourcePath, oas.paths))) | ||
| ) { | ||
| return; | ||
| } | ||
| if (hasException(input, RULE_NAME)) { | ||
| collectException(input, RULE_NAME, path); | ||
| return; | ||
| } | ||
|
|
||
| const errors = checkViolationsAndReturnErrors(input, path); | ||
|
|
||
| if (errors.length !== 0) { | ||
| return collectAndReturnViolation(path, RULE_NAME, errors); | ||
| } | ||
| return collectAdoption(path, RULE_NAME); | ||
| }; | ||
|
|
||
| function checkViolationsAndReturnErrors(input, path) { | ||
| if (input['responses']) { | ||
| const responses = input['responses']; | ||
|
|
||
| // If there is no 200 response, return a violation | ||
| if (!responses['200']) { | ||
| return [{ path, message: ERROR_MESSAGE }]; | ||
| } | ||
|
|
||
| // If there are other 2xx responses that are not 200, return a violation | ||
| if (Object.keys(responses).some((key) => key.startsWith('2') && key !== '200')) { | ||
| return [{ path, message: ERROR_MESSAGE }]; | ||
| } | ||
| } | ||
| return []; | ||
| } | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: consider merging those violations into array of 2 errors.
Think of someone waiting 40 minutes for the build to pass only to get yet another error etc.