chore(aws-cdk-lib): increase jest test speed, remove warnings (#26854)

Two changes to the `jest` tests: - We are currently running the tests directly from `.ts` source files using `ts-jest`. Disable type checking (by setting `isolatedModules: true`) to improve the speed. This brings down running 4 test suites from an arbitrary service (`aws-servicecatalog`) down from `79s` to `19s` on my machine. - Change the "coverage ignore files" a little to get rid of the "Note: The code generator has deoptimised the styling" errors produced by jest when it wants to read the coverage of the generated source files. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Aug 25, 2023 · 6227c94 · 6227c94
1 parent 356f302
commit 6227c94
Show file tree

Hide file tree

Showing 37 changed files with 203 additions and 160 deletions.
diff --git a/nx.json b/nx.json
@@ -11,7 +11,8 @@
         "!{workspaceRoot}/**/tsconfig.json",
         "!{workspaceRoot}/**/tsconfig.json",
         "!{workspaceRoot}/tsconfig.base.json",
-        "!{workspaceRoot}/**/tsconfig.tsbuildinfo"
+        "!{workspaceRoot}/**/tsconfig.tsbuildinfo",
+        "!{workspaceRoot}/**/jest.config.js"
       ],
       "outputs": [
         "{projectRoot}/**/*.integ.*.js.snapshot/*",

diff --git a/package.json b/package.json
@@ -28,6 +28,7 @@
     "jsii-pacmak": "1.87.0",
     "jsii-reflect": "1.87.0",
     "jsii-rosetta": "~5.1.10",
+    "ts-jest": "^29.1.1",
     "lerna": "^7.1.5",
     "nx": "^16.7.3",
     "patch-package": "^6.5.1",

diff --git a/packages/@aws-cdk-testing/cli-integ/test/resource-pool.test.ts b/packages/@aws-cdk-testing/cli-integ/test/resource-pool.test.ts
@@ -1,6 +1,8 @@
 import { sleep } from '../lib';
 import { ResourcePool } from '../lib/resource-pool';
 
+jest.setTimeout(30_000);
+
 const POOL_NAME = 'resource-pool.test';
 
 test('take and dispose', async () => {

diff --git a/packages/@aws-cdk-testing/framework-integ/.gitignore b/packages/@aws-cdk-testing/framework-integ/.gitignore
@@ -14,4 +14,6 @@ nyc.config.js
 
 !**/*.snapshot/**/asset.*/**
 
-**/*.ts.snapshot
+**/*.ts.snapshot
+
+!jest.config.js
diff --git a/packages/@aws-cdk-testing/framework-integ/jest.config.js b/packages/@aws-cdk-testing/framework-integ/jest.config.js
@@ -0,0 +1,14 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  // Purposely only run .js files, not .ts files. This is so that the unit tests
+  // here will use the jsii-compiled version of `aws-cdk-lib`, and not the live-interpreted
+  // .ts files.
+  moduleFileExtensions: [
+    'js',
+  ],
+  testMatch: [
+    '<rootDir>/test/**/?(*.)+(test).js',
+  ],
+
+  testEnvironment: 'node',
+};
diff --git a/...4da17aecd505282a25513f8/__entrypoint__.js → ...f228bef7ab23627ed409cde/__entrypoint__.js b/...4da17aecd505282a25513f8/__entrypoint__.js → ...f228bef7ab23627ed409cde/__entrypoint__.js
diff --git a/...snapshot/asset.1e14e895fcbdf65feb0a29e4aa74c6c92a6fb0e41f228bef7ab23627ed409cde/consts.js b/...snapshot/asset.1e14e895fcbdf65feb0a29e4aa74c6c92a6fb0e41f228bef7ab23627ed409cde/consts.js
diff --git a/....snapshot/asset.1e14e895fcbdf65feb0a29e4aa74c6c92a6fb0e41f228bef7ab23627ed409cde/index.js b/....snapshot/asset.1e14e895fcbdf65feb0a29e4aa74c6c92a6fb0e41f228bef7ab23627ed409cde/index.js
diff --git a/...snapshot/asset.a913a2614f4e118cb83fa3c0dd17575c9adbbdbad4da17aecd505282a25513f8/consts.js b/...snapshot/asset.a913a2614f4e118cb83fa3c0dd17575c9adbbdbad4da17aecd505282a25513f8/consts.js
diff --git a/....snapshot/asset.a913a2614f4e118cb83fa3c0dd17575c9adbbdbad4da17aecd505282a25513f8/index.js b/....snapshot/asset.a913a2614f4e118cb83fa3c0dd17575c9adbbdbad4da17aecd505282a25513f8/index.js
diff --git a/...dk-testing/framework-integ/test/aws-iam/test/integ.condition-with-ref.js.snapshot/cdk.out b/...dk-testing/framework-integ/test/aws-iam/test/integ.condition-with-ref.js.snapshot/cdk.out
@@ -1 +1 @@
-{"version":"32.0.0"}
+{"version":"33.0.0"}
diff --git a/...n-with-ref.js.snapshot/iamtestconditionwithrefDefaultTestDeployAssert5E44A64B.assets.json b/...n-with-ref.js.snapshot/iamtestconditionwithrefDefaultTestDeployAssert5E44A64B.assets.json
@@ -1,5 +1,5 @@
 {
-  "version": "32.0.0",
+  "version": "33.0.0",
   "files": {
     "21fbb51d7b23f6a6c262b46a9caee79d744a3ac019fd45422d988b96d44b2a22": {
       "source": {

diff --git a/...testing/framework-integ/test/aws-iam/test/integ.condition-with-ref.js.snapshot/integ.json b/...testing/framework-integ/test/aws-iam/test/integ.condition-with-ref.js.snapshot/integ.json
@@ -1,10 +1,11 @@
 {
-  "version": "32.0.0",
+  "version": "33.0.0",
   "testCases": {
     "iam-test-condition-with-ref/DefaultTest": {
       "stacks": [
         "test-condition-with-ref"
       ],
+      "diffAssets": true,
       "assertionStack": "iam-test-condition-with-ref/DefaultTest/DeployAssert",
       "assertionStackName": "iamtestconditionwithrefDefaultTestDeployAssert5E44A64B"
     }

diff --git a/...ting/framework-integ/test/aws-iam/test/integ.condition-with-ref.js.snapshot/manifest.json b/...ting/framework-integ/test/aws-iam/test/integ.condition-with-ref.js.snapshot/manifest.json
@@ -1,5 +1,5 @@
 {
-  "version": "32.0.0",
+  "version": "33.0.0",
   "artifacts": {
     "test-condition-with-ref.assets": {
       "type": "cdk:asset-manifest",
@@ -17,7 +17,7 @@
         "validateOnSynth": false,
         "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-deploy-role-${AWS::AccountId}-${AWS::Region}",
         "cloudFormationExecutionRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-cfn-exec-role-${AWS::AccountId}-${AWS::Region}",
-        "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/5d543b44583359346e7d4e1d73209c742ec533540ce929f2f2493fb27b0e738d.json",
+        "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/c78c907e2231879b958741f82c29330bcd35d5778c279f9e497f7e8565e6e2cc.json",
         "requiresBootstrapStackVersion": 6,
         "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version",
         "additionalDependencies": [

diff --git a/...est/aws-iam/test/integ.condition-with-ref.js.snapshot/test-condition-with-ref.assets.json b/...est/aws-iam/test/integ.condition-with-ref.js.snapshot/test-condition-with-ref.assets.json
@@ -1,28 +1,28 @@
 {
-  "version": "32.0.0",
+  "version": "33.0.0",
   "files": {
-    "a913a2614f4e118cb83fa3c0dd17575c9adbbdbad4da17aecd505282a25513f8": {
+    "1e14e895fcbdf65feb0a29e4aa74c6c92a6fb0e41f228bef7ab23627ed409cde": {
       "source": {
-        "path": "asset.a913a2614f4e118cb83fa3c0dd17575c9adbbdbad4da17aecd505282a25513f8",
+        "path": "asset.1e14e895fcbdf65feb0a29e4aa74c6c92a6fb0e41f228bef7ab23627ed409cde",
         "packaging": "zip"
       },
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "a913a2614f4e118cb83fa3c0dd17575c9adbbdbad4da17aecd505282a25513f8.zip",
+          "objectKey": "1e14e895fcbdf65feb0a29e4aa74c6c92a6fb0e41f228bef7ab23627ed409cde.zip",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }
     },
-    "5d543b44583359346e7d4e1d73209c742ec533540ce929f2f2493fb27b0e738d": {
+    "c78c907e2231879b958741f82c29330bcd35d5778c279f9e497f7e8565e6e2cc": {
       "source": {
         "path": "test-condition-with-ref.template.json",
         "packaging": "file"
       },
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "5d543b44583359346e7d4e1d73209c742ec533540ce929f2f2493fb27b0e738d.json",
+          "objectKey": "c78c907e2231879b958741f82c29330bcd35d5778c279f9e497f7e8565e6e2cc.json",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }

diff --git a/...t/aws-iam/test/integ.condition-with-ref.js.snapshot/test-condition-with-ref.template.json b/...t/aws-iam/test/integ.condition-with-ref.js.snapshot/test-condition-with-ref.template.json
@@ -65,7 +65,7 @@
      "S3Bucket": {
       "Fn::Sub": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}"
      },
-     "S3Key": "a913a2614f4e118cb83fa3c0dd17575c9adbbdbad4da17aecd505282a25513f8.zip"
+     "S3Key": "1e14e895fcbdf65feb0a29e4aa74c6c92a6fb0e41f228bef7ab23627ed409cde.zip"
     },
     "Timeout": 900,
     "MemorySize": 128,

diff --git a/...-testing/framework-integ/test/aws-iam/test/integ.condition-with-ref.js.snapshot/tree.json b/...-testing/framework-integ/test/aws-iam/test/integ.condition-with-ref.js.snapshot/tree.json
@@ -179,7 +179,7 @@
                 "path": "iam-test-condition-with-ref/DefaultTest/Default",
                 "constructInfo": {
                   "fqn": "constructs.Construct",
-                  "version": "10.2.55"
+                  "version": "10.2.69"
                 }
               },
               "DeployAssert": {
@@ -225,7 +225,7 @@
         "path": "Tree",
         "constructInfo": {
           "fqn": "constructs.Construct",
-          "version": "10.2.55"
+          "version": "10.2.69"
         }
       }
     },

diff --git a/...ws-cdk-lib/core/test/runtime-info.test.ts → ...integ/test/core/test/runtime-info.test.ts b/...ws-cdk-lib/core/test/runtime-info.test.ts → ...integ/test/core/test/runtime-info.test.ts
@@ -1,40 +1,26 @@
+/**
+ * Unit tests that depend on 'aws-cdk-lib' having been compiled using jsii
+ */
 import * as fs from 'fs';
 import * as path from 'path';
 import { Construct } from 'constructs';
-import { App, NestedStack, Stack, Stage, IPolicyValidationPluginBeta1, PolicyViolationBeta1, PolicyValidationPluginReportBeta1, IPolicyValidationContextBeta1 } from '../lib';
-import { constructInfoFromConstruct, constructInfoFromStack } from '../lib/private/runtime-info';
+import { App, NestedStack, Stack, Stage, IPolicyValidationPluginBeta1, PolicyViolationBeta1, PolicyValidationPluginReportBeta1, IPolicyValidationContextBeta1 } from 'aws-cdk-lib';
+import { constructInfoFromConstruct, constructInfoFromStack } from 'aws-cdk-lib/core/lib/helpers-internal';
 
 const JSII_RUNTIME_SYMBOL = Symbol.for('jsii.rtti');
 
 let app: App;
 let stack: Stack;
 let _cdkVersion: string | undefined = undefined;
 
-// The runtime metadata this test relies on is only available if the most
-// recent compile has happened using 'jsii', as the jsii compiler injects
-// this metadata.
-//
-// If the most recent compile was using 'tsc', the metadata will not have
-// been injected, and the test suite will fail.
-//
-// Tolerate `tsc` builds locally, but not on CodeBuild.
-const codeBuild = !!process.env.CODEBUILD_BUILD_ID;
-const moduleCompiledWithTsc = constructInfoFromConstruct(new Stack())?.fqn === 'constructs.Construct';
-let describeTscSafe = describe;
-if (moduleCompiledWithTsc && !codeBuild) {
-  // eslint-disable-next-line
-  console.error('It appears this module was compiled with `tsc` instead of `jsii` in a local build. Skipping this test suite.');
-  describeTscSafe = describe.skip;
-}
-
 beforeEach(() => {
   app = new App();
   stack = new Stack(app, 'Stack', {
     analyticsReporting: true,
   });
 });
 
-describeTscSafe('constructInfoFromConstruct', () => {
+describe('constructInfoFromConstruct', () => {
   test('returns fqn and version for core constructs', () => {
     const constructInfo = constructInfoFromConstruct(stack);
     expect(constructInfo).toBeDefined();
@@ -70,7 +56,7 @@ describeTscSafe('constructInfoFromConstruct', () => {
   });
 });
 
-describeTscSafe('constructInfoForStack', () => {
+describe('constructInfoForStack', () => {
   test('returns stack itself and jsii runtime if stack is empty', () => {
     const constructInfos = constructInfoFromStack(stack);
 

diff --git a/...b/core/test/private/tree-metadata.test.ts → ...nteg/test/core/test/tree-metadata.test.ts b/...b/core/test/private/tree-metadata.test.ts → ...nteg/test/core/test/tree-metadata.test.ts
@@ -1,8 +1,11 @@
+/**
+ * Unit tests that depend on 'aws-cdk-lib' having been compiled using jsii
+ */
 import * as fs from 'fs';
 import * as path from 'path';
 import { Construct } from 'constructs';
-import * as cxschema from '../../../cloud-assembly-schema';
-import { App, CfnParameter, CfnResource, Lazy, Stack, TreeInspector } from '../../lib/index';
+import * as cxschema from 'aws-cdk-lib/cloud-assembly-schema';
+import { App, CfnParameter, CfnResource, Lazy, Stack, TreeInspector } from 'aws-cdk-lib';
 
 abstract class AbstractCfnResource extends CfnResource {
   constructor(scope: Construct, id: string) {
@@ -160,21 +163,19 @@ describe('tree metadata', () => {
     const treeArtifact = assembly.tree();
     expect(treeArtifact).toBeDefined();
 
-    const codeBuild = !!process.env.CODEBUILD_BUILD_ID;
-
     expect(readJson(assembly.directory, treeArtifact!.file)).toEqual({
       version: 'tree-0.1',
       tree: expect.objectContaining({
         children: expect.objectContaining({
           mystack: expect.objectContaining({
             constructInfo: {
-              fqn: expect.stringMatching(codeBuild ? /\bStack$/ : /\bStack$|^constructs.Construct$/),
+              fqn: expect.stringMatching(/\bStack$/),
               version: expect.any(String),
             },
             children: expect.objectContaining({
               myconstruct: expect.objectContaining({
                 constructInfo: {
-                  fqn: expect.stringMatching(codeBuild ? /\bCfnResource$/ : /\bCfnResource$|^constructs.Construct$/),
+                  fqn: expect.stringMatching(/\bCfnResource$/),
                   version: expect.any(String),
                 },
               }),
@@ -398,4 +399,4 @@ describe('tree metadata', () => {
 
 function readJson(outdir: string, file: string) {
   return JSON.parse(fs.readFileSync(path.join(outdir, file), 'utf-8'));
-}
+}
diff --git a/packages/@aws-cdk/app-staging-synthesizer-alpha/test/app-staging-synthesizer.test.ts b/packages/@aws-cdk/app-staging-synthesizer-alpha/test/app-staging-synthesizer.test.ts
@@ -137,7 +137,7 @@ describe(AppStagingSynthesizer, () => {
 
     // THEN - we have a fixed asset location
     expect(evalCFN(location.bucketName)).toEqual(`cdk-${APP_ID}-staging-000000000000-us-east-1`);
-    expect(evalCFN(location.httpUrl)).toEqual(`https://s3.us-east-1.domain.aws/cdk-${APP_ID}-staging-000000000000-us-east-1/abcdef.js`);
+    expect(evalCFN(location.httpUrl)).toEqual(`https://s3.us-east-1.domain.aws/cdk-${APP_ID}-staging-000000000000-us-east-1/abcdef.ts`);
 
     // THEN - object key contains source hash somewhere
     expect(location.objectKey.indexOf('abcdef')).toBeGreaterThan(-1);
@@ -187,7 +187,7 @@ describe(AppStagingSynthesizer, () => {
       });
 
       // THEN - asset has deploy time prefix
-      expect(evalCFN(location.objectKey)).toEqual(`${DEPLOY_TIME_PREFIX}abcdef.js`);
+      expect(evalCFN(location.objectKey)).toEqual(`${DEPLOY_TIME_PREFIX}abcdef.ts`);
     });
 
     test('lambda assets are by default deploy time assets', () => {

diff --git a/...a/test/__snapshots__/cluster.test.js.snap → ...a/test/__snapshots__/cluster.test.ts.snap b/...a/test/__snapshots__/cluster.test.js.snap → ...a/test/__snapshots__/cluster.test.ts.snap
diff --git a/packages/@aws-cdk/cloud-assembly-schema/jest.config.js b/packages/@aws-cdk/cloud-assembly-schema/jest.config.js
@@ -1,11 +1,6 @@
 const baseConfig = require('@aws-cdk/cdk-build-tools/config/jest.config');
 module.exports = {
   ...baseConfig,
-  moduleFileExtensions: [
-    'js',
-    'ts',
-  ],
-  preset: 'ts-jest',
   testMatch: [
     '<rootDir>/**/test/**/?(*.)+(test).ts',
   ],

diff --git a/packages/@aws-cdk/cx-api/jest.config.js b/packages/@aws-cdk/cx-api/jest.config.js
@@ -1,14 +1,6 @@
 const baseConfig = require('@aws-cdk/cdk-build-tools/config/jest.config');
 module.exports = {
-    ...baseConfig,
-  moduleFileExtensions: [
-    'js',
-    'ts',
-  ],
-  preset: 'ts-jest',
-  testMatch: [
-    '<rootDir>/**/test/**/?(*.)+(test).ts',
-  ],
+  ...baseConfig,
   coverageThreshold: {
     global: {
       ...baseConfig.coverageThreshold.global,