chore: update cdk migrate command to allow for stack name input and a…

…dditional languages

This change updates use of noctilucent to cdk-from-cfn and installs it from npm. It also adds some additional language support and stack renaming.

packages/@aws-cdk/cli-lib-alpha/package.json

@@ -52,7 +52,7 @@
     "build+test+package": "yarn build+test && yarn package",
     "bundle": "esbuild --bundle lib/index.ts --target=node14 --platform=node --external:fsevents --minify-whitespace --outfile=lib/main.js",
     "compat": "cdk-compat",
-    "gen": "./generate.sh",
+    "gen": "../../../packages/aws-cdk/generate.sh",
     "lint": "cdk-lint",
     "package": "cdk-package",
     "pkglint": "pkglint -f",
@@ -68,7 +68,6 @@
   "cdk-build": {
     "post": [
       "yarn attribute",
-      "cp ../../aws-cdk/lib/vendor/noctilucent/index_bg.wasm ./lib/",
       "mkdir -p ./lib/api/bootstrap/ && cp ../../aws-cdk/lib/api/bootstrap/bootstrap-template.yaml ./lib/api/bootstrap/",
       "yarn bundle",
       "node ./lib/main.js >/dev/null 2>/dev/null </dev/null"
@@ -126,4 +125,4 @@
   },
   "dependencies": {},
   "peerDependencies": {}
-}
+}

packages/aws-cdk/.eslintrc.js

@@ -1,6 +1,5 @@
 const baseConfig = require('@aws-cdk/cdk-build-tools/config/eslintrc');
 baseConfig.ignorePatterns.push('lib/init-templates/**/typescript/**/*.ts');
 baseConfig.ignorePatterns.push('test/integ/cli/sam_cdk_integ_app/**/*.ts');
-baseConfig.ignorePatterns.push('vendor/noctilucent/**/*.ts');
 baseConfig.parserOptions.project = __dirname + '/tsconfig.json';
 module.exports = baseConfig;

packages/aws-cdk/.gitignore

@@ -36,10 +36,6 @@ test/integ/cli/*.js
 test/integ/cli/*.d.ts
 !test/integ/cli-regression-patches/**/*
 
-lib/vendor/noctilucent/*
-!lib/vendor/noctilucent/.keepdir
-
 .DS_Store
 
 junit.xml
-tmp/

packages/aws-cdk/.npmignore

@@ -30,5 +30,3 @@ tsconfig.json
 junit.xml
 
 generate.sh
-lib/vendor/noctilucent/Dockerfile
-tmp/

packages/aws-cdk/THIRD_PARTY_LICENSES

@@ -459,6 +459,10 @@ The above copyright notice and this permission notice shall be included in all c
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 
+----------------
+
+** [email protected] - https://www.npmjs.com/package/cdk-from-cfn/v/0.11.0 | MIT OR Apache-2.0
+
 ----------------
 
 ** [email protected] - https://www.npmjs.com/package/chalk/v/4.1.2 | MIT

packages/aws-cdk/generate.sh

@@ -14,19 +14,3 @@ cat > build-info.json <<HERE
   "commit": "${commit:0:7}"
 }
 HERE
-
-# Download noctilucent wasm-pack build
-NOCTILUCENT_VERSION=0.1.2
-PACK_URL=https://github.com/iph/noctilucent/releases/download/v${NOCTILUCENT_VERSION}/wasm-pack.zip
-zipfile=$PWD/tmp/noctilucent-wasm-${NOCTILUCENT_VERSION}.zip
-outdir=lib/vendor/noctilucent
-
-mkdir -p tmp
-if [[ ! -f "$zipfile" ]]; then
-    curl -sSfLo "$zipfile" "$PACK_URL"
-fi
-
-(cd $outdir && unzip -qo $zipfile)
-
-# Don't need these files
-rm -f $outdir/{.gitignore,README.md,package.json}

packages/aws-cdk/lib/cli.ts

@@ -272,10 +272,10 @@ async function parseCommandLineArguments(args: string[]) {
       .option('generate-only', { type: 'boolean', default: false, desc: 'If true, only generates project files, without executing additional operations such as setting up a git repo, installing dependencies or compiling the project' }),
     )
     .command('migrate', false /* hidden from "cdk --help" */, (yargs: Argv) => yargs
-      .option('language', { type: 'string', alias: 'l', desc: 'The language to be used for the new project (default can be configured in ~/.cdk.json)', choices: MIGRATE_SUPPORTED_LANGUAGES })
-      .option('input-path', { type: 'string', alias: 'inputpath', desc: 'The path to the CloudFormation template to migrate' })
-      .option('output-path', { type: 'string', alias: 'outputpath', desc: 'The output path for the migrated cdk code' })
-      .option('generate-only', { type: 'boolean', default: false, desc: 'If true, only generates project files, without executing additional operations such as setting up a git repo, installing dependencies or compiling the project' }),
+      .option('stack-name', { type: 'string', alias: 'n', desc: 'The name assigned to the stack created in the new project. The name of the app will be based off this name as well.', requiresArg: true })
+      .option('language', { type: 'string', default: 'typescript', alias: 'l', desc: 'The language to be used for the new project', choices: MIGRATE_SUPPORTED_LANGUAGES })
+      .option('from-path', { type: 'string', alias: 'p', desc: 'The path to the CloudFormation template to migrate. Use this for locally stored templates' })
+      .option('output-path', { type: 'string', alias: 'o', desc: 'The output path for the migrated cdk app' }),
     )
     .command('context', 'Manage cached context values', (yargs: Argv) => yargs
       .option('reset', { alias: 'e', desc: 'The context key (or its index) to reset', type: 'string', requiresArg: true })
@@ -659,8 +659,12 @@ export async function exec(args: string[], synthesizer?: Synthesizer): Promise<n
           return cliInit(args.TEMPLATE, language, undefined, args.generateOnly);
         }
       case 'migrate':
-        const migrateLanguage = configuration.settings.get(['language']);
-        return cliMigrate(args.inputpath, migrateLanguage, args.generateOnly, args.outputpath);
+        return cliMigrate({
+          stackName: args['stack-name'],
+          fromPath: args['from-path'],
+          language: args.language,
+          outputPath: args['output-path'],
+        });
       case 'version':
         return data(version.DISPLAY_VERSION);
 

packages/aws-cdk/lib/commands/migrate.ts

@@ -1,71 +1,78 @@
 import * as fs from 'fs';
 import * as path from 'path';
-import { initializeProject, availableInitTemplates } from '../../lib/init';
+import * as cdk_from_cfn from 'cdk-from-cfn';
+import { cliInit } from '../../lib/init';
 import { warning } from '../logging';
-import * as nocti from '../vendor/noctilucent';
+
+/* eslint-disable @typescript-eslint/no-var-requires */ // Packages don't have @types module
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const camelCase = require('camelcase');
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const decamelize = require('decamelize');
 
 /** The list of languages supported by the built-in noctilucent binary. */
-export const MIGRATE_SUPPORTED_LANGUAGES: readonly string[] = nocti.supported_languages();
+export const MIGRATE_SUPPORTED_LANGUAGES: readonly string[] = cdk_from_cfn.supported_languages();
 
-export async function cliMigrate(
-  inputpath: string = process.cwd() + '/../template.txt',
-  language = MIGRATE_SUPPORTED_LANGUAGES[0],
-  generateOnly = false,
-  outputpath = process.cwd(),
-) {
-  warning('This is an experimental feature. We make no guarantees about the outcome or stability of the functionality.');
-  const type = 'default'; // "default" is the default type (and maps to 'app')
-  const template = (await availableInitTemplates()).find(t => t.hasName(type!));
-  if (!template) {
-    throw new Error(`couldn't find template for ${type} app type, this should never happen`);
-  }
+export interface CliMigrateOptions {
+  readonly stackName: string;
+  readonly language?: string;
+  readonly fromPath?: string;
+  readonly outputPath?: string;
+}
 
-  if (!MIGRATE_SUPPORTED_LANGUAGES.includes(language)) {
-    throw new Error(`Unsupported language for cdk migrate: ${language}. Supported languages are: ${MIGRATE_SUPPORTED_LANGUAGES.join(', ')}`);
-  }
+export async function cliMigrate(options: CliMigrateOptions) {
+  warning('This is an experimental feature. We make no guarantees about the outcome or stability of the functionality.');
 
-  await initializeProject(template, language, true, generateOnly, outputpath);
-  const template_file = fs.readFileSync(inputpath, 'utf8');
-  const generated_app = nocti.transmute(template_file, language);
+  // TODO: Validate stack name
 
-  // clear out the init'd bin/lib files to replace with our own
-  delete_files(outputpath + '/lib/');
+  const language = options.language ?? 'typescript';
+  const outputPath = path.join(options.outputPath ?? process.cwd(), options.stackName);
 
-  // we hardcode everything to be called noctstack still so this works for now.
-  // Will change this to be much smarter once we can change stack name in noct
-  const bin_app = `#!/usr/bin/env node
-  import 'source-map-support/register';
-  import * as cdk from 'aws-cdk-lib';
-  import { NoctStack } from '../lib/generated_stack';
+  const generatedStack = generateStack(options, language);
+  const stackName = decamelize(options.stackName);
 
-  const app = new cdk.App();
-  new NoctStack(app, 'NoctStack', {
-    /* If you don't specify 'env', this stack will be environment-agnostic.
-     * Account/Region-dependent features and context lookups will not work,
-     * but a single synthesized template can be deployed anywhere. */
+  try {
+    fs.rmSync(outputPath, { recursive: true, force: true });
+    fs.mkdirSync(outputPath, { recursive: true });
+    await cliInit('app', language, true, false, outputPath, options.stackName);
 
-    /* Uncomment the next line to specialize this stack for the AWS Account
-     * and Region that are implied by the current CLI configuration. */
-    // env: { account: process.env.CDK_DEFAULT_ACCOUNT, region: process.env.CDK_DEFAULT_REGION },
+    let stackFileName: string;
+    switch (language) {
+      case 'typescript':
+        stackFileName = `${outputPath}/lib/${stackName}-stack.ts`;
+        break;
+      case 'java':
+        stackFileName = `${outputPath}/src/main/java/com/myorg/${camelCase(stackName, { pascalCase: true })}Stack.java`;
+        break;
+      case 'python':
+        stackFileName = `${outputPath}/${stackName.replace(/-/g, '_')}/${stackName.replace(/-/g, '_')}_stack.py`;
+        break;
+      case 'csharp':
+        stackFileName = `${outputPath}/src/${camelCase(stackName, { pascalCase: true })}/${camelCase(stackName, { pascalCase: true })}Stack.cs`;
+        break;
+      // TODO: Add Go support
+      default:
+        throw new Error(`${language} is not supported by CDK Migrate. Please choose from: ${MIGRATE_SUPPORTED_LANGUAGES.join(', ')}`);
+    }
+    fs.writeFileSync(stackFileName!, generatedStack);
+  } catch (error) {
+    fs.rmSync(outputPath, { recursive: true, force: true });
+    throw error;
+  }
 
-    /* Uncomment the next line if you know exactly what Account and Region you
-     * want to deploy the stack to. */
-    // env: { account: '123456789012', region: 'us-east-1' },
+}
 
-    /* For more information, see https://docs.aws.amazon.com/cdk/latest/guide/environments.html */
-  });`;
-  const myname = path.basename(outputpath);
-  fs.writeFileSync(outputpath + '/lib/' + 'generated_stack.ts', generated_app);
-  fs.writeFileSync(outputpath + '/bin/' + `${myname}.ts`, bin_app);
+function generateStack(options: CliMigrateOptions, language: string) {
+  const stackName = `${camelCase(decamelize(options.stackName), { pascalCase: true })}Stack`;
+  // We will add other options here in a future change.
+  if (options.fromPath) {
+    return fromPath(stackName, options.fromPath, language);
+  }
+  // TODO: replace with actual output for other options.
+  return '';
 }
 
-function delete_files(filepath: string) {
-  fs.readdir(filepath, (err, files) => {
-    if (err) throw err;
-    for (const file of files) {
-      fs.unlink(filepath + file, (cause) => {
-        if (cause) throw cause;
-      });
-    }
-  });
+function fromPath(stackName: string, inputPath: string, language: string): string {
+  const templateFile = fs.readFileSync(inputPath, 'utf8');
+  return cdk_from_cfn.transmute(templateFile, language, stackName);
 }

packages/aws-cdk/lib/init-templates/app/csharp/src/%name.PascalCased%/Program.template.cs

@@ -10,7 +10,7 @@ sealed class Program
         public static void Main(string[] args)
         {
             var app = new App();
-            new %name.PascalCased%Stack(app, "%name.PascalCased%Stack", new StackProps
+            new %name.PascalCased%Stack(app, "%stackname%", new StackProps
             {
                 // If you don't specify 'env', this stack will be environment-agnostic.
                 // Account/Region-dependent features and context lookups will not work,

packages/aws-cdk/lib/init-templates/app/fsharp/src/%name.PascalCased%/Program.template.fs

@@ -5,7 +5,7 @@ open %name.PascalCased%
 let main _ =
     let app = App(null)
 
-    %name.PascalCased%Stack(app, "%name.PascalCased%Stack", StackProps()) |> ignore
+    %name.PascalCased%Stack(app, "%stackname%", StackProps()) |> ignore
 
     app.Synth() |> ignore
     0

packages/aws-cdk/lib/init-templates/app/go/%name%.template.go

@@ -33,7 +33,7 @@ func main() {
 
 	app := awscdk.NewApp(nil)
 
-	New%name.PascalCased%Stack(app, "%name.PascalCased%Stack", &%name.PascalCased%StackProps{
+	New%name.PascalCased%Stack(app, "%stackname%", &%name.PascalCased%StackProps{
 		awscdk.StackProps{
 			Env: env(),
 		},

packages/aws-cdk/lib/init-templates/app/java/src/main/java/com/myorg/%name.PascalCased%App.template.java

@@ -10,7 +10,7 @@ public class %name.PascalCased%App {
     public static void main(final String[] args) {
         App app = new App();
 
-        new %name.PascalCased%Stack(app, "%name.PascalCased%Stack", StackProps.builder()
+        new %name.PascalCased%Stack(app, "%stackname%", StackProps.builder()
                 // If you don't specify 'env', this stack will be environment-agnostic.
                 // Account/Region-dependent features and context lookups will not work,
                 // but a single synthesized template can be deployed anywhere.

packages/aws-cdk/lib/init-templates/app/javascript/bin/%name%.template.js

@@ -4,7 +4,7 @@ const cdk = require('aws-cdk-lib');
 const { %name.PascalCased%Stack } = require('../lib/%name%-stack');
 
 const app = new cdk.App();
-new %name.PascalCased%Stack(app, '%name.PascalCased%Stack', {
+new %name.PascalCased%Stack(app, '%stackname%', {
   /* If you don't specify 'env', this stack will be environment-agnostic.
    * Account/Region-dependent features and context lookups will not work,
    * but a single synthesized template can be deployed anywhere. */

packages/aws-cdk/lib/init-templates/app/python/app.template.py

@@ -7,7 +7,7 @@
 
 
 app = cdk.App()
-%name.PascalCased%Stack(app, "%name.PascalCased%Stack",
+%name.PascalCased%Stack(app, "%stackname%",
     # If you don't specify 'env', this stack will be environment-agnostic.
     # Account/Region-dependent features and context lookups will not work,
     # but a single synthesized template can be deployed anywhere.

packages/aws-cdk/lib/init-templates/app/typescript/bin/%name%.template.ts

@@ -4,7 +4,7 @@ import * as cdk from 'aws-cdk-lib';
 import { %name.PascalCased%Stack } from '../lib/%name%-stack';
 
 const app = new cdk.App();
-new %name.PascalCased%Stack(app, '%name.PascalCased%Stack', {
+new %name.PascalCased%Stack(app, '%stackname%', {
   /* If you don't specify 'env', this stack will be environment-agnostic.
    * Account/Region-dependent features and context lookups will not work,
    * but a single synthesized template can be deployed anywhere. */

packages/aws-cdk/lib/init-templates/sample-app/csharp/src/%name.PascalCased%/Program.template.cs

@@ -7,7 +7,7 @@ sealed class Program
         public static void Main(string[] args)
         {
             var app = new App();
-            new %name.PascalCased%Stack(app, "%name.PascalCased%Stack");
+            new %name.PascalCased%Stack(app, "%stackname%");
 
             app.Synth();
         }

packages/aws-cdk/lib/init-templates/sample-app/fsharp/src/%name.PascalCased%/Program.template.fs

@@ -5,7 +5,7 @@ open %name.PascalCased%
 let main _ =
     let app = App(null)
 
-    %name.PascalCased%Stack(app, "%name.PascalCased%Stack", StackProps()) |> ignore
+    %name.PascalCased%Stack(app, "%stackname%", StackProps()) |> ignore
 
     app.Synth() |> ignore
     0

packages/aws-cdk/lib/init-templates/sample-app/go/%name%.template.go

@@ -36,7 +36,7 @@ func main() {
 
 	app := awscdk.NewApp(nil)
 
-	New%name.PascalCased%Stack(app, "%name.PascalCased%Stack", &%name.PascalCased%StackProps{
+	New%name.PascalCased%Stack(app, "%stackname", &%name.PascalCased%StackProps{
 		awscdk.StackProps{
 			Env: env(),
 		},

packages/aws-cdk/lib/init-templates/sample-app/java/src/main/java/com/myorg/%name.PascalCased%App.template.java

@@ -6,7 +6,7 @@ public final class %name.PascalCased%App {
     public static void main(final String[] args) {
         App app = new App();
 
-        new %name.PascalCased%Stack(app, "%name.PascalCased%Stack");
+        new %name.PascalCased%Stack(app, "%stackname%");
 
         app.synth();
     }

packages/aws-cdk/lib/init-templates/sample-app/javascript/bin/%name%.template.js

@@ -3,4 +3,4 @@ const cdk = require('aws-cdk-lib');
 const { %name.PascalCased%Stack } = require('../lib/%name%-stack');
 
 const app = new cdk.App();
-new %name.PascalCased%Stack(app, '%name.PascalCased%Stack');
+new %name.PascalCased%Stack(app, '%stackname%');

packages/aws-cdk/lib/init-templates/sample-app/python/app.template.py

@@ -6,6 +6,6 @@
 
 
 app = cdk.App()
-%name.PascalCased%Stack(app, "%name.StackName%")
+%name.PascalCased%Stack(app, "%stackname%")
 
 app.synth()

packages/aws-cdk/lib/init-templates/sample-app/typescript/bin/%name%.template.ts

@@ -3,4 +3,4 @@ import * as cdk from 'aws-cdk-lib';
 import { %name.PascalCased%Stack } from '../lib/%name%-stack';
 
 const app = new cdk.App();
-new %name.PascalCased%Stack(app, '%name.PascalCased%Stack');
+new %name.PascalCased%Stack(app, '%stackname%');