chore: syntax check test files (#374)

Currently, the test files are not syntax checked during TypeScript
compilation, only during test running. This makes it hard to pick up on
necessary changes during large-scale refactors.

You will only notice them during test runs, and then every single test
file will fail with a parse error (instead of potentially a single
typechecking error during typechecking phase).

Another complication with the trivial solution of just running `tsc -p
tsconfig.dev.json` is that VSCode will not detect that `test/` files are
included in a tsconfig file if it's not literally called
`tsconfig.json`, so we have to do some trickery to type-check at
compilation time AND convince VSCode to type check as well.

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

Author: rix0rrr

.projen/deps.json

@@ -13,6 +13,7 @@ import { LargePrChecker } from './projenrc/large-pr-checker';
 import { PrLabeler } from './projenrc/pr-labeler';
 import { RecordPublishingTimestamp } from './projenrc/record-publishing-timestamp';
 import { DocType, S3DocsPublishing } from './projenrc/s3-docs-publishing';
+import { TypecheckTests } from './projenrc/TypecheckTests';
 
 // 5.7 sometimes gives a weird error in `ts-jest` in `@aws-cdk/cli-lib-alpha`
 // https://github.com/microsoft/TypeScript/issues/60159
@@ -270,6 +271,7 @@ const repoProject = new yarn.Monorepo({
 repoProject.package.addPackageResolutions(
   '[email protected]',
   '@jest/[email protected]',
+  '@jest/[email protected]',
 );
 
 new AdcPublishing(repoProject);
@@ -654,6 +656,8 @@ const cdkAssets = configureProject(
   }),
 );
 
+new TypecheckTests(cdkAssets);
+
 cdkAssets.addTask('shrinkwrap', {
   steps: [
     {
@@ -775,6 +779,8 @@ const tmpToolkitHelpers = configureProject(
   }),
 );
 
+new TypecheckTests(tmpToolkitHelpers);
+
 // Prevent imports of private API surface
 tmpToolkitHelpers.package.addField('exports', {
   '.': './lib/index.js',
@@ -924,6 +930,8 @@ const toolkitLib = configureProject(
   }),
 );
 
+new TypecheckTests(toolkitLib);
+
 // TypeDoc documentation publishing
 new S3DocsPublishing(toolkitLib, {
   docsStream: 'toolkit-lib',
@@ -1252,6 +1260,8 @@ const cli = configureProject(
   }),
 );
 
+new TypecheckTests(cli);
+
 // Eslint rules
 cli.eslint?.addRules({
   '@cdklabs/no-throw-default-error': 'error',

.projenrc.ts

@@ -60,7 +60,8 @@ export class SecurityGroupContextProviderPlugin implements ContextProviderPlugin
 }
 
 /**
- * @internal
+ * TODO: We intend this to be @*internal but a test in aws-cdk depends on it.
+ * Put the tag back later.
  */
 export function hasAllTrafficEgress(securityGroup: SecurityGroup) {
   let hasAllTrafficCidrV4 = false;

package.json

@@ -24,7 +24,7 @@ export default class TestEnvironment extends NodeEnvironment implements JestEnvi
     // We need to set the event handler by assignment in the constructor,
     // because if we declare it as an async member TypeScript's type derivation
     // doesn't work properly.
-    (this as JestEnvironment<unknown>).handleTestEvent = (async (event, _state) => {
+    (this as JestEnvironment<unknown>).handleTestEvent = (async (event) => {
       if (event.name === 'test_done' && event.test.errors.length > 0 && this.log.length > 0) {
         this.stopCapture();
 

packages/@aws-cdk/tmp-toolkit-helpers/.gitattributes

@@ -62,7 +62,6 @@ describe('formatStackDiff', () => {
       templateInfo: {
         oldTemplate: mockNewTemplate.template,
         newTemplate: mockNewTemplate,
-        stackName: 'test-stack',
       },
     });
     const result = formatter.formatStackDiff();
@@ -84,7 +83,6 @@ describe('formatStackDiff', () => {
       templateInfo: {
         oldTemplate: {},
         newTemplate: mockNewTemplate,
-        stackName: 'test-stack',
       },
     });
     const result = formatter.formatStackDiff();
@@ -107,7 +105,6 @@ describe('formatStackDiff', () => {
       templateInfo: {
         oldTemplate: {},
         newTemplate: mockNewTemplate,
-        stackName: 'test-stack',
         isImport: true,
       },
     });
@@ -149,7 +146,6 @@ describe('formatStackDiff', () => {
       templateInfo: {
         oldTemplate: {},
         newTemplate: mockNewTemplate,
-        stackName: 'test-stack',
         nestedStacks,
       },
     });
@@ -225,7 +221,6 @@ describe('formatSecurityDiff', () => {
       templateInfo: {
         oldTemplate: mockNewTemplate.template,
         newTemplate: mockNewTemplate,
-        stackName: 'test-stack',
       },
     });
     const result = formatter.formatSecurityDiff({
@@ -244,7 +239,6 @@ describe('formatSecurityDiff', () => {
       templateInfo: {
         oldTemplate: {},
         newTemplate: mockNewTemplate,
-        stackName: 'test-stack',
       },
     });
     const result = formatter.formatSecurityDiff({
@@ -279,7 +273,6 @@ describe('formatSecurityDiff', () => {
       templateInfo: {
         oldTemplate: {},
         newTemplate: mockNewTemplate,
-        stackName: 'test-stack',
       },
     });
     const result = formatter.formatSecurityDiff({
@@ -317,7 +310,6 @@ describe('formatSecurityDiff', () => {
       templateInfo: {
         oldTemplate: {},
         newTemplate: mockNewTemplate,
-        stackName: 'test-stack',
       },
     });
     const result = formatter.formatSecurityDiff({

packages/@aws-cdk/tmp-toolkit-helpers/.gitignore

@@ -82,7 +82,7 @@ describe('fromAssemblyBuilder', () => {
     // GIVEN
     const cx = await toolkit.fromAssemblyBuilder(async (props) => {
       lock = new RWLock(props.outdir!);
-      if (!await lock._currentWriter()) {
+      if (!await (lock as any)._currentWriter()) {
         throw new Error('Expected the directory to be locked during synth');
       }
       throw new Error('a wild error appeared');
@@ -92,8 +92,8 @@ describe('fromAssemblyBuilder', () => {
     await expect(cx.produce()).rejects.toThrow(/wild error/);
 
     // THEN: Don't expect either a read or write lock on the directory afterwards
-    expect(await lock!._currentWriter()).toBeUndefined();
-    expect(await lock!._currentReaders()).toEqual([]);
+    expect(await (lock! as any)._currentWriter()).toBeUndefined();
+    expect(await (lock! as any)._currentReaders()).toEqual([]);
   });
 });
 
@@ -162,8 +162,8 @@ describe('fromCdkApp', () => {
     await expect(cx.produce()).rejects.toThrow(/error 1/);
 
     // THEN: Don't expect either a read or write lock on the directory afterwards
-    expect(await lock!._currentWriter()).toBeUndefined();
-    expect(await lock!._currentReaders()).toEqual([]);
+    expect(await (lock! as any)._currentWriter()).toBeUndefined();
+    expect(await (lock! as any)._currentReaders()).toEqual([]);
   });
 });
 

packages/@aws-cdk/tmp-toolkit-helpers/.projen/files.json

@@ -156,7 +156,7 @@ export class MockSdkProvider extends SdkProvider {
   public defaultAccount(): Promise<Account | undefined> {
     const accountId = this.defaultAccounts.length === 0
       ? '123456789012'
-      : this.defaultAccounts.shift();
+      : this.defaultAccounts.shift()!;
     return Promise.resolve({ accountId, partition: 'aws' });
   }
 }

packages/@aws-cdk/tmp-toolkit-helpers/.projen/tasks.json

@@ -5,7 +5,7 @@ describe(SdkToCliLogger, () => {
     notify: jest.fn(),
     requestResponse: jest.fn(),
   };
-  const logger = new SdkToCliLogger(ioHost);
+  const logger = new SdkToCliLogger(ioHost as any);
 
   beforeEach(() => {
     ioHost.notify.mockReset();

packages/@aws-cdk/tmp-toolkit-helpers/src/context-providers/security-groups.ts

@@ -24,7 +24,7 @@ import { AwsCliCompatible } from '../../../lib/api/aws-auth';
 import { defaultCliUserAgent } from '../../../lib/api/aws-auth';
 import { PluginHost } from '../../../lib/api/plugin';
 import { Mode } from '../../../lib/api/plugin';
-import { instanceMockFrom, withMocked } from '../../_helpers/as-mock';
+import { withMocked } from '../../_helpers/as-mock';
 import { undoAllSdkMocks } from '../../_helpers/mock-sdk';
 import { TestIoHost } from '../../_helpers/io-host';
 

packages/@aws-cdk/tmp-toolkit-helpers/test/_helpers/jest-bufferedconsole.ts

@@ -17,6 +17,7 @@ const createEvaluateCloudFormationTemplate = (template: Template) =>
     region: 'ap-south-east-2',
     partition: 'aws',
     sdk,
+    stackArtifact: {} as any,
   });
 
 describe('evaluateCfnExpression', () => {

packages/@aws-cdk/tmp-toolkit-helpers/test/api/diff/diff.test.ts

@@ -135,7 +135,7 @@ describe.each([HotswapMode.FALL_BACK, HotswapMode.HOTSWAP_ONLY])('%p mode', (hot
       // GIVEN
       const body = getBodyStream('template defined in s3');
       mockS3Client.on(GetObjectCommand).resolves({
-        Body: body,
+        Body: body as any,
       });
       setup.setCurrentCfnStackTemplate({
         Resources: {
@@ -212,7 +212,7 @@ describe.each([HotswapMode.FALL_BACK, HotswapMode.HOTSWAP_ONLY])('%p mode', (hot
       // GIVEN
       const body = getBodyStream('code defined in s3');
       mockS3Client.on(GetObjectCommand).resolves({
-        Body: body,
+        Body: body as any,
       });
       setup.setCurrentCfnStackTemplate({
         Resources: {
@@ -731,7 +731,7 @@ describe.each([HotswapMode.FALL_BACK, HotswapMode.HOTSWAP_ONLY])('%p mode', (hot
     async () => {
       // GIVEN
       mockS3Client.on(GetObjectCommand).resolves({
-        Body: getBodyStream('template defined in s3'),
+        Body: getBodyStream('template defined in s3') as any,
       });
       mockAppSyncClient
         .on(ListFunctionsCommand)
@@ -1269,7 +1269,7 @@ describe.each([HotswapMode.FALL_BACK, HotswapMode.HOTSWAP_ONLY])('%p mode', (hot
     async () => {
       // GIVEN
       mockS3Client.on(GetObjectCommand).resolves({
-        Body: getBodyStream('schema defined in s3'),
+        Body: getBodyStream('schema defined in s3') as any,
       });
       setup.setCurrentCfnStackTemplate({
         Resources: {