CLOUDP-304958: IPA rule singleton must not have delete

Author: lovisaberggren

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

@@ -0,0 +1,59 @@
+import testRule from './__helpers__/testRule';
+import { DiagnosticSeverity } from '@stoplight/types';
+
+testRule('xgen-IPA-113-singleton-must-not-have-delete-method', [
+  {
+    name: 'valid resources',
+    document: {
+      paths: {
+        '/resource': {
+          post: {},
+          get: {},
+        },
+        '/resource/{exampleId}': {
+          get: {},
+          patch: {},
+          delete: {},
+        },
+        '/resource/{exampleId}/singleton': {
+          get: {},
+          patch: {},
+        },
+      },
+    },
+    errors: [],
+  },
+  {
+    name: 'invalid resource',
+    document: {
+      paths: {
+        '/resource/{exampleId}/singleton': {
+          delete: {},
+        },
+      },
+    },
+    errors: [
+      {
+        code: 'xgen-IPA-113-singleton-must-not-have-delete-method',
+        message:
+          'Singleton resources must not define the Delete standard method. If this is not a singleton resource, please implement all CRUDL methods.',
+        path: ['paths', '/resource/{exampleId}/singleton'],
+        severity: DiagnosticSeverity.Warning,
+      },
+    ],
+  },
+  {
+    name: 'invalid resources with exceptions',
+    document: {
+      paths: {
+        '/resource/{exampleId}/singleton': {
+          delete: {},
+          'x-xgen-IPA-exception': {
+            'xgen-IPA-113-singleton-must-not-have-delete-method': 'reason',
+          },
+        },
+      },
+    },
+    errors: [],
+  },
+]);

tools/spectral/ipa/rulesets/IPA-113.yaml

@@ -3,6 +3,7 @@
 
 functions:
   - IPA113SingletonHasNoId
+  - IPA113SingletonHasNoDeleteMethod
 
 rules:
   xgen-IPA-113-singleton-must-not-have-id:
@@ -21,3 +22,16 @@ rules:
     given: '$.paths[*]'
     then:
       function: 'IPA113SingletonHasNoId'
+  xgen-IPA-113-singleton-must-not-have-delete-method:
+    description: |
+      Singleton resources must not define the Delete standard method
+
+      ##### Implementation details
+      Rule checks for the following conditions:
+        - Applies only to singleton resources
+        - Checks that the resource does not have a DELETE method defined
+    message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-113-singleton-must-not-have-delete-method'
+    severity: warn
+    given: '$.paths[*]'
+    then:
+      function: 'IPA113SingletonHasNoDeleteMethod'

tools/spectral/ipa/rulesets/README.md

@@ -482,6 +482,16 @@ Rule checks for the following conditions:
   - Verifies that no schema contains 'id' or '_id' properties in their object definitions
   - Fails if any response schema contains these identifier properties
 
+#### xgen-IPA-113-singleton-must-not-have-delete-method
+
+ ![warn](https://img.shields.io/badge/warning-yellow) 
+Singleton resources must not define the Delete standard method
+
+##### Implementation details
+Rule checks for the following conditions:
+  - Applies only to singleton resources
+  - Checks that the resource does not have a DELETE method defined
+
 
 
 ### IPA-123

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

@@ -0,0 +1,49 @@
+import {
+  getResourcePathItems,
+  isSingletonResource,
+  isResourceCollectionIdentifier,
+  hasDeleteMethod,
+} from './utils/resourceEvaluation.js';
+import { hasException } from './utils/exceptions.js';
+import {
+  collectAdoption,
+  collectAndReturnViolation,
+  collectException,
+  handleInternalError,
+} from './utils/collectionUtils.js';
+
+const RULE_NAME = 'xgen-IPA-113-singleton-must-not-have-delete-method';
+const ERROR_MESSAGE =
+  'Singleton resources must not define the Delete standard method. If this is not a singleton resource, please implement all CRUDL methods.';
+
+export default (input, opts, { path, documentInventory }) => {
+  const oas = documentInventory.resolved;
+  const resourcePath = path[1];
+  const resourcePathItems = getResourcePathItems(resourcePath, oas.paths);
+
+  if (!(isResourceCollectionIdentifier(resourcePath) && isSingletonResource(resourcePathItems))) {
+    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);
+};
+
+function checkViolationsAndReturnErrors(input, path) {
+  try {
+    if (hasDeleteMethod(input)) {
+      return [{ path, message: ERROR_MESSAGE }];
+    }
+    return [];
+  } catch (e) {
+    handleInternalError(RULE_NAME, path, e);
+  }
+}

tools/spectral/ipa/rulesets/functions/utils/resourceEvaluation.js

@@ -102,6 +102,16 @@ export function hasPostMethod(pathObject) {
   return Object.keys(pathObject).includes('post');
 }
 
+/**
+ * Checks if a path object has a DELETE method
+ *
+ * @param pathObject the path object to evaluate
+ * @returns {boolean}
+ */
+export function hasDeleteMethod(pathObject) {
+  return Object.keys(pathObject).includes('delete');
+}
+
 /**
  * Get all path items for a resource based on the path for the resource collection
  * For example, resource collection path '/resource' may return path items for ['/resource', '/resource{id}', '/resource{id}:customMethod']