chore(cli): lint test files (#441)

These were previously ignored, presumingly because they did not follow
most of our linting rules. However now a lot less tests are in the CLI
package (most moved to toolkit-lib) so we can safely re-enable linting
of test files.

Added `'@typescript-eslint/unbound-method': 'off'` for test files, since
there were many violations of this and it doesn't seem necessary to
enforce this rule in test code.

Most test code changes are automated. I've annotated the few manual
fixes I made.

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

Author: mrgrain

.projenrc.ts

@@ -1002,6 +1002,8 @@ const cli = configureProject(
       '@types/sinon',
       '@types/yargs@^15',
       'aws-cdk-lib',
+      'aws-sdk-client-mock',
+      'aws-sdk-client-mock-jest',
       'axios',
       'constructs',
       'fast-check',
@@ -1097,7 +1099,7 @@ const cli = configureProject(
     },
     eslintOptions: {
       dirs: ['lib'],
-      ignorePatterns: ['*.template.ts', '*.d.ts', 'test/**/*.ts'],
+      ignorePatterns: ['*.template.ts', '*.d.ts'],
     },
     jestOptions: jestOptionsForProject({
       jestConfig: {
@@ -1144,6 +1146,7 @@ cli.eslint?.addOverride({
   files: ['./test/**'],
   rules: {
     '@cdklabs/no-throw-default-error': 'off',
+    '@typescript-eslint/unbound-method': 'off',
   },
 });
 

packages/aws-cdk/.eslintrc.json

@@ -3,12 +3,12 @@ import * as path from 'path';
 import { ArtifactMetadataEntryType, ArtifactType, type AssetManifest, type AssetMetadataEntry, type AwsCloudFormationStackProperties, type MetadataEntry, type MissingContext } from '@aws-cdk/cloud-assembly-schema';
 import { type CloudAssembly, CloudAssemblyBuilder, type CloudFormationStackArtifact, type StackMetadata } from '@aws-cdk/cx-api';
 import { cxapiAssemblyWithForcedVersion } from './assembly-versions';
-import { MockSdkProvider } from '../_helpers/mock-sdk';
-import { CloudExecutable } from '../../lib/cxapp/cloud-executable';
-import { Configuration } from '../../lib/cli/user-configuration';
 import { TestIoHost } from './io-host';
-import { IIoHost } from '../../lib/cli/io-host';
 import { asIoHelper } from '../../../@aws-cdk/toolkit-lib/lib/api/io/private';
+import type { IIoHost } from '../../lib/cli/io-host';
+import { Configuration } from '../../lib/cli/user-configuration';
+import { CloudExecutable } from '../../lib/cxapp/cloud-executable';
+import { MockSdkProvider } from '../_helpers/mock-sdk';
 
 export const DEFAULT_FAKE_TEMPLATE = { No: 'Resources' };
 
@@ -47,7 +47,7 @@ export class MockCloudExecutable extends CloudExecutable {
     const configuration = new Configuration();
     const sdkProvider = sdkProviderArg ?? new MockSdkProvider();
     const mockIoHost = ioHost ?? new TestIoHost();
-    
+
     super({
       configuration,
       sdkProvider,

packages/aws-cdk/.projen/deps.json

@@ -1,4 +1,4 @@
-import { IIoHost, IoMessage, IoMessageLevel, IoRequest } from "../../../@aws-cdk/toolkit-lib/lib/api/io";
+import type { IIoHost, IoMessage, IoMessageLevel, IoRequest } from '../../../@aws-cdk/toolkit-lib/lib/api/io';
 
 /**
  * An implementation of `IIoHost` that records messages and lets you assert on what was logged

packages/aws-cdk/.projen/tasks.json

@@ -3,7 +3,7 @@
  * A Jest environment that buffers outputs to `console.log()` and only shows it for failing tests.
  */
 import type { EnvironmentContext, JestEnvironment, JestEnvironmentConfig } from '@jest/environment';
-import { Circus } from '@jest/types';
+import type { Circus } from '@jest/types';
 import { TestEnvironment as NodeEnvironment } from 'jest-environment-node';
 
 interface ConsoleMessage {

packages/aws-cdk/package.json

@@ -63,7 +63,9 @@ afterAll(async () => {
     await new Promise<void>((resolve, reject) => {
       const response = aft(resolve as any);
       if (isPromise(response)) {
-        response.then(() => { return resolve(); }, reject);
+        response.then(() => {
+          return resolve();
+        }, reject);
       } else {
         resolve();
       }

packages/aws-cdk/test/_helpers/assembly.ts

@@ -1,8 +1,9 @@
 import 'aws-sdk-client-mock-jest';
-import { Environment } from '@aws-cdk/cx-api';
+import type { Environment } from '@aws-cdk/cx-api';
 import { AppSyncClient } from '@aws-sdk/client-appsync';
 import { CloudControlClient } from '@aws-sdk/client-cloudcontrol';
-import { CloudFormationClient, Stack, StackStatus } from '@aws-sdk/client-cloudformation';
+import type { Stack } from '@aws-sdk/client-cloudformation';
+import { CloudFormationClient, StackStatus } from '@aws-sdk/client-cloudformation';
 import { CloudWatchLogsClient } from '@aws-sdk/client-cloudwatch-logs';
 import { CodeBuildClient } from '@aws-sdk/client-codebuild';
 import { EC2Client } from '@aws-sdk/client-ec2';
@@ -19,12 +20,12 @@ import { SFNClient } from '@aws-sdk/client-sfn';
 import { SSMClient } from '@aws-sdk/client-ssm';
 import { AssumeRoleCommand, GetCallerIdentityCommand, STSClient } from '@aws-sdk/client-sts';
 import { createCredentialChain } from '@aws-sdk/credential-providers';
-import { AwsCredentialIdentity } from '@smithy/types';
+import type { AwsCredentialIdentity } from '@smithy/types';
 import { mockClient } from 'aws-sdk-client-mock';
 import { type Account } from 'cdk-assets';
+import { TestIoHost } from './io-host';
 import { SDK, SdkProvider } from '../../lib/api/aws-auth';
 import { CloudFormationStack } from '../../lib/api/cloudformation';
-import { TestIoHost } from './io-host';
 
 export const FAKE_CREDENTIALS: AwsCredentialIdentity = {
   accessKeyId: 'ACCESS',
@@ -98,7 +99,7 @@ export const restoreSdkMocksToDefault = () => {
  */
 export function undoAllSdkMocks() {
   applyToAllMocks('restore');
-};
+}
 
 function applyToAllMocks(meth: 'reset' | 'restore') {
   mockAppSyncClient[meth]();

packages/aws-cdk/test/_helpers/fake-io-host.ts

@@ -1,6 +1,6 @@
 /* eslint-disable import/order */
 import { ToolkitInfo, DEFAULT_BOOTSTRAP_VARIANT } from '../../lib/api';
-import { CloudFormationStack } from '../../lib/api/cloudformation';
+import type { CloudFormationStack } from '../../lib/api/cloudformation';
 
 export interface MockToolkitInfoProps {
   readonly bucketName?: string;

packages/aws-cdk/test/_helpers/jest-bufferedconsole.ts

@@ -18,8 +18,8 @@ const fakeChokidarWatcherOn = {
   },
 
   get fileEventCallback(): (
-    event: 'add' | 'addDir' | 'change' | 'unlink' | 'unlinkDir',
-    path: string,
+  event: 'add' | 'addDir' | 'change' | 'unlink' | 'unlinkDir',
+  path: string,
   ) => Promise<void> {
     expect(mockChokidarWatcherOn.mock.calls.length).toBeGreaterThanOrEqual(2);
     const secondCall = mockChokidarWatcherOn.mock.calls[1];
@@ -60,46 +60,49 @@ jest.setTimeout(30_000);
 import 'aws-sdk-client-mock';
 import * as os from 'os';
 import * as path from 'path';
-import * as cdkAssets from 'cdk-assets';
 import * as cxschema from '@aws-cdk/cloud-assembly-schema';
 import { Manifest } from '@aws-cdk/cloud-assembly-schema';
 import * as cxapi from '@aws-cdk/cx-api';
+import type { DestroyStackResult } from '@aws-cdk/toolkit-lib/lib/api/deployments/deploy-stack';
 import { DescribeStacksCommand, GetTemplateCommand, StackStatus } from '@aws-sdk/client-cloudformation';
 import { GetParameterCommand } from '@aws-sdk/client-ssm';
+import * as cdkAssets from 'cdk-assets';
 import * as fs from 'fs-extra';
 import * as promptly from 'promptly';
-import { SdkProvider } from '../../lib/api';
+import type { Template } from '../../../@aws-cdk/toolkit-lib/lib/api';
+import { asIoHelper } from '../../../@aws-cdk/toolkit-lib/lib/api/io/private';
+import type { SdkProvider } from '../../lib/api';
 import { Bootstrapper, type BootstrapSource } from '../../lib/api/bootstrap';
-import {
+import type {
   DeployStackResult,
   SuccessfulDeployStackResult,
-  Deployments,
   DeployStackOptions,
   DestroyStackOptions,
   RollbackStackOptions,
   RollbackStackResult,
 } from '../../lib/api/deployments';
+import {
+  Deployments,
+} from '../../lib/api/deployments';
 import { HotswapMode } from '../../lib/api/hotswap';
 import { Mode } from '../../lib/api/plugin';
-import { Tag } from '../../lib/api/tags';
+import type { Tag } from '../../lib/api/tags';
 import { CdkToolkit, markTesting } from '../../lib/cli/cdk-toolkit';
+import { CliIoHost } from '../../lib/cli/io-host';
 import { Configuration } from '../../lib/cli/user-configuration';
+import { StackActivityProgress } from '../../lib/commands/deploy';
 import { RequireApproval } from '../../lib/commands/diff';
-import { CliIoHost } from '../../lib/cli/io-host';
 import { flatten } from '../../lib/util';
-import { MockCloudExecutable, TestStackArtifact } from '../_helpers/assembly';
 import { instanceMockFrom } from '../_helpers/as-mock';
+import type { TestStackArtifact } from '../_helpers/assembly';
+import { MockCloudExecutable } from '../_helpers/assembly';
 import {
   mockCloudFormationClient,
   MockSdk,
   MockSdkProvider,
   mockSSMClient,
   restoreSdkMocksToDefault,
 } from '../_helpers/mock-sdk';
-import { asIoHelper } from '../../../@aws-cdk/toolkit-lib/lib/api/io/private';
-import { StackActivityProgress } from '../../lib/commands/deploy';
-import { Template } from '../../../@aws-cdk/toolkit-lib/lib/api';
-import { DestroyStackResult } from '@aws-cdk/toolkit-lib/lib/api/deployments/deploy-stack';
 
 markTesting();
 
@@ -154,7 +157,6 @@ function defaultToolkitSetup() {
 
 const mockSdk = new MockSdk();
 
-
 describe('bootstrap', () => {
   test('accepts qualifier from context', async () => {
     // GIVEN
@@ -276,6 +278,7 @@ describe('deploy', () => {
         deployments: new FakeCloudFormation({}),
       });
       stderrMock.mockImplementation((...x) => {
+        // eslint-disable-next-line no-console
         console.error(...x);
       });
 
@@ -1034,8 +1037,8 @@ describe('deploy', () => {
 
     await toolkit.deploy({
       progress: StackActivityProgress.EVENTS,
-      selector: { patterns: ["**"] },
-      hotswap: HotswapMode.FALL_BACK
+      selector: { patterns: ['**'] },
+      hotswap: HotswapMode.FALL_BACK,
     });
 
     // now expect it to be updated
@@ -1556,7 +1559,6 @@ describe('migrate', () => {
 });
 
 describe('rollback', () => {
-
   test('rollback uses deployment role', async () => {
     cloudExecutable = new MockCloudExecutable({
       stacks: [MockStack.MOCK_STACK_C],

packages/aws-cdk/test/_helpers/jest-setup-after-env.ts

@@ -29,7 +29,7 @@ describe('doctor', () => {
     await exec(['doctor']);
     expect(logging.info).toHaveBeenCalledWith(expect.stringContaining('CDK Version:'));
   });
-})
+});
 
 describe('docs', () => {
   test('prints docs url version', async () => {

packages/aws-cdk/test/_helpers/mock-sdk.ts

@@ -1,5 +1,5 @@
-import { debug, error, info, success, warning } from '../../../lib/logging';
 import { CliIoHost } from '../../../lib/cli/io-host';
+import { debug, error, info, success, warning } from '../../../lib/logging';
 
 const ioHost = CliIoHost.instance({}, true);
 let mockStderr: jest.Mock;

packages/aws-cdk/test/_helpers/mock-toolkitinfo.ts

@@ -1,7 +1,8 @@
 import { PassThrough } from 'stream';
-import * as chalk from 'chalk';
-import { CliIoHost, IoMessage, IoMessageLevel, IoRequest } from '../../../lib/cli/io-host';
 import { RequireApproval } from '@aws-cdk/cloud-assembly-schema';
+import * as chalk from 'chalk';
+import type { IoMessage, IoMessageLevel, IoRequest } from '../../../lib/cli/io-host';
+import { CliIoHost } from '../../../lib/cli/io-host';
 
 let passThrough: PassThrough;
 
@@ -429,7 +430,7 @@ describe('CliIoHost', () => {
       });
 
       test('require approval by default - respond no', async () => {
-        expect(() => requestResponse('n', plainMessage({
+        await expect(() => requestResponse('n', plainMessage({
           time: new Date(),
           level: 'info',
           action: 'synth',