The library runs tests defined in JSON consructed using the same format as the tests in JSON-Schema-Tests-Suite.
Each test file should have this format:
[ { // schema to be tested, there can be multiple schemas in each file // only: true, // only this schema will be tested // skip: true, // skip this schema description: 'The description is shown in the test report', // schema object or reference if the validator supports it schema: { ... } // or 'http://schema.example.com/schema.json#', // schemas: [] // array of schema objects or refs (schema property won't be used) tests: [ // test cases for the schema { // only: true, // only this data sample will be tested // skip: true, // skip this data sample description: 'valid data', // shown in report data: { ... }, // data object (can be any type) // dataFile: './valid_data.json', // or the relative path to the file valid: true // whether the data is valid for schema }, { description: 'invalid data'
Validator instance to be used or array of validator instances (in which case each test will run with each instance).
Validator should have validate(schema, data) method and after validation should have errors property (array in case of failure, empty array or null in case of success).
If validator instance has different API you can use json-schema-consolidate as adapter (or just use some simple adaptor function).
options
description - optional top level suite name (passed to top level describe).
suites - the map of test suite names and paths to test files. Names are used in test report, paths are passed to glob module. Instead of glob paths, the array of filenames (objects with name and path properties) of of actual tests (objects with name and test properties) can be passed.
async - pass true if validate function is asynchronous and returns the Promise. The promise should resolve with true or reject with the exception that has .errors property (array of errors). The promise may also reject with any error (and if it is the expected result, the test case in json file should specify error property with the message instead of valid property). That is the asynchronous api of Ajv - use an adaptor in case you are using some validator with a different api. It's safe to use async option if some results are synchronous, the results will simply be wrapped in the promise.
asyncValid - pass 'data' if in case of successful validation promise resolves with validated data. Otherwise, true will be expected.
afterEach - the function that will be called after each test. The function is passed an object with properties validator, schema, data, valid, expected, errors, passed (see above in example).
afterError - the function that is called if the test fails (the same result is passed as to function).