logic fix

Author: yelizhenden-mdb

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

@@ -11,10 +11,16 @@ testRule('xgen-IPA-005-exception-extension-format', [
             'xgen-IPA-100-rule-name': 'Exception.',
           },
         },
+        '/path-short': {
+          'x-xgen-IPA-exception': {
+            'xgen-IPA-100': 'Exception.',
+          },
+        },
         '/nested': {
           post: {
             'x-xgen-IPA-exception': {
               'xgen-IPA-100-rule-name': 'Exception.',
+              'xgen-IPA-005': 'Short format exception.',
             },
           },
         },
@@ -61,6 +67,26 @@ testRule('xgen-IPA-005-exception-extension-format', [
             'xgen-IPA_100_rule-name': {},
           },
         },
+        '/path8': {
+          'x-xgen-IPA-exception': {
+            'xgen-IPA-100-': 'Exception.',
+          },
+        },
+        '/path9': {
+          'x-xgen-IPA-exception': {
+            'xgen-IPA-5': 'Exception.',
+          },
+        },
+        '/path10': {
+          'x-xgen-IPA-exception': {
+            'xgen-IPA-100': 'exception without uppercase.',
+          },
+        },
+        '/path11': {
+          'x-xgen-IPA-exception': {
+            'xgen-IPA-100': 'Exception without period',
+          },
+        },
       },
     },
     errors: [
@@ -106,6 +132,30 @@ testRule('xgen-IPA-005-exception-extension-format', [
         path: ['paths', '/path7', 'x-xgen-IPA-exception'],
         severity: DiagnosticSeverity.Error,
       },
+      {
+        code: 'xgen-IPA-005-exception-extension-format',
+        message: 'IPA exceptions must have a valid key following xgen-IPA-XXX-{rule-name} format.',
+        path: ['paths', '/path8', 'x-xgen-IPA-exception'],
+        severity: DiagnosticSeverity.Error,
+      },
+      {
+        code: 'xgen-IPA-005-exception-extension-format',
+        message: 'IPA exceptions must have a valid key following xgen-IPA-XXX-{rule-name} format.',
+        path: ['paths', '/path9', 'x-xgen-IPA-exception'],
+        severity: DiagnosticSeverity.Error,
+      },
+      {
+        code: 'xgen-IPA-005-exception-extension-format',
+        message: 'IPA exceptions must have a non-empty reason that starts with uppercase and ends with a full stop.',
+        path: ['paths', '/path10', 'x-xgen-IPA-exception'],
+        severity: DiagnosticSeverity.Error,
+      },
+      {
+        code: 'xgen-IPA-005-exception-extension-format',
+        message: 'IPA exceptions must have a non-empty reason that starts with uppercase and ends with a full stop.',
+        path: ['paths', '/path11', 'x-xgen-IPA-exception'],
+        severity: DiagnosticSeverity.Error,
+      },
     ],
   },
 ]);

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

@@ -11,7 +11,7 @@ rules:
 
       ##### Implementation details
       Rule checks for the following conditions:
-        - Exception rule names must follow 'xgen-IPA-XXX-{rule-name}' format.
+        - Exception rule names must start with 'xgen-IPA-' prefix
         - Each exception must include a non-empty reason as a string that starts with uppercase and ends with a full stop
         - This rule itself does not allow exceptions
     message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-005-exception-extension-format'

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

@@ -1,9 +1,12 @@
-import { evaluateAndCollectAdoptionStatusWithoutExceptions, handleInternalError } from './utils/collectionUtils.js';
+import {
+  evaluateAndCollectAdoptionStatusWithoutExceptions,
+  handleInternalError,
+} from './utils/collectionUtils.js';
 
 const ERROR_MESSAGE_RULENAME_FORMAT = 'IPA exceptions must have a valid key following xgen-IPA-XXX-{rule-name} format.';
 const ERROR_MESSAGE_REASON_FORMAT =
   'IPA exceptions must have a non-empty reason that starts with uppercase and ends with a full stop.';
-const RULE_NAME_PATTERN = /^xgen-IPA-\d{3}-[a-z-]+$/;
+const RULE_NAME_PATTERN = /^xgen-IPA-\d{3}(?:-[a-z-]+)?$/;
 
 // Note: This rule does not allow exceptions
 export default (input, _, { path, rule }) => {