synctos/test/sample-payment-processor-settlement.spec.js

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

const sampleSpecHelperMaker = require('./helpers/sample-spec-helper-maker');
const testFixtureMaker = require('../src/testing/test-fixture-maker');

describe('Sample payment processor settlement doc definition', () => {
  const testFixture = testFixtureMaker.initFromSyncFunction('build/sync-functions/test-sample-sync-function.js');
  const errorFormatter = testFixture.validationErrorFormatter;
  const sampleSpecHelper = sampleSpecHelperMaker.init(testFixture);

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

  function verifySettlementWritten(businessId, doc, oldDoc) {
    testFixture.verifyDocumentAccepted(doc, oldDoc, sampleSpecHelper.getExpectedAuthorization('payment-settlement-write'));
  }

  function verifySettlementNotWritten(businessId, doc, oldDoc, expectedErrorMessages) {
    testFixture.verifyDocumentRejected(
      doc,
      oldDoc,
      'paymentProcessorSettlement',
      expectedErrorMessages, sampleSpecHelper.getExpectedAuthorization('payment-settlement-write'));
  }

  it('can successfully create a valid payment processor settlement document', () => {
    const doc = {
      _id: 'biz.12345.paymentProcessor.XYZ.processedSettlement.some-settlement-id',
      _attachments: { },
      businessId: 12345,
      transferId: 10,
      settlementId: 'some-settlement-id',
      processorId: 'XYZ',
      capturedAt: '2016-02-29',
      processedAt: '2016-03-03',
      amount: 300,
      currency: 'USD',
      processorMessage: 'my-processor-message'
    };

    verifySettlementWritten(20, doc);
  });

  it('cannot create a payment processor settlement document when the properties are invalid', () => {
    const doc = {
      _id: 'biz.12345.paymentProcessor.XYZ.processedSettlement.foo-bar',
      businessId: 54321,
      settlementId: 'not-foo-bar',
      processorId: 'ZYX',
      capturedAt: 'not-a-capturedAt',
      processedAt: 2123,
      currency: 'invalid-iso-4217-currency',
      processorMessage: 'my-processor-message'
    };

    verifySettlementNotWritten(
      'my-business',
      doc,
      void 0,
      [
        errorFormatter.documentIdRegexPatternViolation(/^biz\.54321\.paymentProcessor\.ZYX\.processedSettlement\.not-foo-bar$/),
        errorFormatter.requiredValueViolation('transferId'),
        errorFormatter.datetimeFormatInvalid('capturedAt'),
        errorFormatter.typeConstraintViolation('processedAt', 'datetime'),
        errorFormatter.requiredValueViolation('amount'),
        errorFormatter.regexPatternItemViolation('currency', /^[A-Z]{3}$/)
      ]);
  });

  it('cannot replace a payment processor settlement document because it is immutable', () => {
    const doc = {
      _id: 'biz.12345.paymentProcessor.XYZ.processedSettlement.foo-bar',
      businessId: 12345,
      transferId: -5,
      settlementId: 'foo-bar',
      processorId: 'XYZ',
      capturedAt: '2016-02-29',
      processedAt: '2016-03-03',
      amount: 300,
      currency: 'USD',
      processorMessage: 'my-other-processor-message',
      whatPropIsThis: 'some value'
    };
    const oldDoc = {
      _id: 'biz.12345.paymentProcessor.XYZ.processedSettlement.foo-bar',
      businessId: 12345,
      transferId: 10,
      settlementId: 'foo-bar',
      processorId: 'XYZ',
      capturedAt: '2016-02-29',
      processedAt: '2016-03-03',
      amount: 300,
      currency: 'USD',
      processorMessage: 'my-processor-message'
    };

    verifySettlementNotWritten(
      12345,
      doc,
      oldDoc,
      [
        errorFormatter.immutableDocViolation(),
        errorFormatter.immutableItemViolation('transferId'),
        errorFormatter.minimumValueViolation('transferId', 1),
        errorFormatter.unsupportedProperty('whatPropIsThis')
      ]);
  });

  it('cannot delete a valid payment processing attempt document because it is immutable', () => {
    const doc = { _id: 'biz.12345.paymentProcessor.XYZ.processedSettlement.foo-bar', _deleted: true };
    const oldDoc = { _id: 'biz.12345.paymentProcessor.XYZ.processedSettlement.foo-bar', businessId: 12345 };

    verifySettlementNotWritten(12345, doc, oldDoc, [ errorFormatter.immutableDocViolation() ]);
  });
});