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(core): Prevent volatile physical name generation #2984

Merged
merged 7 commits into from
Jul 2, 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: 6 additions & 5 deletions packages/@aws-cdk/aws-codepipeline-actions/test/test.pipeline.ts
Original file line number Diff line number Diff line change
Expand Up @@ -756,8 +756,9 @@ export = {
const app = new App();

const buildAccount = '901234567890';
const buildRegion = 'bermuda-triangle-1';
const buildStack = new Stack(app, 'BuildStack', {
env: { account: buildAccount },
env: { account: buildAccount, region: buildRegion },
});
const rolePhysicalName = 'ProjectRolePhysicalName';
const projectRole = new iam.Role(buildStack, 'ProjectRole', {
Expand All @@ -771,7 +772,7 @@ export = {
});

const pipelineStack = new Stack(app, 'PipelineStack', {
env: { account: '123456789012' },
env: { account: '123456789012', region: 'bermuda-triangle-42' },
});
const sourceBucket = new s3.Bucket(pipelineStack, 'ArtifactBucket', {
bucketName: 'source-bucket',
Expand Down Expand Up @@ -826,7 +827,7 @@ export = {
{
"Ref": "AWS::Partition",
},
`:iam::${buildAccount}:role/buildstackebuildactionrole166c75d145cdaa010350`,
`:iam::${buildAccount}:role/buildstackebuildactionrole166c75d1d8be701b1ad8`,
],
],
},
Expand Down Expand Up @@ -861,7 +862,7 @@ export = {
{
"Ref": "AWS::Partition",
},
`:s3:::pipelinestackeartifactsbucket5409dc8418216ab8debe`,
':s3:::pipelinestackeartifactsbucket5409dc84ec8d21c5e28c',
],
],
},
Expand All @@ -873,7 +874,7 @@ export = {
{
"Ref": "AWS::Partition",
},
`:s3:::pipelinestackeartifactsbucket5409dc8418216ab8debe/*`,
':s3:::pipelinestackeartifactsbucket5409dc84ec8d21c5e28c/*',
],
],
},
Expand Down
16 changes: 8 additions & 8 deletions packages/@aws-cdk/core/lib/private/physical-name-generator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ export function generatePhysicalName(resource: IResource): string {
const stackPart = new PrefixNamePart(stack.stackName, 25);
const idPart = new SuffixNamePart(resource.node.uniqueId, 24);

let region: string | undefined = stack.region;
if (Token.isUnresolved(region)) {
region = undefined;
const region: string = stack.region;
if (Token.isUnresolved(region) || !region) {
throw new Error(`Cannot generate a physical name for ${resource.node.path}, because the region is un-resolved or missing`);
}

let account: string | undefined = stack.account;
if (Token.isUnresolved(account)) {
account = undefined;
const account: string = stack.account;
if (Token.isUnresolved(account) || !account) {
throw new Error(`Cannot generate a physical name for ${resource.node.path}, because the account is un-resolved or missing`);
}

const parts = [stackPart, idPart]
Expand All @@ -25,8 +25,8 @@ export function generatePhysicalName(resource: IResource): string {
const sha256 = crypto.createHash('sha256')
.update(stackPart.bareStr)
.update(idPart.bareStr)
.update(region || '')
.update(account || '');
.update(region)
.update(account);
const hash = sha256.digest('hex').slice(0, hashLength);

const ret = [...parts, hash].join('');
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
import nodeunit = require('nodeunit');
import { App, Aws, Resource, Stack } from '../../lib';
import { generatePhysicalName } from '../../lib/private/physical-name-generator';

export = nodeunit.testCase({
'generates correct physical names'(test: nodeunit.Test) {
const app = new App();
const stack = new Stack(app, 'TestStack', { env: { account: '012345678912', region: 'bermuda-triangle-1' } });

const testResourceA = new TestResource(stack, 'A');
const testResourceB = new TestResource(testResourceA, 'B');

test.equal(generatePhysicalName(testResourceA), 'teststackteststackaa164c141d59b37c1b663');
test.equal(generatePhysicalName(testResourceB), 'teststackteststackab27595cd34d8188283a1f');

test.done();
},

'generates different names in different accounts'(test: nodeunit.Test) {
const appA = new App();
const stackA = new Stack(appA, 'TestStack', { env: { account: '012345678912', region: 'bermuda-triangle-1' } });
const resourceA = new TestResource(stackA, 'Resource');

const appB = new App();
const stackB = new Stack(appB, 'TestStack', { env: { account: '012345678913', region: 'bermuda-triangle-1' } });
const resourceB = new TestResource(stackB, 'Resource');

test.notEqual(generatePhysicalName(resourceA), generatePhysicalName(resourceB));

test.done();
},

'generates different names in different regions'(test: nodeunit.Test) {
const appA = new App();
const stackA = new Stack(appA, 'TestStack', { env: { account: '012345678912', region: 'bermuda-triangle-1' } });
const resourceA = new TestResource(stackA, 'Resource');

const appB = new App();
const stackB = new Stack(appB, 'TestStack', { env: { account: '012345678912', region: 'bermuda-triangle-2' } });
const resourceB = new TestResource(stackB, 'Resource');

test.notEqual(generatePhysicalName(resourceA), generatePhysicalName(resourceB));

test.done();
},

'fails when the region is an unresolved token'(test: nodeunit.Test) {
const app = new App();
const stack = new Stack(app, 'TestStack', { env: { account: '012345678912', region: Aws.REGION } });
const testResource = new TestResource(stack, 'A');

test.throws(() => generatePhysicalName(testResource),
/Cannot generate a physical name for TestStack\/A, because the region is un-resolved or missing/);

test.done();
},

'fails when the region is not provided'(test: nodeunit.Test) {
const app = new App();
const stack = new Stack(app, 'TestStack', { env: { account: '012345678912' } });
const testResource = new TestResource(stack, 'A');

test.throws(() => generatePhysicalName(testResource),
/Cannot generate a physical name for TestStack\/A, because the region is un-resolved or missing/);

test.done();
},

'fails when the account is an unresolved token'(test: nodeunit.Test) {
const app = new App();
const stack = new Stack(app, 'TestStack', { env: { account: Aws.ACCOUNT_ID, region: 'bermuda-triangle-1' } });
const testResource = new TestResource(stack, 'A');

test.throws(() => generatePhysicalName(testResource),
/Cannot generate a physical name for TestStack\/A, because the account is un-resolved or missing/);

test.done();
},

'fails when the account is not provided'(test: nodeunit.Test) {
const app = new App();
const stack = new Stack(app, 'TestStack', { env: { region: 'bermuda-triangle-1' } });
const testResource = new TestResource(stack, 'A');

test.throws(() => generatePhysicalName(testResource),
/Cannot generate a physical name for TestStack\/A, because the account is un-resolved or missing/);

test.done();
},
});

class TestResource extends Resource {}
14 changes: 12 additions & 2 deletions packages/@aws-cdk/core/test/test.cross-environment-token.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@ export = {
const stack1 = new Stack(app, 'Stack1', {
env: {
account: '123456789012',
region: 'bermuda-triangle-1337',
},
});
const myResource = new MyResource(stack1, 'MyResource', 'PhysicalName');

const stack2 = new Stack(app, 'Stack2', {
env: {
account: '234567890123',
region: 'bermuda-triangle-42',
},
});

Expand Down Expand Up @@ -56,11 +58,13 @@ export = {
const stack1 = new Stack(app, 'Stack1', {
env: {
account: '123456789012',
region: 'bermuda-triangle-1337',
},
});
const stack2 = new Stack(app, 'Stack2', {
env: {
account: '234567890123',
region: 'bermuda-triangle-42',
},
});

Expand Down Expand Up @@ -88,13 +92,15 @@ export = {
const stack1 = new Stack(app, 'Stack1', {
env: {
account: '123456789012',
region: 'bermuda-triangle-1337',
},
});
const myResource = new MyResource(stack1, 'MyResource', PhysicalName.GENERATE_IF_NEEDED);

const stack2 = new Stack(app, 'Stack2', {
env: {
account: '234567890123',
region: 'bermuda-triangle-42',
},
});

Expand All @@ -115,7 +121,7 @@ export = {
{
Ref: 'AWS::Partition',
},
':myservice:::my-resource/stack1stack1myresourcec54ced43dab875fcfa49',
':myservice:::my-resource/stack1stack1myresourcec54ced43683ebf9a3c4c',
],
],
},
Expand All @@ -132,11 +138,13 @@ export = {
const stack1 = new Stack(app, 'Stack1', {
env: {
account: '123456789012',
region: 'bermuda-triangle-1337',
},
});
const stack2 = new Stack(app, 'Stack2', {
env: {
account: '234567890123',
region: 'bermuda-triangle-42',
},
});

Expand All @@ -150,7 +158,7 @@ export = {
test.deepEqual(toCloudFormation(stack2), {
Outputs: {
Output: {
Value: 'stack1stack1myresourcec54ced43dab875fcfa49',
Value: 'stack1stack1myresourcec54ced43683ebf9a3c4c',
},
},
});
Expand All @@ -165,11 +173,13 @@ export = {
const stack1 = new Stack(app, 'Stack1', {
env: {
account: '123456789012',
region: 'bermuda-triangle-1337',
},
});
const stack2 = new Stack(app, 'Stack2', {
env: {
account: '234567890123',
region: 'bermuda-triangle-42',
},
});

Expand Down