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): correctly reset context from the shell command #1903

Merged
merged 3 commits into from
Feb 28, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 5 additions & 6 deletions packages/aws-cdk/lib/commands/context.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import colors = require('colors/safe');
import yargs = require('yargs');
import { CommandOptions } from '../command-api';
import { print } from '../logging';
import { PROJECT_CONFIG } from '../settings';
import { Context, PROJECT_CONFIG } from '../settings';
import { renderTable } from '../util';

export const command = 'context';
Expand Down Expand Up @@ -34,8 +34,7 @@ export async function realHandler(options: CommandOptions): Promise<number> {
await configuration.saveContext();
print('All context values cleared.');
} else if (args.reset) {
invalidateContext(contextValues, args.reset);
configuration.context.setAll(contextValues);
invalidateContext(configuration.context, args.reset);
await configuration.saveContext();
} else {
// List -- support '--json' flag
Expand Down Expand Up @@ -77,16 +76,16 @@ function listContext(context: any) {
print(`Run ${colors.blue('cdk context --reset KEY_OR_NUMBER')} to remove a context key. It will be refreshed on the next CDK synthesis run.`);
}

function invalidateContext(context: any, key: string) {
function invalidateContext(context: Context, key: string) {
const i = parseInt(key, 10);
if (`${i}` === key) {
// Twas a number and we fully parsed it.
key = keyByNumber(context, i);
}

// Unset!
if (key in context) {
delete context[key];
if (context.has(key)) {
context.unset(key);
print(`Context value ${colors.blue(key)} reset. It will be refreshed on the next SDK synthesis run.`);
} else {
print(`No context value with key ${colors.blue(key)}`);
Expand Down
21 changes: 14 additions & 7 deletions packages/aws-cdk/lib/settings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ export class Configuration {
private readonly commandLineArguments: Settings;
private projectConfig: Settings;
private projectContext: Settings;
private loaded = false;

constructor(commandLineArguments?: yargs.Arguments) {
this.commandLineArguments = commandLineArguments
Expand All @@ -48,13 +49,17 @@ export class Configuration {
.merge(this.commandLineArguments)
.makeReadOnly();

this.loaded = true;

return this;
}

/**
* Save the project config
*/
public async saveContext(): Promise<this> {
if (!this.loaded) { return this; }

if (this.context.modifiedBottom) {
await this.projectConfig.save(PROJECT_CONFIG);
}
Expand Down Expand Up @@ -85,6 +90,14 @@ export class Context {
constructor(private readonly bottom: Settings, private readonly bottomPrefixPath: string[], private readonly top: Settings) {
}

public get keys(): string[] {
return Object.keys(this.everything());
}

public has(key: string) {
return this.keys.indexOf(key) > -1;
}

public everything(): {[key: string]: any} {
const b = this.bottom.get(this.bottomPrefixPath) || {};
const t = this.top.get([]) || {};
Expand All @@ -105,18 +118,12 @@ export class Context {
}
}

public setAll(values: object) {
for (const [key, value] of Object.entries(values)) {
this.set(key, value);
}
}

public unset(key: string) {
this.set(key, undefined);
}

public clear() {
for (const key of Object.keys(this.everything())) {
for (const key of this.keys) {
this.unset(key);
}
}
Expand Down
25 changes: 25 additions & 0 deletions packages/aws-cdk/test/commands/test.context-command.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Test } from 'nodeunit';
import { realHandler } from '../../lib/commands/context';
import { Configuration } from '../../lib/settings';

export = {
async 'context reset can remove a context key'(test: Test) {
// GIVEN
const configuration = new Configuration();
configuration.context.set('foo', 'bar');
configuration.context.set('baz', 'quux');

// WHEN
await realHandler({
configuration,
args: { reset: 'foo' }
} as any);

// THEN
test.deepEqual(configuration.context.everything(), {
baz: 'quux'
});

test.done();
},
};