serverless/tests/cli/TestPluginCustom.js

'use strict';

/**
 * Test: Plugins
 */

let JAWS        = require('../../lib/Jaws.js'),
    JawsPlugin  = require('../../lib/JawsPlugin'),
    path        = require('path'),
    assert      = require('chai').assert,
    config      = require('../config');

/**
 * JAWS
 */

let Jaws = new JAWS({
  awsAdminKeyId: '123',
  awsAdminSecretKey: '123',
  interactive: false,
});

/**
 * Define Plugin
 */

class PromisePlugin extends JawsPlugin {

  constructor(Jaws, config) {
    super(Jaws, config);
  }

  /**
   * Register Actions
   */

  registerActions() {
    this.Jaws.action(this._actionPluginTest.bind(this), {
      handler:          'pluginTest',
      description:      'A test plugin',
      context:          'plugin',
      contextAction:    'test',
      options:          [{
        option: 'option',
        shortcut: 'o',
        description: 'test option 1'
      }],
    });
  }

  /**
   * Register Hooks
   */

  registerHooks() {
    this.Jaws.hook(this._hookPrePluginTest.bind(this), {
      handler: 'pluginTest',
      event:   'pre'
    });
    this.Jaws.hook(this._hookPostPluginTest.bind(this), {
      handler: 'pluginTest',
      event:   'post'
    });
  }

  /**
   * Plugin Logic
   * @returns {*|Promise.<T>}
   * @private
   */

  _actionPluginTest(paramsTest1, paramsTest2) {
    let _this = this;
    return new Promise(function(resolve) {
      console.log('Action fired');
      setTimeout(function(){
        _this.Jaws.testAction = true;
        _this.Jaws.paramsTest1 = paramsTest1;
        _this.Jaws.paramsTest2 = paramsTest2;
        return resolve();
      }, 250);
    });
  }

  _hookPrePluginTest() {
    let _this = this;
    return new Promise(function(resolve) {
      console.log('Hook "Pre" fired');
      setTimeout(function(){
        _this.Jaws.testHookPre = true;
        return resolve();
      }, 250);
    });
  }

  _hookPostPluginTest() {
    let _this = this;
    return new Promise(function(resolve) {
      console.log('Hook "Post" fired');
      setTimeout(function(){
        _this.Jaws.testHookPost = true;
        return resolve();
      }, 250);
    });
  }
}

/**
 * Run Tests
 */

describe('Test Custom Plugin', function() {

  before(function(done) {
    Jaws.addPlugin(new PromisePlugin(Jaws, {}));
    done();
  });

  after(function(done) {
    done();
  });

  describe('Test Custom Plugin', function() {
    it('should run and attach values to context', function(done) {

      this.timeout(0);

      Jaws.pluginTest(true, true)
          .then(function() {
            // Test context
            assert.isTrue(Jaws.testHookPre);
            assert.isTrue(Jaws.testHookPost);
            assert.isTrue(Jaws.testAction);
            // Test Params are passed through action handler
            assert.isTrue(Jaws.paramsTest1);
            assert.isTrue(Jaws.paramsTest2);
            done();
          })
          .catch(function(e) {
            done(e);
          });
    });
  });
});