All files / lib/resource-types json.js

100% Statements 110/110
100% Branches 17/17
100% Functions 5/5
100% Lines 110/110

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 1111x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 5x 5x 4x 5x 1x 1x 5x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 6x 6x 6x 6x 5x 5x 4x 4x 4x 1x 1x 1x 4x 1x 1x 1x 1x 1x 1x 4x 1x 1x 1x 1x 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/json
 */
import { getProperty, setProperty } from "dot-prop";
import fs from "fs";
 
/**
 * Set version value in the JSON resource's property (defined in dot-notation).
 *
 * @param {String} version - version value to set
 * @param {Object} resource - resource configuration
 * @param {String} resource.path - path to the JSON file
 * @param {String} resource.params.property - property in dot-notation
 * @param {Object} opts - optional settings
 * @param {Boolean} [opts.dryRun] - when true, JSON file won't be modified
 * @param {Function} cb - standard cb(err, result) callback
 */
function setVersion(version, resource, opts, cb) {
  const property = resource.params.property;
  const data = JSON.parse(fs.readFileSync(resource.path, "UTF-8"));
  setProperty(data, property, version);
  if (!opts.dryRun) {
    fs.writeFile(resource.path, JSON.stringify(data, null, 2) + "\n", cb);
  } else {
    cb();
  }
}
 
/**
 * Get version value from the JSON resource's property (defined in
 * dot-notation).
 *
 * @param {Object} resource - resource configuration
 * @param {String} resource.path - path to the JSON 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 = JSON.parse(result);
      version = getProperty(data, property);
    }
    cb(err, version);
  }
  fs.readFile(resource.path, "UTF-8", readCb);
}
 
/**
 * Check that the JSON 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 JSON 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) {
      try {
        const value = getProperty(JSON.parse(result), property);
        if (value === undefined) {
          err = new Error(
            `Property ${property} does not exist in JSON resource ${resource.path}`,
          );
        } else if (value === null || value === "") {
          err = new Error(
            `Property ${property} has no value in JSON resource ${resource.path}`,
          );
        } else {
          ready = true;
        }
      } catch (parseErr) {
        err = new Error(
          `Failed to parse JSON resource ${resource.path}. Error: ${parseErr.message}`,
        );
      }
    }
    cb(err, ready);
  }
  if (!property) {
    cb(
      new Error(
        `JSON 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 };