Skip to content

feat(core): Add resource type and properties of all CfnResource constructs to tree.json #4562

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

Closed
nija-at wants to merge 3 commits into from
Closed

feat(core): Add resource type and properties of all CfnResource constructs to tree.json #4562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b6af28
feat(core): Add resource type and properties of all CfnResource const…
Oct 16, 2019
f663182
Merge branch 'master' into nija-at/treemd-l1type
nija-at Oct 17, 2019
b919ddb
Merge branch 'master' into nija-at/treemd-l1type
nija-at Oct 17, 2019
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
32 changes: 29 additions & 3 deletions packages/@aws-cdk/core/lib/private/tree-metadata.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import fs = require('fs');
import path = require('path');

import { ArtifactType } from '@aws-cdk/cx-api';
import { Construct, IConstruct, ISynthesisSession } from '../construct';
import { CfnResource, Construct, IConstruct, ISynthesisSession } from '../index';

const FILE_PATH = 'tree.json';

Expand All @@ -23,10 +23,13 @@ export class TreeMetadata extends Construct {

const visit = (construct: IConstruct): Node => {
const children = construct.node.children.map(visit);
const childrenMap = children.reduce((map, child) => Object.assign(map, { [child.id]: child }), {});
const node: Node = {
id: construct.node.id || 'App',
path: construct.node.path,
children: children.length === 0 ? undefined : children,
type: this.inferType(construct),
properties: this.inferProperties(construct),
children: children.length === 0 ? undefined : childrenMap,
};

lookup[node.path] = node;
Expand All @@ -49,10 +52,33 @@ export class TreeMetadata extends Construct {
}
});
}

private inferType(construct: IConstruct): Type | undefined {
if (CfnResource.isCfnResource(construct)) {
return {
cfnResourceType: (construct as CfnResource).cfnResourceType
};
}
return undefined;
}

private inferProperties(construct: IConstruct): { [key: string]: any } | undefined {
if (CfnResource.isCfnResource(construct)) {
return (construct as any).cfnProperties;
} else {
return undefined;
}
}
}

interface Node {
id: string;
path: string;
children?: Node[];
type?: Type;
properties?: { [key: string]: any };
children?: { [key: string]: Node };
}

interface Type {
cfnResourceType?: string;
}
106 changes: 76 additions & 30 deletions packages/@aws-cdk/core/test/private/test.tree-metadata.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
import fs = require('fs');
import { Test } from 'nodeunit';
import path = require('path');
import { App, Construct, Resource, Stack } from '../../lib/index';
import { App, CfnResource, Construct, Stack } from '../../lib/index';

export = {
'tree metadata is generated as expected'(test: Test) {
'tree metadata for stacks and simple constructs'(test: Test) {
const app = new App();

const stack = new Stack(app, 'mystack');
new Construct(stack, 'group1');
const group2 = new Construct(stack, 'group2');

new MyResource(group2, 'resource3');
new Construct(stack, 'myconstruct');

const assembly = app.synth();
const treeArtifact = assembly.tree();
Expand All @@ -22,41 +18,91 @@ export = {
tree: {
id: 'App',
path: '',
children: [
{
children: {
Tree: {
id: 'Tree',
path: 'Tree'
path: 'Tree',
},
{
mystack: {
id: 'mystack',
path: 'mystack',
children: [
{
id: 'group1',
path: 'mystack/group1'
},
{
id: 'group2',
path: 'mystack/group2',
children: [
{ id: 'resource3', path: 'mystack/group2/resource3' }
]
children: {
myconstruct: {
id: 'myconstruct',
path: 'mystack/myconstruct',
}
]
}
}
}
}
});
test.done();
},

'tree metadata for Cfn* resources'(test: Test) {
class MyCfnResource extends CfnResource {
constructor(scope: Construct, id: string) {
super(scope, id, {
type: 'CDK::UnitTest::MyCfnResource',
});
}

protected get cfnProperties(): { [key: string]: any } {
return {
mystringpropkey: 'mystringpropval',
mylistpropkey: [ 'listitem1' ],
mystructpropkey: {
myboolpropkey: true,
mynumpropkey: 50,
}
};
}
}

const app = new App();
const stack = new Stack(app, 'mystack');
new MyCfnResource(stack, 'mycfnresource');

const assembly = app.synth();
const treeArtifact = assembly.tree();
test.ok(treeArtifact);

test.deepEqual(readJson(assembly.directory, treeArtifact!.file), {
version: 'tree-0.1',
tree: {
id: 'App',
path: '',
children: {
Tree: {
id: 'Tree',
path: 'Tree',
},
]
mystack: {
id: 'mystack',
path: 'mystack',
children: {
mycfnresource: {
id: 'mycfnresource',
path: 'mystack/mycfnresource',
type: { cfnResourceType: 'CDK::UnitTest::MyCfnResource' },
properties: {
mystringpropkey: 'mystringpropval',
mylistpropkey: [ 'listitem1' ],
mystructpropkey: {
myboolpropkey: true,
mynumpropkey: 50,
}
}
}
}
}
}
}
});
test.done();
},
};

class MyResource extends Resource {
constructor(scope: Construct, id: string) {
super(scope, id);
}
}

function readJson(outdir: string, file: string) {
return JSON.parse(fs.readFileSync(path.join(outdir, file), 'utf-8'));
}
6 changes: 3 additions & 3 deletions packages/@aws-cdk/core/test/test.synthesis.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ export = {
tree: {
id: 'App',
path: '',
children: [
{ id: 'Tree', path: 'Tree' }
]
children: {
Tree: { id: 'Tree', path: 'Tree' }
}
}
});
test.done();
Expand Down