add new validation that checks if info is an object as well as test cases and more compact code

Author: System Administrator

README.md

@@ -171,12 +171,6 @@ The supported categories are described below:
 Each category contains a group of rules. The spec that each rule applies to is marked in the third column. For the actual configuration structure, see the [default values](#default-values).
 The supported rules are described below:
 
-##### rules
-| Rule                         | Description                                                                         | Spec     |
-| ---------------------------- | ----------------------------------------------------------------------------------- | -------- |
-| no_info  | Flag missing info field in api defintion.                              | shared   |
-| mistyped_version_or_title         | Flag version or title that are not strings.                                                                            | shared   |
-
 ##### operations
 | Rule                         | Description                                                                         | Spec     |
 | ---------------------------- | ----------------------------------------------------------------------------------- | -------- |
@@ -334,13 +328,6 @@ The default values for each rule are described below.
 
 ##### shared
 
-
-###### operations
-| Rule                         | Default |
-| ---------------------------- | ------- |
-| no_info                      | error   |
-| mistyped_title_or_version    | error   |
-
 ###### operations
 | Rule                         | Default |
 | ---------------------------- | ------- |

src/.defaultsForValidator.js

@@ -20,10 +20,6 @@
 
 const defaults = {
   'shared': {
-    'info':{
-      'no_info': 'error',
-      'mistyped_title_or_version': 'error'
-    },
     'operations': {
       'no_operation_id': 'warning',
       'operation_id_case_convention': ['warning', 'lower_snake_case'],

src/plugins/validation/2and3/semantic-validators/info.js

@@ -6,28 +6,35 @@
 module.exports.validate = function({ jsSpec }) {
   const errors = [];
   const warnings = [];
-  const no_input = !jsSpec.info;
-  let mistyped_title_or_version = false;
-  if (no_input) {
+  const info = jsSpec.info;
+  if (!info) {
     errors.push({
       path: ['info'],
       message: 'Missing info object for api defintion'
     });
-  }
-  //Assertion 2
-  if (
-    jsSpec.info &&
-    (typeof jsSpec.info.title != 'string' ||
-      typeof jsSpec.info.version != 'string')
-  ) {
-    mistyped_title_or_version = true;
-  }
-  if (mistyped_title_or_version) {
+  } else if (typeof info != 'object') {
     errors.push({
-      path: ['info', 'title'],
-      message:
-        'Info object missing proper definitions for title or version properties'
+      path: ['info'],
+      message: 'Info is an obect and must have properties'
     });
+  } else {
+    const title = jsSpec.info.title;
+    const hasTitle =
+      typeof title === 'string' && title.toString().trim().length > 0;
+    const version = jsSpec.info.version;
+    const hasVersion =
+      typeof version === 'string' && version.toString().trim().length > 0;
+    if (!hasTitle) {
+      errors.push({
+        path: ['info', 'title'],
+        message: ' Info object is missng the title field'
+      });
+    } else if (!hasVersion) {
+      errors.push({
+        path: ['info', 'version'],
+        message: ' Info object is missng the version field'
+      });
+    }
   }
-  return { errors: errors, warnings: warnings };
+  return { errors, warnings };
 };

test/plugins/validation/2and3/info.js

@@ -13,28 +13,85 @@ describe('validation plugin - semantic - error handling for incorrect formatting
       };
 
       const res = validate({ jsSpec: spec }, config);
-      //expect(res.warnings.length).toEqual(0);
       expect(res.errors.length).toEqual(1);
       expect(res.errors[0].path).toEqual(['info']);
       expect(res.errors[0].message).toEqual(
         'Missing info object for api defintion'
       );
     });
-    it('should return an error when a title and version are not strings', () => {
+    it('should return an error when a title and version is not a string', () => {
       const spec = {
         Openapi: '3.0.0',
         info: {
           title: 32,
-          version: 1
+          version: '32'
         }
       };
 
       const res = validate({ jsSpec: spec }, config);
-      //expect(res.warnings.length).toEqual(0);
       expect(res.errors.length).toEqual(1);
       expect(res.errors[0].path).toEqual(['info', 'title']);
       expect(res.errors[0].message).toEqual(
-        'Info object missing proper definitions for title or version properties'
+        ' Info object is missng the title field'
+      );
+    });
+    it('should return an error when a title and version is not a string', () => {
+      const spec = {
+        Openapi: '3.0.0',
+        info: {
+          title: '32',
+          version: 32
+        }
+      };
+
+      const res = validate({ jsSpec: spec }, config);
+      expect(res.errors.length).toEqual(1);
+      expect(res.errors[0].path).toEqual(['info', 'version']);
+      expect(res.errors[0].message).toEqual(
+        ' Info object is missng the version field'
+      );
+    });
+    it('should return an error when a title is missing', () => {
+      const spec = {
+        Openapi: '3.0.0',
+        info: {
+          version: '32'
+        }
+      };
+
+      const res = validate({ jsSpec: spec }, config);
+      expect(res.errors.length).toEqual(1);
+      expect(res.errors[0].path).toEqual(['info', 'title']);
+      expect(res.errors[0].message).toEqual(
+        ' Info object is missng the title field'
+      );
+    });
+    it('should return an error when a version is missing', () => {
+      const spec = {
+        Openapi: '3.0.0',
+        info: {
+          title: '32'
+        }
+      };
+
+      const res = validate({ jsSpec: spec }, config);
+      expect(res.errors.length).toEqual(1);
+      expect(res.errors[0].path).toEqual(['info', 'version']);
+      expect(res.errors[0].message).toEqual(
+        ' Info object is missng the version field'
+      );
+    });
+    it('should return an error when a info is not defined as a proper object', () => {
+      const spec = {
+        Openapi: '3.0.0',
+        info: 'abc'
+      };
+
+      const res = validate({ jsSpec: spec }, config);
+      expect(res.errors.length).toEqual(1);
+      expect(res.errors[0].path).toEqual(['info']);
+      expect(res.errors[0].message).toEqual(
+        'Info is an obect and must have properties'
       );
     });
   });