integ-runner: exit code 1 despite tests passing

[graydenshand]

Describe the bug

If a change contains destructive changes, integ-runner will exit with exit code 1 with the following message:

Tests:    2 passed, 2 total
Error: Some changes were destructive!
    at main (~/.nvm/versions/node/v18.17.1/lib/node_modules/@aws-cdk/integ-runner/lib/index.js:10271:11)

This happens even when the tests pass and the --disable-update-workflow flag is used.

Regression Issue

• Select this option if this issue appears to be a regression.

Last Known Working CDK Version

No response

Expected Behavior

I expect that if the tests pass with --disable-update-workflow, that the job succeeds.

Current Behavior

The job fails with exit code 1.

Reproduction Steps

1. Make a destructive change.
2. Run integration tests using integ-runner --update-on-failed --disable-update-workflow
3. Check the exit code via echo $?

Possible Solution

Two ideas:

• exit with code 0 to indicate that the tests succeeded without error and that the snapshots have been updated.
• exit with some other code (not 1) to differentiate this error from an actual test failure.

Additional Information/Context

In my project I use a CI job which executes the integration tests and commits the new snapshot files. With this bug, I need to run integration tests using the following pattern to suppress this error in order for the new snapshots to be committed:

integ-runner ... || true

However, given that exit code 1 is used for genuine test failures, those errors are suppressed as well.

CDK CLI Version

2.174.0

Framework Version

No response

Node.js Version

v18.17.1

OS

MacOS

Language

Python

Language Version

No response

Other information

No response

[pahud]

Thank you for the feedback. Will bring this up to the team for review and inputs.