All files / lib/resource-types hcl.js

100% Statements 122/122
100% Branches 18/18
100% Functions 6/6
100% Lines 122/122

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 1231x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 3x 3x 2x 2x 2x 2x 2x 2x 2x 2x 2x 3x 1x 1x 3x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 6x 6x 6x 6x 5x 5x 4x 4x 4x 4x 1x 4x 3x 3x 1x 1x 1x 3x 1x 1x 1x 1x 1x 1x 3x 4x 5x 5x 6x 1x 1x 1x 1x 1x 6x 5x 5x 6x 1x 1x 1x 1x 1x 1x 1x 1x 1x  
"use strict";
/**
 * @module resource-types/hcl
 */
import bag from "bagofcli";
import { getProperty } from "dot-prop";
import fs from "fs";
import hcl from "hcl2-parser";
 
/**
 * Set version value in the HCL resource's property (defined in dot-notation).
 * This uses {@link https://github.com/minamijoyo/hcledit|hcledit} CLI tool to
 * modify the HCL file because there is no node.js library that can write HCL
 * files in a safe way while preserving original formatting.
 *
 * NOTE: hcledit must be installed and available in the PATH for this to work.
 *
 * @param {String} version - version value to set
 * @param {Object} resource - resource configuration
 * @param {String} resource.path - path to the HCL file
 * @param {String} resource.params.property - property in dot-notation
 * @param {Object} opts - optional settings
 * @param {Boolean} [opts.dryRun] - when true, HCL file won't be modified
 * @param {Function} cb - standard cb(err, result) callback
 */
function setVersion(version, resource, opts, cb) {
  if (!opts.dryRun) {
    const property = resource.params.property;
    function execCb(err, stdOutOuput, stdErrOuput, result) {
      cb(err);
    }
    bag.exec(
      `hcledit attribute set ${property} ${version} -f ${resource.path} -u`,
      false,
      execCb,
    );
  } else {
    cb();
  }
}
 
/**
 * Get version value from the HCL resource's property (defined in dot-notation).
 *
 * @param {Object} resource - resource configuration
 * @param {String} resource.path - path to the HCL file
 * @param {String} resource.params.property - property in dot-notation
 * @param {Function} cb - standard cb(err, result) callback, result is the
 *   version value
 */
function getVersion(resource, cb) {
  const property = resource.params.property;
 
  function readCb(err, result) {
    let version;
    if (!err) {
      const data = hcl.parseToObject(result)[0];
      version = getProperty(data, property);
    }
    cb(err, version);
  }
  fs.readFile(resource.path, "UTF-8", readCb);
}
 
/**
 * Check that the HCL resource is ready for release, i.e. the file can be
 * parsed and the property exists with a value.
 *
 * @param {Object} resource - resource configuration
 * @param {String} resource.path - path to the HCL file
 * @param {String} resource.params.property - property in dot-notation
 * @param {Function} cb - standard cb(err, result) callback, result is true
 *   when the resource is ready for release, an error is passed when the file
 *   is not configured, the file can't be parsed, or the property doesn't exist or has no value
 */
function isReadyForRelease(resource, cb) {
  const property = resource.params && resource.params.property;
 
  function readCb(err, result) {
    let ready;
    if (!err) {
      // hcl2-parser returns the parse error (without a message) instead of
      // throwing it
      const [data, parseErr] = hcl.parseToObject(result);
      if (parseErr) {
        err = new Error(`Failed to parse HCL resource ${resource.path}`);
      } else {
        const value = getProperty(data, property);
        if (value === undefined) {
          err = new Error(
            `Property ${property} does not exist in HCL resource ${resource.path}`,
          );
        } else if (value === null || value === "") {
          err = new Error(
            `Property ${property} has no value in HCL resource ${resource.path}`,
          );
        } else {
          ready = true;
        }
      }
    }
    cb(err, ready);
  }
  if (!property) {
    cb(
      new Error(
        `HCL resource ${resource.path} has no params.property configured`,
      ),
    );
  } else {
    fs.readFile(resource.path, "UTF-8", readCb);
  }
}
 
const exports = {
  setReleaseVersion: setVersion,
  setPostReleaseVersion: setVersion,
  getVersion: getVersion,
  isReadyForRelease: isReadyForRelease,
};
 
export { exports as default };