feat: helm import

.projenrc.ts

@@ -60,7 +60,6 @@ const project = new Cdk8sTeamTypeScriptProject({
   ],
   backport: true,
   backportBranches: ['1.x'],
-
 });
 
 project.tsconfig?.addInclude('src/schemas/*.json');

src/cli/cmds/import.ts

@@ -1,7 +1,8 @@
 import * as yargs from 'yargs';
 import { readConfigSync, ImportSpec } from '../../config';
-import { PREFIX_DELIM, importDispatch } from '../../import/dispatch';
+import { importDispatch } from '../../import/dispatch';
 import { DEFAULT_API_VERSION } from '../../import/k8s';
+import { parseImports } from '../../util';
 
 const config = readConfigSync();
 
@@ -21,6 +22,7 @@ class Command implements yargs.CommandModule {
     .example('cdk8s import jenkins.io_jenkins_crd.yaml', 'Imports constructs for the Jenkins custom resource definition from a file')
     .example('cdk8s import mattermost:=mattermost_crd.yaml', 'Imports constructs for the mattermost cluster custom resource definition using a custom module name')
     .example('cdk8s import github:crossplane/[email protected]', 'Imports constructs for a GitHub repo using doc.crds.dev')
+    .example('cdk8s import helm:https://charts.bitnami.com/bitnami/[email protected]', 'Imports the specified version of helm chart')
 
     .option('save', { type: 'boolean', required: false, default: true, desc: "Dont save the import URL in the 'imports' section of the cdk8s.yaml configuration file.", alias: 's' })
     .option('output', { default: DEFAULT_OUTDIR, type: 'string', desc: 'Output directory', alias: 'o' })
@@ -42,28 +44,4 @@ class Command implements yargs.CommandModule {
   }
 }
 
-function parseImports(spec: string): ImportSpec {
-  const splitImport = spec.split(PREFIX_DELIM);
-
-  // [email protected]
-  // crd.yaml
-  // url.com/crd.yaml
-  if (splitImport.length === 1) {
-    return {
-      source: spec,
-    };
-  }
-
-  // crd=crd.yaml
-  // crd=url.com/crd.yaml
-  if (splitImport.length === 2) {
-    return {
-      moduleNamePrefix: splitImport[0],
-      source: splitImport[1],
-    };
-  }
-
-  throw new Error('Unable to parse import specification. Syntax is [NAME:=]SPEC');
-}
-
 module.exports = new Command();

src/import/codegen.ts

@@ -85,7 +85,7 @@ export function generateConstruct(typegen: TypeGenerator, def: ApiObjectDefiniti
     // `propsTypeName` could also be "any" if we can't parse the schema for some reason
     const propsTypeName = emitPropsStruct();
     const groupPrefix = def.group ? `${def.group}/` : '';
-    const hasRequired = schema?.required && Array.isArray(schema.required) && schema.required.length > 0;
+    const hasRequired = hasRequiredProps(schema);
     const defaultProps = hasRequired ? '' : ' = {}';
     emitConstruct();
 
@@ -213,3 +213,143 @@ export function generateConstruct(typegen: TypeGenerator, def: ApiObjectDefiniti
     }
   });
 }
+
+/**
+ * Emit imports for generated helm construct
+ * @param code CodeMaker istance
+ */
+export function emitHelmHeader(code: CodeMaker) {
+  code.line('// generated by cdk8s');
+  code.line('import { Helm } from \'cdk8s\';');
+  code.line('import { Construct } from \'constructs\';');
+  code.line();
+}
+
+/**
+ * Helm Object Definition
+ */
+export interface HelmObjectDefinition {
+  /**
+   * `values.schema.json` for the helm chart
+   */
+  readonly schema: JSONSchema4 | undefined;
+  /**
+   * Chart name
+   */
+  readonly chartName: string;
+  /**
+   * Chart url
+   */
+  readonly chartUrl: string;
+  /**
+   * Chart version
+   */
+  readonly chartVersion: string;
+  /**
+   * Chart dependencies
+   */
+  readonly chartDependencies: string[];
+  /**
+   * Fully qualified name for the construct
+   */
+  readonly fqn?: string;
+}
+
+export function generateHelmConstruct(typegen: TypeGenerator, def: HelmObjectDefinition) {
+  const noSpecialChars = def.chartName.replace(/([^\w ]|_)/g, '');
+  const chartName = TypeGenerator.normalizeTypeName(noSpecialChars);
+  const schema = def.schema;
+  const repoUrl = def.chartUrl;
+  const chartVersion = def.chartVersion;
+
+  // Create custom type
+  typegen.emitCustomType(chartName, code => {
+
+    const valuesInterface = `${chartName}Values`;
+    if (schema !== undefined) {
+      // Creating values interface
+      emitValuesInterface();
+
+      function emitValuesInterface() {
+        const copyOfSchema = schema;
+
+        if (copyOfSchema && copyOfSchema.properties) {
+          // Sub charts or dependencies
+          for (const dependency of def.chartDependencies) {
+            copyOfSchema.properties[dependency] = { type: 'object', additionalProperties: { type: 'object' } };
+          }
+
+          copyOfSchema.properties.global = { type: 'object', additionalProperties: { type: 'object' } };
+          copyOfSchema.properties.additionalValues = { type: 'object', additionalProperties: { type: 'object' } };
+        }
+
+        typegen.emitType(valuesInterface, copyOfSchema, def.fqn);
+      }
+    }
+
+    // Creating construct properties
+    emitPropsInterface();
+
+    code.line();
+
+    // Creating construct for helm chart
+    emitConstruct();
+
+    function emitPropsInterface() {
+      code.openBlock(`export interface ${chartName}Props`);
+
+      code.line('readonly namespace?: string;');
+      code.line('readonly releaseName?: string;');
+      code.line('readonly helmExecutable?: string;');
+      code.line('readonly helmFlags?: string[];');
+
+      if (schema === undefined) {
+        code.line('readonly values?: { [key: string]: any };');
+      } else {
+        const doValuesHaveReqProps = hasRequiredProps(schema) ? '' : '?';
+        code.line(`readonly values${doValuesHaveReqProps}: ${valuesInterface};`);
+      }
+
+      code.closeBlock();
+    }
+
+    function emitConstruct() {
+      code.openBlock(`export class ${chartName} extends Construct`);
+
+      emitInitializer();
+
+      code.closeBlock();
+    }
+
+    function emitInitializer() {
+      code.openBlock(`public constructor(scope: Construct, id: string, props: ${chartName}Props = {})`);
+
+      code.line('let updatedProps = undefined;');
+      code.line();
+      code.openBlock('if (props.values && \'additionalValues\' in props.values)');
+      code.line('const { additionalValues, ...withoutAdditionalValues } = props.values;');
+      code.open('updatedProps = {');
+      code.line('...withoutAdditionalValues,');
+      code.line('...additionalValues,');
+      code.close('};');
+      code.closeBlock();
+      code.line();
+
+      code.open('const finalProps = {');
+      code.line(`chart: \'${def.chartName}\',`);
+      code.line(`repo: \'${repoUrl}\',`);
+      code.line(`version: \'${chartVersion}\',`);
+      code.line('values: (updatedProps ?? props),');
+      code.close('};');
+
+      code.line();
+      code.line('super(scope, id)');
+      code.line('new Helm(scope, \'Helm\', finalProps)');
+      code.closeBlock();
+    }
+  });
+}
+
+function hasRequiredProps(schema: JSONSchema4):boolean | undefined {
+  return schema?.required && Array.isArray(schema.required) && schema.required.length > 0;
+}

src/import/dispatch.ts

@@ -1,6 +1,7 @@
 import { ImportBase, ImportOptions } from './base';
 import { ImportCustomResourceDefinition } from './crd';
 import { matchCrdsDevUrl } from './crds-dev';
+import { ImportHelm } from './helm';
 import { ImportKubernetesApi } from './k8s';
 import { ImportSpec, addImportToConfig } from '../config';
 
@@ -36,6 +37,12 @@ async function matchImporter(importSpec: ImportSpec, argv: any): Promise<ImportB
     return new ImportKubernetesApi(k8s);
   }
 
+  const prefix = importSpec.source.split(':')[0];
+
+  if (prefix === 'helm') {
+    return ImportHelm.fromSpec(importSpec);
+  }
+
   // now check if its a crds.dev import
   const crdsDevUrl = matchCrdsDevUrl(importSpec.source);
   if (crdsDevUrl) {