Skip to content

fix(cli): diff always prints stack name #304

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

Merged
aws-cdk-automation merged 4 commits into from
Apr 2, 2025
Merged

fix(cli): diff always prints stack name #304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
05c3790
fix(cli): diff always prints stack name
kaizencc Apr 1, 2025
1a2ef2f
Merge branch 'main' into conroy/fixdiff
kaizencc Apr 2, 2025
863fb48
update tests
kaizencc Apr 2, 2025
ad302b9
chore: self mutation
invalid-email-address Apr 2, 2025
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
29 changes: 14 additions & 15 deletions packages/@aws-cdk/tmp-toolkit-helpers/src/api/diff/diff-formatter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ export class DiffFormatter {
try {
// must output the stack name if there are differences, even if quiet
if (stackName && (!options.quiet || !diff.isEmpty)) {
stream.write(format('Stack %s\n', chalk.bold(stackName)));
stream.write(format(`Stack ${chalk.bold(stackName)}\n`));
}

if (!options.quiet && options.isImport) {
Expand Down Expand Up @@ -239,20 +239,19 @@ export class DiffFormatter {
...logicalIdMapFromTemplate(this.oldTemplate),
...buildLogicalToPathMap(this.newTemplate),
}, options.context);

// store the stream containing a formatted stack diff
formattedDiff = stream.toString();
} else if (!options.quiet) {
options.ioDefaultHelper.info(chalk.green('There were no differences'));
stream.write(chalk.green('There were no differences\n'));
}

if (filteredChangesCount > 0) {
stream.write(chalk.yellow(`Omitted ${filteredChangesCount} changes because they are likely mangled non-ASCII characters. Use --strict to print them.\n`));
}
} finally {
// store the stream containing a formatted stack diff
formattedDiff = stream.toString();
stream.end();
}

if (filteredChangesCount > 0) {
options.ioDefaultHelper.info(chalk.yellow(`Omitted ${filteredChangesCount} changes because they are likely mangled non-ASCII characters. Use --strict to print them.`));
}

for (const nestedStackLogicalId of Object.keys(nestedStackTemplates ?? {})) {
if (!nestedStackTemplates) {
break;
Expand Down Expand Up @@ -285,18 +284,18 @@ export class DiffFormatter {
const diff = fullDiff(this.oldTemplate, this.newTemplate.template, options.changeSet);

if (diffRequiresApproval(diff, options.requireApproval)) {
ioDefaultHelper.info(format('Stack %s\n', chalk.bold(options.stackName)));

// eslint-disable-next-line max-len
ioDefaultHelper.warning(`This deployment will make potentially sensitive changes according to your current security approval level (--require-approval ${options.requireApproval}).`);
ioDefaultHelper.warning('Please confirm you intend to make the following modifications:\n');

// The security diff is formatted via `Formatter`, which takes in a stream
// and sends its output directly to that stream. To faciliate use of the
// global CliIoHost, we create our own stream to capture the output of
// `Formatter` and return the output as a string for the consumer of
// `formatSecurityDiff` to decide what to do with it.
const stream = new StringWriteStream();

stream.write(format(`Stack ${chalk.bold(options.stackName)}\n`));

// eslint-disable-next-line max-len
ioDefaultHelper.warning(`This deployment will make potentially sensitive changes according to your current security approval level (--require-approval ${options.requireApproval}).`);
ioDefaultHelper.warning('Please confirm you intend to make the following modifications:\n');
try {
// formatSecurityChanges updates the stream with the formatted security diff
formatSecurityChanges(stream, diff, buildLogicalToPathMap(this.newTemplate));
Expand Down
12 changes: 9 additions & 3 deletions packages/@aws-cdk/tmp-toolkit-helpers/test/api/diff/diff.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ describe('formatStackDiff', () => {
} as any;
});

test('returns no changes when templates are identical', () => {
test('returns no differences when templates are identical', () => {
// WHEN
const formatter = new DiffFormatter({
ioHelper: mockIoHelper,
Expand All @@ -76,8 +76,12 @@ describe('formatStackDiff', () => {

// THEN
expect(result.numStacksWithChanges).toBe(0);
expect(result.formattedDiff).toBe('');
expect(mockIoDefaultMessages.info).toHaveBeenCalledWith(expect.stringContaining('no differences'));
expect(result.formattedDiff).toBeDefined();
const sanitizedDiff = result.formattedDiff!.replace(/\x1B\[[0-?]*[ -/]*[@-~]/g, '').trim();
expect(sanitizedDiff).toBe(
'Stack test-stack\n' +
'There were no differences',
);
});

test('formats differences when changes exist', () => {
Expand Down Expand Up @@ -256,6 +260,7 @@ describe('formatSecurityDiff', () => {
expect(result.formattedDiff).toBeDefined();
const sanitizedDiff = result.formattedDiff!.replace(/\x1B\[[0-?]*[ -/]*[@-~]/g, '').trim();
expect(sanitizedDiff).toBe(
'Stack test-stack\n' +
'IAM Statement Changes\n' +
'┌───┬─────────────┬────────┬────────────────┬──────────────────────────────┬───────────┐\n' +
'│ │ Resource │ Effect │ Action │ Principal │ Condition │\n' +
Expand Down Expand Up @@ -291,6 +296,7 @@ describe('formatSecurityDiff', () => {
);
const sanitizedDiff = result.formattedDiff!.replace(/\x1B\[[0-?]*[ -/]*[@-~]/g, '').trim();
expect(sanitizedDiff).toBe(
'Stack test-stack\n' +
'IAM Statement Changes\n' +
'┌───┬─────────────┬────────┬────────────────┬──────────────────────────────┬───────────┐\n' +
'│ │ Resource │ Effect │ Action │ Principal │ Condition │\n' +
Expand Down
14 changes: 10 additions & 4 deletions packages/aws-cdk/test/commands/diff.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -865,7 +865,7 @@ describe('nested stacks', () => {
});

// THEN
const plainTextOutput = notifySpy.mock.calls[1][0].message.replace(/\x1B\[[0-?]*[ -/]*[@-~]/g, '').replace(/[ \t]+$/gm, '');
const plainTextOutput = notifySpy.mock.calls[0][0].message.replace(/\x1B\[[0-?]*[ -/]*[@-~]/g, '').replace(/[ \t]+$/gm, '');
expect(plainTextOutput.trim()).toEqual(`Stack Parent
Resources
[~] AWS::CloudFormation::Stack AdditionChild
Expand Down Expand Up @@ -906,7 +906,10 @@ Resources

Stack newGrandChild
Resources
[+] AWS::Something SomeResource`);
[+] AWS::Something SomeResource

Stack UnChangedChild
There were no differences`);
Comment on lines +911 to +912
Copy link
Contributor Author

@kaizencc kaizencc Apr 2, 2025

Choose a reason for hiding this comment

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

this was missed in #264; it should have not been removed, and would have alerted us of the issue.

it also shows an additional thing that this PR fixes. previously, the comment There were no differences was printed separately from the diff (on console, it renders the same). now it is included in the formatted diff itself


expect(notifySpy).toHaveBeenCalledWith(expect.objectContaining({
message: expect.stringContaining('✨ Number of stacks with differences: 6'),
Expand All @@ -926,7 +929,7 @@ Resources
});

// THEN
const plainTextOutput = notifySpy.mock.calls[2][0].message.replace(/\x1B\[[0-?]*[ -/]*[@-~]/g, '').replace(/[ \t]+$/gm, '');
const plainTextOutput = notifySpy.mock.calls[1][0].message.replace(/\x1B\[[0-?]*[ -/]*[@-~]/g, '').replace(/[ \t]+$/gm, '');
expect(plainTextOutput.trim()).toEqual(`Stack Parent
Resources
[~] AWS::CloudFormation::Stack AdditionChild
Expand Down Expand Up @@ -967,7 +970,10 @@ Resources

Stack newGrandChild
Resources
[+] AWS::Something SomeResource`);
[+] AWS::Something SomeResource

Stack UnChangedChild
There were no differences`);

expect(notifySpy).toHaveBeenCalledWith(expect.objectContaining({
message: expect.stringContaining('✨ Number of stacks with differences: 6'),
Expand Down