(integ-tests): Can't make two awsApiCall for the same service and api in a given context

[dontirun]

Describe the bug

While fumbling around with integration tests I received the following error

Error: There is already a Construct with name 'AwsApiCallRedshiftdescribeClusters' in Stack [DeployAssert]

I believe this is because I had two calls for the same service and api

Expected Behavior

I can make two calls to the same service API combo

Current Behavior

I can't make two calls to the same service API combo

Reproduction Steps

import * as integ from '@aws-cdk/integ-tests';
import * as cdk from '@aws-cdk/core';

const app = new cdk.App();
const stack = new cdk.Stack(app, 'aws-cdk-redshift-cluster-database');


const test = new integ.IntegTest(app, 'aws-cdk-redshift-reboot-test', {
  testCases: [stack],
  stackUpdateWorkflow: true,
  diffAssets: true,
});


const describe = test.assertions.awsApiCall('Redshift', 'describeClusters', {
  ClusterIdentifier: cluster.clusterName,
});

const describe2 = test.assertions.awsApiCall('Redshift', 'describeClusters', {
  ClusterIdentifier: cluster.clusterName,
});

Possible Solution

aws-cdk/packages/@aws-cdk/integ-tests/lib/assertions/private/deploy-assert.ts

Line 53 in 1f03e8c

return new AwsApiCall(this.scope, `AwsApiCall${service}${api}`, {

Maybe something like this?

  private static serviceAPICounter = new Map<string, number>();

...

  public awsApiCall(service: string, api: string, parameters?: any): IAwsApiCall {
    let combo = `AwsApiCall${service}${api}`
    const count = (DeployAssert.serviceAPICounter.get(combo) ?? 0) + 1
    DeployAssert.serviceAPICounter.set(combo, count)
    return new AwsApiCall(this.scope, `${combo}${count}`, {
      api,
      service,
      parameters,
    });
  }

Additional Information/Context

No response

CDK CLI Version

2.41.0

Framework Version

No response

Node.js Version

v16.16.0

OS

OsX

Language

Typescript

Language Version

No response

Other information

No response

[peterwoodworth]

Thanks for the report @dontirun,

We could either change how the logical id is built altogether (which would change the logical id for existing instances so we'd likely need a feature flag), or what's more preferable is to somehow detect if the same API call has already been used, and then adjusting the logical ID from there if that's the case. However I'm not sure how feasible the latter is without looking more into it

[misterjoshua]

While not generally advisable, I'm working around this right now by importing from DeployAssert:

import { AwsApiCall, IntegTest } from '@aws-cdk/integ-tests-alpha';
import { DeployAssert } from '@aws-cdk/integ-tests-alpha/lib/assertions/private/deploy-assert';

// ...

declare const integTest: IntegTest;

const deployAssert = integTest.assertions;
if (!DeployAssert.isDeployAssert(deployAssert)) {
  throw new Error('Expected DeployAssert');
}

// Extract the assertion scope from the DeployAssert because upstream
// implementation fails to allow multiples of the same aws api call
// due to insufficient uniqueness in the logical ids.
const assertionScope = deployAssert.scope;

const assertion1 = new AwsApiCall(assertionScope, 'First', {
  service: 'TheService',
  api: 'theApi',
  parameters: { /* ... */ },
});

const assertion2 = new AwsApiCall(assertionScope, 'Second', {
  service: 'TheService',
  api: 'theApi',
  parameters: { /* ... */ },
});

Edit: I've proposed a backward-compatible PR, hoping to fix the issue at its root. You can find it below.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.