is-my-ssb-valid/test/schema-based.test.js

build scuttlebutt message validators from JSON Schema

const test = require('tape')
const Validator = require('../')

test('schema-based', t => {
  const schema = {
    required: ['type'],
    properties: {
      type: {
        type: 'string',
        pattern: '^post'
      },
      date: {
        type: 'integer'
      },
      tangles: {
        type: 'object',
        properties: {
          root: { type: 'string' },
          previous: { type: 'array' }
        },
        additionalProperties: false
      }
    },
    additionalProperties: false
  }

  const isValid = Validator(schema)

  t.true(isValid({ type: 'post' }))
  t.equal(isValid.errors, null, 'no isValid.errors when last passed')
  t.equal(isValid.errorsString, '', 'empty isValid.errorsString when last passed')

  /* failures */
  // missing required
  t.false(isValid({ kind: 'post' }))
  t.deepEqual(
    isValid.errors[0],
    { field: 'data.type', message: 'is required', value: { kind: 'post' }, type: undefined, schemaPath: [] },
    'isValid.errors when last failed'
  )
  t.equal(isValid.errorsString, 'data.type is required', 'isValid.errorsString when last failed')

  // additional field
  t.false(isValid({ type: 'post', dog: 'pupper', tangles: { dog: true } }))
  t.deepEqual(
    isValid.errors[0],
    { field: 'data', message: 'has additional properties', value: 'data.dog', type: undefined, schemaPath: [] },
    'isValid.errors when last failed'
  )
  t.equal(
    isValid.errorsString,
    'data has additional properties (data.dog); data.tangles has additional properties (data.tangles.dog)',
    'isValid.errorsString when last failed'
  )

  // error fields get reset un subsequent validations
  isValid({ type: 'post' })
  t.equal(isValid.errors, null, 'no isValid.errors when last passed')
  t.equal(isValid.errorsString, '', 'empty isValid.errorsString when last passed')

  /* can validate value or { msg, key } as well */
  const fullMessage = {
    key: '%10nwqzf93pmuI1FoIWlxpqm0amum2zbJbwvsidL3DyU=.sha256',
    value: {
      author: '@ye+QM09iPcDJD6YvQYjoQc7sLF/IFhmNbEqgdzQo3lQ=.ed25519',
      timestamp: 123123123123,
      content: { type: 'post' }
    }
  }
  t.true(isValid(fullMessage), 'can validate full messsages')
  t.true(isValid(fullMessage.value), 'can validate full messsage.value')

  t.end()
})