CLOUDP-328959: Added tests for validating IPA107 valid operationIds

Author: Sophia Marie Terry

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

@@ -0,0 +1,88 @@
+import testRule from './__helpers__/testRule';
+import { DiagnosticSeverity } from '@stoplight/types';
+
+// TODO: add tests for xgen-custom-method extension - CLOUDP-306294
+// TOOD: enable tests for invalid methods (after rules are upgraded to warning) - CLOUDP-329722
+
+const componentSchemas = {
+  schemas: {
+    Schema: {
+      type: 'object',
+    },
+  },
+  operationId: 'string',
+};
+
+testRule('xgen-IPA-107-valid-operation-id', [
+  {
+    name: 'valid methods',
+    document: {
+      components: componentSchemas,
+      paths: {
+        'groups/{groupId}/clusters/{clusterName}': {
+          put: {
+            operationId: 'updateGroupCluster',
+          },
+        },
+        '/groups/{groupId}/settings': {
+          put: {
+            operationId: 'updateGroupSettings',
+          },
+        },
+      },
+    },
+    errors: [],
+  },
+  // This test will be enable when the xgen-IPA-107-valid-operation-id is set to warning severity - CLOUDP-329722
+  /* {
+    name: 'invalid methods',
+    document: {
+      components: componentSchemas,
+      paths: {
+        '/api/atlas/v2/groups/{groupId}/limits/{limitName}': {
+          patch: {
+            operationId: 'setProjectLimit',
+          },
+        },
+        '/api/atlas/v2/groups/{groupId}/settings': {
+          put: {
+            operationId: 'updateProjectSettings',
+          },
+        },
+      },
+    },
+    errors: [
+      {
+        code: 'xgen-IPA-107-valid-operation-id',
+        message:
+          'Invalid OperationID. The Operation ID must start with the verb “update” and should be followed by a noun or compound noun. The noun(s) in the Operation ID should be the collection identifiers from the resource identifier in singular form. For singleton resources - the last noun may be in plural form.',
+        path: ['paths', '/api/atlas/v2/groups/{groupId}/limits/{limitName}', 'patch'],
+        severity: DiagnosticSeverity.Warning,
+      },
+      {
+        code: 'xgen-IPA-107-valid-operation-id',
+        message:
+          'Invalid OperationID. The Operation ID must start with the verb “update” and should be followed by a noun or compound noun. The noun(s) in the Operation ID should be the collection identifiers from the resource identifier in singular form. For singleton resources - the last noun may be in plural form.',
+        path: ['paths', '/api/atlas/v2/groups/{groupId}/settings', 'put'],
+        severity: DiagnosticSeverity.Warning,
+      },
+    ],
+  }, */
+  {
+    name: 'invalid methods with exceptions',
+    document: {
+      components: componentSchemas,
+      paths: {
+        '/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index ': {
+          post: {
+            operationId: 'updateRollingIndex',
+            'x-xgen-IPA-exception': {
+              'xgen-IPA-107-valid-operation-id': 'Reason',
+            },
+          },
+        },
+      },
+    },
+    errors: [],
+  },
+]);

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

@@ -1,5 +1,4 @@
 import testRule from './__helpers__/testRule';
-import { DiagnosticSeverity } from '@stoplight/types';
 
 // TODO: add tests for xgen-custom-method extension - CLOUDP-306294
 // TOOD: enable tests for invalid methods (after rules are upgraded to warning) - CLOUDP-329722