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.

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(toolkit): fix context passed in from command-line #1939

Merged
merged 2 commits into from
Mar 4, 2019

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Mar 4, 2019

Fix issue where context passed in via command-line was ignored.

Migration behavior has been changed: context that looks like it
has been generated by context providers (keys containing ":")
will upon loading be migrated to cdk.context.json; other
context in cdk.json will be left as-is and treated as readonly.

Fixes #1911.


Pull Request Checklist

  • Testing
    • Unit test added (prefer not to modify an existing test, otherwise, it's probably a breaking change)
    • CLI change?: coordinate update of integration tests with team
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
  • Title and Description
    • Change type: title prefixed with fix, feat will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.

Fix issue where context passed in via command-line was ignored.

Migration behavior has been changed: context that looks like it
has been generated by context providers (keys containing ":")
will upon loading be migrated to `cdk.context.json`; other
context in `cdk.json` will be left as-is and treated as readonly.

Fixes #1911.
@rix0rrr rix0rrr requested a review from a team as a code owner March 4, 2019 12:50
@@ -18,10 +18,11 @@ const CONTEXT_KEY = 'context';
*/
export class Configuration {
public settings = new Settings();
public context = new Context(new Settings(), [], new Settings());
public context = new Context(new Settings());

Copy link
Contributor

Choose a reason for hiding this comment

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

what's up here?

@@ -18,10 +18,11 @@ const CONTEXT_KEY = 'context';
*/
export class Configuration {
public settings = new Settings();
public context = new Context(new Settings(), [], new Settings());
public context = new Context(new Settings());

Copy link
Contributor

Choose a reason for hiding this comment

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

what's up here?

@@ -18,10 +18,11 @@ const CONTEXT_KEY = 'context';
*/
export class Configuration {
public settings = new Settings();
public context = new Context(new Settings(), [], new Settings());
public context = new Context(new Settings());

Copy link
Contributor

Choose a reason for hiding this comment

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

what's up here?

this.context = new Context(
this.commandLineContext,
this.projectConfig.subSettings([CONTEXT_KEY]).makeReadOnly(),
this.projectContext);
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a bit tricky, can we special-case it a bit more? Feel wrong to migrate all context that has : in it, or we should block this from user-defined context keys.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll agree it's not fantastic, but I'd prefer just to take out the migration behavior a couple of releases in the future (maybe for GA) rather than complicate things now.


constructor(private readonly bottom: Settings, private readonly bottomPrefixPath: string[], private readonly top: Settings) {
constructor(bag: Settings, ...bags: Settings[]) {
this.bags = [bag, ...bags];
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Throw?

@eladb
Copy link
Contributor

eladb commented Mar 4, 2019

I guess we need an integ test...

@rix0rrr rix0rrr merged commit 82d1862 into master Mar 4, 2019
@rix0rrr rix0rrr deleted the huijbers/cli-context branch March 4, 2019 15:18
sam-goodwin pushed a commit that referenced this pull request Mar 4, 2019
Fix issue where context passed in via command-line was ignored.

Migration behavior has been changed: context that looks like it
has been generated by context providers (keys containing ":")
will upon loading be migrated to `cdk.context.json`; other
context in `cdk.json` will be left as-is and treated as readonly.

Fixes #1911.
sam-goodwin pushed a commit that referenced this pull request Mar 4, 2019
Fix issue where context passed in via command-line was ignored.

Migration behavior has been changed: context that looks like it
has been generated by context providers (keys containing ":")
will upon loading be migrated to `cdk.context.json`; other
context in `cdk.json` will be left as-is and treated as readonly.

Fixes #1911.
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Context variable is not found
3 participants