Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(cli): warns about missing --no-rollback flag that is present #32309

Merged
merged 5 commits into from
Nov 28, 2024
Merged

fix(cli): warns about missing --no-rollback flag that is present #32309

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
023a4fa
fix: CLI warns about missing `--no-rollback` flag that is present
rix0rrr Nov 27, 2024
b9e2027
fix tests
rix0rrr Nov 27, 2024
36b4d62
Typo
rix0rrr Nov 27, 2024
bf0bb5e
Add another test case for the coverage
rix0rrr Nov 28, 2024
01dfa6b
Merge branch 'main' into huijbers/inverted-logic
mergify[bot] Nov 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion packages/aws-cdk/lib/api/aws-auth/sdk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -951,7 +951,6 @@ export class SDK {
});
const command = new GetCallerIdentityCommand({});
const result = await client.send(command);
debug(result.Account!, result.Arn, result.UserId);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why remove?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty sure this is a debug line left by Otavio :).

In any case, I don't want just the account number, ARN and userId printed to the log without text.

const accountId = result.Account;
const partition = result.Arn!.split(':')[1];
if (!accountId) {
Expand Down
17 changes: 9 additions & 8 deletions packages/aws-cdk/lib/api/deploy-stack.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ import { StringWithoutPlaceholders } from './util/placeholders';
export type DeployStackResult =
| SuccessfulDeployStackResult
| NeedRollbackFirstDeployStackResult
| ReplacementRequiresNoRollbackStackResult
| ReplacementRequiresRollbackStackResult
;

/** Successfully deployed a stack */
Expand All @@ -52,11 +52,12 @@ export interface SuccessfulDeployStackResult {
export interface NeedRollbackFirstDeployStackResult {
readonly type: 'failpaused-need-rollback-first';
readonly reason: 'not-norollback' | 'replacement';
readonly status: string;
}

/** The upcoming change has a replacement, which requires deploying without --no-rollback */
export interface ReplacementRequiresNoRollbackStackResult {
readonly type: 'replacement-requires-norollback';
/** The upcoming change has a replacement, which requires deploying with --rollback */
export interface ReplacementRequiresRollbackStackResult {
readonly type: 'replacement-requires-rollback';
}

export function assertIsSuccessfulDeployStackResult(x: DeployStackResult): asserts x is SuccessfulDeployStackResult {
Expand Down Expand Up @@ -512,13 +513,13 @@ class FullCloudFormationDeployment {
const isPausedFailState = this.cloudFormationStack.stackStatus.isRollbackable;
const rollback = this.options.rollback ?? true;
if (isPausedFailState && replacement) {
return { type: 'failpaused-need-rollback-first', reason: 'replacement' };
return { type: 'failpaused-need-rollback-first', reason: 'replacement', status: this.cloudFormationStack.stackStatus.name };
}
if (isPausedFailState && !rollback) {
return { type: 'failpaused-need-rollback-first', reason: 'not-norollback' };
if (isPausedFailState && rollback) {
return { type: 'failpaused-need-rollback-first', reason: 'not-norollback', status: this.cloudFormationStack.stackStatus.name };
}
if (!rollback && replacement) {
return { type: 'replacement-requires-norollback' };
return { type: 'replacement-requires-rollback' };
}

return this.executeChangeSet(changeSetDescription);
Expand Down
6 changes: 3 additions & 3 deletions packages/aws-cdk/lib/cdk-toolkit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,8 @@ export class CdkToolkit {

case 'failpaused-need-rollback-first': {
const motivation = r.reason === 'replacement'
? 'Stack is in a paused fail state and change includes a replacement which cannot be deployed with "--no-rollback"'
: 'Stack is in a paused fail state and command line arguments do not include "--no-rollback"';
? `Stack is in a paused fail state (${r.status}) and change includes a replacement which cannot be deployed with "--no-rollback"`
: `Stack is in a paused fail state (${r.status}) and command line arguments do not include "--no-rollback"`;

if (options.force) {
warning(`${motivation}. Rolling back first (--force).`);
Expand All @@ -461,7 +461,7 @@ export class CdkToolkit {
break;
}

case 'replacement-requires-norollback': {
case 'replacement-requires-rollback': {
const motivation = 'Change includes a replacement which cannot be deployed with "--no-rollback"';

if (options.force) {
Expand Down
37 changes: 25 additions & 12 deletions packages/aws-cdk/test/api/deploy-stack.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1127,30 +1127,41 @@ describe('disable rollback', () => {
});

test.each([
[StackStatus.UPDATE_FAILED, 'failpaused-need-rollback-first'],
[StackStatus.CREATE_COMPLETE, 'replacement-requires-norollback'],
])('no-rollback and replacement is disadvised: %p -> %p', async (stackStatus, expectedType) => {
// From a failed state, a --no-rollback is possible as long as there is not a replacement
[StackStatus.UPDATE_FAILED, 'no-rollback', 'no-replacement', 'did-deploy-stack'],
[StackStatus.UPDATE_FAILED, 'no-rollback', 'replacement', 'failpaused-need-rollback-first'],
// Any combination of UPDATE_FAILED & rollback always requires a rollback first
[StackStatus.UPDATE_FAILED, 'rollback', 'replacement', 'failpaused-need-rollback-first'],
[StackStatus.UPDATE_FAILED, 'rollback', 'no-replacement', 'failpaused-need-rollback-first'],
// From a stable state, any deployment containing a replacement requires a regular deployment (--rollback)
[StackStatus.UPDATE_COMPLETE, 'no-rollback', 'replacement', 'replacement-requires-rollback'],
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't traced through the code fully, but this seems to read that replacement-requires-rollback, will successfully complete when a replacement is needed but we passed in no-rollback.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the stack is in a stable state (UPDATE_COMPLETE), the user passes --no-rollback, and there is a replacement to do, the deployStack function will say: replacement-requires-rollback.

That is to say, the combination of replacement and no-rollback is not possible. This is a CloudFormation limitation.

What will happen in practice is that our CLI will catch this return code and ask "Do you want to perform a regular (--rollback) deployment (y/n)?"

] satisfies Array<[StackStatus, 'rollback' | 'no-rollback', 'replacement' | 'no-replacement', string]>)
('no-rollback and replacement is disadvised: %s %s %s -> %s', async (stackStatus, rollback, replacement, expectedType) => {
// GIVEN
givenTemplateIs(FAKE_STACK.template);
givenStackExists({
NotificationARNs: ['arn:aws:sns:bermuda-triangle-1337:123456789012:TestTopic'],
// First call
StackStatus: stackStatus,
}, {
// Later calls
StackStatus: 'UPDATE_COMPLETE',
});
givenChangeSetContainsReplacement();
givenChangeSetContainsReplacement(replacement === 'replacement');

// WHEN
const result = await deployStack({
...standardDeployStackArguments(),
stack: FAKE_STACK,
rollback: false,
rollback: rollback === 'rollback',
force: true, // Bypass 'canSkipDeploy'
});

// THEN
expect(result.type).toEqual(expectedType);
});

test('assertIsSuccessfulDeployStackResult does what it says', () => {
expect(() => assertIsSuccessfulDeployStackResult({ type: 'replacement-requires-norollback' })).toThrow();
expect(() => assertIsSuccessfulDeployStackResult({ type: 'replacement-requires-rollback' })).toThrow();
});
/**
* Set up the mocks so that it looks like the stack exists to start with
Expand All @@ -1162,12 +1173,14 @@ function givenStackExists(...overrides: Array<Partial<Stack>>) {
overrides = [{}];
}

let handler = mockCloudFormationClient.on(DescribeStacksCommand);

for (const override of overrides.slice(0, overrides.length - 1)) {
mockCloudFormationClient.on(DescribeStacksCommand).resolvesOnce({
handler = handler.resolvesOnce({
Stacks: [{ ...baseResponse, ...override }],
});
}
mockCloudFormationClient.on(DescribeStacksCommand).resolves({
handler.resolves({
Stacks: [{ ...baseResponse, ...overrides[overrides.length - 1] }],
});
}
Expand All @@ -1178,10 +1191,10 @@ function givenTemplateIs(template: any) {
});
}

function givenChangeSetContainsReplacement() {
function givenChangeSetContainsReplacement(replacement: boolean) {
mockCloudFormationClient.on(DescribeChangeSetCommand).resolves({
Status: 'CREATE_COMPLETE',
Changes: [
Changes: replacement ? [
{
Type: 'Resource',
ResourceChange: {
Expand All @@ -1205,6 +1218,6 @@ function givenChangeSetContainsReplacement() {
],
},
},
],
] : [],
});
}
10 changes: 5 additions & 5 deletions packages/aws-cdk/test/cdk-toolkit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1464,11 +1464,11 @@ describe('synth', () => {
});

test.each([
[{ type: 'failpaused-need-rollback-first', reason: 'replacement' }, false],
[{ type: 'failpaused-need-rollback-first', reason: 'replacement' }, true],
[{ type: 'failpaused-need-rollback-first', reason: 'not-norollback' }, false],
[{ type: 'replacement-requires-norollback' }, false],
[{ type: 'replacement-requires-norollback' }, true],
[{ type: 'failpaused-need-rollback-first', reason: 'replacement', status: 'OOPS' }, false],
[{ type: 'failpaused-need-rollback-first', reason: 'replacement', status: 'OOPS' }, true],
[{ type: 'failpaused-need-rollback-first', reason: 'not-norollback', status: 'OOPS' }, false],
[{ type: 'replacement-requires-rollback' }, false],
[{ type: 'replacement-requires-rollback' }, true],
] satisfies Array<[DeployStackResult, boolean]>)('no-rollback deployment that cant proceed will be called with rollback on retry: %p (using force: %p)', async (firstResult, useForce) => {
cloudExecutable = new MockCloudExecutable({
stacks: [
Expand Down
Loading