CLOUDP-304967: Add IPA rule for description format

Author: lovisaberggren

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

@@ -0,0 +1,102 @@
+import testRule from './__helpers__/testRule';
+import { DiagnosticSeverity } from '@stoplight/types';
+
+testRule('xgen-IPA-117-description-uppercase-period', [
+  {
+    name: 'valid description',
+    document: {
+      components: {
+        schemas: {
+          Schema: {
+            properties: {
+              id: {
+                description: 'Description.',
+              },
+            },
+          },
+        },
+      },
+    },
+    errors: [],
+  },
+  {
+    name: 'invalid descriptions',
+    document: {
+      components: {
+        schemas: {
+          Schema: {
+            properties: {
+              noPeriod: {
+                description: 'Description',
+              },
+              noUpperCase: {
+                description: 'description.',
+              },
+              noUpperCaseNoPeriod: {
+                description: 'description',
+              },
+            },
+          },
+        },
+      },
+    },
+    errors: [
+      {
+        code: 'xgen-IPA-117-description-uppercase-period',
+        message: 'Descriptions must end with a full stop(.).',
+        path: ['components', 'schemas', 'Schema', 'properties', 'noPeriod'],
+        severity: DiagnosticSeverity.Warning,
+      },
+      {
+        code: 'xgen-IPA-117-description-uppercase-period',
+        message: 'Descriptions must start with Uppercase.',
+        path: ['components', 'schemas', 'Schema', 'properties', 'noUpperCase'],
+        severity: DiagnosticSeverity.Warning,
+      },
+      {
+        code: 'xgen-IPA-117-description-uppercase-period',
+        message: 'Descriptions must start with Uppercase.',
+        path: ['components', 'schemas', 'Schema', 'properties', 'noUpperCaseNoPeriod'],
+        severity: DiagnosticSeverity.Warning,
+      },
+      {
+        code: 'xgen-IPA-117-description-uppercase-period',
+        message: 'Descriptions must end with a full stop(.).',
+        path: ['components', 'schemas', 'Schema', 'properties', 'noUpperCaseNoPeriod'],
+        severity: DiagnosticSeverity.Warning,
+      },
+    ],
+  },
+  {
+    name: 'invalid components with exceptions',
+    document: {
+      components: {
+        schemas: {
+          Schema: {
+            properties: {
+              noPeriod: {
+                description: 'Description',
+                'x-xgen-IPA-exception': {
+                  'xgen-IPA-117-description-uppercase-period': 'reason',
+                },
+              },
+              noUpperCase: {
+                description: 'description.',
+                'x-xgen-IPA-exception': {
+                  'xgen-IPA-117-description-uppercase-period': 'reason',
+                },
+              },
+              noUpperCaseNoPeriod: {
+                description: 'description',
+                'x-xgen-IPA-exception': {
+                  'xgen-IPA-117-description-uppercase-period': 'reason',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+    errors: [],
+  },
+]);

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

@@ -3,6 +3,7 @@
 
 functions:
   - IPA117HasDescription
+  - IPA117DescriptionUpperCasePeriod
 
 rules:
   xgen-IPA-117-description:
@@ -30,3 +31,27 @@ rules:
       - '$.components.parameters[*]'
     then:
       function: 'IPA117HasDescription'
+  xgen-IPA-117-description-uppercase-period:
+    description: |
+      Descriptions must start with Uppercase and end with a full stop(.)
+
+      ##### Implementation details
+      Rule checks the format of the description property in the following components:
+        - Info object
+        - Tags
+        - Operation objects
+        - Inline schema properties for operation object requests and responses
+        - Parameter objects (in operations and components)
+        - Schema properties
+    message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-117-description-uppercase-period'
+    severity: warn
+    given:
+      - '$.info'
+      - '$.tags[*]'
+      - '$.paths[*][get,put,post,delete,options,head,patch,trace]'
+      - '$.paths[*][get,put,post,delete,options,head,patch,trace].parameters[*]'
+      - '$.paths[*][get,put,post,delete,options,head,patch,trace]..content..properties[*]'
+      - '$.components.schemas..properties[*]'
+      - '$.components.parameters[*]'
+    then:
+      function: 'IPA117DescriptionUpperCasePeriod'

tools/spectral/ipa/rulesets/README.md

@@ -535,6 +535,20 @@ Rule checks for description property in the following components:
   - Schema properties
 The rule also fails if the description is an empty string.
 
+#### xgen-IPA-117-description-uppercase-period
+
+ ![warn](https://img.shields.io/badge/warning-yellow) 
+Descriptions must start with Uppercase and end with a full stop(.)
+
+##### Implementation details
+Rule checks the format of the description property in the following components:
+  - Info object
+  - Tags
+  - Operation objects
+  - Inline schema properties for operation object requests and responses
+  - Parameter objects (in operations and components)
+  - Schema properties
+
 
 
 ### IPA-123

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

@@ -0,0 +1,46 @@
+import { hasException } from './utils/exceptions.js';
+import {
+  collectAdoption,
+  collectAndReturnViolation,
+  collectException,
+  handleInternalError,
+} from './utils/collectionUtils.js';
+
+const RULE_NAME = 'xgen-IPA-117-description-uppercase-period';
+const ERROR_MESSAGE_PERIOD = 'Descriptions must end with a full stop(.).';
+const ERROR_MESSAGE_UPPER_CASE = 'Descriptions must start with Uppercase.';
+
+export default (input, opts, { path }) => {
+  if (!input['description']) {
+    return;
+  }
+
+  if (hasException(input, RULE_NAME)) {
+    collectException(input, RULE_NAME, path);
+    return;
+  }
+
+  const errors = checkViolationsAndReturnErrors(input['description'], path);
+  if (errors.length !== 0) {
+    return collectAndReturnViolation(path, RULE_NAME, errors);
+  }
+  collectAdoption(path, RULE_NAME);
+};
+
+function checkViolationsAndReturnErrors(description, path) {
+  const upperCaseStart = new RegExp(`^[A-Z]`);
+  const periodEnd = new RegExp(`[.]$`);
+  const errors = [];
+
+  try {
+    if (!upperCaseStart.test(description)) {
+      errors.push({ path, message: ERROR_MESSAGE_UPPER_CASE });
+    }
+    if (!periodEnd.test(description)) {
+      errors.push({ path, message: ERROR_MESSAGE_PERIOD });
+    }
+    return errors;
+  } catch (e) {
+    handleInternalError(RULE_NAME, path, e);
+  }
+}