-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(path-param-not-crn): add new spectral-style rule
This commit introduces the new spectral-style 'path-param-not-crn' validation rule which will verify that there are no path parameters that are defined as a CRN (Cloud Resource Name) value. Signed-off-by: Phil Adams <[email protected]>
- Loading branch information
Showing
7 changed files
with
404 additions
and
0 deletions.
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| const { | ||
| isStringSchema, | ||
| checkCompositeSchemaForConstraint | ||
| } = require('../utils'); | ||
|
|
||
| module.exports = function(pathParam, _opts, { path }) { | ||
| return pathParamNotCRN(pathParam, path); | ||
| }; | ||
|
|
||
| /** | ||
| * This function will check "pathParam" (assumed to be a path parameter object) | ||
| * to make sure that it is not defined as a "CRN" (Cloud Resource Name) value. | ||
| * @param {*} pathParam the path parameter object to check | ||
| * @param {*} path the jsonpath location of "pathParam" within the API definition | ||
| * @returns an array containing the violations found or [] if no violations | ||
| */ | ||
| function pathParamNotCRN(pathParam, path) { | ||
| const subPath = isCRNParameter(pathParam); | ||
| if (subPath && subPath.length > 0) { | ||
| return [ | ||
| { | ||
| message: 'Path parameter should not be defined as a CRN value', | ||
| path: [...path, ...subPath] | ||
| } | ||
| ]; | ||
| } | ||
|
|
||
| return []; | ||
| } | ||
|
|
||
| /** | ||
| * This function checks to see if the specified parameter object "p" is defined as a CRN-like value. | ||
| * If "p" does not appear to be defined as a CRN-like value, then [] is returned. | ||
| * If "p" does appear to be defined as a CRN-like value, then the return value will be a | ||
| * list of one or more jsonpath segments that represent the relative location of the violation | ||
| * (relative to "p"'s location within the API definition) | ||
| * @param {} p the parameter object to check | ||
| * @returns a list of zero or more jsonpath segments to indicate that a violation | ||
| * was found at that relative location | ||
| */ | ||
| function isCRNParameter(p) { | ||
| // Check if the parameter name contains "crn". | ||
| if ( | ||
| p.name && | ||
| typeof p.name === 'string' && | ||
| /crn/.test(p.name.toLowerCase()) | ||
| ) { | ||
| return ['name']; | ||
| } | ||
|
|
||
| // Grab the parameter's schema object. | ||
| let schema = p.schema; | ||
| if (!schema) { | ||
| // If not set directly on the parameter, grab the first schema within the content map instead. | ||
| if (p.content && typeof p.content === 'object' && p.content.size > 0) { | ||
| schema = p.content.values()[0]; | ||
| } | ||
| } | ||
|
|
||
| // Check if the schema is defined as type=string/format=crn. | ||
| if ( | ||
| schema && | ||
| isStringSchema(schema) && | ||
| checkCompositeSchemaForConstraint(schema, s => s.format === 'crn') | ||
| ) { | ||
| return ['schema', 'format']; | ||
| } | ||
|
|
||
| // Check if the schema defines a pattern field that starts with "crn" or "^crn". | ||
| if ( | ||
| schema && | ||
| checkCompositeSchemaForConstraint( | ||
| schema, | ||
| s => | ||
| s.pattern && | ||
| typeof s.pattern === 'string' && | ||
| /^\^?crn.*/.test(s.pattern.trim().toLowerCase()) | ||
| ) | ||
| ) { | ||
| return ['schema', 'pattern']; | ||
| } | ||
|
|
||
| // Check if the parameter's "example" field is a CRN-like value. | ||
| if (p.example && isCRNValue(p.example)) { | ||
| return ['example']; | ||
| } | ||
|
|
||
| // Check if the parameter's "examples" field contains an entry with a CRN-like value. | ||
| if (p.examples && typeof p.examples === 'object') { | ||
| for (const [name, obj] of Object.entries(p.examples)) { | ||
| if (obj && obj.value && isCRNValue(obj.value)) { | ||
| return ['examples', name, 'value']; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Check if the parameter schema's "example" field is a CRN-like value. | ||
| if (schema && schema.example && isCRNValue(schema.example)) { | ||
| return ['schema', 'example']; | ||
| } | ||
|
|
||
| // Check if the parameter's description contains "CRN" or "Cloud Resource Name". | ||
| if (isCRNInDescription(p)) { | ||
| return ['description']; | ||
| } | ||
|
|
||
| // Check if the parameter schema's description contains "CRN" or "Cloud Resource Name". | ||
| if (isCRNInDescription(schema)) { | ||
| return ['schema', 'description']; | ||
| } | ||
|
|
||
| // If we made it through the gauntlet unscathed, then return an empty list to | ||
| // indicate no violations. | ||
| return []; | ||
| } | ||
|
|
||
| /** | ||
| * Returns true iff the specified example value appears to be an example of | ||
| * a CRN value. | ||
| * @param {} value the value to check | ||
| * @return boolean | ||
| */ | ||
| function isCRNValue(value) { | ||
| return value && typeof value === 'string' && /^crn:.*/.test(value.trim()); | ||
| } | ||
|
|
||
| /** | ||
| * Returns true iff "obj" is an object with a "description" field that contains | ||
| * "CRN" or "Cloud Resource Name". | ||
| * @param {*} obj the objet whose "description" field should be checked | ||
| * @return boolean | ||
| */ | ||
| function isCRNInDescription(obj) { | ||
| return ( | ||
| obj && | ||
| obj.description && | ||
| typeof obj.description === 'string' && | ||
| /^.*((CRN)|(Cloud\s*Resource\s*Name)).*$/.test(obj.description) | ||
| ); | ||
| } |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| const { oas2, oas3 } = require('@stoplight/spectral-formats'); | ||
| const { pathParamNotCRN } = require('../functions'); | ||
|
|
||
| module.exports = { | ||
| description: | ||
| 'Path parameter should not be defined as a CRN (Cloud Resource Name) value', | ||
| message: '{{error}}', | ||
| formats: [oas2, oas3], | ||
| given: [ | ||
| '$.paths[*].parameters[?(@.in === "path")]', | ||
| '$.paths[*][get,put,post,delete,options,head,patch,trace].parameters[?(@.in === "path")]' | ||
| ], | ||
| severity: 'warn', | ||
| resolved: true, | ||
| then: { | ||
| function: pathParamNotCRN | ||
| } | ||
| }; |
Oops, something went wrong.