Merge pull request #37 from SamerJaser96/missing_info_validation

feat: added check in the validator for info section.

Author: dpopp07

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

@@ -0,0 +1,38 @@
+// Assertation 1:
+// check if info exists
+
+// Assertation 2:
+// making sure that the required version and title are defined properly
+module.exports.validate = function({ jsSpec }) {
+  const errors = [];
+  const warnings = [];
+
+  const info = jsSpec.info;
+  const hasInfo = info && typeof info === 'object';
+  if (!hasInfo) {
+    errors.push({
+      path: ['info'],
+      message: 'API definition must have an `info` object'
+    });
+  } 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 must have a string-type `title` field'
+      });
+    } else if (!hasVersion) {
+      errors.push({
+        path: ['info', 'version'],
+        message: '`info` object must have a string-type `version` field'
+      });
+    }
+  }
+  return { errors, warnings };
+};

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

@@ -0,0 +1,96 @@
+const config = require('../../../../src/.defaultsForValidator').defaults.shared;
+const expect = require('expect');
+const {
+  validate
+} = require('../../../../src/plugins/validation/2and3/semantic-validators/info');
+
+describe('validation plugin - semantic - info', () => {
+  //this is for openapi object
+  it('should return an error when a parameter does not have info', () => {
+    const spec = {
+      Openapi: '3.0.0'
+    };
+
+    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(
+      'API definition must have an `info` object'
+    );
+  });
+  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(
+      'API definition must have an `info` object'
+    );
+  });
+  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', 'title']);
+    expect(res.errors[0].message).toEqual(
+      '`info` object must have a string-type `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 must have a string-type `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 must have a string-type `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 must have a string-type `version` field'
+    );
+  });
+});