feat: Implemented schema-validator and tests

javiertrancoso · javiertrancoso · commit f9ad09b0a5a6 · 2019-12-12T11:17:20.000+01:00
diff --git a/package.json b/package.json
@@ -0,0 +1,22 @@
+{
+  "name": "json-validations-lib",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "test-units": "cross-env BUILD_ENV=test DEBUG=amio* mocha test/test_unit/**/*.test.js --reporter mocha-multi-reporters --reporter-options configFile=test/mocha-reporters-config.json"
+  },
+  "dependencies": {
+    "ajv": "6.10.2",
+    "logzio-node-debug": "^2.0.0",
+    "ramda": "0.26.1",
+    "valid-url": "1.0.9"
+  },
+  "devDependencies": {
+    "chai": "4.2.0",
+    "chai-as-promised": "7.1.1",
+    "mocha": "6.1.4",
+    "mocha-junit-reporter": "1.22.0",
+    "mocha-multi-reporters": "1.1.7",
+    "mochawesome": "3.1.2"
+  }
+}
diff --git a/src/async-validator.js b/src/async-validator.js
@@ -0,0 +1,19 @@
+class AsyncValidator {
+
+  async validate(data) {
+    throw Error('validate() must be implemented in children')
+  }
+
+  /** Follows AJV error to be compatible with Schema errors */
+  createError(path = [], keyword, data, params) {
+    return {
+      dataPath: path.join('.'),
+      keyword,
+      data,
+      params
+    }
+  }
+
+}
+
+module.exports = AsyncValidator
diff --git a/src/errors/schema-validator-error.js b/src/errors/schema-validator-error.js
@@ -0,0 +1,18 @@
+class SchemaValidatorError extends Error{
+  constructor(message, field = undefined, rejectedValue = undefined) {
+    super()
+    this.field = field
+    this.rejected_value = rejectedValue
+    this.message = message
+  }
+
+  toObject(){
+    return {
+      message: this.message,
+      field: this.field,
+      rejected_value: this.rejected_value
+    }
+  }
+}
+
+module.exports = SchemaValidatorError
diff --git a/src/schema-validator.js b/src/schema-validator.js
@@ -0,0 +1,25 @@
+const Ajv = require('ajv')
+const errorConverter = require('./utils/validation-errors-converter')
+const urlValidator = require('valid-url')
+const debug = require('logzio-node-debug').debug('json-validations-lib:' + require('path').basename(__filename))
+
+class SchemaValidator {
+
+  constructor(schemaId, schemas) {
+    this.schemaValidator = new Ajv({verbose: true, schemas: schemas}) // verbose to enable errors.data field
+    this.schemaValidator.addFormat('httpUrl', urlValidator.isWebUri)
+    this._validate = this.schemaValidator.getSchema(schemaId)
+  }
+
+  /** @returns null OR error*/
+  validate(data) {
+    const valid = this._validate(data)
+    if(valid) return null
+
+    const validationErrors = this._validate.errors
+    debug('schema validation failed', this._validate.errors)
+    throw errorConverter.convertValidationError(validationErrors)
+  }
+}
+
+module.exports = SchemaValidator
diff --git a/src/utils/validation-errors-converter.js b/src/utils/validation-errors-converter.js
@@ -0,0 +1,56 @@
+const R = require('ramda')
+const SchemaValidatorError = require('../errors/schema-validator-error')
+
+function convertValidationError(error) {
+  const errorObject = Array.isArray(error) ? error[0] : error
+
+  const propName = errorObject.dataPath.split('.').pop()
+  const params = errorObject.params
+
+  switch(errorObject.keyword) {
+    case 'type':
+      return new SchemaValidatorError(`Property '${propName}' must be ${params.type}.`, errorObject.dataPath, errorObject.data)
+    case 'additionalProperties':
+      return new SchemaValidatorError(`Property '${params.additionalProperty}' is not supported.`,
+        errorObject.dataPath + '.' + params.additionalProperty)
+    case 'required': {
+      const fieldPath = (errorObject.dataPath) ? errorObject.dataPath : '.'
+      return new SchemaValidatorError(`Missing property '${params.missingProperty}'.`, fieldPath)
+    }
+    case 'const':
+      return new SchemaValidatorError(`Property '${propName}' must have value '${params.allowedValue}'.`, errorObject.dataPath, errorObject.data)
+    case 'enum':
+      return convertEnum(errorObject.data, errorObject.dataPath, params, propName, errorObject.schemaPath)
+    case 'format':
+      if(errorObject.params.format === 'httpUrl') {
+        const message = `Property '${propName}' must be a valid URL. Current value is "${errorObject.data}"`
+        return new SchemaValidatorError(message, errorObject.dataPath, errorObject.data)
+      }
+    // Intentional fall through
+    default:
+      return new SchemaValidatorError(`Property '${propName}' ${errorObject.message}`, errorObject.dataPath, errorObject.data)
+  }
+}
+
+function convertEnum(data, dataPath, params, propName, schemaPath) {
+  const schemaParent = R.pipe( // #/propertyNames/enum
+    R.split('/'), // ['#', 'propertyNames', 'enum']
+    R.dropLast(1), // ['#', 'propertyNames']
+    R.last // 'propertyNames'
+  )(schemaPath)
+
+  if(schemaParent === 'propertyNames') {
+    const path = dataPath || '.'
+    const message = `Property '${data}' at '${path}' does not match any allowed property: ${params.allowedValues.join(', ')}.`
+    const fieldPath = `${dataPath}.${data}`
+    return new SchemaValidatorError(message, fieldPath)
+  }
+
+  const message = `Property '${propName}' with value '${data}' does not match any allowed value: ${params.allowedValues.join(', ')}.`
+  return new SchemaValidatorError(message, dataPath, data)
+
+}
+
+module.exports = {
+  convertValidationError
+}
diff --git a/test/global-test-hooks.js b/test/global-test-hooks.js
diff --git a/test/mocha-reporters-config.json b/test/mocha-reporters-config.json
@@ -0,0 +1,6 @@
+{
+  "reporterEnabled": "mocha-junit-reporter, mochawesome",
+  "mochaJunitReporterReporterOptions": {
+    "mochaFile": "test-results.xml"
+  }
+}
diff --git a/test/mocha.opts b/test/mocha.opts
@@ -0,0 +1,3 @@
+test/global-test-hooks.js
+--timeout 20000
+--exit
diff --git a/test/test_unit/schema-validator.test.js b/test/test_unit/schema-validator.test.js
@@ -0,0 +1,27 @@
+const expect = require('chai').expect
+const SchemaValidator = require('../../src/schema-validator')
+
+describe('Schema Validator', () => {
+
+  const schema = {
+    $id: 'http://example.com/schemas/schema.json',
+    type: 'object',
+    required: [
+      'a'
+    ]
+  }
+  const schemaValidator = new SchemaValidator(schema.$id, [schema])
+
+  it('Validation passed', () => {
+    const error = schemaValidator.validate({a: 1})
+    expect(error).to.be.null
+  })
+
+  it('Validation failed', () => {
+    const error = schemaValidator.validate({})
+    expect(error).to.eql({
+      field: '.',
+      message: "Missing property '.a'."
+    })
+  })
+})
diff --git a/test/test_unit/validation-errors-converter.test.js b/test/test_unit/validation-errors-converter.test.js
@@ -0,0 +1,168 @@
+const expect = require('chai').expect
+const SchemaValidator = require('../../src/schema-validator')
+
+describe('validation-error-converter test', () => {
+
+    const schema = {
+        $id: 'http://example.com/schemas/schema.json',
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+            typeError: {
+                type: 'string'
+            },
+            additionalPropertyError: {
+                type: 'object',
+                additionalProperties: false,
+                properties: {
+                    a: {
+                        type: 'string'
+                    }
+                }
+            },
+            requiredError: {
+                type: 'object',
+                required: ['a'],
+                properties: {
+                    a: {
+                        type: 'string'
+                    }
+                }
+            },
+            constError: {
+                type: 'string',
+                const: 'dummy'
+            },
+            enumError: {
+                type: 'string',
+                enum: [
+                    '1',
+                    '2',
+                    '3'
+                ]
+            },
+            propEnumError: {
+                type: 'object',
+                propertyNames: {
+                    enum: [
+                        'a',
+                        'b',
+                        'c'
+                    ]
+                }
+            },
+            formatUrlError: {
+                type: 'string',
+                format: 'httpUrl'
+            },
+            formatError: {
+                type: 'string',
+                format: 'email'
+            }
+        }
+    }
+    const schemaValidator = new SchemaValidator(schema.$id, [schema])
+
+    it('type', () => {
+        const data = {
+            typeError: {}
+        }
+
+        const result = schemaValidator.validate(data)
+        expect(result).to.include({
+            field: '.typeError',
+            message: "Property 'typeError' must be string.",
+            rejected_value: data.typeError
+        })
+    })
+
+    it('additionalProperties', () => {
+        const data = {
+            additionalPropertyError: {
+                d: {}
+            }
+        }
+
+        const result = schemaValidator.validate(data)
+        expect(result).to.include({
+            field: '.additionalPropertyError.d',
+            message: "Property 'd' is not supported."
+        })
+    })
+
+    it('required', () => {
+        const data = {
+            requiredError: {}
+        }
+
+        const result = schemaValidator.validate(data)
+        expect(result).to.include({
+            field: '.requiredError',
+            message: "Missing property 'a'."
+        })
+    })
+
+    it('const', () => {
+        const data = {
+            constError: 'a'
+        }
+
+        const result = schemaValidator.validate(data)
+        expect(result).to.include({
+            field: '.constError',
+            message: "Property 'constError' must have value 'dummy'.",
+            rejected_value: 'a'
+        })
+    })
+
+    it('enum - values', () => {
+        const data = {
+            enumError: 'a'
+        }
+
+        const result = schemaValidator.validate(data)
+        expect(result).to.include({
+            field: '.enumError',
+            message: "Property 'enumError' with value 'a' does not match any allowed value: 1, 2, 3.",
+            rejected_value: 'a'
+        })
+    })
+
+    it('enum - properties', () => {
+        const data = {
+            propEnumError: {d: {}}
+        }
+
+        const result = schemaValidator.validate(data)
+        expect(result).to.include({
+            field: '.propEnumError.d',
+            message: "Property 'd' at '.propEnumError' does not match any allowed property: a, b, c.",
+        })
+    })
+
+    it('format URL', () => {
+        const data = {
+            formatUrlError: 'dummy'
+        }
+
+        const result = schemaValidator.validate(data)
+        expect(result).to.include({
+            field: '.formatUrlError',
+            message: `Property 'formatUrlError' must be a valid URL. Current value is "dummy"`,
+            rejected_value: 'dummy'
+        })
+    })
+
+    it('format other', () => {
+        const data = {
+            formatError: 'dummy'
+        }
+
+        const result = schemaValidator.validate(data)
+        expect(result).to.include({
+            field: '.formatError',
+            message: `Property 'formatError' should match format "email"`,
+            rejected_value: 'dummy'
+        })
+    })
+})

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+test/global-test-hooks.js`
	`2`	`+--timeout 20000`
	`3`	`+--exit`