Merge pull request #1091 from tfxor/feature/added_new_feature

Feature/added new feature and fixed issue #550

docs/commands/apply.md

@@ -8,6 +8,7 @@ this command will run `terraform apply` across multiple terrahub components
 
 Options:
   --auto-approve, -y     Auto approve terraform execution
+  --refresh-only, -R     Use Refresh-Only Mode to Sync Terraform State
   --include, -i          List of components to include (comma separated values)
   --exclude, -x          List of components to exclude (comma separated values)
   --include-regex, -I    List of components to include (regex search)

src/commands/apply.js

@@ -11,14 +11,16 @@ class ApplyCommand extends DistributedCommand {
     this
       .setName('apply')
       .setDescription('run distributedly `terraform apply` across multiple terrahub components')
-      .addOption('auto-approve', 'y', 'Auto approve terraform execution', Boolean, false);
+      .addOption('auto-approve', 'y', 'Auto approve terraform execution', Boolean, false)
+      .addOption('refresh-only', 'R', 'Use Refresh-Only Mode to Sync Terraform State', Boolean, false);
   }
 
   /**
    * @returns {Promise}
    */
   async run() {
     const config = this.getFilteredConfig();
+    this._refreshOnly = this.getOption('refresh-only');
 
     this.checkDependencies(config);
 
@@ -28,6 +30,14 @@ class ApplyCommand extends DistributedCommand {
       throw new Error('Action aborted');
     }
 
+    if (this._refreshOnly) {
+      return [{
+        actions: ['workspaceSelect', 'plan', 'applyRefreshOnly'],
+        config,
+        dependencyDirection: Dictionary.DIRECTION.FORWARD
+      }];
+    }
+
     return [{
       actions: ['workspaceSelect', 'plan', 'apply'],
       config,

src/config-loader.js

@@ -103,9 +103,9 @@ class ConfigLoader {
     return {
       terraform: {
         var: {},
-        varFile: [],
+        varFile: ['default.tfvars'],
         backend: {},
-        version: '0.14.5',
+        version: '1.0.9',
         backup: false,
         workspace: 'default',
       },

src/helpers/distributors/distributor.js

@@ -343,7 +343,7 @@ class Distributor {
 
     if (config.build && config.build.env && config.build.env.variables) {
       Object.entries(config.build.env.variables)
-        .filter((element) => element[1] !== '' && typeof element[1] === 'string')
+        .filter((element) => element[1] !== '' && typeof element[1] === 'string' && !this._isJSON(element[1]))
         .forEach((element) => {
           element[1] = this._replaceEnv(config.build.env.variables, element[1]);
           const stdout = execSync(`echo "${element[1]}"`);
@@ -360,7 +360,7 @@ class Distributor {
 
     if (config.project.env && config.project.env.variables) {
       Object.entries(config.project.env.variables)
-        .filter((element) => element[1] !== '' && typeof element[1] === 'string')
+        .filter((element) => element[1] !== '' && typeof element[1] === 'string' && !this._isJSON(element[1]))
         .forEach((element) => {
           element[1] = this._replaceEnv(config.project.env.variables, element[1]);
           const stdout = execSync(`echo "${element[1]}"`);
@@ -376,7 +376,7 @@ class Distributor {
 
     if (config.processEnv) {
       Object.entries(config.processEnv)
-        .filter((element) => element[1] !== '' && typeof element[1] === 'string')
+        .filter((element) => element[1] !== '' && typeof element[1] === 'string' && !this._isJSON(element[1]))
         .forEach((element) => {
           element[1] = this._replaceEnv(config.processEnv, element[1]);
           const stdout = execSync(`echo "${element[1]}"`);
@@ -418,6 +418,18 @@ class Distributor {
     }
   }
 
+  /**
+   * @param {String} str
+   * @return {boolean}
+   */
+  _isJSON(str) {
+    try {
+      return (JSON.parse(str.replaceAll('=', ':')) && !!str.replaceAll('=', ':'));
+    } catch (e) {
+      return false;
+    }
+  }
+
   /**
    * @param {String} importLines
    * @return {Promise}

src/helpers/wrappers/terraform.js

@@ -163,8 +163,10 @@ class Terraform {
    */
   _varFile() {
     const result = [];
+    this._tf.varFile.push(`${this._config.terraform.workspace}.tfvars`);
+    const uSet = new Set(this._tf.varFile);
 
-    this._tf.varFile.forEach(fileName => {
+    uSet.forEach(fileName => {
       const varFile = path.join(this._metadata.getRoot(), fileName);
 
       if (fs.existsSync(varFile)) {
@@ -302,13 +304,13 @@ class Terraform {
    * @return {Promise}
    */
   plan() {
-    const options = { '-out': this._metadata.getPlanPath(), '-input': false };
+    const options = { '-out': this._metadata.getPlanPath(), '-input': false, '-lock': false };
     const args = process.env.planDestroy === 'true' ? ['-no-color', '-destroy'] : ['-no-color'];
     const { providerId } = process.env;
     if (providerId) {
       const { targets } = this._config;
       if (targets.length) {
-        Object.assign(options, { '-target': `${targets[providerId]}`, '-lock': false });
+        Object.assign(options, { '-target': `${targets[providerId]}` });
       }
     }
 
@@ -342,12 +344,24 @@ class Terraform {
           fse.outputFileSync(backupPath, planContent);
         }
 
-        return Promise.resolve({
-          buffer: buffer,
-          skip: skip,
-          metadata: metadata,
-          status: Dictionary.REALTIME.SUCCESS
-        });
+        if (!skip) {
+          return Promise.resolve({
+            buffer: buffer,
+            skip: skip,
+            metadata: metadata,
+            status: Dictionary.REALTIME.SUCCESS
+          });
+        }
+
+        return this.run('refresh', args.concat(this._varFile(), this._var()))
+          .then(() => {
+            return Promise.resolve({
+              buffer: buffer,
+              skip: skip,
+              metadata: metadata,
+              status: Dictionary.REALTIME.SUCCESS
+            });
+          });
       });
   }
 
@@ -485,13 +499,30 @@ class Terraform {
   apply() {
     const backupPath = this._metadata.getStateBackupPath();
     fse.ensureFileSync(backupPath);
-    const options = { '-backup': backupPath, '-auto-approve': true, '-input': false };
+
+    const options = {
+      '-backup': backupPath, '-auto-approve': true, '-input': false, '-lock': false
+    };
 
     return this.run('apply', ['-no-color'].concat(this._optsToArgs(options), this._metadata.getPlanPath()))
       .then(() => this._getStateContent())
       .then(buffer => ({ buffer: buffer, status: Dictionary.REALTIME.SUCCESS }));
   }
 
+  /**
+   * https://www.terraform.io/docs/commands/apply.html
+   * @return {Promise}
+   */
+  applyRefreshOnly() {
+    const options = {
+      '-lock': false
+    };
+
+    return this.run('apply', ['-refresh-only'].concat(this._optsToArgs(options), this._metadata.getPlanPath()))
+      .then(() => this._getStateContent())
+      .then(buffer => ({ buffer: buffer, status: Dictionary.REALTIME.SUCCESS }));
+  }
+
   /**
    * Get state content whether is remote or local
    * @return {Promise}
@@ -516,7 +547,7 @@ class Terraform {
    * @return {Promise}
    */
   refresh() {
-    const options = { '-backup': this._metadata.getStateBackupPath(), '-input': false };
+    const options = { '-backup': this._metadata.getStateBackupPath(), '-input': false, '-lock': false };
 
     const localBackend = [];
     const { template } = this._config;

src/templates/help/metadata.json

@@ -14,6 +14,12 @@
           "description": "Auto approve terraform execution",
           "defaultValue": false
         },
+        {
+          "name": "refresh-only",
+          "shortcut": "R",
+          "description": "Use Refresh-Only Mode to Sync Terraform State",
+          "defaultValue": false
+        },
         {
           "name": "include",
           "shortcut": "i",