serverless/lib/defaults/actions/EnvGet.js

'use strict';

/**
 * Action: EnvGet
 */

const JawsPlugin = require('../../JawsPlugin'),
      JawsError  = require('../../jaws-error'),
      JawsCLI    = require('../../utils/cli'),
      chalk      = require('chalk'),
      BbPromise  = require('bluebird'),
      JawsUtils  = require('../../utils'),
      awsMisc    = require('../../utils/aws/Misc');

/**
 * EnvGet Class
 */

class EnvGet extends JawsPlugin {

  /**
   * @param Jaws class object
   * @param config object
   */

  constructor(Jaws, config) {
    super(Jaws, config);
    this.evt = {};
  }

  /**
   * Define your plugins name
   *
   * @returns {string}
   */
  static getName() {
    return 'jaws.core.' + EnvGet.name;
  }

  /**
   * @returns {Promise} upon completion of all registrations
   */

  registerActions() {
    this.Jaws.addAction(this.envGet.bind(this), {
      handler:       'envGet',
      description:   `get var value for stage and region. Region can be 'all'
usage: jaws env get`,
      context:       'env',
      contextAction: 'get',
      options:       [
        {
          option:      'region',
          shortcut:    'r',
          description: 'region you want to get env var from'
        },
        {
          option:      'stage',
          shortcut:    's',
          description: 'stage you want to get env var from'
        },
        {
          option:      'key',
          shortcut:    'k',
          description: 'the key of the env var you want to get'
        },
        {
          option:      'nonInteractive',
          shortcut:    'i',
          description: 'Optional - Turn off CLI interactivity if true. Default: false'
        },
      ],
    });
    return BbPromise.resolve();
  }

  /**
   * Action
   */
  envGet(evt) {
    let _this = this;

    if(evt) {
      _this.evt = evt;
      _this.Jaws._interactive = false;
    }

    // If CLI, parse arguments
    if (_this.Jaws.cli) {
      _this.evt = _this.Jaws.cli.options;
      
      if (_this.Jaws.cli.options.nonInteractive) {
        _this.Jaws._interactive = false;
      }
    }

    return _this.Jaws.validateProject()
      .bind(_this)
      .then(_this._promptKey)
      .then(_this._promptStage)
      .then(_this._promptRegion)
      .then(_this._validateAndPrepare)
      .then(_this._getEnvVar);  
  }
  
  
  /**
   * Prompt key if it's missing
   */
  _promptKey(){
    let _this = this;

    if (!_this.Jaws._interactive || _this.evt.key) return BbPromise.resolve();
    
    let prompts = {
      properties: {},
    };

    prompts.properties.key = {
      description: 'Enter the environment variable key to get its value: '.yellow,
      required:    true,
      message:     'environment variable key is required.',
    };
    
    return this.promptInput(prompts, null)
      .then(function(answers) {
        _this.evt.key = answers.key;
      })
  }
  
  
  /**
   * Prompt stage if it's missing
   */
  _promptStage(){
    let _this = this;
    let stages = Object.keys(_this.Jaws._projectJson.stages);

    // Skip if non-interactive
    if (!_this.Jaws._interactive || _this.evt.stage) return BbPromise.resolve();

    // if project has 1 stage, skip prompt
    if (stages.length === 1) {
      _this.evt.stage = stages[0];
      return BbPromise.resolve();
    }
    // add local stage
    stages.push('local');

    // Create Choices
    let choices = [];
    for (let i = 0; i < stages.length; i++) {
      choices.push({
        key:   (i + 1) + ') ',
        value: stages[i],
        label: stages[i],
      });
    }

    return JawsCLI.select('Which stage are you getting the env var from: ', choices, false)
      .then(function(results) {
        _this.evt.stage = results[0].value;
      });
  }
  
  /**
   * Prompt region if it's missing
   */
  _promptRegion(){
    let _this = this;

    // skip region prompt if selected stage is 'local'
    if (_this.evt.stage === 'local') {
      _this.evt.region = 'local';
      return BbPromise.resolve();
    }

    if (!_this.Jaws._interactive || _this.evt.region) return BbPromise.resolve();
    
    // TODO: list only regions defined in the provided Stage
    //       this assumres that the provided stage is valid, we'll have to validate before getting here
    let choices = awsMisc.validLambdaRegions.map(r => {
      return {
        key:   '',
        value: r,
        label: r,
      };
    });
    
    // adding all regions
    choices.push(
      {
        key:   '',
        value: 'all',
        label: 'all',  
      }
    );

    return _this.selectInput('Select a region to get env var from: ', choices, false)
      .then(results => {
        _this.evt.region = results[0].value;
      });
  }
  

  /**
   * Validate all data from event, interactive CLI or non interactive CLI
   * and prepare data
   */
  _validateAndPrepare(){
    let _this = this;

    // non interactive validation
    if (!_this.Jaws._interactive) {

      // Check API Keys
      if (!_this.Jaws._awsProfile) {
        if (!_this.Jaws._awsAdminKeyId || !_this.Jaws._awsAdminSecretKey) {
          return BbPromise.reject(new JawsError('Missing AWS Profile and/or API Key and/or AWS Secret Key'));
        }
      }
      // Check Params
      if (!_this.evt.stage || !_this.evt.region || !_this.evt.key) {
        return BbPromise.reject(new JawsError('Missing stage and/or region and/or key'));
      }
    }

    // validate stage: make sure stage exists
    if (!_this.Jaws._projectJson.stages[_this.evt.stage] && _this.evt.stage != 'local') {
      return BbPromise.reject(new JawsError('Stage ' + _this.evt.stage + ' does not exist in your project', JawsError.errorCodes.UNKNOWN));
    }
    
    // skip the next validation if stage is 'local' & region is 'all'
    if (_this.evt.stage != 'local' && _this.evt.region != 'all') {

      // validate region: make sure region exists in stage
      if (!_this.Jaws._projectJson.stages[_this.evt.stage].some(function(r) {
            return r.region == _this.evt.region;
          })) {
        return BbPromise.reject(new JawsError('Region "' + _this.evt.region + '" does not exist in stage "' + _this.evt.stage + '"'));  
      }
    }
  }
  
  /**
   * get env var based on data validated
   */
  _getEnvVar(){
    let _this = this;

    return awsMisc.getEnvFiles(_this.Jaws, _this.evt.region, _this.evt.stage)
      .then(envMapsByRegion => {
        let valByRegion = {};

        JawsCLI.log(`Values for ${_this.evt.key} in stage ${_this.evt.stage} by region:`);
        envMapsByRegion.forEach(mapForRegion => {
          let value;
          if (mapForRegion.vars && mapForRegion.vars[_this.evt.key]) {
            value = mapForRegion.vars[_this.evt.key];
            valByRegion[mapForRegion.regionName] = value;
          } else {
            value = chalk.red('NOT SET');
          }

          console.log(chalk.underline.bold(mapForRegion.regionName) + `: ${value}`);
        });

        return valByRegion;
      });
  }
}

module.exports = EnvGet;