feat: add helm v2 support

Dockerfile

@@ -1,4 +1,4 @@
-FROM fireblink/kind:1.19.0
+FROM fireblink/kind:1.19.0-2
 
 RUN npm i -g http-server
 

README.md

@@ -82,7 +82,8 @@ pipeline:
 
 ## Action Handlers
 
-- [helm update --install](./docs/UpdateOrInstall.md)
-- [helm delete](./docs/Delete.md)
-- [helm test](./docs/Test.md)
-- [helm repo add](./docs/RepoAdd.md)
+- Helm V3 only: [helm update --install](./docs/UpdateOrInstall.md)
+- Helm V2 only: [helm update --install](./docs/UpdateOrInstall_V2.md)
+- Helm V2 and V3: [helm delete](./docs/Delete.md)
+- Helm V2 and V3: [helm test](./docs/Test.md)
+- Helm V2 and V3: [helm repo add](./docs/RepoAdd.md)

docker-run-tests.sh

@@ -9,8 +9,15 @@ mkdir -p test/assets/helm/repo
 helm package test/assets/helm/test --destination test/assets/helm/repo
 helm repo index test/assets/helm/repo
 http-server -p 9999 test/assets/helm/repo &
+
+mkdir -p test/assets/helm/repo-v2
+helm_v2 package test/assets/helm/test-v2 --destination test/assets/helm/repo-v2
+helm_v2 repo index test/assets/helm/repo-v2
+http-server -p 9988 test/assets/helm/repo-v2 &
+
 sleep 2
 helm repo add localhost http://localhost:9999
+helm_v2 repo add localhost http://localhost:9988
 
 echo "-> running tests"
 cd /usr/app

docs/Delete.md

@@ -16,6 +16,10 @@ Action handler that allows to delete the release.
 ```yaml
 pipeline:
   helm.del:
+    # [optional] Custom helm binary name/path
+    # Default value: helm
+    binary: 'helm_v3'
+
     # [required] Release name.
     release: 'string'
 

docs/RepoAdd.md

@@ -15,6 +15,10 @@ Action handler that allows to add new repository.
 ```yaml
 pipeline:
   helm.repo.add:
+    # [optional] Custom helm binary name/path
+    # Default value: helm
+    binary: 'helm_v3'
+
     # [required] Name of the repository to add
     name: repo_name
 

docs/Test.md

@@ -15,6 +15,10 @@ Action handler that allows to test the release.
 ```yaml
 pipeline:
   helm.test:
+    # [optional] Custom helm binary name/path
+    # Default value: helm
+    binary: 'helm_v3'
+
     # [required] Release name.
     release: 'string'
 

docs/UpdateOrInstall.md

@@ -18,6 +18,10 @@ Action handler that allows to install new / update existing helm chart release.
 ```yaml
 pipeline:
   helm.install:
+    # [optional] Custom helm binary name/path
+    # Default value: helm
+    binary: 'helm_v3'
+
     # [required] Release name.
     release: 'string'
 
@@ -26,7 +30,7 @@ pipeline:
 
     # [optional] Specify the exact chart version to use. If this is not specified,
     # the latest version is used (works only for charts referenced from repositories).
-    version: '1.0.0.'
+    version: '1.0.0'
 
     # [optional] K8s namespace into which to install the release.
     # Default value: `default`

docs/UpdateOrInstall_V2.md

@@ -0,0 +1,78 @@
+# Update or Install Helm Chart (for Helm V2)
+
+Action handler that allows to install new / update existing helm chart release.
+
+**ID:** `com.fireblink.fbl.plugins.k8s.helm.upgrade.v2`
+
+**Aliases:**
+
+- `fbl.plugins.k8s.helm.upgrade.v2`
+- `fbl.plugins.k8s.helm.install.v2`
+- `k8s.helm.upgrade.v2`
+- `k8s.helm.install.v2`
+- `helm.upgrade.v2`
+- `helm.install.v2`
+
+## Syntax:
+
+```yaml
+pipeline:
+  helm.install:
+    # [optional] Custom helm binary name/path
+    # Default value: helm
+    binary: 'helm_v2'
+
+    # [required] Release name.
+    release: 'string'
+
+    # [required} Chart name or local path (absolute or relative to the flow file).
+    chart: 'repo/chart'
+
+    # [optional] Specify the exact chart version to use. If this is not specified,
+    # the latest version is used (works only for charts referenced from repositories).
+    version: '1.0.0'
+
+    # [optional] K8s namespace into which to install the release.
+    # Default value: `default`
+    namespace: 'main'
+
+    # [optional] extra variables to override / exted default helm chart values
+    variables:
+      # [optional] list of files to use as sources for values
+      files:
+        - assets/chart_values.yml
+
+      # [optional] list of files that are EJS templates (both FBL global and local delimiters are supported)
+      # Note: template have a priority over `files`
+      templates:
+        - assets/chart_values.tpl.yml
+
+      # [optional] define values inline the flow
+      # Note: inlive values have a priority over both `files` and `templates`
+      inline:
+        ImagePullPolicy: Always
+
+    # [optional] Force resource update through delete/recreate if needed.
+    # Default value: false
+    force: true
+
+    # [optional] If set, will wait until all Pods, PVCs, Services, and minimum number of Pods
+    # of a Deployment are in a ready state before marking the release as successful. It will
+    # wait for as long as `timeout`.
+    # Default value: false
+    wait: true
+
+    # [optional] Еime in seconds to wait for any individual Kubernetes operation (like Jobs for hooks)
+    # Default value: 300 (5 minutes)
+    # Max allowed value: 3600 (1 hour)
+    timeout: 60
+
+    # [optional] Enable verbose output.
+    # Default value: false
+    debug: false
+
+    # [optional] List of extra arguments to append to the command.
+    # Refer to `helm help upgrade` for all available options
+    extra:
+      - --dry-run
+```

index.ts

@@ -23,6 +23,7 @@ module.exports = <IPlugin>{
         new handlers.DeleteActionHandler(),
         new handlers.TestActionHandler(),
         new handlers.UpgradeOrInstallActionHandler(),
+        new handlers.UpgradeOrInstallV2ActionHandler(),
         new handlers.AddRepoActionHandler(),
     ],
 

src/handlers/UpgradeOrInstallV2ActionHandler.ts

@@ -0,0 +1,43 @@
+import {
+    ActionHandler,
+    ActionProcessor,
+    IActionHandlerMetadata,
+    IContext,
+    ActionSnapshot,
+    IDelegatedParameters,
+} from 'fbl';
+import { UpgradeOrInstallV2ActionProcessor } from '../processors';
+
+export class UpgradeOrInstallV2ActionHandler extends ActionHandler {
+    private static metadata = <IActionHandlerMetadata>{
+        id: 'com.fireblink.fbl.plugins.k8s.helm.upgrade.v2',
+        aliases: [
+            'fbl.plugins.k8s.helm.upgrade.v2',
+            'fbl.plugins.k8s.helm.install.v2',
+            'k8s.helm.upgrade.v2',
+            'k8s.helm.install.v2',
+            'helm.upgrade.v2',
+            'helm.install.v2',
+        ],
+    };
+
+    /* istanbul ignore next */
+    /**
+     * @inheritdoc
+     */
+    getMetadata(): IActionHandlerMetadata {
+        return UpgradeOrInstallV2ActionHandler.metadata;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    getProcessor(
+        options: any,
+        context: IContext,
+        snapshot: ActionSnapshot,
+        parameters: IDelegatedParameters,
+    ): ActionProcessor {
+        return new UpgradeOrInstallV2ActionProcessor(options, context, snapshot, parameters);
+    }
+}

src/handlers/index.ts

@@ -2,3 +2,4 @@ export * from './repo';
 export * from './DeleteActionHandler';
 export * from './TestActionHandler';
 export * from './UpgradeOrInstallActionHandler';
+export * from './UpgradeOrInstallV2ActionHandler';

src/processors/BaseActionProcessor.ts

@@ -4,28 +4,31 @@ import Container from 'typedi';
 export abstract class BaseActionProcessor extends ActionProcessor {
     /**
      * Execute "helm" command
+     * @param binary
      * @param {string[]} args
      * @param {string} wd
      * @return {Promise<IExecOutput>}
      */
     async execHelmCommand(
         args: string[],
         debug: boolean,
+        binary?: string,
     ): Promise<{
         code: number;
         stdout: string;
         stderr: string;
     }> {
+        binary = binary || 'helm';
         const childProcessService = Container.get(ChildProcessService);
 
         const stdout: string[] = [];
         const stderr: string[] = [];
 
         if (debug) {
-            this.snapshot.log(`Running command "helm ${args.join(' ')}"`);
+            this.snapshot.log(`Running command "${binary} ${args.join(' ')}"`);
         }
 
-        const code = await childProcessService.exec('helm', args, this.snapshot.wd, {
+        const code = await childProcessService.exec(binary, args, this.snapshot.wd, {
             stdout: (chunk: any) => {
                 stdout.push(chunk.toString().trim());
             },

src/processors/DeleteActionProcessor.ts

@@ -3,6 +3,9 @@ import { BaseActionProcessor } from './BaseActionProcessor';
 
 export class DeleteActionProcessor extends BaseActionProcessor {
     private static validationSchema = Joi.object({
+        // custom helm v2 binary name or path
+        binary: Joi.string().optional(),
+
         // release name
         release: Joi.string().required(),
 
@@ -37,7 +40,7 @@ export class DeleteActionProcessor extends BaseActionProcessor {
         this.snapshot.log(`Deleting release ${this.options.release}`);
 
         const args = this.prepareCLIArgs();
-        await this.execHelmCommand(args, this.options.debug);
+        await this.execHelmCommand(args, this.options.debug, this.options.binary);
     }
 
     /**

src/processors/TestActionProcessor.ts

@@ -3,6 +3,9 @@ import { BaseActionProcessor } from './BaseActionProcessor';
 
 export class TestActionProcessor extends BaseActionProcessor {
     private static validationSchema = Joi.object({
+        // custom helm v2 binary name or path
+        binary: Joi.string().optional(),
+
         // release name
         release: Joi.string().required(),
 
@@ -37,7 +40,7 @@ export class TestActionProcessor extends BaseActionProcessor {
         this.snapshot.log(`Testing release ${this.options.release}`);
 
         const args = this.prepareCLIArgs();
-        await this.execHelmCommand(args, this.options.debug);
+        await this.execHelmCommand(args, this.options.debug, this.options.binary);
     }
 
     /**

src/processors/UpgradeOrInstallActionProcessor.ts

@@ -12,6 +12,9 @@ const existsAsync = promisify(exists);
 
 export class UpgradeOrInstallActionProcessor extends BaseActionProcessor {
     private static validationSchema = Joi.object({
+        // custom helm v2 binary name or path
+        binary: Joi.string().optional(),
+
         // release name
         release: Joi.string().required(),
 
@@ -66,13 +69,13 @@ export class UpgradeOrInstallActionProcessor extends BaseActionProcessor {
      */
     async execute(): Promise<void> {
         this.snapshot.log(
-            `Ugrading or installing release ${this.options.release} of helm chart ${this.options.chart}@${
+            `Upgrading or installing release ${this.options.release} of helm chart ${this.options.chart}@${
                 this.options.version || 'latest'
             }`,
         );
 
         const args = await this.prepareCLIArgs();
-        await this.execHelmCommand(args, this.options.debug);
+        await this.execHelmCommand(args, this.options.debug, this.options.binary);
     }
 
     /**