chore: release 2.126.0 (#28967)

See CHANGELOG.v2.md and CHANGELOG.v2.alpha.md


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

CHANGELOG.v2.alpha.md

@@ -2,6 +2,8 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.126.0-alpha.0](https://github.com/aws/aws-cdk/compare/v2.125.0-alpha.0...v2.126.0-alpha.0) (2024-02-02)
+
 ## [2.125.0-alpha.0](https://github.com/aws/aws-cdk/compare/v2.124.0-alpha.0...v2.125.0-alpha.0) (2024-01-31)
 
 

CHANGELOG.v2.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.126.0](https://github.com/aws/aws-cdk/compare/v2.125.0...v2.126.0) (2024-02-02)
+
+
+### Features
+
+* **migrate:** Add CDK Migrate `--from-scan` functionality ([#28962](https://github.com/aws/aws-cdk/issues/28962)) ([bbc14b3](https://github.com/aws/aws-cdk/commit/bbc14b32801f103bc465fd910d507ffa0d06b7fe))
+
 ## [2.125.0](https://github.com/aws/aws-cdk/compare/v2.124.0...v2.125.0) (2024-01-31)
 
 

packages/@aws-cdk-testing/cli-integ/lib/with-cdk-app.ts

@@ -12,6 +12,7 @@ import { AwsContext, withAws } from './with-aws';
 import { withTimeout } from './with-timeout';
 
 export const DEFAULT_TEST_TIMEOUT_S = 10 * 60;
+export const EXTENDED_TEST_TIMEOUT_S = 30 * 60;
 
 /**
  * Higher order function to execute a block with a CDK app fixture
@@ -185,6 +186,10 @@ export function withDefaultFixture(block: (context: TestFixture) => Promise<void
   return withAws(withTimeout(DEFAULT_TEST_TIMEOUT_S, withCdkApp(block)));
 }
 
+export function withExtendedTimeoutFixture(block: (context: TestFixture) => Promise<void>) {
+  return withAws(withTimeout(EXTENDED_TEST_TIMEOUT_S, withCdkApp(block)));
+}
+
 export function withCDKMigrateFixture(language: string, block: (content: TestFixture) => Promise<void>) {
   return withAws(withTimeout(DEFAULT_TEST_TIMEOUT_S, withCdkMigrateApp(language, block)));
 }

packages/@aws-cdk-testing/cli-integ/package.json

@@ -39,7 +39,7 @@
   },
   "dependencies": {
     "@octokit/rest": "^18.12.0",
-    "aws-sdk": "^2.1547.0",
+    "aws-sdk": "^2.1548.0",
     "axios": "^1.6.7",
     "fs-extra": "^9.1.0",
     "glob": "^7.2.3",

packages/@aws-cdk-testing/cli-integ/resources/cdk-apps/app/app.js

@@ -86,7 +86,35 @@ class MigrateStack extends cdk.Stack {
         value: queue.node.defaultChild.logicalId,
       });
     }
+    if (process.env.SAMPLE_RESOURCES) {
+      const myTopic = new sns.Topic(this, 'migratetopic1', {
+        removalPolicy: cdk.RemovalPolicy.DESTROY,
+      });
+      cdk.Tags.of(myTopic).add('tag1', 'value1');
+      const myTopic2 = new sns.Topic(this, 'migratetopic2', {
+        removalPolicy: cdk.RemovalPolicy.DESTROY,
+      });
+      cdk.Tags.of(myTopic2).add('tag2', 'value2');
+      const myQueue = new sqs.Queue(this, 'migratequeue1', {
+        removalPolicy: cdk.RemovalPolicy.DESTROY,
+      });
+      cdk.Tags.of(myQueue).add('tag3', 'value3');
+    }
+    if (process.env.LAMBDA_RESOURCES) {
+      const myFunction = new lambda.Function(this, 'migratefunction1', {
+        code: lambda.Code.fromInline('console.log("hello world")'),
+        handler: 'index.handler',
+        runtime: lambda.Runtime.NODEJS_18_X,
+      });
+      cdk.Tags.of(myFunction).add('lambda-tag', 'lambda-value');
 
+      const myFunction2 = new lambda.Function(this, 'migratefunction2', {
+        code: lambda.Code.fromInline('console.log("hello world2")'),
+        handler: 'index.handler',
+        runtime: lambda.Runtime.NODEJS_18_X,
+      });
+      cdk.Tags.of(myFunction2).add('lambda-tag', 'lambda-value');
+    }
   }
 }
 

packages/@aws-cdk-testing/cli-integ/tests/cli-integ-tests/cli.integtest.ts

@@ -1,7 +1,7 @@
 import { promises as fs, existsSync } from 'fs';
 import * as os from 'os';
 import * as path from 'path';
-import { integTest, cloneDirectory, shell, withDefaultFixture, retry, sleep, randomInteger, withSamIntegrationFixture, RESOURCES_DIR, withCDKMigrateFixture } from '../../lib';
+import { integTest, cloneDirectory, shell, withDefaultFixture, retry, sleep, randomInteger, withSamIntegrationFixture, RESOURCES_DIR, withCDKMigrateFixture, withExtendedTimeoutFixture } from '../../lib';
 
 jest.setTimeout(2 * 60 * 60_000); // Includes the time to acquire locks, worst-case single-threaded runtime
 
@@ -571,9 +571,9 @@ integTest('deploy with role', withDefaultFixture(async (fixture) => {
   }
 }));
 
-// TODO add go back in when template synths properly
+// TODO add more testing that ensures the symmetry of the generated constructs to the resources.
 ['typescript', 'python', 'csharp', 'java'].forEach(language => {
-  integTest(`cdk migrate ${language}`, withCDKMigrateFixture(language, async (fixture) => {
+  integTest(`cdk migrate ${language} deploys successfully`, withCDKMigrateFixture(language, async (fixture) => {
     if (language === 'python') {
       await fixture.shell(['pip', 'install', '-r', 'requirements.txt']);
     }
@@ -588,6 +588,118 @@ integTest('deploy with role', withDefaultFixture(async (fixture) => {
   }));
 });
 
+integTest('cdk migrate generates migrate.json', withCDKMigrateFixture('typescript', async (fixture) => {
+
+  const migrateFile = await fs.readFile(path.join(fixture.integTestDir, 'migrate.json'), 'utf8');
+  const expectedFile = `{
+    \"//\": \"This file is generated by cdk migrate. It will be automatically deleted after the first successful deployment of this app to the environment of the original resources.\",
+    \"Source\": \"localfile\"
+  }`;
+  expect(JSON.parse(migrateFile)).toEqual(JSON.parse(expectedFile));
+  await fixture.cdkDestroy(fixture.stackNamePrefix);
+}));
+
+integTest('cdk migrate --from-scan with AND/OR filters correctly filters resources', withExtendedTimeoutFixture(async (fixture) => {
+  const stackName = `cdk-migrate-integ-${fixture.randomString}`;
+
+  await fixture.cdkDeploy('migrate-stack', {
+    modEnv: { SAMPLE_RESOURCES: '1' },
+  });
+  await fixture.cdk(
+    ['migrate', '--stack-name', stackName, '--from-scan', 'new', '--filter', 'type=AWS::SNS::Topic,tag-key=tag1', 'type=AWS::SQS::Queue,tag-key=tag3'],
+    { modEnv: { MIGRATE_INTEG_TEST: '1' }, neverRequireApproval: true, verbose: true, captureStderr: false },
+  );
+
+  try {
+    const response = await fixture.aws.cloudFormation('describeGeneratedTemplate', {
+      GeneratedTemplateName: stackName,
+    });
+    const resourceNames = [];
+    for (const resource of response.Resources || []) {
+      if (resource.LogicalResourceId) {
+        resourceNames.push(resource.LogicalResourceId);
+      }
+    }
+    fixture.log(`Resources: ${resourceNames}`);
+    expect(resourceNames.some(ele => ele && ele.includes('migratetopic1'))).toBeTruthy();
+    expect(resourceNames.some(ele => ele && ele.includes('migratequeue1'))).toBeTruthy();
+  } finally {
+    await fixture.cdkDestroy('migrate-stack');
+    await fixture.aws.cloudFormation('deleteGeneratedTemplate', {
+      GeneratedTemplateName: stackName,
+    });
+  }
+}));
+
+integTest('cdk migrate --from-scan for resources with Write Only Properties generates warnings', withExtendedTimeoutFixture(async (fixture) => {
+  const stackName = `cdk-migrate-integ-${fixture.randomString}`;
+
+  await fixture.cdkDeploy('migrate-stack', {
+    modEnv: {
+      LAMBDA_RESOURCES: '1',
+    },
+  });
+  await fixture.cdk(
+    ['migrate', '--stack-name', stackName, '--from-scan', 'new', '--filter', 'type=AWS::Lambda::Function,tag-key=lambda-tag'],
+    { modEnv: { MIGRATE_INTEG_TEST: '1' }, neverRequireApproval: true, verbose: true, captureStderr: false },
+  );
+
+  try {
+
+    const response = await fixture.aws.cloudFormation('describeGeneratedTemplate', {
+      GeneratedTemplateName: stackName,
+    });
+    const resourceNames = [];
+    for (const resource of response.Resources || []) {
+      if (resource.LogicalResourceId && resource.ResourceType === 'AWS::Lambda::Function') {
+        resourceNames.push(resource.LogicalResourceId);
+      }
+    }
+    fixture.log(`Resources: ${resourceNames}`);
+    const readmePath = path.join(fixture.integTestDir, stackName, 'README.md');
+    const readme = await fs.readFile(readmePath, 'utf8');
+    expect(readme).toContain('## Warnings');
+    for (const resourceName of resourceNames) {
+      expect(readme).toContain(`### ${resourceName}`);
+    }
+  } finally {
+    await fixture.cdkDestroy('migrate-stack');
+    await fixture.aws.cloudFormation('deleteGeneratedTemplate', {
+      GeneratedTemplateName: stackName,
+    });
+  }
+}));
+
+['typescript', 'python', 'csharp', 'java'].forEach(language => {
+  integTest(`cdk migrate --from-stack creates deployable ${language} app`, withExtendedTimeoutFixture(async (fixture) => {
+    const migrateStackName = fixture.fullStackName('migrate-stack');
+    await fixture.aws.cloudFormation('createStack', {
+      StackName: migrateStackName,
+      TemplateBody: await fs.readFile(path.join(__dirname, '..', '..', 'resources', 'templates', 'sqs-template.json'), 'utf8'),
+    });
+    try {
+      let stackStatus = 'CREATE_IN_PROGRESS';
+      while (stackStatus === 'CREATE_IN_PROGRESS') {
+        stackStatus = await (await (fixture.aws.cloudFormation('describeStacks', { StackName: migrateStackName }))).Stacks?.[0].StackStatus!;
+        await sleep(1000);
+      }
+      await fixture.cdk(
+        ['migrate', '--stack-name', migrateStackName, '--from-stack'],
+        { modEnv: { MIGRATE_INTEG_TEST: '1' }, neverRequireApproval: true, verbose: true, captureStderr: false },
+      );
+      await fixture.shell(['cd', path.join(fixture.integTestDir, migrateStackName)]);
+      await fixture.cdk(['deploy', migrateStackName], { neverRequireApproval: true, verbose: true, captureStderr: false });
+      const response = await fixture.aws.cloudFormation('describeStacks', {
+        StackName: migrateStackName,
+      });
+
+      expect(response.Stacks?.[0].StackStatus).toEqual('UPDATE_COMPLETE');
+    } finally {
+      await fixture.cdkDestroy('migrate-stack');
+    }
+  }));
+});
+
 integTest('cdk diff', withDefaultFixture(async (fixture) => {
   const diff1 = await fixture.cdk(['diff', fixture.fullStackName('test-1')]);
   expect(diff1).toContain('AWS::SNS::Topic');

packages/@aws-cdk-testing/framework-integ/package.json

@@ -41,7 +41,7 @@
     "@aws-cdk/integ-tests-alpha": "0.0.0",
     "@aws-cdk/lambda-layer-kubectl-v24": "^2.0.242",
     "aws-cdk-lib": "0.0.0",
-    "aws-sdk": "^2.1547.0",
+    "aws-sdk": "^2.1548.0",
     "aws-sdk-mock": "5.6.0",
     "cdk8s": "2.68.32",
     "cdk8s-plus-27": "2.7.74",

packages/@aws-cdk/cli-lib-alpha/THIRD_PARTY_LICENSES

@@ -207,7 +207,7 @@ The @aws-cdk/cli-lib-alpha package includes the following third-party software/l
 
 ----------------
 
-** @jsii/check-node@1.93.0 - https://www.npmjs.com/package/@jsii/check-node/v/1.93.0 | Apache-2.0
+** @jsii/check-node@1.94.0 - https://www.npmjs.com/package/@jsii/check-node/v/1.94.0 | Apache-2.0
 jsii
 Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
@@ -471,17 +471,7 @@ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH RE
 
 ----------------
 
-** aws-sdk@2.1517.0 - https://www.npmjs.com/package/aws-sdk/v/2.1517.0 | Apache-2.0
-AWS SDK for JavaScript
-Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-
-This product includes software developed at
-Amazon Web Services, Inc. (http://aws.amazon.com/).
-
-
-----------------
-
-** aws-sdk@2.1532.0 - https://www.npmjs.com/package/aws-sdk/v/2.1532.0 | Apache-2.0
+** aws-sdk@2.1548.0 - https://www.npmjs.com/package/aws-sdk/v/2.1548.0 | Apache-2.0
 AWS SDK for JavaScript
 Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
@@ -495,7 +485,7 @@ Amazon Web Services, Inc. (http://aws.amazon.com/).
 
 ----------------
 
-** basic-ftp@5.0.3 - https://www.npmjs.com/package/basic-ftp/v/5.0.3 | MIT
+** basic-ftp@5.0.4 - https://www.npmjs.com/package/basic-ftp/v/5.0.4 | MIT
 Copyright (c) 2019 Patrick Juchli
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -678,7 +668,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ----------------
 
-** cdk-from-cfn@0.116.0 - https://www.npmjs.com/package/cdk-from-cfn/v/0.116.0 | MIT OR Apache-2.0
+** cdk-from-cfn@0.125.0 - https://www.npmjs.com/package/cdk-from-cfn/v/0.125.0 | MIT OR Apache-2.0
 
 ----------------
 
@@ -3515,7 +3505,7 @@ IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 ----------------
 
-** xml2js@0.5.0 - https://www.npmjs.com/package/xml2js/v/0.5.0 | MIT
+** xml2js@0.6.2 - https://www.npmjs.com/package/xml2js/v/0.6.2 | MIT
 Copyright 2010, 2011, 2012, 2013. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

packages/@aws-cdk/cloudformation-diff/package.json

@@ -38,7 +38,7 @@
     "@types/string-width": "^4.0.1",
     "fast-check": "^3.15.1",
     "jest": "^29.7.0",
-    "aws-sdk": "2.1547.0",
+    "aws-sdk": "2.1548.0",
     "ts-jest": "^29.1.2"
   },
   "repository": {

packages/@aws-cdk/custom-resource-handlers/package.json

@@ -63,7 +63,7 @@
     "@aws-sdk/client-synthetics": "3.421.0",
     "@aws-sdk/client-ecr": "3.421.0",
     "@aws-sdk/client-s3": "3.421.0",
-    "aws-sdk": "^2.1547.0"
+    "aws-sdk": "^2.1548.0"
   },
   "repository": {
     "url": "https://github.com/aws/aws-cdk.git",

packages/aws-cdk-lib/core/lib/private/metadata-resource.ts

@@ -16,7 +16,6 @@ import { Token } from '../token';
 export class MetadataResource extends Construct {
   constructor(scope: Stack, id: string) {
     super(scope, id);
-
     const metadataServiceExists = Token.isUnresolved(scope.region) || RegionInfo.get(scope.region).cdkMetadataResourceAvailable;
     if (metadataServiceExists) {
       const resource = new CfnResource(this, 'Default', {
@@ -51,22 +50,30 @@ function makeCdkMetadataAvailableCondition() {
 class Trie extends Map<string, Trie> { }
 
 /**
- * Formats a list of construct fully-qualified names (FQNs) and versions into a (possibly compressed) prefix-encoded string.
+ * Formats the analytics string which has 3 or 4 sections separated by colons (:)
+ *
+ * version:encoding:constructinfo OR version:encoding:constructinfo:appinfo
  *
- * The list of ConstructInfos is logically formatted into:
- * ${version}!${fqn} (e.g., "1.90.0!aws-cdk-lib.Stack")
- * and then all of the construct-versions are grouped with common prefixes together, grouping common parts in '{}' and separating items with ','.
+ * The constructinfo section is a list of construct fully-qualified names (FQNs)
+ * and versions into a (possibly compressed) prefix-encoded string.
+ *
+ * The list of ConstructInfos is logically formatted into: ${version}!${fqn}
+ * (e.g., "1.90.0!aws-cdk-lib.Stack") and then all of the construct-versions are
+ * grouped with common prefixes together, grouping common parts in '{}' and
+ * separating items with ','.
  *
  * Example:
  * [1.90.0!aws-cdk-lib.Stack, 1.90.0!aws-cdk-lib.Construct, 1.90.0!aws-cdk-lib.service.Resource, 0.42.1!aws-cdk-lib-experiments.NewStuff]
  * Becomes:
  * 1.90.0!aws-cdk-lib.{Stack,Construct,service.Resource},0.42.1!aws-cdk-lib-experiments.NewStuff
  *
- * The whole thing is then either included directly as plaintext as:
- * v2:plaintext:{prefixEncodedList}
- * Or is compressed and base64-encoded, and then formatted as:
+ * The whole thing is then compressed and base64-encoded, and then formatted as:
  * v2:deflate64:{prefixEncodedListCompressedAndEncoded}
  *
+ * The appinfo section is optional, and currently only added if the app was generated using `cdk migrate`
+ * It is also compressed and base64-encoded. In this case, the string will be formatted as:
+ * v2:deflate64:{prefixEncodedListCompressedAndEncoded}:{'cdk-migrate'CompressedAndEncoded}
+ *
  * Exported/visible for ease of testing.
  */
 export function formatAnalytics(infos: ConstructInfo[]) {
@@ -81,7 +88,15 @@ export function formatAnalytics(infos: ConstructInfo[]) {
   setGzipOperatingSystemToUnknown(compressedConstructsBuffer);
 
   const compressedConstructs = compressedConstructsBuffer.toString('base64');
-  return `v2:deflate64:${compressedConstructs}`;
+  const analyticsString = `v2:deflate64:${compressedConstructs}`;
+
+  if (process.env.CDK_CONTEXT_JSON && JSON.parse(process.env.CDK_CONTEXT_JSON)['cdk-migrate']) {
+    const compressedAppInfoBuffer = zlib.gzipSync(Buffer.from('cdk-migrate'));
+    const compressedAppInfo = compressedAppInfoBuffer.toString('base64');
+    analyticsString.concat(':', compressedAppInfo);
+  }
+
+  return analyticsString;
 }
 
 /**

packages/aws-cdk-lib/package.json

@@ -163,7 +163,7 @@
     "@types/lodash": "^4.14.202",
     "@types/punycode": "^2.1.3",
     "@aws-cdk/lazify": "0.0.0",
-    "aws-sdk": "^2.1547.0",
+    "aws-sdk": "^2.1548.0",
     "aws-sdk-client-mock": "^3.0.1",
     "aws-sdk-client-mock-jest": "^3.0.1",
     "aws-sdk-mock": "5.8.0",