@aws-cdk/integ-tests-alpha:DescribeUserPool

[sankarvasudev]

Describe the bug

I am making an assertion as follows
const assertion1 = integ.assertions .awsApiCall('CognitoIdentityServiceProvider', 'describeUserPool', { UserPoolId: 'ap-southeast-1_1234567' }) .expect(ExpectedResult.objectLike({ UserPool: { Id: 'ap-southeast-1_1234567' }, }));

When I run npm run integ-test
I get the error
CREATE_FAILED | Custom::DeployAssert@SdkCallCognitoIdentityServiceProviderde | CognitoStackTest/DefaultTest/DeployAssert/AwsApiCallCognitoIdentityServiceProviderdescribeUserPool31f29c4a94406a13295f446784a03bfb/Default/Default (AwsApiCallCognitoIdentityServiceProviderdescribeUserPool31f29c4a94406a13295f446784a03bfb) Response object is too long.

Expected Behavior

The CognitoStackTestDefaultTestDeployAssert stack needs to successfully deploy.

Current Behavior

I get the error
CREATE_FAILED | Custom::DeployAssert@SdkCallCognitoIdentityServiceProviderde | CognitoStackTest/DefaultTest/DeployAssert/AwsApiCallCognitoIdentityServiceProviderdescribeUserPool31f29c4a94406a13295f446784a03bfb/Default/Default (AwsApiCallCognitoIdentityServiceProviderdescribeUserPool31f29c4a94406a13295f446784a03bfb) Response object is too long.

Reproduction Steps

Create an assertion using the following code

const assertion1 = integ.assertions .awsApiCall('CognitoIdentityServiceProvider', 'describeUserPool', { UserPoolId: 'ap-southeast-1_1234567' }) .expect(ExpectedResult.objectLike({ UserPool: { Id: 'ap-southeast-1_1234567' }, }));

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.108.0

Framework Version

No response

Node.js Version

v16.20.2

OS

Linux

Language

TypeScript

Language Version

No response

Other information

No response

[lpizzinidev]

@sankarvasudev

DescribeIUserPool output is exceeding CloudFormation custom resource output size limit of 4KB.
You can use the outputPaths parameter to filter specific fields and reduce output size:

const assertion = integ.assertions.awsApiCall('CognitoIdentityServiceProvider', 'describeUserPool', {
  UserPoolId: 'ap-southeast-1_1234567',
}, ['UserPool.Id']);
assertion.assertAtPath('UserPool.Id', ExpectedResult.stringLikeRegexp('ap-southeast-1_1234567'));

[pahud]

Thank you @lpizzinidev

[sankarvasudev]

Thank you @lpizzinidev
This helped

[lpizzinidev]

@pahud @sankarvasudev
I guess this can be closed.

[jvalore-medallia]

@lpizzinidev could you (or anyone on this thread) provide an actual example of how to use outputPaths? You mention it, but then don't use it in your example code.

Looking through the cdk source, it doesn't like it can be passed through to a Lambda invoke.

The LambdaInvokeFunction class constructor can not pass additional props to its AwsApiCall base class, which is where outputPaths appears that it needs to be set.

aws-cdk/packages/@aws-cdk/integ-tests-alpha/lib/assertions/sdk.ts

Lines 221 to 232 in b865320

	export class LambdaInvokeFunction extends AwsApiCall {
	constructor(scope: Construct, id: string, props: LambdaInvokeFunctionProps) {
	super(scope, id, {
	api: 'invoke',
	service: 'Lambda',
	parameters: {
	FunctionName: props.functionName,
	InvocationType: props.invocationType,
	LogType: props.logType,
	Payload: props.payload,
	},
	});

It also isn't a property that can be passed to assertions.invokeFunction() within a test. So I don't see where we are supposed to set it.

---

Update:

It seems assertion.assertAtPath must wire up outputPath internally? I was running into issues so didn't think it was working, but found a place in a test where I wasn't using assertion.assertAtPath because I was expecting a short enough return value, but the Lambda was returning an error message, which was blowing over the 4k limit 🤦

So this does seem to be working based on the provided example code.