refactor: introduces MessageCarrier to simplify adding warnings and e…

…rrors

- introduced MessageCarrier class to centralize the logic/checks for adding warnings and errors.
- introduced an instance of this class in each semantic validator to provide uniform warning and error reporting
- added unit tests for the MessageCarrier class

README.md

@@ -430,7 +430,6 @@ The default values for each rule are described below.
 | array_of_arrays             | warning |
 | property_case_convention    | error, lower_snake_case |
 | enum_case_convention        | error, lower_snake_case |
-| json_or_param_binary_string | warning |
 
 ###### walker
 | Rule                          | Default |

src/.defaultsForValidator.js

@@ -64,8 +64,7 @@ const defaults = {
       'description_mentions_json': 'warning',
       'array_of_arrays': 'warning',
       'property_case_convention': [ 'error', 'lower_snake_case'],
-      'enum_case_convention': [ 'error', 'lower_snake_case'],
-      'binary_string': 'warning'
+      'enum_case_convention': [ 'error', 'lower_snake_case']
     },
     'walker': {
       'no_empty_descriptions': 'error',

src/plugins/validation/oas3/semantic-validators/operations.js

@@ -83,7 +83,7 @@ module.exports.validate = function({ resolvedSpec, jsSpec }, config) {
           }
 
           // Assertation 3
-          const binaryStringStatus = configSchemas.binary_string;
+          const binaryStringStatus = configSchemas.json_or_param_binary_string;
           if (binaryStringStatus !== 'off') {
             for (const mimeType of requestBodyMimeTypes) {
               if (mimeType === 'application/json') {

src/plugins/validation/oas3/semantic-validators/parameters.js

@@ -22,11 +22,12 @@ module.exports.validate = function({ jsSpec }, config) {
   const configSchemas = config.schemas;
   config = config.parameters;
 
-  walk(resolvedSpec, [], function(obj, path) {
+  walk(jsSpec, [], function(obj, path) {
     const isContentsOfParameterObject = isParameterObject(path, true); // 2nd arg is isOAS3
+    const isRef = !!obj.$ref;
 
     // obj is a parameter object
-    if (isContentsOfParameterObject) {
+    if (isContentsOfParameterObject && !isRef) {
       const allowedInValues = ['query', 'header', 'path', 'cookie'];
       if (!obj.in) {
         // bad because in is required

test/plugins/validation/oas3/operations.js

@@ -2,19 +2,10 @@ const expect = require('expect');
 const {
   validate
 } = require('../../../../src/plugins/validation/oas3/semantic-validators/operations');
+const config = require('../../../../src/.defaultsForValidator').defaults.oas3;
 
 describe('validation plugin - semantic - operations - oas3', function() {
   it('should complain about a request body not having a content field', function() {
-    const config = {
-      operations: {
-        no_request_body_content: 'error',
-        no_request_body_name: 'warning'
-      },
-      schemas: {
-        json_or_param_binary_string: 'warning'
-      }
-    };
-
     const spec = {
       paths: {
         '/pets': {
@@ -39,16 +30,6 @@ describe('validation plugin - semantic - operations - oas3', function() {
   });
 
   it('should warn about an operation with a non-form, array schema request body that does not set a name', function() {
-    const config = {
-      operations: {
-        no_request_body_content: 'error',
-        no_request_body_name: 'warning'
-      },
-      schemas: {
-        json_or_param_binary_string: 'warning'
-      }
-    };
-
     const spec = {
       paths: {
         '/pets': {
@@ -83,16 +64,6 @@ describe('validation plugin - semantic - operations - oas3', function() {
   });
 
   it('should not warn about an operation with a non-array json request body that does not set a name', function() {
-    const config = {
-      operations: {
-        no_request_body_content: 'error',
-        no_request_body_name: 'warning'
-      },
-      schemas: {
-        json_or_param_binary_string: 'warning'
-      }
-    };
-
     const spec = {
       paths: {
         '/pets': {
@@ -120,16 +91,6 @@ describe('validation plugin - semantic - operations - oas3', function() {
   });
 
   it('should not warn about an operation with a non-form request body that sets a name', function() {
-    const config = {
-      operations: {
-        no_request_body_content: 'error',
-        no_request_body_name: 'warning'
-      },
-      schemas: {
-        json_or_param_binary_string: 'warning'
-      }
-    };
-
     const spec = {
       paths: {
         '/pets': {
@@ -158,16 +119,6 @@ describe('validation plugin - semantic - operations - oas3', function() {
   });
 
   it('should not warn about an operation with a form request body that does not set a name', function() {
-    const config = {
-      operations: {
-        no_request_body_content: 'error',
-        no_request_body_name: 'warning'
-      },
-      schemas: {
-        json_or_param_binary_string: 'warning'
-      }
-    };
-
     const spec = {
       paths: {
         '/pets': {
@@ -200,16 +151,6 @@ describe('validation plugin - semantic - operations - oas3', function() {
   });
 
   it('should not warn about an operation with a referenced request body that does not set a name', function() {
-    const config = {
-      operations: {
-        no_request_body_content: 'error',
-        no_request_body_name: 'warning'
-      },
-      schemas: {
-        json_or_param_binary_string: 'warning'
-      }
-    };
-
     const resolvedSpec = {
       paths: {
         '/pets': {
@@ -250,16 +191,6 @@ describe('validation plugin - semantic - operations - oas3', function() {
   });
 
   it('should not crash in request body name check when path name contains a period', function() {
-    const config = {
-      operations: {
-        no_request_body_content: 'error',
-        no_request_body_name: 'warning'
-      },
-      schemas: {
-        json_or_param_binary_string: 'warning'
-      }
-    };
-
     const spec = {
       paths: {
         '/other.pets': {
@@ -294,16 +225,6 @@ describe('validation plugin - semantic - operations - oas3', function() {
   });
 
   it('should not crash when request body is behind a ref', function() {
-    const config = {
-      operations: {
-        no_request_body_content: 'error',
-        no_request_body_name: 'warning'
-      },
-      schemas: {
-        json_or_param_binary_string: 'warning'
-      }
-    };
-
     const jsSpec = {
       paths: {
         '/resource': {

test/plugins/validation/oas3/parameters.js

@@ -1,23 +1,11 @@
 const expect = require('expect');
-
 const {
   validate
 } = require('../../../../src/plugins/validation/oas3/semantic-validators/parameters');
+const config = require('../../../../src/.defaultsForValidator').defaults.oas3;
 
 describe('validation plugin - semantic - parameters - oas3', function() {
   it('should not complain when parameter is valid', function() {
-    const config = {
-      parameters: {
-        no_in_property: 'error',
-        invalid_in_property: 'error',
-        missing_schema_or_content: 'error',
-        has_schema_and_content: 'error'
-      },
-      schemas: {
-        json_or_param_binary_string: 'warning'
-      }
-    };
-
     const spec = {
       paths: {
         '/pets': {
@@ -51,24 +39,12 @@ describe('validation plugin - semantic - parameters - oas3', function() {
       }
     };
 
-    const res = validate({ resolvedSpec: spec }, config);
+    const res = validate({ jsSpec: spec }, config);
     expect(res.errors.length).toEqual(0);
     expect(res.warnings.length).toEqual(0);
   });
 
   it('should complain when `in` is missing', function() {
-    const config = {
-      parameters: {
-        no_in_property: 'error',
-        invalid_in_property: 'error',
-        missing_schema_or_content: 'error',
-        has_schema_and_content: 'error'
-      },
-      schemas: {
-        json_or_param_binary_string: 'warning'
-      }
-    };
-
     const spec = {
       paths: {
         '/pets': {
@@ -101,7 +77,7 @@ describe('validation plugin - semantic - parameters - oas3', function() {
       }
     };
 
-    const res = validate({ resolvedSpec: spec }, config);
+    const res = validate({ jsSpec: spec }, config);
     expect(res.errors.length).toEqual(1);
     expect(res.errors[0].path).toEqual([
       'paths',
@@ -117,18 +93,6 @@ describe('validation plugin - semantic - parameters - oas3', function() {
   });
 
   it('should complain when `in` is an invalid value', function() {
-    const config = {
-      parameters: {
-        no_in_property: 'error',
-        invalid_in_property: 'error',
-        missing_schema_or_content: 'error',
-        has_schema_and_content: 'error'
-      },
-      schemas: {
-        json_or_param_binary_string: 'warning'
-      }
-    };
-
     const spec = {
       paths: {
         '/pets': {
@@ -162,7 +126,7 @@ describe('validation plugin - semantic - parameters - oas3', function() {
       }
     };
 
-    const res = validate({ resolvedSpec: spec }, config);
+    const res = validate({ jsSpec: spec }, config);
     expect(res.errors.length).toEqual(1);
     expect(res.errors[0].path).toEqual([
       'paths',
@@ -179,18 +143,6 @@ describe('validation plugin - semantic - parameters - oas3', function() {
   });
 
   it('should complain when the parameter has an undescribed data type', function() {
-    const config = {
-      parameters: {
-        no_in_property: 'error',
-        invalid_in_property: 'error',
-        missing_schema_or_content: 'error',
-        has_schema_and_content: 'error'
-      },
-      schemas: {
-        json_or_param_binary_string: 'warning'
-      }
-    };
-
     const spec = {
       paths: {
         '/pets': {
@@ -221,7 +173,7 @@ describe('validation plugin - semantic - parameters - oas3', function() {
       }
     };
 
-    const res = validate({ resolvedSpec: spec }, config);
+    const res = validate({ jsSpec: spec }, config);
     expect(res.errors.length).toEqual(1);
     expect(res.errors[0].path).toEqual([
       'paths',
@@ -237,18 +189,6 @@ describe('validation plugin - semantic - parameters - oas3', function() {
   });
 
   it('should complain when a parameter describes data type with both `schema` and `content`', function() {
-    const config = {
-      parameters: {
-        no_in_property: 'error',
-        invalid_in_property: 'error',
-        missing_schema_or_content: 'error',
-        has_schema_and_content: 'error'
-      },
-      schemas: {
-        json_or_param_binary_string: 'warning'
-      }
-    };
-
     const spec = {
       components: {
         parameters: {
@@ -271,7 +211,7 @@ describe('validation plugin - semantic - parameters - oas3', function() {
       }
     };
 
-    const res = validate({ resolvedSpec: spec }, config);
+    const res = validate({ jsSpec: spec }, config);
     expect(res.errors.length).toEqual(1);
     expect(res.errors[0].path).toEqual([
       'components',
@@ -475,7 +415,7 @@ describe('validation plugin - semantic - parameters - oas3', function() {
       }
     };
 
-    const res = validate({ resolvedSpec: spec }, config);
+    const res = validate({ jsSpec: spec }, config);
     expect(res.errors.length).toEqual(0);
     expect(res.warnings.length).toEqual(0);
   });
@@ -527,18 +467,6 @@ describe('validation plugin - semantic - parameters - oas3', function() {
   });
 
   it('should not complain about a schema property named `parameters`', function() {
-    const config = {
-      parameters: {
-        no_in_property: 'error',
-        invalid_in_property: 'error',
-        missing_schema_or_content: 'error',
-        has_schema_and_content: 'error'
-      },
-      schemas: {
-        json_or_param_binary_string: 'warning'
-      }
-    };
-
     const spec = {
       components: {
         schemas: {
@@ -557,9 +485,7 @@ describe('validation plugin - semantic - parameters - oas3', function() {
       }
     };
 
-    const resolvedSpec = await resolver.dereference(spec);
-
-    const res = validate({ resolvedSpec: resolvedSpec }, config);
+    const res = validate({ jsSpec: spec }, config);
     expect(res.errors.length).toEqual(0);
     expect(res.warnings.length).toEqual(0);
   });