fix(pipelines): undeployable due to dependency cycle #18686
Merged
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
We happily generate templates with dependency cycles. Those would be undeployable in CloudFormation, so we should make it impossible that templates like these pass unit test validation. We could make it a separate assertion method (`Template.fromStack().assertNoCycles()`), but the only thing that will do is give you an opportunity to forget to put the test in. Instead, we just check it by default for every generated template.
|
|
github-actions
bot
added
the
@aws-cdk/assertions
rix0rrr
changed the title
rix0rrr
changed the title
LukvonStrom
reviewed
Jan 28, 2022
| @@ -1084,6 +1084,25 @@ describe('Template', () => { | |||
| expect(Object.keys(result).length).toEqual(0); | |||
| }); | |||
| }); | |||
|
|
|||
| test('throws when given a templat with cyclic dependencies', () => { | |||
njlynch
approved these changes
Jan 28, 2022
rix0rrr
commented
Jan 28, 2022
| // Don't know why this was added in the first place, but I'm disabling it for now and if | ||
| // no complaints come from this, we're probably safe to remove it altogether. | ||
| // attachment.node.addDependency(this); | ||
| Array.isArray(attachment); |
There was a problem hiding this comment.
It prevents an "unused variable" error :)
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
madeline-k
reviewed
Feb 1, 2022
Comment on lines
+3
to
+9
| /** | ||
| * Check a template for cyclic dependencies | ||
| * | ||
| * This will make sure that we don't happily validate templates | ||
| * in unit tests that wouldn't deploy to CloudFormation anyway. | ||
| */ | ||
| export function checkTemplateForCyclicDependencies(template: Template): void { |
TikiTDO
pushed a commit
to TikiTDO/aws-cdk
that referenced
this pull request
Feb 21, 2022
A dependency cycle was inadvertently introduced to CDK Pipelines in aws#18492. Fix that dependency cycle, and also one in Cognito IdentityPools. Add facilities to the `assertions` library to automatically detect this in the future, to stop errors like this from slipping in. We could make it a separate assertion method (`Template.fromStack().assertNoCycles()`), but the only thing that will do is give you an opportunity to forget to put the test in. Instead, we just check it by default for every generated template. Fixes aws#18673. ---- *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.
A dependency cycle was inadvertently introduced to CDK Pipelines in #18492.
Fix that dependency cycle, and also one in Cognito IdentityPools.
Add facilities to the
assertionslibrary to automatically detect this in the future,to stop errors like this from slipping in.
We could make it a separate assertion method
(
Template.fromStack().assertNoCycles()), but the only thing that willdo is give you an opportunity to forget to put the test in.
Instead, we just check it by default for every generated template.
Fixes #18673.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license