feat(ipa): error on unneeded exceptions IPA 105-107 (#878)

Author: lovisaberggren

tools/spectral/ipa/__tests__/IPA106CreateMethodRequestBodyIsGetResponse.test.js

@@ -563,7 +563,7 @@ testRule('xgen-IPA-106-create-method-request-body-is-get-method-response', [
                 content: {
                   'application/vnd.atlas.2023-01-01+json': {
                     schema: {
-                      $ref: '#/components/schemas/SchemaTwoResponse',
+                      $ref: '#/components/schemas/SchemaThree',
                     },
                   },
                 },

tools/spectral/ipa/__tests__/IPA107UpdateMethodRequestBodyIsGetResponse.test.js

@@ -681,15 +681,15 @@ testRule('xgen-IPA-107-update-method-request-body-is-get-method-response', [
               content: {
                 'application/vnd.atlas.2023-01-01+json': {
                   schema: {
-                    $ref: '#/components/schemas/SchemaTwoRequest',
+                    $ref: '#/components/schemas/SchemaThree',
                   },
                   'x-xgen-IPA-exception': {
                     'xgen-IPA-107-update-method-request-body-is-get-method-response': 'reason',
                   },
                 },
                 'application/vnd.atlas.2024-01-01+json': {
                   schema: {
-                    $ref: '#/components/schemas/SchemaTwoRequest',
+                    $ref: '#/components/schemas/SchemaThree',
                   },
                   'x-xgen-IPA-exception': {
                     'xgen-IPA-107-update-method-request-body-is-get-method-response': 'reason',

tools/spectral/ipa/ipa-spectral.yaml

@@ -129,3 +129,7 @@ overrides:
       - '**#/paths/~1api~1atlas~1v2~1groups~1%7BgroupId%7D'
     rules:
       xgen-IPA-104-get-method-response-has-no-input-fields: 'off'
+  - files: # To be removed in CLOUDP-337392
+      - '**#/paths/~1api~1atlas~1v2~1groups~1%7BgroupId%7D~1pushBasedLogExport'
+    rules:
+      xgen-IPA-106-create-method-request-has-no-readonly-fields: 'off'

tools/spectral/ipa/rulesets/functions/IPA105EachResourceHasListMethod.js

@@ -4,8 +4,7 @@ import {
   getResourcePathItems,
   isResourceCollectionIdentifier,
 } from './utils/resourceEvaluation.js';
-import { hasException } from './utils/exceptions.js';
-import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js';
+import { evaluateAndCollectAdoptionStatus } from './utils/collectionUtils.js';
 
 const RULE_NAME = 'xgen-IPA-105-resource-has-list';
 const ERROR_MESSAGE = 'APIs must provide a List method for resources.';
@@ -17,16 +16,8 @@ export default (input, _, { path, documentInventory }) => {
     return;
   }
 
-  if (hasException(oas.paths[input], RULE_NAME)) {
-    collectException(oas.paths[input], RULE_NAME, path);
-    return;
-  }
-
   const errors = checkViolationsAndReturnErrors(oas.paths[input], input, path);
-  if (errors.length !== 0) {
-    return collectAndReturnViolation(path, RULE_NAME, errors);
-  }
-  collectAdoption(path, RULE_NAME);
+  return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, oas.paths[input], path);
 };
 
 function checkViolationsAndReturnErrors(pathItem, input, path) {

tools/spectral/ipa/rulesets/functions/IPA105ListMethodHasNoRequestBody.js

@@ -1,5 +1,4 @@
-import { hasException } from './utils/exceptions.js';
-import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js';
+import { evaluateAndCollectAdoptionStatus } from './utils/collectionUtils.js';
 import {
   getResourcePathItems,
   isResourceCollectionIdentifier,
@@ -20,17 +19,9 @@ export default (input, _, { path, documentInventory }) => {
     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);
-  }
-  collectAdoption(path, RULE_NAME);
+  return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
 };
 
 function checkViolationsAndReturnErrors(getOperationObject, path) {

tools/spectral/ipa/rulesets/functions/IPA105ListMethodResponseIsGetMethodResponse.js

@@ -4,13 +4,7 @@ import {
   isSingletonResource,
 } from './utils/resourceEvaluation.js';
 import { resolveObject } from './utils/componentUtils.js';
-import { hasException } from './utils/exceptions.js';
-import {
-  collectAdoption,
-  collectAndReturnViolation,
-  collectException,
-  handleInternalError,
-} from './utils/collectionUtils.js';
+import { evaluateAndCollectAdoptionStatus, handleInternalError } from './utils/collectionUtils.js';
 import { getSchemaRef, getSchemaNameFromRef, getResponseOfGetMethodByMediaType } from './utils/methodUtils.js';
 import { schemaIsPaginated } from './utils/schemaUtils.js';
 
@@ -38,11 +32,6 @@ export default (input, _, { path, documentInventory }) => {
     return;
   }
 
-  if (hasException(listMethodResponse, RULE_NAME)) {
-    collectException(listMethodResponse, RULE_NAME, path);
-    return;
-  }
-
   // Get list response schema from ref or inline schema
   let resolvedListSchema;
   const listSchemaRef = getSchemaRef(listMethodResponse.schema);
@@ -70,11 +59,7 @@ export default (input, _, { path, documentInventory }) => {
     getMethodResponseContentPerMediaType
   );
 
-  if (errors.length !== 0) {
-    return collectAndReturnViolation(path, RULE_NAME, errors);
-  }
-
-  collectAdoption(path, RULE_NAME);
+  return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, listMethodResponse, path);
 };
 
 function checkViolationsAndReturnErrors(path, listMethodResultItems, getMethodResponseContent) {

tools/spectral/ipa/rulesets/functions/IPA105ListResponseCodeShouldBe200OK.js

@@ -1,5 +1,4 @@
-import { hasException } from './utils/exceptions.js';
-import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js';
+import { evaluateAndCollectAdoptionStatus } from './utils/collectionUtils.js';
 import {
   getResourcePathItems,
   isResourceCollectionIdentifier,
@@ -21,15 +20,7 @@ export default (input, _, { path, documentInventory }) => {
   ) {
     return;
   }
-  if (hasException(input, RULE_NAME)) {
-    collectException(input, RULE_NAME, path);
-    return;
-  }
 
   const errors = checkResponseCodeAndReturnErrors(input, '200', path, RULE_NAME, ERROR_MESSAGE);
-
-  if (errors.length !== 0) {
-    return collectAndReturnViolation(path, RULE_NAME, errors);
-  }
-  return collectAdoption(path, RULE_NAME);
+  return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
 };

tools/spectral/ipa/rulesets/functions/IPA105ValidOperationID.js

@@ -1,10 +1,4 @@
-import { hasException } from './utils/exceptions.js';
-import {
-  collectAdoption,
-  collectAndReturnViolation,
-  collectException,
-  handleInternalError,
-} from './utils/collectionUtils.js';
+import { evaluateAndCollectAdoptionStatus, handleInternalError } from './utils/collectionUtils.js';
 import { getResourcePathItems } from './utils/resourceEvaluation.js';
 import { isInvalidListMethod } from './utils/methodLogic.js';
 import { hasCustomMethodOverride, hasMethodVerbOverride, VERB_OVERRIDE_EXTENSION } from './utils/extensions.js';
@@ -25,23 +19,13 @@ export default (input, { methodName }, { path, documentInventory }) => {
     return;
   }
 
-  if (hasException(input, RULE_NAME)) {
-    collectException(input, RULE_NAME, path);
-    return;
-  }
-
   if (hasMethodVerbOverride(input, methodName)) {
     methodName = input[VERB_OVERRIDE_EXTENSION].verb;
   }
 
   try {
     const errors = validateOperationIdAndReturnErrors(methodName, resourcePath, input, path);
-
-    if (errors.length > 0) {
-      return collectAndReturnViolation(path, RULE_NAME, errors);
-    }
-
-    return collectAdoption(path, RULE_NAME);
+    return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
   } catch (e) {
     return handleInternalError(RULE_NAME, path, e);
   }

tools/spectral/ipa/rulesets/functions/IPA106CreateMethodRequestBodyIsGetResponse.js

@@ -5,8 +5,7 @@ import {
   isSingletonResource,
 } from './utils/resourceEvaluation.js';
 import { resolveObject } from './utils/componentUtils.js';
-import { hasException } from './utils/exceptions.js';
-import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js';
+import { evaluateAndCollectAdoptionStatus } from './utils/collectionUtils.js';
 import { getResponseOfGetMethodByMediaType } from './utils/methodUtils.js';
 import { checkRequestResponseResourceEqualityAndReturnErrors } from './utils/validations/checkRequestResponseResourceEqualityAndReturnErrors.js';
 
@@ -43,11 +42,6 @@ export default (input, _, { path, documentInventory }) => {
     return;
   }
 
-  if (hasException(postRequestContentPerMediaType, RULE_NAME)) {
-    collectException(postRequestContentPerMediaType, RULE_NAME, path);
-    return;
-  }
-
   const postRequestContentPerMediaTypeUnresolved = resolveObject(unresolvedOas, path);
   const getResponseContentPerMediaTypeUnresolved = getResponseOfGetMethodByMediaType(
     mediaType,
@@ -65,10 +59,5 @@ export default (input, _, { path, documentInventory }) => {
     'Get',
     ERROR_MESSAGE
   );
-
-  if (errors.length !== 0) {
-    return collectAndReturnViolation(path, RULE_NAME, errors);
-  }
-
-  collectAdoption(path, RULE_NAME);
+  return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, postRequestContentPerMediaType, path);
 };

tools/spectral/ipa/rulesets/functions/IPA106CreateMethodRequestBodyIsRequestSuffixedObject.js

@@ -1,5 +1,4 @@
-import { hasException } from './utils/exceptions.js';
-import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js';
+import { evaluateAndCollectAdoptionStatus } from './utils/collectionUtils.js';
 import {
   getResourcePathItems,
   isCustomMethodIdentifier,
@@ -27,15 +26,6 @@ export default (input, _, { path, documentInventory }) => {
     return;
   }
 
-  if (hasException(contentPerMediaType, RULE_NAME)) {
-    collectException(contentPerMediaType, RULE_NAME, path);
-    return;
-  }
-
   const errors = checkSchemaRefSuffixAndReturnErrors(path, contentPerMediaType, 'Request', RULE_NAME);
-
-  if (errors.length !== 0) {
-    return collectAndReturnViolation(path, RULE_NAME, errors);
-  }
-  collectAdoption(path, RULE_NAME);
+  return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, contentPerMediaType, path);
 };