feat(applets): integrate into toolkit

packages/@aws-cdk/applet-js/bin/cdk-applet-js.ts

@@ -26,18 +26,22 @@ async function main() {
   }
 
   // read applet(s) properties from the provided file
-  let fileContents = YAML.safeLoad(await fs.readFile(appletFile, { encoding: 'utf-8' }));
-  if (!Array.isArray(fileContents)) {
-    fileContents = [fileContents];
+  const fileContents = YAML.safeLoad(await fs.readFile(appletFile, { encoding: 'utf-8' }));
+  if (typeof fileContents !== 'object') {
+    throw new Error(`${appletFile}: should contain a YAML object`);
+  }
+  const appletMap = fileContents.Applets;
+  if (!appletMap) {
+    throw new Error(`${appletFile}: must have an 'Applets' key`);
   }
 
   const searchDir = path.dirname(appletFile);
   const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'cdkapplet'));
   try {
-
     const app = new cdk.App();
-    for (const props of fileContents) {
-      await constructStack(app, searchDir, tempDir, props);
+
+    for (const [name, definition] of Object.entries(appletMap)) {
+      await constructStack(app, searchDir, tempDir, name, definition);
     }
     app.run();
   } finally {
@@ -49,19 +53,18 @@ async function main() {
  * Construct a stack from the given props
  * @param props Const
  */
-async function constructStack(app: cdk.App, searchDir: string, tempDir: string, props: any) {
+async function constructStack(app: cdk.App, searchDir: string, tempDir: string, stackName: string, spec: any) {
   // the 'applet' attribute tells us how to load the applet. in the javascript case
   // it will be in the format <module>:<class> where <module> is technically passed to "require"
   // and <class> is expected to be exported from the module.
-  const appletSpec: string = props.applet;
+  const appletSpec: string | undefined = spec.Type;
   if (!appletSpec) {
-    throw new Error('Applet file missing "applet" attribute');
+    throw new Error(`Applet ${stackName} missing "Type" attribute`);
   }
 
   const applet = parseApplet(appletSpec);
 
-  // remove the 'applet' attribute as we pass it along to the applet class.
-  delete props.applet;
+  const props = spec.Properties || {};
 
   if (applet.npmPackage) {
     // tslint:disable-next-line:no-console
@@ -79,8 +82,7 @@ async function constructStack(app: cdk.App, searchDir: string, tempDir: string,
 
   // we need to resolve the module name relatively to where the applet file is
   // and not relative to this module or cwd.
-  const resolve = require.resolve as any; // escape type-checking since { paths } is not defined
-  const modulePath = resolve(applet.moduleName, { paths: [ searchDir ] });
+  const modulePath = require.resolve(applet.moduleName, { paths: [ searchDir ] });
 
   // load the module
   const pkg = require(modulePath);
@@ -92,8 +94,6 @@ async function constructStack(app: cdk.App, searchDir: string, tempDir: string,
     throw new Error(`Cannot find applet class "${applet.className}" in module "${applet.moduleName}"`);
   }
 
-  const stackName = props.name || applet.className;
-
   if (isStackConstructor(appletConstructor)) {
     // add the applet stack into the app.
     new appletConstructor(app, stackName, props);
@@ -102,4 +102,4 @@ async function constructStack(app: cdk.App, searchDir: string, tempDir: string,
     const stack = new cdk.Stack(app, stackName, props);
     new appletConstructor(stack, 'Default', props);
   }
-}
+}

packages/@aws-cdk/applet-js/test/manual-test-npm.yaml

@@ -1 +1,3 @@
-applet: npm://@aws-cdk/aws-ecs:Hello
+Applets:
+  Hello:
+    Type: npm://@aws-cdk/aws-ecs:Hello

packages/@aws-cdk/applet-js/test/negative-test4.yaml

@@ -1,2 +1,4 @@
 # malformed applet specification
-applet: invalid:number:of:components:in:applet:name
+Applets:
+  Applet:
+    Type: invalid:number:of:components:in:applet:name

packages/@aws-cdk/applet-js/test/negative-test5.yaml

@@ -1,2 +1,4 @@
 # applet module not found
-applet: notfound
+Applets:
+  Applet:
+    Type: notfound

packages/@aws-cdk/applet-js/test/negative-test6.yaml

@@ -1,2 +1,4 @@
 # applet class not found
-applet: ./test-applet:ClassNotFound
+Applets:
+  Applet:
+    Type: ./test-applet:ClassNotFound

packages/@aws-cdk/applet-js/test/negative-test7.yaml

@@ -1,2 +1,4 @@
 # no module
-applet: :TestApplet
+Applets:
+  Applet:
+    Type: :TestApplet

packages/@aws-cdk/applet-js/test/test-multistack.yaml

@@ -1,9 +1,11 @@
----
-- applet: ./test-applet:TestApplet
-  name: Stack1
-  prop1: stack1
-  prop2: 123
-- applet: ./test-applet:TestApplet
-  name: Stack2
-  prop1: stack2
-  prop2: 456
+Applets:
+  Stack1:
+    Type: ./test-applet:TestApplet
+    Properties:
+      prop1: stack1
+      prop2: 123
+  Stack2:
+    Type: ./test-applet:TestApplet
+    Properties:
+      prop1: stack2
+      prop2: 456

packages/@aws-cdk/applet-js/test/test-nonstack.yaml

@@ -1,4 +1,6 @@
-#!/usr/bin/env cdk-applet-js
-applet: ./test-applet:NoStackApplet
-argument: this should be reflected in the template description
+Applets:
+  NoStackApplet:
+    Type: ./test-applet:NoStackApplet
+    Properties:
+      argument: this should be reflected in the template description
 

packages/@aws-cdk/applet-js/test/test.applets.ts

@@ -113,60 +113,4 @@ function stripStackMetadata(stack: any) {
   }
   delete stack.environment;
   return stack;
-}
-
-// cdk-applet-js test1.yaml '{ "type": "synth", "stacks": ["TestApplet"] }' | node strip-stacktrace.js > /tmp/actual1.json
-// expect_success diff expected1.json /tmp/actual1.json
-
-// #!/bin/bash
-// set -euo pipefail
-// cd $(dirname $0)
-// export PATH=../bin:$PATH
-
-// announce() {
-//   echo "-------------------------------------------------"
-//   echo "$@"
-// }
-
-// expect_success() {
-//   announce $@
-//   set +e
-//   $@
-//   local exit_code=$?
-//   set -e
-
-//   if [ "${exit_code}" -ne 0 ]; then
-//     echo "Command expected to succeed: $@"
-//     exit 1
-//   fi
-// }
-
-// expect_failure() {
-//   announce $@
-//   set +e
-//   $@
-//   local exit_code=$?
-//   set -e
-//   if [ "${exit_code}" -eq 0 ]; then
-//     echo "Command expected to fail: $@"
-//     exit 1
-//   fi
-// }
-
-// cdk-applet-js test1.yaml '{ "type": "synth", "stacks": ["TestApplet"] }' | node strip-stacktrace.js > /tmp/actual1.json
-// expect_success diff expected1.json /tmp/actual1.json
-
-// cdk-applet-js test2.yaml '{ "type": "synth", "stacks": ["TestApplet"] }' | node strip-stacktrace.js > /tmp/actual2.json
-// expect_success diff expected2.json /tmp/actual2.json
-
-// # applets can use the host as shebang
-// chmod +x ./test3.yaml # since codebuild loses permissions
-// ./test3.yaml '{ "type": "synth", "stacks": ["Applet"] }' | node strip-stacktrace.js > /tmp/actual3.json
-// expect_success diff expected3.json /tmp/actual3.json
-
-// expect_failure cdk-applet-js negative-test4.yaml
-// expect_failure cdk-applet-js negative-test5.yaml
-// expect_failure cdk-applet-js negative-test6.yaml
-// expect_failure cdk-applet-js negative-test7.yaml
-
-// echo "PASS"
+}

packages/@aws-cdk/applet-js/test/test1.yaml

@@ -1,4 +1,7 @@
 # applet is loaded from the local ./test-applet.js file
-applet: ./test-applet:TestApplet
-prop1: hello
-prop2: 123
+Applets:
+  TestApplet:
+    Type: ./test-applet:TestApplet
+    Properties:
+      prop1: hello
+      prop2: 123

packages/@aws-cdk/applet-js/test/test2.yaml

@@ -1,10 +1,13 @@
 # applet is loaded from the local ./test-applet.js file
-applet: ./test-applet:TestApplet
-prop1: hello
-prop2: 123
-prop3:
-  - hello
-  - this
-  - is
-  - awesome
-  - 12345
+Applets:
+  TestApplet:
+    Type: ./test-applet:TestApplet
+    Properties:
+      prop1: hello
+      prop2: 123
+      prop3:
+        - hello
+        - this
+        - is
+        - awesome
+        - 12345

packages/@aws-cdk/applet-js/test/test3.yaml

@@ -1,5 +1,6 @@
 #!/usr/bin/env cdk-applet-js
-
-# if class name is not specified, 'Applet' is assumed
-applet: ./test-applet
-desc: this should be reflected in the template description
+Applets:
+  Applet:
+    Type: ./test-applet
+    Properties:
+      desc: this should be reflected in the template description

packages/aws-cdk/lib/exec.ts

@@ -141,14 +141,53 @@ function appToArray(app: any) {
   return typeof app === 'string' ? app.split(' ') : app;
 }
 
+type CommandGenerator = (file: string) => string[];
+
+/**
+ * Direct execution of a YAML file, assume that we're deploying an Applet
+ */
+function executeApplet(appletFile: string): string[] {
+    const appletBinary = path.resolve(require.resolve('@aws-cdk/applet-js'));
+    return [process.execPath, appletBinary, appletFile];
+}
+
+/**
+ * Execute the given file with the same 'node' process as is running the current process
+ */
+function executeNode(scriptFile: string): string[] {
+    return [process.execPath, scriptFile];
+}
+
+/**
+ * Mapping of extensions to command-line generators
+ */
+const EXTENSION_MAP = new Map<string, CommandGenerator>([
+  ['.yml', executeApplet],
+  ['.yaml', executeApplet],
+  ['.js', executeNode],
+]);
+
 /**
  * Guess the executable from the command-line argument
+ *
+ * Only do this if the file is NOT marked as executable. If it is,
+ * we'll defer to the shebang inside the file itself.
+ *
+ * If we're on Windows, we ALWAYS take the handler, since it's hard to
+ * verify if registry associations have or have not been set up for this
+ * file type, so we'll assume the worst and take control.
  */
 async function guessExecutable(commandLine: string[]) {
-  if (commandLine.length === 1 && ['.yml', '.yaml'].includes(path.extname(commandLine[0]))) {
-    // Direct execution of a YAML file, assume that we're deploying an Applet
-    const appletBinary = path.resolve(require.resolve('@aws-cdk/applet-js'));
-    return [process.execPath, appletBinary, commandLine[0]];
+  if (commandLine.length === 1) {
+    const fstat = await fs.stat(commandLine[0]);
+    // tslint:disable-next-line:no-bitwise
+    const isExecutable = (fstat.mode & fs.constants.X_OK) !== 0;
+    const isWindows = process.platform === "win32";
+
+    const handler = EXTENSION_MAP.get(path.extname(commandLine[0]));
+    if (handler && (!isExecutable || isWindows)) {
+      return handler(commandLine[0]);
+    }
   }
   return commandLine;
 }