-
Couldn't load subscription status.
- Fork 14
CLOUDP-302984: IPA rule Get methods should return data for a single resource #463
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
3 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
271 changes: 271 additions & 0 deletions
271
tools/spectral/ipa/__tests__/getMethodReturnsSingleResource.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,271 @@ | ||
| import testRule from './__helpers__/testRule'; | ||
| import { DiagnosticSeverity } from '@stoplight/types'; | ||
|
|
||
| const componentSchemas = { | ||
| schemas: { | ||
| Schema: { | ||
| properties: { | ||
| exampleProperty: { | ||
| type: 'string', | ||
| }, | ||
| }, | ||
| }, | ||
| PaginatedSchema: { | ||
| type: 'array', | ||
| }, | ||
| ArraySchema: { | ||
| properties: { | ||
| results: { | ||
| type: 'array', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| testRule('xgen-IPA-104-get-method-returns-single-resource', [ | ||
| { | ||
| name: 'valid resources', | ||
| document: { | ||
| paths: { | ||
| '/resource': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| content: { | ||
| 'application/vnd.atlas.2024-08-05+json': { | ||
| schema: { | ||
| $ref: '#/components/schemas/PaginatedSchema', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| '/resource/{id}': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| content: { | ||
| 'application/vnd.atlas.2024-08-05+json': { | ||
| schema: { | ||
| $ref: '#/components/schemas/Schema', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| '/resource/{id}:getAllThings': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| content: { | ||
| 'application/vnd.atlas.2024-08-05+json': { | ||
| schema: { | ||
| $ref: '#/components/schemas/ArraySchema', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| '/singleton': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| content: { | ||
| 'application/vnd.atlas.2024-08-05+json': { | ||
| schema: { | ||
| $ref: '#/components/schemas/Schema', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| components: componentSchemas, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| { | ||
| name: 'invalid resources', | ||
| document: { | ||
| paths: { | ||
| '/arrayResource/{id}': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| content: { | ||
| 'application/vnd.atlas.2024-08-05+json': { | ||
| schema: { | ||
| $ref: '#/components/schemas/ArraySchema', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| '/paginatedResource/{id}': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| content: { | ||
| 'application/vnd.atlas.2024-08-05+json': { | ||
| schema: { | ||
| $ref: '#/components/schemas/PaginatedSchema', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| '/arraySingleton': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| content: { | ||
| 'application/vnd.atlas.2024-08-05+json': { | ||
| schema: { | ||
| $ref: '#/components/schemas/ArraySchema', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| '/paginatedSingleton': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| content: { | ||
| 'application/vnd.atlas.2024-08-05+json': { | ||
| schema: { | ||
| $ref: '#/components/schemas/PaginatedSchema', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| components: componentSchemas, | ||
| }, | ||
| errors: [ | ||
| { | ||
| code: 'xgen-IPA-104-get-method-returns-single-resource', | ||
| message: | ||
| 'Get methods should return data for a single resource. This method returns an array or a paginated response. http://go/ipa/104', | ||
| path: [ | ||
| 'paths', | ||
| '/arrayResource/{id}', | ||
| 'get', | ||
| 'responses', | ||
| '200', | ||
| 'content', | ||
| 'application/vnd.atlas.2024-08-05+json', | ||
| ], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-104-get-method-returns-single-resource', | ||
| message: | ||
| 'Get methods should return data for a single resource. This method returns an array or a paginated response. http://go/ipa/104', | ||
| path: [ | ||
| 'paths', | ||
| '/paginatedResource/{id}', | ||
| 'get', | ||
| 'responses', | ||
| '200', | ||
| 'content', | ||
| 'application/vnd.atlas.2024-08-05+json', | ||
| ], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-104-get-method-returns-single-resource', | ||
| message: | ||
| 'Get methods should return data for a single resource. This method returns an array or a paginated response. http://go/ipa/104', | ||
| path: [ | ||
| 'paths', | ||
| '/arraySingleton', | ||
| 'get', | ||
| 'responses', | ||
| '200', | ||
| 'content', | ||
| 'application/vnd.atlas.2024-08-05+json', | ||
| ], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-104-get-method-returns-single-resource', | ||
| message: | ||
| 'Get methods should return data for a single resource. This method returns an array or a paginated response. http://go/ipa/104', | ||
| path: [ | ||
| 'paths', | ||
| '/paginatedSingleton', | ||
| 'get', | ||
| 'responses', | ||
| '200', | ||
| 'content', | ||
| 'application/vnd.atlas.2024-08-05+json', | ||
| ], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| name: 'invalid resources with exceptions', | ||
| document: { | ||
| paths: { | ||
| '/arrayResource/{id}': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| content: { | ||
| 'application/vnd.atlas.2024-08-05+json': { | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-104-get-method-returns-single-resource': 'reason', | ||
| }, | ||
| schema: { | ||
| $ref: '#/components/schemas/ArraySchema', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| '/paginatedSingleton': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| content: { | ||
| 'application/vnd.atlas.2024-08-05+json': { | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-104-get-method-returns-single-resource': 'reason', | ||
| }, | ||
| schema: { | ||
| $ref: '#/components/schemas/PaginatedSchema', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| components: componentSchemas, | ||
| }, | ||
| 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
39 changes: 39 additions & 0 deletions
39
tools/spectral/ipa/rulesets/functions/getMethodReturnsSingleResource.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,39 @@ | ||
| import { isChild, isCustomMethod, isSingletonResource, getResourcePaths } from './utils/resourceEvaluation.js'; | ||
| import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js'; | ||
| import { getAllSuccessfulResponseSchemas } from './utils/methodUtils.js'; | ||
| import { hasException } from './utils/exceptions.js'; | ||
| import { schemaIsArray, schemaIsPaginated } from './utils/schemaUtils.js'; | ||
| import { resolveObject } from './utils/componentUtils.js'; | ||
|
|
||
| const RULE_NAME = 'xgen-IPA-104-get-method-returns-single-resource'; | ||
| const ERROR_MESSAGE_STANDARD_RESOURCE = | ||
| 'Get methods should return data for a single resource. This method returns an array or a paginated response.'; | ||
|
|
||
| export default (input, _, { path, documentInventory }) => { | ||
| const oas = documentInventory.resolved; | ||
| const resourcePath = path[1]; | ||
| const resourcePaths = getResourcePaths(resourcePath, Object.keys(oas.paths)); | ||
|
|
||
| if (isCustomMethod(resourcePath) || (!isChild(resourcePath) && !isSingletonResource(resourcePaths))) { | ||
| return; | ||
| } | ||
|
|
||
| const errors = []; | ||
|
|
||
| const responseSchemas = getAllSuccessfulResponseSchemas(input); | ||
| responseSchemas.forEach(({ schemaPath, schema }) => { | ||
| const fullPath = path.concat(schemaPath); | ||
| const responseObject = resolveObject(oas, fullPath); | ||
|
|
||
| if (hasException(responseObject, RULE_NAME)) { | ||
| collectException(responseObject, RULE_NAME, fullPath); | ||
| } else if (schemaIsPaginated(schema) || schemaIsArray(schema)) { | ||
| collectAndReturnViolation(fullPath, RULE_NAME, ERROR_MESSAGE_STANDARD_RESOURCE); | ||
| errors.push({ path: fullPath, message: ERROR_MESSAGE_STANDARD_RESOURCE }); | ||
| } else { | ||
| collectAdoption(fullPath, RULE_NAME); | ||
| } | ||
| }); | ||
|
|
||
| return 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
Oops, something went wrong.
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.
Question - when we have PR level job does this validator runs against dev or production schema?
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.
It will be for the dev schema
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.
Perfect!