'use strict'; var Ajv = require(typeof window == 'object' ? 'ajv' : '../lib/ajv') , should = require('chai').should(); describe('Validation errors', function () { var ajv, ajvJP, fullAjv; beforeEach(function() { createInstances(); }); function createInstances(errorDataPath) { ajv = Ajv({ errorDataPath: errorDataPath }); ajvJP = Ajv({ errorDataPath: errorDataPath, jsonPointers: true }); fullAjv = Ajv({ errorDataPath: errorDataPath, allErrors: true, jsonPointers: true }); } it('error should include dataPath', function() { testSchema1({ properties: { foo: { type: 'number' } } }); }); it('"refs" error should include dataPath', function() { testSchema1({ definitions: { num: { type: 'number' } }, properties: { foo: { $ref: '#/definitions/num' } } }); }); describe('"additionalProperties" errors', function() { it('should include property in dataPath with option errorDataPath="property"', function() { createInstances('property'); testAdditional('property'); }); it('should NOT include property in dataPath WITHOUT option errorDataPath', function() { testAdditional(); }); function testAdditional(errorDataPath) { var schema = { properties: { foo: {}, bar: {} }, additionalProperties: false }; var data = { foo: 1, bar: 2 } , invalidData = { foo: 1, bar: 2, baz: 3, quux: 4 }; var path = pathFunc(errorDataPath); var msg = msgFunc(errorDataPath); var validate = ajv.compile(schema); shouldBeValid(validate, data); shouldBeInvalid(validate, invalidData); shouldBeError(validate.errors[0], 'additionalProperties', '#/additionalProperties', path("['baz']"), undefined, { additionalProperty: 'baz' }); var validateJP = ajvJP.compile(schema); shouldBeValid(validateJP, data); shouldBeInvalid(validateJP, invalidData); shouldBeError(validateJP.errors[0], 'additionalProperties', '#/additionalProperties', path("/baz"), undefined, { additionalProperty: 'baz' }); var fullValidate = fullAjv.compile(schema); shouldBeValid(fullValidate, data); shouldBeInvalid(fullValidate, invalidData, 2); shouldBeError(fullValidate.errors[0], 'additionalProperties', '#/additionalProperties', path('/baz'), undefined, { additionalProperty: 'baz' }); shouldBeError(fullValidate.errors[1], 'additionalProperties', '#/additionalProperties', path('/quux'), undefined, { additionalProperty: 'quux' }); if (errorDataPath == 'property') { fullValidate.errors .filter(function(err) { return err.keyword == 'additionalProperties'; }) .map(function(err) { return fullAjv.opts.jsonPointers ? err.dataPath.substr(1) : err.dataPath.slice(2,-2); }) .forEach(function(p) { delete invalidData[p]; }); invalidData .should.eql({ foo: 1, bar: 2 }); } } }); describe('"required" errors', function() { it('should include missing property in dataPath with option errorDataPath="property"', function() { createInstances('property'); testRequired('property'); }); it('should NOT include missing property in dataPath WITHOUT option errorDataPath', function() { testRequired(); }); function testRequired(errorDataPath) { var schema = { required: ['foo', 'bar', 'baz'] }; _testRequired(errorDataPath, schema, '#', '.'); } it('large data/schemas with option errorDataPath="property"', function() { createInstances('property'); testRequiredLargeSchema('property'); }); it('large data/schemas WITHOUT option errorDataPath', function() { testRequiredLargeSchema(); }); function testRequiredLargeSchema(errorDataPath) { var schema = { required: [] } , data = {} , invalidData1 = {} , invalidData2 = {}; for (var i=0; i<100; i++) { schema.required.push(''+i); // properties from '0' to '99' are required data[i] = invalidData1[i] = invalidData2[i] = i; } delete invalidData1[1]; // property '1' will be missing delete invalidData2[2]; // properties '2' and '198' will be missing delete invalidData2[98]; var path = pathFunc(errorDataPath); var msg = msgFunc(errorDataPath); test(); var schema = { anyOf: [ schema ] }; test(1, '#/anyOf/0'); function test(extraErrors, schemaPathPrefix) { extraErrors = extraErrors || 0; var schPath = (schemaPathPrefix || '#') + '/required'; var validate = ajv.compile(schema); shouldBeValid(validate, data); shouldBeInvalid(validate, invalidData1, 1 + extraErrors); shouldBeError(validate.errors[0], 'required', schPath, path("['1']"), msg('1'), { missingProperty: '1' }); shouldBeInvalid(validate, invalidData2, 1 + extraErrors); shouldBeError(validate.errors[0], 'required', schPath, path("['2']"), msg('2'), { missingProperty: '2' }); var validateJP = ajvJP.compile(schema); shouldBeValid(validateJP, data); shouldBeInvalid(validateJP, invalidData1, 1 + extraErrors); shouldBeError(validateJP.errors[0], 'required', schPath, path("/1"), msg('1'), { missingProperty: '1' }); shouldBeInvalid(validateJP, invalidData2, 1 + extraErrors); shouldBeError(validateJP.errors[0], 'required', schPath, path("/2"), msg('2'), { missingProperty: '2' }); var fullValidate = fullAjv.compile(schema); shouldBeValid(fullValidate, data); shouldBeInvalid(fullValidate, invalidData1, 1 + extraErrors); shouldBeError(fullValidate.errors[0], 'required', schPath, path('/1'), msg('1'), { missingProperty: '1' }); shouldBeInvalid(fullValidate, invalidData2, 2 + extraErrors); shouldBeError(fullValidate.errors[0], 'required', schPath, path('/2'), msg('2'), { missingProperty: '2' }); shouldBeError(fullValidate.errors[1], 'required', schPath, path('/98'), msg('98'), { missingProperty: '98' }); } } it('with "properties" with option errorDataPath="property"', function() { createInstances('property'); testRequiredAndProperties('property'); }); it('with "properties" WITHOUT option errorDataPath', function() { testRequiredAndProperties(); }); function testRequiredAndProperties(errorDataPath) { var schema = { properties: { 'foo': { type: 'number' }, 'bar': { type: 'number' }, 'baz': { type: 'number' }, }, required: ['foo', 'bar', 'baz'] }; _testRequired(errorDataPath, schema); } it('in "anyOf" with option errorDataPath="property"', function() { createInstances('property'); testRequiredInAnyOf('property'); }); it('in "anyOf" WITHOUT option errorDataPath', function() { testRequiredInAnyOf(); }); function testRequiredInAnyOf(errorDataPath) { var schema = { anyOf: [ { required: ['foo', 'bar', 'baz'] } ] }; _testRequired(errorDataPath, schema, '#/anyOf/0', '.', 1); } }); describe('"dependencies" errors', function() { it('should include missing property in dataPath with option errorDataPath="property"', function() { createInstances('property'); testDependencies('property'); }); it('should NOT include missing property in dataPath WITHOUT option errorDataPath', function() { testDependencies(); }); function testDependencies(errorDataPath) { var schema = { dependencies: { a: ['foo', 'bar', 'baz'] } }; var data = { a: 0, foo: 1, bar: 2, baz: 3 } , invalidData1 = { a: 0, foo: 1, baz: 3 } , invalidData2 = { a: 0, bar: 2 }; var path = pathFunc(errorDataPath); var msg = 'should have properties foo, bar, baz when property a is present'; var validate = ajv.compile(schema); shouldBeValid(validate, data); shouldBeInvalid(validate, invalidData1); shouldBeError(validate.errors[0], 'dependencies', '#/dependencies', path('.bar'), msg, params('.bar')); shouldBeInvalid(validate, invalidData2); shouldBeError(validate.errors[0], 'dependencies', '#/dependencies', path('.foo'), msg, params('.foo')); var validateJP = ajvJP.compile(schema); shouldBeValid(validateJP, data); shouldBeInvalid(validateJP, invalidData1); shouldBeError(validateJP.errors[0], 'dependencies', '#/dependencies', path('/bar'), msg, params('bar')); shouldBeInvalid(validateJP, invalidData2); shouldBeError(validateJP.errors[0], 'dependencies', '#/dependencies', path('/foo'), msg, params('foo')); var fullValidate = fullAjv.compile(schema); shouldBeValid(fullValidate, data); shouldBeInvalid(fullValidate, invalidData1); shouldBeError(fullValidate.errors[0], 'dependencies', '#/dependencies', path('/bar'), msg, params('bar')); shouldBeInvalid(fullValidate, invalidData2/*, 2*/); shouldBeError(fullValidate.errors[0], 'dependencies', '#/dependencies', path('/foo'), msg, params('foo')); // shouldBeError(fullValidate.errors[1], 'dependencies', path('/baz'), msg, params('baz')); function params(missing) { var p = { property: 'a', deps: 'foo, bar, baz', depsCount: 3 }; p.missingProperty = missing; return p; } } }); function _testRequired(errorDataPath, schema, schemaPathPrefix, prefix, extraErrors) { var schPath = (schemaPathPrefix || '#') + '/required'; prefix = prefix || ''; extraErrors = extraErrors || 0; var data = { foo: 1, bar: 2, baz: 3 } , invalidData1 = { foo: 1, baz: 3 } , invalidData2 = { bar: 2 }; var path = pathFunc(errorDataPath); var msg = msgFunc(errorDataPath); var validate = ajv.compile(schema); shouldBeValid(validate, data); shouldBeInvalid(validate, invalidData1, 1 + extraErrors); shouldBeError(validate.errors[0], 'required', schPath, path('.bar'), msg(prefix + 'bar'), { missingProperty: prefix + 'bar' }); shouldBeInvalid(validate, invalidData2, 1 + extraErrors); shouldBeError(validate.errors[0], 'required', schPath, path('.foo'), msg(prefix + 'foo'), { missingProperty: prefix + 'foo' }); var validateJP = ajvJP.compile(schema); shouldBeValid(validateJP, data); shouldBeInvalid(validateJP, invalidData1, 1 + extraErrors); shouldBeError(validateJP.errors[0], 'required', schPath, path('/bar'), msg('bar'), { missingProperty: 'bar' }); shouldBeInvalid(validateJP, invalidData2, 1 + extraErrors); shouldBeError(validateJP.errors[0], 'required', schPath, path('/foo'), msg('foo'), { missingProperty: 'foo' }); var fullValidate = fullAjv.compile(schema); shouldBeValid(fullValidate, data); shouldBeInvalid(fullValidate, invalidData1, 1 + extraErrors); shouldBeError(fullValidate.errors[0], 'required', schPath, path('/bar'), msg('bar'), { missingProperty: 'bar' }); shouldBeInvalid(fullValidate, invalidData2, 2 + extraErrors); shouldBeError(fullValidate.errors[0], 'required', schPath, path('/foo'), msg('foo'), { missingProperty: 'foo' }); shouldBeError(fullValidate.errors[1], 'required', schPath, path('/baz'), msg('baz'), { missingProperty: 'baz' }); } function pathFunc(errorDataPath) { return function (dataPath) { return errorDataPath == 'property' ? dataPath : ''; }; } function msgFunc(errorDataPath) { return function (prop) { return errorDataPath == 'property' ? 'is a required property' : 'should have required property \'' + prop + '\''; }; } it('"items" errors should include item index without quotes in dataPath (#48)', function() { var schema1 = { id: 'schema1', type: 'array', items: { type: 'integer', minimum: 10 } }; var data = [ 10, 11, 12] , invalidData1 = [ 1, 10 ] , invalidData2 = [ 10, 9, 11, 8, 12]; var validate = ajv.compile(schema1); shouldBeValid(validate, data); shouldBeInvalid(validate, invalidData1); shouldBeError(validate.errors[0], 'minimum', '#/items/minimum', '[0]', 'should be >= 10'); shouldBeInvalid(validate, invalidData2); shouldBeError(validate.errors[0], 'minimum', '#/items/minimum', '[1]', 'should be >= 10'); var validateJP = ajvJP.compile(schema1); shouldBeValid(validateJP, data); shouldBeInvalid(validateJP, invalidData1); shouldBeError(validateJP.errors[0], 'minimum', '#/items/minimum', '/0', 'should be >= 10'); shouldBeInvalid(validateJP, invalidData2); shouldBeError(validateJP.errors[0], 'minimum', '#/items/minimum', '/1', 'should be >= 10'); var fullValidate = fullAjv.compile(schema1); shouldBeValid(fullValidate, data); shouldBeInvalid(fullValidate, invalidData1); shouldBeError(fullValidate.errors[0], 'minimum', '#/items/minimum', '/0', 'should be >= 10'); shouldBeInvalid(fullValidate, invalidData2, 2); shouldBeError(fullValidate.errors[0], 'minimum', '#/items/minimum', '/1', 'should be >= 10'); shouldBeError(fullValidate.errors[1], 'minimum', '#/items/minimum', '/3', 'should be >= 10'); var schema2 = { id: 'schema2', type: 'array', items: [{ minimum: 10 }, { minimum: 9 }, { minimum: 12 }] }; var validate = ajv.compile(schema2); shouldBeValid(validate, data); shouldBeInvalid(validate, invalidData1); shouldBeError(validate.errors[0], 'minimum', '#/items/0/minimum', '[0]', 'should be >= 10'); shouldBeInvalid(validate, invalidData2); shouldBeError(validate.errors[0], 'minimum', '#/items/2/minimum', '[2]', 'should be >= 12'); }); function testSchema1(schema) { _testSchema1(ajv, schema); _testSchema1(ajvJP, schema); _testSchema1(fullAjv, schema) } function _testSchema1(ajv, schema) { var data = { foo: 1 } , invalidData = { foo: 'bar' }; var validate = ajv.compile(schema); shouldBeValid(validate, data); shouldBeInvalid(validate, invalidData); shouldBeError(validate.errors[0], 'type', '#/properties/foo/type', ajv.opts.jsonPointers ? '/foo' : '.foo'); } function shouldBeValid(validate, data) { validate(data) .should.equal(true); should.equal(validate.errors, null); } function shouldBeInvalid(validate, data, numErrors) { validate(data) .should.equal(false); should.equal(validate.errors.length, numErrors || 1) } function shouldBeError(error, keyword, schemaPath, dataPath, message, params) { error.keyword .should.equal(keyword); error.schemaPath .should.equal(schemaPath); error.dataPath .should.equal(dataPath); error.message .should.be.a('string'); if (message !== undefined) error.message .should.equal(message); if (params !== undefined) error.params .should.eql(params); } });