Merge pull request #21 from cliffano/hcl-support

cliffano · web-flow · commit c844fa110567 · 2025-10-19T12:17:44.000+11:00
Add HCL support
diff --git a/README.md b/README.md
@@ -151,6 +151,22 @@ Example `toml` resource configuration:
       ]
     }
 
+### Managing version on HCL file
+
+Example `hcl` resource configuration:
+
+    {
+      "resources": [
+        {
+          "path": "somefile.hcl",
+          "type": "hcl",
+          "params": {
+            "property": "version"
+          }
+        }
+      ]
+    }
+
 ### Managing version on Makefile file
 
 Example `makefile` resource configuration:
diff --git a/lib/release-schemes/rtk.js b/lib/release-schemes/rtk.js
@@ -5,6 +5,7 @@ import stringFormat from 'string-format';
 import util from 'util';
 import semverVersionScheme from '../version-schemes/semver.js';
 import gitScmScheme from '../scm-schemes/git.js';
+import hclResourceType from '../resource-types/hcl.js';
 import jsonResourceType from '../resource-types/json.js';
 import keepAChangelogResourceType from '../resource-types/keep-a-changelog.js';
 import makefileResourceType from '../resource-types/makefile.js';
@@ -29,6 +30,7 @@ class Rtk {
       git: gitScmScheme
     };
     this.resourceTypes = {
+      hcl: hclResourceType,
       json: jsonResourceType,
       makefile: makefileResourceType,
       text: textResourceType,
diff --git a/lib/resource-types/hcl.js b/lib/resource-types/hcl.js
@@ -0,0 +1,60 @@
+"use strict";
+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 will use hcledit CLI tool (https://github.com/minamijoyo/hcledit) 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 which contains type, path, and params
+ * @param {Object} opts: optional settings
+ *   - 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 which contains type, path, and params
+ * @param {Function} cb: standard cb(err, result) callback
+ */
+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);
+}
+
+const exports = {
+  setReleaseVersion: setVersion,
+  setPostReleaseVersion: setVersion,
+  getVersion: getVersion
+};
+
+export {
+  exports as default
+};
diff --git a/lib/rtk.js b/lib/rtk.js
@@ -1,6 +1,7 @@
 "use strict";
 import async from 'async';
 import rtkReleaseScheme from './release-schemes/rtk.js';
+import hclResourceType from './resource-types/hcl.js';
 import jsonResourceType from './resource-types/json.js';
 import keepAChangelogResourceType from './resource-types/keep-a-changelog.js';
 import makefileResourceType from './resource-types/makefile.js';
@@ -27,6 +28,7 @@ class RTK {
       rtk: rtkReleaseScheme
     };
     this.resourceTypes = {
+      hcl: hclResourceType,
       json: jsonResourceType,
       makefile: makefileResourceType,
       text: textResourceType,
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -44,6 +44,7 @@
     "bagofcli": "^2.4.1",
     "chalk": "^5.4.1",
     "dot-prop": "^9.0.0",
+    "hcl2-parser": "^1.0.3",
     "js-yaml": "^4.1.0",
     "keep-a-changelog": "^0.10.4",
     "lodash": "^4.17.21",
diff --git a/test-integration/commands.yml b/test-integration/commands.yml
@@ -31,4 +31,8 @@
   command: '{rtk} release --dry-run --config-file {base}/test-integration/fixtures/confs/rtk-yaml.json'
   exitcode: 0
   output: 'Setting release version version-1.3.0 on yaml resource located at ../../../../../test-integration/fixtures/data/data.yaml'
-  
+
+- description: Command release dry run config should format release value on a HCL data file
+  command: '{rtk} release --dry-run --config-file {base}/test-integration/fixtures/confs/rtk-hcl.json'
+  exitcode: 0
+  output: 'Setting release version version-1.3.0 on hcl resource located at ../../../../../test-integration/fixtures/data/data.hcl'
diff --git a/test-integration/fixtures/confs/rtk-hcl.json b/test-integration/fixtures/confs/rtk-hcl.json
@@ -0,0 +1,12 @@
+{
+    "resources": [
+      {
+        "path": "../../../../../test-integration/fixtures/data/data.hcl",
+        "type": "hcl",
+        "params": {
+          "property": "app_version",
+          "release_format": "version-{version}"
+        }
+      }
+    ]
+  }
diff --git a/test-integration/fixtures/data/data.hcl b/test-integration/fixtures/data/data.hcl
@@ -0,0 +1 @@
+app_version = "1.2.3"
diff --git a/test/cli.js b/test/cli.js
@@ -28,7 +28,7 @@ describe('cli - release', function() {
 
   afterEach(function () {
     this.mockBag.verify();
-    this.mockBag.restore();
+    sinon.restore();
   });
 
   it('should contain release command and delegate to rtk release when exec is called', function (done) {
diff --git a/test/release-schemes/rtk.js b/test/release-schemes/rtk.js
@@ -20,7 +20,7 @@ describe('rtk', function() {
       done();
     });
     it('should initialise resource types', function (done) {
-      assert.keys(this.rtk.resourceTypes, ['json', 'makefile', 'text', 'toml', 'yaml', 'keep-a-changelog']);
+      assert.keys(this.rtk.resourceTypes, ['hcl', 'json', 'makefile', 'text', 'toml', 'yaml', 'keep-a-changelog']);
       done();
     });
     it('should initialise version scheme', function (done) {
diff --git a/test/resource-types/hcl.js b/test/resource-types/hcl.js
@@ -0,0 +1,135 @@
+"use strict";
+/* eslint no-unused-vars: 0 */
+import assert from 'assert';
+import bag from 'bagofcli';
+import fs from 'fs';
+import resourceType from '../../lib/resource-types/hcl.js';
+import sinon from 'sinon';
+
+describe('hcl', function() {
+
+  beforeEach(function (done) {
+    this.mockBag = sinon.mock(bag);
+    this.mockFs = sinon.mock(fs);
+    done();
+  });
+  afterEach(function (done) {
+    this.mockBag.verify();
+    this.mockFs.verify();
+    sinon.restore();
+    done();
+  });
+
+  describe('setVersion', function() {
+    it('should only set version but not modify hcl file when dry run is enabled', function(done) {
+      const resource = {
+        path: 'variables.tf',
+        type: 'hcl',
+        params: {
+          property: 'version'
+        }
+      };
+      this.mockFs.expects('readFileSync').never();
+      this.mockFs.expects('writeFile').never();
+      function cb(err, result) {
+        assert.equal(err, null);
+        done();
+      }
+      resourceType.setReleaseVersion('1.2.3', resource, { dryRun: true }, cb);
+    });
+    it('should set call hcledit via execaSync when dry run is disabled', function(done) {
+      const resource = {
+        path: 'variables.tf',
+        type: 'hcl',
+        params: {
+          property: 'variable.tags.default.version'
+        }
+      };
+      this.mockFs.expects('readFileSync').never();
+      this.mockFs.expects('writeFile').never();
+      this.mockBag
+        .expects('exec')
+        .once()
+        .withArgs('hcledit attribute set variable.tags.default.version 1.2.3 -f variables.tf -u', false, sinon.match.func)
+        .callsArgWith(2, null, 'somestdout', 'somestderr', { exitCode: 0 });
+      function cb(err) {
+        assert.equal(err, null);
+        done();
+      }
+      resourceType.setReleaseVersion('1.2.3', resource, { dryRun: false }, cb);
+    });
+    it('should set array property under a section', function(done) {
+      const resource = {
+        path: 'variables.tf',
+        type: 'hcl',
+        params: {
+          property: 'package.versions[1]'
+        }
+      };
+      this.mockFs.expects('readFileSync').never();
+      this.mockFs.expects('writeFile').never();
+      this.mockBag
+        .expects('exec')
+        .once()
+        .withArgs('hcledit attribute set package.versions[1] 1.2.3 -f variables.tf -u', false, sinon.match.func)
+        .callsArgWith(2, null, 'somestdout', 'somestderr', { exitCode: 0 });
+      function cb(err) {
+        assert.equal(err, null);
+        done();
+      }
+      resourceType.setReleaseVersion('1.2.3', resource, { dryRun: false }, cb);
+    });
+  });
+
+  describe('getVersion', function() {
+    it('should get version from resource property', function(done) {
+      const resource = {
+        path: 'variables.tf',
+        type: 'hcl',
+        params: {
+          property: 'version'
+        }
+      };
+      this.mockFs.expects('readFile').once().withExactArgs('variables.tf', 'UTF-8', sinon.match.func).callsArgWith(2, null, 'version = "0.0.0"');
+      function cb(err, result) {
+        assert.equal(err, null);
+        assert.equal(result, '0.0.0');
+        done();
+      }
+      resourceType.getVersion(resource, cb);
+    });
+    it('should get array property as a subproperty', function(done) {
+      const resource = {
+        path: 'variables.tf',
+        type: 'hcl',
+        params: {
+          property: 'package.versions[1]'
+        }
+      };
+      this.mockFs.expects('readFile').once().withExactArgs('variables.tf', 'UTF-8', sinon.match.func).callsArgWith(2, null, 'package = { versions = ["9.9.9", "0.0.0", "8.8.8"] }');
+      function cb(err, result) {
+        assert.equal(err, null);
+        assert.equal(result, '0.0.0');
+        done();
+      }
+      resourceType.getVersion(resource, cb);
+    });
+    it('should get array property under a resource', function(done) {
+      const resource = {
+        path: 'variables.tf',
+        type: 'hcl',
+        params: {
+          property: 'resource.something.somename[0].package.versions[1]'
+        }
+      };
+      this.mockFs.expects('readFile').once().withExactArgs('variables.tf', 'UTF-8', sinon.match.func).callsArgWith(2, null, 'resource "something" "somename" { package = { versions = ["9.9.9", "0.0.0", "8.8.8"] }}');
+      function cb(err, result) {
+        assert.equal(err, null);
+        assert.equal(result, '0.0.0');
+        done();
+      }
+      resourceType.getVersion(resource, cb);
+    });
+  });
+
+});
