@rophy123/helmtest 2.0.0 → 2.1.0

package/Makefile

@@ -0,0 +1,7 @@
+.PHONY: help test
+
+help:	## Show this help.
+	@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##//'
+
+test: 	## Run unit tests.
+	docker run -t --rm -e DEBUG=helmtest -v `pwd`:/workspace rophy/helmtest

package/README.md

@@ -19,4 +19,70 @@ Differences with [Stono/helmtest](https://github.com/Stono/helm-test):
 
 ## Getting Started
 
-See [example](../../tree/example) as an example helm chart project which includes unit tests.
+### Running helmtest as npm module
+
+Install helmtest:
+
+```bash
+npm install @rophy123/helmtest
+```
+
+To use helmtest in your code:
+
+```javascript
+const helmtest = require('@rophy123/helmtest');
+
+// Run `helm template` under working directory
+helmtest.renderTemplate()
+.then(results => {
+  // results are JS objects converted from result YAML.
+  // '[{"apiVesrion":"v1","kind":"ServiceAccount","metadata":...
+  console.log(JSON.stringify(results));
+});
+```
+
+The results object can be used to verify details. For example, in jest:
+
+```javascript
+const helmtest = require('@rophy123/helmtest');
+
+test('exmapleChart should render 4 resources', async () => {
+  const result = await helmtest.renderTemplate();
+  expect(result.length).toBe(4);
+});
+```
+
+See [API Spec](#api-spec) for the options of `helmtest.renderTemplate()`.
+
+### Running helmtest as CLI
+
+Install [jest](https://jestjs.io/) along with helmtest globally:
+
+```bash
+npm install -g @rophy123/helmtest jest
+```
+
+...and then you can write unit tests under `tests/` dir of your chart project without the need for package.json
+
+A docker image [rophy/helmtest](https://hub.docker.com/r/rophy/helmtest) is avilable which includes everything to run up unit tests.
+
+See [example](../../tree/example) as an example helm chart project on how to use docker image and write unit tests.
+
+## API Spec
+
+helmtest currently only expose one method: `helmtest.renderTemplate(options)`.
+
+`options` is a object with option names, descriptions and defaults as below:
+
+| Option               | Description                                                                         | Default                                             |
+| -------------------- | ----------------------------------------------------------------------------------- | --------------------------------------------------- |
+| chartDir             | Path to chart, the `CHART` arg in helm CLI: `helm template [NAME] [CHART] [flags]`. | `'.'`                                               |
+| releaseName          | Release name, the `NAME` arg in helm CLI: `helm template [NAME] [CHART] [flags]`.   | `'release-name'`                                    |
+| values               | Map of chart values to set.                                                         | `{}`                                                |
+| valuesFiles          | Paths to additional values.yaml.                                                    | `[]`                                                |
+| extraHelmArgs        | Extra args to pass to helm CLI, e.g. `--timeout=5s`                                 | `[]`                                                |
+| helmBinary           | Path to helm binary.                                                                | `process.env.HELM_BINARY \|\| 'helm'`               |
+| loadYaml             | if `false`, will return rendered template as raw string instead of js object.       | `true`                                              |
+| kubeconformEnabled   | if `true`, will pass rendered template to kubeconform CLI to validate schema.       | `process.env.KUBECONFORM_ENABLED \|\| false`        |
+| kubeconformBinary    | Path to kubeconform binary.                                                         | `process.env.KUBECONFORM_BINARY \|\| 'kubeconform'` |
+| kubeconformArgs      | Args to pass to kubeconform CLI. Will append `process.env.KUBECONFORM_EXTRA_ARGS`.  | `['-strict','-ignore-missing-schemas','-summary']`  |

package/lib/helmtest.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
 const path = require('path');
 const util = require('util');
-const exec = util.promisify(require('node:child_process').exec);
+const execFile = util.promisify(require('node:child_process').execFile);
 const yaml = require('js-yaml');
 const debug = require('debug')('helmtest');
 const Readable = require('stream').Readable;
@@ -26,8 +26,13 @@ async function renderTemplate(options = {}) {
     process.env.KUBECONFORM_ENABLED || false;
   options.kubeconformBinary = options.kubeconformBinary ||
     process.env.KUBECONFORM_BINARY || 'kubeconform';
-  options.kubeconformExtraArgs = options.kubeconformExtraArgs ||
-    process.env.KUBECONFORM_ARGS || false;
+  options.kubeconformArgs = options.kubeconformArgs ||
+    ['-strict', '-ignore-missing-schemas', '-summary'];
+
+  if (process.env.KUBECONFORM_EXTRA_ARGS) {
+    const kcExtraArgs = process.env.KUBECONFORM_EXTRA_ARGS.split(' ');
+    options.kubeConformArgs.concat(kcExtraArgs);
+  }
 
   debug(`options: ${JSON.stringify(options)}`);
 
@@ -35,7 +40,8 @@ async function renderTemplate(options = {}) {
   fs.statSync(options.chartDir);
 
   // Now construct the args.
-  const helmCmd = [options.helmBinary, 'template'];
+  const helmCmd = options.helmBinary;
+  const helmArgs = ['template'];
 
   const valueKeys = Object.keys(options.values);
   const valuePairs = [];
@@ -43,7 +49,7 @@ async function renderTemplate(options = {}) {
     valuePairs.push(`${key}=${options.values[key]}`);
   });
   if (valuePairs.length > 0) {
-    helmCmd.push('--set', valuePairs.join(','));
+    helmArgs.push('--set', valuePairs.join(','));
   }
 
   if (options.valuesFiles) {
@@ -52,8 +58,7 @@ async function renderTemplate(options = {}) {
       options.valuesFiles;
     valuesFiles.forEach((valuesFile) => {
       fs.statSync(valuesFile);
-      helmCmd.push('-f');
-      helmCmd.push(valuesFile);
+      helmArgs.push('-f', valuesFile);
     });
   }
 
@@ -66,35 +71,28 @@ async function renderTemplate(options = {}) {
       fs.statSync(filePath);
       // Note: get the abs template file path to chek it actually exists,
       // `helm template` command expects relative path from chartDir.
-      helmCmd.push('--show-only');
-      helmCmd.push(templateFile);
+      helmArgs.push('--show-only', templateFile);
     });
   }
 
-  if (options.extraHelmArgs) {
-    options.extraHelmArgs.forEach((arg) => helmCmd.push(arg));
-  }
-
-  helmCmd.push(options.releaseName);
-  helmCmd.push(options.chartDir);
-
-  const command = helmCmd.join(' ');
-  debug(`command: ${command}`);
-  const helmOutput = await exec(command);
+  options.extraHelmArgs.forEach((arg) => helmArgs.push(arg));
+  helmArgs.push(options.releaseName, options.chartDir);
+  debug(`helm command: ${helmCmd} ${helmArgs.join(' ')}`);
+  const helmOutput = await execFile(helmCmd, helmArgs);
 
   if (options.kubeconformEnabled) {
-    let kcCommand = options.kubeconformBinary;
-    if (options.kubeconformExtraArgs) {
-      kcCommand += ' ' + options.kubeconformExtraArgs;
-    }
-    debug(`kcCommand: ${kcCommand}`);
-    const kcProc = exec(kcCommand);
+    const kcCmd = options.kubeconformBinary;
+    const kcArgs = options.kubeconformArgs;
+    debug(`kubeconform command: ${kcCmd} ${kcArgs.join(' ')}`);
+    const kcProc = execFile(kcCmd, kcArgs);
     const piper = new Readable();
     piper.pipe(kcProc.child.stdin);
     piper.push(helmOutput.stdout);
     piper.push(null);
     try {
-      await kcProc;
+      const kcResult = await kcProc;
+      if (kcResult.stdout) debug(kcResult.stdout);
+      if (kcResult.stderr) debug(kcResult.stderr);
     } catch (err) {
       if (err.stdout) console.error(err.stdout);
       if (err.stderr) console.error(err.stderr);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rophy123/helmtest",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Write unit tests against your helm charts using JavaScript.",
   "main": "index.js",
   "bin": {