fix tests

Author: mrgrain

packages/@aws-cdk/toolkit-lib/lib/toolkit/toolkit.ts

@@ -155,7 +155,7 @@ export class Toolkit extends CloudAssemblySourceBuilder implements AsyncDisposab
     const bootstrapEnvironments = await environments.getEnvironments();
     const source = options.source ?? BootstrapSource.default();
     const parameters = options.parameters;
-    const bootstrapper = new Bootstrapper(source, { ioHost: ioHelper, action: 'bootstrap' });
+    const bootstrapper = new Bootstrapper(source, ioHelper);
     const sdkProvider = await this.sdkProvider('bootstrap');
     const limit = pLimit(20);
 
@@ -281,7 +281,7 @@ export class Toolkit extends CloudAssemblySourceBuilder implements AsyncDisposab
     }
 
     const deployments = await this.deploymentsForAction('deploy');
-    const migrator = new ResourceMigrator({ deployments, ioHost: ioHelper, action });
+    const migrator = new ResourceMigrator({ deployments, ioHelper });
 
     await migrator.tryMigrateResources(stackCollection, options);
 
@@ -511,7 +511,7 @@ export class Toolkit extends CloudAssemblySourceBuilder implements AsyncDisposab
         if (options.traceLogs) {
           // deploy calls that originate from watch will come with their own cloudWatchLogMonitor
           const cloudWatchLogMonitor = options.cloudWatchLogMonitor ?? new CloudWatchLogEventMonitor();
-          const foundLogGroupsResult = await findCloudWatchLogGroups(await this.sdkProvider('deploy'), { ioHost: ioHelper, action }, stack);
+          const foundLogGroupsResult = await findCloudWatchLogGroups(await this.sdkProvider('deploy'), ioHelper, stack);
           cloudWatchLogMonitor.addLogGroups(
             foundLogGroupsResult.env,
             foundLogGroupsResult.sdk,
@@ -543,7 +543,7 @@ export class Toolkit extends CloudAssemblySourceBuilder implements AsyncDisposab
       stack,
       ...stack.dependencies.filter(x => cxapi.AssetManifestArtifact.isAssetManifestArtifact(x)),
     ]);
-    const workGraph = new WorkGraphBuilder({ ioHost: ioHelper, action }, prebuildAssets).build(stacksAndTheirAssetManifests);
+    const workGraph = new WorkGraphBuilder(ioHelper, prebuildAssets).build(stacksAndTheirAssetManifests);
 
     // Unless we are running with '--force', skip already published assets
     if (!options.force) {

packages/aws-cdk/lib/api/work-graph/work-graph-builder.ts

@@ -29,7 +29,7 @@ export class WorkGraphBuilder {
     private readonly prebuildAssets: boolean,
     private readonly idPrefix = '',
   ) {
-    this.graph = new WorkGraph({}, { ioHelper });
+    this.graph = new WorkGraph({}, ioHelper);
     this.ioHelper = ioHelper;
   }
 

packages/aws-cdk/lib/api/work-graph/work-graph.ts

@@ -6,10 +6,6 @@ import { parallelPromises } from '../../util';
 
 export type Concurrency = number | Record<WorkNode['type'], number>;
 
-export interface WorkGraphProps {
-  ioHelper: IoHelper;
-}
-
 export class WorkGraph {
   public readonly nodes: Record<string, WorkNode>;
   private readonly readyPool: Array<WorkNode> = [];
@@ -18,9 +14,9 @@ export class WorkGraph {
 
   public error?: Error;
 
-  public constructor(nodes: Record<string, WorkNode>, props: WorkGraphProps) {
+  public constructor(nodes: Record<string, WorkNode>, ioHelper: IoHelper) {
     this.nodes = { ...nodes };
-    this.ioHelper = props.ioHelper;
+    this.ioHelper = ioHelper;
   }
 
   public addNodes(...nodes: WorkNode[]) {

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

@@ -0,0 +1,30 @@
+import { IIoHost, IoMessage, IoMessageLevel, IoRequest } from "../../../@aws-cdk/tmp-toolkit-helpers/src/api/io";
+import { isMessageRelevantForLevel } from "../../../@aws-cdk/tmp-toolkit-helpers/src/api/io/private";
+
+/**
+ * A test implementation of IIoHost that does nothing but can by spied on.
+ * Optionally set a level to filter out all irrelevant messages.
+ * Optionally set a approval level.
+ */
+export class TestIoHost implements IIoHost {
+  public readonly notifySpy: jest.Mock<any, any, any>;
+  public readonly requestSpy: jest.Mock<any, any, any>;
+
+  constructor(public level: IoMessageLevel = 'info') {
+    this.notifySpy = jest.fn();
+    this.requestSpy = jest.fn();
+  }
+
+  public async notify<T>(msg: IoMessage<T>): Promise<void> {
+    if (isMessageRelevantForLevel(msg, this.level)) {
+      this.notifySpy(msg);
+    }
+  }
+
+  public async requestResponse<T, U>(msg: IoRequest<T, U>): Promise<U> {
+    if (isMessageRelevantForLevel(msg, this.level)) {
+      this.requestSpy(msg);
+    }
+    return msg.defaultResponse;
+  }
+}

packages/aws-cdk/test/api/_helpers/hotswap-test-setup.ts

@@ -14,6 +14,8 @@ import {
   setDefaultSTSMocks,
 } from '../../util/mock-sdk';
 import { FakeCloudformationStack } from './fake-cloudformation-stack';
+import { TestIoHost } from '../../_helpers/test-io-host';
+import { asIoHelper } from '../../../../@aws-cdk/tmp-toolkit-helpers/src/api/io/private';
 
 const STACK_NAME = 'withouterrors';
 export const STACK_ID = 'stackId';
@@ -23,11 +25,7 @@ let currentCfnStack: FakeCloudformationStack;
 const currentCfnStackResources: StackResourceSummary[] = [];
 let stackTemplates: { [stackName: string]: any };
 let currentNestedCfnStackResources: { [stackName: string]: StackResourceSummary[] };
-
-let mockMsg: IoMessaging = {
-  ioHost: CliIoHost.instance(),
-  action: 'deploy',
-};
+let ioHost = new TestIoHost();
 
 export function setupHotswapTests(): HotswapMockSdkProvider {
   restoreSdkMocksToDefault();
@@ -148,6 +146,6 @@ export class HotswapMockSdkProvider extends MockSdkProvider {
     hotswapPropertyOverrides?: HotswapPropertyOverrides,
   ): Promise<SuccessfulDeployStackResult | undefined> {
     let hotswapProps = hotswapPropertyOverrides || new HotswapPropertyOverrides();
-    return deployments.tryHotswapDeployment(this, mockMsg, assetParams, currentCfnStack, stackArtifact, hotswapMode, hotswapProps);
+    return deployments.tryHotswapDeployment(this, asIoHelper(ioHost, 'deploy'), assetParams, currentCfnStack, stackArtifact, hotswapMode, hotswapProps);
   }
 }

packages/aws-cdk/test/api/bootstrap/bootstrap.test.ts

@@ -13,8 +13,9 @@ import { parse } from 'yaml';
 import { Bootstrapper } from '../../../lib/api/bootstrap';
 import { legacyBootstrapTemplate } from '../../../lib/api/bootstrap/legacy-template';
 import { deserializeStructure, serializeStructure, toYAML } from '../../../lib/util';
-import { CliIoHost } from '../../../lib/toolkit/cli-io-host';
 import { MockSdkProvider, mockCloudFormationClient, restoreSdkMocksToDefault } from '../../util/mock-sdk';
+import { TestIoHost } from '../../_helpers/test-io-host';
+import { asIoHelper } from '../../../../@aws-cdk/tmp-toolkit-helpers/src/api/io/private';
 
 const env = {
   account: '123456789012',
@@ -31,9 +32,12 @@ jest.mock('../../../lib/api/deployments/checks', () => ({
 let sdk: MockSdkProvider;
 let changeSetTemplate: any | undefined;
 let bootstrapper: Bootstrapper;
+let ioHost = new TestIoHost();
+let ioHelper = asIoHelper(ioHost, 'bootstrap');
+
 beforeEach(() => {
   sdk = new MockSdkProvider();
-  bootstrapper = new Bootstrapper({ source: 'legacy' }, { ioHost: CliIoHost.instance(), action: 'bootstrap' });
+  bootstrapper = new Bootstrapper({ source: 'legacy' }, ioHelper);
   mockCloudFormationClient.reset();
   restoreSdkMocksToDefault();
   // First two calls, no stacks exist (first is for version checking, second is in deploy-stack.ts)

packages/aws-cdk/test/api/bootstrap/bootstrap2.test.ts

@@ -10,16 +10,28 @@ import {
   MockSdkProvider,
   restoreSdkMocksToDefault, setDefaultSTSMocks,
 } from '../../util/mock-sdk';
-import { CliIoHost } from '../../../lib/toolkit/cli-io-host';
+import { IIoHost } from '../../../lib/toolkit/cli-io-host';
+import { asIoHelper } from '../../../../@aws-cdk/tmp-toolkit-helpers/src/api/io/private';
 
 const mockDeployStack = jest.spyOn(deployStack, 'deployStack');
 
 let bootstrapper: Bootstrapper;
 let stderrMock: jest.SpyInstance;
+let ioHost: IIoHost = {
+  notify: jest.fn().mockImplementation((msg) => {
+    process.stderr.write(msg.message + '\n');
+  }),
+  requestResponse: jest.fn().mockImplementation((msg) => {
+    process.stderr.write(msg.message + '\n');
+    return msg.defaultResponses
+  }),
+};
+let ioHelper = asIoHelper(ioHost, 'bootstrap');
 
 beforeEach(() => {
-  CliIoHost.instance().isCI = false;
-  bootstrapper = new Bootstrapper({ source: 'default' }, { ioHost: CliIoHost.instance(), action: 'bootstrap' });
+  jest.mocked(ioHost.notify).mockClear();
+  jest.mocked(ioHost.requestResponse).mockClear();
+  bootstrapper = new Bootstrapper({ source: 'default' }, ioHelper);
   stderrMock = jest.spyOn(process.stderr, 'write').mockImplementation(() => {
     return true;
   });

packages/aws-cdk/test/api/deployments/assets.test.ts

@@ -6,20 +6,25 @@ import { AssetManifestBuilder } from '../../../lib/api/deployments';
 import { EnvironmentResources, EnvironmentResourcesRegistry } from '../../../lib/api/environment';
 import { MockSdk } from '../../util/mock-sdk';
 import { MockToolkitInfo } from '../../util/mock-toolkitinfo';
-import { CliIoHost, IoMessaging } from '../../../lib/toolkit/cli-io-host';
+import { TestIoHost } from '../../_helpers/test-io-host';
+import { asIoHelper } from '../../../../@aws-cdk/tmp-toolkit-helpers/src/api/io/private';
 
 let assets: AssetManifestBuilder;
 let envRegistry: EnvironmentResourcesRegistry;
 let envResources: EnvironmentResources;
 let toolkitMock: ReturnType<typeof MockToolkitInfo.setup>;
-let mockMsg: IoMessaging = { ioHost: CliIoHost.instance(), action: 'deploy' };
+let ioHost = new TestIoHost();
+let ioHelper = asIoHelper(ioHost, 'deploy');
 
 beforeEach(() => {
+  ioHost.notifySpy.mockClear();
+  ioHost.requestSpy.mockClear();
+
   assets = new AssetManifestBuilder();
   envRegistry = new EnvironmentResourcesRegistry();
 
   const sdk = new MockSdk();
-  envResources = envRegistry.for({ account: '11111111', region: 'us-nowhere', name: 'aws://11111111/us-nowhere' }, sdk, mockMsg);
+  envResources = envRegistry.for({ account: '11111111', region: 'us-nowhere', name: 'aws://11111111/us-nowhere' }, sdk, ioHelper);
   toolkitMock = MockToolkitInfo.setup();
 });
 
@@ -44,7 +49,7 @@ describe('file assets', () => {
     ]);
 
     // WHEN
-    const params = await addMetadataAssetsToManifest(mockMsg, stack, assets, envResources);
+    const params = await addMetadataAssetsToManifest(ioHelper, stack, assets, envResources);
 
     // THEN
     expect(params).toEqual({
@@ -83,7 +88,7 @@ describe('file assets', () => {
     ]);
 
     // WHEN
-    await addMetadataAssetsToManifest(mockMsg, stack, assets, envResources);
+    await addMetadataAssetsToManifest(ioHelper, stack, assets, envResources);
 
     // THEN
     expect(assets.toManifest('.').entries).toEqual([
@@ -111,7 +116,7 @@ describe('file assets', () => {
     ]);
 
     // WHEN
-    const params = await addMetadataAssetsToManifest(mockMsg, stack, assets, envResources, ['SomeStackSomeResource4567']);
+    const params = await addMetadataAssetsToManifest(ioHelper, stack, assets, envResources, ['SomeStackSomeResource4567']);
 
     // THEN
     expect(params).toEqual({
@@ -137,7 +142,7 @@ describe('docker assets', () => {
       mockFn(envResources.prepareEcrRepository).mockResolvedValue({ repositoryUri: 'docker.uri' });
 
       // WHEN
-      const params = await addMetadataAssetsToManifest(mockMsg, stack, assets, envResources);
+      const params = await addMetadataAssetsToManifest(ioHelper, stack, assets, envResources);
 
       // THEN
       expect(envResources.prepareEcrRepository).toHaveBeenCalledWith('cdk/stack-construct-abc123');
@@ -170,7 +175,7 @@ describe('docker assets', () => {
       },
     ]);
 
-    await expect(addMetadataAssetsToManifest(mockMsg, stack, assets, envResources)).rejects.toThrow('Invalid Docker image asset');
+    await expect(addMetadataAssetsToManifest(ioHelper, stack, assets, envResources)).rejects.toThrow('Invalid Docker image asset');
   });
 
   test('no parameter and repo/tag name (new)', async () => {
@@ -189,7 +194,7 @@ describe('docker assets', () => {
       mockFn(envResources.prepareEcrRepository).mockResolvedValue({ repositoryUri: 'docker.uri' });
 
       // WHEN
-      const params = await addMetadataAssetsToManifest(mockMsg, stack, assets, envResources);
+      const params = await addMetadataAssetsToManifest(ioHelper, stack, assets, envResources);
 
       // THEN
       expect(envResources.prepareEcrRepository).toHaveBeenCalledWith('reponame');
@@ -222,7 +227,7 @@ describe('docker assets', () => {
     ]);
 
     // WHEN
-    const params = await addMetadataAssetsToManifest(mockMsg, stack, assets, envResources, ['SomeStackSomeResource4567']);
+    const params = await addMetadataAssetsToManifest(ioHelper, stack, assets, envResources, ['SomeStackSomeResource4567']);
 
     // THEN
     expect(params).toEqual({

packages/aws-cdk/test/api/deployments/checks.test.ts

@@ -1,12 +1,10 @@
 import { DescribeStacksCommand, StackStatus } from '@aws-sdk/client-cloudformation';
 import { determineAllowCrossAccountAssetPublishing, getBootstrapStackInfo } from '../../../lib/api/deployments/checks';
-import { CliIoHost, IoMessaging } from '../../../lib/toolkit/cli-io-host';
 import { mockCloudFormationClient, MockSdk } from '../../util/mock-sdk';
+import { TestIoHost } from '../../_helpers/test-io-host';
+import { asIoHelper } from '../../../../@aws-cdk/tmp-toolkit-helpers/src/api/io/private';
 
-let mockMsg: IoMessaging = {
-  ioHost: CliIoHost.instance(),
-  action: 'deploy',
-};
+let ioHelper = asIoHelper(new TestIoHost(), 'deploy');
 
 describe('determineAllowCrossAccountAssetPublishing', () => {
   it('should return true when hasStagingBucket is false', async () => {
@@ -20,7 +18,7 @@ describe('determineAllowCrossAccountAssetPublishing', () => {
       }],
     });
 
-    const result = await determineAllowCrossAccountAssetPublishing(mockSDK, mockMsg);
+    const result = await determineAllowCrossAccountAssetPublishing(mockSDK, ioHelper);
     expect(result).toBe(true);
   });
 
@@ -38,7 +36,7 @@ describe('determineAllowCrossAccountAssetPublishing', () => {
       }],
     });
 
-    const result = await determineAllowCrossAccountAssetPublishing(mockSDK, mockMsg);
+    const result = await determineAllowCrossAccountAssetPublishing(mockSDK, ioHelper);
     expect(result).toBe(true);
   });
 
@@ -57,23 +55,23 @@ describe('determineAllowCrossAccountAssetPublishing', () => {
       }],
     });
 
-    const result = await determineAllowCrossAccountAssetPublishing(mockSDK, mockMsg);
+    const result = await determineAllowCrossAccountAssetPublishing(mockSDK, ioHelper);
     expect(result).toBe(true);
   });
 
   it('should return true if looking up the bootstrap stack fails', async () => {
     const mockSDK = new MockSdk();
     mockCloudFormationClient.on(DescribeStacksCommand).rejects(new Error('Could not read bootstrap stack'));
 
-    const result = await determineAllowCrossAccountAssetPublishing(mockSDK, mockMsg);
+    const result = await determineAllowCrossAccountAssetPublishing(mockSDK, ioHelper);
     expect(result).toBe(true);
   });
 
   it('should return true if looking up the bootstrap stack fails', async () => {
     const mockSDK = new MockSdk();
     mockCloudFormationClient.on(DescribeStacksCommand).rejects(new Error('Could not read bootstrap stack'));
 
-    const result = await determineAllowCrossAccountAssetPublishing(mockSDK, mockMsg);
+    const result = await determineAllowCrossAccountAssetPublishing(mockSDK, ioHelper);
     expect(result).toBe(true);
   });
 
@@ -91,7 +89,7 @@ describe('determineAllowCrossAccountAssetPublishing', () => {
       }],
     });
 
-    const result = await determineAllowCrossAccountAssetPublishing(mockSDK, mockMsg);
+    const result = await determineAllowCrossAccountAssetPublishing(mockSDK, ioHelper);
     expect(result).toBe(false);
   });
 });

packages/aws-cdk/test/api/deployments/cloudformation-deployments.test.ts

@@ -16,7 +16,6 @@ import { CloudFormationStack, createChangeSet, Deployments } from '../../../lib/
 import { deployStack } from '../../../lib/api/deployments/deploy-stack';
 import { HotswapMode } from '../../../lib/api/hotswap/common';
 import { ToolkitInfo } from '../../../lib/api/toolkit-info';
-import { CliIoHost } from '../../../lib/toolkit/cli-io-host';
 import { testStack } from '../../util';
 import {
   mockBootstrapStack,
@@ -28,6 +27,8 @@ import {
   setDefaultSTSMocks,
 } from '../../util/mock-sdk';
 import { FakeCloudformationStack } from '../_helpers/fake-cloudformation-stack';
+import { TestIoHost } from '../../_helpers/test-io-host';
+import { asIoHelper } from '../../../../@aws-cdk/tmp-toolkit-helpers/src/api/io/private';
 
 jest.mock('../../../lib/api/deployments/deploy-stack');
 jest.mock('../../../lib/api/deployments/asset-publishing');
@@ -37,11 +38,16 @@ let sdk: MockSdk;
 let deployments: Deployments;
 let mockToolkitInfoLookup: jest.Mock;
 let currentCfnStackResources: { [key: string]: StackResourceSummary[] };
+let ioHost = new TestIoHost();
+let ioHelper = asIoHelper(ioHost, 'deploy');
+
 beforeEach(() => {
   jest.resetAllMocks();
   sdkProvider = new MockSdkProvider();
   sdk = new MockSdk();
-  deployments = new Deployments({ sdkProvider, ioHost: CliIoHost.instance(), action: 'deploy' });
+  ioHost.notifySpy.mockClear();
+  ioHost.requestSpy.mockClear();
+  deployments = new Deployments({ sdkProvider, ioHelper });
 
   currentCfnStackResources = {};
   restoreSdkMocksToDefault();
@@ -1151,7 +1157,7 @@ test('tags are passed along to create change set', async () => {
   }
 
   await createChangeSet(
-    { ioHost: CliIoHost.instance(), action: 'deploy' },
+    ioHelper,
     {
       stack: stack,
       cfn: new MockSdk().cloudFormation(),