fix(core): CFN version and description template sections were merged incorrectly #8251
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
nija-at
suggested changes
May 28, 2020
packages/@aws-cdk/core/lib/stack.ts
Outdated
Comment on lines
863
to
866
| case 'Description': | ||
| // merge the two descriptions, with a newline in between | ||
| template[section] = `${dest}\n${src}`; | ||
| break; |
There was a problem hiding this comment.
This is a weird choice. I would say either error or destination wins.
In the case of CfnInclude, I think it's fair to say that if the description was altered after import, the altered description wins.
There was a problem hiding this comment.
This is not about "altering" - this is the case when Description was provided from multiple places. See the test for this:
new CfnInclude(stack, 'T1', {
template: {
AWSTemplateFormatVersion: '2010-09-09',
Description: 'Test 1',
},
});
new CfnInclude(stack, 'T2', {
template: {
AWSTemplateFormatVersion: '2010-09-09',
Description: 'Test 2',
},
});
rix0rrr
approved these changes
May 29, 2020
…incorrectly In the merge logic in Stack when rendering the template, it was mistakenly assumed that all CFN sections are objects. However, there are some sections, like Description and AWSTemplateFormatVersion, that are in fact strings. Add special logic for those cases in the merge functionality (multiple provided CFN versions are checked for being identical, and mutliple descriptions are merged together, with a newline in between). Fixes aws#8151
b084416 to
f009d29
Compare
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
mergify bot
pushed a commit
that referenced
this pull request
Aug 7, 2020
When we changed the merging behavior in #8251, we forgot to account for the 'Rules' section. To prevent that error from happening again, let's default to merging objects without duplicates. Fixes #9485 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
eladb
pushed a commit
that referenced
this pull request
Aug 10, 2020
When we changed the merging behavior in #8251, we forgot to account for the 'Rules' section. To prevent that error from happening again, let's default to merging objects without duplicates. Fixes #9485 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the merge logic in Stack when rendering the template,
it was mistakenly assumed that all CFN sections are objects.
However, there are some sections, like Description and AWSTemplateFormatVersion,
that are in fact strings.
Add special logic for those cases in the merge functionality
(multiple provided CFN versions are checked for being identical,
and multiple descriptions are merged together, with a newline in between).
Fixes #8151
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license