refactor(core): misc cleanups to App-related APIs (#2731)

Fixes #1891

Testing: all toolkit integration tests passed.

BREAKING CHANGE:

* **cli:** This release requires CDK CLI >= 0.34.0
* **core:** `App.run()` was renamed to `App.synth()` (soft deprecation, it will be removed in the next release).
* **core:** The `Stack.autoDeploy` feature has been removed. You can use `cdk deploy STACK ...` to determine which stacks to deploy (and wildcards are supported, so `cdk deploy '*'` will deploy all stacks. We plan to change the CLI to require specifying stacks if there is more than a single stack in the app (#2750).
* **core:** `ConstructNode.aspects` is now private.
* **core:** The `Synthesizer` has been removed. Use `ConstructNode.synth(node)` instead.
* **core:** `ISynthesizable.synthesize` now accepts an `ISynthesisSession` which contains the `CloudAssemblyBuilder` object. This will allow further extension in the future.
* **cx-api:** `cxapi.MissingContext` now includes the context `key`
* **core:** `Stack.reportMissingContext` now accepts a single argument of type `cxapi.MissingContext`, which includes the missing context key
* **core:** `Stack.annotatePhysicalName` has been removed (not used).
* **core:** `Stack.missingContext` is now private.
* **cx-api:** Multiple changes to the cloud assembly APIs to reduce surface area and clean up.
* **cdk-integ (private):** if an integration test includes multiple stacks, use `/// !cdk-integ STACK ...`  to explicitly specify which stacks to include in the test.

Author: Elad Ben-Israel

packages/@aws-cdk/app-delivery/test/integ.cicd.ts

@@ -38,4 +38,4 @@ new cicd.PipelineDeployStackAction(stack, 'DeployStack', {
   capabilities: cfn.CloudFormationCapabilities.None,
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/assert/lib/inspector.ts

@@ -54,9 +54,10 @@ export class StackPathInspector extends Inspector {
     // The names of paths in metadata in tests are very ill-defined. Try with the full path first,
     // then try with the stack name preprended for backwards compat with most tests that happen to give
     // their stack an ID that's the same as the stack name.
-    const md = this.stack.metadata[this.path] || this.stack.metadata[`/${this.stack.name}${this.path}`];
+    const metadata = this.stack.manifest.metadata || {};
+    const md = metadata[this.path] || metadata[`/${this.stack.name}${this.path}`];
     if (md === undefined) { return undefined; }
-    const resourceMd = md.find(entry => entry.type === 'aws:cdk:logicalId');
+    const resourceMd = md.find(entry => entry.type === api.LOGICAL_ID_METADATA_KEY);
     if (resourceMd === undefined) { return undefined; }
     const logicalId = resourceMd.data;
     return this.stack.template.Resources[logicalId];

packages/@aws-cdk/assert/lib/synth-utils.ts

@@ -1,4 +1,4 @@
-import { Stack, SynthesisOptions, Synthesizer } from '@aws-cdk/cdk';
+import { ConstructNode, Stack, SynthesisOptions } from '@aws-cdk/cdk';
 import cxapi = require('@aws-cdk/cx-api');
 
 export class SynthUtils {
@@ -7,8 +7,8 @@ export class SynthUtils {
    */
   public static synthesize(stack: Stack, options: SynthesisOptions = { }): cxapi.CloudFormationStackArtifact {
     // always synthesize against the root (be it an App or whatever) so all artifacts will be included
-    const synth = new Synthesizer();
-    const assembly = synth.synthesize(stack.node.root, options);
+    const root = stack.node.root;
+    const assembly = ConstructNode.synth(root.node, options);
     return assembly.getStack(stack.name);
   }
 

packages/@aws-cdk/assert/test/test.assertions.ts

@@ -209,7 +209,7 @@ function synthesizedStack(fn: (stack: cdk.Stack) => void): cx.CloudFormationStac
   const stack = new cdk.Stack(app, 'TestStack');
   fn(stack);
 
-  const assembly = app.run();
+  const assembly = app.synth();
   return assembly.getStack(stack.name);
 }
 

packages/@aws-cdk/assets-docker/test/integ.assets-docker.ts

@@ -12,4 +12,4 @@ const asset = new assets.DockerImageAsset(stack, 'DockerImage', {
 new cdk.CfnOutput(stack, 'ArtifactHash', { value: asset.artifactHash });
 new cdk.CfnOutput(stack, 'ImageUri', { value: asset.imageUri });
 
-app.run();
+app.synth();

packages/@aws-cdk/assets-docker/test/test.image-asset.ts

@@ -172,7 +172,7 @@ export = {
       directory: path.join(__dirname, 'demo-image')
     });
 
-    const session = app.run();
+    const session = app.synth();
 
     test.ok(fs.existsSync(path.join(session.directory, 'asset.1a17a141505ac69144931fe263d130f4612251caa4bbbdaf68a44ed0f405439c/Dockerfile')));
     test.ok(fs.existsSync(path.join(session.directory, 'asset.1a17a141505ac69144931fe263d130f4612251caa4bbbdaf68a44ed0f405439c/index.py')));

packages/@aws-cdk/assets/lib/staging.ts

@@ -1,4 +1,4 @@
-import { Construct } from '@aws-cdk/cdk';
+import { Construct, ISynthesisSession } from '@aws-cdk/cdk';
 import cxapi = require('@aws-cdk/cx-api');
 import fs = require('fs');
 import path = require('path');
@@ -66,12 +66,12 @@ export class Staging extends Construct {
     }
   }
 
-  protected synthesize(session: cxapi.CloudAssemblyBuilder) {
+  protected synthesize(session: ISynthesisSession) {
     if (!this.relativePath) {
       return;
     }
 
-    const targetPath = path.join(session.outdir, this.relativePath);
+    const targetPath = path.join(session.assembly.outdir, this.relativePath);
 
     // asset already staged
     if (fs.existsSync(targetPath)) {

packages/@aws-cdk/assets/test/integ.assets.directory.lit.ts

@@ -20,4 +20,4 @@ class TestStack extends cdk.Stack {
 
 const app = new cdk.App();
 new TestStack(app, 'aws-cdk-asset-test');
-app.run();
+app.synth();

packages/@aws-cdk/assets/test/integ.assets.file.lit.ts

@@ -20,4 +20,4 @@ class TestStack extends cdk.Stack {
 
 const app = new cdk.App();
 new TestStack(app, 'aws-cdk-asset-file-test');
-app.run();
+app.synth();

packages/@aws-cdk/assets/test/integ.assets.permissions.lit.ts

@@ -20,4 +20,4 @@ class TestStack extends cdk.Stack {
 
 const app = new cdk.App();
 new TestStack(app, 'aws-cdk-asset-refs');
-app.run();
+app.synth();

packages/@aws-cdk/assets/test/integ.assets.refs.lit.ts

@@ -24,4 +24,4 @@ class TestStack extends cdk.Stack {
 
 const app = new cdk.App();
 new TestStack(app, 'aws-cdk-asset-refs');
-app.run();
+app.synth();

packages/@aws-cdk/assets/test/integ.multi-assets.ts

@@ -24,4 +24,4 @@ class TestStack extends cdk.Stack {
 
 const app = new cdk.App();
 new TestStack(app, 'aws-cdk-multi-assets');
-app.run();
+app.synth();

packages/@aws-cdk/assets/test/test.asset.ts

@@ -29,7 +29,7 @@ export = {
     test.ok(entry, 'found metadata entry');
 
     // verify that now the template contains parameters for this asset
-    const session = app.run();
+    const session = app.synth();
 
     test.deepEqual(stack.node.resolve(entry!.data), {
       path: SAMPLE_ASSET_DIR,
@@ -57,8 +57,11 @@ export = {
       path: dirPath
     });
 
-    const synth = app.run().getStack(stack.name);
-    test.deepEqual(synth.metadata['/my-stack/MyAsset'][0].data, {
+    const synth = app.synth().getStack(stack.name);
+    const meta = synth.manifest.metadata || {};
+    test.ok(meta['/my-stack/MyAsset']);
+    test.ok(meta['/my-stack/MyAsset'][0]);
+    test.deepEqual(meta['/my-stack/MyAsset'][0].data, {
       path: 'asset.6b84b87243a4a01c592d78e1fd3855c4bfef39328cd0a450cc97e81717fea2a2',
       id: "mystackMyAssetD6B1B593",
       packaging: "zip",
@@ -248,7 +251,7 @@ export = {
       });
 
       // THEN
-      app.run();
+      app.synth();
       test.ok(fs.existsSync(tempdir));
       test.ok(fs.existsSync(path.join(tempdir, 'asset.a7a79cdf84b802ea8b198059ff899cffc095a1b9606e919f98e05bf80779756b.zip')));
       test.done();
@@ -268,7 +271,7 @@ export = {
       });
 
       // THEN
-      app.run();
+      app.synth();
       test.ok(fs.existsSync(tempdir));
       const hash = 'asset.6b84b87243a4a01c592d78e1fd3855c4bfef39328cd0a450cc97e81717fea2a2';
       test.ok(fs.existsSync(path.join(tempdir, hash, 'sample-asset-file.txt')));
@@ -340,10 +343,10 @@ export = {
       new ZipDirectoryAsset(stack, 'MyAsset', { path: SAMPLE_ASSET_DIR });
 
       // WHEN
-      const session = app.run();
+      const session = app.synth();
       const artifact = session.getStack(stack.name);
-
-      const md = Object.values(artifact.metadata)[0][0].data;
+      const metadata = artifact.manifest.metadata || {};
+      const md = Object.values(metadata)[0]![0]!.data;
       test.deepEqual(md.path, 'asset.6b84b87243a4a01c592d78e1fd3855c4bfef39328cd0a450cc97e81717fea2a2');
       test.done();
     }

packages/@aws-cdk/aws-apigateway/test/integ.restapi.books.ts

@@ -69,4 +69,4 @@ function helloCode(_event: any, _context: any, callback: any) {
   });
 }
 
-new BookApp().run();
+new BookApp().synth();

packages/@aws-cdk/aws-apigateway/test/integ.restapi.defaults.ts

@@ -10,4 +10,4 @@ const api = new apigateway.RestApi(stack, 'my-api');
 // at least one method is required
 api.root.addMethod('GET');
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-apigateway/test/integ.restapi.ts

@@ -82,4 +82,4 @@ const app = new cdk.App();
 
 new Test(app, 'test-apigateway-restapi');
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-apigateway/test/test.restapi.ts

@@ -131,7 +131,7 @@ export = {
     api.root.addResource('bar').addResource('goo');
 
     // THEN
-    test.throws(() => app.run(), /The REST API doesn't contain any methods/);
+    test.throws(() => app.synth(), /The REST API doesn't contain any methods/);
     test.done();
   },
 

packages/@aws-cdk/aws-autoscaling/test/integ.amazonlinux2.ts

@@ -16,4 +16,4 @@ new autoscaling.AutoScalingGroup(stack, 'Fleet', {
   machineImage: new ec2.AmazonLinuxImage({ generation: ec2.AmazonLinuxGeneration.AmazonLinux2 }),
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-autoscaling/test/integ.asg-w-classic-loadbalancer.ts

@@ -28,4 +28,4 @@ const lb = new elb.LoadBalancer(stack, 'LB', {
 lb.addTarget(asg);
 lb.addListener({ externalPort: 80 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-autoscaling/test/integ.asg-w-elbv2.ts

@@ -37,4 +37,4 @@ asg.scaleOnRequestCount('AModestLoad', {
   targetRequestsPerSecond: 1
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-autoscaling/test/integ.custom-scaling.ts

@@ -30,4 +30,4 @@ asg.scaleOnCpuUtilization('KeepCPUReasonable', {
   targetUtilizationPercent: 50
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-autoscaling/test/integ.external-role.ts

@@ -25,4 +25,4 @@ const app = new cdk.App();
 
 new TestStack(app, 'integ-iam-external-role');
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-autoscaling/test/integ.spot-instances.ts

@@ -17,4 +17,4 @@ new autoscaling.AutoScalingGroup(stack, 'Fleet', {
   spotPrice: '0.20'
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-cloudformation/test/integ.aws-custom-resource.ts

@@ -45,4 +45,4 @@ new cdk.CfnOutput(stack, 'MessageId', { value: snsPublish.getData('MessageId') }
 new cdk.CfnOutput(stack, 'TopicArn', { value: listTopics.getData('Topics.0.TopicArn') });
 new cdk.CfnOutput(stack, 'ParameterValue', { value: getParameter.getData('Parameter.Value') });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-cloudformation/test/integ.trivial-lambda-resource.ts

@@ -59,4 +59,4 @@ const app = new cdk.App();
 
 new SucceedingStack(app, 'SucceedingStack');
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-cloudfront/test/integ.cloudfront-bucket-logging.ts

@@ -52,4 +52,4 @@ new cloudfront.CloudFrontWebDistribution(stack, 'AnAmazingWebsiteProbably2', {
   loggingConfig: {}
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-cloudfront/test/integ.cloudfront-custom.ts

@@ -24,4 +24,4 @@ new cloudfront.CloudFrontWebDistribution(stack, 'AnAmazingWebsiteProbably', {
   ]
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-cloudfront/test/integ.cloudfront-empty-root.ts

@@ -25,4 +25,4 @@ new cloudfront.CloudFrontWebDistribution(stack, 'AnAmazingWebsiteProbably', {
   defaultRootObject: ''
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-cloudfront/test/integ.cloudfront-ipv6-disabled.ts

@@ -23,4 +23,4 @@ new cloudfront.CloudFrontWebDistribution(stack, 'MyDistribution', {
   enableIpV6: false
  });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-cloudfront/test/integ.cloudfront-security-policy.ts

@@ -30,4 +30,4 @@ new cloudfront.CloudFrontWebDistribution(stack, 'AnAmazingWebsiteProbably', {
   }
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-cloudfront/test/integ.cloudfront.ts

@@ -22,4 +22,4 @@ new cloudfront.CloudFrontWebDistribution(stack, 'MyDistribution', {
   ]
  });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-cloudtrail/test/integ.cloudtrail.lit.ts

@@ -10,4 +10,4 @@ const bucket = new s3.Bucket(stack, 'Bucket', { removalPolicy: cdk.RemovalPolicy
 const trail = new cloudtrail.Trail(stack, 'Trail');
 trail.addS3EventSelector([bucket.arnForObjects('')]);
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-cloudwatch/test/integ.alarm-and-dashboard.ts

@@ -50,4 +50,4 @@ dashboard.add(new cloudwatch.SingleValueWidget({
   metrics: [metric]
 }));
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-codebuild/test/integ.caching.ts

@@ -24,4 +24,4 @@ new codebuild.Project(stack, 'MyProject', {
   }
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-codebuild/test/integ.defaults.lit.ts

@@ -26,4 +26,4 @@ const app = new cdk.App();
 
 new TestStack(app, 'codebuild-default-project');
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-codebuild/test/integ.docker-asset.lit.ts

@@ -30,4 +30,4 @@ const app = new cdk.App();
 
 new TestStack(app, 'test-codebuild-docker-asset');
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-codebuild/test/integ.ecr.lit.ts

@@ -30,4 +30,4 @@ const app = new cdk.App();
 
 new TestStack(app, 'test-codebuild-docker-asset');
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-codebuild/test/integ.github.ts

@@ -20,4 +20,4 @@ const app = new cdk.App();
 
 new TestStack(app, 'test-codebuild-github');
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-codebuild/test/integ.project-bucket.ts

@@ -21,4 +21,4 @@ new codebuild.Project(stack, 'MyProject', {
   }
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-codebuild/test/integ.project-secondary-sources-artifacts.ts

@@ -31,4 +31,4 @@ new codebuild.Project(stack, 'MyProject', {
   ],
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-codebuild/test/integ.project-shell.ts

@@ -11,4 +11,4 @@ new Project(stack, 'MyProject', {
   buildScriptAsset: new assets.ZipDirectoryAsset(stack, 'Bundle', { path: 'script_bundle' })
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-codebuild/test/integ.project-vpc.ts

@@ -23,4 +23,4 @@ new Project(stack, 'MyProject', {
     vpc
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-codecommit/test/integ.codecommit-events.ts

@@ -19,4 +19,4 @@ repo.onReferenceCreated('OnReferenceCreated', {
   }
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-codedeploy/test/lambda/integ.deployment-group.ts

@@ -45,4 +45,4 @@ new codedeploy.LambdaDeploymentGroup(stack, 'BlueGreenDeployment', {
   postHook
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-codedeploy/test/server/integ.deployment-group.ts

@@ -42,4 +42,4 @@ new codedeploy.ServerDeploymentGroup(stack, 'CodeDeployGroup', {
   },
 });
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-codepipeline-actions/test/integ.cfn-template-from-repo.lit.ts

@@ -59,4 +59,4 @@ new codepipeline.Pipeline(stack, 'Pipeline', {
 });
 /// !hide
 
-app.run();
+app.synth();

packages/@aws-cdk/aws-codepipeline-actions/test/integ.lambda-deployed-through-codepipeline.lit.ts

@@ -1,3 +1,4 @@
+/// !cdk-integ PipelineStack
 import codebuild = require('@aws-cdk/aws-codebuild');
 import codecommit = require('@aws-cdk/aws-codecommit');
 import codepipeline = require('@aws-cdk/aws-codepipeline');
@@ -8,11 +9,7 @@ import codepipeline_actions = require('../lib');
 const app = new cdk.App();
 
 /// !show
-const lambdaStack = new cdk.Stack(app, 'LambdaStack', {
-  // remove the Stack from `cdk synth` and `cdk deploy`
-  // unless you explicitly filter for it
-  autoDeploy: false,
-});
+const lambdaStack = new cdk.Stack(app, 'LambdaStack');
 const lambdaCode = lambda.Code.cfnParameters();
 new lambda.Function(lambdaStack, 'Lambda', {
   code: lambdaCode,

packages/@aws-cdk/aws-codepipeline-actions/test/integ.lambda-pipeline.ts

@@ -42,4 +42,4 @@ lambdaStage.addAction(new cpactions.LambdaInvokeAction({
   lambda: lambdaFun,
 }));
 
-app.run();
+app.synth();