Skip to content

fix(ec2): Throw error on empty InitFile content (#13009) #13119

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

Merged
mergify merged 5 commits into from
Feb 26, 2021
Merged

fix(ec2): Throw error on empty InitFile content (#13009) #13119

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bfd57f7
fix(ec2): Throw error on empty InitFile content (#13009)
mprencipe Feb 17, 2021
6d8770a
Merge branch 'master' into master
mprencipe Feb 22, 2021
17e9c84
fix(ec2): Use correct function in test, improve error message.
mprencipe Feb 25, 2021
f85d909
fix(ec2): Fix expectation in test
mprencipe Feb 25, 2021
77a7a37
Merge branch 'master' into master
mergify[bot] Feb 26, 2021
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
3 changes: 3 additions & 0 deletions packages/@aws-cdk/aws-ec2/lib/cfn-init-elements.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,9 @@ export abstract class InitFile extends InitElement {
* Use a literal string as the file content
*/
public static fromString(fileName: string, content: string, options: InitFileOptions = {}): InitFile {
if (!content) {
throw new Error('Content was empty');
Copy link
Contributor

@rix0rrr rix0rrr Feb 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be more descriptive, at least referencing the file that was trying to be created. Also, we like our error messages to suggest a clear path forward.

How about:

InitFile ${fileName}: cannot create empty file. Please supply at least one character of content.

Copy link
Contributor Author

@mprencipe mprencipe Feb 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good suggestion, fixed.

}
return new class extends InitFile {
protected _doBind(bindOptions: InitBindOptions) {
return {
Expand Down
6 changes: 6 additions & 0 deletions packages/@aws-cdk/aws-ec2/test/cfn-init-element.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,12 @@ describe('InitFile', () => {
});
});

test('empty content string throws error', () => {
expect(() => {
ec2.InitFile.symlink('/tmp/foo', '');
Copy link
Contributor

@rix0rrr rix0rrr Feb 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why have you changed fromString and are you testing symlink ?

Copy link
Contributor Author

@mprencipe mprencipe Feb 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo, fixed.

}).toThrow('Content was empty');
});

test('symlink throws an error if mode is set incorrectly', () => {
expect(() => {
ec2.InitFile.symlink('/tmp/foo', '/tmp/bar', {
Expand Down