@rophy123/helmtest 1.0.0 → 1.2.0

package/.dockerignore

@@ -0,0 +1,2 @@
+node_modules/
+.git/

package/Dockerfile

@@ -0,0 +1,28 @@
+FROM node:16.19.1-bullseye-slim
+
+RUN apt-get update && apt-get install -y curl git
+
+RUN curl -sLo ./helm.tar.gz https://get.helm.sh/helm-v3.11.2-linux-amd64.tar.gz \
+    && tar -zxvf helm.tar.gz linux-amd64/helm \
+    --strip-components 1 && mv ./helm /usr/local/bin/ \
+    && rm ./helm.tar.gz
+
+RUN curl -sLo ./helm.tar.gz https://get.helm.sh/helm-v3.11.2-linux-amd64.tar.gz \
+    && tar -zxvf helm.tar.gz linux-amd64/helm \
+    --strip-components 1 && mv ./helm /usr/local/bin/ \
+    && rm ./helm.tar.gz
+
+RUN curl -sLo kubeconform.tar.gz https://github.com/yannh/kubeconform/releases/download/v0.6.1/kubeconform-linux-amd64.tar.gz \
+    && tar -zxvf kubeconform.tar.gz kubeconform \
+    && mv ./kubeconform /usr/local/bin/ \
+    && rm kubeconform.tar.gz
+
+ENV KUBERNETES_VERSION=1.22.9
+RUN cd / && git clone --depth 1 --filter=blob:none --sparse https://github.com/yannh/kubernetes-json-schema \
+    && cd kubernetes-json-schema \
+    && git sparse-checkout set v${KUBERNETES_VERSION}-standalone-strict \
+    && rm -rf ./.git
+
+ENV KUBECONFORM_ENABLED=true KUBECONFORM_ARGS="-kubernetes-version ${KUBERNETES_VERSION} -schema-location /kubernetes-json-schema -strict"
+ENV HELM_REGISTRY_CONFIG=/tmp/registry.json DOCKER_CONFIG=/tmp/config.json
+RUN npm install -g @rophy123/helmtest

package/README.md

@@ -0,0 +1,4 @@
+# helmtest
+
+Write unit tests for your helm chart using JavaScript.
+

package/bin/helmtest

@@ -2,7 +2,8 @@
 
 const jest = require('jest');
 const path = require('path');
-
+const helmtest = require('../lib/helmtest');
+globalThis.helmtest = helmtest;
 jest.run([
   '--testMatch',
   '**/*.js',

package/lib/helmtest.js

@@ -3,6 +3,8 @@ const path = require('path');
 const util = require('util');
 const exec = util.promisify(require('node:child_process').exec);
 const yaml = require('js-yaml');
+const debug = require('debug')('helmtest');
+const Readable = require('stream').Readable;
 
 /**
  * Run `helm template` to generate javascript object of the result YAML.
@@ -20,6 +22,14 @@ async function renderTemplate(options = {}) {
   options.extraHelmArgs = options.extraHelmArgs || [];
   options.helmBinary = options.helmBinary || process.env.HELM_BINARY || 'helm';
   options.loadYaml = options.loadYaml || true;
+  options.kubeconformEnabled = options.kubeconformEnabled ||
+    process.env.KUBECONFORM_ENABLED || false;
+  options.kubeconformBinary = options.kubeconformBinary ||
+    process.env.KUBECONFORM_BINARY || 'kubeconform';
+  options.kubeconformExtraArgs = options.kubeconformExtraArgs ||
+    process.env.KUBECONFORM_ARGS || false;
+
+  debug(`options: ${JSON.stringify(options)}`);
 
   // Make sure chartDir exists.
   fs.statSync(options.chartDir);
@@ -68,7 +78,30 @@ async function renderTemplate(options = {}) {
   helmCmd.push(options.releaseName);
   helmCmd.push(options.chartDir);
 
-  const helmOutput = await exec(helmCmd.join(' '));
+  const command = helmCmd.join(' ');
+  debug(`command: ${command}`);
+  const helmOutput = await exec(command);
+
+  if (options.kubeconformEnabled) {
+    let kcCommand = options.kubeconformBinary;
+    if (options.kubeconformExtraArgs) {
+      kcCommand += ' ' + options.kubeconformExtraArgs;
+    }
+    debug(`kcCommand: ${kcCommand}`);
+    const kcProc = exec(kcCommand);
+    const piper = new Readable();
+    piper.pipe(kcProc.child.stdin);
+    piper.push(helmOutput.stdout);
+    piper.push(null);
+    try {
+      await kcProc;
+    } catch (err) {
+      if (err.stdout) console.error(err.stdout);
+      if (err.stderr) console.error(err.stderr);
+      throw err;
+    }
+  }
+
   if (options.loadYaml) {
     return yaml.loadAll(helmOutput.stdout);
   } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rophy123/helmtest",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Write unit tests against your helm charts using JavaScript.",
   "main": "index.js",
   "bin": {
@@ -20,6 +20,7 @@
   },
   "homepage": "https://github.com/rophy/helmtest#readme",
   "dependencies": {
+    "debug": "^4.3.4",
     "jest": "^29.5.0",
     "js-yaml": "^4.1.0"
   },