check enum values

Author: yelizhenden-mdb

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

@@ -46,6 +46,32 @@ testRule('xgen-IPA-119-no-default-for-cloud-providers', [
       },
     ],
   },
+  {
+    name: 'invalid when cloud provider field has default value',
+    document: {
+      components: {
+        schemas: {
+          Schema: {
+            properties: {
+              provider: {
+                type: 'string',
+                enum: ['AWS', 'GCP', 'AZURE'],
+                default: 'AWS',
+              },
+            },
+          },
+        },
+      },
+    },
+    errors: [
+      {
+        code: 'xgen-IPA-119-no-default-for-cloud-providers',
+        message: 'When using a provider field or param, API producers should not define a default value.',
+        path: ['components', 'schemas', 'Schema', 'properties', 'provider'],
+        severity: DiagnosticSeverity.Warning,
+      },
+    ],
+  },
   {
     name: 'valid when non-provider field has default value',
     document: {
@@ -137,6 +163,22 @@ testRule('xgen-IPA-119-no-default-for-cloud-providers', [
           },
         },
       },
+      components: {
+        schemas: {
+          Schema: {
+            properties: {
+              provider: {
+                type: 'string',
+                enum: ['AWS', 'GCP', 'AZURE'],
+                default: 'AWS',
+                'x-xgen-IPA-exception': {
+                  'xgen-IPA-119-no-default-for-cloud-providers': 'Reason',
+                },
+              },
+            },
+          },
+        },
+      },
     },
     errors: [],
   },

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

@@ -7,9 +7,9 @@ rules:
   xgen-IPA-119-no-default-for-cloud-providers:
     description: |
       When using a provider field or parameter, API producers should not define a default value.
-      As providers are added, having a default value can impact usability.
-      This rule checks fields containing "provider" or "cloudProvider" and ensures they do not have a default value.
+      This rule checks fields and parameters named "cloudProvider" and ensures they do not have a default value.
       It also checks enum fields that might contain cloud provider values.
+      All cloudProviderEnumValues should be listed in the enum array.
     severity: warn
     message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-119-no-default-for-cloud-providers'
     given:
@@ -22,3 +22,7 @@ rules:
       function: IPA119NoDefaultForCloudProviders
       functionOptions:
         propertyNameToLookFor: 'cloudProvider'
+        cloudProviderEnumValues:
+          - 'AWS'
+          - 'GCP'
+          - 'AZURE'

tools/spectral/ipa/rulesets/README.md

@@ -780,9 +780,9 @@ Rules are based on [http://go/ipa/IPA-119](http://go/ipa/IPA-119).
 
  ![warn](https://img.shields.io/badge/warning-yellow) 
 When using a provider field or parameter, API producers should not define a default value.
-As providers are added, having a default value can impact usability.
-This rule checks fields containing "provider" or "cloudProvider" and ensures they do not have a default value.
+This rule checks fields and parameters named "cloudProvider" and ensures they do not have a default value.
 It also checks enum fields that might contain cloud provider values.
+All cloudProviderEnumValues should be listed in the enum array.
 
 
 

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

@@ -9,7 +9,7 @@ import { resolveObject } from './utils/componentUtils.js';
 
 const RULE_NAME = 'xgen-IPA-119-no-default-for-cloud-providers';
 const ERROR_MESSAGE = 'When using a provider field or param, API producers should not define a default value.';
-export default (input, { propertyNameToLookFor }, { path, documentInventory }) => {
+export default (input, { propertyNameToLookFor, cloudProviderEnumValues }, { path, documentInventory }) => {
   const oas = documentInventory.resolved;
   const propertyObject = resolveObject(oas, path);
   const fieldType = path[path.length - 2];
@@ -19,14 +19,28 @@ export default (input, { propertyNameToLookFor }, { path, documentInventory }) =
     return;
   }
 
-  const errors = checkViolationsAndReturnErrors(input, propertyObject, path, propertyNameToLookFor, fieldType);
+  const errors = checkViolationsAndReturnErrors(
+    input,
+    propertyObject,
+    path,
+    propertyNameToLookFor,
+    fieldType,
+    cloudProviderEnumValues
+  );
   if (errors.length !== 0) {
     return collectAndReturnViolation(path, RULE_NAME, errors);
   }
   collectAdoption(path, RULE_NAME);
 };
 
-function checkViolationsAndReturnErrors(propertyName, propertyObject, path, propertyNameToLookFor, fieldType) {
+function checkViolationsAndReturnErrors(
+  propertyName,
+  propertyObject,
+  path,
+  propertyNameToLookFor,
+  fieldType,
+  cloudProviderEnumValues
+) {
   try {
     if (fieldType === 'properties') {
       if (propertyName === propertyNameToLookFor && propertyObject.default !== undefined) {
@@ -37,6 +51,21 @@ function checkViolationsAndReturnErrors(propertyName, propertyObject, path, prop
           },
         ];
       }
+
+      if (Array.isArray(propertyObject.enum) && propertyObject.enum.length > 0) {
+        const enumValues = propertyObject.enum;
+        const hasCloudProviderEnumValue = cloudProviderEnumValues.every((cloudProviderValue) =>
+          enumValues.includes(cloudProviderValue)
+        );
+        if (hasCloudProviderEnumValue && propertyObject.default !== undefined) {
+          return [
+            {
+              path,
+              message: ERROR_MESSAGE,
+            },
+          ];
+        }
+      }
     } else if (fieldType === 'parameters') {
       if (propertyObject.name === propertyNameToLookFor && propertyObject.schema.default !== undefined) {
         return [
@@ -46,6 +75,22 @@ function checkViolationsAndReturnErrors(propertyName, propertyObject, path, prop
           },
         ];
       }
+
+      if (Array.isArray(propertyObject.schema.enum) && propertyObject.schema.enum.length > 0) {
+        const enumValues = propertyObject.schema.enum;
+        const hasCloudProviderEnumValue = cloudProviderEnumValues.every((cloudProviderValue) =>
+          enumValues.includes(cloudProviderValue)
+        );
+
+        if (hasCloudProviderEnumValue && propertyObject.schema.default !== undefined) {
+          return [
+            {
+              path,
+              message: ERROR_MESSAGE,
+            },
+          ];
+        }
+      }
     }
 
     return [];