Schema validation deprecated

Schema validation deprecated

Author: LuisTejedaS

lib/ajValidation/ajvValidation.js

@@ -50,6 +50,16 @@ function getDraftToUse(localDraft, jsonSchemaDialect) {
   return localDraft ? localDraft : jsonSchemaDialect;
 }
 
+/**
+ * Checks if the schema object property is deprecated
+ *
+ * @param {*} schema - Schema object used in validation
+ * @returns {Boolean} postman variable or not
+ */
+function isDeprecated (schema) {
+  return schema ? schema.deprecated ? schema.deprecated : false : false;
+}
+
 /**
  * Used to validate schema against a value.
  * NOTE: Used in assets/json-schema-faker.js to validate schema example
@@ -107,6 +117,18 @@ function validateSchema (schema, valueToUse, options = {}, jsonSchemaDialect) {
       return !isTypeValue(valueToValidate, schemaToUse);
     }
 
+    if (validationError.keyword === 'required') {
+      let schemaDataPath = formatDataPath(formatSchemaPathFromAJVErrorToConvertToDataPath(validationError.schemaPath)),
+        propertyError = _.get(validationError, 'params.missingProperty') || '',
+        schemaPropertyPath = schemaDataPath.replace('.required', '.properties.') + propertyError;
+
+      if (options.includeDeprecated === false &&
+        isDeprecated(_.get(schema, schemaPropertyPath))) {
+        return false;
+      }
+      return true;
+    }
+
     return true;
   });
 

test/unit/xajvValidation.test.js

@@ -500,6 +500,163 @@ describe('validateSchema', function () {
     expect(result[0].keyword).to.equal('enum');
     expect(result[1].keyword).to.equal('pattern');
   });
+
+  it('Should not report error with deprecated property when is present', function () {
+    const schema = {
+        type: 'object',
+        properties: {
+          deprecated: {
+            type: 'boolean'
+          },
+          pet: {
+            type: 'object',
+            properties: {
+              id: {
+                type: 'string',
+                deprecated: true,
+                default: '<string>'
+              },
+              newID: {
+                type: 'string',
+                default: '<string>'
+              },
+              deprecated: {
+                type: 'string',
+                default: '<string>'
+              }
+            }
+          }
+        }
+      },
+      valueToUse = {
+        deprecated: false,
+        pet: {
+          id: '<string>',
+          newID: '122',
+          deprecated: 'value'
+        }
+      },
+      result = validateSchema(schema, valueToUse);
+    expect(result).to.be.empty;
+  });
+
+  it('Should report error with deprecated property when is invalid type', function () {
+    const schema = {
+        type: 'object',
+        properties: {
+          deprecated: {
+            type: 'boolean'
+          },
+          pet: {
+            type: 'object',
+            properties: {
+              id: {
+                type: 'string',
+                deprecated: true,
+                default: '<string>'
+              },
+              newID: {
+                type: 'string',
+                default: '<string>'
+              },
+              deprecated: {
+                type: 'string',
+                default: '<string>'
+              }
+            }
+          }
+        }
+      },
+      valueToUse = {
+        deprecated: false,
+        pet: {
+          id: 2,
+          newID: '122',
+          deprecated: 'value'
+        }
+      },
+      result = validateSchema(schema, valueToUse);
+    expect(result[0].instancePath).to.equal('/pet/id');
+    expect(result[0].keyword).to.equal('type');
+  });
+
+  it('Should not report error with deprecated property when is not present and' +
+   ' includeDeprecated is false', function () {
+    const schema = {
+        type: 'object',
+        properties: {
+          deprecated: {
+            type: 'boolean'
+          },
+          pet: {
+            type: 'object',
+            required: ['id'],
+            properties: {
+              id: {
+                type: 'string',
+                deprecated: true,
+                default: '<string>'
+              },
+              newID: {
+                type: 'string',
+                default: '<string>'
+              },
+              deprecated: {
+                type: 'string',
+                default: '<string>'
+              }
+            }
+          }
+        }
+      },
+      valueToUse = {
+        deprecated: false,
+        pet: {
+          newID: '122'
+        }
+      },
+      result = validateSchema(schema, valueToUse, { includeDeprecated: false });
+    expect(result).to.be.empty;
+  });
+
+  it('Should report error with deprecated property when is not present and' +
+  ' includeDeprecated is true', function () {
+    const schema = {
+        type: 'object',
+        properties: {
+          deprecated: {
+            type: 'boolean'
+          },
+          pet: {
+            type: 'object',
+            required: ['id'],
+            properties: {
+              id: {
+                type: 'string',
+                deprecated: true,
+                default: '<string>'
+              },
+              newID: {
+                type: 'string',
+                default: '<string>'
+              },
+              deprecated: {
+                type: 'string',
+                default: '<string>'
+              }
+            }
+          }
+        }
+      },
+      valueToUse = {
+        deprecated: false,
+        pet: {
+          newID: '122'
+        }
+      },
+      result = validateSchema(schema, valueToUse, { includeDeprecated: true });
+    expect(result).to.not.be.empty;
+  });
 });
 
 describe('getDraftToUse', function() {