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

Jump to bottom

fix(ecs): remove Fargate environment files restriction #11820

Merged
merged 6 commits into from
Dec 10, 2020
Merged

fix(ecs): remove Fargate environment files restriction #11820

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
272f197
Remove restriction on environment files
jkenn99 Dec 2, 2020
cbe2ee6
Update tests
jkenn99 Dec 2, 2020
b95181b
Merge branch 'master' into patch-1
jkenn99 Dec 2, 2020
9da67a8
Add requested tests for Fargate taskdef
jkenn99 Dec 10, 2020
ce8a25a
Merge branch 'master' into patch-1
jkenn99 Dec 10, 2020
bd9366b
Merge branch 'master' into patch-1
jkenn99 Dec 10, 2020
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
4 changes: 0 additions & 4 deletions packages/@aws-cdk/aws-ecs/lib/container-definition.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,10 +420,6 @@ export class ContainerDefinition extends cdk.Construct {
}
}

if (this.taskDefinition.isFargateCompatible && props.environmentFiles) {
throw new Error(`Cannot specify environment files for a task using the FARGATE launch type in container '${this.node.id}'.`);
}

if (props.environmentFiles) {
this.environmentFiles = [];

Expand Down
303 changes: 198 additions & 105 deletions packages/@aws-cdk/aws-ecs/test/test.container-definition.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -703,122 +703,215 @@ export = {
},

'Environment Files': {
'can add asset environment file to the container definition'(test: Test) {
// GIVEN
const stack = new cdk.Stack();
const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'TaskDef');
'with EC2 task definitions': {
'can add asset environment file to the container definition'(test: Test) {
// GIVEN
const stack = new cdk.Stack();
const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'TaskDef');

// WHEN
taskDefinition.addContainer('cont', {
image: ecs.ContainerImage.fromRegistry('test'),
memoryLimitMiB: 1024,
environmentFiles: [ecs.EnvironmentFile.fromAsset(path.join(__dirname, 'demo-envfiles/test-envfile.env'))],
});
// WHEN
taskDefinition.addContainer('cont', {
image: ecs.ContainerImage.fromRegistry('test'),
memoryLimitMiB: 1024,
environmentFiles: [ecs.EnvironmentFile.fromAsset(path.join(__dirname, 'demo-envfiles/test-envfile.env'))],
});

// THEN
expect(stack).to(haveResourceLike('AWS::ECS::TaskDefinition', {
ContainerDefinitions: [
{
EnvironmentFiles: [{
Type: 's3',
Value: {
'Fn::Join': [
'',
[
'arn:aws:s3:::',
{
Ref: 'AssetParameters872561bf078edd1685d50c9ff821cdd60d2b2ddfb0013c4087e79bf2bb50724dS3Bucket7B2069B7',
},
'/',
{
'Fn::Select': [
0,
{
'Fn::Split': [
'||',
{
Ref: 'AssetParameters872561bf078edd1685d50c9ff821cdd60d2b2ddfb0013c4087e79bf2bb50724dS3VersionKey40E12C15',
},
],
},
],
},
{
'Fn::Select': [
1,
{
'Fn::Split': [
'||',
{
Ref: 'AssetParameters872561bf078edd1685d50c9ff821cdd60d2b2ddfb0013c4087e79bf2bb50724dS3VersionKey40E12C15',
},
],
},
],
},
// THEN
expect(stack).to(haveResourceLike('AWS::ECS::TaskDefinition', {
ContainerDefinitions: [
{
EnvironmentFiles: [{
Type: 's3',
Value: {
'Fn::Join': [
'',
[
'arn:aws:s3:::',
{
Ref: 'AssetParameters872561bf078edd1685d50c9ff821cdd60d2b2ddfb0013c4087e79bf2bb50724dS3Bucket7B2069B7',
},
'/',
{
'Fn::Select': [
0,
{
'Fn::Split': [
'||',
{
Ref: 'AssetParameters872561bf078edd1685d50c9ff821cdd60d2b2ddfb0013c4087e79bf2bb50724dS3VersionKey40E12C15',
},
],
},
],
},
{
'Fn::Select': [
1,
{
'Fn::Split': [
'||',
{
Ref: 'AssetParameters872561bf078edd1685d50c9ff821cdd60d2b2ddfb0013c4087e79bf2bb50724dS3VersionKey40E12C15',
},
],
},
],
},
],
],
],
},
}],
},
],
}));
},
}],
},
],
}));

test.done();
},
'can add s3 bucket environment file to the container definition'(test: Test) {
// GIVEN
const stack = new cdk.Stack();
const bucket = new s3.Bucket(stack, 'Bucket', {
bucketName: 'test-bucket',
});
const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'TaskDef');
test.done();
},
'can add s3 bucket environment file to the container definition'(test: Test) {
// GIVEN
const stack = new cdk.Stack();
const bucket = new s3.Bucket(stack, 'Bucket', {
bucketName: 'test-bucket',
});
const taskDefinition = new ecs.Ec2TaskDefinition(stack, 'TaskDef');

// WHEN
taskDefinition.addContainer('cont', {
image: ecs.ContainerImage.fromRegistry('test'),
memoryLimitMiB: 1024,
environmentFiles: [ecs.EnvironmentFile.fromBucket(bucket, 'test-key')],
});
// WHEN
taskDefinition.addContainer('cont', {
image: ecs.ContainerImage.fromRegistry('test'),
memoryLimitMiB: 1024,
environmentFiles: [ecs.EnvironmentFile.fromBucket(bucket, 'test-key')],
});

// THEN
expect(stack).to(haveResourceLike('AWS::ECS::TaskDefinition', {
ContainerDefinitions: [
{
EnvironmentFiles: [{
Type: 's3',
Value: {
'Fn::Join': [
'',
[
'arn:aws:s3:::',
{
Ref: 'Bucket83908E77',
},
'/test-key',
// THEN
expect(stack).to(haveResourceLike('AWS::ECS::TaskDefinition', {
ContainerDefinitions: [
{
EnvironmentFiles: [{
Type: 's3',
Value: {
'Fn::Join': [
'',
[
'arn:aws:s3:::',
{
Ref: 'Bucket83908E77',
},
'/test-key',
],
],
],
},
}],
},
],
}));
},
}],
},
],
}));

test.done();
test.done();
},
},
'throws when using environment files for a Fargate task'(test: Test) {
// GIVEN
const stack = new cdk.Stack();
const taskDefinition = new ecs.FargateTaskDefinition(stack, 'TaskDef');
'with Fargate task definitions': {
'can add asset environment file to the container definition'(test: Test) {
// GIVEN
const stack = new cdk.Stack();
const taskDefinition = new ecs.FargateTaskDefinition(stack, 'TaskDef');

// THEN
test.throws(() => taskDefinition.addContainer('cont', {
image: ecs.ContainerImage.fromRegistry('test'),
memoryLimitMiB: 1024,
environmentFiles: [ecs.EnvironmentFile.fromAsset(path.join(__dirname, 'demo-envfiles/test-envfile.env'))],
}), /Cannot specify environment files for a task using the FARGATE launch type in container/);
// WHEN
taskDefinition.addContainer('cont', {
image: ecs.ContainerImage.fromRegistry('test'),
memoryLimitMiB: 1024,
environmentFiles: [ecs.EnvironmentFile.fromAsset(path.join(__dirname, 'demo-envfiles/test-envfile.env'))],
});

test.done();
// THEN
expect(stack).to(haveResourceLike('AWS::ECS::TaskDefinition', {
ContainerDefinitions: [
{
EnvironmentFiles: [{
Type: 's3',
Value: {
'Fn::Join': [
'',
[
'arn:aws:s3:::',
{
Ref: 'AssetParameters872561bf078edd1685d50c9ff821cdd60d2b2ddfb0013c4087e79bf2bb50724dS3Bucket7B2069B7',
},
'/',
{
'Fn::Select': [
0,
{
'Fn::Split': [
'||',
{
Ref: 'AssetParameters872561bf078edd1685d50c9ff821cdd60d2b2ddfb0013c4087e79bf2bb50724dS3VersionKey40E12C15',
},
],
},
],
},
{
'Fn::Select': [
1,
{
'Fn::Split': [
'||',
{
Ref: 'AssetParameters872561bf078edd1685d50c9ff821cdd60d2b2ddfb0013c4087e79bf2bb50724dS3VersionKey40E12C15',
},
],
},
],
},
],
],
},
}],
},
],
}));

test.done();
},
'can add s3 bucket environment file to the container definition'(test: Test) {
// GIVEN
const stack = new cdk.Stack();
const bucket = new s3.Bucket(stack, 'Bucket', {
bucketName: 'test-bucket',
});
const taskDefinition = new ecs.FargateTaskDefinition(stack, 'TaskDef');

// WHEN
taskDefinition.addContainer('cont', {
image: ecs.ContainerImage.fromRegistry('test'),
memoryLimitMiB: 1024,
environmentFiles: [ecs.EnvironmentFile.fromBucket(bucket, 'test-key')],
});

// THEN
expect(stack).to(haveResourceLike('AWS::ECS::TaskDefinition', {
ContainerDefinitions: [
{
EnvironmentFiles: [{
Type: 's3',
Value: {
'Fn::Join': [
'',
[
'arn:aws:s3:::',
{
Ref: 'Bucket83908E77',
},
'/test-key',
],
],
},
}],
},
],
}));

test.done();
},
},
},

Expand Down