synctos/test/property-validators.spec.js

The Syncmaker. A tool to build comprehensive sync functions for Couchbase Sync Gateway.

const testFixtureMaker = require('../src/testing/test-fixture-maker');
const errorFormatter = require('../src/testing/validation-error-formatter');

describe('Property validators:', () => {
  const testFixture =
    testFixtureMaker.initFromSyncFunction('build/sync-functions/test-property-validators-sync-function.js');

  afterEach(() => {
    testFixture.resetTestEnvironment();
  });

  describe('static validation at the document level', () => {
    it('allow unknown properties when a document is created and the option is enabled', () => {
      const doc = {
        _id: 'staticAllowUnknownDoc',
        unknownProperty1: 15
      };

      testFixture.verifyDocumentCreated(doc);
    });

    it('allow unknown properties when a document is replaced and the option is enabled', () => {
      const doc = {
        _id: 'staticAllowUnknownDoc',
        unknownProperty1: 'foo'
      };
      const oldDoc = {
        _id: 'staticAllowUnknownDoc',
        unknownProperty2: true
      };

      testFixture.verifyDocumentReplaced(doc, oldDoc);
    });

    it('reject unknown properties when a document is created and the option is disabled', () => {
      const doc = {
        _id: 'staticPreventUnknownDoc',
        unknownProperty1: 15
      };

      testFixture.verifyDocumentNotCreated(doc, 'staticPreventUnknownDoc', [ errorFormatter.unsupportedProperty('unknownProperty1') ]);
    });

    it('reject unknown properties when a document is replaced and the option is disabled', () => {
      const doc = {
        _id: 'staticPreventUnknownDoc',
        unknownProperty1: 73.7
      };
      const oldDoc = { _id: 'staticPreventUnknownDoc' };

      testFixture.verifyDocumentNotReplaced(doc, oldDoc, 'staticPreventUnknownDoc', [ errorFormatter.unsupportedProperty('unknownProperty1') ]);
    });
  });

  describe('dynamic validation at the document level', () => {
    it('allows a document with no unknown properties', () => {
      const doc = {
        _id: 'foobar',
        type: 'dynamicPropertiesValidationDoc',
        extraProperty: 1.5,
        unknownPropertiesAllowed: false
      };

      testFixture.verifyDocumentCreated(doc);
    });

    it('allows a document with unknown properties when they are enabled', () => {
      const doc = {
        _id: 'foobar',
        type: 'dynamicPropertiesValidationDoc',
        unrecognizedProperty: 'foobar',
        unknownPropertiesAllowed: true
      };

      testFixture.verifyDocumentCreated(doc);
    });

    it('blocks a document with unknown properties when they are disabled', () => {
      const doc = {
        _id: 'my-doc',
        type: 'dynamicPropertiesValidationDoc',
        extraProperty: 99, // Since the ID is not "foobar", extraProperty is expected to be a string
        unrecognizedProperty: [ ],
        unknownPropertiesAllowed: false
      };

      testFixture.verifyDocumentNotCreated(
        doc,
        'dynamicPropertiesValidationDoc',
        [
          errorFormatter.unsupportedProperty('unrecognizedProperty'),
          errorFormatter.typeConstraintViolation('extraProperty', 'string')
        ]);
    });
  });

  describe('static validation in a nested object', () => {
    it('allow unknown properties when a document is created and the option is enabled', () => {
      const doc = {
        _id: 'staticPreventUnknownDoc',
        allowUnknownProp: {
          myStringProp: 'foo',
          myUnknownProp: 'bar'
        }
      };

      testFixture.verifyDocumentCreated(doc);
    });

    it('allow unknown properties when a document is replaced and the option is enabled', () => {
      const doc = {
        _id: 'staticPreventUnknownDoc',
        allowUnknownProp: {
          myStringProp: 'foo',
          myUnknownProp: 'bar'
        }
      };
      const oldDoc = { _id: 'staticPreventUnknownDoc' };

      testFixture.verifyDocumentReplaced(doc, oldDoc);
    });

    it('reject unknown properties when a document is created and the option is disabled', () => {
      const doc = {
        _id: 'staticAllowUnknownDoc',
        preventUnknownProp: {
          myStringProp: 'foo',
          myUnknownProp: 'bar'
        }
      };

      testFixture.verifyDocumentNotCreated(
        doc,
        'staticAllowUnknownDoc',
        [ errorFormatter.unsupportedProperty('preventUnknownProp.myUnknownProp') ]);
    });

    it('reject unknown properties when a document is replaced and the option is disabled', () => {
      const doc = {
        _id: 'staticAllowUnknownDoc',
        preventUnknownProp: {
          myStringProp: 'foo',
          myUnknownProp: 'bar'
        }
      };
      const oldDoc = { _id: 'staticAllowUnknownDoc' };

      testFixture.verifyDocumentNotReplaced(
        doc,
        oldDoc,
        'staticAllowUnknownDoc',
        [ errorFormatter.unsupportedProperty('preventUnknownProp.myUnknownProp') ]);
    });
  });

  describe('dynamic validation in a nested object', () => {
    it('allows a document with no nested unknown properties', () => {
      const doc = {
        _id: 'foobar',
        type: 'dynamicObjectValidationDoc',
        subObject: {
          extraProperty: 1.5,
          unknownPropertiesAllowed: false
        }
      };

      testFixture.verifyDocumentCreated(doc);
    });

    it('allows a document with nested unknown properties when they are enabled', () => {
      const doc = {
        _id: 'foobar',
        type: 'dynamicObjectValidationDoc',
        subObject: {
          unrecognizedProperty: 'foobar',
          unknownPropertiesAllowed: true
        }
      };

      testFixture.verifyDocumentCreated(doc);
    });

    it('blocks a document with nested unknown properties when they are disabled', () => {
      const doc = {
        _id: 'my-doc',
        type: 'dynamicObjectValidationDoc',
        subObject: {
          extraProperty: 99, // Since the ID is not "foobar", extraProperty is expected to be a string
          unrecognizedProperty: [ ],
          unknownPropertiesAllowed: false
        }
      };

      testFixture.verifyDocumentNotCreated(
        doc,
        'dynamicObjectValidationDoc',
        [
          errorFormatter.unsupportedProperty('subObject.unrecognizedProperty'),
          errorFormatter.typeConstraintViolation('subObject.extraProperty', 'string')
        ]);
    });
  });
});