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.

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

fix(ec2): UserData.addSignalOnExitCommand does not work in combination with userDataCausesReplacement #18726

Merged
merged 2 commits into from
Jan 31, 2022
Merged

fix(ec2): UserData.addSignalOnExitCommand does not work in combination with userDataCausesReplacement #18726

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ee850d
fix(ec2): UserData.addSignalOnExitCommand uses invalid resource logic…
corymhall Jan 28, 2022
2a1b691
Merge branch 'master' into corymhall/fix-ec2-cfn-signal
mergify[bot] Jan 31, 2022
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
6 changes: 3 additions & 3 deletions packages/@aws-cdk/aws-ec2/lib/user-data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { IBucket } from '@aws-cdk/aws-s3';
import { CfnElement, Fn, Resource, Stack } from '@aws-cdk/core';
import { Fn, Resource, Stack, CfnResource } from '@aws-cdk/core';
import { OperatingSystemType } from './machine-image';

/**
Expand Down Expand Up @@ -178,7 +178,7 @@ class LinuxUserData extends UserData {

public addSignalOnExitCommand( resource: Resource ): void {
const stack = Stack.of(resource);
const resourceID = stack.getLogicalId(resource.node.defaultChild as CfnElement);
const resourceID = (resource.node.defaultChild as CfnResource).logicalId;
this.addOnExitCommands(`/opt/aws/bin/cfn-signal --stack ${stack.stackName} --resource ${resourceID} --region ${stack.region} -e $exitCode || echo 'Failed to send Cloudformation Signal'`);
}

Expand Down Expand Up @@ -235,7 +235,7 @@ class WindowsUserData extends UserData {

public addSignalOnExitCommand( resource: Resource ): void {
const stack = Stack.of(resource);
const resourceID = stack.getLogicalId(resource.node.defaultChild as CfnElement);
const resourceID = (resource.node.defaultChild as CfnResource).logicalId;

this.addOnExitCommands(`cfn-signal --stack ${stack.stackName} --resource ${resourceID} --region ${stack.region} --success ($success.ToString().ToLower())`);
}
Expand Down
86 changes: 83 additions & 3 deletions packages/@aws-cdk/aws-ec2/test/userdata.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { Bucket } from '@aws-cdk/aws-s3';
import { Aws, Stack } from '@aws-cdk/core';
import { Template, Match } from '@aws-cdk/assertions';
import { Aws, Stack, CfnResource } from '@aws-cdk/core';
import * as ec2 from '../lib';

describe('user data', () => {
Expand Down Expand Up @@ -41,6 +42,7 @@ describe('user data', () => {
const stack = new Stack();
const resource = new ec2.Vpc(stack, 'RESOURCE');
const userData = ec2.UserData.forWindows();
const logicalId = (resource.node.defaultChild as CfnResource).logicalId;

// WHEN
userData.addSignalOnExitCommand( resource );
Expand All @@ -49,16 +51,55 @@ describe('user data', () => {
// THEN
const rendered = userData.render();

expect(stack.resolve(logicalId)).toEqual('RESOURCE1989552F');
expect(rendered).toEqual('<powershell>trap {\n' +
'$success=($PSItem.Exception.Message -eq "Success")\n' +
`cfn-signal --stack Default --resource RESOURCE1989552F --region ${Aws.REGION} --success ($success.ToString().ToLower())\n` +
`cfn-signal --stack Default --resource ${logicalId} --region ${Aws.REGION} --success ($success.ToString().ToLower())\n` +
'break\n' +
'}\n' +
'command1\n' +
'throw "Success"</powershell>',
);

});
test('can create Windows with Signal Command and userDataCausesReplacement', () => {
// GIVEN
const stack = new Stack();
const vpc = new ec2.Vpc(stack, 'Vpc');
const userData = ec2.UserData.forWindows();
const resource = new ec2.Instance(stack, 'RESOURCE', {
vpc,
instanceType: ec2.InstanceType.of(ec2.InstanceClass.T2, ec2.InstanceSize.LARGE),
machineImage: ec2.MachineImage.genericWindows({ ['us-east-1']: 'ami-12345678' }),
userDataCausesReplacement: true,
userData,
});

const logicalId = (resource.node.defaultChild as CfnResource).logicalId;

// WHEN
userData.addSignalOnExitCommand( resource );
userData.addCommands('command1');

// THEN
Template.fromStack(stack).templateMatches({
Resources: Match.objectLike({
RESOURCE1989552Fdfd505305f427919: {
Type: 'AWS::EC2::Instance',
},
}),
});
expect(stack.resolve(logicalId)).toEqual('RESOURCE1989552Fdfd505305f427919');
const rendered = userData.render();
expect(rendered).toEqual('<powershell>trap {\n' +
'$success=($PSItem.Exception.Message -eq "Success")\n' +
`cfn-signal --stack Default --resource ${logicalId} --region ${Aws.REGION} --success ($success.ToString().ToLower())\n` +
'break\n' +
'}\n' +
'command1\n' +
'throw "Success"</powershell>',
);
});
test('can windows userdata download S3 files', () => {
// GIVEN
const stack = new Stack();
Expand Down Expand Up @@ -174,6 +215,7 @@ describe('user data', () => {
// GIVEN
const stack = new Stack();
const resource = new ec2.Vpc(stack, 'RESOURCE');
const logicalId = (resource.node.defaultChild as CfnResource).logicalId;

// WHEN
const userData = ec2.UserData.forLinux();
Expand All @@ -182,15 +224,53 @@ describe('user data', () => {

// THEN
const rendered = userData.render();
expect(stack.resolve(logicalId)).toEqual('RESOURCE1989552F');
expect(rendered).toEqual('#!/bin/bash\n' +
'function exitTrap(){\n' +
'exitCode=$?\n' +
`/opt/aws/bin/cfn-signal --stack Default --resource RESOURCE1989552F --region ${Aws.REGION} -e $exitCode || echo \'Failed to send Cloudformation Signal\'\n` +
`/opt/aws/bin/cfn-signal --stack Default --resource ${logicalId} --region ${Aws.REGION} -e $exitCode || echo \'Failed to send Cloudformation Signal\'\n` +
'}\n' +
'trap exitTrap EXIT\n' +
'command1');

});
test('can create Linux with Signal Command and userDataCausesReplacement', () => {
// GIVEN
const stack = new Stack();
const vpc = new ec2.Vpc(stack, 'Vpc');
const userData = ec2.UserData.forLinux();
const resource = new ec2.Instance(stack, 'RESOURCE', {
vpc,
instanceType: ec2.InstanceType.of(ec2.InstanceClass.T2, ec2.InstanceSize.LARGE),
machineImage: ec2.MachineImage.genericLinux({ ['us-east-1']: 'ami-12345678' }),
userDataCausesReplacement: true,
userData,
});

const logicalId = (resource.node.defaultChild as CfnResource).logicalId;

// WHEN
userData.addSignalOnExitCommand( resource );
userData.addCommands('command1');

// THEN
Template.fromStack(stack).templateMatches({
Resources: Match.objectLike({
RESOURCE1989552F74a24ef4fbc89422: {
Type: 'AWS::EC2::Instance',
},
}),
});
expect(stack.resolve(logicalId)).toEqual('RESOURCE1989552F74a24ef4fbc89422');
const rendered = userData.render();
expect(rendered).toEqual('#!/bin/bash\n' +
'function exitTrap(){\n' +
'exitCode=$?\n' +
`/opt/aws/bin/cfn-signal --stack Default --resource ${logicalId} --region ${Aws.REGION} -e $exitCode || echo \'Failed to send Cloudformation Signal\'\n` +
'}\n' +
'trap exitTrap EXIT\n' +
'command1');
});
test('can linux userdata download S3 files', () => {
// GIVEN
const stack = new Stack();
Expand Down