tests.js

'use strict';

const path = require('path');
const BbPromise = require('bluebird');
const { expect } = require('chai');
const log = require('log').get('serverless:test');

const { getTmpDirPath } = require('../../utils/fs');
const { createBucket, createAndRemoveInBucket, deleteBucket } = require('../../utils/s3');
const { createTestService, deployService, removeService } = require('../../utils/integration');
const { confirmCloudWatchLogs } = require('../../utils/misc');

describe('AWS - S3 Integration Test', function() {
  this.timeout(1000 * 60 * 10); // Involves time-taking deploys
  let serviceName;
  let stackName;
  let tmpDirPath;
  let bucketMinimalSetup;
  let bucketExtendedSetup;
  let bucketCustomName;
  let bucketExistingSimpleSetup;
  let bucketExistingComplexSetup;
  const stage = 'dev';

  before(async () => {
    tmpDirPath = getTmpDirPath();
    log.notice(`Temporary path: ${tmpDirPath}`);
    const serverlessConfig = await createTestService(tmpDirPath, {
      templateDir: path.join(__dirname, 'service'),
      filesToAdd: [path.join(__dirname, '..', 'shared')],
      serverlessConfigHook:
        // Ensure unique S3 bucket names for each test (to avoid collision among concurrent CI runs)
        config => {
          bucketMinimalSetup = `${config.service}-s3-minimal`;
          bucketExtendedSetup = `${config.service}-s3-extended`;
          bucketCustomName = `${config.service}-custom-bucket-${stage}`;
          bucketExistingSimpleSetup = `${config.service}-s3-existing-simple`;
          bucketExistingComplexSetup = `${config.service}-s3-existing-complex`;
          config.functions.minimal.events[0].s3 = bucketMinimalSetup;
          config.functions.extended.events[0].s3.bucket = bucketExtendedSetup;
          config.provider.s3.customBucket.name = bucketCustomName;
          config.functions.existing.events[0].s3.bucket = bucketExistingSimpleSetup;
          config.functions.existingCreated.events[0].s3.bucket = bucketExistingComplexSetup;
          config.functions.existingCreated.events[1].s3.bucket = bucketExistingComplexSetup;
          config.functions.existingRemoved.events[0].s3.bucket = bucketExistingComplexSetup;
          config.functions.existingRemoved.events[1].s3.bucket = bucketExistingComplexSetup;
        },
    });
    serviceName = serverlessConfig.service;
    stackName = `${serviceName}-${stage}`;
    // create external S3 buckets
    // NOTE: deployment can only be done once the S3 buckets are created
    log.notice('Creating S3 buckets...');
    return BbPromise.all([
      createBucket(bucketExistingSimpleSetup),
      createBucket(bucketExistingComplexSetup),
    ]).then(() => {
      log.notice(`Deploying "${stackName}" service...`);
      return deployService(tmpDirPath);
    });
  });

  after(async () => {
    log.notice('Removing service...');
    await removeService(tmpDirPath);
    log.notice('Deleting S3 buckets');
    return BbPromise.all([
      deleteBucket(bucketExistingSimpleSetup),
      deleteBucket(bucketExistingComplexSetup),
    ]);
  });

  describe('Minimal Setup', () => {
    it('should invoke function when an object is created', () => {
      const functionName = 'minimal';
      const expectedMessage = `Hello from S3! - (${functionName})`;

      return confirmCloudWatchLogs(`/aws/lambda/${stackName}-${functionName}`, () =>
        createAndRemoveInBucket(bucketMinimalSetup)
      ).then(events => {
        const logs = events.reduce((data, event) => data + event.message, '');
        expect(/aws:s3/g.test(logs)).to.equal(true);
        expect(/ObjectCreated:Put/g.test(logs)).to.equal(true);
        expect(logs.includes(expectedMessage)).to.equal(true);
      });
    });
  });

  describe('Extended Setup', () => {
    it('should invoke function when an object is removed', () => {
      const functionName = 'extended';
      const expectedMessage = `Hello from S3! - (${functionName})`;

      return confirmCloudWatchLogs(`/aws/lambda/${stackName}-${functionName}`, () =>
        createAndRemoveInBucket(bucketExtendedSetup, { prefix: 'photos/', suffix: '.jpg' })
      ).then(events => {
        const logs = events.reduce((data, event) => data + event.message, '');
        expect(/aws:s3/g.test(logs)).to.equal(true);
        expect(/ObjectRemoved:Delete/g.test(logs)).to.equal(true);
        expect(logs.includes(expectedMessage)).to.equal(true);
      });
    });
  });

  describe('Custom Setup', () => {
    it('should invoke function when an object is created', () => {
      const functionName = 'custom';
      const expectedMessage = `Hello from S3! - (${functionName})`;

      return confirmCloudWatchLogs(`/aws/lambda/${stackName}-${functionName}`, () =>
        createAndRemoveInBucket(bucketCustomName)
      ).then(events => {
        const logs = events.reduce((data, event) => data + event.message, '');
        expect(/aws:s3/g.test(logs)).to.equal(true);
        expect(/ObjectCreated:Put/g.test(logs)).to.equal(true);
        expect(logs.includes(expectedMessage)).to.equal(true);
      });
    });
  });

  describe('Existing Setup', () => {
    describe('Single function / single bucket setup', () => {
      it('should invoke function when an object is created', () => {
        const functionName = 'existing';
        const expectedMessage = `Hello from S3! - (${functionName})`;

        return confirmCloudWatchLogs(`/aws/lambda/${stackName}-${functionName}`, () =>
          createAndRemoveInBucket(bucketExistingSimpleSetup, {
            prefix: 'Files/',
            suffix: '.TXT',
          })
        ).then(events => {
          const logs = events.reduce((data, event) => data + event.message, '');
          expect(/aws:s3/g.test(logs)).to.equal(true);
          expect(/ObjectCreated:Put/g.test(logs)).to.equal(true);
          expect(logs.includes(expectedMessage)).to.equal(true);
        });
      });
    });

    describe('Multi function / multi bucket setup', () => {
      it('should invoke function when a .jpg object is created', () => {
        const functionName = 'existingCreated';
        const expectedMessage = `Hello from S3! - (${functionName})`;

        return confirmCloudWatchLogs(`/aws/lambda/${stackName}-${functionName}`, () =>
          createAndRemoveInBucket(bucketExistingComplexSetup, {
            prefix: 'photos',
            suffix: '.jpg',
          })
        ).then(events => {
          const logs = events.reduce((data, event) => data + event.message, '');
          expect(/aws:s3/g.test(logs)).to.equal(true);
          expect(/ObjectCreated:Put/g.test(logs)).to.equal(true);
          expect(logs.includes(expectedMessage)).to.equal(true);
        });
      });
      it('should invoke function when a .jpg object is removed', () => {
        const functionName = 'existingRemoved';
        const expectedMessage = `Hello from S3! - (${functionName})`;

        return confirmCloudWatchLogs(`/aws/lambda/${stackName}-${functionName}`, () =>
          createAndRemoveInBucket(bucketExistingComplexSetup, {
            prefix: 'photos',
            suffix: '.jpg',
          })
        ).then(events => {
          const logs = events.reduce((data, event) => data + event.message, '');
          expect(/aws:s3/g.test(logs)).to.equal(true);
          expect(/ObjectRemoved:Delete/g.test(logs)).to.equal(true);
          expect(logs.includes(expectedMessage)).to.equal(true);
        });
      });
      it('should invoke function when a .png object is created', () => {
        const functionName = 'existingCreated';
        const expectedMessage = `Hello from S3! - (${functionName})`;

        return confirmCloudWatchLogs(`/aws/lambda/${stackName}-${functionName}`, () =>
          createAndRemoveInBucket(bucketExistingComplexSetup, {
            prefix: 'photos',
            suffix: '.png',
          })
        ).then(events => {
          const logs = events.reduce((data, event) => data + event.message, '');
          expect(/aws:s3/g.test(logs)).to.equal(true);
          expect(/ObjectCreated:Put/g.test(logs)).to.equal(true);
          expect(logs.includes(expectedMessage)).to.equal(true);
        });
      });
      it('should invoke function when a .png object is removed', () => {
        const functionName = 'existingRemoved';
        const expectedMessage = `Hello from S3! - (${functionName})`;

        return confirmCloudWatchLogs(`/aws/lambda/${stackName}-${functionName}`, () =>
          createAndRemoveInBucket(bucketExistingComplexSetup, {
            prefix: 'photos',
            suffix: '.png',
          })
        ).then(events => {
          const logs = events.reduce((data, event) => data + event.message, '');
          expect(/aws:s3/g.test(logs)).to.equal(true);
          expect(/ObjectRemoved:Delete/g.test(logs)).to.equal(true);
          expect(logs.includes(expectedMessage)).to.equal(true);
        });
      });
    });
  });
});